aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-scanner-engine/src/main/java/org/sonar/scanner/phases/AbstractCoverageExclusions.java
blob: 0690f02f539a4293b3318f3ebc57e1b9ee62e9b4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/*
 * SonarQube
 * Copyright (C) 2009-2019 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program 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.
 *
 * This program 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.scanner.phases;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableList.Builder;
import java.util.Collection;
import java.util.Iterator;
import java.util.function.Function;
import javax.annotation.concurrent.Immutable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.CoreProperties;
import org.sonar.api.batch.fs.internal.DefaultInputFile;
import org.sonar.api.config.Configuration;
import org.sonar.api.utils.WildcardPattern;

@Immutable
public abstract class AbstractCoverageExclusions {
  private static final Logger LOG = LoggerFactory.getLogger(AbstractCoverageExclusions.class);
  private final Function<DefaultInputFile, String> pathExtractor;
  private final String[] coverageExclusionConfig;

  private Collection<WildcardPattern> exclusionPatterns;

  public AbstractCoverageExclusions(Configuration config, Function<DefaultInputFile, String> pathExtractor) {
    this.pathExtractor = pathExtractor;
    Builder<WildcardPattern> builder = ImmutableList.builder();
    coverageExclusionConfig = config.getStringArray(CoreProperties.PROJECT_COVERAGE_EXCLUSIONS_PROPERTY);
    for (String pattern : coverageExclusionConfig) {
      builder.add(WildcardPattern.create(pattern));
    }
    exclusionPatterns = builder.build();
  }

  public String[] getCoverageExclusionConfig() {
    return coverageExclusionConfig;
  }

  void log() {
    if (!exclusionPatterns.isEmpty()) {
      log("Excluded sources for coverage: ", exclusionPatterns);
    }
  }

  boolean isExcluded(DefaultInputFile file) {
    boolean found = false;
    Iterator<WildcardPattern> iterator = exclusionPatterns.iterator();
    while (!found && iterator.hasNext()) {
      found = iterator.next().match(pathExtractor.apply(file));
    }
    return found;
  }

  private static void log(String title, Collection<WildcardPattern> patterns) {
    if (!patterns.isEmpty()) {
      LOG.info(title);
      for (WildcardPattern pattern : patterns) {
        LOG.info("  {}", pattern);
      }
    }
  }
}