WIP: Bzlmod part the one hundred-eighteenth

mbland · mbland · commit c1a39d3c8815 · 2024-10-27T20:33:56.000-04:00
Fix testing toolchain configuration errors

Also introduces `register_testing_toolchains` to make
`{scalatest,junit,specs2_junit}_toolchain` compatible with the
new toolchains repo. They aren't separate toolchains anymore; there's a
single testing toolchain per Scala version that contains all testing
frameworks configured via `scala_toolchains`.

The error below happened when building under `--noenable_bzlmod
--enable_workspace` until I properly propagated `scalatest = True` when
`testing == True` in `scala_toolchains`. I don't know how the Bzlmod
builds passed without this change.

```txt
$ bazel build //src/...

ERROR: no such package '@@io_bazel_rules_scala_scalatest_shouldmatchers_2_12_20//':
  The repository '@@io_bazel_rules_scala_scalatest_shouldmatchers_2_12_20'
  could not be resolved:
  Repository '@@io_bazel_rules_scala_scalatest_shouldmatchers_2_12_20' is not defined

ERROR: .../external/io_bazel_rules_scala_toolchains/testing/BUILD:13:34:
  no such package '@@io_bazel_rules_scala_scalatest_shouldmatchers_2_12_20//':
  The repository '@@io_bazel_rules_scala_scalatest_shouldmatchers_2_12_20'
  could not be resolved:
  Repository '@@io_bazel_rules_scala_scalatest_shouldmatchers_2_12_20' is not defined
  and referenced by
  '@@io_bazel_rules_scala_toolchains//testing:testing_toolchain_2_12_20_scalatest_classpath_provider'

ERROR: Analysis of target
  '//src/java/io/bazel/rulesscala/scala_test:runner' failed;
  build aborted: Analysis failed
```
diff --git a/MODULE.bazel b/MODULE.bazel
@@ -65,9 +65,7 @@ use_repo(
     "scala_compiler_sources",
 )
 
-register_toolchains(
-    "@io_bazel_rules_scala_toolchains//...:all",
-)
+register_toolchains("@io_bazel_rules_scala_toolchains//...:all")
 
 # Dev dependencies
 
@@ -234,4 +232,4 @@ use_repo(
     "org_golang_x_tools",
 )
 
-bazel_dep(name = "rules_python", version = "0.35.0", dev_dependency = True)
+bazel_dep(name = "rules_python", version = "0.36.0", dev_dependency = True)
diff --git a/WORKSPACE b/WORKSPACE
@@ -51,7 +51,6 @@ scala_toolchains(
 )
 
 register_toolchains(
-    "//testing:testing_toolchain",
     "//scala:unused_dependency_checker_error_toolchain",
     "//test/proto:scalapb_toolchain",
     "@io_bazel_rules_scala_toolchains//...:all",
diff --git a/scala/private/macros/toolchains.bzl b/scala/private/macros/toolchains.bzl
@@ -108,6 +108,11 @@ def scala_toolchains(
             scala_compiler_srcjars = scala_compiler_srcjars,
         )
 
+    if testing:
+        scalatest = True
+        junit = True
+        specs2 = True
+
     if scalatest:
         num_toolchains += 1
         scalatest_repositories(
diff --git a/scala/private/macros/toolchains_repo.bzl b/scala/private/macros/toolchains_repo.bzl
@@ -8,6 +8,7 @@ def _generate_testing_toolchain_build_file_args(repo_attr):
             "scalatest": "SCALATEST_DEPS",
             "junit": "JUNIT_DEPS",
             "specs2": "SPECS2_DEPS",
+            "specs2_junit": "SPECS2_JUNIT_DEPS",
         }
     if repo_attr.scalatest:
         framework_deps["scalatest"] = "SCALATEST_DEPS"
diff --git a/src/java/io/bazel/rulesscala/test_discovery/BUILD b/src/java/io/bazel/rulesscala/test_discovery/BUILD
@@ -8,5 +8,5 @@ scala_library(
         "FilteredRunnerBuilder.scala",
     ],
     visibility = ["//visibility:public"],
-    deps = ["@io_bazel_rules_scala//testing/toolchain:junit_classpath"],
+    deps = ["//testing/toolchain:junit_classpath"],
 )
diff --git a/testing/BUILD b/testing/BUILD
@@ -2,30 +2,18 @@ load("//scala:scala_cross_version.bzl", "version_suffix")
 load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
 
 # Aliases for backward compatibility:
-alias(
-    name = "testing_toolchain",
-    actual = (
-        "@io_bazel_rules_scala_toolchains//testing:testing_toolchain" +
-        version_suffix(SCALA_VERSION)
-    ),
-)
-
-alias(
-    name = "scalatest_toolchain",
-    actual = (
-        "@io_bazel_rules_scala_toolchains//scalatest:scalatest_toolchain" +
-        version_suffix(SCALA_VERSION)
-    ),
-)
-
-alias(
-    name = "specs2_junit_toolchain",
-    actual = (
-        "@io_bazel_rules_scala_toolchains//specs2:specs2_junit_toolchain"
-    ),
-)
-
-alias(
-    name = "junit_toolchain",
-    actual = "@io_bazel_rules_scala_toolchains//junit:junit_toolchain",
-)
+[
+    alias(
+        name = framework + "_toolchain",
+        actual = (
+            "@io_bazel_rules_scala_toolchains//testing:testing_toolchain" +
+            version_suffix(SCALA_VERSION)
+        ),
+    )
+    for framework in [
+        "testing",
+        "scalatest",
+        "specs2_junit",
+        "junit",
+    ]
+]
diff --git a/testing/junit.bzl b/testing/junit.bzl
@@ -1,7 +1,8 @@
 load("//junit:junit.bzl", _repositories = "junit_repositories")
