Merge pull request #75 from scalacenter/fix-49

Add configs-ignore input

Author: adpi2

README.md

@@ -45,6 +45,12 @@ The name of a module contains the name of the project and its binary version.
 
 Example: `foo_2.13 bar_2.13`
 
+#### - `configs-ignore` (optional)
+
+A list of space-separated names of configurations to ignore. The action will not submit the dependencies of these configurations.
+
+Example of configurations are `compile`, `test`, `scala-tool`, `scala-doc-tool`.
+
 #### - `token` (optional)
 
 GitHub Personal Access Token (PAT). Defaults to PAT provided by Action runner.
@@ -53,6 +59,8 @@ Example: `${{ secrets.USER_TOKEN }}`
 
 #### Example
 
+##### Excluding some projects or some Scala versions from the dependency submission.
+
 In this example the snapshot will not contain the graphs of `foo_2.13` and `bar_3`.
 
 ```yaml
@@ -67,6 +75,22 @@ steps:
       modules-ignore: foo_2.13 bar_3
 ```
 
+#### Excluding the Scaladoc dependencies.
+
+In this example the snapshot will not contain the dependencies of the scala-doc-tool configuration.
+
+```yaml
+
+## in .github/workflows/dependency-graph.md
+...
+steps:
+  - uses: actions/checkout@v3
+  - uses: scalacenter/sbt-dependency-submission@v2
+    with:
+      base-dir: ./my-scala-project
+      configs-ignore: scala-doc-tool
+```
+
 ## Troubleshooting
 
 ### Unexpected Status: 404

action.yml

@@ -16,6 +16,12 @@ inputs:
       Example: `foo_2.13 bar_2.13`
     required: false
     default: ''
+  configs-ignore:
+    description: |
+      A list of space-separated names of configurations to ignore. The action will not submit the dependencies of these configurations.
+      Example: `test scala-doc-tool`
+    required: false
+    default: ''
   on-resolve-failure:
     description: |
       Either 'error' or 'warning'.

sbt-plugin/src/main/contraband/input.contra

@@ -16,4 +16,11 @@ type SubmitInput {
   ## The name of module is composed of the name of the project and its binary version.
   ## Example: foo_2.13
   ignoredModules: [String]
+
+  ## A set of sbt configurations to ignore.
+  ## Examples:
+  ##  - "test" to ignore the test dependencies
+  ##  - "scala-doc-tool" to ignore the scaladoc dependencies
+  ##  - "scala-tool" to ignore the compiler dependencies
+  ignoredConfigs: [String]
 }

sbt-plugin/src/main/scala/ch/epfl/scala/GithubDependencyGraphPlugin.scala

