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
81
82
83
84
85
86
87
88
89
90
91
|
/*
* SonarQube
* Copyright (C) 2009-2025 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.scan.filesystem;
import java.util.Collection;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
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.utils.WildcardPattern;
@Immutable
public abstract class AbstractCoverageAndDuplicationExclusions {
private static final Logger LOG = LoggerFactory.getLogger(AbstractCoverageAndDuplicationExclusions.class);
private final Function<DefaultInputFile, String> pathExtractor;
private final String[] coverageExclusionConfig;
private final String[] duplicationExclusionConfig;
private final Collection<WildcardPattern> coverageExclusionPatterns;
private final Collection<WildcardPattern> duplicationExclusionPatterns;
public AbstractCoverageAndDuplicationExclusions(Function<String, String[]> configProvider, Function<DefaultInputFile, String> pathExtractor) {
this.pathExtractor = pathExtractor;
coverageExclusionConfig = configProvider.apply(CoreProperties.PROJECT_COVERAGE_EXCLUSIONS_PROPERTY);
coverageExclusionPatterns = Stream.of(coverageExclusionConfig).map(WildcardPattern::create).toList();
duplicationExclusionConfig = configProvider.apply(CoreProperties.CPD_EXCLUSIONS);
duplicationExclusionPatterns = Stream.of(duplicationExclusionConfig).map(WildcardPattern::create).toList();
}
public String[] getCoverageExclusionConfig() {
return coverageExclusionConfig;
}
public String[] getDuplicationExclusionConfig() {
return duplicationExclusionConfig;
}
void log(String indent) {
if (!coverageExclusionPatterns.isEmpty()) {
log("Excluded sources for coverage:", coverageExclusionPatterns, indent);
}
if (!duplicationExclusionPatterns.isEmpty()) {
log("Excluded sources for duplication:", duplicationExclusionPatterns, indent);
}
}
public boolean isExcludedForCoverage(DefaultInputFile file) {
return isExcluded(file, coverageExclusionPatterns);
}
public boolean isExcludedForDuplication(DefaultInputFile file) {
return isExcluded(file, duplicationExclusionPatterns);
}
private boolean isExcluded(DefaultInputFile file, Collection<WildcardPattern> patterns) {
if (patterns.isEmpty()) {
return false;
}
final String path = pathExtractor.apply(file);
return patterns
.stream()
.anyMatch(p -> p.match(path));
}
private static void log(String title, Collection<WildcardPattern> patterns, String ident) {
if (!patterns.isEmpty() && LOG.isInfoEnabled()) {
LOG.info("{}{} {}", ident, title, patterns.stream().map(WildcardPattern::toString).collect(Collectors.joining(", ")));
}
}
}
|
