aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-db-dao/src/it/java/org/sonar/db/user/UserTokenDaoWithPersisterIT.java
blob: c5319b6eaa41e47802951dbf94ab19fb4aa15ad0 (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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/*
 * 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.user;

import java.security.SecureRandom;
import java.util.Random;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import org.mockito.ArgumentCaptor;
import org.sonar.api.utils.DateUtils;
import org.sonar.api.utils.System2;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.DbTester;
import org.sonar.db.audit.AuditPersister;
import org.sonar.db.audit.model.UserTokenNewValue;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.sonar.db.user.UserTokenTesting.newUserToken;

class UserTokenDaoWithPersisterIT {

  private final Random random = new SecureRandom();

  private final AuditPersister auditPersister = mock(AuditPersister.class);
  private final ArgumentCaptor<UserTokenNewValue> newValueCaptor = ArgumentCaptor.forClass(UserTokenNewValue.class);

  @RegisterExtension
  private final DbTester db = DbTester.create(System2.INSTANCE, auditPersister);

  private final DbSession dbSession = db.getSession();
  private final DbClient dbClient = db.getDbClient();
  private final UserTokenDao underTest = dbClient.userTokenDao();

  @Test
  void insert_token_is_persisted() {
    UserTokenDto userToken = newUserToken()
      .setExpirationDate(random.nextLong(Long.MAX_VALUE))
      .setLastConnectionDate(random.nextLong(Long.MAX_VALUE));
    underTest.insert(db.getSession(), userToken, "login");

    verify(auditPersister).addUserToken(eq(db.getSession()), newValueCaptor.capture());
    UserTokenDto userTokenFromDb = underTest.selectByTokenHash(db.getSession(), userToken.getTokenHash());
    assertThat(userTokenFromDb).isNotNull();
    assertThat(userTokenFromDb.getUuid()).isEqualTo(userToken.getUuid());
    assertThat(userTokenFromDb.getName()).isEqualTo(userToken.getName());
    assertThat(userTokenFromDb.getCreatedAt()).isEqualTo(userToken.getCreatedAt());
    assertThat(userTokenFromDb.getTokenHash()).isEqualTo(userToken.getTokenHash());
    assertThat(userTokenFromDb.getUserUuid()).isEqualTo(userToken.getUserUuid());
    assertThat(userTokenFromDb.getType()).isEqualTo(userToken.getType());
    assertThat(userTokenFromDb.getExpirationDate()).isEqualTo(userToken.getExpirationDate());
    UserTokenNewValue newValue = newValueCaptor.getValue();
    assertThat(newValue)
      .extracting(UserTokenNewValue::getTokenUuid, UserTokenNewValue::getTokenName, UserTokenNewValue::getUserUuid,
        UserTokenNewValue::getLastConnectionDate,
        UserTokenNewValue::getProjectKey, UserTokenNewValue::getType)
      .containsExactly(userToken.getUuid(), userToken.getName(), userToken.getUserUuid(), userToken.getLastConnectionDate(),
        userToken.getProjectKey(), userToken.getType());
    assertThat(newValue.toString())
      .contains("tokenUuid")
      .contains(DateUtils.formatDateTime(userToken.getLastConnectionDate()));
  }

  @Test
  void update_token_is_persisted() {
    UserDto user1 = db.users().insertUser();
    UserTokenDto userToken1 = db.users().insertToken(user1);

    assertThat(underTest.selectByTokenHash(dbSession, userToken1.getTokenHash()).getLastConnectionDate()).isNull();

    underTest.updateWithoutAudit(dbSession, userToken1.setLastConnectionDate(10_000_000_000L));
    underTest.update(dbSession, userToken1.setName("new_name"), user1.getLogin());

    verify(auditPersister).updateUserToken(eq(db.getSession()), newValueCaptor.capture());
    assertThat(newValueCaptor.getValue())
      .extracting(UserTokenNewValue::getTokenUuid, UserTokenNewValue::getTokenName, UserTokenNewValue::getUserUuid,
        UserTokenNewValue::getLastConnectionDate)
      .containsExactly(userToken1.getUuid(), "new_name", userToken1.getUserUuid(), userToken1.getLastConnectionDate());
  }

  @Test
  void delete_tokens_by_user_is_persisted() {
    UserDto user1 = db.users().insertUser();
    UserDto user2 = db.users().insertUser();
    db.users().insertToken(user1);
    db.users().insertToken(user1);
    db.users().insertToken(user2);
    underTest.deleteByUser(dbSession, user1);
    db.commit();

    assertThat(underTest.selectByUser(dbSession, user1)).isEmpty();
    assertThat(underTest.selectByUser(dbSession, user2)).hasSize(1);
    verify(auditPersister).deleteUserToken(eq(db.getSession()), newValueCaptor.capture());
    assertThat(newValueCaptor.getValue())
      .extracting(UserTokenNewValue::getUserUuid, UserTokenNewValue::getUserLogin)
      .containsExactly(user1.getUuid(), user1.getLogin());
  }

  @Test
  void delete_tokens_by_user_without_affected_rows_is_not_persisted() {
    UserDto user1 = db.users().insertUser();

    underTest.deleteByUser(dbSession, user1);

    verify(auditPersister).addUser(any(), any());
    verifyNoMoreInteractions(auditPersister);
  }

  @Test
  void delete_token_by_user_and_name_is_persisted() {
    UserDto user1 = db.users().insertUser();
    UserDto user2 = db.users().insertUser();
    db.users().insertToken(user1, t -> t.setName("name"));
    db.users().insertToken(user1, t -> t.setName("another-name"));
    db.users().insertToken(user2, t -> t.setName("name"));
    underTest.deleteByUserAndName(dbSession, user1, "name");

    assertThat(underTest.selectByUserAndName(dbSession, user1, "name")).isNull();
    assertThat(underTest.selectByUserAndName(dbSession, user1, "another-name")).isNotNull();
    assertThat(underTest.selectByUserAndName(dbSession, user2, "name")).isNotNull();
    verify(auditPersister).deleteUserToken(eq(db.getSession()), newValueCaptor.capture());
    assertThat(newValueCaptor.getValue())
      .extracting(UserTokenNewValue::getUserUuid, UserTokenNewValue::getUserLogin, UserTokenNewValue::getTokenName)
      .containsExactly(user1.getUuid(), user1.getLogin(), "name");
  }

  @Test
  void delete_token_by_user_and_name_without_affected_rows_is_not_persisted() {
    UserDto user1 = db.users().insertUser();

    underTest.deleteByUserAndName(dbSession, user1, "name");

    verify(auditPersister).addUser(any(), any());
    verifyNoMoreInteractions(auditPersister);
  }


  @Test
  void delete_token_by_projectKey_is_persisted() {
    UserDto user1 = db.users().insertUser();
    UserDto user2 = db.users().insertUser();
    db.users().insertToken(user1, t -> t.setProjectUuid("projectToDelete"));
    db.users().insertToken(user1, t -> t.setProjectUuid("projectToKeep"));
    db.users().insertToken(user2, t -> t.setProjectUuid("projectToDelete"));

    underTest.deleteByProjectUuid(dbSession, "projectToDeleteKey", "projectToDelete");

    assertThat(underTest.selectByUser(dbSession, user1)).hasSize(1);
    assertThat(underTest.selectByUser(dbSession, user2)).isEmpty();
    verify(auditPersister).deleteUserToken(eq(db.getSession()), newValueCaptor.capture());
    assertThat(newValueCaptor.getValue())
      .extracting(UserTokenNewValue::getProjectKey, UserTokenNewValue::getType)
      .containsExactly("projectToDeleteKey", "PROJECT_ANALYSIS_TOKEN");
  }

  @Test
  void delete_token_by_projectKey_without_affected_rows_is_not_persisted() {
    UserDto user1 = db.users().insertUser();

    db.users().insertToken(user1, t -> t.setProjectKey("projectToKeep"));

    underTest.deleteByProjectUuid(dbSession, "projectToDeleteKey", "projectToDelete");

    assertThat(underTest.selectByUser(dbSession, user1)).hasSize(1);

    verify(auditPersister).addUser(any(), any());
    verify(auditPersister).addUserToken(any(), any());
    verifyNoMoreInteractions(auditPersister);
  }
}