SONAR-15412 detection of branches and PRs when using CodeMagic CI

3 files changed, 146 insertions, 0 deletions

diff --git a/sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/CodeMagic.java b/sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/CodeMagic.java
new file mode 100644
index 00000000000..d2f3fdaf5de
--- /dev/null
+++ b/sonar-scanner-engine/src/main/java/org/sonar/scanner/ci/vendors/CodeMagic.java
@@ -0,0 +1,59 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2021 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.api.utils.log.Logger;
+import org.sonar.api.utils.log.Loggers;
+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.isEmpty;
+
+public class CodeMagic implements CiVendor {
+
+  private static final Logger LOG = Loggers.get(CodeMagic.class);
+
+  private final System2 system;
+
+  public CodeMagic(System2 system) {
+    this.system = system;
+  }
+
+  @Override
+  public String getName() {
+    return "CodeMagic";
+  }
+
+  @Override
+  public boolean isDetected() {
+    return !isEmpty(system.envVariable("FCI_BUILD_ID"));
+  }
+
+  @Override
+  public CiConfiguration loadConfiguration() {
+    String revision = system.envVariable("FCI_COMMIT");
+    if (isEmpty(revision)) {
+      LOG.warn("Missing environment variable FCI_COMMIT");
+    }
+    return new CiConfigurationImpl(revision, getName());
+  }
+}
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 e6bf8582814..d77df0452ee 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
@@ -52,6 +52,7 @@ import org.sonar.scanner.ci.vendors.Bitrise;
 import org.sonar.scanner.ci.vendors.Buildkite;
 import org.sonar.scanner.ci.vendors.CircleCi;
 import org.sonar.scanner.ci.vendors.CirrusCi;
+import org.sonar.scanner.ci.vendors.CodeMagic;
 import org.sonar.scanner.ci.vendors.DroneCi;
 import org.sonar.scanner.ci.vendors.GithubActions;
 import org.sonar.scanner.ci.vendors.GitlabCi;
@@ -286,6 +287,7 @@ public class ProjectScanContainer extends ComponentContainer {
       CirrusCi.class,
       DroneCi.class,
       GithubActions.class,
+      CodeMagic.class,
       GitlabCi.class,
       Jenkins.class,
       SemaphoreCi.class,
diff --git a/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/CodeMagicTest.java b/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/CodeMagicTest.java
new file mode 100644
index 00000000000..8836b83a011
--- /dev/null
+++ b/sonar-scanner-engine/src/test/java/org/sonar/scanner/ci/vendors/CodeMagicTest.java
@@ -0,0 +1,85 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2021 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 java.util.List;
+import javax.annotation.Nullable;
+import org.junit.Rule;
+import org.junit.Test;
+import org.sonar.api.utils.System2;
+import org.sonar.api.utils.log.LogTester;
+import org.sonar.api.utils.log.LoggerLevel;
+import org.sonar.scanner.ci.CiConfiguration;
+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 CodeMagicTest {
+
+  private final System2 system = mock(System2.class);
+  private final CiVendor underTest = new CodeMagic(system);
+
+  @Rule
+  public LogTester logTester = new LogTester();
+
+  @Test
+  public void getName() {
+    assertThat(underTest.getName()).isEqualTo("CodeMagic");
+  }
+
+  @Test
+  public void isDetected_givenBuildID_detectCodeMagic() {
+    setEnvVariable("FCI_BUILD_ID", "1");
+
+    assertThat(underTest.isDetected()).isTrue();
+  }
+
+  @Test
+  public void isDetected_givenNoEnvVariable_dontDetectCodeMagic() {
+    assertThat(underTest.isDetected()).isFalse();
+  }
+
+  @Test
+  public void loadConfiguration_commitEnvVariableAvailable_addScmRevisionToConfig() {
+    setEnvVariable("FCI_BUILD_ID", "1");
+    setEnvVariable("FCI_COMMIT", "d9d25f70ec9023f7acc0c520c8b67204229a5c7e");
+
+    assertThat(underTest.loadConfiguration().getScmRevision()).hasValue("d9d25f70ec9023f7acc0c520c8b67204229a5c7e");
+  }
+
+  @Test
+  public void loadConfiguration_commitEnvVariableNotAvailable_addScmRevisionToConfig() {
+    setEnvVariable("FCI_BUILD_ID", "1");
+
+    CiConfiguration ciConfiguration = underTest.loadConfiguration();
+    List<String> logs = logTester.logs(LoggerLevel.WARN);
+
+    assertThat(ciConfiguration.getScmRevision()).isEmpty();
+    assertThat(logs).hasSize(1);
+    assertThat(logs.get(0)).isEqualTo("Missing environment variable FCI_COMMIT");
+  }
+
+
+  private void setEnvVariable(String key, @Nullable String value) {
+    when(system.envVariable(key)).thenReturn(value);
+  }
+}