Only add dependency scope if configured

To avoid assigned all dependencies to either 'runtime' or 'development' scope,
we leave the current behaviour of assigning no scopes unless the relevant input
parameters are configured.

Author: bigdaz

README.md

@@ -51,6 +51,25 @@ You can provide this value via the `DEPENDENCY_GRAPH_INCLUDE_PROJECTS` environme
 To restrict which Gradle configurations contribute to the report, you can filter configurations by name using a regular expression.
 You can provide this value via the `DEPENDENCY_GRAPH_INCLUDE_CONFIGURATIONS` environment variable or system property.
 
+### Controlling the scope of dependencies in the dependency graph
+
+The GitHub dependency graph allows a scope to be assigned to each reported dependency.
+The only permissible values for scope are 'runtime' and 'development'.
+
+By default, no scope is assigned to dependencies in the graph. To enable scopes in the generated dependency graph, 
+at least one of `DEPENDENCY_GRAPH_RUNTIME_PROJECTS` or `DEPENDENCY_GRAPH_RUNTIME_CONFIGURATIONS` must be configured.
+
+To restrict which Gradle subprojects contribute 'runtime' dependencies to the report, specify which projects to include via a regular expression.
+You can provide this value via the `DEPENDENCY_GRAPH_RUNTIME_PROJECTS` environment variable or system property.
+For a project not matching this filter, all dependencies will be scoped 'development'.
+
+To restrict which Gradle configurations contribute 'runtime' dependencies to the report, you can filter configurations by name using a regular expression.
+You can provide this value via the `DEPENDENCY_GRAPH_RUNTIME_CONFIGURATIONS` environment variable or system property.
+Dependencies resolved by a matching configuration will be scoped 'runtime': all other dependencies will be scoped 'development'.
+
+For dependencies that are resolved in multiple projects and/or multiple configurations, only a single 'runtime' scoped resolution
+is required for that dependency to be scoped 'runtime'.
+
 ### Gradle compatibility
 
 The plugin should be compatible with most versions of Gradle >= 5.2, and has been tested against 

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

@@ -208,7 +208,7 @@ abstract class BaseExtractorTest extends Specification {
                 }
                 assert actual.relationship == (expected.relationship ?: "direct")
                 assert actual.dependencies == (expected.dependencies ?: [])
-                assert actual.scope == (expected.scope ?: "runtime")
+                assert actual.scope == expected.scope
             }
 
             return true

plugin/src/main/kotlin/org/gradle/dependencygraph/extractor/DependencyExtractor.kt

@@ -9,8 +9,7 @@ import org.gradle.api.internal.artifacts.configurations.ResolveConfigurationDepe
 import org.gradle.api.logging.Logging
 import org.gradle.dependencygraph.DependencyGraphRenderer
 import org.gradle.dependencygraph.model.*
-import org.gradle.dependencygraph.model.DependencyScope.RUNTIME
-import org.gradle.dependencygraph.model.DependencyScope.DEVELOPMENT
+import org.gradle.dependencygraph.model.DependencyScope.*
 import org.gradle.dependencygraph.util.*
 import org.gradle.initialization.EvaluateSettingsBuildOperationType
 import org.gradle.initialization.LoadProjectsBuildOperationType
@@ -176,7 +175,7 @@ abstract class DependencyExtractor :
             return
         }
 
-        val scope = if (runtimeFilter.include(rootPath, configurationName)) RUNTIME else DEVELOPMENT
+        val scope = dependencyScope(rootPath, configurationName)
 
         val rootId = if (projectIdentityPath == null) "build $rootPath" else componentId(rootComponent)
         val rootOrigin = DependencyOrigin(rootId, rootPath)
@@ -198,6 +197,16 @@ abstract class DependencyExtractor :
         resolvedConfigurations.add(resolvedConfiguration)
     }
 