+load("//testing/toolchain:toolchain.bzl", "register_testing_toolchains")
 
 def junit_repositories(**kwargs):
     _repositories(**kwargs)
 
 def junit_toolchain():
-    native.register_toolchains("@io_bazel_rules_scala//testing:junit_toolchain")
+    register_testing_toolchains()
diff --git a/testing/scalatest.bzl b/testing/scalatest.bzl
@@ -1,10 +1,8 @@
 load("//scalatest:scalatest.bzl", _repositories = "scalatest_repositories")
-load("//scala:scala_cross_version.bzl", "version_suffix")
-load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
+load("//testing/toolchain:toolchain.bzl", "register_testing_toolchains")
 
 def scalatest_repositories():
     _repositories()
 
 def scalatest_toolchain():
-    for scala_version in SCALA_VERSIONS:
-        native.register_toolchains("@io_bazel_rules_scala//testing:scalatest_toolchain" + version_suffix(scala_version))
+    register_testing_toolchains()
diff --git a/testing/specs2_junit.bzl b/testing/specs2_junit.bzl
@@ -1,7 +1,8 @@
 load("//specs2:specs2_junit.bzl", _repositories = "specs2_junit_repositories")
+load("//testing/toolchain:toolchain.bzl", "register_testing_toolchains")
 
 def specs2_junit_repositories():
     _repositories()
 
 def specs2_junit_toolchain():
-    native.register_toolchains("@io_bazel_rules_scala//testing:specs2_junit_toolchain")
+    register_testing_toolchains()
diff --git a/testing/testing.bzl b/testing/testing.bzl
@@ -1,9 +1,6 @@
-load("@io_bazel_rules_scala//scala:providers.bzl", "declare_deps_provider")
-load(
-    "@io_bazel_rules_scala//testing/toolchain:toolchain.bzl",
-    "scala_testing_toolchain",
-)
+load("//scala:providers.bzl", "declare_deps_provider")
 load("//scala:scala_cross_version.bzl", "repositories", "version_suffix")
+load("//testing/toolchain:toolchain.bzl", "scala_testing_toolchain")
 load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
 
 DEP_PROVIDERS = [
diff --git a/testing/toolchain/toolchain.bzl b/testing/toolchain/toolchain.bzl
@@ -14,3 +14,19 @@ scala_testing_toolchain = rule(
         ),
     },
 )
+
+def register_testing_toolchains(name = None):
+    """DO NOT USE: Registers all testing toolchains for WORKSPACE builds.
+
+    This exists solely for backwards compatibility with existing
+    `{scalatest,junit,specs2_junit}_toolchain` users. New users should prefer to
+    use the following in their `WORKSPACE` files:
+
+    ```starlark
+    register_toolchains("@io_bazel_rules_scala_toolchains//...:all")
+    ```
+
+    Bzlmod users need not do this; the rules_scala `MODULE.bazel` does this
+    automatically.
+    """
+    native.register_toolchains("@io_bazel_rules_scala_toolchains//testing:all")

Original file line number	Diff line number	Diff line change
`@@ -65,9 +65,7 @@ use_repo(`
`65`	`65`	`"scala_compiler_sources",`
`66`	`66`	`)`
`67`	`67`
`68`		`-register_toolchains(`
`69`		`- "@io_bazel_rules_scala_toolchains//...:all",`
`70`		`-)`
	`68`	`+register_toolchains("@io_bazel_rules_scala_toolchains//...:all")`
`71`	`69`
`72`	`70`	`# Dev dependencies`
`73`	`71`
`@@ -234,4 +232,4 @@ use_repo(`
`234`	`232`	`"org_golang_x_tools",`
`235`	`233`	`)`
`236`	`234`
`237`		`-bazel_dep(name = "rules_python", version = "0.35.0", dev_dependency = True)`
	`235`	`+bazel_dep(name = "rules_python", version = "0.36.0", dev_dependency = True)`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,6 @@ scala_toolchains(`
`51`	`51`	`)`
`52`	`52`
`53`	`53`	`register_toolchains(`
`54`		`- "//testing:testing_toolchain",`
`55`	`54`	`"//scala:unused_dependency_checker_error_toolchain",`
`56`	`55`	`"//test/proto:scalapb_toolchain",`
`57`	`56`	`"@io_bazel_rules_scala_toolchains//...:all",`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ def _generate_testing_toolchain_build_file_args(repo_attr):`
`8`	`8`	`"scalatest": "SCALATEST_DEPS",`
`9`	`9`	`"junit": "JUNIT_DEPS",`
`10`	`10`	`"specs2": "SPECS2_DEPS",`
	`11`	`+ "specs2_junit": "SPECS2_JUNIT_DEPS",`
`11`	`12`	`}`
`12`	`13`	`if repo_attr.scalatest:`
`13`	`14`	`framework_deps["scalatest"] = "SCALATEST_DEPS"`
Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,5 @@ scala_library(`
`8`	`8`	`"FilteredRunnerBuilder.scala",`
`9`	`9`	`],`
`10`	`10`	`visibility = ["//visibility:public"],`
`11`		`- deps = ["@io_bazel_rules_scala//testing/toolchain:junit_classpath"],`
	`11`	`+ deps = ["//testing/toolchain:junit_classpath"],`
`12`	`12`	`)`