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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
|
/*
* 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.server.rule;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;
import org.sonar.api.rule.RuleKey;
import org.sonar.api.utils.System2;
import org.sonar.core.permission.GlobalPermissions;
import org.sonar.core.persistence.DbSession;
import org.sonar.core.rule.RuleDto;
import org.sonar.core.technicaldebt.db.CharacteristicDao;
import org.sonar.core.technicaldebt.db.CharacteristicDto;
import org.sonar.server.db.DbClient;
import org.sonar.server.exceptions.BadRequestException;
import org.sonar.server.exceptions.NotFoundException;
import org.sonar.server.rule.RuleOperations.RuleChange;
import org.sonar.server.rule.db.RuleDao;
import org.sonar.server.user.MockUserSession;
import org.sonar.server.user.UserSession;
import static org.fest.assertions.Assertions.assertThat;
import static org.mockito.Matchers.any;
import static org.mockito.Matchers.eq;
import static org.mockito.Mockito.*;
@RunWith(MockitoJUnitRunner.class)
public class RuleOperationsTest {
@Mock
DbClient dbClient;
@Mock
DbSession session;
@Mock
RuleDao ruleDao;
@Mock
CharacteristicDao characteristicDao;
@Captor
ArgumentCaptor<RuleDto> ruleCaptor;
UserSession authorizedUserSession = MockUserSession.create().setLogin("nicolas").setName("Nicolas").setGlobalPermissions(GlobalPermissions.QUALITY_PROFILE_ADMIN);
RuleOperations operations;
@Before
public void setUp() throws Exception {
when(dbClient.openSession(false)).thenReturn(session);
when(dbClient.ruleDao()).thenReturn(ruleDao);
when(dbClient.debtCharacteristicDao()).thenReturn(characteristicDao);
operations = new RuleOperations(dbClient, System2.INSTANCE);
}
@Test
public void update_rule() throws Exception {
RuleDto dto = new RuleDto().setId(1).setRepositoryKey("squid").setRuleKey("UselessImportCheck")
.setSubCharacteristicId(6).setRemediationFunction("CONSTANT_ISSUE").setRemediationOffset("10min");
RuleKey ruleKey = RuleKey.of("squid", "UselessImportCheck");
when(ruleDao.getNullableByKey(session, ruleKey)).thenReturn(dto);
CharacteristicDto subCharacteristic = new CharacteristicDto().setId(2).setKey("COMPILER").setName("Compiler").setParentId(1);
when(characteristicDao.selectByKey("COMPILER", session)).thenReturn(subCharacteristic);
// Call when reindexing rule in E/S
when(characteristicDao.selectById(2, session)).thenReturn(subCharacteristic);
CharacteristicDto characteristic = new CharacteristicDto().setId(1).setKey("PORTABILITY").setName("Portability").setOrder(2);
when(characteristicDao.selectById(1, session)).thenReturn(characteristic);
operations.updateRule(
new RuleChange().setRuleKey(ruleKey).setDebtCharacteristicKey("COMPILER")
.setDebtRemediationFunction("LINEAR_OFFSET").setDebtRemediationCoefficient("2h").setDebtRemediationOffset("20min"),
authorizedUserSession
);
verify(ruleDao).update(eq(session), ruleCaptor.capture());
verify(session).commit();
RuleDto result = ruleCaptor.getValue();
assertThat(result.getId()).isEqualTo(1);
assertThat(result.getSubCharacteristicId()).isEqualTo(2);
assertThat(result.getRemediationFunction()).isEqualTo("LINEAR_OFFSET");
assertThat(result.getRemediationCoefficient()).isEqualTo("2h");
assertThat(result.getRemediationOffset()).isEqualTo("20min");
}
@Test
public void update_rule_set_overridden_values_to_null_when_new_values_are_equals_to_default_values() throws Exception {
RuleDto dto = new RuleDto().setId(1).setRepositoryKey("squid").setRuleKey("UselessImportCheck")
.setSubCharacteristicId(6).setRemediationFunction("CONSTANT_ISSUE").setRemediationOffset("10min")
.setDefaultSubCharacteristicId(2).setDefaultRemediationFunction("CONSTANT_ISSUE").setDefaultRemediationOffset("10min");
RuleKey ruleKey = RuleKey.of("squid", "UselessImportCheck");
when(ruleDao.getNullableByKey(session, ruleKey)).thenReturn(dto);
CharacteristicDto subCharacteristic = new CharacteristicDto().setId(2).setKey("COMPILER").setName("Compiler").setParentId(1);
when(characteristicDao.selectByKey("COMPILER", session)).thenReturn(subCharacteristic);
when(characteristicDao.selectById(2, session)).thenReturn(subCharacteristic);
CharacteristicDto characteristic = new CharacteristicDto().setId(1).setKey("PORTABILITY").setName("Portability").setOrder(2);
when(characteristicDao.selectById(1, session)).thenReturn(characteristic);
operations.updateRule(
// Same value as default values -> overridden values will be set to null
new RuleChange().setRuleKey(ruleKey).setDebtCharacteristicKey("COMPILER")
.setDebtRemediationFunction("CONSTANT_ISSUE").setDebtRemediationOffset("10min"),
authorizedUserSession
);
verify(ruleDao).update(eq(session), ruleCaptor.capture());
verify(session).commit();
RuleDto result = ruleCaptor.getValue();
assertThat(result.getId()).isEqualTo(1);
assertThat(result.getSubCharacteristicId()).isNull();
assertThat(result.getRemediationFunction()).isNull();
assertThat(result.getRemediationCoefficient()).isNull();
assertThat(result.getRemediationOffset()).isNull();
}
@Test
public void not_update_rule_if_same_sub_characteristic_and_function() throws Exception {
RuleDto dto = new RuleDto().setId(1).setRepositoryKey("squid").setRuleKey("UselessImportCheck")
.setSubCharacteristicId(2).setRemediationFunction("CONSTANT_ISSUE").setRemediationOffset("10min");
RuleKey ruleKey = RuleKey.of("squid", "UselessImportCheck");
when(ruleDao.getNullableByKey(session, ruleKey)).thenReturn(dto);
CharacteristicDto subCharacteristic = new CharacteristicDto().setId(2).setKey("COMPILER").setName("Compiler").setParentId(1);
when(characteristicDao.selectByKey("COMPILER", session)).thenReturn(subCharacteristic);
operations.updateRule(
new RuleChange().setRuleKey(ruleKey).setDebtCharacteristicKey("COMPILER")
.setDebtRemediationFunction("CONSTANT_ISSUE").setDebtRemediationOffset("10min"),
authorizedUserSession
);
verify(ruleDao, never()).update(eq(session), any(RuleDto.class));
verify(session, never()).commit();
}
@Test
public void update_rule_set_characteristic_if_different_from_default_one() throws Exception {
RuleDto dto = new RuleDto().setId(1).setRepositoryKey("squid").setRuleKey("UselessImportCheck")
.setDefaultSubCharacteristicId(2).setDefaultRemediationFunction("CONSTANT_ISSUE").setDefaultRemediationOffset("10min");
RuleKey ruleKey = RuleKey.of("squid", "UselessImportCheck");
when(ruleDao.getNullableByKey(session, ruleKey)).thenReturn(dto);
CharacteristicDto subCharacteristic = new CharacteristicDto().setId(2).setKey("COMPILER").setName("Compiler").setParentId(1);
when(characteristicDao.selectByKey("COMPILER", session)).thenReturn(subCharacteristic);
when(characteristicDao.selectById(2, session)).thenReturn(subCharacteristic);
CharacteristicDto characteristic = new CharacteristicDto().setId(1).setKey("PORTABILITY").setName("Portability").setOrder(2);
when(characteristicDao.selectById(1, session)).thenReturn(characteristic);
operations.updateRule(
// Remediation function is not the same as default one -> Overridden value should be set
new RuleChange().setRuleKey(ruleKey).setDebtCharacteristicKey("COMPILER")
.setDebtRemediationFunction("LINEAR_OFFSET").setDebtRemediationCoefficient("2h").setDebtRemediationOffset("20min"),
authorizedUserSession
);
verify(ruleDao).update(eq(session), ruleCaptor.capture());
verify(session).commit();
RuleDto result = ruleCaptor.getValue();
assertThat(result.getId()).isEqualTo(1);
assertThat(result.getSubCharacteristicId()).isEqualTo(2);
assertThat(result.getRemediationFunction()).isEqualTo("LINEAR_OFFSET");
assertThat(result.getRemediationCoefficient()).isEqualTo("2h");
assertThat(result.getRemediationOffset()).isEqualTo("20min");
}
@Test
public void update_rule_set_remediation_function_if_different_from_default_one() throws Exception {
RuleDto dto = new RuleDto().setId(1).setRepositoryKey("squid").setRuleKey("UselessImportCheck")
.setDefaultSubCharacteristicId(6).setDefaultRemediationFunction("CONSTANT_ISSUE").setDefaultRemediationOffset("10min");
RuleKey ruleKey = RuleKey.of("squid", "UselessImportCheck");
when(ruleDao.getNullableByKey(session, ruleKey)).thenReturn(dto);
CharacteristicDto subCharacteristic = new CharacteristicDto().setId(2).setKey("COMPILER").setName("Compiler").setParentId(1);
when(characteristicDao.selectByKey("COMPILER", session)).thenReturn(subCharacteristic);
when(characteristicDao.selectById(2, session)).thenReturn(subCharacteristic);
CharacteristicDto characteristic = new CharacteristicDto().setId(1).setKey("PORTABILITY").setName("Portability").setOrder(2);
when(characteristicDao.selectById(1, session)).thenReturn(characteristic);
operations.updateRule(
// Characteristic is the not same as the default one -> Overridden values should be set
new RuleChange().setRuleKey(ruleKey).setDebtCharacteristicKey("COMPILER")
.setDebtRemediationFunction("CONSTANT_ISSUE").setDebtRemediationOffset("10min"),
authorizedUserSession
);
verify(ruleDao).update(eq(session), ruleCaptor.capture());
verify(session).commit();
RuleDto result = ruleCaptor.getValue();
assertThat(result.getId()).isEqualTo(1);
assertThat(result.getSubCharacteristicId()).isEqualTo(2);
assertThat(result.getRemediationFunction()).isEqualTo("CONSTANT_ISSUE");
assertThat(result.getRemediationCoefficient()).isNull();
assertThat(result.getRemediationOffset()).isEqualTo("10min");
}
@Test
public void disable_rule_debt_when_update_rule_with_no_sub_characteristic() throws Exception {
RuleDto dto = new RuleDto().setId(1).setRepositoryKey("squid").setRuleKey("UselessImportCheck")
.setDefaultSubCharacteristicId(6).setDefaultRemediationFunction("LINEAR").setDefaultRemediationCoefficient("10min")
.setSubCharacteristicId(6)
.setRemediationFunction("CONSTANT_ISSUE")
.setRemediationOffset("10min");
RuleKey ruleKey = RuleKey.of("squid", "UselessImportCheck");
when(ruleDao.getNullableByKey(session, ruleKey)).thenReturn(dto);
operations.updateRule(new RuleChange().setRuleKey(ruleKey).setDebtCharacteristicKey(null), authorizedUserSession);
verify(ruleDao).update(eq(session), ruleCaptor.capture());
verify(session).commit();
RuleDto result = ruleCaptor.getValue();
assertThat(result.getId()).isEqualTo(1);
assertThat(result.getSubCharacteristicId()).isEqualTo(-1);
assertThat(result.getRemediationFunction()).isNull();
assertThat(result.getRemediationCoefficient()).isNull();
assertThat(result.getRemediationOffset()).isNull();
}
@Test
public void disable_rule_debt_when_update_rule_with_no_function() throws Exception {
RuleDto dto = new RuleDto().setId(1).setRepositoryKey("squid").setRuleKey("UselessImportCheck")
.setDefaultSubCharacteristicId(6).setDefaultRemediationFunction("CONSTANT_ISSUE").setDefaultRemediationOffset("10min");
RuleKey ruleKey = RuleKey.of("squid", "UselessImportCheck");
when(ruleDao.getNullableByKey(session, ruleKey)).thenReturn(dto);
CharacteristicDto subCharacteristic = new CharacteristicDto().setId(2).setKey("COMPILER").setName("Compiler").setParentId(1);
when(characteristicDao.selectByKey("COMPILER", session)).thenReturn(subCharacteristic);
when(characteristicDao.selectById(2, session)).thenReturn(subCharacteristic);
CharacteristicDto characteristic = new CharacteristicDto().setId(1).setKey("PORTABILITY").setName("Portability").setOrder(2);
when(characteristicDao.selectById(1, session)).thenReturn(characteristic);
operations.updateRule(new RuleChange().setRuleKey(ruleKey).setDebtCharacteristicKey("COMPILER"), authorizedUserSession);
verify(ruleDao).update(eq(session), ruleCaptor.capture());
verify(session).commit();
RuleDto result = ruleCaptor.getValue();
assertThat(result.getId()).isEqualTo(1);
assertThat(result.getSubCharacteristicId()).isEqualTo(-1);
assertThat(result.getRemediationFunction()).isNull();
assertThat(result.getRemediationCoefficient()).isNull();
assertThat(result.getRemediationOffset()).isNull();
}
@Test
public void disable_characteristic_on_rule_having_no_debt_info() throws Exception {
RuleDto dto = new RuleDto().setId(1).setRepositoryKey("squid").setRuleKey("UselessImportCheck");
RuleKey ruleKey = RuleKey.of("squid", "UselessImportCheck");
when(ruleDao.getNullableByKey(session, ruleKey)).thenReturn(dto);
operations.updateRule(new RuleChange().setRuleKey(ruleKey).setDebtCharacteristicKey(null), authorizedUserSession);
verify(ruleDao).update(eq(session), ruleCaptor.capture());
verify(session).commit();
RuleDto result = ruleCaptor.getValue();
assertThat(result.getId()).isEqualTo(1);
assertThat(result.getSubCharacteristicId()).isNull();
assertThat(result.getRemediationFunction()).isNull();
assertThat(result.getRemediationCoefficient()).isNull();
assertThat(result.getRemediationOffset()).isNull();
}
@Test
public void not_disable_characteristic_when_update_rule_if_already_disabled() throws Exception {
RuleDto dto = new RuleDto().setId(1).setRepositoryKey("squid").setRuleKey("UselessImportCheck").setSubCharacteristicId(-1);
RuleKey ruleKey = RuleKey.of("squid", "UselessImportCheck");
when(ruleDao.getNullableByKey(session, ruleKey)).thenReturn(dto);
operations.updateRule(
new RuleChange().setRuleKey(ruleKey).setDebtCharacteristicKey(null),
authorizedUserSession
);
verify(ruleDao, never()).update(eq(session), any(RuleDto.class));
verify(session, never()).commit();
}
@Test
public void fail_to_update_rule_on_unknown_rule() throws Exception {
RuleKey ruleKey = RuleKey.of("squid", "UselessImportCheck");
when(ruleDao.getNullableByKey(session, ruleKey)).thenReturn(null);
try {
operations.updateRule(
new RuleChange().setRuleKey(ruleKey).setDebtCharacteristicKey("COMPILER")
.setDebtRemediationFunction("LINEAR_OFFSET").setDebtRemediationCoefficient("2h").setDebtRemediationOffset("20min"),
authorizedUserSession
);
} catch (Exception e) {
assertThat(e).isInstanceOf(NotFoundException.class);
}
verify(ruleDao, never()).update(eq(session), any(RuleDto.class));
verify(session, never()).commit();
}
@Test
public void fail_to_update_rule_on_unknown_sub_characteristic() throws Exception {
RuleDto dto = new RuleDto().setId(1).setRepositoryKey("squid").setRuleKey("UselessImportCheck")
.setSubCharacteristicId(2).setRemediationFunction("CONSTANT_ISSUE").setRemediationOffset("10min");
RuleKey ruleKey = RuleKey.of("squid", "UselessImportCheck");
when(ruleDao.getNullableByKey(session, ruleKey)).thenReturn(dto);
when(characteristicDao.selectByKey("COMPILER", session)).thenReturn(null);
try {
operations.updateRule(
new RuleChange().setRuleKey(ruleKey).setDebtCharacteristicKey("COMPILER")
.setDebtRemediationFunction("LINEAR_OFFSET").setDebtRemediationCoefficient("2h").setDebtRemediationOffset("20min"),
authorizedUserSession
);
} catch (Exception e) {
assertThat(e).isInstanceOf(NotFoundException.class);
}
verify(ruleDao, never()).update(eq(session), any(RuleDto.class));
verify(session, never()).commit();
}
@Test
public void fail_to_update_rule_on_invalid_coefficient() throws Exception {
RuleDto dto = new RuleDto().setId(1).setRepositoryKey("squid").setRuleKey("UselessImportCheck")
.setSubCharacteristicId(2).setRemediationFunction("LINEAR").setRemediationCoefficient("1h");
RuleKey ruleKey = RuleKey.of("squid", "UselessImportCheck");
when(ruleDao.getNullableByKey(session, ruleKey)).thenReturn(dto);
CharacteristicDto subCharacteristic = new CharacteristicDto().setId(2).setKey("COMPILER").setName("Compiler").setParentId(1);
when(characteristicDao.selectByKey("COMPILER", session)).thenReturn(subCharacteristic);
try {
operations.updateRule(
new RuleChange().setRuleKey(ruleKey).setDebtCharacteristicKey("COMPILER")
.setDebtRemediationFunction("LINEAR").setDebtRemediationCoefficient("foo"),
authorizedUserSession
);
} catch (Exception e) {
assertThat(e).isInstanceOf(BadRequestException.class).hasMessage("Invalid coefficient: foo (Duration 'foo' is invalid, it should use the following sample format : 2d 10h 15min)");
}
verify(ruleDao, never()).update(eq(session), any(RuleDto.class));
verify(session, never()).commit();
}
}
|
