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
|
/*
* 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.db.issue;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Stream;
import org.apache.ibatis.session.ResultContext;
import org.apache.ibatis.session.ResultHandler;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import org.sonar.api.utils.DateUtils;
import org.sonar.api.utils.System2;
import org.sonar.core.issue.FieldDiffs;
import org.sonar.db.DbTester;
import static com.google.common.collect.ImmutableList.of;
import static java.util.Arrays.asList;
import static java.util.Collections.emptyList;
import static java.util.Collections.singleton;
import static java.util.Collections.singletonList;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.tuple;
import static org.sonar.db.issue.IssueChangeDto.TYPE_COMMENT;
import static org.sonar.db.issue.IssueChangeDto.TYPE_FIELD_CHANGE;
class IssueChangeDaoIT {
@RegisterExtension
private final DbTester db = DbTester.create(System2.INSTANCE);
private final IssueChangeDao underTest = db.getDbClient().issueChangeDao();
@Test
void select_issue_changelog_from_issue_key() {
IssueDto issue1 = db.issues().insertIssue();
db.issues().insertChange(issue1, c -> c.setChangeType(TYPE_FIELD_CHANGE).setChangeData("severity=MAJOR|BLOCKER"));
IssueDto issue2 = db.issues().insertIssue();
db.issues().insertChange(issue2);
List<FieldDiffs> changelog = underTest.selectChangelogByIssue(db.getSession(), issue1.getKey());
assertThat(changelog).hasSize(1);
assertThat(changelog.get(0).diffs()).hasSize(1);
assertThat(changelog.get(0).diffs().get("severity").newValue()).isEqualTo("BLOCKER");
assertThat(changelog.get(0).diffs().get("severity").oldValue()).isEqualTo("MAJOR");
assertThat(underTest.selectChangelogByIssue(db.getSession(), "unknown")).isEmpty();
}
@Test
void select_issue_changes_from_issues_keys() {
IssueDto issue1 = db.issues().insertIssue();
db.issues().insertChange(issue1);
db.issues().insertChange(issue1);
db.issues().insertChange(issue1);
db.issues().insertChange(issue1);
IssueDto issue2 = db.issues().insertIssue();
db.issues().insertChange(issue2);
IssueDto issue3 = db.issues().insertIssue();
List<IssueChangeDto> changelog = underTest.selectByIssueKeys(db.getSession(), asList(issue1.getKey(), issue2.getKey(),
issue3.getKey()));
assertThat(changelog).hasSize(5);
assertThat(underTest.selectByIssueKeys(db.getSession(), singletonList("unknown"))).isEmpty();
assertThat(underTest.selectByIssueKeys(db.getSession(), emptyList())).isEmpty();
}
@Test
void select_comment_by_key() {
IssueDto issue = db.issues().insertIssue();
IssueChangeDto issueChange = db.issues().insertChange(issue, c -> c.setChangeType(TYPE_COMMENT));
db.issues().insertChange(issue, c -> c.setChangeType(TYPE_COMMENT));
Optional<IssueChangeDto> issueChangeDto = underTest.selectCommentByKey(db.getSession(), issueChange.getKey());
assertThat(issueChangeDto).isPresent();
assertThat(issueChangeDto.get().getKey()).isEqualTo(issueChange.getKey());
assertThat(issueChangeDto.get().getChangeType()).isEqualTo(TYPE_COMMENT);
assertThat(issueChangeDto.get().getUserUuid()).isEqualTo(issueChange.getUserUuid());
assertThat(issueChangeDto.get().getChangeData()).isEqualTo(issueChange.getChangeData());
assertThat(issueChangeDto.get().getIssueChangeCreationDate()).isNotNull();
assertThat(issueChangeDto.get().getCreatedAt()).isNotNull();
assertThat(issueChangeDto.get().getUpdatedAt()).isNotNull();
}
@Test
void delete() {
IssueDto issue = db.issues().insertIssue();
IssueChangeDto issueChange1 = db.issues().insertChange(issue);
IssueChangeDto issueChange2 = db.issues().insertChange(issue);
assertThat(underTest.deleteByKey(db.getSession(), issueChange1.getKey())).isTrue();
assertThat(db.countRowsOfTable(db.getSession(), "issue_changes")).isOne();
}
@Test
void deleteByUuids() {
IssueDto issue = db.issues().insertIssue();
IssueChangeDto issueChange1 = db.issues().insertChange(issue);
IssueChangeDto issueChange2 = db.issues().insertChange(issue);
IssueChangeDto issueChange3 = db.issues().insertChange(issue);
underTest.deleteByUuids(db.getSession(), Set.of(issueChange1.getUuid(), issueChange2.getUuid()));
assertThat(underTest.selectByIssueKeys(db.getSession(), singleton(issue.getKey()))).extracting(IssueChangeDto::getIssueKey).containsOnly(issue.getKey());
assertThat(db.countRowsOfTable(db.getSession(), "issue_changes")).isOne();
}
@Test
void delete_unknown_key() {
IssueDto issue = db.issues().insertIssue();
db.issues().insertChange(issue);
assertThat(underTest.deleteByKey(db.getSession(), "UNKNOWN")).isFalse();
}
@Test
void insert() {
IssueDto issue = db.issues().insertIssue();
IssueChangeDto changeDto = new IssueChangeDto()
.setUuid("uuid")
.setKey("EFGH")
.setUserUuid("user_uuid")
.setChangeData("Some text")
.setChangeType("comment")
.setIssueKey(issue.getKey())
.setCreatedAt(1_500_000_000_000L)
.setUpdatedAt(1_501_000_000_000L)
.setIssueChangeCreationDate(1_502_000_000_000L)
.setProjectUuid("project_uuid");
underTest.insert(db.getSession(), changeDto);
db.getSession().commit();
assertThat(underTest.selectByIssueKeys(db.getSession(), singletonList(issue.getKey())))
.extracting(IssueChangeDto::getKey, IssueChangeDto::getUuid, IssueChangeDto::getIssueKey, IssueChangeDto::getChangeData,
IssueChangeDto::getChangeType,
IssueChangeDto::getIssueChangeCreationDate, IssueChangeDto::getCreatedAt, IssueChangeDto::getUpdatedAt,
IssueChangeDto::getProjectUuid)
.containsExactlyInAnyOrder(
tuple("EFGH", "uuid", issue.getKey(), "Some text", TYPE_COMMENT, 1_502_000_000_000L, 1_500_000_000_000L, 1_501_000_000_000L,
"project_uuid"));
}
@Test
void update() {
IssueDto issue = db.issues().insertIssue();
IssueChangeDto issueChange = db.issues().insertChange(issue);
assertThat(underTest.update(db.getSession(), new IssueChangeDto()
.setKey(issueChange.getKey())
// Only the following fields can be updated:
.setChangeData("new comment")
.setUpdatedAt(1_500_000_000_000L)
// Should not be taking into account
.setIssueKey("other_issue_uuid")
.setUserUuid("other_user_uuid")
.setCreatedAt(10_000_000_000L)
.setIssueChangeCreationDate(30_000_000_000L))).isTrue();
db.commit();
assertThat(underTest.selectByIssueKeys(db.getSession(), singletonList(issue.getKey())))
.extracting(IssueChangeDto::getKey, IssueChangeDto::getIssueKey, IssueChangeDto::getChangeData, IssueChangeDto::getChangeType,
IssueChangeDto::getIssueChangeCreationDate, IssueChangeDto::getCreatedAt, IssueChangeDto::getUpdatedAt)
.containsExactlyInAnyOrder(
tuple(issueChange.getKey(), issue.getKey(), "new comment", issueChange.getChangeType(), issueChange.getIssueChangeCreationDate(),
issueChange.getCreatedAt(),
1_500_000_000_000L));
}
@Test
void update_unknown_key() {
IssueDto issue = db.issues().insertIssue();
IssueChangeDto issueChange = db.issues().insertChange(issue);
assertThat(underTest.update(db.getSession(), new IssueChangeDto()
.setKey("UNKNOWN")
.setIssueKey("other_issue_uuid")
.setChangeData("new comment")
.setUpdatedAt(DateUtils.parseDate("2013-06-30").getTime())))
.isFalse();
assertThat(underTest.selectByIssueKeys(db.getSession(), singletonList(issue.getKey())))
.extracting(IssueChangeDto::getKey, IssueChangeDto::getIssueKey, IssueChangeDto::getChangeData, IssueChangeDto::getChangeType,
IssueChangeDto::getIssueChangeCreationDate, IssueChangeDto::getCreatedAt, IssueChangeDto::getUpdatedAt)
.containsExactlyInAnyOrder(
tuple(issueChange.getKey(), issue.getKey(), issueChange.getChangeData(), issueChange.getChangeType(),
issueChange.getIssueChangeCreationDate(), issueChange.getCreatedAt(),
issueChange.getUpdatedAt()));
}
@Test
void scrollDiffChangesOfIssues_scrolls_only_diff_changes_of_selected_issues() {
IssueDto issue1 = db.issues().insertIssue();
IssueChangeDto diffChange1 = db.issues().insertChange(issue1, t -> t.setChangeType(TYPE_FIELD_CHANGE));
db.issues().insertChange(issue1, t -> t.setChangeType(TYPE_COMMENT));
IssueDto issue2 = db.issues().insertIssue();
IssueChangeDto diffChange2 = db.issues().insertChange(issue2, t -> t.setChangeType(TYPE_FIELD_CHANGE));
db.issues().insertChange(issue2, t -> t.setChangeType(TYPE_COMMENT));
IssueDto issue3 = db.issues().insertIssue();
IssueChangeDto diffChange31 = db.issues().insertChange(issue3, t -> t.setChangeType(TYPE_FIELD_CHANGE));
IssueChangeDto diffChange32 = db.issues().insertChange(issue3, t -> t.setChangeType(TYPE_FIELD_CHANGE));
db.issues().insertChange(issue3, t -> t.setChangeType(TYPE_COMMENT));
RecordingIssueChangeDtoResultHandler recordingHandler = new RecordingIssueChangeDtoResultHandler();
underTest.scrollDiffChangesOfIssues(db.getSession(), of(), recordingHandler.clear());
assertThat(recordingHandler.getDtoKeys()).isEmpty();
underTest.scrollDiffChangesOfIssues(db.getSession(), of("fooBarCacahuete"), recordingHandler.clear());
assertThat(recordingHandler.getDtoKeys()).isEmpty();
underTest.scrollDiffChangesOfIssues(db.getSession(), of(issue1.getKee()), recordingHandler.clear());
assertThat(recordingHandler.getDtoKeys()).containsOnly(diffChange1.getKey());
underTest.scrollDiffChangesOfIssues(db.getSession(), of(issue2.getKee()), recordingHandler.clear());
assertThat(recordingHandler.getDtoKeys()).containsOnly(diffChange2.getKey());
underTest.scrollDiffChangesOfIssues(db.getSession(), of(issue1.getKee(), issue3.getKee()), recordingHandler.clear());
assertThat(recordingHandler.getDtoKeys()).containsOnly(diffChange1.getKey(), diffChange31.getKey(), diffChange32.getKey());
}
@Test
void scrollDiffChangesOfIssues_orders_changes_by_issue_and_then_creationDate() {
IssueDto issue1 = db.issues().insertIssue();
IssueChangeDto[] diffChanges = {
db.issues().insertChange(issue1, t -> t.setChangeType(TYPE_FIELD_CHANGE).setCreatedAt(1L).setIssueChangeCreationDate(50L)),
db.issues().insertChange(issue1, t -> t.setChangeType(TYPE_FIELD_CHANGE).setCreatedAt(2L).setIssueChangeCreationDate(20L)),
db.issues().insertChange(issue1, t -> t.setChangeType(TYPE_FIELD_CHANGE).setCreatedAt(3L).setIssueChangeCreationDate(30L)),
db.issues().insertChange(issue1, t -> t.setChangeType(TYPE_FIELD_CHANGE).setCreatedAt(4L).setIssueChangeCreationDate(80L)),
db.issues().insertChange(issue1, t -> t.setChangeType(TYPE_FIELD_CHANGE).setCreatedAt(5L).setIssueChangeCreationDate(10L)),
};
RecordingIssueChangeDtoResultHandler recordingHandler = new RecordingIssueChangeDtoResultHandler();
underTest.scrollDiffChangesOfIssues(db.getSession(), of(issue1.getKee()), recordingHandler.clear());
assertThat(recordingHandler.getDtoKeys()).containsExactly(
diffChanges[3].getKey(),
diffChanges[0].getKey(),
diffChanges[2].getKey(),
diffChanges[1].getKey(),
diffChanges[4].getKey());
}
private static class RecordingIssueChangeDtoResultHandler implements ResultHandler<IssueChangeDto> {
private final List<IssueChangeDto> dtos = new ArrayList<>();
@Override
public void handleResult(ResultContext<? extends IssueChangeDto> resultContext) {
dtos.add(resultContext.getResultObject());
}
public RecordingIssueChangeDtoResultHandler clear() {
dtos.clear();
return this;
}
private Stream<String> getDtoKeys() {
return dtos.stream().map(IssueChangeDto::getKey);
}
}
}
|