sonarqube/it/it-tests/src/test/java/administration/suite/administration/ProjectAdministrationTest.java

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube 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.
 *
 * SonarQube 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 administration.suite.administration;

import administration.suite.AdministrationTestSuite;
import com.sonar.orchestrator.Orchestrator;
import com.sonar.orchestrator.build.SonarRunner;
import com.sonar.orchestrator.selenium.Selenese;
import java.sql.SQLException;
import java.util.Calendar;
import java.util.GregorianCalendar;
import javax.annotation.Nullable;
import org.junit.Before;
import org.junit.ClassRule;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.sonar.wsclient.SonarClient;
import org.sonar.wsclient.base.HttpException;
import org.sonar.wsclient.permissions.PermissionParameters;
import org.sonar.wsclient.qualitygate.NewCondition;
import org.sonar.wsclient.qualitygate.QualityGate;
import org.sonar.wsclient.qualitygate.QualityGateClient;
import org.sonar.wsclient.qualitygate.QualityGateCondition;
import org.sonar.wsclient.qualitygate.UpdateCondition;
import org.sonar.wsclient.services.PropertyQuery;
import org.sonar.wsclient.services.ResourceQuery;
import org.sonar.wsclient.user.UserParameters;

import static org.assertj.core.api.Assertions.assertThat;
import static util.ItUtils.projectDir;

public class ProjectAdministrationTest {

  private static final String DELETE_WS_ENDPOINT = "api/projects/bulk_delete";
  @ClassRule
  public static Orchestrator orchestrator = AdministrationTestSuite.ORCHESTRATOR;
  @Rule
  public ExpectedException expectedException = ExpectedException.none();

  private static final String PROJECT_KEY = "sample";
  private static final String FILE_KEY = "sample:src/main/xoo/sample/Sample.xoo";

  @Before
  public void deleteAnalysisData() throws SQLException {
    orchestrator.resetData();
  }

  @Test
  public void delete_project_by_web_service() {
    scanSampleWithDate("2012-01-01");

    assertThat(orchestrator.getServer().getWsClient().find(ResourceQuery.create(PROJECT_KEY))).isNotNull();
    assertThat(orchestrator.getServer().getWsClient().find(ResourceQuery.create(FILE_KEY))).isNotNull();

    orchestrator.getServer().adminWsClient().post(DELETE_WS_ENDPOINT, "keys", PROJECT_KEY);

    assertThat(orchestrator.getServer().getWsClient().find(ResourceQuery.create(PROJECT_KEY))).isNull();
    assertThat(orchestrator.getServer().getWsClient().find(ResourceQuery.create(FILE_KEY))).isNull();
  }

  @Test
  public void fail_when_trying_to_delete_a_file() {
    expectedException.expect(HttpException.class);
    scanSampleWithDate("2012-01-01");

    assertThat(orchestrator.getServer().getWsClient().find(ResourceQuery.create(PROJECT_KEY))).isNotNull();
    assertThat(orchestrator.getServer().getWsClient().find(ResourceQuery.create(FILE_KEY))).isNotNull();

    // it's forbidden to delete only some files
    orchestrator.getServer().adminWsClient().post(DELETE_WS_ENDPOINT, "keys", FILE_KEY);
  }

  @Test
  public void fail_when_insufficient_privilege() {
    expectedException.expect(HttpException.class);
    scanSampleWithDate("2012-01-01");

    assertThat(orchestrator.getServer().getWsClient().find(ResourceQuery.create(PROJECT_KEY))).isNotNull();

    // use wsClient() instead of adminWsClient()
    orchestrator.getServer().wsClient().post(DELETE_WS_ENDPOINT, "keys", PROJECT_KEY);
  }