+    private fun dependencyScope(
+        rootPath: String,
+        configurationName: String
+    ): DependencyScope {
+        if (runtimeFilter.isConfigured()) {
+            return if (runtimeFilter.include(rootPath, configurationName)) RUNTIME else DEVELOPMENT
+        }
+        return UNKNOWN
+    }
+
     private fun walkComponentDependencies(
         component: ResolvedComponentResult,
         parentOrigin: DependencyOrigin,

plugin/src/main/kotlin/org/gradle/dependencygraph/extractor/ResolvedConfigurationFilter.kt

@@ -13,4 +13,8 @@ class ResolvedConfigurationFilter(projectFilter: String?, configurationFilter: S
         }
         return true
     }
+
+    fun isConfigured(): Boolean {
+        return projectFilter != null || configurationFilter != null
+    }
 }

plugin/src/main/kotlin/org/gradle/dependencygraph/model/DependencyScope.kt

@@ -6,12 +6,13 @@ package org.gradle.dependencygraph.model
  * Later development may extend this to a richer set of scopes.
  */
 enum class DependencyScope {
-    DEVELOPMENT, RUNTIME;
+    UNKNOWN, DEVELOPMENT, RUNTIME;
 
     companion object {
         fun getEffectiveScope(scopes: List<DependencyScope>): DependencyScope {
             if (scopes.contains(RUNTIME)) return RUNTIME
-            return DEVELOPMENT
+            if (scopes.contains(DEVELOPMENT)) return DEVELOPMENT
+            return UNKNOWN
         }
     }
 }

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

@@ -38,10 +38,11 @@ class GitHubRepositorySnapshotBuilder(
         )
     }
 
-    private fun determineGitHubScope(configuration: ResolvedConfiguration): GitHubDependency.Scope {
+    private fun determineGitHubScope(configuration: ResolvedConfiguration): GitHubDependency.Scope? {
         return when(configuration.scope) {
             DependencyScope.DEVELOPMENT -> GitHubDependency.Scope.development
             DependencyScope.RUNTIME -> GitHubDependency.Scope.runtime
+            DependencyScope.UNKNOWN -> null
         }
     }
 
@@ -75,7 +76,7 @@ class GitHubRepositorySnapshotBuilder(
         /**
          * Merge each resolved component with the same ID into a single GitHubDependency.
          */
-        fun addResolved(component: ResolvedDependency, scope: GitHubDependency.Scope) {
+        fun addResolved(component: ResolvedDependency, scope: GitHubDependency.Scope?) {
             val dep = dependencyBuilders.getOrPut(component.id) {
                 GitHubDependencyBuilder(component.packageUrl())
             }
@@ -98,7 +99,7 @@ class GitHubRepositorySnapshotBuilder(
 
         private class GitHubDependencyBuilder(val package_url: String) {
             var relationship: GitHubDependency.Relationship = GitHubDependency.Relationship.indirect
-            var scope: GitHubDependency.Scope = GitHubDependency.Scope.development
+            var scope: GitHubDependency.Scope? = null
             val dependencies = mutableListOf<String>()
 
             fun addRelationship(newRelationship: GitHubDependency.Relationship) {
@@ -108,8 +109,9 @@ class GitHubRepositorySnapshotBuilder(
                 }
             }
 
-            fun addScope(newScope: GitHubDependency.Scope) {
-                if (scope == GitHubDependency.Scope.development) {
+            fun addScope(newScope: GitHubDependency.Scope?) {
+                if (newScope == null) return
+                if (scope == null || scope == GitHubDependency.Scope.development) {
                     scope = newScope
                 }
             }

plugin/src/main/kotlin/org/gradle/github/dependencygraph/model/GitHubDependency.kt

@@ -3,7 +3,7 @@ package org.gradle.github.dependencygraph.model
 data class GitHubDependency(
     val package_url: String,
     val relationship: Relationship,
-    val scope: Scope,
+    val scope: Scope?,
     val dependencies: List<String>
 ) {
     enum class Relationship {