@@ -88,16 +88,20 @@ object GithubDependencyGraphPlugin extends AutoPlugin {
 
   private def includeProject(projectRef: ProjectRef, state: State, logger: Logger): Boolean = {
     val ignoredModules = state.attributes(githubSubmitInputKey).ignoredModules
-    val scalaVersion = state.setting(projectRef / Keys.artifactName / Keys.scalaVersion)
-    val scalaBinaryVersion = state.setting(projectRef / Keys.artifactName / Keys.scalaBinaryVersion)
-    val projectID = state.setting(projectRef / Keys.projectID)
-    val moduleName = CrossVersion(scalaVersion, scalaBinaryVersion).apply(projectID).name
+    val moduleName = getModuleName(projectRef, state)
     val ignored = ignoredModules.contains(moduleName)
     if (!ignored) logger.info(s"Including dependency graph of $moduleName")
     else logger.info(s"Excluding dependency graph of $moduleName")
     !ignored
   }
 
+  private def getModuleName(projectRef: ProjectRef, state: State): String = {
+    val scalaVersion = state.setting(projectRef / Keys.artifactName / Keys.scalaVersion)
+    val scalaBinaryVersion = state.setting(projectRef / Keys.artifactName / Keys.scalaBinaryVersion)
+    val projectID = state.setting(projectRef / Keys.projectID)
+    CrossVersion(scalaVersion, scalaBinaryVersion).apply(projectID).name
+  }
+
   private def manifestTask: Def.Initialize[Task[Option[Manifest]]] = Def.task {
     // updateFull is needed to have information about callers and reconstruct dependency tree
     val reportResult = Keys.updateFull.result.value
@@ -108,17 +112,26 @@ object GithubDependencyGraphPlugin extends AutoPlugin {
     val allDirectDependencies = Keys.allDependencies.value
     val baseDirectory = Keys.baseDirectory.value
     val logger = Keys.streams.value.log
-    val onResolveFailure = Keys.state.value.get(githubSubmitInputKey).flatMap(_.onResolveFailure)
+    val input = Keys.state.value.get(githubSubmitInputKey)
+
+    val onResolveFailure = input.flatMap(_.onResolveFailure)
+    val ignoredConfigs = input.toSeq.flatMap(_.ignoredConfigs).toSet
+    val moduleName = crossVersion(projectID).name
 
     def getReference(module: ModuleID): String =
       crossVersion(module)
         .withConfigurations(None)
         .withExtraAttributes(Map.empty)
         .toString
 
+    def includeConfig(config: ConfigRef): Boolean =
+      if (ignoredConfigs.contains(config.name)) {
+        logger.info(s"Excluding config ${config.name} of ${moduleName} from its dependency graph")
+        false
+      } else true
+
     reportResult match {
       case Inc(cause) =>
-        val moduleName = crossVersion(projectID).name
         val message = s"Failed to resolve the dependencies of $moduleName"
         onResolveFailure match {
           case Some(OnFailure.warning) =>
@@ -132,9 +145,9 @@ object GithubDependencyGraphPlugin extends AutoPlugin {
         val alreadySeen = mutable.Set[String]()
         val moduleReports = mutable.Buffer[(ModuleReport, ConfigRef)]()
         val allDependencies = mutable.Buffer[(String, String)]()
-
         for {
           configReport <- report.configurations
+          if includeConfig(configReport.configuration)
           moduleReport <- configReport.modules
           moduleRef = getReference(moduleReport.module)
           if !moduleReport.evicted && !alreadySeen.contains(moduleRef)

sbt-plugin/src/sbt-test/dependency-manifest/ignore-scaladoc/build.sbt

@@ -0,0 +1,55 @@
+import ch.epfl.scala.githubapi.DependencyRelationship
+import ch.epfl.scala.githubapi.DependencyScope
+import ch.epfl.scala.githubapi.Manifest
+import ch.epfl.scala.SubmitInput
+import sjsonnew.shaded.scalajson.ast.unsafe.JString
+
+val checkScaladoc = taskKey[Unit]("Check scaladoc_3 is in the manifest ")
+val ignoreScaladoc = taskKey[StateTransform]("Ignore the scala-doc-tool in the submit input")
+val checkIgnoreScaladoc = taskKey[Unit]("Check scaladoc_3 is absent in the manifest")
+
+inThisBuild(
+  Seq(
+    organization := "ch.epfl.scala",
+    version := "1.2.0-SNAPSHOT",
+    scalaVersion := "3.2.1"
+  )
+)
+
+Global / ignoreScaladoc := {
+  val input = SubmitInput(None, Vector.empty, ignoredConfigs = Vector("scala-doc-tool"))
+  StateTransform(state => state.put(githubSubmitInputKey, input))
+}
+
+lazy val p1 = project
+  .in(file("p1"))
+  .settings(
+    checkScaladoc := {
+      val manifest = githubDependencyManifest.value.get
+      checkDependency(manifest, "org.scala-lang:scaladoc_3:3.2.1")(
+        expectedRelationship = DependencyRelationship.direct,
+        expectedScope = DependencyScope.development,
+        expectedConfig = "scala-doc-tool"
+      )
+    },
+    checkIgnoreScaladoc := {
+      val manifest = githubDependencyManifest.value.get
+      val suspicious = manifest.resolved.keys.filter(dep => dep.contains("scaladoc_3"))
+      assert(suspicious.isEmpty, s"The manifest should not contain scaladoc_3, found ${suspicious.mkString(", ")}")
+    }
+  )
+
+def checkDependency(manifest: Manifest, name: String)(
+    expectedRelationship: DependencyRelationship = DependencyRelationship.direct,
+    expectedScope: DependencyScope = DependencyScope.runtime,
+    expectedConfig: String = "compile",
+    expectedDeps: Seq[String] = Seq.empty
+): Unit = {
+  val node = manifest.resolved(name)
+  assert(node.package_url.startsWith("pkg:maven/"), s"Wrong package_url for node $name: ${node.package_url}")
+  assert(node.relationship.contains(expectedRelationship), s"Wrong relationship for node $name: ${node.relationship}")
+  assert(node.scope.contains(expectedScope), s"Wrong scope for node $name: ${node.scope}")
+  val configurations = node.metadata.get("config").collect { case JString(c) => c }
+  assert(configurations.contains(expectedConfig), s"Wrong config in metadata for node $name: $configurations")
+  expectedDeps.foreach(d => assert(node.dependencies.contains(d), s"missing dependency $d in node $name"))
+}

sbt-plugin/src/sbt-test/dependency-manifest/ignore-scaladoc/project/plugins.sbt

@@ -0,0 +1,3 @@
+val pluginVersion = sys.props("plugin.version")
+
+addSbtPlugin("ch.epfl.scala" % "sbt-github-dependency-submission" % pluginVersion)

sbt-plugin/src/sbt-test/dependency-manifest/ignore-scaladoc/test

@@ -0,0 +1,3 @@
+> p1 / checkScaladoc
+> Global / ignoreScaladoc
+> p1 / checkIgnoreScaladoc

sbt-plugin/src/test/scala/ch/epfl/scala/JsonProtocolTests.scala

@@ -30,15 +30,15 @@ class JsonProtocolTests extends FunSuite {
     import ch.epfl.scala.JsonProtocol._
     val raw = Parser.parseUnsafe("{}")
     val obtained = Converter.fromJson[SubmitInput](raw).get
-    val expected = SubmitInput(None, Vector.empty)
+    val expected = SubmitInput(None, Vector.empty, Vector.empty)
     assertEquals(obtained, expected)
   }
 
   test("decode input with onResolveFailure: warning") {
     import ch.epfl.scala.JsonProtocol._
     val raw = Parser.parseUnsafe("""{"onResolveFailure": "warning"}""")
     val obtained = Converter.fromJson[SubmitInput](raw).get
-    val expected = SubmitInput(Some(OnFailure.warning), Vector.empty)
+    val expected = SubmitInput(Some(OnFailure.warning), Vector.empty, Vector.empty)
     assertEquals(obtained, expected)
   }
 }

src/main.ts

@@ -35,6 +35,11 @@ async function run(): Promise<void> {
       .split(' ')
       .filter(value => value.length > 0)
 
+    const ignoredConfigs = core
+      .getInput('configs-ignore')
+      .split(' ')
+      .filter(value => value.length > 0)
+
     const onResolveFailure = core.getInput('on-resolve-failure')
     if (!['error', 'warning'].includes(onResolveFailure)) {
       core.setFailed(
@@ -43,7 +48,7 @@ async function run(): Promise<void> {
       return
     }
 
-    const input = { ignoredModules, onResolveFailure }
+    const input = { ignoredModules, ignoredConfigs, onResolveFailure }
 
     process.env['GITHUB_TOKEN'] = token
     await cli.exec('sbt', [`githubSubmitDependencyGraph ${JSON.stringify(input)}`], {