From babdff561b86cbca86e64a8511eee5f3331998aa Mon Sep 17 00:00:00 2001 From: Simon Brandhof Date: Sun, 12 May 2019 17:43:21 +0200 Subject: [PATCH] SONAR-11950 autoconfig of SCM revision on Gitlab CI --- .../sonar/scanner/ci/vendors/GitlabCi.java | 52 ++++++++++++++++ .../scanner/scan/ProjectScanContainer.java | 2 + .../scanner/ci/vendors/GitlabCiTest.java | 61 +++++++++++++++++++ 3 files changed, 115 insertions(+) create mode 100644 sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/GitlabCi.java create mode 100644 sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/GitlabCiTest.java diff --git a/sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/GitlabCi.java b/sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/GitlabCi.java new file mode 100644 index 00000000000..330e2409455 --- /dev/null +++ b/sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/GitlabCi.java @@ -0,0 +1,52 @@ +/* + * 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; + +/** + * https://docs.gitlab.com/ee/ci/variables/ + */ +public class GitlabCi implements CiVendor { + private final System2 system; + + public GitlabCi(System2 system) { + this.system = system; + } + + @Override + public String getName() { + return "Gitlab CI"; + } + + @Override + public boolean isDetected() { + return "true".equalsIgnoreCase(system.envVariable("GITLAB_CI")); + } + + @Override + public CiConfiguration loadConfiguration() { + String revision = system.envVariable("CI_COMMIT_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 1a8807f142d..004a976d56b 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 @@ -54,6 +54,7 @@ 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.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.cpd.CpdExecutor; @@ -281,6 +282,7 @@ public class ProjectScanContainer extends ComponentContainer { CirrusCi.class, DroneCi.class, GithubActions.class, + GitlabCi.class, Jenkins.class, SemaphoreCi.class, diff --git a/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/GitlabCiTest.java b/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/GitlabCiTest.java new file mode 100644 index 00000000000..c9e366abb58 --- /dev/null +++ b/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/GitlabCiTest.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 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 GitlabCiTest { + + private System2 system = mock(System2.class); + private CiVendor underTest = new GitlabCi(system); + + @Test + public void getName() { + assertThat(underTest.getName()).isEqualTo("Gitlab CI"); + } + + @Test + public void isDetected() { + setEnvVariable("GITLAB_CI", "true"); + assertThat(underTest.isDetected()).isTrue(); + + setEnvVariable("GITLAB_CI", null); + assertThat(underTest.isDetected()).isFalse(); + } + + @Test + public void loadConfiguration() { + setEnvVariable("GITLAB_CI", "true"); + setEnvVariable("CI_COMMIT_SHA", "abd12fc"); + + assertThat(underTest.loadConfiguration().getScmRevision()).hasValue("abd12fc"); + } + + private void setEnvVariable(String key, @Nullable String value) { + when(system.envVariable(key)).thenReturn(value); + } +} -- 2.39.5