From 652b08142c0eac67726921b378d6795c7e91fb51 Mon Sep 17 00:00:00 2001 From: Simon Brandhof Date: Sun, 12 May 2019 19:06:34 +0200 Subject: [PATCH] SONAR-11950 autoconfig of SCM revision on Travis CI --- .../sonar/scanner/ci/vendors/TravisCi.java | 63 +++++++++++++++ .../scanner/scan/ProjectScanContainer.java | 2 + .../scanner/ci/vendors/TravisCiTest.java | 78 +++++++++++++++++++ 3 files changed, 143 insertions(+) create mode 100644 sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/TravisCi.java create mode 100644 sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/TravisCiTest.java diff --git a/sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/TravisCi.java b/sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/TravisCi.java new file mode 100644 index 00000000000..3b08acb414a --- /dev/null +++ b/sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/TravisCi.java @@ -0,0 +1,63 @@ +/* + * 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; + +import static org.apache.commons.lang.StringUtils.isBlank; + +/** + * Support of https://travis-ci.com + * + * Environment variables: https://docs.travis-ci.com/user/environment-variables/ + */ +public class TravisCi implements CiVendor { + private final System2 system; + + public TravisCi(System2 system) { + this.system = system; + } + + @Override + public String getName() { + return "TravisCI"; + } + + @Override + public boolean isDetected() { + return "true".equals(system.envVariable("CI")) && "true".equals(system.envVariable("TRAVIS")); + } + + @Override + public CiConfiguration loadConfiguration() { + String pr = system.envVariable("TRAVIS_PULL_REQUEST"); + String revision; + if (isBlank(pr) || "false".equals(pr)) { + revision = system.envVariable("TRAVIS_COMMIT"); + } else { + revision = system.envVariable("TRAVIS_PULL_REQUEST_SHA"); + + } + 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 004a976d56b..0bfdd5ca386 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 @@ -57,6 +57,7 @@ import org.sonar.scanner.ci.vendors.GithubActions; import org.sonar.scanner.ci.vendors.GitlabCi; import org.sonar.scanner.ci.vendors.Jenkins; import org.sonar.scanner.ci.vendors.SemaphoreCi; +import org.sonar.scanner.ci.vendors.TravisCi; import org.sonar.scanner.cpd.CpdExecutor; import org.sonar.scanner.cpd.CpdSettings; import org.sonar.scanner.cpd.index.SonarCpdBlockIndex; @@ -285,6 +286,7 @@ public class ProjectScanContainer extends ComponentContainer { GitlabCi.class, Jenkins.class, SemaphoreCi.class, + TravisCi.class, AnalysisObservers.class); diff --git a/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/TravisCiTest.java b/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/TravisCiTest.java new file mode 100644 index 00000000000..a18cc762ca9 --- /dev/null +++ b/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/TravisCiTest.java @@ -0,0 +1,78 @@ +/* + * 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 TravisCiTest { + + private System2 system = mock(System2.class); + private CiVendor underTest = new TravisCi(system); + + @Test + public void getName() { + assertThat(underTest.getName()).isEqualTo("TravisCI"); + } + + @Test + public void isDetected() { + setEnvVariable("CI", "true"); + setEnvVariable("TRAVIS", "true"); + assertThat(underTest.isDetected()).isTrue(); + + setEnvVariable("CI", "true"); + setEnvVariable("DRONE", "true"); + setEnvVariable("TRAVIS", null); + assertThat(underTest.isDetected()).isFalse(); + } + + @Test + public void loadConfiguration_of_branch() { + setEnvVariable("CI", "true"); + setEnvVariable("TRAVIS", "true"); + setEnvVariable("TRAVIS_COMMIT", "abd12fc"); + setEnvVariable("TRAVIS_PULL_REQUEST", "false"); + setEnvVariable("TRAVIS_PULL_REQUEST_SHA", ""); + + assertThat(underTest.loadConfiguration().getScmRevision()).hasValue("abd12fc"); + } + + @Test + public void loadConfiguration_of_pull_request() { + setEnvVariable("CI", "true"); + setEnvVariable("TRAVIS", "true"); + setEnvVariable("TRAVIS_COMMIT", "abd12fc"); + setEnvVariable("TRAVIS_PULL_REQUEST", "1234"); + setEnvVariable("TRAVIS_PULL_REQUEST_SHA", "987fbd3"); + + assertThat(underTest.loadConfiguration().getScmRevision()).hasValue("987fbd3"); + } + + private void setEnvVariable(String key, @Nullable String value) { + when(system.envVariable(key)).thenReturn(value); + } +} -- 2.39.5