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
|
/*
* SonarQube
* Copyright (C) 2009-2016 SonarSource SA
* mailto:contact 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 it.qualityModel;
import com.sonar.orchestrator.Orchestrator;
import com.sonar.orchestrator.locator.FileLocation;
import it.Category2Suite;
import java.util.List;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.ClassRule;
import org.junit.Test;
import org.sonar.wsclient.services.Measure;
import org.sonar.wsclient.services.Resource;
import org.sonar.wsclient.services.ResourceQuery;
import util.ItUtils;
import static org.assertj.core.api.Assertions.assertThat;
import static util.ItUtils.setServerProperty;
/**
* SONAR-4776
*/
public class TechnicalDebtMeasureVariationTest {
@ClassRule
public static Orchestrator orchestrator = Category2Suite.ORCHESTRATOR;
@BeforeClass
public static void initPeriods() throws Exception {
setServerProperty(orchestrator, "sonar.timemachine.period1", "previous_analysis");
setServerProperty(orchestrator, "sonar.timemachine.period2", "30");
setServerProperty(orchestrator, "sonar.timemachine.period3", "previous_analysis");
}
@AfterClass
public static void resetPeriods() throws Exception {
ItUtils.resetPeriods(orchestrator);
}
@Before
public void cleanUpAnalysisData() {
orchestrator.resetData();
}
@Test
public void new_technical_debt_measures_from_new_issues() throws Exception {
// This test assumes that period 1 is "since previous analysis" and 2 is "over x days"
// Execute an analysis in the past to have a past snapshot without any issues
provisionSampleProject();
setSampleProjectQualityProfile("empty");
runSampleProjectAnalysis("sonar.projectDate", "2013-01-01");
// Second analysis -> issues will be created
defineQualityProfile("one-issue-per-line");
setSampleProjectQualityProfile("one-issue-per-line");
runSampleProjectAnalysis();
// New technical debt only comes from new issues
Resource newTechnicalDebt = getSampleProjectResourceWithVariations("new_technical_debt");
List<Measure> measures = newTechnicalDebt.getMeasures();
assertThat(measures.get(0).getVariation1()).isEqualTo(17);
assertThat(measures.get(0).getVariation2()).isEqualTo(17);
// Third analysis, with exactly the same profile -> no new issues so no new technical debt
runSampleProjectAnalysis();
newTechnicalDebt = orchestrator.getServer().getWsClient()
.find(ResourceQuery.createForMetrics("sample:src/main/xoo/sample/Sample.xoo", "new_technical_debt").setIncludeTrends(true));
// No variation => measure is purged
assertThat(newTechnicalDebt).isNull();
}
@Test
public void new_technical_debt_measures_from_technical_debt_update_since_previous_analysis() throws Exception {
// This test assumes that period 1 is "since previous analysis"
// Execute twice analysis
defineQualityProfile("one-issue-per-file");
provisionSampleProject();
setSampleProjectQualityProfile("one-issue-per-file");
runSampleProjectAnalysis();
runSampleProjectAnalysis();
// Third analysis, existing issues on OneIssuePerFile will have their technical debt updated with the effort to fix
runSampleProjectAnalysis("sonar.oneIssuePerFile.effortToFix", "10");
Resource newTechnicalDebt = getSampleProjectResourceWithVariations("new_technical_debt");
List<Measure> measures = newTechnicalDebt.getMeasures();
assertThat(measures.get(0).getVariation1()).isEqualTo(90);
// Fourth analysis, with exactly the same profile -> no new issues so no new technical debt since previous analysis
runSampleProjectAnalysis("sonar.oneIssuePerFile.effortToFix", "10");
newTechnicalDebt = getSampleProjectResourceWithVariations("new_technical_debt");
measures = newTechnicalDebt.getMeasures();
assertThat(measures.get(0).getVariation1()).isEqualTo(0);
}
@Test
public void new_technical_debt_measures_from_technical_debt_update_since_30_days() throws Exception {
// This test assumes that period 2 is "over x days"
// Execute an analysis in the past to have a past snapshot without any issues
provisionSampleProject();
setSampleProjectQualityProfile("empty");
runSampleProjectAnalysis("sonar.projectDate", "2013-01-01");
// Second analysis -> issues will be created
String profileXmlFile = "one-issue-per-file";
defineQualityProfile(profileXmlFile);
setSampleProjectQualityProfile("one-issue-per-file");
runSampleProjectAnalysis();
// Third analysis, existing issues on OneIssuePerFile will have their technical debt updated with the effort to fix
runSampleProjectAnalysis("sonar.oneIssuePerFile.effortToFix", "10");
Resource newTechnicalDebt = getSampleProjectResourceWithVariations("new_technical_debt");
List<Measure> measures = newTechnicalDebt.getMeasures();
assertThat(measures.get(0).getVariation2()).isEqualTo(90);
// Fourth analysis, with exactly the same profile -> no new issues so no new technical debt since previous analysis but still since 30
// days
runSampleProjectAnalysis("sonar.oneIssuePerFile.effortToFix", "10");
newTechnicalDebt = getSampleProjectResourceWithVariations("new_technical_debt");
measures = newTechnicalDebt.getMeasures();
assertThat(measures.get(0).getVariation2()).isEqualTo(90);
}
/**
* SONAR-5059
*/
@Test
public void new_technical_debt_measures_should_never_be_negative() throws Exception {
// This test assumes that period 1 is "since previous analysis" and 2 is "over x days"
// Execute an analysis with a big effort to fix
defineQualityProfile("one-issue-per-file");
provisionSampleProject();
setSampleProjectQualityProfile("one-issue-per-file");
runSampleProjectAnalysis("sonar.oneIssuePerFile.effortToFix", "100");
// Execute a second analysis with a smaller effort to fix -> Added technical debt should be 0, not negative
runSampleProjectAnalysis("sonar.oneIssuePerFile.effortToFix", "10");
Resource newTechnicalDebt = getSampleProjectResourceWithVariations("new_technical_debt");
assertThat(newTechnicalDebt).isNull();
}
private void setSampleProjectQualityProfile(String qualityProfileKey) {
orchestrator.getServer().associateProjectToQualityProfile("sample", "xoo", qualityProfileKey);
}
private void provisionSampleProject() {
orchestrator.getServer().provisionProject("sample", "sample");
}
private void defineQualityProfile(String qualityProfileKey) {
orchestrator.getServer().restoreProfile(FileLocation.ofClasspath("/measure/" + qualityProfileKey + ".xml"));
}
private void runSampleProjectAnalysis(String... properties) {
ItUtils.runVerboseProjectAnalysis(TechnicalDebtMeasureVariationTest.orchestrator, "shared/xoo-sample", properties);
}
private Resource getSampleProjectResourceWithVariations(String metricKey) {
return orchestrator.getServer().getWsClient().find(ResourceQuery.createForMetrics("sample:src/main/xoo/sample/Sample.xoo", metricKey).setIncludeTrends(true));
}
}
|
