path: root/server/sonar-db-dao/src/it/java/org/sonar/db/property/PropertiesDaoWithPersisterIT.java

/*
 * 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.property;

import javax.annotation.Nullable;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import org.mockito.ArgumentCaptor;
import org.sonar.api.impl.utils.AlwaysIncreasingSystem2;
import org.sonar.db.component.ComponentQualifiers;
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.PropertyNewValue;
import org.sonar.db.component.ComponentDto;
import org.sonar.db.user.UserDto;

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.verifyNoInteractions;
import static org.mockito.Mockito.when;

class PropertiesDaoWithPersisterIT {
  private static final String KEY = "key";
  private static final String ANOTHER_KEY = "another_key";
  private static final String PROJECT_KEY = "project_key";
  private static final String PROJECT_NAME = "project_name";
  private static final String PROJECT_UUID = "project_uuid";
  private static final String SECURED_KEY = "key.secured";
  private static final String USER_LOGIN = "user_login";
  private static final String USER_UUID = "user_uuid";
  private static final String VALUE = "value";

  private static final long INITIAL_DATE = 1_444_000L;

  private final AlwaysIncreasingSystem2 system2 = new AlwaysIncreasingSystem2(INITIAL_DATE, 1);

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

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

  private final DbClient dbClient = db.getDbClient();
  private final DbSession session = db.getSession();
  private final PropertiesDao underTest = dbClient.propertiesDao();

  @Test
  void saveGlobalTrackedPropertyIsPersisted() {
    when(auditPersister.isTrackedProperty(KEY)).thenReturn(true);
    underTest.saveProperty(new PropertyDto().setKey(KEY).setValue(VALUE));

    verify(auditPersister).addProperty(any(), newValueCaptor.capture(), eq(false));

    PropertyNewValue newValue = newValueCaptor.getValue();

    assertThat(newValue)
      .extracting(PropertyNewValue::getPropertyKey, PropertyNewValue::getPropertyValue,
        PropertyNewValue::getUserUuid, PropertyNewValue::getUserLogin)
      .containsExactly(KEY, VALUE, null, null);
    assertThat(newValue.toString()).doesNotContain("projectUuid");
  }

  @Test
  void saveGlobalTrackedAndSecuredPropertyIsPersisted() {
    when(auditPersister.isTrackedProperty(SECURED_KEY)).thenReturn(true);

    underTest.saveProperty(new PropertyDto().setKey(SECURED_KEY).setValue(VALUE));

    verify(auditPersister).addProperty(any(), newValueCaptor.capture(), eq(false));
    PropertyNewValue newValue = newValueCaptor.getValue();
    assertThat(newValue)
      .extracting(PropertyNewValue::getPropertyKey, PropertyNewValue::getPropertyValue,
        PropertyNewValue::getUserUuid, PropertyNewValue::getUserLogin)
      .containsExactly(SECURED_KEY, null, null, null);
    assertThat(newValue.toString()).doesNotContain("projectUuid");
  }

  @Test
  void saveProjectPropertyIsPersisted() {
    when(auditPersister.isTrackedProperty(KEY)).thenReturn(true);

    PropertyDto propertyDto = getPropertyDto(KEY, PROJECT_UUID, USER_UUID);
    underTest.saveProperty(session, propertyDto, USER_LOGIN, PROJECT_KEY, PROJECT_NAME, ComponentQualifiers.PROJECT);

    verify(auditPersister).addProperty(any(), newValueCaptor.capture(), eq(false));
    PropertyNewValue newValue = newValueCaptor.getValue();
    assertThat(newValue)
      .extracting(PropertyNewValue::getPropertyKey, PropertyNewValue::getPropertyValue,
        PropertyNewValue::getUserUuid, PropertyNewValue::getUserLogin,
        PropertyNewValue::getComponentUuid, PropertyNewValue::getComponentKey,
        PropertyNewValue::getComponentName, PropertyNewValue::getQualifier)
      .containsExactly(propertyDto.getKey(), propertyDto.getValue(), propertyDto.getUserUuid(),
        USER_LOGIN, propertyDto.getEntityUuid(), PROJECT_KEY, PROJECT_NAME, "TRK");
    assertThat(newValue.toString()).contains("componentUuid");
  }

  @Test
  void saveApplicationTrackedPropertyIsPersisted() {
    when(auditPersister.isTrackedProperty(KEY)).thenReturn(true);

    PropertyDto propertyDto = getPropertyDto(KEY, PROJECT_UUID, USER_UUID);
    underTest.saveProperty(session, propertyDto, USER_LOGIN, "app-key", "app-name", ComponentQualifiers.APP);

    verify(auditPersister).addProperty(any(), newValueCaptor.capture(), eq(false));
    PropertyNewValue newValue = newValueCaptor.getValue();
    assertThat(newValue)
      .extracting(PropertyNewValue::getPropertyKey, PropertyNewValue::getPropertyValue,
        PropertyNewValue::getUserUuid, PropertyNewValue::getUserLogin,
        PropertyNewValue::getComponentUuid, PropertyNewValue::getComponentKey,
        PropertyNewValue::getComponentName, PropertyNewValue::getQualifier)
      .containsExactly(propertyDto.getKey(), propertyDto.getValue(), propertyDto.getUserUuid(),
        USER_LOGIN, propertyDto.getEntityUuid(), "app-key", "app-name", "APP");
    assertThat(newValue.toString())
      .contains("componentUuid");
  }

  @Test
  void savePortfolioTrackedPropertyIsPersisted() {
    when(auditPersister.isTrackedProperty(KEY)).thenReturn(true);

    PropertyDto propertyDto = getPropertyDto(KEY, PROJECT_UUID, USER_UUID);
    underTest.saveProperty(session, propertyDto, USER_LOGIN, "portfolio-key", "portfolio-name", ComponentQualifiers.VIEW);

    verify(auditPersister).addProperty(any(), newValueCaptor.capture(), eq(false));
    PropertyNewValue newValue = newValueCaptor.getValue();
    assertThat(newValue)
      .extracting(PropertyNewValue::getPropertyKey, PropertyNewValue::getPropertyValue,
        PropertyNewValue::getUserUuid, PropertyNewValue::getUserLogin,
        PropertyNewValue::getComponentUuid, PropertyNewValue::getComponentKey,
        PropertyNewValue::getComponentName, PropertyNewValue::getQualifier)
      .containsExactly(propertyDto.getKey(), propertyDto.getValue(), propertyDto.getUserUuid(),
        USER_LOGIN, propertyDto.getEntityUuid(), "portfolio-key", "portfolio-name", "VW");
    assertThat(newValue.toString())
      .contains("componentUuid");
  }

  @Test
  void saveProjectTrackedAndSecuredPropertyIsPersisted() {
    when(auditPersister.isTrackedProperty(SECURED_KEY)).thenReturn(true);

    PropertyDto propertyDto = getPropertyDto(SECURED_KEY, PROJECT_UUID, USER_UUID);
    underTest.saveProperty(session, propertyDto, USER_LOGIN, PROJECT_KEY, PROJECT_NAME, ComponentQualifiers.PROJECT);

    verify(auditPersister).addProperty(any(), newValueCaptor.capture(), eq(false));
    PropertyNewValue newValue = newValueCaptor.getValue();
    assertThat(newValue)
      .extracting(PropertyNewValue::getPropertyKey, PropertyNewValue::getPropertyValue,
        PropertyNewValue::getUserUuid, PropertyNewValue::getUserLogin,
        PropertyNewValue::getComponentUuid, PropertyNewValue::getComponentKey,
        PropertyNewValue::getComponentName, PropertyNewValue::getQualifier)
      .containsExactly(propertyDto.getKey(), null, propertyDto.getUserUuid(),
        USER_LOGIN, propertyDto.getEntityUuid(), PROJECT_KEY, PROJECT_NAME, "TRK");
    assertThat(newValue.toString()).contains("componentUuid");
  }

  @Test
  void deleteTrackedPropertyByQueryIsPersisted() {
    when(auditPersister.isTrackedProperty(KEY)).thenReturn(true);
    PropertyQuery query = getPropertyQuery(KEY);
    PropertyDto propertyDto = getPropertyDto(KEY, PROJECT_UUID, USER_UUID);
    underTest.saveProperty(session, propertyDto, USER_LOGIN, PROJECT_KEY, PROJECT_NAME, ComponentQualifiers.PROJECT);

    underTest.deleteByQuery(session, query);

    verify(auditPersister).deleteProperty(any(), newValueCaptor.capture(), eq(false));
    PropertyNewValue newValue = newValueCaptor.getValue();
    assertThat(newValue)
      .extracting(PropertyNewValue::getPropertyKey, PropertyNewValue::getPropertyValue,
        PropertyNewValue::getUserUuid, PropertyNewValue::getUserLogin,
        PropertyNewValue::getComponentUuid, PropertyNewValue::getComponentKey,
        PropertyNewValue::getComponentName)
      .containsExactly(query.key(), null, query.userUuid(),
        null, query.entityUuid(), null, null);
    assertThat(newValue.toString()).doesNotContain("userLogin");
  }

  @Test
  void deleteTrackedPropertyByQueryWithoutAffectedRowsIsNotPersisted() {
    PropertyQuery query = getPropertyQuery(KEY);

    underTest.deleteByQuery(session, query);

    verifyNoInteractions(auditPersister);
  }

  @Test
  void deleteTrackedPropertyIsPersisted() {
    when(auditPersister.isTrackedProperty(KEY)).thenReturn(true);
    PropertyDto propertyDto = getPropertyDto(KEY, PROJECT_UUID, USER_UUID);
    underTest.saveProperty(session, propertyDto, USER_LOGIN, null, null, null);

    underTest.delete(session, propertyDto, USER_LOGIN, PROJECT_KEY, PROJECT_NAME, ComponentQualifiers.PROJECT);

    verify(auditPersister).deleteProperty(any(), newValueCaptor.capture(), eq(false));
    PropertyNewValue newValue = newValueCaptor.getValue();
    assertThat(newValue)
      .extracting(PropertyNewValue::getPropertyKey, PropertyNewValue::getPropertyValue,
        PropertyNewValue::getUserUuid, PropertyNewValue::getUserLogin,
        PropertyNewValue::getComponentUuid, PropertyNewValue::getComponentKey,
        PropertyNewValue::getComponentName)
      .containsExactly(propertyDto.getKey(), propertyDto.getValue(), propertyDto.getUserUuid(),
        USER_LOGIN, propertyDto.getEntityUuid(), PROJECT_KEY, PROJECT_NAME);
    assertThat(newValue.toString()).contains("userLogin");
  }

  @Test
  void deleteTrackedPropertyWithoutAffectedRowsIsNotPersisted() {
    PropertyDto propertyDto = getPropertyDto(KEY, PROJECT_UUID, USER_UUID);

    underTest.delete(session, propertyDto, USER_LOGIN, PROJECT_KEY, PROJECT_NAME, ComponentQualifiers.PROJECT);

    verifyNoInteractions(auditPersister);
  }

  @Test
  void deleteTrackedGlobalPropertyIsPersisted() {
    when(auditPersister.isTrackedProperty(KEY)).thenReturn(true);
    PropertyDto propertyDto = getPropertyDto(KEY, null, null);
    underTest.saveProperty(session, propertyDto, null, null, null, null);

    underTest.deleteGlobalProperty(KEY, session);

    verify(auditPersister).deleteProperty(any(), newValueCaptor.capture(), eq(false));
    PropertyNewValue newValue = newValueCaptor.getValue();
    assertThat(newValue)
      .extracting(PropertyNewValue::getPropertyKey, PropertyNewValue::getPropertyValue,
        PropertyNewValue::getUserUuid, PropertyNewValue::getUserLogin,
        PropertyNewValue::getComponentUuid, PropertyNewValue::getComponentKey,
        PropertyNewValue::getComponentName)
      .containsExactly(KEY, null, null, null,
        null, null, null);
    assertThat(newValue.toString()).doesNotContain("projectUuid");
  }

  @Test
  void deleteTrackedGlobalPropertyWithoutAffectedRowsIsNotPersisted() {
    underTest.deleteGlobalProperty(KEY, session);

    verifyNoInteractions(auditPersister);
  }

  @Test
  void deleteTrackedPropertyByKeyAndValueIsPersisted() {
    when(auditPersister.isTrackedProperty(KEY)).thenReturn(true);

    PropertyDto propertyDto = getPropertyDto(KEY, null, USER_UUID);
    underTest.saveProperty(session, propertyDto, USER_LOGIN, null, null, null);
    underTest.deleteByKeyAndValue(session, KEY, VALUE);

    verify(auditPersister).deleteProperty(any(), newValueCaptor.capture(), eq(false));
    PropertyNewValue newValue = newValueCaptor.getValue();
    assertThat(newValue)
      .extracting(PropertyNewValue::getPropertyKey, PropertyNewValue::getPropertyValue,
        PropertyNewValue::getUserUuid, PropertyNewValue::getUserLogin,
        PropertyNewValue::getComponentUuid, PropertyNewValue::getComponentKey,
        PropertyNewValue::getComponentName)
      .containsExactly(KEY, VALUE, null,
        null, null, null, null);
    assertThat(newValue.toString()).doesNotContain("projectUuid");
  }

  @Test
  void deleteTrackedPropertyByKeyAndValueWithoutAffectedRowsIsNotPersisted() {
    underTest.deleteByKeyAndValue(session, KEY, VALUE);

    verifyNoInteractions(auditPersister);
  }

  private PropertyDto getPropertyDto(String key, @Nullable String projectUuid, @Nullable String userUuid) {
    return new PropertyDto()
      .setKey(key)
      .setValue(VALUE)
      .setUserUuid(userUuid)
      .setEntityUuid(projectUuid);
  }

  private PropertyQuery getPropertyQuery(String key) {
    return PropertyQuery.builder()
      .setKey(key)
      .setEntityUuid(PROJECT_UUID)
      .setUserUuid(USER_UUID)
      .build();
  }

  private UserDto setUserProperties(@Nullable String value) {
    when(auditPersister.isTrackedProperty(KEY)).thenReturn(true);
    when(auditPersister.isTrackedProperty(ANOTHER_KEY)).thenReturn(false);
    when(auditPersister.isTrackedProperty(SECURED_KEY)).thenReturn(true);

    ComponentDto project = db.components().insertPrivateProject().getMainBranchComponent();
    UserDto user = db.users().insertUser();

    if (value == null) {
      value = user.getLogin();
    }

    PropertyDto dto1 = new PropertyDto().setKey(KEY)
      .setEntityUuid(project.uuid())
      .setUserUuid(user.getUuid())
      .setValue(value);
    PropertyDto dto2 = new PropertyDto().setKey(ANOTHER_KEY)
      .setEntityUuid(project.uuid())
      .setUserUuid(user.getUuid())
      .setValue(value);
    PropertyDto dto3 = new PropertyDto().setKey(SECURED_KEY)
      .setEntityUuid(project.uuid())
      .setUserUuid(user.getUuid())
      .setValue(value);
    db.properties().insertProperty(dto1, project.getKey(), project.name(), project.qualifier(), user.getLogin());
    db.properties().insertProperty(dto2, project.getKey(), project.name(), project.qualifier(), user.getLogin());
    db.properties().insertProperty(dto3, project.getKey(), project.name(), project.qualifier(), user.getLogin());
    return user;
  }
}