Add on-resolve-failure input

adpi2 · adpi2 · commit e6b1b6c23a46 · 2022-07-14T14:57:06.000+02:00
diff --git a/action.yml b/action.yml
@@ -16,6 +16,13 @@ inputs:
       Example: `foo_2.13 bar_2.13`
     required: false
     default: ''
+  on-resolve-failure:
+    description: |
+      Either 'error' or 'warning'.
+      When a dependency resolution failure happens, if 'error' the job will fail and will not submit the snapshot.
+      If 'warning', the job will ignore the failing modules and submit the snapshot.
+    required: false
+    default: error
   token:
     description: GitHub Personal Access Token (PAT). Defaults to PAT provided by Action runner.
     required: false
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/sbt-plugin/src/main/contraband/input.contra b/sbt-plugin/src/main/contraband/input.contra
@@ -3,9 +3,17 @@ package ch.epfl.scala
 @codecPackage("ch.epfl.scala")
 @fullCodec("JsonProtocol")
 
+enum OnFailure {
+  error
+  warning
+}
+
 ## Input of the githubSubmitDependencyGraph command
 type SubmitInput {
-  ## A set of modules to ignore, a module is the artifact ID of a project on a particular scala version
-  ## Typically it would be something like foo_2.13
+  onResolveFailure: ch.epfl.scala.OnFailure
+
+  ## A set of modules to ignore.
+  ## The name of module is composed of the name of the project and its binary version.
+  ## Example: foo_2.13
   ignoredModules: [String]
 }
