/
DuplicationMeasures.java
200 lines (177 loc) · 8.14 KB
/
DuplicationMeasures.java
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/*
* SonarQube
* Copyright (C) 2009-2024 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.ce.task.projectanalysis.duplication;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import javax.inject.Inject;
import org.sonar.ce.task.projectanalysis.component.Component;
import org.sonar.ce.task.projectanalysis.component.PathAwareCrawler;
import org.sonar.ce.task.projectanalysis.component.TreeRootHolder;
import org.sonar.ce.task.projectanalysis.formula.Counter;
import org.sonar.ce.task.projectanalysis.formula.CounterInitializationContext;
import org.sonar.ce.task.projectanalysis.formula.CreateMeasureContext;
import org.sonar.ce.task.projectanalysis.formula.Formula;
import org.sonar.ce.task.projectanalysis.formula.FormulaExecutorComponentVisitor;
import org.sonar.ce.task.projectanalysis.measure.Measure;
import org.sonar.ce.task.projectanalysis.measure.MeasureRepository;
import org.sonar.ce.task.projectanalysis.metric.MetricRepository;
import static com.google.common.collect.Iterables.isEmpty;
import static java.util.Objects.requireNonNull;
import static org.sonar.api.measures.CoreMetrics.DUPLICATED_BLOCKS_KEY;
import static org.sonar.api.measures.CoreMetrics.DUPLICATED_FILES_KEY;
import static org.sonar.api.measures.CoreMetrics.DUPLICATED_LINES_DENSITY_KEY;
import static org.sonar.api.measures.CoreMetrics.DUPLICATED_LINES_KEY;
import static org.sonar.api.measures.CoreMetrics.LINES_KEY;
public class DuplicationMeasures {
protected final List<Formula<?>> formulas;
protected final TreeRootHolder treeRootHolder;
protected final MetricRepository metricRepository;
protected final MeasureRepository measureRepository;
private final DuplicationRepository duplicationRepository;
@Inject
public DuplicationMeasures(TreeRootHolder treeRootHolder, MetricRepository metricRepository, MeasureRepository measureRepository,
@Nullable DuplicationRepository duplicationRepository) {
this.treeRootHolder = treeRootHolder;
this.metricRepository = metricRepository;
this.measureRepository = measureRepository;
// will be null for views
this.duplicationRepository = duplicationRepository;
this.formulas = List.of(new DuplicationFormula());
}
public DuplicationMeasures(TreeRootHolder treeRootHolder, MetricRepository metricRepository, MeasureRepository measureRepository) {
this(treeRootHolder, metricRepository, measureRepository, null);
}
public void execute() {
new PathAwareCrawler<>(
FormulaExecutorComponentVisitor.newBuilder(metricRepository, measureRepository).buildFor(formulas))
.visit(treeRootHolder.getReportTreeRoot());
}
protected DuplicationCounter createCounter() {
return new DuplicationCounter(duplicationRepository);
}
protected static class DuplicationCounter implements Counter<DuplicationCounter> {
@CheckForNull
private final DuplicationRepository duplicationRepository;
protected int fileCount = 0;
protected int blockCount = 0;
protected int dupLineCount = 0;
protected int lineCount = 0;
private DuplicationCounter(@Nullable DuplicationRepository duplicationRepository) {
this.duplicationRepository = duplicationRepository;
}
@Override
public void aggregate(DuplicationCounter counter) {
this.fileCount += counter.fileCount;
this.blockCount += counter.blockCount;
this.dupLineCount += counter.dupLineCount;
this.lineCount += counter.lineCount;
}
@Override
public void initialize(CounterInitializationContext context) {
Component leaf = context.getLeaf();
if (leaf.getType() == Component.Type.FILE && !leaf.getFileAttributes().isUnitTest()) {
initializeForFile(leaf);
} else if (leaf.getType() == Component.Type.PROJECT_VIEW) {
initializeForProjectView(context);
}
}
protected void initializeForFile(Component file) {
// don't use measure since it won't be available for some files in the report tree in PRs
this.lineCount = file.getFileAttributes().getLines();
Iterable<Duplication> duplications = requireNonNull(this.duplicationRepository, "DuplicationRepository missing")
.getDuplications(file);
if (isEmpty(duplications)) {
return;
}
// use a set to count lines only once
Set<Integer> duplicatedLineNumbers = new HashSet<>();
int blocks = 0;
for (Duplication duplication : duplications) {
blocks++;
addLines(duplication.getOriginal(), duplicatedLineNumbers);
InnerDuplicate[] innerDuplicates = Arrays.stream(duplication.getDuplicates())
.filter(InnerDuplicate.class::isInstance)
.map(InnerDuplicate.class::cast)
.toArray(InnerDuplicate[]::new);
for (InnerDuplicate innerDuplicate : innerDuplicates) {
blocks++;
addLines(innerDuplicate.getTextBlock(), duplicatedLineNumbers);
}
}
this.fileCount += 1;
this.blockCount += blocks;
this.dupLineCount += duplicatedLineNumbers.size();
}
private static void addLines(TextBlock textBlock, Set<Integer> duplicatedLineNumbers) {
for (int i = textBlock.getStart(); i <= textBlock.getEnd(); i++) {
duplicatedLineNumbers.add(i);
}
}
private void initializeForProjectView(CounterInitializationContext context) {
fileCount += getMeasure(context, DUPLICATED_FILES_KEY);
blockCount += getMeasure(context, DUPLICATED_BLOCKS_KEY);
dupLineCount += getMeasure(context, DUPLICATED_LINES_KEY);
lineCount += getMeasure(context, LINES_KEY);
}
private static int getMeasure(CounterInitializationContext context, String metricKey) {
Optional<Measure> files = context.getMeasure(metricKey);
return files.map(Measure::getIntValue).orElse(0);
}
}
private final class DuplicationFormula implements Formula<DuplicationCounter> {
@Override
public DuplicationCounter createNewCounter() {
return createCounter();
}
@Override
public Optional<Measure> createMeasure(DuplicationCounter counter, CreateMeasureContext context) {
switch (context.getMetric().getKey()) {
case DUPLICATED_FILES_KEY:
return Optional.of(Measure.newMeasureBuilder().create(counter.fileCount));
case DUPLICATED_LINES_KEY:
return Optional.of(Measure.newMeasureBuilder().create(counter.dupLineCount));
case DUPLICATED_LINES_DENSITY_KEY:
return createDuplicatedLinesDensityMeasure(counter, context);
case DUPLICATED_BLOCKS_KEY:
return Optional.of(Measure.newMeasureBuilder().create(counter.blockCount));
default:
throw new IllegalArgumentException("Unsupported metric " + context.getMetric());
}
}
private Optional<Measure> createDuplicatedLinesDensityMeasure(DuplicationCounter counter, CreateMeasureContext context) {
int duplicatedLines = counter.dupLineCount;
int nbLines = counter.lineCount;
if (nbLines > 0) {
double density = Math.min(100.0, 100.0 * duplicatedLines / nbLines);
return Optional.of(Measure.newMeasureBuilder().create(density, context.getMetric().getDecimalScale()));
}
return Optional.empty();
}
@Override
public String[] getOutputMetricKeys() {
return new String[] {DUPLICATED_FILES_KEY, DUPLICATED_LINES_KEY, DUPLICATED_LINES_DENSITY_KEY, DUPLICATED_BLOCKS_KEY};
}
}
}