TestabilityMetrics.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 org.sonar.api.measures.Metric;
import org.sonar.api.measures.Metrics;

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

public class TestabilityMetrics implements Metrics {

  private static final String KEY_TESTABILITY_COST = "testability_cost";
  private static final String KEY_NEEDSWORK_CLASSES = "testability_needswork";
  private static final String KEY_ACCEPTABLE_CLASSES = "testability_acceptable";
  private static final String KEY_EXCELLENT_CLASSES = "testability_excellent";
  private static final String KEY_METHOD_DETAILS = "testability_method_details";

  private static final String DOMAIN_GLOBAL = "testability_global_metrics";

  public static final Metric EXCELLENT_CLASSES = new Metric(
      KEY_EXCELLENT_CLASSES,
      "Excellent classes",
      "Number of classes qualified as excellent",
      Metric.ValueType.INT,
      Metric.DIRECTION_BETTER,
      false,
      DOMAIN_GLOBAL
  );

  public static final Metric ACCEPTABLE_CLASSES = new Metric(
      KEY_ACCEPTABLE_CLASSES,
      "Acceptable classes",
      "Number of classes qualified as acceptable",
      Metric.ValueType.INT,
      Metric.DIRECTION_NONE,
      false,
      DOMAIN_GLOBAL
  );

  public static final Metric NEEDSWORK_CLASSES = new Metric(
      KEY_NEEDSWORK_CLASSES,
      "Needs work classes",
      "Number of classes qualified as hard to test (needs work)",
      Metric.ValueType.INT,
      Metric.DIRECTION_WORST,
      false,
      DOMAIN_GLOBAL
  );

  public static final Metric TESTABILITY_COST = new Metric(
      KEY_TESTABILITY_COST,
      "Overall cost",
      "Cost of testability",
      Metric.ValueType.INT,
      Metric.DIRECTION_WORST,
      false,
      DOMAIN_GLOBAL
  );

  public static final Metric METHOD_DETAILS_COST = new Metric(
      KEY_METHOD_DETAILS,
      "Mthod details",
      "Cost of testability detailed by method and line",
      Metric.ValueType.DATA,
      Metric.DIRECTION_NONE,
      false,
      DOMAIN_GLOBAL
  );

  public List<Metric> getMetrics() {
    return Arrays.asList(
        EXCELLENT_CLASSES,
        ACCEPTABLE_CLASSES,
        NEEDSWORK_CLASSES,
        TESTABILITY_COST,
        METHOD_DETAILS_COST
    );
  }

}