Allow job.correlator to be explicitly specified

Previously the plugin was inferring the values of job.id and job.correlator
from core GITHUB environment variables. While this may be useful in some cases,
there are many cases where it is insufficient.

With this change, the user of this plugin will directly provide these values
via custom environment variables.

The job.correlator value provided is now included in the generated file name.

Author: bigdaz

.github/workflows/gradle.yml

@@ -69,14 +69,16 @@ jobs:
             uses: gradle/gradle-build-action@v2
 
           - name: Self Test :plugin
-            run: ./plugin-self-test
+            run: ./plugin-self-test GitHubDependencyGraphPlugin_generateDependencyGraph
             env:
                 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+                GITHUB_DEPENDENCY_GRAPH_JOB_ID: ${{ github.run_id }}
+                GITHUB_DEPENDENCY_GRAPH_JOB_CORRELATOR: "plugin-self-test"
 
           - name: Save plugin JSON report
             uses: actions/upload-artifact@v3
             with:
                 name: plugin-json
-                path: build/reports/github-dependency-graph-plugin/github-dependency-snapshot.json
+                path: build/reports/github-dependency-graph-snapshots/plugin-self-test.json
                 if-no-files-found: error
 

plugin-self-test

@@ -16,5 +16,5 @@ else
     -H "Authorization: Bearer $GITHUB_TOKEN"\
     -H "X-GitHub-Api-Version: 2022-11-28" \
     https://api.github.com/repos/gradle/github-dependency-graph-gradle-plugin/dependency-graph/snapshots \
-    -d @build/reports/github-dependency-graph-plugin/github-dependency-snapshot.json
+    -d @build/reports/github-dependency-graph-snapshots/plugin-self-test.json
 fi

plugin-self-test-local

@@ -1,7 +1,7 @@
 #!/bin/sh
 
-export GITHUB_JOB="Build"
-export GITHUB_RUN_NUMBER="42"
+export GITHUB_DEPENDENCY_GRAPH_JOB_ID="42"
+export GITHUB_DEPENDENCY_GRAPH_JOB_CORRELATOR="plugin-self-test"
 export GITHUB_REF="refs/heads/main"
 export GITHUB_SHA=$( git rev-parse HEAD )
 export GITHUB_WORKSPACE=$( pwd )

plugin-test/src/test/groovy/org/gradle/github/dependencygraph/BaseExtractorTest.groovy

