source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2024 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.ce.task.projectanalysis.webhook;
  21
  22 import com.google.common.collect.ImmutableMap;
  23 import java.util.Collections;
  24 import java.util.Date;
  25 import java.util.Map;
  26 import java.util.Random;
  27 import java.util.function.Supplier;
  28 import javax.annotation.Nullable;
  29 import org.junit.Before;
  30 import org.junit.Test;
  31 import org.mockito.ArgumentCaptor;
  32 import org.sonar.api.ce.posttask.Branch;
  33 import org.sonar.api.ce.posttask.CeTask;
  34 import org.sonar.api.ce.posttask.PostProjectAnalysisTask.LogStatistics;
  35 import org.sonar.api.ce.posttask.Project;
  36 import org.sonar.api.ce.posttask.QualityGate;
  37 import org.sonar.api.config.Configuration;
  38 import org.sonar.api.measures.Metric;
  39 import org.sonar.api.testfixtures.posttask.PostProjectAnalysisTaskTester;
  40 import org.sonar.ce.task.projectanalysis.component.ConfigurationRepository;
  41 import org.sonar.server.qualitygate.Condition;
  42 import org.sonar.server.qualitygate.EvaluatedCondition;
  43 import org.sonar.server.qualitygate.EvaluatedQualityGate;
  44 import org.sonar.server.webhook.Analysis;
  45 import org.sonar.server.webhook.ProjectAnalysis;
  46 import org.sonar.server.webhook.WebHooks;
  47 import org.sonar.server.webhook.WebhookPayload;
  48 import org.sonar.server.webhook.WebhookPayloadFactory;
  49
  50 import static org.apache.commons.lang3.RandomStringUtils.randomAlphanumeric;
  51 import static org.assertj.core.api.Assertions.assertThat;
  52 import static org.mockito.ArgumentMatchers.any;
  53 import static org.mockito.ArgumentMatchers.eq;
  54 import static org.mockito.Mockito.mock;
  55 import static org.mockito.Mockito.verify;
  56 import static org.mockito.Mockito.when;
  57 import static org.sonar.api.testfixtures.posttask.PostProjectAnalysisTaskTester.newBranchBuilder;
  58 import static org.sonar.api.testfixtures.posttask.PostProjectAnalysisTaskTester.newCeTaskBuilder;
  59 import static org.sonar.api.testfixtures.posttask.PostProjectAnalysisTaskTester.newConditionBuilder;
  60 import static org.sonar.api.testfixtures.posttask.PostProjectAnalysisTaskTester.newProjectBuilder;
  61 import static org.sonar.api.testfixtures.posttask.PostProjectAnalysisTaskTester.newQualityGateBuilder;
  62 import static org.sonar.api.testfixtures.posttask.PostProjectAnalysisTaskTester.newScannerContextBuilder;
  63
  64 public class WebhookPostTaskTest {
  65
  66   private final Random random = new Random();
  67   private final Configuration configuration = mock(Configuration.class);
  68   private final WebhookPayload webhookPayload = mock(WebhookPayload.class);
  69   private final WebhookPayloadFactory payloadFactory = mock(WebhookPayloadFactory.class);
  70   private final WebHooks webHooks = mock(WebHooks.class);
  71   private final ConfigurationRepository configurationRepository = mock(ConfigurationRepository.class);
  72   private WebhookPostTask underTest = new WebhookPostTask(payloadFactory, webHooks);
  73
  74   @Before
  75   public void wireMocks() {
  76     when(payloadFactory.create(any(ProjectAnalysis.class))).thenReturn(webhookPayload);
  77     when(configurationRepository.getConfiguration()).thenReturn(configuration);
  78   }
  79
  80   @Test
  81   public void has_description() {
  82     assertThat(underTest.getDescription()).isNotEmpty();
  83   }
  84
  85   @Test
  86   public void call_webhooks_when_no_analysis_not_qualitygate() {
  87     callWebHooks(null, null);
  88   }
  89
  90   @Test
  91   public void call_webhooks_with_analysis_and_qualitygate() {
  92     QualityGate.Condition condition = newConditionBuilder()
  93       .setMetricKey(randomAlphanumeric(96))
  94       .setOperator(QualityGate.Operator.LESS_THAN)
  95       .setErrorThreshold(randomAlphanumeric(22))
  96       .build(QualityGate.EvaluationStatus.OK, randomAlphanumeric(33));
  97     QualityGate qualityGate = newQualityGateBuilder()
  98       .setId(randomAlphanumeric(23))
  99       .setName(randomAlphanumeric(66))
 100       .setStatus(QualityGate.Status.values()[random.nextInt(QualityGate.Status.values().length)])
 101       .add(condition)
 102       .build();
 103
 104     callWebHooks(randomAlphanumeric(40), qualityGate);
 105   }
 106
 107   private void callWebHooks(@Nullable String analysisUUid, @Nullable QualityGate qualityGate) {
 108     Project project = newProjectBuilder()
 109       .setUuid(randomAlphanumeric(3))
 110       .setKey(randomAlphanumeric(4))
 111       .setName(randomAlphanumeric(5))
 112       .build();
 113     CeTask ceTask = newCeTaskBuilder()
 114       .setStatus(CeTask.Status.values()[random.nextInt(CeTask.Status.values().length)])
 115       .setId(randomAlphanumeric(6))
 116       .build();
 117     Date date = new Date();
 118     Map<String, String> properties = ImmutableMap.of(randomAlphanumeric(17), randomAlphanumeric(18));
 119     Branch branch = newBranchBuilder()
 120       .setIsMain(random.nextBoolean())
 121       .setType(Branch.Type.values()[random.nextInt(Branch.Type.values().length)])
 122       .setName(randomAlphanumeric(29))
 123       .build();
 124
 125     PostProjectAnalysisTaskTester.of(underTest)
 126       .at(date)
 127       .withCeTask(ceTask)
 128       .withProject(project)
 129       .withBranch(branch)
 130       .withQualityGate(qualityGate)
 131       .withScannerContext(newScannerContextBuilder()
 132         .addProperties(properties)
 133         .build())
 134       .withAnalysisUuid(analysisUUid)
 135       .withQualityGate(qualityGate)
 136       .execute();
 137
 138     ArgumentCaptor<Supplier> supplierCaptor = ArgumentCaptor.forClass(Supplier.class);
 139     verify(webHooks)
 140       .sendProjectAnalysisUpdate(
 141         eq(new WebHooks.Analysis(project.getUuid(),
 142           analysisUUid,
 143           ceTask.getId())),
 144         supplierCaptor.capture(),
 145         any(LogStatistics.class));
 146
 147     assertThat(supplierCaptor.getValue().get()).isSameAs(webhookPayload);
 148
 149     EvaluatedQualityGate webQualityGate = null;
 150     if (qualityGate != null) {
 151       QualityGate.Condition condition = qualityGate.getConditions().iterator().next();
 152       Condition qgCondition = new Condition(
 153         condition.getMetricKey(),
 154         Condition.Operator.valueOf(condition.getOperator().name()),
 155         condition.getErrorThreshold());
 156       webQualityGate = EvaluatedQualityGate.newBuilder()
 157         .setQualityGate(new org.sonar.server.qualitygate.QualityGate(qualityGate.getId(), qualityGate.getName(), Collections.singleton(qgCondition)))
 158         .setStatus(Metric.Level.valueOf(qualityGate.getStatus().name()))
 159         .addEvaluatedCondition(qgCondition, EvaluatedCondition.EvaluationStatus.valueOf(condition.getStatus().name()), condition.getValue())
 160         .build();
 161     }
 162
 163     verify(payloadFactory).create(new ProjectAnalysis(
 164       new org.sonar.server.webhook.Project(project.getUuid(), project.getKey(), project.getName()),
 165       new org.sonar.server.webhook.CeTask(ceTask.getId(), org.sonar.server.webhook.CeTask.Status.valueOf(ceTask.getStatus().name())),
 166       analysisUUid == null ? null : new Analysis(analysisUUid, date.getTime(), null),
 167       new org.sonar.server.webhook.Branch(branch.isMain(), branch.getName().get(), org.sonar.server.webhook.Branch.Type.valueOf(branch.getType().name())),
 168       webQualityGate,
 169       analysisUUid == null ? null : date.getTime(),
 170       properties));
 171   }
 172 }