aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-db-dao/src/it/java/org/sonar/db/audit/AuditDaoIT.java
blob: 3c7f045293791ea5e19cab1f061eb545b82e2113 (plain)
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
/*
 * 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.audit;

import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.LongStream;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import org.sonar.api.impl.utils.TestSystem2;
import org.sonar.core.util.UuidFactoryImpl;
import org.sonar.db.DbSession;
import org.sonar.db.DbTester;

import static org.apache.commons.lang3.RandomStringUtils.secure;
import static org.assertj.core.api.Assertions.assertThat;
import static org.sonar.db.audit.AuditDao.EXCEEDED_LENGTH;

class AuditDaoIT {

  private static final long NOW = 1000000L;
  private final TestSystem2 system2 = new TestSystem2().setNow(NOW);
  @RegisterExtension
  private final DbTester db = DbTester.create(system2);
  private final DbSession dbSession = db.getSession();

  private final AuditDao testAuditDao = new AuditDao(system2, UuidFactoryImpl.INSTANCE);

  @Test
  void selectByPeriodPaginated_10001EntriesInserted_defaultPageSizeEntriesReturned() {
    prepareRowsWithDeterministicCreatedAt(10001);

    List<AuditDto> auditDtos = testAuditDao.selectByPeriodPaginated(dbSession, 1, 20000, 1);

    assertThat(auditDtos).hasSize(10_000);
  }

  @Test
  void selectByPeriodPaginated_10001EntriesInserted_querySecondPageReturns1Item() {
    prepareRowsWithDeterministicCreatedAt(10001);

    List<AuditDto> auditDtos = testAuditDao.selectByPeriodPaginated(dbSession, 1, 20000, 2);

    assertThat(auditDtos.size()).isOne();
  }

  @Test
  void purge_has_limit() {
    prepareRowsWithDeterministicCreatedAt(100_001);
    long purged = testAuditDao.deleteBefore(dbSession, 200_000);
    assertThat(purged).isEqualTo(100_000);
    assertThat(db.countRowsOfTable(dbSession, "audits")).isOne();
    assertThat(testAuditDao.selectOlderThan(dbSession, 100_002))
      .extracting(AuditDto::getCreatedAt)
      .containsOnly(100_001L);
  }

  @Test
  void purge_with_threshold() {
    prepareRowsWithDeterministicCreatedAt(100_000);
    long purged = testAuditDao.deleteBefore(dbSession, 50_000);
    assertThat(purged).isEqualTo(49_999);
    assertThat(db.countRowsOfTable(dbSession, "audits")).isEqualTo(50_001);
    assertThat(testAuditDao.selectOlderThan(dbSession, 100_000))
      .hasSize(50_000)
      .allMatch(a -> a.getCreatedAt() >= 50_000);
  }

  @Test
  void selectByPeriodPaginated_100EntriesInserted_100EntriesReturned() {
    prepareRowsWithDeterministicCreatedAt(100);

    List<AuditDto> auditDtos = testAuditDao.selectByPeriodPaginated(dbSession, 1, 101, 1);

    assertThat(auditDtos).hasSize(100);
  }

  @Test
  void insert_doNotSetACreatedAtIfAlreadySet() {
    AuditDto auditDto = AuditTesting.newAuditDto();
    auditDto.setCreatedAt(1041375600000L);

    testAuditDao.insert(dbSession, auditDto);

    List<AuditDto> auditDtos = testAuditDao.selectByPeriodPaginated(dbSession, 1041375500000L, 1041375700000L, 1);
    AuditDto storedAuditDto = auditDtos.get(0);
    assertThat(storedAuditDto.getCreatedAt()).isEqualTo(auditDto.getCreatedAt());
  }

  @Test
  void insert_setACreatedAtIfAlreadySet() {
    AuditDto auditDto = AuditTesting.newAuditDto();
    auditDto.setCreatedAt(0);

    testAuditDao.insert(dbSession, auditDto);

    assertThat(auditDto.getCreatedAt()).isNotZero();
  }

  @Test
  void insert_doNotSetAUUIDIfAlreadySet() {
    AuditDto auditDto = AuditTesting.newAuditDto();
    auditDto.setUuid("myuuid");
    auditDto.setCreatedAt(1041375600000L);

    testAuditDao.insert(dbSession, auditDto);

    List<AuditDto> auditDtos = testAuditDao.selectByPeriodPaginated(dbSession, 1041375500000L, 1041375700000L, 1);
    AuditDto storedAuditDto = auditDtos.get(0);
    assertThat(storedAuditDto.getUuid()).isEqualTo(auditDto.getUuid());
  }

  @Test
  void insert_truncateVeryLongNewValue() {
    AuditDto auditDto = AuditTesting.newAuditDto();
    String veryLongString = secure().nextAlphanumeric(5000);
    auditDto.setNewValue(veryLongString);

    testAuditDao.insert(dbSession, auditDto);

    assertThat(auditDto.getNewValue()).isEqualTo(EXCEEDED_LENGTH);
  }

  @Test
  void selectByPeriodPaginated_whenRowsInAnyOrder_returnOrderedByCreatedAt() {
    List<Long> createdAts = LongStream.range(1, 51).boxed().collect(Collectors.toList());
    Collections.shuffle(createdAts);
    createdAts.stream()
      .map(AuditTesting::newAuditDto)
      .forEach(auditDto -> testAuditDao.insert(dbSession, auditDto));

    List<AuditDto> auditDtos = testAuditDao.selectByPeriodPaginated(dbSession, 1, 51, 1);

    assertThat(auditDtos).hasSize(50);
    assertThat(auditDtos).extracting(AuditDto::getCreatedAt).isSorted();
  }

  @Test
  void selectByPeriodPaginated_whenRowsWithIdenticalCreatedAt_returnOrderedByCreatedAtAndUuids() {
    AuditDto auditDto1 = AuditTesting.newAuditDto(100L);
    auditDto1.setUuid("uuid1");
    testAuditDao.insert(dbSession, auditDto1);
    AuditDto auditDto2 = AuditTesting.newAuditDto(100L);
    auditDto2.setUuid("uuid2");
    testAuditDao.insert(dbSession, auditDto2);

    List<AuditDto> auditDtos = testAuditDao.selectByPeriodPaginated(dbSession, 99, 101, 1);

    assertThat(auditDtos).hasSize(2);
    assertThat(auditDtos).extracting(AuditDto::getCreatedAt).isSorted();
    assertThat(auditDtos).extracting(AuditDto::getUuid).isSorted();
  }

  private void prepareRowsWithDeterministicCreatedAt(int size) {
    for (int i = 1; i <= size; i++) {
      AuditDto auditDto = AuditTesting.newAuditDto(i);
      testAuditDao.insert(dbSession, auditDto);
    }
  }
}