123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329 |
- /*
- * 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.server.qualitygate.ws;
-
- import org.junit.Before;
- import org.junit.Rule;
- import org.junit.Test;
- import org.sonar.api.server.ws.WebService;
- import org.sonar.api.server.ws.WebService.Param;
- import org.sonar.api.utils.System2;
- import org.sonar.db.DbSession;
- import org.sonar.db.DbTester;
- import org.sonar.db.metric.MetricDto;
- import org.sonar.db.qualitygate.QualityGateConditionDto;
- import org.sonar.db.qualitygate.QualityGateDto;
- import org.sonar.db.user.UserDto;
- import org.sonar.server.component.TestComponentFinder;
- import org.sonar.server.exceptions.NotFoundException;
- import org.sonar.server.qualitygate.QualityGateCaycChecker;
- import org.sonar.server.qualitygate.QualityGateFinder;
- import org.sonar.server.tester.UserSessionRule;
- import org.sonar.server.ws.WsActionTester;
- import org.sonarqube.ws.Qualitygates.ShowWsResponse;
- import org.sonarqube.ws.Qualitygates.ShowWsResponse.Condition;
-
- import static java.lang.String.format;
- import static org.assertj.core.api.Assertions.assertThat;
- import static org.assertj.core.api.Assertions.assertThatThrownBy;
- import static org.assertj.core.api.AssertionsForClassTypes.tuple;
- import static org.junit.Assert.assertEquals;
- import static org.mockito.ArgumentMatchers.any;
- import static org.mockito.ArgumentMatchers.eq;
- import static org.mockito.Mockito.mock;
- import static org.mockito.Mockito.when;
- import static org.sonar.db.permission.GlobalPermission.ADMINISTER_QUALITY_GATES;
- import static org.sonar.db.permission.GlobalPermission.ADMINISTER_QUALITY_PROFILES;
- import static org.sonar.server.qualitygate.QualityGateCaycStatus.COMPLIANT;
- import static org.sonar.test.JsonAssert.assertJson;
- import static org.sonarqube.ws.Qualitygates.Actions;
-
- public class ShowActionTest {
-
- @Rule
- public UserSessionRule userSession = UserSessionRule.standalone();
- @Rule
- public DbTester db = DbTester.create(System2.INSTANCE);
- private final QualityGateCaycChecker qualityGateCaycChecker = mock(QualityGateCaycChecker.class);
-
- private final WsActionTester ws = new WsActionTester(
- new ShowAction(db.getDbClient(), new QualityGateFinder(db.getDbClient()),
- new QualityGatesWsSupport(db.getDbClient(), userSession, TestComponentFinder.from(db)), qualityGateCaycChecker));
-
- @Before
- public void setUp() {
- when(qualityGateCaycChecker.checkCaycCompliant(any(), any())).thenReturn(COMPLIANT);
- }
-
- @Test
- public void show() {
- QualityGateDto qualityGate = db.qualityGates().insertQualityGate();
- db.qualityGates().setDefaultQualityGate(qualityGate);
- MetricDto metric1 = db.measures().insertMetric();
- MetricDto metric2 = db.measures().insertMetric();
- QualityGateConditionDto condition1 = db.qualityGates().addCondition(qualityGate, metric1, c -> c.setOperator("GT"));
- QualityGateConditionDto condition2 = db.qualityGates().addCondition(qualityGate, metric2, c -> c.setOperator("LT"));
-
- ShowWsResponse response = ws.newRequest()
- .setParam("name", qualityGate.getName())
- .executeProtobuf(ShowWsResponse.class);
-
- assertThat(response.getId()).isEqualTo(qualityGate.getUuid());
- assertThat(response.getName()).isEqualTo(qualityGate.getName());
- assertThat(response.getIsBuiltIn()).isFalse();
- assertThat(response.getConditionsList()).hasSize(2);
- assertThat(response.getConditionsList())
- .extracting(Condition::getId, Condition::getMetric, Condition::getOp, Condition::getError)
- .containsExactlyInAnyOrder(
- tuple(condition1.getUuid(), metric1.getKey(), "GT", condition1.getErrorThreshold()),
- tuple(condition2.getUuid(), metric2.getKey(), "LT", condition2.getErrorThreshold()));
- }
-
- @Test
- public void show_built_in() {
- QualityGateDto qualityGate = db.qualityGates().insertQualityGate(qg -> qg.setBuiltIn(true));
- db.qualityGates().setDefaultQualityGate(qualityGate);
-
- ShowWsResponse response = ws.newRequest()
- .setParam("name", qualityGate.getName())
- .executeProtobuf(ShowWsResponse.class);
-
- assertThat(response.getIsBuiltIn()).isTrue();
- }
-
- @Test
- public void show_isCaycCompliant() {
- QualityGateDto qualityGate = db.qualityGates().insertQualityGate();
- when(qualityGateCaycChecker.checkCaycCompliant(any(DbSession.class), eq(qualityGate.getUuid()))).thenReturn(COMPLIANT);
- db.qualityGates().setDefaultQualityGate(qualityGate);
-
- ShowWsResponse response = ws.newRequest()
- .setParam("name", qualityGate.getName())
- .executeProtobuf(ShowWsResponse.class);
-
- assertEquals(COMPLIANT.toString(), response.getCaycStatus());
- }
-
- @Test
- public void show_by_id() {
- QualityGateDto qualityGate = db.qualityGates().insertQualityGate();
- db.qualityGates().setDefaultQualityGate(qualityGate);
-
- ShowWsResponse response = ws.newRequest()
- .setParam("name", qualityGate.getName())
- .executeProtobuf(ShowWsResponse.class);
-
- assertThat(response.getId()).isEqualTo(qualityGate.getUuid());
- assertThat(response.getName()).isEqualTo(qualityGate.getName());
- }
-
- @Test
- public void no_condition() {
- QualityGateDto qualityGate = db.qualityGates().insertQualityGate();
- db.qualityGates().setDefaultQualityGate(qualityGate);
-
- ShowWsResponse response = ws.newRequest()
- .setParam("name", qualityGate.getName())
- .executeProtobuf(ShowWsResponse.class);
-
- assertThat(response.getId()).isEqualTo(qualityGate.getUuid());
- assertThat(response.getName()).isEqualTo(qualityGate.getName());
- assertThat(response.getConditionsList()).isEmpty();
- }
-
- @Test
- public void actions() {
- userSession.logIn("john").addPermission(ADMINISTER_QUALITY_GATES);
- QualityGateDto qualityGate = db.qualityGates().insertQualityGate();
- QualityGateDto qualityGate2 = db.qualityGates().insertQualityGate();
- db.qualityGates().setDefaultQualityGate(qualityGate2);
-
- ShowWsResponse response = ws.newRequest()
- .setParam("name", qualityGate.getName())
- .executeProtobuf(ShowWsResponse.class);
-
- Actions actions = response.getActions();
- assertThat(actions.getRename()).isTrue();
- assertThat(actions.getManageConditions()).isTrue();
- assertThat(actions.getDelete()).isTrue();
- assertThat(actions.getCopy()).isTrue();
- assertThat(actions.getSetAsDefault()).isTrue();
- assertThat(actions.getAssociateProjects()).isTrue();
- }
-
- @Test
- public void actions_on_default() {
- userSession.logIn("john").addPermission(ADMINISTER_QUALITY_GATES);
- QualityGateDto qualityGate = db.qualityGates().insertQualityGate();
- db.qualityGates().setDefaultQualityGate(qualityGate);
-
- ShowWsResponse response = ws.newRequest()
- .setParam("name", qualityGate.getName())
- .executeProtobuf(ShowWsResponse.class);
-
- Actions actions = response.getActions();
- assertThat(actions.getRename()).isTrue();
- assertThat(actions.getManageConditions()).isTrue();
- assertThat(actions.getDelete()).isFalse();
- assertThat(actions.getCopy()).isTrue();
- assertThat(actions.getSetAsDefault()).isFalse();
- assertThat(actions.getAssociateProjects()).isFalse();
- }
-
- @Test
- public void actions_on_built_in() {
- userSession.logIn("john").addPermission(ADMINISTER_QUALITY_GATES);
- QualityGateDto qualityGate = db.qualityGates().insertQualityGate(qg -> qg.setBuiltIn(true));
- QualityGateDto qualityGate2 = db.qualityGates().insertQualityGate(qg -> qg.setBuiltIn(false));
- db.qualityGates().setDefaultQualityGate(qualityGate2);
-
- ShowWsResponse response = ws.newRequest()
- .setParam("name", qualityGate.getName())
- .executeProtobuf(ShowWsResponse.class);
-
- Actions actions = response.getActions();
- assertThat(actions.getRename()).isFalse();
- assertThat(actions.getManageConditions()).isFalse();
- assertThat(actions.getDelete()).isFalse();
- assertThat(actions.getCopy()).isTrue();
- assertThat(actions.getSetAsDefault()).isTrue();
- assertThat(actions.getAssociateProjects()).isTrue();
- }
-
- @Test
- public void actions_when_not_quality_gate_administer() {
- userSession.logIn("john").addPermission(ADMINISTER_QUALITY_PROFILES);
- QualityGateDto qualityGate = db.qualityGates().insertQualityGate(qg -> qg.setBuiltIn(true));
- db.qualityGates().setDefaultQualityGate(qualityGate);
-
- ShowWsResponse response = ws.newRequest()
- .setParam("name", qualityGate.getName())
- .executeProtobuf(ShowWsResponse.class);
-
- Actions actions = response.getActions();
- assertThat(actions.getRename()).isFalse();
- assertThat(actions.getManageConditions()).isFalse();
- assertThat(actions.getDelete()).isFalse();
- assertThat(actions.getCopy()).isFalse();
- assertThat(actions.getSetAsDefault()).isFalse();
- assertThat(actions.getAssociateProjects()).isFalse();
- }
-
- @Test
- public void actions_when_delegate_quality_gate_administer() {
- QualityGateDto defaultQualityGate = db.qualityGates().insertQualityGate(qg -> qg.setName("Sonar way"));
- QualityGateDto otherQualityGate = db.qualityGates().insertQualityGate(qg -> qg.setName("Sonar way - Without Coverage"));
- UserDto user = db.users().insertUser();
- db.qualityGates().addUserPermission(defaultQualityGate, user);
- db.qualityGates().addUserPermission(otherQualityGate, user);
- userSession.logIn(user);
- db.qualityGates().setDefaultQualityGate(defaultQualityGate);
-
- ShowWsResponse response = ws.newRequest()
- .setParam("name", defaultQualityGate.getName())
- .executeProtobuf(ShowWsResponse.class);
-
- assertThat(response.getActions())
- .extracting(
- Actions::getRename, Actions::getDelete, Actions::getManageConditions,
- Actions::getCopy, Actions::getSetAsDefault, Actions::getAssociateProjects, Actions::getDelegate)
- .containsExactlyInAnyOrder(
- false, false, true, false, false, false, true);
-
- response = ws.newRequest()
- .setParam("name", otherQualityGate.getName())
- .executeProtobuf(ShowWsResponse.class);
-
- assertThat(response.getActions())
- .extracting(
- Actions::getRename, Actions::getDelete, Actions::getManageConditions,
- Actions::getCopy, Actions::getSetAsDefault, Actions::getAssociateProjects, Actions::getDelegate)
- .containsExactlyInAnyOrder(
- false, false, true, false, false, false, true);
-
- }
-
- @Test
- public void fail_when_no_name() {
- QualityGateDto qualityGate = db.qualityGates().insertQualityGate();
-
- assertThatThrownBy(() -> ws.newRequest().execute())
- .isInstanceOf(IllegalArgumentException.class)
- .hasMessageContaining("The 'name' parameter is missing");
- }
-
- @Test
- public void fail_when_condition_is_on_disabled_metric() {
- QualityGateDto qualityGate = db.qualityGates().insertQualityGate();
- db.qualityGates().setDefaultQualityGate(qualityGate);
- MetricDto metric = db.measures().insertMetric();
- db.qualityGates().addCondition(qualityGate, metric);
- db.getDbClient().metricDao().disableByKey(db.getSession(), metric.getKey());
- db.commit();
-
- assertThatThrownBy(() -> ws.newRequest()
- .setParam("name", qualityGate.getName())
- .execute())
- .isInstanceOf(IllegalStateException.class)
- .hasMessageContaining(format("Could not find metric with id %s", metric.getUuid()));
- }
-
- @Test
- public void fail_when_quality_name_does_not_exist() {
- QualityGateDto qualityGate = db.qualityGates().insertQualityGate();
-
- assertThatThrownBy(() -> ws.newRequest()
- .setParam("name", "UNKNOWN")
- .execute())
- .isInstanceOf(NotFoundException.class)
- .hasMessageContaining("No quality gate has been found for name UNKNOWN");
- }
-
- @Test
- public void json_example() {
- userSession.logIn("admin").addPermission(ADMINISTER_QUALITY_GATES);
- QualityGateDto qualityGate = db.qualityGates().insertQualityGate(qg -> qg.setName("My Quality Gate"));
- QualityGateDto qualityGate2 = db.qualityGates().insertQualityGate(qg -> qg.setName("My Quality Gate 2"));
- db.qualityGates().setDefaultQualityGate(qualityGate2);
- MetricDto blockerViolationsMetric = db.measures().insertMetric(m -> m.setKey("blocker_violations"));
- MetricDto criticalViolationsMetric = db.measures().insertMetric(m -> m.setKey("tests"));
- db.qualityGates().addCondition(qualityGate, blockerViolationsMetric, c -> c.setOperator("GT").setErrorThreshold("0"));
- db.qualityGates().addCondition(qualityGate, criticalViolationsMetric, c -> c.setOperator("LT").setErrorThreshold("10"));
-
- String response = ws.newRequest()
- .setParam("name", qualityGate.getName())
- .execute()
- .getInput();
-
- assertJson(response).ignoreFields("id")
- .isSimilarTo(getClass().getResource("show-example.json"));
- }
-
- @Test
- public void verify_definition() {
- WebService.Action action = ws.getDef();
- assertThat(action.since()).isEqualTo("4.3");
- assertThat(action.params())
- .extracting(Param::key, Param::isRequired)
- .containsExactlyInAnyOrder(
- tuple("name", true));
- }
-
- }
|