From: Simon Brandhof Date: Sun, 12 May 2019 14:43:34 +0000 (+0200) Subject: SONAR-11950 autoconfig of SCM revision on Jenkins X-Git-Tag: 7.8~176 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=9e3f550607e46f6d8e5f63adb593957853f3d7b5;p=sonarqube.git SONAR-11950 autoconfig of SCM revision on Jenkins --- diff --git a/sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/Jenkins.java b/sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/Jenkins.java new file mode 100644 index 00000000000..0471195a91a --- /dev/null +++ b/sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/Jenkins.java @@ -0,0 +1,61 @@ +/* + * 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.apache.commons.lang.StringUtils; +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.isNotBlank; + +public class Jenkins implements CiVendor { + private final System2 system; + + public Jenkins(System2 system) { + this.system = system; + } + + @Override + public String getName() { + return "Jenkins"; + } + + @Override + public boolean isDetected() { + // https://wiki.jenkins-ci.org/display/JENKINS/Building+a+software+project + return isNotBlank(system.envVariable("JENKINS_URL")); + } + + @Override + public CiConfiguration loadConfiguration() { + // https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin#GitHubpullrequestbuilderplugin-EnvironmentVariables + // https://wiki.jenkins-ci.org/display/JENKINS/Building+a+software+project + String revision = system.envVariable("ghprbActualCommit"); + if (StringUtils.isBlank(revision)) { + revision = system.envVariable("GIT_COMMIT"); + if (StringUtils.isBlank(revision)) { + revision = system.envVariable("SVN_COMMIT"); + } + } + 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 02532a425a6..5d32cbe6a10 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 @@ -50,6 +50,7 @@ import org.sonar.scanner.ci.CiConfigurationProvider; import org.sonar.scanner.ci.vendors.BitbucketPipelines; import org.sonar.scanner.ci.vendors.CirrusCi; import org.sonar.scanner.ci.vendors.DroneCi; +import org.sonar.scanner.ci.vendors.Jenkins; import org.sonar.scanner.ci.vendors.SemaphoreCi; import org.sonar.scanner.cpd.CpdExecutor; import org.sonar.scanner.cpd.CpdSettings; @@ -272,6 +273,7 @@ public class ProjectScanContainer extends ComponentContainer { BitbucketPipelines.class, CirrusCi.class, DroneCi.class, + Jenkins.class, SemaphoreCi.class, AnalysisObservers.class); diff --git a/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/JenkinsTest.java b/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/JenkinsTest.java new file mode 100644 index 00000000000..cc01ceeefbb --- /dev/null +++ b/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/JenkinsTest.java @@ -0,0 +1,77 @@ +/* + * 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 JenkinsTest { + private System2 system = mock(System2.class); + private CiVendor underTest = new Jenkins(system); + + @Test + public void getName() { + assertThat(underTest.getName()).isEqualTo("Jenkins"); + } + + @Test + public void isDetected() { + setEnvVariable("JENKINS_URL", "http://foo"); + assertThat(underTest.isDetected()).isTrue(); + + setEnvVariable("JENKINS_URL", null); + assertThat(underTest.isDetected()).isFalse(); + } + + @Test + public void loadConfiguration_with_deprecated_pull_request_plugin() { + setEnvVariable("CI", "true"); + setEnvVariable("ghprbActualCommit", "abd12fc"); + + assertThat(underTest.loadConfiguration().getScmRevision()).hasValue("abd12fc"); + } + + @Test + public void loadConfiguration_of_git_repo() { + setEnvVariable("CI", "true"); + setEnvVariable("GIT_COMMIT", "abd12fc"); + + assertThat(underTest.loadConfiguration().getScmRevision()).hasValue("abd12fc"); + } + + @Test + public void loadConfiguration_of_svn_repo() { + setEnvVariable("CI", "true"); + setEnvVariable("SVN_COMMIT", "abd12fc"); + + assertThat(underTest.loadConfiguration().getScmRevision()).hasValue("abd12fc"); + } + + private void setEnvVariable(String key, @Nullable String value) { + when(system.envVariable(key)).thenReturn(value); + } + +}