001/*
002 * SonarQube
003 * Copyright (C) 2009-2017 SonarSource SA
004 * mailto:info AT sonarsource DOT com
005 *
006 * This program is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.batch.sensor.coverage;
021
022import com.google.common.collect.ImmutableSet;
023import java.util.Set;
024import org.sonar.api.measures.Metric;
025
026import static org.sonar.api.measures.CoreMetrics.CONDITIONS_BY_LINE;
027import static org.sonar.api.measures.CoreMetrics.CONDITIONS_TO_COVER;
028import static org.sonar.api.measures.CoreMetrics.COVERAGE_LINE_HITS_DATA;
029import static org.sonar.api.measures.CoreMetrics.COVERED_CONDITIONS_BY_LINE;
030import static org.sonar.api.measures.CoreMetrics.IT_CONDITIONS_BY_LINE;
031import static org.sonar.api.measures.CoreMetrics.IT_CONDITIONS_TO_COVER;
032import static org.sonar.api.measures.CoreMetrics.IT_COVERAGE_LINE_HITS_DATA;
033import static org.sonar.api.measures.CoreMetrics.IT_COVERED_CONDITIONS_BY_LINE;
034import static org.sonar.api.measures.CoreMetrics.IT_LINES_TO_COVER;
035import static org.sonar.api.measures.CoreMetrics.IT_UNCOVERED_CONDITIONS;
036import static org.sonar.api.measures.CoreMetrics.IT_UNCOVERED_LINES;
037import static org.sonar.api.measures.CoreMetrics.LINES_TO_COVER;
038import static org.sonar.api.measures.CoreMetrics.OVERALL_CONDITIONS_BY_LINE;
039import static org.sonar.api.measures.CoreMetrics.OVERALL_CONDITIONS_TO_COVER;
040import static org.sonar.api.measures.CoreMetrics.OVERALL_COVERAGE_LINE_HITS_DATA;
041import static org.sonar.api.measures.CoreMetrics.OVERALL_COVERED_CONDITIONS_BY_LINE;
042import static org.sonar.api.measures.CoreMetrics.OVERALL_LINES_TO_COVER;
043import static org.sonar.api.measures.CoreMetrics.OVERALL_UNCOVERED_CONDITIONS;
044import static org.sonar.api.measures.CoreMetrics.OVERALL_UNCOVERED_LINES;
045import static org.sonar.api.measures.CoreMetrics.UNCOVERED_CONDITIONS;
046import static org.sonar.api.measures.CoreMetrics.UNCOVERED_LINES;
047
048/**
049 * Different coverage categories.
050 * @since 5.2
051 *
052 * @deprecated since 6.2 SonarQube merge all coverage reports and don't keep track of different test category
053 */
054@Deprecated
055public enum CoverageType {
056
057  UNIT(LINES_TO_COVER, UNCOVERED_LINES, COVERAGE_LINE_HITS_DATA, CONDITIONS_TO_COVER, UNCOVERED_CONDITIONS, COVERED_CONDITIONS_BY_LINE, CONDITIONS_BY_LINE),
058  IT(IT_LINES_TO_COVER, IT_UNCOVERED_LINES, IT_COVERAGE_LINE_HITS_DATA, IT_CONDITIONS_TO_COVER, IT_UNCOVERED_CONDITIONS, IT_COVERED_CONDITIONS_BY_LINE, IT_CONDITIONS_BY_LINE),
059  OVERALL(OVERALL_LINES_TO_COVER, OVERALL_UNCOVERED_LINES, OVERALL_COVERAGE_LINE_HITS_DATA, OVERALL_CONDITIONS_TO_COVER, OVERALL_UNCOVERED_CONDITIONS,
060    OVERALL_COVERED_CONDITIONS_BY_LINE, OVERALL_CONDITIONS_BY_LINE);
061
062  private final Metric linesToCover;
063  private final Metric uncoveredLines;
064  private final Metric lineHitsData;
065  private final Metric conditionsToCover;
066  private final Metric uncoveredConditions;
067  private final Metric coveredConditionsByLine;
068  private final Metric conditionsByLine;
069  private final Set<Metric> all;
070
071  CoverageType(Metric linesToCover, Metric uncoveredLines, Metric lineHitsData, Metric conditionsToCover, Metric uncoveredConditions, Metric coveredConditionsByLine,
072    Metric conditionsByLine) {
073    this.linesToCover = linesToCover;
074    this.uncoveredLines = uncoveredLines;
075    this.lineHitsData = lineHitsData;
076    this.conditionsToCover = conditionsToCover;
077    this.uncoveredConditions = uncoveredConditions;
078    this.coveredConditionsByLine = coveredConditionsByLine;
079    this.conditionsByLine = conditionsByLine;
080    this.all = ImmutableSet.of(linesToCover, uncoveredLines, lineHitsData, conditionsToCover, uncoveredConditions, coveredConditionsByLine, conditionsByLine);
081  }
082
083  public Set<Metric> allMetrics() {
084    return all;
085  }
086
087  public Metric linesToCover() {
088    return linesToCover;
089  }
090
091  public Metric uncoveredLines() {
092    return uncoveredLines;
093  }
094
095  public Metric lineHitsData() {
096    return lineHitsData;
097  }
098
099  public Metric conditionsToCover() {
100    return conditionsToCover;
101  }
102
103  public Metric uncoveredConditions() {
104    return uncoveredConditions;
105  }
106
107  public Metric coveredConditionsByLine() {
108    return coveredConditionsByLine;
109  }
110
111  public Metric conditionsByLine() {
112    return conditionsByLine;
113  }
114
115}