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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2014 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube 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.
*
* SonarQube 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.batch.rule;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;
import org.sonar.api.batch.debt.internal.DefaultDebtCharacteristic;
import org.sonar.api.batch.debt.internal.DefaultDebtModel;
import org.sonar.api.batch.rule.DebtRemediationFunction;
import org.sonar.api.batch.rule.Rule;
import org.sonar.api.batch.rule.RuleParam;
import org.sonar.api.batch.rule.Rules;
import org.sonar.api.config.Settings;
import org.sonar.api.rule.RuleKey;
import org.sonar.api.rule.Severity;
import org.sonar.api.utils.Duration;
import org.sonar.api.utils.Durations;
import org.sonar.core.persistence.AbstractDaoTestCase;
import org.sonar.core.rule.RuleDao;
import static org.fest.assertions.Assertions.assertThat;
import static org.fest.assertions.Fail.fail;
@RunWith(MockitoJUnitRunner.class)
public class RulesProviderTest extends AbstractDaoTestCase {
@Mock
Durations durations;
RuleDao ruleDao;
DefaultDebtModel debtModel;
RulesProvider provider;
@Before
public void setUp() throws Exception {
debtModel = new DefaultDebtModel()
.addCharacteristic(new DefaultDebtCharacteristic()
.setId(100)
.setKey("MEMORY_EFFICIENCY")
.setName("Memory use")
.setOrder(1))
.addCharacteristic(new DefaultDebtCharacteristic()
.setId(101)
.setKey("EFFICIENCY")
.setName("Efficiency")
.setParentId(100));
debtModel
.addCharacteristic(new DefaultDebtCharacteristic()
.setId(102)
.setKey("COMPILER_RELATED_PORTABILITY")
.setName("Compiler")
.setOrder(1))
.addCharacteristic(new DefaultDebtCharacteristic()
.setId(103)
.setKey("PORTABILITY")
.setName("Portability")
.setParentId(102));
durations = new Durations(new Settings().setProperty("sonar.technicalDebt.hoursInDay", 8), null);
ruleDao = new RuleDao(getMyBatis());
provider = new RulesProvider();
}
@Test
public void build_rules() throws Exception {
setupData("shared");
Rules rules = provider.provide(ruleDao, debtModel, durations);
assertThat(rules.findAll()).hasSize(1);
assertThat(rules.findByRepository("checkstyle")).hasSize(1);
assertThat(rules.findByRepository("unknown")).isEmpty();
Rule rule = rules.find(RuleKey.of("checkstyle", "AvoidNull"));
assertThat(rule).isNotNull();
assertThat(rule.key()).isEqualTo(RuleKey.of("checkstyle", "AvoidNull"));
assertThat(rule.name()).isEqualTo("Avoid Null");
assertThat(rule.description()).isEqualTo("Should avoid NULL");
assertThat(rule.severity()).isEqualTo(Severity.MINOR);
assertThat(rule.metadata()).isNull();
assertThat(rule.params()).hasSize(1);
RuleParam param = rule.param("myParameter");
assertThat(param).isNotNull();
assertThat(param.description()).isEqualTo("My Parameter");
}
@Test
public void build_rules_with_default_debt_definitions() throws Exception {
setupData("build_rules_with_default_debt_definitions");
Rules rules = provider.provide(ruleDao, debtModel, durations);
Rule rule = rules.find(RuleKey.of("checkstyle", "AvoidNull"));
assertThat(rule.debtSubCharacteristic()).isEqualTo("EFFICIENCY");
assertThat(rule.debtRemediationFunction()).isEqualTo(DebtRemediationFunction.createLinearWithOffset(Duration.decode("5d", 8), Duration.decode("10h", 8)));
}
@Test
public void build_rules_with_overridden_debt_definitions() throws Exception {
setupData("build_rules_with_overridden_debt_definitions");
Rules rules = provider.provide(ruleDao, debtModel, durations);
Rule rule = rules.find(RuleKey.of("checkstyle", "AvoidNull"));
assertThat(rule.debtSubCharacteristic()).isEqualTo("PORTABILITY");
assertThat(rule.debtRemediationFunction()).isEqualTo(DebtRemediationFunction.createLinear(Duration.decode("2h", 8)));
}
@Test
public void build_rules_with_default_and_overridden_debt_definitions() throws Exception {
setupData("build_rules_with_default_and_overridden_debt_definitions");
Rules rules = provider.provide(ruleDao, debtModel, durations);
// As both default columns and user columns on debt are set, user debt columns should be used
Rule rule = rules.find(RuleKey.of("checkstyle", "AvoidNull"));
assertThat(rule.debtSubCharacteristic()).isEqualTo("PORTABILITY");
assertThat(rule.debtRemediationFunction()).isEqualTo(DebtRemediationFunction.createLinear(Duration.decode("2h", 8)));
}
@Test
public void build_rules_with_default_characteristic_and_overridden_function() throws Exception {
setupData("build_rules_with_default_characteristic_and_overridden_function");
Rules rules = provider.provide(ruleDao, debtModel, durations);
// As both default columns and user columns on debt are set, user debt columns should be used
Rule rule = rules.find(RuleKey.of("checkstyle", "AvoidNull"));
assertThat(rule.debtSubCharacteristic()).isEqualTo("PORTABILITY");
assertThat(rule.debtRemediationFunction()).isEqualTo(DebtRemediationFunction.createLinear(Duration.decode("2h", 8)));
}
@Test
public void build_rules_with_overridden_characteristic_and_default_function() throws Exception {
setupData("build_rules_with_overridden_characteristic_and_default_function");
Rules rules = provider.provide(ruleDao, debtModel, durations);
// As both default columns and user columns on debt are set, user debt columns should be used
Rule rule = rules.find(RuleKey.of("checkstyle", "AvoidNull"));
assertThat(rule.debtSubCharacteristic()).isEqualTo("PORTABILITY");
assertThat(rule.debtRemediationFunction()).isEqualTo(DebtRemediationFunction.createLinear(Duration.decode("2h", 8)));
}
@Test
public void build_rules_with_disable_characteristic() throws Exception {
setupData("build_rules_with_disable_characteristic");
Rules rules = provider.provide(ruleDao, debtModel, durations);
Rule rule = rules.find(RuleKey.of("checkstyle", "AvoidNull"));
assertThat(rule.debtSubCharacteristic()).isNull();
assertThat(rule.debtRemediationFunction()).isNull();
}
@Test
public void build_rules_with_default_characteristic_and_disable_characteristic() throws Exception {
setupData("build_rules_with_default_characteristic_and_disable_characteristic");
Rules rules = provider.provide(ruleDao, debtModel, durations);
Rule rule = rules.find(RuleKey.of("checkstyle", "AvoidNull"));
assertThat(rule.debtSubCharacteristic()).isNull();
assertThat(rule.debtRemediationFunction()).isNull();
}
@Test
public void fail_if_characteristic_not_found() throws Exception {
setupData("fail_if_characteristic_not_found");
try {
provider.provide(ruleDao, debtModel, durations);
fail();
} catch (Exception e) {
assertThat(e).isInstanceOf(IllegalStateException.class).hasMessage("Sub characteristic id '999' on rule 'checkstyle:AvoidNull' has not been found");
}
}
@Test
public void fail_if_no_function() throws Exception {
setupData("fail_if_no_function");
try {
provider.provide(ruleDao, debtModel, durations);
fail();
} catch (Exception e) {
assertThat(e).isInstanceOf(IllegalStateException.class).hasMessage("Remediation function should not be null on rule 'checkstyle:AvoidNull'");
}
}
}
|