  /**
   * Test updated for SONAR-3570 and SONAR-5923
   */
  @Test
  public void project_deletion() throws Exception {
    String projectAdminUser = "project-deletion-with-admin-permission-on-project";
    SonarClient adminClient = orchestrator.getServer().adminWsClient();
    try {
      SonarRunner scan = SonarRunner.create(projectDir("shared/xoo-sample"));
      orchestrator.executeBuild(scan);

      // Create user having admin permission on previously analysed project
      adminClient.userClient().create(
        UserParameters.create().login(projectAdminUser).name(projectAdminUser).password("password").passwordConfirmation("password"));
      adminClient.permissionClient().addPermission(
        PermissionParameters.create().user(projectAdminUser).component("sample").permission("admin"));

      orchestrator.executeSelenese(
        Selenese.builder().setHtmlTestsInClasspath("project-deletion", "/administration/suite/ProjectAdministrationTest/project-deletion/project-deletion.html").build()
        );
    } finally {
      adminClient.userClient().deactivate(projectAdminUser);
    }
  }

  // SONAR-4203
  @Test
  public void delete_version_of_multimodule_project() throws Exception {
    GregorianCalendar today = new GregorianCalendar();
    SonarRunner build = SonarRunner.create(projectDir("shared/xoo-multi-modules-sample"))
      .setProperty("sonar.dynamicAnalysis", "false")
      .setProperty("sonar.projectDate", (today.get(Calendar.YEAR) - 1) + "-01-01");
    orchestrator.executeBuild(build);

    // The analysis must be run once again to have an history so that it is possible
    // to set/delete version on old snapshot
    build.setProperty("sonar.projectDate", today.get(Calendar.YEAR) + "-01-01");
    orchestrator.executeBuild(build);

    // There are 7 modules
    assertThat(count("events where category='Version'")).as("Different number of events").isEqualTo(7);

    Selenese selenese = Selenese
      .builder()
      .setHtmlTestsInClasspath("modify_version_of_multimodule_project",
        "/administration/suite/ProjectAdministrationTest/project-administration/multimodule-project-modify-version.html"
      ).build();
    orchestrator.executeSelenese(selenese);

    assertThat(count("events where category='Version'")).as("Different number of events").isEqualTo(14);

    selenese = Selenese
      .builder()
      .setHtmlTestsInClasspath("delete_version_of_multimodule_project",
        "/administration/suite/ProjectAdministrationTest/project-administration/multimodule-project-delete-version.html"
      ).build();
    orchestrator.executeSelenese(selenese);

    assertThat(count("events where category='Version'")).as("Different number of events").isEqualTo(7);
  }

  // SONAR-3326
  @Test
  public void display_alerts_correctly_in_history_page() throws Exception {
    QualityGateClient qgClient = orchestrator.getServer().adminWsClient().qualityGateClient();
    QualityGate qGate = qgClient.create("AlertsForHistory");
    qgClient.setDefault(qGate.id());

    // with this configuration, project should have an Orange alert
    QualityGateCondition lowThresholds = qgClient.createCondition(NewCondition.create(qGate.id()).metricKey("lines").operator("GT").warningThreshold("5").errorThreshold("50"));
    scanSampleWithDate("2012-01-01");
    // with this configuration, project should have a Green alert
    qgClient.updateCondition(UpdateCondition.create(lowThresholds.id()).metricKey("lines").operator("GT").warningThreshold("5000").errorThreshold("5000"));
    scanSampleWithDate("2012-01-02");

    Selenese selenese = Selenese
      .builder()
      .setHtmlTestsInClasspath("display-alerts-history-page",
        "/administration/suite/ProjectAdministrationTest/display-alerts-history-page/should-display-alerts-correctly-history-page.html"
      ).build();
    orchestrator.executeSelenese(selenese);

    qgClient.unsetDefault();
    qgClient.destroy(qGate.id());
  }

  /**
   * SONAR-1352
   */
  @Test
  public void display_period_alert_on_project_dashboard() throws Exception {
    QualityGateClient qgClient = orchestrator.getServer().adminWsClient().qualityGateClient();
    QualityGate qGate = qgClient.create("AlertsForDashboard");
    qgClient.createCondition(NewCondition.create(qGate.id()).metricKey("lines").operator("LT").warningThreshold("0").errorThreshold("10")
      .period(1));
    qgClient.setDefault(qGate.id());

    // No alert
    scanSampleWithDate("2012-01-01");

    // Red alert because lines number has not changed since previous analysis
    scanSample();

    Selenese selenese = Selenese
      .builder()
      .setHtmlTestsInClasspath("display-period-alerts",
        "/administration/suite/ProjectAdministrationTest/display-alerts/should-display-period-alerts-correctly.html"
      ).build();
    orchestrator.executeSelenese(selenese);

    qgClient.unsetDefault();
    qgClient.destroy(qGate.id());
  }

