Merge pull request #31 from shakuzen

* gh-31: Support build scan link for CircleCI Closes gh-31
spring-io · Jul 21, 2021 · c0f9c74 · c0f9c74
2 parents 8ee255e + 460d849
commit c0f9c74
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/src/main/java/io/spring/ge/conventions/gradle/BuildScanConventions.java b/src/main/java/io/spring/ge/conventions/gradle/BuildScanConventions.java
@@ -36,6 +36,8 @@ class BuildScanConventions implements Action<BuildScanExtension> {
 
 	private static final String BAMBOO_RESULTS_ENV_VAR = "bamboo_resultsUrl";
 
+	private static final String CIRCLECI_BUILD_URL_ENV_VAR = "CIRCLE_BUILD_URL";
+
 	private final Map<String, String> env;
 
 	private final ProcessRunner processRunner;
@@ -98,7 +100,7 @@ private void tagCiOrLocal(BuildScanExtension buildScan) {
 	}
 
 	private boolean isCi() {
-		if (isBamboo() || isConcourse() || isJenkins()) {
+		if (isBamboo() || isCircleCi() || isConcourse() || isJenkins()) {
 			return true;
 		}
 		return false;
@@ -108,6 +110,10 @@ private boolean isBamboo() {
 		return this.env.containsKey(BAMBOO_RESULTS_ENV_VAR);
 	}
 
+	private boolean isCircleCi() {
+		return this.env.containsKey(CIRCLECI_BUILD_URL_ENV_VAR);
+	}
+
 	private boolean isConcourse() {
 		return this.env.containsKey("CI");
 	}
@@ -157,6 +163,9 @@ else if (isJenkins()) {
 				buildScan.link("CI build", buildUrl);
 			}
 		}
+		else if (isCircleCi()) {
+			buildScan.link("CI build", this.env.get(CIRCLECI_BUILD_URL_ENV_VAR));
+		}
 	}
 
 	private RunResult getBranch() {

diff --git a/src/test/java/io/spring/ge/conventions/gradle/BuildScanConventionsTests.java b/src/test/java/io/spring/ge/conventions/gradle/BuildScanConventionsTests.java
@@ -81,6 +81,14 @@ void whenBambooResultEnvVarIsPresentThenBuildScanHasACiBuildLinkToIt() {
 		assertThat(this.buildScan.links).containsEntry("CI build", "https://bamboo.example.com");
 	}
 
+	@Test
+	void whenCircleBuildUrlEnvVarIsPresentThenBuildScanHasACiBuildLinkToIt() {
+		new BuildScanConventions(this.processRunner,
+				Collections.singletonMap("CIRCLE_BUILD_URL", "https://circleci.example.com/gh/org/project/123"))
+						.execute(this.buildScan);
+		assertThat(this.buildScan.links).containsEntry("CI build", "https://circleci.example.com/gh/org/project/123");
+	}
+
 	@Test
 	void whenJenkinsUrlAndBuildUrlEnvVarsArePresentThenBuildScanHasACiBuildLinkToBuildUrl() {
 		Map<String, String> env = new HashMap<>();