TestabilityPlugin.java

/*
 * Sonar is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * Sonar is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Sonar; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */

package org.codehaus.sonar.plugins.testability;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.sonar.api.Extension;
import org.sonar.api.Properties;
import org.sonar.api.Property;
import org.sonar.api.Plugin;

@Properties({
    @Property(
        key = TestabilityPlugin.KEY_MAX_ACCEPTABLE_COST,
        defaultValue = TestabilityPlugin.MAX_ACCEPTABLE_COST_DEFAULT,
        name = "Maximum cost to be acceptable",
        description = "Maximum Total Class cost to classify it as 'acceptable'"
    ),
    @Property(
        key = TestabilityPlugin.KEY_MAX_EXCELLENT_COST,
        defaultValue = TestabilityPlugin.MAX_EXCELLENT_COST_DEFAULT,
        name = "Maximum cost to be excellent",
        description = "Maximum Total Class cost to classify it as 'excellent'"
    ),
    @Property(
        key = TestabilityPlugin.KEY_WORST_OFFENDER_COUNT,
        defaultValue = TestabilityPlugin.WORST_OFFENDER_COUNT_DEFAULT,
        name = "Number of worst offending classes",
        description = "Print N number of worst offending classes"
    )
})
public class TestabilityPlugin implements Plugin {

  public static final String KEY = "testability";
  public static final String KEY_MAX_ACCEPTABLE_COST = "sonar.testability.maxAcceptableCost";
  public static final String KEY_MAX_EXCELLENT_COST = "sonar.testability.maxExcellentCost";
  public static final String KEY_WORST_OFFENDER_COUNT = "sonar.testability.worstOffenderCount";
  public static final String MAX_ACCEPTABLE_COST_DEFAULT = "100";
  public static final String MAX_EXCELLENT_COST_DEFAULT = "50";
  public static final String WORST_OFFENDER_COUNT_DEFAULT = "20";

  public String getKey() {
    return KEY;
  }

  public String getName() {
    return "Testability Explorer Plugin";
  }

  public String getDescription() {
    return "Testability-explorer is a tool which analyzes Java bytecode and computes how difficult it will be" +
        " to write unit tests for the code.";
  }

  public List<Class<? extends Extension>> getExtensions() {
    return Arrays.asList(
        TestabilityMavenCollector.class,
        TestabilityMavenPluginHandler.class,
        TestabilityMetrics.class,
        TestabilityDashboardWidget.class,
        TestabilityViewerDefinition.class
    );
  }

}