From c503c06a3e878577ba7350228941bdbb2c78f374 Mon Sep 17 00:00:00 2001 From: Simon Brandhof Date: Sun, 12 May 2019 16:48:32 +0200 Subject: [PATCH] SONAR-11950 autoconfig of SCM revision on CircleCI --- .../sonar/scanner/ci/vendors/CircleCi.java | 55 +++++++++++++++ .../scanner/scan/ProjectScanContainer.java | 2 + .../scanner/ci/vendors/CircleCiTest.java | 69 +++++++++++++++++++ 3 files changed, 126 insertions(+) create mode 100644 sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/CircleCi.java create mode 100644 sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/CircleCiTest.java diff --git a/sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/CircleCi.java b/sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/CircleCi.java new file mode 100644 index 00000000000..81842dc702f --- /dev/null +++ b/sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/CircleCi.java @@ -0,0 +1,55 @@ +/* + * 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.scanner.ci.vendors; + +import org.sonar.api.utils.System2; +import org.sonar.scanner.ci.CiConfiguration; +import org.sonar.scanner.ci.CiConfigurationImpl; +import org.sonar.scanner.ci.CiVendor; + +/** + * Support of https://circleci.com + * + * Environment variables: https://circleci.com/docs/2.0/env-vars/#built-in-environment-variables + */ +public class CircleCi implements CiVendor { + + private final System2 system; + + public CircleCi(System2 system) { + this.system = system; + } + + @Override + public String getName() { + return "CircleCI"; + } + + @Override + public boolean isDetected() { + return "true".equals(system.envVariable("CI")) && "true".equals(system.envVariable("CIRCLECI")); + } + + @Override + public CiConfiguration loadConfiguration() { + String revision = system.envVariable("CIRCLE_SHA1"); + return new CiConfigurationImpl(revision); + } +} diff --git a/sonar-scanner-engine/src/main/java/org/sonar/scanner/scan/ProjectScanContainer.java b/sonar-scanner-engine/src/main/java/org/sonar/scanner/scan/ProjectScanContainer.java index 5d32cbe6a10..ceed297c4eb 100644 --- a/sonar-scanner-engine/src/main/java/org/sonar/scanner/scan/ProjectScanContainer.java +++ b/sonar-scanner-engine/src/main/java/org/sonar/scanner/scan/ProjectScanContainer.java @@ -48,6 +48,7 @@ import org.sonar.scanner.bootstrap.PostJobExtensionDictionnary; import org.sonar.scanner.bootstrap.ProcessedScannerProperties; import org.sonar.scanner.ci.CiConfigurationProvider; import org.sonar.scanner.ci.vendors.BitbucketPipelines; +import org.sonar.scanner.ci.vendors.CircleCi; import org.sonar.scanner.ci.vendors.CirrusCi; import org.sonar.scanner.ci.vendors.DroneCi; import org.sonar.scanner.ci.vendors.Jenkins; @@ -271,6 +272,7 @@ public class ProjectScanContainer extends ComponentContainer { // CI new CiConfigurationProvider(), BitbucketPipelines.class, + CircleCi.class, CirrusCi.class, DroneCi.class, Jenkins.class, diff --git a/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/CircleCiTest.java b/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/CircleCiTest.java new file mode 100644 index 00000000000..582753cce2f --- /dev/null +++ b/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/CircleCiTest.java @@ -0,0 +1,69 @@ +/* + * 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.scanner.ci.vendors; + +import javax.annotation.Nullable; +import org.junit.Test; +import org.sonar.api.utils.System2; +import org.sonar.scanner.ci.CiVendor; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +public class CircleCiTest { + + private System2 system = mock(System2.class); + private CiVendor underTest = new CircleCi(system); + + @Test + public void getName() { + assertThat(underTest.getName()).isEqualTo("CircleCI"); + } + + @Test + public void isDetected() { + setEnvVariable("CI", "true"); + setEnvVariable("CIRCLECI", "true"); + assertThat(underTest.isDetected()).isTrue(); + + setEnvVariable("CI", "true"); + setEnvVariable("SEMAPHORE", "true"); + setEnvVariable("CIRCLECI", null); + assertThat(underTest.isDetected()).isFalse(); + + setEnvVariable("CI", "false"); + setEnvVariable("CIRCLECI", "true"); + assertThat(underTest.isDetected()).isFalse(); + } + + @Test + public void loadConfiguration() { + setEnvVariable("CI", "true"); + setEnvVariable("CIRCLECI", "true"); + setEnvVariable("CIRCLE_SHA1", "abd12fc"); + + assertThat(underTest.loadConfiguration().getScmRevision()).hasValue("abd12fc"); + } + + private void setEnvVariable(String key, @Nullable String value) { + when(system.envVariable(key)).thenReturn(value); + } +} -- 2.39.5