  /**
   * SONAR-3425
   */
  @Test
  public void project_settings() {
    scanSampleWithDate("2012-01-01");

    Selenese selenese = Selenese.builder().setHtmlTestsInClasspath("project-settings",
      // SONAR-3425
      "/administration/suite/ProjectAdministrationTest/project-settings/override-global-settings.html",

      "/administration/suite/ProjectAdministrationTest/project-settings/only-on-project-settings.html"
      ).build();
    orchestrator.executeSelenese(selenese);

    assertThat(orchestrator.getServer().getAdminWsClient().find(PropertyQuery.createForResource("sonar.skippedModules", "sample")).getValue())
      .isEqualTo("my-excluded-module");
  }

  /**
   * SONAR-1608
   */
  @Test
  public void bulk_update_project_keys() {
    SonarRunner build = SonarRunner.create(projectDir("shared/xoo-multi-modules-sample"));
    orchestrator.executeBuild(build);

    Selenese selenese = Selenese
      .builder()
      .setHtmlTestsInClasspath("project-bulk-update-keys",
        "/administration/suite/ProjectAdministrationTest/project-update-keys/bulk-update-impossible-because-duplicate-keys.html",
        "/administration/suite/ProjectAdministrationTest/project-update-keys/bulk-update-impossible-because-no-input.html",
        "/administration/suite/ProjectAdministrationTest/project-update-keys/bulk-update-impossible-because-no-match.html",
        "/administration/suite/ProjectAdministrationTest/project-update-keys/bulk-update-success.html"
      ).build();
    orchestrator.executeSelenese(selenese);
  }

  /**
   * SONAR-1608
   */
  @Test
  public void fine_grain_update_project_keys() {
    SonarRunner build = SonarRunner.create(projectDir("shared/xoo-multi-modules-sample"));
    orchestrator.executeBuild(build);

    Selenese selenese = Selenese
      .builder()
      .setHtmlTestsInClasspath("project-fine-grained-update-keys",
        "/administration/suite/ProjectAdministrationTest/project-update-keys/fine-grained-update-impossible.html",
        "/administration/suite/ProjectAdministrationTest/project-update-keys/fine-grained-update-success.html"
      ).build();
    orchestrator.executeSelenese(selenese);
  }

  @Test
  public void anonymous_should_have_user_role_to_access_project() {
    scanSample();

    Selenese selenese = Selenese.builder()
      .setHtmlTestsInClasspath("anonymous_should_have_user_role_to_access_project",
        "/administration/suite/ProjectAdministrationTest/anonymous_should_have_user_role_to_access_project/remove_user_role.html"
      ).build();
    orchestrator.executeSelenese(selenese);
  }

  /**
   * SONAR-4060
   */
  @Test
  public void display_module_settings() {
    orchestrator.executeBuild(SonarRunner.create(projectDir("shared/xoo-multi-modules-sample")));

    Selenese selenese = Selenese.builder().setHtmlTestsInClasspath("module-settings",
      // SONAR-3425
      "/administration/suite/ProjectAdministrationTest/module-settings/display-module-settings.html"
      ).build();
    orchestrator.executeSelenese(selenese);
  }

  private void scanSample() {
    scanSample(null, null);
  }

  private void scanSampleWithDate(String date) {
    scanSample(date, null);
  }

  private void scanSample(@Nullable String date, @Nullable String profile) {
    SonarRunner scan = SonarRunner.create(projectDir("shared/xoo-sample"))
      .setProperties("sonar.cpd.skip", "true");
    if (date != null) {
      scan.setProperty("sonar.projectDate", date);
    }
    if (profile != null) {
      scan.setProfile(profile);
    }
    orchestrator.executeBuild(scan);
  }

  private int count(String condition) {
    return orchestrator.getDatabase().countSql("select count(*) from " + condition);
  }

}