sonarqube/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/component/ComponentUuidFactoryWithMigrationTest.java

/*
 * SonarQube
 * Copyright (C) 2009-2023 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.ce.task.projectanalysis.component;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.function.Function;
import org.junit.Rule;
import org.junit.Test;
import org.sonar.api.utils.System2;
import org.sonar.ce.task.projectanalysis.analysis.Branch;
import org.sonar.db.DbTester;
import org.sonar.db.component.ComponentDto;
import org.sonar.db.component.ComponentTesting;

import static org.assertj.core.api.Assertions.assertThat;
import static org.sonar.db.component.BranchDto.DEFAULT_MAIN_BRANCH_NAME;

public class ComponentUuidFactoryWithMigrationTest {
  private final Branch mainBranch = new DefaultBranchImpl(DEFAULT_MAIN_BRANCH_NAME);
  @Rule
  public DbTester db = DbTester.create(System2.INSTANCE);
  private Function<String, String> pathToKey = path -> path != null ? "project:" + path : "project";

  @Test
  public void load_uuids_from_existing_components_in_db() {
    ComponentDto project = db.components().insertPrivateProject();
    ComponentDto module = db.components().insertComponent(ComponentTesting.newModuleDto(project));
    Map<String, String> reportModulesPath = Collections.singletonMap(module.getKey(), "module1_path");
    pathToKey = path -> path != null ? project.getKey() + ":" + path : project.getKey();

    ComponentUuidFactoryWithMigration underTest =
      new ComponentUuidFactoryWithMigration(db.getDbClient(), db.getSession(), project.getKey(), mainBranch, pathToKey, reportModulesPath);

    assertThat(underTest.getOrCreateForKey(project.getKey())).isEqualTo(project.uuid());
    assertThat(underTest.getOrCreateForKey(module.getKey())).isEqualTo(module.uuid());
  }

  @Test
  public void migrate_project_with_modules() {
    ComponentDto project = db.components().insertPrivateProject(dto -> dto.setKey("project"));
    ComponentDto module1 = db.components().insertComponent(ComponentTesting.newModuleDto(project)
      .setKey("project:module1"));
    ComponentDto module2 = db.components().insertComponent(ComponentTesting.newModuleDto(module1)
      .setKey("project:module1:module2"));
    ComponentDto file1 = db.components().insertComponent(ComponentTesting.newFileDto(project)
      .setKey("project:file1")
      .setPath("file1_path"));
    ComponentDto file2 = db.components().insertComponent(ComponentTesting.newFileDto(module2)
      .setKey("project:module1:module2:file2")
      .setPath("file2_path"));

    assertThat(file2.moduleUuidPath()).isEqualTo("." + project.uuid() + "." + module1.uuid() + "." + module2.uuid() + ".");
    Map<String, String> modulesRelativePaths = new HashMap<>();
    modulesRelativePaths.put("project:module1", "module1_path");
    modulesRelativePaths.put("project:module1:module2", "module1_path/module2_path");
    ComponentUuidFactoryWithMigration underTest =
      new ComponentUuidFactoryWithMigration(db.getDbClient(), db.getSession(), project.getKey(), mainBranch, pathToKey, modulesRelativePaths);

    // migrated files
    assertThat(underTest.getOrCreateForKey("project:file1_path")).isEqualTo(file1.uuid());
    assertThat(underTest.getOrCreateForKey("project:module1_path/module2_path/file2_path")).isEqualTo(file2.uuid());

    // project remains the same
    assertThat(underTest.getOrCreateForKey(project.getKey())).isEqualTo(project.uuid());
  }

  @Test
  public void migrate_project_with_disabled_components_no_path() {
    ComponentDto project = db.components().insertPrivateProject(dto -> dto.setKey("project"));
    ComponentDto module1 = db.components().insertComponent(ComponentTesting.newModuleDto(project)
      .setKey("project:module1"));
    ComponentDto file1 = db.components().insertComponent(ComponentTesting.newFileDto(project)
      .setKey("project:file1")
      .setPath("file1"));
    ComponentDto disabledFileNoPath = db.components().insertComponent(ComponentTesting.newFileDto(project)
      .setKey("project:file2")
      .setPath(null)
      .setEnabled(false));

    Map<String, String> modulesRelativePaths = new HashMap<>();
    modulesRelativePaths.put("project:module1", "module1_path");
    ComponentUuidFactoryWithMigration underTest =
      new ComponentUuidFactoryWithMigration(db.getDbClient(), db.getSession(), project.getKey(), mainBranch, pathToKey, modulesRelativePaths);

    // migrated files
    assertThat(underTest.getOrCreateForKey("project:file1")).isEqualTo(file1.uuid());

    // project remains the same
    assertThat(underTest.getOrCreateForKey(project.getKey())).isEqualTo(project.uuid());
  }

  @Test
  public void migrate_project_with_disabled_components_same_path() {
    ComponentDto project = db.components().insertPrivateProject(dto -> dto.setKey("project"));
    ComponentDto module1 = db.components().insertComponent(ComponentTesting.newModuleDto(project)
      .setKey("project:module1"));
    ComponentDto file1 = db.components().insertComponent(ComponentTesting.newFileDto(project)
      .setKey("project:file1")
      .setPath("file1"));
    ComponentDto disabledFileSamePath = db.components().insertComponent(ComponentTesting.newFileDto(project)
      .setKey("project:file2")
      .setPath("file1")
      .setEnabled(false));

    Map<String, String> modulesRelativePaths = new HashMap<>();
    modulesRelativePaths.put("project:module1", "module1_path");
    ComponentUuidFactoryWithMigration underTest =
      new ComponentUuidFactoryWithMigration(db.getDbClient(), db.getSession(), project.getKey(), mainBranch, pathToKey, modulesRelativePaths);

    // migrated files
    assertThat(underTest.getOrCreateForKey("project:file1")).isEqualTo(file1.uuid());

    // project remains the same
    assertThat(underTest.getOrCreateForKey(project.getKey())).isEqualTo(project.uuid());
  }

  @Test
  public void prefers_component_having_same_key() {
    ComponentDto project = db.components().insertPrivateProject(dto -> dto.setKey("project"));
    ComponentDto module1 = db.components().insertComponent(ComponentTesting.newModuleDto(project)
      .setKey("project:module1"));
    ComponentDto file1 = db.components().insertComponent(ComponentTesting.newFileDto(module1)
      .setKey("project:module1:file1")
      .setPath("file1"));
    ComponentDto disabledFileSameKey = db.components().insertComponent(ComponentTesting.newFileDto(project)
      .setKey("project:module1/file1")
      .setPath("module1_path/file1")
      .setEnabled(false));

    Map<String, String> modulesRelativePaths = new HashMap<>();
    modulesRelativePaths.put("project:module1", "module1_path");
    ComponentUuidFactoryWithMigration underTest =
      new ComponentUuidFactoryWithMigration(db.getDbClient(), db.getSession(), project.getKey(), mainBranch, pathToKey, modulesRelativePaths);

    // in theory we should migrate file1. But since disabledFileSameKey already have the expected migrated key, let's reuse it.
    assertThat(underTest.getOrCreateForKey("project:module1/file1")).isEqualTo(disabledFileSameKey.uuid());

    // project remains the same
    assertThat(underTest.getOrCreateForKey(project.getKey())).isEqualTo(project.uuid());
  }

  @Test
  public void migrate_branch_with_modules() {
    pathToKey = path -> path != null ? "project:" + path : "project";
    ComponentDto project = db.components().insertPrivateProject(dto -> dto.setKey("project"));
    ComponentDto module1 = db.components().insertComponent(ComponentTesting.newModuleDto(project)
      .setKey("project:module1"));
    ComponentDto module2 = db.components().insertComponent(ComponentTesting.newModuleDto(module1)
      .setKey("project:module1:module2"));
    ComponentDto file1 = db.components().insertComponent(ComponentTesting.newFileDto(project)
      .setKey("project:file1")
      .setPath("file1_path"));
    ComponentDto file2 = db.components().insertComponent(ComponentTesting.newFileDto(module2)
      .setKey("project:module1:module2:file2")
      .setPath("file2_path"));

    assertThat(file2.moduleUuidPath()).isEqualTo("." + project.uuid() + "." + module1.uuid() + "." + module2.uuid() + ".");
    Map<String, String> modulesRelativePaths = new HashMap<>();
    modulesRelativePaths.put("project:module1", "module1_path");
    modulesRelativePaths.put("project:module1:module2", "module1_path/module2_path");
    ComponentUuidFactoryWithMigration underTest =
      new ComponentUuidFactoryWithMigration(db.getDbClient(), db.getSession(), project.getKey(), mainBranch, pathToKey, modulesRelativePaths);

    // migrated files
    assertThat(underTest.getOrCreateForKey("project:file1_path")).isEqualTo(file1.uuid());
    assertThat(underTest.getOrCreateForKey("project:module1_path/module2_path/file2_path")).isEqualTo(file2.uuid());

    // project remains the same
    assertThat(underTest.getOrCreateForKey(project.getKey())).isEqualTo(project.uuid());
  }

  @Test
  public void migrate_project_with_root_folders() {
    ComponentDto project = db.components().insertPrivateProject(dto -> dto.setKey("project"));
    ComponentDto module1 = db.components().insertComponent(ComponentTesting.newModuleDto(project)
      .setKey("project:module1"));
    ComponentDto dir1 = db.components().insertComponent(ComponentTesting.newDirectory(module1, "/")
      .setKey("project:module1:/"));

    Map<String, String> modulesRelativePaths = Collections.singletonMap("project:module1", "module1_path");
    ComponentUuidFactoryWithMigration underTest =
      new ComponentUuidFactoryWithMigration(db.getDbClient(), db.getSession(), project.getKey(), mainBranch, pathToKey, modulesRelativePaths);

    // project remains the same
    assertThat(underTest.getOrCreateForKey(project.getKey())).isEqualTo(project.uuid());

    // module migrated to folder
    assertThat(underTest.getOrCreateForKey("project:module1_path")).isEqualTo(module1.uuid());
  }

  @Test
  public void dont_override_root_uuid_if_module_path_is_not_sent() {
    ComponentDto project = db.components().insertPrivateProject(dto -> dto.setKey("project"));
    ComponentDto module1 = db.components().insertComponent(ComponentTesting.newModuleDto(project)
      .setKey("project:module1")
      .setEnabled(false));
    ComponentDto module2 = db.components().insertComponent(ComponentTesting.newModuleDto(project)
      .setKey("project:module2")
      .setEnabled(false));
    Map<String, String> modulesRelativePaths = new HashMap<>();
    modulesRelativePaths.put("project", "");
    modulesRelativePaths.put("project:module2", "module2");
    ComponentUuidFactoryWithMigration underTest =
      new ComponentUuidFactoryWithMigration(db.getDbClient(), db.getSession(), project.getKey(), mainBranch, pathToKey, modulesRelativePaths);

    // check root project.
    assertThat(underTest.getOrCreateForKey("project")).isEqualTo(project.uuid());
  }

  @Test
  public void generate_uuid_if_it_does_not_exist_in_db() {
    ComponentUuidFactoryWithMigration underTest =
      new ComponentUuidFactoryWithMigration(db.getDbClient(), db.getSession(), "theProjectKey", mainBranch, pathToKey, Collections.emptyMap());

    String generatedKey = underTest.getOrCreateForKey("foo");
    assertThat(generatedKey).isNotEmpty();

    // uuid is kept in memory for further calls with same key
    assertThat(underTest.getOrCreateForKey("foo")).isEqualTo(generatedKey);
  }

}