@@ -50,7 +50,7 @@ abstract class BaseExtractorTest extends Specification {
     SimpleGradleExecuter createExecuter() {
         // Create a new JsonManifestLoader for each invocation of the executer
         File manifestFile =
-            testDirectory.file("build/reports/github-dependency-graph-plugin/github-dependency-snapshot.json")
+            testDirectory.file("build/reports/github-dependency-graph-plugin/github-dependency-snapshot-Build.json")
         loader = new JsonRepositorySnapshotLoader(manifestFile)
         return createExecuter(testGradleVersion)
     }
@@ -134,8 +134,8 @@ abstract class BaseExtractorTest extends Specification {
         assert json.sha == environmentVars.sha
         assert json.ref == environmentVars.ref
         def job = json.job as Map
-        assert job.correlator == environmentVars.job
-        assert job.id == environmentVars.runNumber
+        assert job.correlator == environmentVars.jobCorrelator
+        assert job.id == environmentVars.jobId
         def detector = json.detector as Map
         assert detector.name.contains("Gradle")
         assert detector.version != null
@@ -255,8 +255,8 @@ abstract class BaseExtractorTest extends Specification {
     }
 
     static class TestEnvironmentVars {
-        final String job = "Build_" + System.currentTimeMillis()
-        final String runNumber = UUID.randomUUID().toString()
+        final String jobId = UUID.randomUUID().toString()
+        final String jobCorrelator = "Build"
         final String ref = "refs/head/feature/test" + UUID.randomUUID().toString()
         final String sha = fakeSha()
         final String workspace
@@ -268,12 +268,12 @@ abstract class BaseExtractorTest extends Specification {
 
         Map<String, String> asEnvironmentMap() {
             return [
-                "GITHUB_JOB"       : job,
-                "GITHUB_RUN_NUMBER": runNumber,
-                "GITHUB_REF"       : ref,
-                "GITHUB_SHA"       : sha,
-                "GITHUB_WORKSPACE" : workspace,
-                "GITHUB_TOKEN"     : gitHubToken
+                "GITHUB_DEPENDENCY_GRAPH_JOB_ID"        : jobId,
+                "GITHUB_DEPENDENCY_GRAPH_JOB_CORRELATOR": jobCorrelator,
+                "GITHUB_REF"                            : ref,
+                "GITHUB_SHA"                            : sha,
+                "GITHUB_WORKSPACE"                      : workspace,
+                "GITHUB_TOKEN"                          : gitHubToken
             ]
         }
 

plugin-test/src/test/groovy/org/gradle/github/dependencygraph/SingleProjectDependencyExtractorTest.groovy

@@ -32,17 +32,6 @@ class SingleProjectDependencyExtractorTest extends BaseExtractorTest {
         """
     }
 
-    def "includes build path in job correlator"() {
-        when:
-        executer.withArgument("-Dorg.gradle.github.env.GRADLE_BUILD_PATH=foo/bar")
-        run()
-
-        then:
-        def json = jsonRepositorySnapshot()
-        def job = json.job as Map
-        job.correlator == environmentVars.job + ":foo/bar"
-    }
-
     def "extracts implementation and test dependencies for a java project"() {
         given:
         buildFile << """

plugin/src/main/kotlin/org/gradle/github/dependencygraph/GitHubDependencyExtractorPlugin.kt

@@ -22,14 +22,14 @@ import java.nio.file.Paths
  */
 class GitHubDependencyExtractorPlugin : Plugin<Gradle> {
     private companion object : PluginCompanionUtils() {
-        const val ENV_GITHUB_JOB = "GITHUB_JOB"
-        const val ENV_GITHUB_RUN_NUMBER = "GITHUB_RUN_NUMBER"
+        const val ENV_DEPENDENCY_GRAPH_JOB_ID = "GITHUB_DEPENDENCY_GRAPH_JOB_ID"
+        const val ENV_DEPENDENCY_GRAPH_JOB_CORRELATOR = "GITHUB_DEPENDENCY_GRAPH_JOB_CORRELATOR"
         const val ENV_GITHUB_REF = "GITHUB_REF"
         const val ENV_GITHUB_SHA = "GITHUB_SHA"
-        const val ENV_GRADLE_BUILD_PATH = "GRADLE_BUILD_PATH"
 
         /**
          * Environment variable should be set to the workspace directory that the Git repository is checked out in.
+         * This is used to determine relative path to build files referenced in the dependency graph.
          */
         const val ENV_GITHUB_WORKSPACE = "GITHUB_WORKSPACE"
     }
@@ -92,18 +92,16 @@ class GitHubDependencyExtractorPlugin : Plugin<Gradle> {
                 // Create a constant value that the provider will always return.
                 // IE. Memoize the value
                 val constantDependencyExtractor = object : DependencyExtractor() {
-                    override val gitHubJobName: String
-                        get() = gradle.loadEnvironmentVariable(ENV_GITHUB_JOB)
-                    override val gitHubRunNumber: String
-                        get() = gradle.loadEnvironmentVariable(ENV_GITHUB_RUN_NUMBER)
+                    override val dependencyGraphJobCorrelator: String
+                        get() = gradle.loadEnvironmentVariable(ENV_DEPENDENCY_GRAPH_JOB_CORRELATOR)
+                    override val dependencyGraphJobId: String
+                        get() = gradle.loadEnvironmentVariable(ENV_DEPENDENCY_GRAPH_JOB_ID)
                     override val gitSha: String
                         get() = gradle.loadEnvironmentVariable(ENV_GITHUB_SHA)
                     override val gitRef: String
                         get() = gradle.loadEnvironmentVariable(ENV_GITHUB_REF)
                     override val gitWorkspaceDirectory: Path
                         get() = gitWorkspaceDirectory
-                    override val gradleBuildPath: String
-                        get() = gradle.loadEnvironmentVariable(ENV_GRADLE_BUILD_PATH, "")
                 }
                 return providerFactory.provider { constantDependencyExtractor }
             }
@@ -154,12 +152,11 @@ class GitHubDependencyExtractorPlugin : Plugin<Gradle> {
                     DependencyExtractorBuildService::class.java
                 ) { spec ->
                     spec.parameters {
-                        it.gitHubJobName.convention(gradle.loadEnvironmentVariable(ENV_GITHUB_JOB))
-                        it.gitHubRunNumber.convention(gradle.loadEnvironmentVariable(ENV_GITHUB_RUN_NUMBER))
+                        it.dependencyGraphJobCorrelator.convention(gradle.loadEnvironmentVariable(ENV_DEPENDENCY_GRAPH_JOB_CORRELATOR))
+                        it.dependencyGraphJobId.convention(gradle.loadEnvironmentVariable(ENV_DEPENDENCY_GRAPH_JOB_ID))
                         it.gitSha.convention(gradle.loadEnvironmentVariable(ENV_GITHUB_SHA))
                         it.gitRef.convention(gradle.loadEnvironmentVariable(ENV_GITHUB_REF))
                         it.gitWorkspaceDirectory.convention(gitWorkspaceDirectory)
-                        it.gradleBuildPath.convention(gradle.loadEnvironmentVariable(ENV_GRADLE_BUILD_PATH, ""))
                     }
                 }
             }

plugin/src/main/kotlin/org/gradle/github/dependencygraph/internal/DependencyExtractor.kt

@@ -6,7 +6,6 @@ import org.gradle.api.artifacts.result.ResolvedDependencyResult
 import org.gradle.api.internal.artifacts.DefaultProjectComponentIdentifier
 import org.gradle.api.internal.artifacts.configurations.ResolveConfigurationDependenciesBuildOperationType
 import org.gradle.github.GitHubDependencyGraphPlugin
-import org.gradle.github.dependencygraph.GitHubDependencyExtractorPlugin
 import org.gradle.github.dependencygraph.internal.model.ComponentCoordinates
 import org.gradle.github.dependencygraph.internal.model.ResolvedComponent
 import org.gradle.github.dependencygraph.internal.model.ResolvedConfiguration
@@ -23,12 +22,11 @@ abstract class DependencyExtractor :
     BuildOperationListener,
     AutoCloseable {
 
-    protected abstract val gitHubJobName: String
-    protected abstract val gitHubRunNumber: String
+    protected abstract val dependencyGraphJobCorrelator: String
+    protected abstract val dependencyGraphJobId: String
     protected abstract val gitSha: String
     protected abstract val gitRef: String
     protected abstract val gitWorkspaceDirectory: Path
-    protected abstract val gradleBuildPath: String
 
     /**
      * Can't use this as a proper input:
@@ -38,12 +36,11 @@ abstract class DependencyExtractor :
 
     private val gitHubRepositorySnapshotBuilder by lazy {
         GitHubRepositorySnapshotBuilder(
-            gitHubJobName = gitHubJobName,
-            gitHubRunNumber = gitHubRunNumber,
+            dependencyGraphJobCorrelator = dependencyGraphJobCorrelator,
+            dependencyGraphJobId = dependencyGraphJobId,
             gitSha = gitSha,
             gitRef = gitRef,
-            gitWorkspaceDirectory = gitWorkspaceDirectory,
-            gradleBuildPath = gradleBuildPath
+            gitWorkspaceDirectory = gitWorkspaceDirectory
         )
     }
 
@@ -54,7 +51,7 @@ abstract class DependencyExtractor :
     }
 
     internal fun setRootProjectBuildDirectory(rootProjectBuildDirectory: File) {
-        fileWriter = DependencyFileWriter.create(rootProjectBuildDirectory)
+        fileWriter = DependencyFileWriter.create(rootProjectBuildDirectory, dependencyGraphJobCorrelator)
     }
 
     override fun started(buildOperation: BuildOperationDescriptor, startEvent: OperationStartEvent) {

plugin/src/main/kotlin/org/gradle/github/dependencygraph/internal/DependencyExtractorBuildService.kt

@@ -11,24 +11,21 @@ abstract class DependencyExtractorBuildService :
     BuildService<DependencyExtractorBuildService.Parameters> {
 
     interface Parameters : BuildServiceParameters {
-        val gitHubJobName: Property<String>
-        val gitHubRunNumber: Property<String>
+        val dependencyGraphJobId: Property<String>
+        val dependencyGraphJobCorrelator: Property<String>
         val gitSha: Property<String>
         val gitRef: Property<String>
         val gitWorkspaceDirectory: DirectoryProperty
-        val gradleBuildPath: Property<String>
     }
 
-    override val gitHubJobName: String
-        get() = parameters.gitHubJobName.get()
-    override val gitHubRunNumber: String
-        get() = parameters.gitHubRunNumber.get()
+    override val dependencyGraphJobId: String
+        get() = parameters.dependencyGraphJobId.get()
+    override val dependencyGraphJobCorrelator: String
+        get() = parameters.dependencyGraphJobCorrelator.get()
     override val gitSha: String
         get() = parameters.gitSha.get()
     override val gitRef: String
         get() = parameters.gitRef.get()
     override val gitWorkspaceDirectory: Path
         get() = parameters.gitWorkspaceDirectory.get().asFile.toPath()
-    override val gradleBuildPath: String
-        get() = parameters.gradleBuildPath.get()
 }

plugin/src/main/kotlin/org/gradle/github/dependencygraph/internal/DependencyFileWriter.kt

@@ -27,24 +27,24 @@ private constructor(
     companion object {
         private val LOGGER = Logging.getLogger(DependencyFileWriter::class.java)
 
-        fun create(buildDirectory: File): DependencyFileWriter =
-            create(buildDirectory) {
+        fun create(buildDirectory: File, jobCorrelator:String): DependencyFileWriter =
+            create(buildDirectory, jobCorrelator) {
                 // No-op
             }
 
         fun create(): DependencyFileWriter =
-            create(File(".")) {
+            create(File("."), "UNKNOWN") {
                 LOGGER.warn(
                     "[WARNING] Something went wrong configuring the GithubDependencyExtractorPlugin. " +
                         "Using JVM working directory as root of build"
                 )
             }
 
-        private fun create(buildDirectory: File, loggerWarning: () -> Unit): DependencyFileWriter {
+        private fun create(buildDirectory: File, jobCorrelator: String, loggerWarning: () -> Unit): DependencyFileWriter {
             return DependencyFileWriter(
                 File(
                     buildDirectory,
-                    "reports/github-dependency-graph-plugin/github-dependency-snapshot.json"
+                    "reports/github-dependency-graph-plugin/github-dependency-snapshot-${jobCorrelator}.json"
                 ),
                 loggerWarning
             )

plugin/src/main/kotlin/org/gradle/github/dependencygraph/internal/GitHubRepositorySnapshotBuilder.kt

@@ -9,20 +9,19 @@ import java.nio.file.Paths
 import java.util.concurrent.ConcurrentHashMap
 
 class GitHubRepositorySnapshotBuilder(
-    private val gitHubJobName: String,
-    private val gitHubRunNumber: String,
+    private val dependencyGraphJobCorrelator: String,
+    private val dependencyGraphJobId: String,
     private val gitSha: String,
     private val gitRef: String,
-    private val gitWorkspaceDirectory: Path,
-    private val gradleBuildPath: String
+    private val gitWorkspaceDirectory: Path
 ) {
 
     private val detector by lazy { GitHubDetector() }
 
     private val job by lazy {
         GitHubJob(
-            id = gitHubRunNumber,
-            correlator = if (gradleBuildPath.isEmpty()) gitHubJobName else "$gitHubJobName:$gradleBuildPath"
+            id = dependencyGraphJobId,
+            correlator = dependencyGraphJobCorrelator
         )
     }