Allow report directory to be specified by env var

Author: bigdaz

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

@@ -49,8 +49,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-Build.json")
+        File manifestFile = reportDir.file("dummy-job-correlator.json")
         loader = new JsonRepositorySnapshotLoader(manifestFile)
         return createExecuter(testGradleVersion)
     }
@@ -73,6 +72,10 @@ abstract class BaseExtractorTest extends Specification {
         return new TestFile(testDir)
     }
 
+    TestFile getReportDir() {
+        return getTestDirectory().file("reports")
+    }
+
     TestFile file(Object... path) {
         if (path.length == 1 && path[0] instanceof TestFile) {
             return path[0] as TestFile
@@ -108,7 +111,7 @@ abstract class BaseExtractorTest extends Specification {
     }
 
     protected void establishEnvironmentVariables() {
-        environmentVars = new TestEnvironmentVars(testDirectory)
+        environmentVars = new TestEnvironmentVars(testDirectory, reportDir)
         getExecuter().withEnvironmentVars(environmentVars.asEnvironmentMap())
     }
 
@@ -256,20 +259,23 @@ abstract class BaseExtractorTest extends Specification {
 
     static class TestEnvironmentVars {
         final String jobId = UUID.randomUUID().toString()
-        final String jobCorrelator = "Build"
+        final String jobCorrelator = "dummy-job-correlator"
         final String ref = "refs/head/feature/test" + UUID.randomUUID().toString()
         final String sha = fakeSha()
         final String workspace
+        final String reportDir
         final String gitHubToken = UUID.randomUUID().toString()
 
-        TestEnvironmentVars(TestFile testDirectory) {
+        TestEnvironmentVars(TestFile testDirectory, TestFile reportDir) {
             workspace = testDirectory.absolutePath
+            this.reportDir = reportDir.absolutePath
         }
 
         Map<String, String> asEnvironmentMap() {
             return [
                 "GITHUB_DEPENDENCY_GRAPH_JOB_ID"        : jobId,
                 "GITHUB_DEPENDENCY_GRAPH_JOB_CORRELATOR": jobCorrelator,
+                "GITHUB_DEPENDENCY_GRAPH_REPORT_DIR"    : reportDir,
                 "GITHUB_REF"                            : ref,
                 "GITHUB_SHA"                            : sha,
                 "GITHUB_WORKSPACE"                      : workspace,

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

@@ -24,6 +24,7 @@ class GitHubDependencyExtractorPlugin : Plugin<Gradle> {
     private companion object : PluginCompanionUtils() {
         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_DEPENDENCY_GRAPH_REPORT_DIR = "GITHUB_DEPENDENCY_GRAPH_REPORT_DIR"
         const val ENV_GITHUB_REF = "GITHUB_REF"
         const val ENV_GITHUB_SHA = "GITHUB_SHA"
 
@@ -96,6 +97,8 @@ class GitHubDependencyExtractorPlugin : Plugin<Gradle> {
                         get() = gradle.loadEnvironmentVariable(ENV_DEPENDENCY_GRAPH_JOB_CORRELATOR)
                     override val dependencyGraphJobId: String
                         get() = gradle.loadEnvironmentVariable(ENV_DEPENDENCY_GRAPH_JOB_ID)
+                    override val dependencyGraphReportDir: String
+                        get() = gradle.loadEnvironmentVariable(ENV_DEPENDENCY_GRAPH_REPORT_DIR, "")
                     override val gitSha: String
                         get() = gradle.loadEnvironmentVariable(ENV_GITHUB_SHA)
                     override val gitRef: String
@@ -154,6 +157,7 @@ class GitHubDependencyExtractorPlugin : Plugin<Gradle> {
                     spec.parameters {
                         it.dependencyGraphJobCorrelator.convention(gradle.loadEnvironmentVariable(ENV_DEPENDENCY_GRAPH_JOB_CORRELATOR))
                         it.dependencyGraphJobId.convention(gradle.loadEnvironmentVariable(ENV_DEPENDENCY_GRAPH_JOB_ID))
+                        it.dependencyGraphReportDir.convention(gradle.loadEnvironmentVariable(ENV_DEPENDENCY_GRAPH_REPORT_DIR, ""))
                         it.gitSha.convention(gradle.loadEnvironmentVariable(ENV_GITHUB_SHA))
                         it.gitRef.convention(gradle.loadEnvironmentVariable(ENV_GITHUB_REF))
                         it.gitWorkspaceDirectory.convention(gitWorkspaceDirectory)

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

@@ -25,6 +25,7 @@ abstract class DependencyExtractor :
 
     protected abstract val dependencyGraphJobCorrelator: String
     protected abstract val dependencyGraphJobId: String
+    protected abstract val dependencyGraphReportDir: String
     protected abstract val gitSha: String
     protected abstract val gitRef: String
     protected abstract val gitWorkspaceDirectory: Path
@@ -176,17 +177,23 @@ abstract class DependencyExtractor :
     }
 
     private fun writeAndGetSnapshotFile() {
+        val outputFile = File(getOutputDir(), "${dependencyGraphJobCorrelator}.json")
+        val fileWriter = DependencyFileWriter(outputFile)
+        fileWriter.writeDependencyManifest(gitHubRepositorySnapshotBuilder.build())
+    }
+
+    private fun getOutputDir(): File {
+        if (dependencyGraphReportDir.isNotEmpty()) {
+            return File(dependencyGraphReportDir)
+        }
+
         if (rootProjectBuildDirectory == null) {
-            LOGGER.warn("Unable to write dependency graph snapshot: target directory not known")
-            return
+            throw RuntimeException("Cannot determine report file location")
         }
-        val outputFile = File(
+        return File(
             rootProjectBuildDirectory,
-            "reports/github-dependency-graph-plugin/github-dependency-snapshot-${dependencyGraphJobCorrelator}.json"
+            "reports/github-dependency-graph-snapshots"
         )
-
-        val fileWriter = DependencyFileWriter(outputFile)
-        fileWriter.writeDependencyManifest(gitHubRepositorySnapshotBuilder.build())
     }
 
     override fun close() {

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

@@ -13,6 +13,7 @@ abstract class DependencyExtractorBuildService :
     interface Parameters : BuildServiceParameters {
         val dependencyGraphJobId: Property<String>
         val dependencyGraphJobCorrelator: Property<String>
+        val dependencyGraphReportDir: Property<String>
         val gitSha: Property<String>
         val gitRef: Property<String>
         val gitWorkspaceDirectory: DirectoryProperty
@@ -22,6 +23,8 @@ abstract class DependencyExtractorBuildService :
         get() = parameters.dependencyGraphJobId.get()
     override val dependencyGraphJobCorrelator: String
         get() = parameters.dependencyGraphJobCorrelator.get()
+    override val dependencyGraphReportDir: String
+        get() = parameters.dependencyGraphReportDir.get()
     override val gitSha: String
         get() = parameters.gitSha.get()
     override val gitRef: String