diff --git a/sbt-plugin/src/main/scala/ch/epfl/scala/GithubDependencyGraphPlugin.scala b/sbt-plugin/src/main/scala/ch/epfl/scala/GithubDependencyGraphPlugin.scala
@@ -28,7 +28,9 @@ object GithubDependencyGraphPlugin extends AutoPlugin {
     val githubSubmitInputKey: AttributeKey[SubmitInput] = AttributeKey("githubSubmitInput")
     val githubManifestsKey: AttributeKey[Map[String, githubapi.Manifest]] = AttributeKey("githubDependencyManifests")
     val githubProjectsKey: AttributeKey[Seq[ProjectRef]] = AttributeKey("githubProjectRefs")
-    val githubDependencyManifest: TaskKey[githubapi.Manifest] = taskKey("The dependency manifest of the project")
+    val githubDependencyManifest: TaskKey[Option[githubapi.Manifest]] = taskKey(
+      "The dependency manifest of the project"
+    )
     val githubStoreDependencyManifests: InputKey[StateTransform] =
       inputKey("Store the dependency manifests of all projects of a Scala version in the attribute map.")
         .withRank(KeyRanks.DTask)
@@ -74,6 +76,7 @@ object GithubDependencyGraphPlugin extends AutoPlugin {
         .map(ref => (ref / githubDependencyManifest).?)
         .join
         .value
+        .flatten
         .collect { case Some(manifest) => (manifest.name, manifest) }
         .toMap
       StateTransform { state =>
@@ -95,7 +98,7 @@ object GithubDependencyGraphPlugin extends AutoPlugin {
     !ignored
   }
 
-  private def manifestTask: Def.Initialize[Task[Manifest]] = Def.task {
+  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
     val projectID = Keys.projectID.value
@@ -105,66 +108,74 @@ 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.attributes(githubSubmitInputKey).onResolveFailure
 
     def getReference(module: ModuleID): String =
       crossVersion(module)
         .withConfigurations(None)
         .withExtraAttributes(Map.empty)
         .toString
 
-    val alreadySeen = mutable.Set[String]()
-    val moduleReports = mutable.Buffer[(ModuleReport, ConfigRef)]()
-    val allDependencies = mutable.Buffer[(String, String)]()
-
-    val report = reportResult match {
+    reportResult match {
       case Inc(cause) =>
         val moduleName = crossVersion(projectID).name
-        logger.error(s"Failed to resolve the dependencies of $moduleName")
-        throw cause
-      case Value(report) => report
-    }
-
-    for {
-      configReport <- report.configurations
-      moduleReport <- configReport.modules
-      moduleRef = getReference(moduleReport.module)
-      if !moduleReport.evicted && !alreadySeen.contains(moduleRef)
-    } {
-      alreadySeen += moduleRef
-      moduleReports += (moduleReport -> configReport.configuration)
-      for (caller <- moduleReport.callers)
-        allDependencies += (getReference(caller.caller) -> moduleRef)
-    }
-
-    val allDependenciesMap: Map[String, Vector[String]] = allDependencies.view
-      .groupBy(_._1)
-      .mapValues {
-        _.map { case (_, dep) => dep }.toVector
-      }
-    val allDirectDependenciesRefs: Set[String] = allDirectDependencies.map(getReference).toSet
-
-    val resolved =
-      for ((moduleReport, configRef) <- moduleReports)
-        yield {
-          val moduleRef = getReference(moduleReport.module)
-          val packageUrl = formatPackageUrl(moduleReport)
-          val dependencies = allDependenciesMap.getOrElse(moduleRef, Vector.empty)
-          val relationship =
-            if (allDirectDependenciesRefs.contains(moduleRef)) DependencyRelationship.direct
-            else DependencyRelationship.indirect
-          val scope =
-            if (isRuntime(configRef)) DependencyScope.runtime
-            else DependencyScope.development
-          val metadata = Map("config" -> JString(configRef.name))
-          val node = DependencyNode(packageUrl, metadata, Some(relationship), Some(scope), dependencies)
-          (moduleRef -> node)
+        val message = s"Failed to resolve the dependencies of $moduleName"
+        onResolveFailure match {
+          case Some(OnFailure.warning) =>
+            logger.warn(message)
+            None
+          case _ =>
+            logger.error(message)
+            throw cause
+        }
+      case Value(report) =>
+        val alreadySeen = mutable.Set[String]()
+        val moduleReports = mutable.Buffer[(ModuleReport, ConfigRef)]()
+        val allDependencies = mutable.Buffer[(String, String)]()
+
+        for {
+          configReport <- report.configurations
+          moduleReport <- configReport.modules
+          moduleRef = getReference(moduleReport.module)
+          if !moduleReport.evicted && !alreadySeen.contains(moduleRef)
+        } {
+          alreadySeen += moduleRef
+          moduleReports += (moduleReport -> configReport.configuration)
+          for (caller <- moduleReport.callers)
+            allDependencies += (getReference(caller.caller) -> moduleRef)
         }
 
-    val projectModuleRef = getReference(projectID)
-    // TODO: find exact build file for this project
-    val file = githubapi.FileInfo("build.sbt")
-    val metadata = Map("baseDirectory" -> JString(baseDirectory.toString))
-    githubapi.Manifest(projectModuleRef, file, metadata, resolved.toMap)
+        val allDependenciesMap: Map[String, Vector[String]] = allDependencies.view
+          .groupBy(_._1)
+          .mapValues {
+            _.map { case (_, dep) => dep }.toVector
+          }
+        val allDirectDependenciesRefs: Set[String] = allDirectDependencies.map(getReference).toSet
+
+        val resolved =
+          for ((moduleReport, configRef) <- moduleReports)
+            yield {
+              val moduleRef = getReference(moduleReport.module)
+              val packageUrl = formatPackageUrl(moduleReport)
+              val dependencies = allDependenciesMap.getOrElse(moduleRef, Vector.empty)
+              val relationship =
+                if (allDirectDependenciesRefs.contains(moduleRef)) DependencyRelationship.direct
+                else DependencyRelationship.indirect
+              val scope =
+                if (isRuntime(configRef)) DependencyScope.runtime
+                else DependencyScope.development
+              val metadata = Map("config" -> JString(configRef.name))
+              val node = DependencyNode(packageUrl, metadata, Some(relationship), Some(scope), dependencies)
+              (moduleRef -> node)
+            }
+
+        val projectModuleRef = getReference(projectID)
+        // TODO: find exact build file for this project
+        val file = githubapi.FileInfo("build.sbt")
+        val metadata = Map("baseDirectory" -> JString(baseDirectory.toString))
+        val manifest = githubapi.Manifest(projectModuleRef, file, metadata, resolved.toMap)
+        Some(manifest)
+    }
   }
 
   private def formatPackageUrl(moduleReport: ModuleReport): String = {
diff --git a/sbt-plugin/src/sbt-test/dependency-manifest/coursier-manifest/build.sbt b/sbt-plugin/src/sbt-test/dependency-manifest/coursier-manifest/build.sbt
@@ -23,7 +23,7 @@ lazy val p1 = project
       "org.scalatest" %% "scalatest" % "3.2.2" % Test
     ),
     checkManifest := {
-      val manifest = githubDependencyManifest.value
+      val manifest = githubDependencyManifest.value.get
       assert(manifest.name == "ch.epfl.scala:p1_2.12:1.2.0-SNAPSHOT")
 
       // all dependencies are defined
@@ -58,7 +58,7 @@ lazy val p2 = project
       "com.typesafe.akka" %% "akka-http" % "10.2.8"
     ),
     checkManifest := {
-      val manifest = githubDependencyManifest.value
+      val manifest = githubDependencyManifest.value.get
       assert(manifest.name == "ch.epfl.scala:p2_2.12:1.2.0-SNAPSHOT")
 
       // all dependencies are defined
diff --git a/sbt-plugin/src/sbt-test/dependency-manifest/default-scala-manifest/build.sbt b/sbt-plugin/src/sbt-test/dependency-manifest/default-scala-manifest/build.sbt
@@ -17,7 +17,7 @@ lazy val p1 = project
   .in(file("p1"))
   .settings(
     checkManifest := {
-      val manifest = githubDependencyManifest.value
+      val manifest = githubDependencyManifest.value.get
       assert(manifest.name == "ch.epfl.scala:p1_2.12:1.2.0-SNAPSHOT")
 
       // all dependencies are defined
diff --git a/sbt-plugin/src/sbt-test/dependency-manifest/ivy-manifest/build.sbt b/sbt-plugin/src/sbt-test/dependency-manifest/ivy-manifest/build.sbt
@@ -23,7 +23,7 @@ lazy val p1 = project
       "org.scalatest" %% "scalatest" % "3.2.2" % Test
     ),
     checkManifest := {
-      val manifest = githubDependencyManifest.value
+      val manifest = githubDependencyManifest.value.get
       assert(manifest.name == "ch.epfl.scala:p1_2.12:1.2.0-SNAPSHOT")
 
       // all dependencies are defined
@@ -58,7 +58,7 @@ lazy val p2 = project
       "com.typesafe.akka" %% "akka-http" % "10.2.8"
     ),
     checkManifest := {
-      val manifest = githubDependencyManifest.value
+      val manifest = githubDependencyManifest.value.get
       assert(manifest.name == "ch.epfl.scala:p2_2.12:1.2.0-SNAPSHOT")
 
       // all dependencies are defined
diff --git a/sbt-plugin/src/sbt-test/dependency-manifest/package-urls/build.sbt b/sbt-plugin/src/sbt-test/dependency-manifest/package-urls/build.sbt
@@ -26,7 +26,7 @@ lazy val p1 = project
         .classifier("natives-macos")
     ),
     checkManifest := {
-      val manifest = githubDependencyManifest.value
+      val manifest = githubDependencyManifest.value.get
 
       checkDependency(manifest, "com.google.inject:guice:4.0")(
         expectedPackageUrl = "pkg:maven/com.google.inject/guice@4.0?packaging=no_aop"
diff --git a/sbt-plugin/src/sbt-test/dependency-manifest/scala3-manifest/build.sbt b/sbt-plugin/src/sbt-test/dependency-manifest/scala3-manifest/build.sbt
@@ -20,7 +20,7 @@ lazy val p1 = project
       "io.circe" %% "circe-core" % "0.14.1"
     ),
     checkManifest := {
-      val manifest = githubDependencyManifest.value
+      val manifest = githubDependencyManifest.value.get
       assert(manifest.name == "ch.epfl.scala:p1_3:1.2.0-SNAPSHOT")
 
       // all dependencies are defined
diff --git a/sbt-plugin/src/sbt-test/submit-snapshot/ci-submit/build.sbt b/sbt-plugin/src/sbt-test/submit-snapshot/ci-submit/build.sbt
@@ -42,7 +42,7 @@ val b = project
   )
   .dependsOn(a)
 
-checkManifests := {
+Global / checkManifests := {
   val logger = streams.value.log
   val expectedSize: Int = (Space ~> NatBasic).parsed
   val manifests = state.value.get(githubManifestsKey).getOrElse {
@@ -54,4 +54,3 @@ checkManifests := {
     s"expected $expectedSize manifests, found ${manifests.size}"
   )
 }
-checkManifests / aggregate := false
diff --git a/sbt-plugin/src/sbt-test/submit-snapshot/ci-submit/test b/sbt-plugin/src/sbt-test/submit-snapshot/ci-submit/test
@@ -1,11 +1,12 @@
 > 'githubSubmitDependencyGraph {}'
-> checkManifests 4
+> Global / checkManifests 4
 
 > 'githubSubmitDependencyGraph {"ignoredModules":["a_2.13", "b_2.13"]}'
-> checkManifests 2
+> Global / checkManifests 2
 
 > 'githubSubmitDependencyGraph {"ignoredModules":["a_2.12", "a_2.13", "b_2.13"]}'
-> checkManifests 1
+> Global / checkManifests 1
 
 > 'githubSubmitDependencyGraph {"ignoredModules":[]}'
-> checkManifests 4
+> Global / checkManifests 4
+
diff --git a/sbt-plugin/src/sbt-test/submit-snapshot/resolve-failure/build.sbt b/sbt-plugin/src/sbt-test/submit-snapshot/resolve-failure/build.sbt
@@ -0,0 +1,41 @@
+import scala.util.Properties
+import sbt.internal.util.complete.Parsers._
+
+val checkManifests = inputKey[Unit]("Check the number of manifests")
+
+inThisBuild(
+  Seq(
+    organization := "ch.epfl.scala",
+    version := "1.2.0-SNAPSHOT",
+    // use Ivy because Coursier does not allow several classifier on the same dep
+    useCoursier := false,
+    scalaVersion := "2.13.8"
+  )
+)
+
+val a = project
+  .in(file("."))
+  .settings(
+    scalaVersion := "2.13.8"
+  )
+
+// Update on b fails, because b on 2.12.16 depends on a on 2.13.8
+val b = project
+  .in(file("b"))
+  .settings(
+    scalaVersion := "2.12.16"
+  )
+  .dependsOn(a)
+
+Global / checkManifests := {
+  val logger = streams.value.log
+  val expectedSize: Int = (Space ~> NatBasic).parsed
+  val manifests = state.value.get(githubManifestsKey).getOrElse {
+    throw new MessageOnlyException(s"Not found ${githubManifestsKey.label} attribute")
+  }
+  logger.info(s"found ${manifests.size} manifests")
+  assert(
+    manifests.size == expectedSize,
+    s"expected $expectedSize manifests, found ${manifests.size}"
+  )
+}
diff --git a/sbt-plugin/src/sbt-test/submit-snapshot/resolve-failure/project/plugins.sbt b/sbt-plugin/src/sbt-test/submit-snapshot/resolve-failure/project/plugins.sbt
@@ -0,0 +1,3 @@
+val pluginVersion = sys.props("plugin.version")
+
+addSbtPlugin("ch.epfl.scala" % "sbt-github-dependency-submission" % pluginVersion)
diff --git a/sbt-plugin/src/sbt-test/submit-snapshot/resolve-failure/test b/sbt-plugin/src/sbt-test/submit-snapshot/resolve-failure/test
@@ -0,0 +1,5 @@
+-> 'githubSubmitDependencyGraph {}'
+-> 'Global / githubSubmitDependencyGraph {"onResolveFailure": "error"}'
+
+> 'githubSubmitDependencyGraph {"onResolveFailure": "warning"}'
+> Global / checkManifests 1
diff --git a/sbt-plugin/src/test/scala/ch/epfl/scala/JsonProtocolTests.scala b/sbt-plugin/src/test/scala/ch/epfl/scala/JsonProtocolTests.scala
@@ -30,7 +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(Vector.empty)
+    val expected = SubmitInput(None, 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)
     assertEquals(obtained, expected)
   }
 }
diff --git a/src/main.ts b/src/main.ts
