Handle failure writing build-results file

Fixes #866
gradle · Dec 23, 2023 · 783c602 · 783c602
1 parent b324739
commit 783c602
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 17 deletions.
diff --git a/src/resources/init-scripts/gradle-build-action.build-result-capture-service.plugin.groovy b/src/resources/init-scripts/gradle-build-action.build-result-capture-service.plugin.groovy
@@ -50,12 +50,16 @@ abstract class BuildResultsRecorder implements BuildService<BuildResultsRecorder
         if (!runnerTempDir || !githubActionStep) {
             return
         }
-
-        def buildResultsDir = new File(runnerTempDir, ".build-results")
-        buildResultsDir.mkdirs()
-        def buildResultsFile = new File(buildResultsDir, githubActionStep + getParameters().getInvocationId().get() + ".json")
-        if (!buildResultsFile.exists()) {
-            buildResultsFile << groovy.json.JsonOutput.toJson(buildResults)
+
+        try {
+            def buildResultsDir = new File(runnerTempDir, ".build-results")
+            buildResultsDir.mkdirs()
+            def buildResultsFile = new File(buildResultsDir, githubActionStep + getParameters().getInvocationId().get() + ".json")
+            if (!buildResultsFile.exists()) {
+                buildResultsFile << groovy.json.JsonOutput.toJson(buildResults)
+            }
+        } catch (Exception e) {
+            println "\ngradle-build-action failed to write build-results file. Will continue.\n> ${e.getLocalizedMessage()}"
         }
     }
 }
diff --git a/src/resources/init-scripts/gradle-build-action.build-result-capture.init.gradle b/src/resources/init-scripts/gradle-build-action.build-result-capture.init.gradle
@@ -121,18 +121,23 @@ class BuildResults {
         if (!runnerTempDir || !githubActionStep) {
             return
         }
-
-        def buildResultsDir = new File(runnerTempDir, ".build-results")
-        buildResultsDir.mkdirs()
-        def buildResultsFile = new File(buildResultsDir, githubActionStep + invocationId + ".json")
-
-        // Overwrite any contents written by buildFinished or build service, since this result is a superset.
-        if (buildResultsFile.exists()) {
-            if (overwrite) {
-                buildResultsFile.text = groovy.json.JsonOutput.toJson(buildResults)
+
+        try {
+            def buildResultsDir = new File(runnerTempDir, ".build-results")
+            buildResultsDir.mkdirs()
+            def buildResultsFile = new File(buildResultsDir, githubActionStep + invocationId + ".json")
+
+            // Overwrite any contents written by buildFinished or build service, since this result is a superset.
+            if (buildResultsFile.exists()) {
+                if (overwrite) {
+                    buildResultsFile.text = groovy.json.JsonOutput.toJson(buildResults)
+                }
+            } else {
+                buildResultsFile << groovy.json.JsonOutput.toJson(buildResults)
             }
-        } else {
-            buildResultsFile << groovy.json.JsonOutput.toJson(buildResults)
+
+        } catch (Exception e) {
+            println "\ngradle-build-action failed to write build-results file. Will continue.\n> ${e.getLocalizedMessage()}"
         }
     }
 }
diff --git a/.../init-scripts/src/test/groovy/com/gradle/gradlebuildaction/TestBuildResultRecorder.groovy b/.../init-scripts/src/test/groovy/com/gradle/gradlebuildaction/TestBuildResultRecorder.groovy
@@ -148,6 +148,23 @@ class TestBuildResultRecorder extends BaseInitScriptTest {
         testGradleVersion << ALL_VERSIONS
     }
 
+    def "produces no build results file when RUNNER_TEMP dir is not a writable directory with #testGradleVersion"() {
+        assumeTrue testGradleVersion.compatibleWithCurrentJvm
+
+        when:
+        def invalidDir = new File(testProjectDir, 'invalid-runner-temp')
+        invalidDir.createNewFile()
+
+        run(['help'], initScript, testGradleVersion.gradleVersion, [], [RUNNER_TEMP: invalidDir.absolutePath])
+
+        then:
+        def buildResultsDir = new File(testProjectDir, '.build-results')
+        assert !buildResultsDir.exists()
+
+        where:
+        testGradleVersion << ALL_VERSIONS
+    }
+
     def "produces build results file with build scan when GE plugin is applied in settingsEvaluated"() {
         assumeTrue testGradleVersion.compatibleWithCurrentJvm