org.sonar.api.measures.CoreMetrics Maven / Gradle / Ivy
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2014 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube 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.
*
* SonarQube 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 this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.measures;
import com.google.common.annotations.Beta;
import com.google.common.base.Predicate;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import org.sonar.api.resources.Scopes;
import org.sonar.api.utils.SonarException;
import javax.annotation.Nullable;
import java.lang.reflect.Field;
import java.util.List;
/**
* @since 1.10
*/
public final class CoreMetrics {
// the following fields are not final to avoid compile-time constants used by plugins
public static String DOMAIN_SIZE = "Size";
public static String DOMAIN_TESTS = "Tests";
public static String DOMAIN_INTEGRATION_TESTS = "Tests (Integration)";
public static String DOMAIN_OVERALL_TESTS = "Tests (Overall)";
public static String DOMAIN_COMPLEXITY = "Complexity";
public static String DOMAIN_DOCUMENTATION = "Documentation";
public static String DOMAIN_SCM = "SCM";
/**
* @deprecated in 3.6. Replaced by concept of issues.
*/
@Deprecated
public static String DOMAIN_REVIEWS = "Reviews";
public static String DOMAIN_ISSUES = "Issues";
public static String DOMAIN_GENERAL = "General";
public static String DOMAIN_DUPLICATION = "Duplication";
public static String DOMAIN_DESIGN = "Design";
/**
* @since 4.0
*/
public static String DOMAIN_TECHNICAL_DEBT = "Technical Debt";
public static final String LINES_KEY = "lines";
public static final Metric LINES = new Metric.Builder(LINES_KEY, "Lines", Metric.ValueType.INT)
.setDescription("Lines")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_SIZE)
.setFormula(new SumChildValuesFormula(false))
.create();
public static final String GENERATED_LINES_KEY = "generated_lines";
public static final Metric GENERATED_LINES = new Metric.Builder(GENERATED_LINES_KEY, "Generated Lines", Metric.ValueType.INT)
.setDescription("Number of generated lines")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_SIZE)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setFormula(new SumChildValuesFormula(false))
.create();
public static final String NCLOC_KEY = "ncloc";
public static final Metric NCLOC = new Metric.Builder(NCLOC_KEY, "Lines of code", Metric.ValueType.INT)
.setDescription("Non Commenting Lines of Code")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_SIZE)
.setFormula(new SumChildValuesFormula(false))
.create();
/**
* @since 4.4
*/
public static final String NCLOC_LANGUAGE_DISTRIBUTION_KEY = "ncloc_language_distribution";
/**
* @since 4.4
*/
public static final Metric NCLOC_LANGUAGE_DISTRIBUTION = new Metric.Builder(NCLOC_LANGUAGE_DISTRIBUTION_KEY, "Lines of code per language", Metric.ValueType.DATA)
.setDescription("Non Commenting Lines of Code Distributed By Language")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_SIZE)
.create();
public static final String GENERATED_NCLOC_KEY = "generated_ncloc";
public static final Metric GENERATED_NCLOC = new Metric.Builder(GENERATED_NCLOC_KEY, "Generated lines of code", Metric.ValueType.INT)
.setDescription("Generated non Commenting Lines of Code")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_SIZE)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setFormula(new SumChildValuesFormula(false))
.create();
public static final String CLASSES_KEY = "classes";
public static final Metric CLASSES = new Metric.Builder(CLASSES_KEY, "Classes", Metric.ValueType.INT)
.setDescription("Classes")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_SIZE)
.setFormula(new SumChildValuesFormula(false))
.create();
public static final String FILES_KEY = "files";
public static final Metric FILES = new Metric.Builder(FILES_KEY, "Files", Metric.ValueType.INT)
.setDescription("Number of files")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_SIZE)
.create();
public static final String DIRECTORIES_KEY = "directories";
public static final Metric DIRECTORIES = new Metric.Builder(DIRECTORIES_KEY, "Directories", Metric.ValueType.INT)
.setDescription("Directories")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_SIZE)
.create();
/**
* @deprecated since 4.2 there is now only directory
*/
@Deprecated
public static final String PACKAGES_KEY = "packages";
/**
* @deprecated since 4.2 there is now only directory
*/
@Deprecated
public static final Metric PACKAGES = new Metric.Builder(PACKAGES_KEY, "Packages", Metric.ValueType.INT)
.setDescription("Packages")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_SIZE)
.setFormula(new SumChildValuesFormula(false))
.setHidden(true)
.create();
public static final String FUNCTIONS_KEY = "functions";
public static final Metric FUNCTIONS = new Metric.Builder(FUNCTIONS_KEY, "Functions", Metric.ValueType.INT)
.setDescription("Functions")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_SIZE)
.setFormula(new SumChildValuesFormula(false))
.create();
public static final String ACCESSORS_KEY = "accessors";
public static final Metric ACCESSORS = new Metric.Builder(ACCESSORS_KEY, "Accessors", Metric.ValueType.INT)
.setDescription("Accessors")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_SIZE)
.setFormula(new SumChildValuesFormula(false))
.create();
public static final String STATEMENTS_KEY = "statements";
public static final Metric STATEMENTS = new Metric.Builder(STATEMENTS_KEY, "Statements", Metric.ValueType.INT)
.setDescription("Number of statements")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_SIZE)
.setFormula(new SumChildValuesFormula(false))
.create();
public static final String PUBLIC_API_KEY = "public_api";
public static final Metric PUBLIC_API = new Metric.Builder(PUBLIC_API_KEY, "Public API", Metric.ValueType.INT)
.setDescription("Public API")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_SIZE)
.setFormula(new SumChildValuesFormula(false))
.create();
/**
* @since 3.0
*/
public static final String PROJECTS_KEY = "projects";
/**
* @since 3.0
*/
public static final Metric PROJECTS = new Metric.Builder(PROJECTS_KEY, "Projects", Metric.ValueType.INT)
.setDescription("Number of projects")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_SIZE)
.create();
// --------------------------------------------------------------------------------------------------------------------
//
// DOCUMENTATION
//
// --------------------------------------------------------------------------------------------------------------------
public static final String COMMENT_LINES_KEY = "comment_lines";
public static final Metric COMMENT_LINES = new Metric.Builder(COMMENT_LINES_KEY, "Comment lines", Metric.ValueType.INT)
.setDescription("Number of comment lines")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(false)
.setDomain(DOMAIN_DOCUMENTATION)
.setFormula(new SumChildValuesFormula(false))
.create();
public static final String COMMENT_LINES_DENSITY_KEY = "comment_lines_density";
public static final Metric COMMENT_LINES_DENSITY = new Metric.Builder(COMMENT_LINES_DENSITY_KEY, "Comments (%)", Metric.ValueType.PERCENT)
.setDescription("Comments balanced by ncloc + comment lines")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_DOCUMENTATION)
.create();
/**
* @deprecated since 3.3 - see SONAR-3768
*/
@Deprecated
public static final String COMMENT_BLANK_LINES_KEY = "comment_blank_lines";
/**
* @deprecated since 3.3 - see SONAR-3768
*/
@Deprecated
public static final Metric COMMENT_BLANK_LINES = new Metric.Builder(COMMENT_BLANK_LINES_KEY, "Blank comments", Metric.ValueType.INT)
.setDescription("Comments that do not contain comments")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_DOCUMENTATION)
.setFormula(new SumChildValuesFormula(false))
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setHidden(true)
.create();
public static final String PUBLIC_DOCUMENTED_API_DENSITY_KEY = "public_documented_api_density";
public static final Metric PUBLIC_DOCUMENTED_API_DENSITY = new Metric.Builder(PUBLIC_DOCUMENTED_API_DENSITY_KEY, "Public documented API (%)", Metric.ValueType.PERCENT)
.setDescription("Public documented classes and functions balanced by ncloc")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_DOCUMENTATION)
.setWorstValue(0.0)
.setBestValue(100.0)
.setOptimizedBestValue(true)
.create();
public static final String PUBLIC_UNDOCUMENTED_API_KEY = "public_undocumented_api";
public static final Metric PUBLIC_UNDOCUMENTED_API = new Metric.Builder(PUBLIC_UNDOCUMENTED_API_KEY, "Public undocumented API", Metric.ValueType.INT)
.setDescription("Public undocumented classes, functions and variables")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_DOCUMENTATION)
.setBestValue(0.0)
.setDirection(Metric.DIRECTION_WORST)
.setOptimizedBestValue(true)
.setFormula(new SumChildValuesFormula(false))
.create();
/**
* @deprecated since 4.2 - see SONAR-4990
*/
@Deprecated
public static final String COMMENTED_OUT_CODE_LINES_KEY = "commented_out_code_lines";
/**
* @deprecated since 4.2 - see SONAR-4990
*/
@Deprecated
public static final Metric COMMENTED_OUT_CODE_LINES = new Metric.Builder(COMMENTED_OUT_CODE_LINES_KEY, "Commented-out LOC", Metric.ValueType.INT)
.setDescription("Commented lines of code")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_DOCUMENTATION)
.setFormula(new SumChildValuesFormula(false))
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setHidden(true)
.create();
// --------------------------------------------------------------------------------------------------------------------
//
// COMPLEXITY
//
// --------------------------------------------------------------------------------------------------------------------
public static final String COMPLEXITY_KEY = "complexity";
public static final Metric COMPLEXITY = new Metric.Builder(COMPLEXITY_KEY, "Complexity", Metric.ValueType.INT)
.setDescription("Cyclomatic complexity")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_COMPLEXITY)
.setFormula(new SumChildValuesFormula(false))
.create();
public static final String FILE_COMPLEXITY_KEY = "file_complexity";
public static final Metric FILE_COMPLEXITY = new Metric.Builder(FILE_COMPLEXITY_KEY, "Complexity /file", Metric.ValueType.FLOAT)
.setDescription("Complexity average by file")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_COMPLEXITY)
.setFormula(AverageFormula.create(CoreMetrics.COMPLEXITY, CoreMetrics.FILES))
.create();
/**
* @since 3.6
*/
public static final String COMPLEXITY_IN_CLASSES_KEY = "complexity_in_classes";
/**
* @since 3.6
*/
public static final Metric COMPLEXITY_IN_CLASSES = new Metric.Builder(COMPLEXITY_IN_CLASSES_KEY, "Complexity in classes", Metric.ValueType.INT)
.setDescription("Cyclomatic complexity in classes")
.setHidden(true)
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_COMPLEXITY)
.setFormula(new SumChildValuesFormula(false))
.setDeleteHistoricalData(true)
.create();
public static final String CLASS_COMPLEXITY_KEY = "class_complexity";
/**
* Information about the cyclomatic complexity per class, calculated by divided the complexity in classes by the number of classes.
* If the complexity in classes is not available, the complexity of the file is used.
*/
public static final Metric CLASS_COMPLEXITY = new Metric.Builder(CLASS_COMPLEXITY_KEY, "Complexity /class", Metric.ValueType.FLOAT)
.setDescription("Complexity average by class")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_COMPLEXITY)
.setFormula(AverageFormula.create(CoreMetrics.COMPLEXITY_IN_CLASSES, CoreMetrics.CLASSES).setFallbackForMainMetric(CoreMetrics.COMPLEXITY))
.create();
/**
* @since 3.6
*/
public static final String COMPLEXITY_IN_FUNCTIONS_KEY = "complexity_in_functions";
/**
* @since 3.6
*/
public static final Metric COMPLEXITY_IN_FUNCTIONS = new Metric.Builder(COMPLEXITY_IN_FUNCTIONS_KEY, "Complexity in functions", Metric.ValueType.INT)
.setDescription("Cyclomatic complexity in functions")
.setHidden(true)
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_COMPLEXITY)
.setFormula(new SumChildValuesFormula(false))
.setDeleteHistoricalData(true)
.create();
public static final String FUNCTION_COMPLEXITY_KEY = "function_complexity";
/**
* Information about the cyclomatic complexity per function, calculated by divided the complexity in functions by the number of functions.
* If the complexity in functions is not available, the complexity of the file is used.
*/
public static final Metric FUNCTION_COMPLEXITY = new Metric.Builder(FUNCTION_COMPLEXITY_KEY, "Complexity /function", Metric.ValueType.FLOAT)
.setDescription("Complexity average by function")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_COMPLEXITY)
.setFormula(AverageFormula.create(CoreMetrics.COMPLEXITY_IN_FUNCTIONS, CoreMetrics.FUNCTIONS).setFallbackForMainMetric(CoreMetrics.COMPLEXITY))
.create();
/**
* @deprecated in 3.0 - see SONAR-3289
*/
@Deprecated
public static final String CLASS_COMPLEXITY_DISTRIBUTION_KEY = "class_complexity_distribution";
/**
* @deprecated in 3.0 - see SONAR-3289
*/
@Deprecated
public static final Metric CLASS_COMPLEXITY_DISTRIBUTION = new Metric.Builder(CLASS_COMPLEXITY_DISTRIBUTION_KEY, "Classes distribution /complexity",
Metric.ValueType.DISTRIB)
.setDescription("Classes distribution /complexity")
.setDirection(Metric.DIRECTION_NONE)
.setQualitative(true)
.setDomain(DOMAIN_COMPLEXITY)
.setFormula(new SumChildDistributionFormula().setMinimumScopeToPersist(Scopes.DIRECTORY))
.setHidden(true)
.create();
public static final String FUNCTION_COMPLEXITY_DISTRIBUTION_KEY = "function_complexity_distribution";
public static final Metric FUNCTION_COMPLEXITY_DISTRIBUTION = new Metric.Builder(FUNCTION_COMPLEXITY_DISTRIBUTION_KEY, "Functions distribution /complexity",
Metric.ValueType.DISTRIB)
.setDescription("Functions distribution /complexity")
.setDirection(Metric.DIRECTION_NONE)
.setQualitative(true)
.setDomain(DOMAIN_COMPLEXITY)
.setFormula(new SumChildDistributionFormula().setMinimumScopeToPersist(Scopes.DIRECTORY))
.create();
public static final String FILE_COMPLEXITY_DISTRIBUTION_KEY = "file_complexity_distribution";
public static final Metric FILE_COMPLEXITY_DISTRIBUTION = new Metric.Builder(FILE_COMPLEXITY_DISTRIBUTION_KEY, "Files distribution /complexity", Metric.ValueType.DISTRIB)
.setDescription("Files distribution /complexity")
.setDirection(Metric.DIRECTION_NONE)
.setQualitative(true)
.setDomain(DOMAIN_COMPLEXITY)
.setFormula(new SumChildDistributionFormula().setMinimumScopeToPersist(Scopes.DIRECTORY))
.create();
// --------------------------------------------------------------------------------------------------------------------
//
// UNIT TESTS
//
// --------------------------------------------------------------------------------------------------------------------
public static final String TESTS_KEY = "tests";
/**
* Value of measure for this metric can be saved from Sensor, taking into account following rules:
*
* - Non-zero value should be saved for resources representing tests. And Sonar provides default Decorator, which will decorate parent resources.
* - Should include {@link #TEST_FAILURES} and {@link #TEST_ERRORS}, but should not include {@link #SKIPPED_TESTS}.
*
*/
public static final Metric TESTS = new Metric.Builder(TESTS_KEY, "Unit tests", Metric.ValueType.INT)
.setDescription("Number of unit tests")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_TESTS)
.create();
public static final String TEST_EXECUTION_TIME_KEY = "test_execution_time";
public static final Metric TEST_EXECUTION_TIME = new Metric.Builder(TEST_EXECUTION_TIME_KEY, "Unit tests duration", Metric.ValueType.MILLISEC)
.setDescription("Execution duration of unit tests")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_TESTS)
.create();
public static final String TEST_ERRORS_KEY = "test_errors";
public static final Metric TEST_ERRORS = new Metric.Builder(TEST_ERRORS_KEY, "Unit test errors", Metric.ValueType.INT)
.setDescription("Number of unit test errors")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_TESTS)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
public static final String SKIPPED_TESTS_KEY = "skipped_tests";
public static final Metric SKIPPED_TESTS = new Metric.Builder(SKIPPED_TESTS_KEY, "Skipped unit tests", Metric.ValueType.INT)
.setDescription("Number of skipped unit tests")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_TESTS)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
public static final String TEST_FAILURES_KEY = "test_failures";
public static final Metric TEST_FAILURES = new Metric.Builder(TEST_FAILURES_KEY, "Unit test failures", Metric.ValueType.INT)
.setDescription("Number of unit test failures")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_TESTS)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
public static final String TEST_SUCCESS_DENSITY_KEY = "test_success_density";
public static final Metric TEST_SUCCESS_DENSITY = new Metric.Builder(TEST_SUCCESS_DENSITY_KEY, "Unit test success (%)", Metric.ValueType.PERCENT)
.setDescription("Density of successful unit tests")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_TESTS)
.setWorstValue(0.0)
.setBestValue(100.0)
.setOptimizedBestValue(true)
.create();
public static final String TEST_DATA_KEY = "test_data";
public static final Metric TEST_DATA = new Metric.Builder(TEST_DATA_KEY, "Unit tests details", Metric.ValueType.DATA)
.setDescription("Unit tests details")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_TESTS)
.create();
public static final String COVERAGE_KEY = "coverage";
public static final Metric COVERAGE = new Metric.Builder(COVERAGE_KEY, "Coverage", Metric.ValueType.PERCENT)
.setDescription("Coverage by unit tests")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_TESTS)
.setWorstValue(0.0)
.setBestValue(100.0)
.create();
public static final String NEW_COVERAGE_KEY = "new_coverage";
public static final Metric NEW_COVERAGE = new Metric.Builder(NEW_COVERAGE_KEY, "Coverage on new code", Metric.ValueType.PERCENT)
.setDescription("Coverage of new/changed code")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_TESTS)
.setWorstValue(0.0)
.setBestValue(100.0)
.setDeleteHistoricalData(true)
.create();
public static final String LINES_TO_COVER_KEY = "lines_to_cover";
/**
* Use {@link CoverageMeasuresBuilder} to build measure for this metric.
*/
public static final Metric LINES_TO_COVER = new Metric.Builder(LINES_TO_COVER_KEY, "Lines to cover", Metric.ValueType.INT)
.setDescription("Lines to cover")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(false)
.setDomain(DOMAIN_TESTS)
.setFormula(new SumChildValuesFormula(false))
.create();
public static final String NEW_LINES_TO_COVER_KEY = "new_lines_to_cover";
public static final Metric NEW_LINES_TO_COVER = new Metric.Builder(NEW_LINES_TO_COVER_KEY, "Lines to cover on new code", Metric.ValueType.INT)
.setDescription("Lines to cover on new code")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setDeleteHistoricalData(true)
.create();
public static final String UNCOVERED_LINES_KEY = "uncovered_lines";
/**
* Use {@link CoverageMeasuresBuilder} to build measure for this metric.
*/
public static final Metric UNCOVERED_LINES = new Metric.Builder(UNCOVERED_LINES_KEY, "Uncovered lines", Metric.ValueType.INT)
.setDescription("Uncovered lines")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setBestValue(0.0)
.create();
public static final String NEW_UNCOVERED_LINES_KEY = "new_uncovered_lines";
public static final Metric NEW_UNCOVERED_LINES = new Metric.Builder(NEW_UNCOVERED_LINES_KEY, "Uncovered lines on new code", Metric.ValueType.INT)
.setDescription("Uncovered lines on new code")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setBestValue(0.0)
.setDeleteHistoricalData(true)
.create();
public static final String LINE_COVERAGE_KEY = "line_coverage";
public static final Metric LINE_COVERAGE = new Metric.Builder(LINE_COVERAGE_KEY, "Line coverage", Metric.ValueType.PERCENT)
.setDescription("Line coverage")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_TESTS)
.setWorstValue(0.0)
.setBestValue(100.0)
.create();
public static final String NEW_LINE_COVERAGE_KEY = "new_line_coverage";
public static final Metric NEW_LINE_COVERAGE = new Metric.Builder(NEW_LINE_COVERAGE_KEY, "Line coverage on new code", Metric.ValueType.PERCENT)
.setDescription("Line coverage of added/changed code")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setWorstValue(0.0)
.setBestValue(100.0)
.setDomain(DOMAIN_TESTS)
.setDeleteHistoricalData(true)
.create();
public static final String COVERAGE_LINE_HITS_DATA_KEY = "coverage_line_hits_data";
/**
* Key-value pairs, where key - is a number of line, and value - is a number of hits for this line.
* Use {@link CoverageMeasuresBuilder} to build measure for this metric.
*/
public static final Metric COVERAGE_LINE_HITS_DATA = new Metric.Builder(COVERAGE_LINE_HITS_DATA_KEY, "Coverage hits by line", Metric.ValueType.DATA)
.setDomain(DOMAIN_TESTS)
.setDeleteHistoricalData(true)
.create();
public static final String CONDITIONS_TO_COVER_KEY = "conditions_to_cover";
/**
* Use {@link CoverageMeasuresBuilder} to build measure for this metric.
*/
public static final Metric CONDITIONS_TO_COVER = new Metric.Builder(CONDITIONS_TO_COVER_KEY, "Branches to cover", Metric.ValueType.INT)
.setDescription("Branches to cover")
.setDomain(DOMAIN_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setHidden(true)
.create();
public static final String NEW_CONDITIONS_TO_COVER_KEY = "new_conditions_to_cover";
public static final Metric NEW_CONDITIONS_TO_COVER = new Metric.Builder(NEW_CONDITIONS_TO_COVER_KEY, "Branches to cover on new code", Metric.ValueType.INT)
.setDescription("Branches to cover on new code")
.setDomain(DOMAIN_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setDeleteHistoricalData(true)
.setHidden(true)
.create();
public static final String UNCOVERED_CONDITIONS_KEY = "uncovered_conditions";
/**
* Use {@link CoverageMeasuresBuilder} to build measure for this metric.
*/
public static final Metric UNCOVERED_CONDITIONS = new Metric.Builder(UNCOVERED_CONDITIONS_KEY, "Uncovered branches", Metric.ValueType.INT)
.setDescription("Uncovered branches")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setBestValue(0.0)
.create();
public static final String NEW_UNCOVERED_CONDITIONS_KEY = "new_uncovered_conditions";
public static final Metric NEW_UNCOVERED_CONDITIONS = new Metric.Builder(NEW_UNCOVERED_CONDITIONS_KEY, "Uncovered branches on new code", Metric.ValueType.INT)
.setDescription("Uncovered branches on new code")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setBestValue(0.0)
.setDeleteHistoricalData(true)
.create();
public static final String BRANCH_COVERAGE_KEY = "branch_coverage";
public static final Metric BRANCH_COVERAGE = new Metric.Builder(BRANCH_COVERAGE_KEY, "Condition coverage", Metric.ValueType.PERCENT)
.setDescription("Condition coverage")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_TESTS)
.setWorstValue(0.0)
.setBestValue(100.0)
.create();
public static final String NEW_BRANCH_COVERAGE_KEY = "new_branch_coverage";
public static final Metric NEW_BRANCH_COVERAGE = new Metric.Builder(NEW_BRANCH_COVERAGE_KEY, "Condition coverage on new code", Metric.ValueType.PERCENT)
.setDescription("Condition coverage of new/changed code")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_TESTS)
.setWorstValue(0.0)
.setBestValue(100.0)
.setDeleteHistoricalData(true)
.create();
public static final String CONDITIONS_BY_LINE_KEY = "conditions_by_line";
/**
* Use {@link CoverageMeasuresBuilder} to build measure for this metric.
*
* @since 2.7
*/
public static final Metric CONDITIONS_BY_LINE = new Metric.Builder(CONDITIONS_BY_LINE_KEY, "Conditions by line", Metric.ValueType.DATA)
.setDomain(DOMAIN_TESTS)
.setDeleteHistoricalData(true)
.create();
public static final String COVERED_CONDITIONS_BY_LINE_KEY = "covered_conditions_by_line";
/**
* Use {@link CoverageMeasuresBuilder} to build measure for this metric.
*
* @since 2.7
*/
public static final Metric COVERED_CONDITIONS_BY_LINE = new Metric.Builder(COVERED_CONDITIONS_BY_LINE_KEY, "Covered conditions by line", Metric.ValueType.DATA)
.setDomain(DOMAIN_TESTS)
.setDeleteHistoricalData(true)
.create();
// --------------------------------------------------------------------------------------------------------------------
//
// INTEGRATION TESTS
//
// --------------------------------------------------------------------------------------------------------------------
/**
* @since 2.12
*/
public static final String IT_COVERAGE_KEY = "it_coverage";
/**
* @since 2.12
*/
public static final Metric IT_COVERAGE = new Metric.Builder(IT_COVERAGE_KEY, "IT coverage", Metric.ValueType.PERCENT)
.setDescription("Coverage by integration tests")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setWorstValue(0.0)
.setBestValue(100.0)
.create();
/**
* @since 2.12
*/
public static final String NEW_IT_COVERAGE_KEY = "new_it_coverage";
/**
* @since 2.12
*/
public static final Metric NEW_IT_COVERAGE = new Metric.Builder(NEW_IT_COVERAGE_KEY, "Coverage by IT on new code", Metric.ValueType.PERCENT)
.setDescription("Integration Tests Coverage of new/changed code")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setWorstValue(0.0)
.setBestValue(100.0)
.setDeleteHistoricalData(true)
.create();
/**
* @since 2.12
*/
public static final String IT_LINES_TO_COVER_KEY = "it_lines_to_cover";
/**
* @since 2.12
*/
public static final Metric IT_LINES_TO_COVER = new Metric.Builder(IT_LINES_TO_COVER_KEY, "IT lines to cover", Metric.ValueType.INT)
.setDescription("Lines to cover by Integration Tests")
.setDirection(Metric.DIRECTION_BETTER)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setQualitative(false)
.setFormula(new SumChildValuesFormula(false))
.setHidden(true)
.create();
/**
* @since 2.12
*/
public static final String NEW_IT_LINES_TO_COVER_KEY = "new_it_lines_to_cover";
/**
* @since 2.12
*/
public static final Metric NEW_IT_LINES_TO_COVER = new Metric.Builder(NEW_IT_LINES_TO_COVER_KEY, "Lines to cover by IT on new code", Metric.ValueType.INT)
.setDescription("Lines to cover by Integration Tests on new code")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setDeleteHistoricalData(true)
.create();
/**
* @since 2.12
*/
public static final String IT_UNCOVERED_LINES_KEY = "it_uncovered_lines";
/**
* @since 2.12
*/
public static final Metric IT_UNCOVERED_LINES = new Metric.Builder(IT_UNCOVERED_LINES_KEY, "IT uncovered lines", Metric.ValueType.INT)
.setDescription("IT uncovered lines")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setFormula(new SumChildValuesFormula(false))
.create();
/**
* @since 2.12
*/
public static final String NEW_IT_UNCOVERED_LINES_KEY = "new_it_uncovered_lines";
/**
* @since 2.12
*/
public static final Metric NEW_IT_UNCOVERED_LINES = new Metric.Builder(NEW_IT_UNCOVERED_LINES_KEY, "Uncovered lines by IT on new code", Metric.ValueType.INT)
.setDescription("Uncovered lines by IT on new code")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setBestValue(0.0)
.setDeleteHistoricalData(true)
.create();
/**
* @since 2.12
*/
public static final String IT_LINE_COVERAGE_KEY = "it_line_coverage";
/**
* @since 2.12
*/
public static final Metric IT_LINE_COVERAGE = new Metric.Builder(IT_LINE_COVERAGE_KEY, "IT line coverage", Metric.ValueType.PERCENT)
.setDescription("IT line coverage")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.create();
/**
* @since 2.12
*/
public static final String NEW_IT_LINE_COVERAGE_KEY = "new_it_line_coverage";
/**
* @since 2.12
*/
public static final Metric NEW_IT_LINE_COVERAGE = new Metric.Builder(NEW_IT_LINE_COVERAGE_KEY, "Line coverage by IT on new code", Metric.ValueType.PERCENT)
.setDescription("Line Coverage by Integration Tests of added/changed code")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setWorstValue(0.0)
.setBestValue(100.0)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setDeleteHistoricalData(true)
.create();
/**
* @since 2.12
*/
public static final String IT_COVERAGE_LINE_HITS_DATA_KEY = "it_coverage_line_hits_data";
/**
* @since 2.12
*/
public static final Metric IT_COVERAGE_LINE_HITS_DATA = new Metric.Builder(IT_COVERAGE_LINE_HITS_DATA_KEY, "IT coverage hits data", Metric.ValueType.DATA)
.setDescription("Integration Tests Code coverage line hits data")
.setDirection(Metric.DIRECTION_NONE)
.setQualitative(false)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setDeleteHistoricalData(true)
.create();
/**
* @since 2.12
*/
public static final String IT_CONDITIONS_TO_COVER_KEY = "it_conditions_to_cover";
/**
* @since 2.12
*/
public static final Metric IT_CONDITIONS_TO_COVER = new Metric.Builder(IT_CONDITIONS_TO_COVER_KEY, "IT branches to cover", Metric.ValueType.INT)
.setDescription("Integration Tests conditions to cover")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(false)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setHidden(true)
.create();
/**
* @since 2.12
*/
public static final String NEW_IT_CONDITIONS_TO_COVER_KEY = "new_it_conditions_to_cover";
/**
* @since 2.12
*/
public static final Metric NEW_IT_CONDITIONS_TO_COVER = new Metric.Builder(NEW_IT_CONDITIONS_TO_COVER_KEY, "Branches to cover by IT on new code", Metric.ValueType.INT)
.setDescription("Branches to cover by Integration Tests on new code")
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setDeleteHistoricalData(true)
.setHidden(true)
.create();
/**
* @since 2.12
*/
public static final String IT_UNCOVERED_CONDITIONS_KEY = "it_uncovered_conditions";
/**
* @since 2.12
*/
public static final Metric IT_UNCOVERED_CONDITIONS = new Metric.Builder(IT_UNCOVERED_CONDITIONS_KEY, "IT uncovered branches", Metric.ValueType.INT)
.setDescription("Integration Tests uncovered conditions")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setFormula(new SumChildValuesFormula(false))
.create();
/**
* @since 2.12
*/
public static final String NEW_IT_UNCOVERED_CONDITIONS_KEY = "new_it_uncovered_conditions";
/**
* @since 2.12
*/
public static final Metric NEW_IT_UNCOVERED_CONDITIONS = new Metric.Builder(NEW_IT_UNCOVERED_CONDITIONS_KEY, "Uncovered branches by IT on new code",
Metric.ValueType.INT)
.setDescription("Uncovered branches by Integration Tests on new code")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setBestValue(0.0)
.setDeleteHistoricalData(true)
.create();
/**
* @since 2.12
*/
public static final String IT_BRANCH_COVERAGE_KEY = "it_branch_coverage";
/**
* @since 2.12
*/
public static final Metric IT_BRANCH_COVERAGE = new Metric.Builder(IT_BRANCH_COVERAGE_KEY, "IT condition coverage", Metric.ValueType.PERCENT)
.setDescription("IT condition coverage")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setWorstValue(0.0)
.setBestValue(100.0)
.create();
/**
* @since 2.12
*/
public static final String NEW_IT_BRANCH_COVERAGE_KEY = "new_it_branch_coverage";
/**
* @since 2.12
*/
public static final Metric NEW_IT_BRANCH_COVERAGE = new Metric.Builder(NEW_IT_BRANCH_COVERAGE_KEY, "Condition coverage by IT on new code", Metric.ValueType.PERCENT)
.setDescription("Condition coverage by Integration Tests of new/changed code")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setWorstValue(0.0)
.setBestValue(100.0)
.setDeleteHistoricalData(true)
.create();
/**
* @since 2.12
*/
public static final String IT_CONDITIONS_BY_LINE_KEY = "it_conditions_by_line";
/**
* @since 2.12
*/
public static final Metric IT_CONDITIONS_BY_LINE = new Metric.Builder(IT_CONDITIONS_BY_LINE_KEY, "IT conditions by line", Metric.ValueType.DATA)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setDeleteHistoricalData(true)
.create();
/**
* @since 2.12
*/
public static final String IT_COVERED_CONDITIONS_BY_LINE_KEY = "it_covered_conditions_by_line";
/**
* @since 2.12
*/
public static final Metric IT_COVERED_CONDITIONS_BY_LINE = new Metric.Builder(IT_COVERED_CONDITIONS_BY_LINE_KEY, "IT covered conditions by line", Metric.ValueType.DATA)
.setDomain(DOMAIN_INTEGRATION_TESTS)
.setDeleteHistoricalData(true)
.create();
// --------------------------------------------------------------------------------------------------------------------
//
// OVERALL TESTS
//
// --------------------------------------------------------------------------------------------------------------------
/**
* @since 3.3
*/
public static final String OVERALL_COVERAGE_KEY = "overall_coverage";
/**
* @since 3.3
*/
public static final Metric OVERALL_COVERAGE = new Metric.Builder(OVERALL_COVERAGE_KEY, "Overall coverage", Metric.ValueType.PERCENT)
.setDescription("Overall test coverage")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_OVERALL_TESTS)
.setWorstValue(0.0)
.setBestValue(100.0)
.create();
/**
* @since 3.3
*/
public static final String NEW_OVERALL_COVERAGE_KEY = "new_overall_coverage";
/**
* @since 3.3
*/
public static final Metric NEW_OVERALL_COVERAGE = new Metric.Builder(NEW_OVERALL_COVERAGE_KEY, "Overall coverage on new code", Metric.ValueType.PERCENT)
.setDescription("Overall coverage of new/changed code")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_OVERALL_TESTS)
.setWorstValue(0.0)
.setBestValue(100.0)
.setDeleteHistoricalData(true)
.create();
/**
* @since 3.3
*/
public static final String OVERALL_LINES_TO_COVER_KEY = "overall_lines_to_cover";
/**
* @since 3.3
*/
public static final Metric OVERALL_LINES_TO_COVER = new Metric.Builder(OVERALL_LINES_TO_COVER_KEY, "Overall lines to cover", Metric.ValueType.INT)
.setDescription("Overall lines to cover by all tests")
.setDirection(Metric.DIRECTION_BETTER)
.setDomain(DOMAIN_OVERALL_TESTS)
.setQualitative(false)
.setFormula(new SumChildValuesFormula(false))
.setHidden(true)
.create();
/**
* @since 3.3
*/
public static final String NEW_OVERALL_LINES_TO_COVER_KEY = "new_overall_lines_to_cover";
/**
* @since 3.3
*/
public static final Metric NEW_OVERALL_LINES_TO_COVER = new Metric.Builder(NEW_OVERALL_LINES_TO_COVER_KEY, "Overall lines to cover on new code", Metric.ValueType.INT)
.setDescription("New lines to cover by all tests")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_OVERALL_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setDeleteHistoricalData(true)
.create();
/**
* @since 3.3
*/
public static final String OVERALL_UNCOVERED_LINES_KEY = "overall_uncovered_lines";
/**
* @since 3.3
*/
public static final Metric OVERALL_UNCOVERED_LINES = new Metric.Builder(OVERALL_UNCOVERED_LINES_KEY, "Overall uncovered lines", Metric.ValueType.INT)
.setDescription("Uncovered lines by all tests")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_OVERALL_TESTS)
.setFormula(new SumChildValuesFormula(false))
.create();
/**
* @since 3.3
*/
public static final String NEW_OVERALL_UNCOVERED_LINES_KEY = "new_overall_uncovered_lines";
/**
* @since 3.3
*/
public static final Metric NEW_OVERALL_UNCOVERED_LINES = new Metric.Builder(NEW_OVERALL_UNCOVERED_LINES_KEY, "Overall uncovered lines on new code", Metric.ValueType.INT)
.setDescription("New lines that are not covered by any tests")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_OVERALL_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setBestValue(0.0)
.setDeleteHistoricalData(true)
.create();
/**
* @since 3.3
*/
public static final String OVERALL_LINE_COVERAGE_KEY = "overall_line_coverage";
/**
* @since 3.3
*/
public static final Metric OVERALL_LINE_COVERAGE = new Metric.Builder(OVERALL_LINE_COVERAGE_KEY, "Overall line coverage", Metric.ValueType.PERCENT)
.setDescription("Line coverage by all tests")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_OVERALL_TESTS)
.create();
/**
* @since 3.3
*/
public static final String NEW_OVERALL_LINE_COVERAGE_KEY = "new_overall_line_coverage";
/**
* @since 3.3
*/
public static final Metric NEW_OVERALL_LINE_COVERAGE = new Metric.Builder(NEW_OVERALL_LINE_COVERAGE_KEY, "Overall line coverage on new code", Metric.ValueType.PERCENT)
.setDescription("Line coverage of added/changed code by all tests")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setWorstValue(0.0)
.setBestValue(100.0)
.setDomain(DOMAIN_OVERALL_TESTS)
.setDeleteHistoricalData(true)
.create();
/**
* @since 3.3
*/
public static final String OVERALL_COVERAGE_LINE_HITS_DATA_KEY = "overall_coverage_line_hits_data";
/**
* @since 3.3
*/
public static final Metric OVERALL_COVERAGE_LINE_HITS_DATA = new Metric.Builder(OVERALL_COVERAGE_LINE_HITS_DATA_KEY, "Overall coverage hits by line",
Metric.ValueType.DATA)
.setDescription("Coverage hits by all tests and by line")
.setDirection(Metric.DIRECTION_NONE)
.setQualitative(false)
.setDomain(DOMAIN_OVERALL_TESTS)
.setDeleteHistoricalData(true)
.create();
/**
* @since 3.3
*/
public static final String OVERALL_CONDITIONS_TO_COVER_KEY = "overall_conditions_to_cover";
/**
* @since 3.3
*/
public static final Metric OVERALL_CONDITIONS_TO_COVER = new Metric.Builder(OVERALL_CONDITIONS_TO_COVER_KEY, "Overall branches to cover", Metric.ValueType.INT)
.setDescription("Branches to cover by all tests")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(false)
.setDomain(DOMAIN_OVERALL_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setHidden(true)
.create();
/**
* @since 3.3
*/
public static final String NEW_OVERALL_CONDITIONS_TO_COVER_KEY = "new_overall_conditions_to_cover";
/**
* @since 3.3
*/
public static final Metric NEW_OVERALL_CONDITIONS_TO_COVER = new Metric.Builder(NEW_OVERALL_CONDITIONS_TO_COVER_KEY, "Overall branches to cover on new code",
Metric.ValueType.INT)
.setDescription("New branches to cover by all tests")
.setDomain(DOMAIN_OVERALL_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setDeleteHistoricalData(true)
.setHidden(true)
.create();
/**
* @since 3.3
*/
public static final String OVERALL_UNCOVERED_CONDITIONS_KEY = "overall_uncovered_conditions";
/**
* @since 3.3
*/
public static final Metric OVERALL_UNCOVERED_CONDITIONS = new Metric.Builder(OVERALL_UNCOVERED_CONDITIONS_KEY, "Overall uncovered branches", Metric.ValueType.INT)
.setDescription("Uncovered branches by all tests")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_OVERALL_TESTS)
.setFormula(new SumChildValuesFormula(false))
.create();
/**
* @since 3.3
*/
public static final String NEW_OVERALL_UNCOVERED_CONDITIONS_KEY = "new_overall_uncovered_conditions";
/**
* @since 3.3
*/
public static final Metric NEW_OVERALL_UNCOVERED_CONDITIONS = new Metric.Builder(NEW_OVERALL_UNCOVERED_CONDITIONS_KEY, "Overall uncovered branches on new code",
Metric.ValueType.INT)
.setDescription("New branches that are not covered by any test")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_OVERALL_TESTS)
.setFormula(new SumChildValuesFormula(false))
.setBestValue(0.0)
.setDeleteHistoricalData(true)
.create();
/**
* @since 3.3
*/
public static final String OVERALL_BRANCH_COVERAGE_KEY = "overall_branch_coverage";
/**
* @since 3.3
*/
public static final Metric OVERALL_BRANCH_COVERAGE = new Metric.Builder(OVERALL_BRANCH_COVERAGE_KEY, "Overall condition coverage", Metric.ValueType.PERCENT)
.setDescription("Condition coverage by all tests")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_OVERALL_TESTS)
.setWorstValue(0.0)
.setBestValue(100.0)
.create();
/**
* @since 3.3
*/
public static final String NEW_OVERALL_BRANCH_COVERAGE_KEY = "new_overall_branch_coverage";
/**
* @since 3.3
*/
public static final Metric NEW_OVERALL_BRANCH_COVERAGE = new Metric.Builder(NEW_OVERALL_BRANCH_COVERAGE_KEY, "Overall condition coverage on new code",
Metric.ValueType.PERCENT)
.setDescription("Condition coverage of new/changed code by all tests")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_OVERALL_TESTS)
.setWorstValue(0.0)
.setBestValue(100.0)
.setDeleteHistoricalData(true)
.create();
/**
* @since 3.3
*/
public static final String OVERALL_CONDITIONS_BY_LINE_KEY = "overall_conditions_by_line";
/**
* @since 3.3
*/
public static final Metric OVERALL_CONDITIONS_BY_LINE = new Metric.Builder(OVERALL_CONDITIONS_BY_LINE_KEY, "Overall conditions by line", Metric.ValueType.DATA)
.setDescription("Overall conditions by all tests and by line")
.setDomain(DOMAIN_OVERALL_TESTS)
.setDeleteHistoricalData(true)
.create();
/**
* @since 3.3
*/
public static final String OVERALL_COVERED_CONDITIONS_BY_LINE_KEY = "overall_covered_conditions_by_line";
/**
* @since 3.3
*/
public static final Metric OVERALL_COVERED_CONDITIONS_BY_LINE = new Metric.Builder(OVERALL_COVERED_CONDITIONS_BY_LINE_KEY, "Overall covered branches by line",
Metric.ValueType.DATA)
.setDescription("Overall covered branches by all tests and by line")
.setDomain(DOMAIN_OVERALL_TESTS)
.setDeleteHistoricalData(true)
.create();
// --------------------------------------------------------------------------------------------------------------------
//
// DUPLICATIONS
//
// --------------------------------------------------------------------------------------------------------------------
public static final String DUPLICATED_LINES_KEY = "duplicated_lines";
public static final Metric DUPLICATED_LINES = new Metric.Builder(DUPLICATED_LINES_KEY, "Duplicated lines", Metric.ValueType.INT)
.setDescription("Duplicated lines")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_DUPLICATION)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
public static final String DUPLICATED_BLOCKS_KEY = "duplicated_blocks";
public static final Metric DUPLICATED_BLOCKS = new Metric.Builder(DUPLICATED_BLOCKS_KEY, "Duplicated blocks", Metric.ValueType.INT)
.setDescription("Duplicated blocks")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_DUPLICATION)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
public static final String DUPLICATED_FILES_KEY = "duplicated_files";
/**
* For files: if it contains duplicates, then 1, otherwise 0.
* For other resources: amount of files under this resource with duplicates.
*/
public static final Metric DUPLICATED_FILES = new Metric.Builder(DUPLICATED_FILES_KEY, "Duplicated files", Metric.ValueType.INT)
.setDescription("Duplicated files")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_DUPLICATION)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
public static final String DUPLICATED_LINES_DENSITY_KEY = "duplicated_lines_density";
public static final Metric DUPLICATED_LINES_DENSITY = new Metric.Builder(DUPLICATED_LINES_DENSITY_KEY, "Duplicated lines (%)", Metric.ValueType.PERCENT)
.setDescription("Duplicated lines balanced by statements")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_DUPLICATION)
.setWorstValue(50.0)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
/**
* @deprecated since 4.5. Internal storage of duplication is not an API.
*/
@Deprecated
public static final String DUPLICATIONS_DATA_KEY = "duplications_data";
/**
* Information about duplications, which is represented as an XML string.
*
* Here is the format (since Sonar 2.12):
*
*
*
*
*
*
* ...
*
* ...
*
*
*
* @deprecated since 4.5. Internal storage of duplication is not an API.
*/
@Deprecated
public static final Metric DUPLICATIONS_DATA = new Metric.Builder(DUPLICATIONS_DATA_KEY, "Duplications details", Metric.ValueType.DATA)
.setDescription("Duplications details")
.setDirection(Metric.DIRECTION_NONE)
.setQualitative(false)
.setDomain(DOMAIN_DUPLICATION)
.setDeleteHistoricalData(true)
.create();
/**
* @since 4.5 used by dev cockpit.
*/
@Beta
public static final String DUPLICATION_LINES_DATA_KEY = "duplication_lines_data";
/**
* Information about duplication in file.
* Key-value pairs, where key - is a number of line, and value - is an indicator of whether line is duplicated somewhere (1) or not (0).
*
* @see org.sonar.api.measures.FileLinesContext
* @since 4.5 used by dev cockpit
*/
@Beta
public static final Metric DUPLICATION_LINES_DATA = new Metric.Builder(DUPLICATION_LINES_DATA_KEY, "duplication_lines_data", Metric.ValueType.DATA)
.setHidden(true)
.setDomain(DOMAIN_DUPLICATION)
.create();
// --------------------------------------------------------------------------------------------------------------------
//
// CODING RULES
//
// --------------------------------------------------------------------------------------------------------------------
public static final String VIOLATIONS_KEY = "violations";
public static final Metric VIOLATIONS = new Metric.Builder(VIOLATIONS_KEY, "Issues", Metric.ValueType.INT)
.setDescription("Issues")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
public static final String BLOCKER_VIOLATIONS_KEY = "blocker_violations";
public static final Metric BLOCKER_VIOLATIONS = new Metric.Builder(BLOCKER_VIOLATIONS_KEY, "Blocker issues", Metric.ValueType.INT)
.setDescription("Blocker issues")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
public static final String CRITICAL_VIOLATIONS_KEY = "critical_violations";
public static final Metric CRITICAL_VIOLATIONS = new Metric.Builder(CRITICAL_VIOLATIONS_KEY, "Critical issues", Metric.ValueType.INT)
.setDescription("Critical issues")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
public static final String MAJOR_VIOLATIONS_KEY = "major_violations";
public static final Metric MAJOR_VIOLATIONS = new Metric.Builder(MAJOR_VIOLATIONS_KEY, "Major issues", Metric.ValueType.INT)
.setDescription("Major issues")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
public static final String MINOR_VIOLATIONS_KEY = "minor_violations";
public static final Metric MINOR_VIOLATIONS = new Metric.Builder(MINOR_VIOLATIONS_KEY, "Minor issues", Metric.ValueType.INT)
.setDescription("Minor issues")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
public static final String INFO_VIOLATIONS_KEY = "info_violations";
public static final Metric INFO_VIOLATIONS = new Metric.Builder(INFO_VIOLATIONS_KEY, "Info issues", Metric.ValueType.INT)
.setDescription("Info issues")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
public static final String NEW_VIOLATIONS_KEY = "new_violations";
public static final Metric NEW_VIOLATIONS = new Metric.Builder(NEW_VIOLATIONS_KEY, "New issues", Metric.ValueType.INT)
.setDescription("New Issues")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setDeleteHistoricalData(true)
.create();
public static final String NEW_BLOCKER_VIOLATIONS_KEY = "new_blocker_violations";
public static final Metric NEW_BLOCKER_VIOLATIONS = new Metric.Builder(NEW_BLOCKER_VIOLATIONS_KEY, "New Blocker issues", Metric.ValueType.INT)
.setDescription("New Blocker issues")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setDeleteHistoricalData(true)
.create();
public static final String NEW_CRITICAL_VIOLATIONS_KEY = "new_critical_violations";
public static final Metric NEW_CRITICAL_VIOLATIONS = new Metric.Builder(NEW_CRITICAL_VIOLATIONS_KEY, "New Critical issues", Metric.ValueType.INT)
.setDescription("New Critical issues")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setDeleteHistoricalData(true)
.create();
public static final String NEW_MAJOR_VIOLATIONS_KEY = "new_major_violations";
public static final Metric NEW_MAJOR_VIOLATIONS = new Metric.Builder(NEW_MAJOR_VIOLATIONS_KEY, "New Major issues", Metric.ValueType.INT)
.setDescription("New Major issues")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setDeleteHistoricalData(true)
.create();
public static final String NEW_MINOR_VIOLATIONS_KEY = "new_minor_violations";
public static final Metric NEW_MINOR_VIOLATIONS = new Metric.Builder(NEW_MINOR_VIOLATIONS_KEY, "New Minor issues", Metric.ValueType.INT)
.setDescription("New Minor issues")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setDeleteHistoricalData(true)
.create();
public static final String NEW_INFO_VIOLATIONS_KEY = "new_info_violations";
public static final Metric NEW_INFO_VIOLATIONS = new Metric.Builder(NEW_INFO_VIOLATIONS_KEY, "New Info issues", Metric.ValueType.INT)
.setDescription("New Info issues")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setDeleteHistoricalData(true)
.create();
/**
* @since 3.6
*/
public static final String FALSE_POSITIVE_ISSUES_KEY = "false_positive_issues";
/**
* @since 3.6
*/
public static final Metric FALSE_POSITIVE_ISSUES = new Metric.Builder(FALSE_POSITIVE_ISSUES_KEY, "False positive issues", Metric.ValueType.INT)
.setDescription("False positive issues")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
/**
* @since 3.6
*/
public static final String OPEN_ISSUES_KEY = "open_issues";
/**
* @since 3.6
*/
public static final Metric OPEN_ISSUES = new Metric.Builder(OPEN_ISSUES_KEY, "Open issues", Metric.ValueType.INT)
.setDescription("Open issues")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
/**
* @since 3.6
*/
public static final String REOPENED_ISSUES_KEY = "reopened_issues";
/**
* @since 3.6
*/
public static final Metric REOPENED_ISSUES = new Metric.Builder(REOPENED_ISSUES_KEY, "Reopened issues", Metric.ValueType.INT)
.setDescription("Reopened issues")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
/**
* @since 3.6
*/
public static final String CONFIRMED_ISSUES_KEY = "confirmed_issues";
/**
* @since 3.6
*/
public static final Metric CONFIRMED_ISSUES = new Metric.Builder(CONFIRMED_ISSUES_KEY, "Confirmed issues", Metric.ValueType.INT)
.setDescription("Confirmed issues")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_ISSUES)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.create();
// --------------------------------------------------------------------------------------------------------------------
//
// DESIGN
//
// --------------------------------------------------------------------------------------------------------------------
/**
* @deprecated since 3.7.1
*/
@Deprecated
public static final String ABSTRACTNESS_KEY = "abstractness";
/**
* @deprecated since 3.7.1
*/
@Deprecated
public static final Metric ABSTRACTNESS = new Metric.Builder(ABSTRACTNESS_KEY, "Abstractness", Metric.ValueType.PERCENT)
.setDescription("Abstractness")
.setDirection(Metric.DIRECTION_NONE)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setHidden(true)
.create();
/**
* @deprecated since 3.7.1
*/
@Deprecated
public static final String INSTABILITY_KEY = "instability";
/**
* @deprecated since 3.7.1
*/
@Deprecated
public static final Metric INSTABILITY = new Metric.Builder(INSTABILITY_KEY, "Instability", Metric.ValueType.PERCENT)
.setDescription("Instability")
.setDirection(Metric.DIRECTION_NONE)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setHidden(true)
.create();
/**
* @deprecated since 3.7.1
*/
@Deprecated
public static final String DISTANCE_KEY = "distance";
/**
* @deprecated since 3.7.1
*/
@Deprecated
public static final Metric DISTANCE = new Metric.Builder(DISTANCE_KEY, "Distance", Metric.ValueType.FLOAT)
.setDescription("Distance")
.setDirection(Metric.DIRECTION_NONE)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setHidden(true)
.create();
/**
* @deprecated since 4.0. See SONAR-4643
*/
@Deprecated
public static final String DEPTH_IN_TREE_KEY = "dit";
/**
* @deprecated since 4.0. See SONAR-4643
*/
@Deprecated
public static final Metric DEPTH_IN_TREE = new Metric.Builder(DEPTH_IN_TREE_KEY, "Depth in Tree", Metric.ValueType.INT)
.setDescription("Depth in Inheritance Tree")
.setDirection(Metric.DIRECTION_NONE)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setHidden(true)
.create();
/**
* @deprecated since 4.0. See SONAR-4643
*/
@Deprecated
public static final String NUMBER_OF_CHILDREN_KEY = "noc";
/**
* @deprecated since 4.0. See SONAR-4643
*/
@Deprecated
public static final Metric NUMBER_OF_CHILDREN = new Metric.Builder(NUMBER_OF_CHILDREN_KEY, "Number of Children", Metric.ValueType.INT)
.setDescription("Number of Children")
.setDirection(Metric.DIRECTION_NONE)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setHidden(true)
.create();
/**
* @deprecated since 4.2. See SONAR-5042
*/
@Deprecated
public static final String RFC_KEY = "rfc";
/**
* @deprecated since 4.2. See SONAR-5042
*/
@Deprecated
public static final Metric RFC = new Metric.Builder(RFC_KEY, "RFC", Metric.ValueType.INT)
.setDescription("Response for Class")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setFormula(new WeightedMeanAggregationFormula(CoreMetrics.FILES, false))
.setHidden(true)
.create();
/**
* @deprecated since 4.2. See SONAR-5042
*/
@Deprecated
public static final String RFC_DISTRIBUTION_KEY = "rfc_distribution";
/**
* @deprecated since 4.2. See SONAR-5042
*/
@Deprecated
public static final Metric RFC_DISTRIBUTION = new Metric.Builder(RFC_DISTRIBUTION_KEY, "Class distribution /RFC", Metric.ValueType.DISTRIB)
.setDescription("Class distribution /RFC")
.setDirection(Metric.DIRECTION_NONE)
.setQualitative(true)
.setDomain(DOMAIN_DESIGN)
.setFormula(new SumChildDistributionFormula().setMinimumScopeToPersist(Scopes.DIRECTORY))
.setHidden(true)
.create();
/**
* @deprecated in 4.1. See http://jira.codehaus.org/browse/SONAR-4853
*/
@Deprecated
public static final String LCOM4_KEY = "lcom4";
/**
* @deprecated in 4.1. See http://jira.codehaus.org/browse/SONAR-4853
*/
@Deprecated
public static final Metric LCOM4 = new Metric.Builder(LCOM4_KEY, "LCOM4", Metric.ValueType.FLOAT)
.setDescription("Lack of Cohesion of Functions")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_DESIGN)
.setBestValue(1.0)
.setHidden(true)
.create();
/**
* @deprecated in 4.1. See http://jira.codehaus.org/browse/SONAR-4853
*/
@Deprecated
public static final String LCOM4_BLOCKS_KEY = "lcom4_blocks";
/**
* @deprecated in 4.1. See http://jira.codehaus.org/browse/SONAR-4853
*/
@Deprecated
public static final Metric LCOM4_BLOCKS = new Metric.Builder(LCOM4_BLOCKS_KEY, "LCOM4 blocks", Metric.ValueType.DATA)
.setDescription("LCOM4 blocks")
.setDirection(Metric.DIRECTION_NONE)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setDeleteHistoricalData(true)
.setHidden(true)
.create();
/**
* @deprecated in 4.1. See http://jira.codehaus.org/browse/SONAR-4853
*/
@Deprecated
public static final String LCOM4_DISTRIBUTION_KEY = "lcom4_distribution";
/**
* @deprecated in 4.1. See http://jira.codehaus.org/browse/SONAR-4853
*/
@Deprecated
public static final Metric LCOM4_DISTRIBUTION = new Metric.Builder(LCOM4_DISTRIBUTION_KEY, "Class distribution /LCOM4", Metric.ValueType.DISTRIB)
.setDescription("Class distribution /LCOM4")
.setDirection(Metric.DIRECTION_NONE)
.setQualitative(true)
.setDomain(DOMAIN_DESIGN)
.setFormula(new SumChildDistributionFormula().setMinimumScopeToPersist(Scopes.DIRECTORY))
.setHidden(true)
.create();
/**
* @deprecated in 4.1. See http://jira.codehaus.org/browse/SONAR-4853
*/
@Deprecated
public static final String SUSPECT_LCOM4_DENSITY_KEY = "suspect_lcom4_density";
/**
* @deprecated in 4.1. See http://jira.codehaus.org/browse/SONAR-4853
*/
@Deprecated
public static final Metric SUSPECT_LCOM4_DENSITY = new Metric.Builder(SUSPECT_LCOM4_DENSITY_KEY, "Suspect LCOM4 density", Metric.ValueType.PERCENT)
.setDescription("Density of classes having LCOM4>1")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_DESIGN)
.setHidden(true)
.create();
/**
* @deprecated since 3.7.1
*/
@Deprecated
public static final String AFFERENT_COUPLINGS_KEY = "ca";
/**
* @deprecated since 3.7.1
*/
@Deprecated
public static final Metric AFFERENT_COUPLINGS = new Metric.Builder(AFFERENT_COUPLINGS_KEY, "Afferent couplings", Metric.ValueType.INT)
.setDescription("Afferent couplings")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setHidden(true)
.create();
/**
* @deprecated since 3.7.1
*/
@Deprecated
public static final String EFFERENT_COUPLINGS_KEY = "ce";
/**
* @deprecated since 3.7.1
*/
@Deprecated
public static final Metric EFFERENT_COUPLINGS = new Metric.Builder(EFFERENT_COUPLINGS_KEY, "Efferent couplings", Metric.ValueType.INT)
.setDescription("Efferent couplings")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setHidden(true)
.create();
public static final String DEPENDENCY_MATRIX_KEY = "dsm";
public static final Metric DEPENDENCY_MATRIX = new Metric.Builder(DEPENDENCY_MATRIX_KEY, "Dependency Matrix", Metric.ValueType.DATA)
.setDescription("Dependency Matrix")
.setDirection(Metric.DIRECTION_NONE)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setDeleteHistoricalData(true)
.create();
public static final String PACKAGE_CYCLES_KEY = "package_cycles";
public static final Metric PACKAGE_CYCLES = new Metric.Builder(PACKAGE_CYCLES_KEY, "Package cycles", Metric.ValueType.INT)
.setDescription("Package cycles")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_DESIGN)
.setBestValue(0.0)
.setFormula(new SumChildValuesFormula(false))
.create();
public static final String PACKAGE_TANGLE_INDEX_KEY = "package_tangle_index";
public static final Metric PACKAGE_TANGLE_INDEX = new Metric.Builder(PACKAGE_TANGLE_INDEX_KEY, "Package tangle index", Metric.ValueType.PERCENT)
.setDescription("Package tangle index")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setBestValue(0.0)
.setDomain(DOMAIN_DESIGN)
.create();
public static final String PACKAGE_TANGLES_KEY = "package_tangles";
public static final Metric PACKAGE_TANGLES = new Metric.Builder(PACKAGE_TANGLES_KEY, "File dependencies to cut", Metric.ValueType.INT)
.setDescription("File dependencies to cut")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setFormula(new SumChildValuesFormula(false))
.create();
public static final String PACKAGE_FEEDBACK_EDGES_KEY = "package_feedback_edges";
public static final Metric PACKAGE_FEEDBACK_EDGES = new Metric.Builder(PACKAGE_FEEDBACK_EDGES_KEY, "Package dependencies to cut", Metric.ValueType.INT)
.setDescription("Package dependencies to cut")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setFormula(new SumChildValuesFormula(false))
.setBestValue(0.0)
.create();
public static final String PACKAGE_EDGES_WEIGHT_KEY = "package_edges_weight";
public static final Metric PACKAGE_EDGES_WEIGHT = new Metric.Builder(PACKAGE_EDGES_WEIGHT_KEY, "Package edges weight", Metric.ValueType.INT)
.setDescription("Package edges weight")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setFormula(new SumChildValuesFormula(false))
.setHidden(true)
.setDeleteHistoricalData(true)
.create();
public static final String FILE_CYCLES_KEY = "file_cycles";
public static final Metric FILE_CYCLES = new Metric.Builder(FILE_CYCLES_KEY, "File cycles", Metric.ValueType.INT)
.setDescription("File cycles")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_DESIGN)
.setHidden(true)
.setDeleteHistoricalData(true)
.setBestValue(0.0)
.create();
public static final String FILE_TANGLE_INDEX_KEY = "file_tangle_index";
public static final Metric FILE_TANGLE_INDEX = new Metric.Builder(FILE_TANGLE_INDEX_KEY, "File tangle index", Metric.ValueType.PERCENT)
.setDescription("File tangle index")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_DESIGN)
.setHidden(true)
.setDeleteHistoricalData(true)
.setBestValue(0.0)
.create();
public static final String FILE_TANGLES_KEY = "file_tangles";
public static final Metric FILE_TANGLES = new Metric.Builder(FILE_TANGLES_KEY, "File tangles", Metric.ValueType.INT)
.setDescription("Files tangles")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setHidden(true)
.setDeleteHistoricalData(true)
.create();
public static final String FILE_FEEDBACK_EDGES_KEY = "file_feedback_edges";
public static final Metric FILE_FEEDBACK_EDGES = new Metric.Builder(FILE_FEEDBACK_EDGES_KEY, "Suspect file dependencies", Metric.ValueType.INT)
.setDescription("Suspect file dependencies")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setHidden(true)
.setDeleteHistoricalData(true)
.setBestValue(0.0)
.create();
public static final String FILE_EDGES_WEIGHT_KEY = "file_edges_weight";
public static final Metric FILE_EDGES_WEIGHT = new Metric.Builder(FILE_EDGES_WEIGHT_KEY, "File edges weight", Metric.ValueType.INT)
.setDescription("File edges weight")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(false)
.setDomain(DOMAIN_DESIGN)
.setHidden(true)
.setDeleteHistoricalData(true)
.create();
// --------------------------------------------------------------------------------------------------------------------
//
// SCM
// These metrics are computed by the SCM Activity plugin, since version 1.2 and introduced here since version 2.7.
//
// --------------------------------------------------------------------------------------------------------------------
/**
* @since 2.7
*/
public static final String SCM_AUTHORS_BY_LINE_KEY = "authors_by_line";
/**
* Key-value pairs, where key - is a number of line, and value - is an author for this line.
*
* @see org.sonar.api.utils.KeyValueFormat#formatIntString(java.util.Map)
* @see org.sonar.api.utils.KeyValueFormat#parseIntString(String)
* @since 2.7
*/
public static final Metric SCM_AUTHORS_BY_LINE = new Metric.Builder(SCM_AUTHORS_BY_LINE_KEY, "Authors by line", Metric.ValueType.DATA)
.setDomain(DOMAIN_SCM)
.create();
/**
* @since 2.7
*/
public static final String SCM_REVISIONS_BY_LINE_KEY = "revisions_by_line";
/**
* Key-value pairs, where key - is a number of line, and value - is a revision for this line.
*
* @see org.sonar.api.utils.KeyValueFormat#formatIntString(java.util.Map)
* @see org.sonar.api.utils.KeyValueFormat#parseIntString(String)
* @since 2.7
*/
public static final Metric SCM_REVISIONS_BY_LINE = new Metric.Builder(SCM_REVISIONS_BY_LINE_KEY, "Revisions by line", Metric.ValueType.DATA)
.setDomain(DOMAIN_SCM)
.create();
/**
* @since 2.7
*/
public static final String SCM_LAST_COMMIT_DATETIMES_BY_LINE_KEY = "last_commit_datetimes_by_line";
/**
* Key-value pairs, where key - is a number of line, and value - is a date of last commit for this line.
*
* @see org.sonar.api.utils.KeyValueFormat#formatIntDateTime(java.util.Map)
* @see org.sonar.api.utils.KeyValueFormat#parseIntDateTime(String)
* @since 2.7
*/
public static final Metric SCM_LAST_COMMIT_DATETIMES_BY_LINE = new Metric.Builder(SCM_LAST_COMMIT_DATETIMES_BY_LINE_KEY, "Last commit dates by line",
Metric.ValueType.DATA)
.setDomain(DOMAIN_SCM)
.create();
// --------------------------------------------------------------------------------------------------------------------
//
// REVIEWS (since 2.14)
//
// --------------------------------------------------------------------------------------------------------------------
/**
* @since 2.14
* @deprecated in 3.6. This measure is not fed anymore since introduction of issues.
*/
@Deprecated
public static final String UNREVIEWED_VIOLATIONS_KEY = "unreviewed_violations";
/**
* @since 2.14
* @deprecated in 3.6. This measure is not fed anymore since introduction of issues.
*/
@Deprecated
public static final Metric UNREVIEWED_VIOLATIONS = new Metric.Builder(UNREVIEWED_VIOLATIONS_KEY, "Unreviewed violations", Metric.ValueType.INT)
.setDescription("Violations that have not been reviewed yet")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_REVIEWS)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setHidden(true)
.create();
/**
* @since 2.14
* @deprecated in 3.6. This measure is not fed anymore since introduction of issues.
*/
@Deprecated
public static final String NEW_UNREVIEWED_VIOLATIONS_KEY = "new_unreviewed_violations";
/**
* @since 2.14
* @deprecated in 3.6. This measure is not fed anymore since introduction of issues.
*/
@Deprecated
public static final Metric NEW_UNREVIEWED_VIOLATIONS = new Metric.Builder(NEW_UNREVIEWED_VIOLATIONS_KEY, "New unreviewed violations", Metric.ValueType.INT)
.setDescription("New violations that have not been reviewed yet")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setDomain(DOMAIN_REVIEWS)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setDeleteHistoricalData(true)
.setHidden(true)
.create();
/**
* @since 2.14
* @deprecated in 3.6. This measure is replaced by {@link #FALSE_POSITIVE_ISSUES_KEY}.
*/
@Deprecated
public static final String FALSE_POSITIVE_REVIEWS_KEY = "false_positive_reviews";
/**
* @since 2.14
* @deprecated in 3.6. This measure is replaced by {@link #FALSE_POSITIVE_ISSUES}.
*/
@Deprecated
public static final Metric FALSE_POSITIVE_REVIEWS = new Metric.Builder(FALSE_POSITIVE_REVIEWS_KEY, "False-positive reviews", Metric.ValueType.INT)
.setDescription("Active false-positive reviews")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_REVIEWS)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setHidden(true)
.create();
/**
* @since 2.14
* @deprecated in 3.6. This measure is not fed anymore since introduction of issues.
*/
@Deprecated
public static final String ACTIVE_REVIEWS_KEY = "active_reviews";
/**
* @since 2.14
* @deprecated in 3.6. This measure is not fed anymore since introduction of issues.
*/
@Deprecated
public static final Metric ACTIVE_REVIEWS = new Metric.Builder(ACTIVE_REVIEWS_KEY, "Active reviews", Metric.ValueType.INT)
.setDescription("Active open and reopened reviews")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_REVIEWS)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setHidden(true)
.create();
/**
* @since 2.14
* @deprecated in 3.6. This measure is not fed anymore since introduction of issues.
*/
@Deprecated
public static final String UNASSIGNED_REVIEWS_KEY = "unassigned_reviews";
/**
* @since 2.14
* @deprecated in 3.6. This measure is not fed anymore since introduction of issues.
*/
@Deprecated
public static final Metric UNASSIGNED_REVIEWS = new Metric.Builder(UNASSIGNED_REVIEWS_KEY, "Unassigned reviews", Metric.ValueType.INT)
.setDescription("Active unassigned reviews")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_REVIEWS)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setHidden(true)
.create();
/**
* @since 2.14
* @deprecated in 3.6. This measure is not fed anymore since introduction of issues.
*/
@Deprecated
public static final String UNPLANNED_REVIEWS_KEY = "unplanned_reviews";
/**
* @since 2.14
* @deprecated in 3.6. This measure is not fed anymore since introduction of issues.
*/
@Deprecated
public static final Metric UNPLANNED_REVIEWS = new Metric.Builder(UNPLANNED_REVIEWS_KEY, "Unplanned reviews", Metric.ValueType.INT)
.setDescription("Active unplanned reviews")
.setDirection(Metric.DIRECTION_WORST)
.setDomain(DOMAIN_REVIEWS)
.setBestValue(0.0)
.setOptimizedBestValue(true)
.setHidden(true)
.create();
// --------------------------------------------------------------------------------------------------------------------
//
// TECHNICAL DEBT
//
// --------------------------------------------------------------------------------------------------------------------
/**
* @since 4.0
*/
public static final String TECHNICAL_DEBT_KEY = "sqale_index";
/**
* @since 4.0
*/
public static final Metric TECHNICAL_DEBT = new Metric.Builder(TECHNICAL_DEBT_KEY, "Technical Debt", Metric.ValueType.WORK_DUR)
.setDomain(DOMAIN_TECHNICAL_DEBT)
.setDirection(Metric.DIRECTION_WORST)
.setOptimizedBestValue(true)
.setBestValue(0.0)
.setQualitative(true)
.create();
/**
* @since 4.1
*/
public static final String NEW_TECHNICAL_DEBT_KEY = "new_technical_debt";
/**
* @since 4.1
*/
public static final Metric NEW_TECHNICAL_DEBT = new Metric.Builder(NEW_TECHNICAL_DEBT_KEY, "Technical Debt on new code", Metric.ValueType.WORK_DUR)
.setDescription("Technical Debt of new code")
.setDomain(DOMAIN_TECHNICAL_DEBT)
.setDirection(Metric.DIRECTION_WORST)
.setOptimizedBestValue(true)
.setBestValue(0.0)
.setQualitative(true)
.setDeleteHistoricalData(true)
.create();
/**
* @since 4.5
*/
public static final String SQALE_RATING_KEY = "sqale_rating";
/**
* @since 4.5
*/
public static final Metric SQALE_RATING = new Metric.Builder(SQALE_RATING_KEY, "SQALE Rating", Metric.ValueType.RATING)
.setDomain(DOMAIN_TECHNICAL_DEBT)
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(true)
.setBestValue(1.0)
.setWorstValue(5.0)
.create();
/**
* @since 4.5
*/
public static final String DEVELOPMENT_COST_KEY = "development_cost";
/**
* @since 4.5
*/
public static final Metric DEVELOPMENT_COST = new Metric.Builder(DEVELOPMENT_COST_KEY, "SQALE Development Cost", Metric.ValueType.STRING)
.setDomain(DOMAIN_TECHNICAL_DEBT)
.setDirection(Metric.DIRECTION_WORST)
.setOptimizedBestValue(true)
.setBestValue(0.0)
.setQualitative(true)
.setHidden(true)
.create();
/**
* @since 4.5
*/
public static final String SQALE_DEBT_RATIO_KEY = "sqale_debt_ratio";
/**
* @since 4.5
*/
public static final Metric SQALE_DEBT_RATIO = new Metric.Builder(SQALE_DEBT_RATIO_KEY, "SQALE Technical Debt Ratio", Metric.ValueType.PERCENT)
.setDescription("Ratio of the technical debt compared to what it would cost to develop the whole source code from scratch.")
.setDomain(DOMAIN_TECHNICAL_DEBT)
.setDirection(Metric.DIRECTION_WORST)
.setOptimizedBestValue(true)
.setBestValue(0.0)
.setQualitative(true)
.create();
// --------------------------------------------------------------------------------------------------------------------
//
// FILE DATA
//
// --------------------------------------------------------------------------------------------------------------------
/**
* @since 2.14
*/
@Beta
public static final String NCLOC_DATA_KEY = "ncloc_data";
/**
* Information about lines of code in file.
* Key-value pairs, where key - is a number of line, and value - is an indicator of whether line contains code (1) or not (0).
*
* @see org.sonar.api.measures.FileLinesContext
* @since 2.14
*/
@Beta
public static final Metric NCLOC_DATA = new Metric.Builder(NCLOC_DATA_KEY, "ncloc_data", Metric.ValueType.DATA)
.setHidden(true)
.setDomain(DOMAIN_SIZE)
.create();
/**
* @since 2.14
*/
@Beta
public static final String COMMENT_LINES_DATA_KEY = "comment_lines_data";
/**
* Information about comments in file.
* Key-value pairs, where key - is a number of line, and value - is an indicator of whether line contains comment (1) or not (0).
*
* @see org.sonar.api.measures.FileLinesContext
* @since 2.14
*/
@Beta
public static final Metric COMMENT_LINES_DATA = new Metric.Builder(COMMENT_LINES_DATA_KEY, "comment_lines_data", Metric.ValueType.DATA)
.setHidden(true)
.setDomain(DOMAIN_DOCUMENTATION)
.create();
// --------------------------------------------------------------------------------------------------------------------
//
// OTHERS
//
// --------------------------------------------------------------------------------------------------------------------
public static final String ALERT_STATUS_KEY = "alert_status";
public static final Metric ALERT_STATUS = new Metric.Builder(ALERT_STATUS_KEY, "Quality Gate Status", Metric.ValueType.LEVEL)
.setDescription("The project status with regard to its quality gate.")
.setDirection(Metric.DIRECTION_BETTER)
.setQualitative(true)
.setDomain(DOMAIN_GENERAL)
.create();
/**
* @since 4.4
*/
public static final String QUALITY_GATE_DETAILS_KEY = "quality_gate_details";
/**
* The project detailed status with regard to its quality gate.
* Storing the global quality gate status, along with all evaluated conditions, into a JSON object.
* @since 4.4
*/
public static final Metric QUALITY_GATE_DETAILS = new Metric.Builder(QUALITY_GATE_DETAILS_KEY, "Quality Gate Details", Metric.ValueType.DATA)
.setDescription("The project detailed status with regard to its quality gate.")
.setDomain(DOMAIN_GENERAL)
.create();
/**
* @deprecated since 4.4 doesn't support multi-language. See {@link #QUALITY_PROFILES_KEY}
*/
@Deprecated
public static final String PROFILE_KEY = "profile";
/**
* @deprecated since 4.4 doesn't support multi-language. See {@link #QUALITY_PROFILES_KEY}
*/
@Deprecated
public static final Metric PROFILE = new Metric.Builder(PROFILE_KEY, "Profile", Metric.ValueType.DATA)
.setDescription("Selected quality profile")
.setDomain(DOMAIN_GENERAL)
.create();
/**
* @since 2.9
* @deprecated since 4.4 doesn't support multi-language. See {@link #QUALITY_PROFILES_KEY}
*/
@Deprecated
public static final String PROFILE_VERSION_KEY = "profile_version";
/**
* @since 2.9
* @deprecated since 4.4 doesn't support multi-language. See {@link #QUALITY_PROFILES_KEY}
*/
@Deprecated
public static final Metric PROFILE_VERSION = new Metric.Builder(PROFILE_VERSION_KEY, "Profile version", Metric.ValueType.INT)
.setDescription("Selected quality profile version")
.setQualitative(false)
.setDomain(DOMAIN_GENERAL)
.setHidden(true)
.create();
/**
* @since 4.4
*/
public static final String QUALITY_PROFILES_KEY = "quality_profiles";
/**
* @since 4.4
*/
public static final Metric QUALITY_PROFILES = new Metric.Builder(QUALITY_PROFILES_KEY, "Profiles", Metric.ValueType.DATA)
.setDescription("Details of quality profiles used during analysis")
.setQualitative(false)
.setDomain(DOMAIN_GENERAL)
.setHidden(true)
.create();
private static final List METRICS;
static {
METRICS = Lists.newLinkedList();
for (Field field : CoreMetrics.class.getFields()) {
if (Metric.class.isAssignableFrom(field.getType())) {
try {
Metric metric = (Metric) field.get(null);
METRICS.add(metric);
} catch (IllegalAccessException e) {
throw new SonarException("can not introspect " + CoreMetrics.class + " to get metrics", e);
}
}
}
}
private CoreMetrics() {
// only static stuff
}
public static List getMetrics() {
return METRICS;
}
public static Metric getMetric(final String key) {
return Iterables.find(METRICS, new Predicate() {
@Override
public boolean apply(@Nullable Metric input) {
return input != null && input.getKey().equals(key);
}
});
}
}