Fix setup_scala_testing_toolchain() classpaths (bazel-contrib#1707)

mbland · web-flow · commit cd1bf158fc4d · 2025-02-28T10:14:28.000+02:00
* Fix `setup_scala_testing_toolchain()` classpaths Fixes bazel-contrib#1706. Removes the addition of the Scala version suffix to `*_classpath` argument labels in `setup_scala_testing_toolchain()`. To facilitate the fix: - Moves everything from `testing/deps.bzl` into `testing/testing.bzl` and removes the original `testing/deps.bzl` file. - Updates `repositories()` from `scala/scala_cross_version.bzl` to accept and return `None` as an argument. - Updates `examples/testing/multi_frameworks_toolchain/BUILD` to provide a reproduction and validation of the fix. After updating `multi_frameworks_toolchain/BUILD`, but before applying the fix, the `multi_framework_toolchain_example` test case broke in a similar fashion to bazel-contrib#1706: ```txt $ RULES_SCALA_TEST_ONLY=multi_framework_toolchain_example \ ./test_examples.sh running test multi_framework_toolchain_example ERROR: .../examples/testing/multi_frameworks_toolchain/BUILD:19:30: no such package '@io_bazel_rules_scala_org_specs2_specs2_fp_2_12_20_2_12_20//': The repository '@io_bazel_rules_scala_org_specs2_specs2_fp_2_12_20_2_12_20' could not be resolved: Repository '@io_bazel_rules_scala_org_specs2_specs2_fp_2_12_20_2_12_20' is not defined and referenced by '//:testing_toolchain_specs2_classpath_provider' ERROR: Analysis of target '//:testing_toolchain_specs2_classpath_provider' failed; build aborted: Analysis failed INFO: Elapsed time: 0.159s INFO: 0 processes. ERROR: Couldn't start the build. Unable to run tests ``` * Fix `repositories()` docstring grammatical error
diff --git a/examples/testing/multi_frameworks_toolchain/BUILD b/examples/testing/multi_frameworks_toolchain/BUILD
@@ -1,35 +1,60 @@
+load("@rules_scala//scala:scala_cross_version.bzl", "repositories")
 load(
     "@rules_scala//testing:testing.bzl",
     "setup_scala_testing_toolchain",
 )
+load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
 
+# This example uses the same toolchain deps you'd get from using
+# `scala_toolchains(junit = True, scalatest = True, specs2 = True)`. It's a
+# working example that we test via `test_examples.sh` that avoids introducing a
+# dependency on `rules_jvm_external` (for now).
+#
+# Normally, you'd use `rules_jvm_external` and references to artifacts like
+# `@maven//:org_scalatest_scalatest_shouldmatchers_2_13` to define custom
+# classpaths.
+#
+# You would _not_ need to load `repositories` or `SCALA_VERSION`. This example
+# needs them to test against a regression of #1706.
 setup_scala_testing_toolchain(
     name = "testing_toolchain",
-    junit_classpath = [
-        "@io_bazel_rules_scala_junit_junit",
-        "@io_bazel_rules_scala_org_hamcrest_hamcrest_core",
-    ],
-    scalatest_classpath = [
-        "@io_bazel_rules_scala_scalactic",
-        "@io_bazel_rules_scala_scalatest",
-        "@io_bazel_rules_scala_scalatest_compatible",
-        "@io_bazel_rules_scala_scalatest_core",
-        "@io_bazel_rules_scala_scalatest_featurespec",
-        "@io_bazel_rules_scala_scalatest_flatspec",
-        "@io_bazel_rules_scala_scalatest_freespec",
-        "@io_bazel_rules_scala_scalatest_funspec",
-        "@io_bazel_rules_scala_scalatest_funsuite",
-        "@io_bazel_rules_scala_scalatest_matchers_core",
-        "@io_bazel_rules_scala_scalatest_mustmatchers",
-        "@io_bazel_rules_scala_scalatest_shouldmatchers",
-    ],
-    specs2_classpath = [
-        "@io_bazel_rules_scala_org_specs2_specs2_common",
-        "@io_bazel_rules_scala_org_specs2_specs2_core",
-        "@io_bazel_rules_scala_org_specs2_specs2_fp",
-        "@io_bazel_rules_scala_org_specs2_specs2_matcher",
-    ],
-    specs2_junit_classpath = [
-        "@io_bazel_rules_scala_org_specs2_specs2_junit",
-    ],
+    junit_classpath = repositories(
+        SCALA_VERSION,
+        [
+            "@io_bazel_rules_scala_junit_junit",
+            "@io_bazel_rules_scala_org_hamcrest_hamcrest_core",
+        ],
+    ),
+    scalatest_classpath = repositories(
+        SCALA_VERSION,
+        [
+            "@io_bazel_rules_scala_scalactic",
+            "@io_bazel_rules_scala_scalatest",
+            "@io_bazel_rules_scala_scalatest_compatible",
+            "@io_bazel_rules_scala_scalatest_core",
+            "@io_bazel_rules_scala_scalatest_featurespec",
+            "@io_bazel_rules_scala_scalatest_flatspec",
+            "@io_bazel_rules_scala_scalatest_freespec",
+            "@io_bazel_rules_scala_scalatest_funspec",
+            "@io_bazel_rules_scala_scalatest_funsuite",
+            "@io_bazel_rules_scala_scalatest_matchers_core",
+            "@io_bazel_rules_scala_scalatest_mustmatchers",
+            "@io_bazel_rules_scala_scalatest_shouldmatchers",
+        ],
+    ),
+    specs2_classpath = repositories(
+        SCALA_VERSION,
+        [
+            "@io_bazel_rules_scala_org_specs2_specs2_common",
+            "@io_bazel_rules_scala_org_specs2_specs2_core",
+            "@io_bazel_rules_scala_org_specs2_specs2_fp",
+            "@io_bazel_rules_scala_org_specs2_specs2_matcher",
+        ],
+    ),
+    specs2_junit_classpath = repositories(
+        SCALA_VERSION,
+        [
+            "@io_bazel_rules_scala_org_specs2_specs2_junit",
+        ],
+    ),
 )
diff --git a/scala/scala_cross_version.bzl b/scala/scala_cross_version.bzl
@@ -53,7 +53,22 @@ def version_suffix(scala_version):
     return "_" + sanitize_version(scala_version)
 
 def repositories(scala_version, repos):
-    """Adds the Scala version suffix to a list of repository IDs."""
+    """Adds the Scala version suffix to a list of repository IDs.
+
+    If `repos` is `None`, this will return `None`. This enables the massaging of
+    optional function arguments.
+
+    Args:
+        scala_version: the Scala version to append to each repo name
+        repos: list of repository names
+
+    Returns:
+        a list of repository names with the Scala version suffix appended, or
+        `None` if `repos` is `None`
+    """
+    if repos == None:
+        return None
+
     suffix = version_suffix(scala_version)
     return [repo + suffix for repo in repos]
 
diff --git a/scala/toolchains_repo.bzl b/scala/toolchains_repo.bzl
@@ -155,13 +155,14 @@ load(
 """
 
 _TESTING_TOOLCHAIN_BUILD = """
-load("@@{rules_scala_repo}//scala:scala_cross_version.bzl", "version_suffix")
 load(
-    "@@{rules_scala_repo}//testing:deps.bzl",
-    "{deps_symbols}",
+    "@@{rules_scala_repo}//scala:scala_cross_version.bzl",
+    "repositories",
+    "version_suffix",
 )
 load(
     "@@{rules_scala_repo}//testing:testing.bzl",
+    "{deps_symbols}",
     "setup_scala_testing_toolchain",
 )
 load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
@@ -170,10 +171,10 @@ load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
     setup_scala_testing_toolchain(
         name = "testing_toolchain" + version_suffix(scala_version),
         scala_version = scala_version,
-        scalatest_classpath = {scalatest},
-        junit_classpath = {junit},
-        specs2_classpath = {specs2},
-        specs2_junit_classpath = {specs2_junit},
+        scalatest_classpath = repositories(scala_version, {scalatest}),
+        junit_classpath = repositories(scala_version, {junit}),
+        specs2_classpath = repositories(scala_version, {specs2}),
+        specs2_junit_classpath = repositories(scala_version, {specs2_junit}),
     )
     for scala_version in SCALA_VERSIONS
 ]
diff --git a/testing/deps.bzl b/testing/deps.bzl
diff --git a/testing/testing.bzl b/testing/testing.bzl
@@ -1,8 +1,23 @@
+load("//junit:junit.bzl", "junit_artifact_ids")
 load("//scala:providers.bzl", "declare_deps_provider")
-load("//scala:scala_cross_version.bzl", "repositories", "version_suffix")
+load("//scala:scala_cross_version.bzl", "version_suffix")
+load("//scalatest:scalatest.bzl", "scalatest_artifact_ids")
+load("//specs2:specs2.bzl", "specs2_artifact_ids")
+load("//specs2:specs2_junit.bzl", "specs2_junit_artifact_ids")
 load("//testing/toolchain:toolchain.bzl", "scala_testing_toolchain")
 load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
 
+def _repoize(ids):
+    return ["@" + id for id in ids]
+
+JUNIT_DEPS = _repoize(junit_artifact_ids())
+
+SCALATEST_DEPS = _repoize(scalatest_artifact_ids())
+
+SPECS2_DEPS = _repoize(specs2_artifact_ids())
+
+SPECS2_JUNIT_DEPS = _repoize(specs2_junit_artifact_ids())
+
 DEP_PROVIDERS = [
     "junit_classpath",
     "scalatest_classpath",
@@ -35,7 +50,7 @@ def setup_scala_testing_toolchain(
             _declare_deps_provider(
                 name,
                 "junit_classpath",
-                repositories(scala_version, junit_classpath),
+                junit_classpath,
                 visibility,
             ),
         )
@@ -45,7 +60,7 @@ def setup_scala_testing_toolchain(
             _declare_deps_provider(
                 name,
                 "specs2_junit_classpath",
-                repositories(scala_version, specs2_junit_classpath),
+                specs2_junit_classpath,
                 visibility,
             ),
         )
@@ -55,7 +70,7 @@ def setup_scala_testing_toolchain(
             _declare_deps_provider(
                 name,
                 "specs2_classpath",
-                repositories(scala_version, specs2_classpath),
+                specs2_classpath,
                 visibility,
             ),
         )
@@ -65,7 +80,7 @@ def setup_scala_testing_toolchain(
             _declare_deps_provider(
                 name,
                 "scalatest_classpath",
-                repositories(scala_version, scalatest_classpath),
+                scalatest_classpath,
                 visibility,
             ),
         )
