sonarqube/server/sonar-webserver-webapi/src/test/java/org/sonar/server/project/ws/UpdateKeyActionTest.java

/*
 * SonarQube
 * Copyright (C) 2009-2019 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.server.project.ws;

import java.util.Optional;
import javax.annotation.Nullable;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.sonar.api.server.ws.WebService;
import org.sonar.api.server.ws.WebService.Param;
import org.sonar.api.utils.System2;
import org.sonar.api.web.UserRole;
import org.sonar.db.DbClient;
import org.sonar.db.DbTester;
import org.sonar.db.component.ComponentDto;
import org.sonar.db.component.ComponentTesting;
import org.sonar.server.component.ComponentService;
import org.sonar.server.es.ProjectIndexers;
import org.sonar.server.es.ProjectIndexersImpl;
import org.sonar.server.exceptions.ForbiddenException;
import org.sonar.server.exceptions.NotFoundException;
import org.sonar.server.project.ProjectLifeCycleListenersImpl;
import org.sonar.server.tester.UserSessionRule;
import org.sonar.server.ws.TestRequest;
import org.sonar.server.ws.WsActionTester;

import static org.assertj.core.api.Assertions.assertThat;
import static org.sonarqube.ws.client.project.ProjectsWsParameters.PARAM_FROM;
import static org.sonarqube.ws.client.project.ProjectsWsParameters.PARAM_TO;

public class UpdateKeyActionTest {
  private static final String ANOTHER_KEY = "another_key";

  @Rule
  public ExpectedException expectedException = ExpectedException.none();
  @Rule
  public DbTester db = DbTester.create(System2.INSTANCE);
  @Rule
  public UserSessionRule userSessionRule = UserSessionRule.standalone();
  private DbClient dbClient = db.getDbClient();
  private ProjectIndexers projectIndexers = new ProjectIndexersImpl();
  private ComponentService componentService = new ComponentService(dbClient, userSessionRule, projectIndexers, new ProjectLifeCycleListenersImpl());
  private WsActionTester ws = new WsActionTester(new UpdateKeyAction(dbClient, componentService));

  @Test
  public void update_key_of_project_referenced_by_its_key() {
    ComponentDto project = insertProject();
    userSessionRule.addProjectPermission(UserRole.ADMIN, project);

    call(project.getKey(), ANOTHER_KEY);

    assertThat(selectByKey(project.getKey()).isPresent()).isFalse();
    assertThat(selectByKey(ANOTHER_KEY).get().uuid()).isEqualTo(project.uuid());
  }

  @Test
  public void update_key_of_disabled_module() {
    ComponentDto project = insertProject();
    ComponentDto module = db.components().insertComponent(ComponentTesting.newModuleDto(project).setEnabled(false));
    userSessionRule.addProjectPermission(UserRole.ADMIN, project);

    call(module.getKey(), ANOTHER_KEY);

    assertThat(selectByKey(project.getKey()).isPresent()).isTrue();
    assertThat(selectByKey(module.getKey()).isPresent()).isFalse();
    ComponentDto loadedModule = selectByKey(ANOTHER_KEY).get();
    assertThat(loadedModule.uuid()).isEqualTo(module.uuid());
    assertThat(loadedModule.isEnabled()).isFalse();
  }

  @Test
  public void fail_if_not_authorized() {
    ComponentDto project = insertProject();
    userSessionRule.addProjectPermission(UserRole.USER, project);

    expectedException.expect(ForbiddenException.class);
    expectedException.expectMessage("Insufficient privileges");

    call(project.getKey(), ANOTHER_KEY);
  }

  @Test
  public void fail_if_new_key_is_not_provided() {
    ComponentDto project = insertProject();
    userSessionRule.addProjectPermission(UserRole.ADMIN, project);

    expectedException.expect(IllegalArgumentException.class);
    expectedException.expectMessage("The 'to' parameter is missing");

    call(project.getKey(), null);
  }

  @Test
  public void fail_if_key_not_provided() {
    expectedException.expect(IllegalArgumentException.class);
    expectedException.expectMessage("The 'from' parameter is missing");

    call(null, ANOTHER_KEY);
  }

  @Test
  public void fail_if_project_does_not_exist() {
    expectedException.expect(NotFoundException.class);

    call("UNKNOWN_UUID", ANOTHER_KEY);
  }

  @Test
  public void fail_when_using_branch_db_key() throws Exception {
    ComponentDto project = db.components().insertMainBranch();
    ComponentDto branch = db.components().insertProjectBranch(project);
    userSessionRule.addProjectPermission(UserRole.ADMIN, project);

    expectedException.expect(NotFoundException.class);
    expectedException.expectMessage("Component not found");

    call(branch.getDbKey(), ANOTHER_KEY);
  }

  @Test
  public void api_definition() {
    WebService.Action definition = ws.getDef();

    assertThat(definition.since()).isEqualTo("6.1");
    assertThat(definition.isPost()).isTrue();
    assertThat(definition.key()).isEqualTo("update_key");
    assertThat(definition.changelog()).hasSize(1);
    assertThat(definition.params())
      .hasSize(2)
      .extracting(Param::key)
      .containsOnlyOnce("from", "to");
  }

  private ComponentDto insertProject() {
    return db.components().insertComponent(ComponentTesting.newPrivateProjectDto(db.organizations().insert()));
  }

  private String call(@Nullable String key, @Nullable String newKey) {
    TestRequest request = ws.newRequest();

    if (key != null) {
      request.setParam(PARAM_FROM, key);
    }
    if (newKey != null) {
      request.setParam(PARAM_TO, newKey);
    }

    return request.execute().getInput();
  }

  private Optional<ComponentDto> selectByKey(String key) {
    return db.getDbClient().componentDao().selectByKey(db.getSession(), key);
  }
}