Ensure multi-module SBT plugins respect excludedModules setting (#199)

* Ensure multi-module SBT plugins respect `excludedModules` setting

Co-authored-by: Julien Richard-Foy <[email protected]>

Author: alejandrohdezma

sbt-version-policy/src/main/scala/sbtversionpolicy/SbtVersionPolicySettings.scala

@@ -127,7 +127,9 @@ object SbtVersionPolicySettings {
       val excludedModules = ignoredModulesOfCurrentBuild.value
       val extractVersion = versionPolicyModuleVersionExtractor.value
 
+      log.debug(s"Computing module dependencies excluding ${excludedModules}")
       val currentDependencies = DependencyCheck.modulesOf(compileReport, excludedModules, sv, sbv, extractVersion, log)
+      log.debug(s"Computed dependencies: ${currentDependencies.keySet}")
 
       val reconciliations =
         DependencySchemes(
@@ -449,9 +451,15 @@ object SbtVersionPolicySettings {
               val projectCrossVersion = (projectRef / crossVersion).value
               val projectScalaVersion = (projectRef / scalaVersion).value
               val projectScalaBinaryVersion = (projectRef / scalaBinaryVersion).value
+              val isSbtPlugin = (projectRef / sbtPlugin).value
               if (versionRegex.findFirstMatchIn(projectVersion).isDefined) {
+                // Our goal is to compute the set of submodule names that should be excluded
+                // from dependency checks.
+                // For some reason, the compilation report returned by sbt adds a Scala binary
+                // version suffix to the module names except for sbt plugins.
                 val nameWithBinarySuffix =
-                  CrossVersion(projectCrossVersion, projectScalaVersion, projectScalaBinaryVersion)
+                  if (isSbtPlugin) projectName
+                  else CrossVersion(projectCrossVersion, projectScalaVersion, projectScalaBinaryVersion)
                     .fold(projectName)(_ (projectName))
                 val module = projectOrganization -> nameWithBinarySuffix
                 Some(module)

sbt-version-policy/src/sbt-test/sbt-version-policy/ignored-internal-sbt-plugin/build.sbt

@@ -0,0 +1,51 @@
+ThisBuild / scalaVersion := "2.12.18"
+ThisBuild / organization := "com.example"
+ThisBuild / versionPolicyIntention := Compatibility.BinaryAndSourceCompatible
+
+val a_1 =
+  project
+    .settings(
+      name := "ignored-internal-dependencies-a",
+      version := "1.0.0"
+    )
+
+val b_1 =
+  project
+    .enablePlugins(SbtPlugin)
+    .settings(
+      name := "ignored-internal-dependencies-b",
+      version := "1.0.0"
+    )
+
+val c_1 =
+  project
+    .enablePlugins(SbtPlugin)
+    .settings(
+      name := "ignored-internal-dependencies-c",
+      version := "1.0.0"
+    )
+    .dependsOn(a_1, b_1)
+
+val a_2 =
+  project
+    .settings(
+      name := "ignored-internal-dependencies-a",
+      version := "2.0.0"
+    )
+
+val b_2 =
+  project
+    .enablePlugins(SbtPlugin)
+    .settings(
+      name := "ignored-internal-dependencies-b",
+      version := "2.0.0"
+    )
+
+val c_2 =
+  project
+    .enablePlugins(SbtPlugin)
+    .settings(
+      name := "ignored-internal-dependencies-c",
+      version := "1.0.1"
+    )
+    .dependsOn(a_2, b_2)

sbt-version-policy/src/sbt-test/sbt-version-policy/ignored-internal-sbt-plugin/project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("ch.epfl.scala" % "sbt-version-policy" % sys.props("plugin.version"))

sbt-version-policy/src/sbt-test/sbt-version-policy/ignored-internal-sbt-plugin/test

@@ -0,0 +1,11 @@
+# Publish v1.0.0 of modules
+> a_1/publishLocal
+> b_1/publishLocal
+> c_1/publishLocal
+
+# Checking dependency issues fails because internal dependencies bumped their major version
+-> c_2/versionPolicyReportDependencyIssues
+
+# Explicitly ignore the major version bump makes versionPolicyReportDependencyIssues pass
+> set c_2/versionPolicyIgnoredInternalDependencyVersions := Some("2.0.0".r)
+> c_2/versionPolicyReportDependencyIssues