test: add @bazel/runfiles test (#1895)

aspect-build · Oct 4, 2024 · 0cf77d9 · 0cf77d9
1 parent 3278fb7
commit 0cf77d9
Show file tree

Hide file tree

Showing 31 changed files with 2,151 additions and 1,807 deletions.
diff --git a/.aspect/rules/external_repository_action_cache/npm_translate_lock_LTE4Nzc1MDcwNjU= b/.aspect/rules/external_repository_action_cache/npm_translate_lock_LTE4Nzc1MDcwNjU=
@@ -1,5 +1,5 @@
 # @generated
-# Input hashes for repository rule npm_translate_lock(name = "npm", pnpm_lock = "@//:pnpm-lock.yaml").
+# Input hashes for repository rule npm_translate_lock(name = "npm", pnpm_lock = "@@//:pnpm-lock.yaml").
 # This file should be checked into version control along with the pnpm-lock.yaml file.
 .npmrc=-2065072158
 examples/js_binary/package.json=-41174383
@@ -15,6 +15,7 @@ examples/npm_package/packages/pkg_a/package.json=1006424040
 examples/npm_package/packages/pkg_b/package.json=1041247977
 examples/npm_package/packages/pkg_d/package.json=1110895851
 examples/npm_package/packages/pkg_e/package.json=-2145239245
+examples/runfiles/package.json=-1545884645
 examples/webpack_cli/package.json=1911342006
 js/private/coverage/bundle/package.json=-1543718929
 js/private/image/package.json=-1260474848
@@ -28,5 +29,5 @@ npm/private/test/vendored/is-odd/package.json=1041695223
 npm/private/test/vendored/lodash-4.17.21.tgz=-1206623349
 npm/private/test/vendored/semver-max/package.json=578664053
 package.json=-275319675
-pnpm-lock.yaml=1584807079
+pnpm-lock.yaml=814447031
 pnpm-workspace.yaml=-762451270
diff --git a/.aspect/workflows/config.yaml b/.aspect/workflows/config.yaml
@@ -6,16 +6,16 @@ workspaces:
         tasks:
             - test:
                   bazel:
-                        flags:
-                              - --config=aspect_rbe
+                      flags:
+                          - --config=aspect_rbe
     e2e/bzlmod:
         icon: bazel
         tasks:
             - test:
                   queue: aspect-default
                   bazel:
-                        flags:
-                              - --config=aspect_rbe                  
+                      flags:
+                          - --config=aspect_rbe
             - format:
                   without: true
             - buildifier:
@@ -30,8 +30,8 @@ workspaces:
             - test:
                   queue: aspect-medium
                   bazel:
-                        flags:
-                              - --config=aspect_rbe                  
+                      flags:
+                          - --config=aspect_rbe
             - format:
                   without: true
             - buildifier:
@@ -49,8 +49,8 @@ workspaces:
             - test:
                   queue: aspect-default
                   bazel:
-                        flags:
-                              - --config=aspect_rbe                  
+                      flags:
+                          - --config=aspect_rbe
             - format:
                   without: true
             - buildifier:
@@ -93,8 +93,8 @@ workspaces:
             - test:
                   queue: aspect-medium
                   bazel:
-                        flags:
-                              - --config=aspect_rbe                  
+                      flags:
+                          - --config=aspect_rbe
             - format:
                   without: true
             - buildifier:
@@ -109,8 +109,8 @@ workspaces:
             - test:
                   queue: aspect-medium
                   bazel:
-                        flags:
-                              - --config=aspect_rbe                  
+                      flags:
+                          - --config=aspect_rbe
             - format:
                   without: true
             - buildifier:
@@ -125,8 +125,8 @@ workspaces:
             - test:
                   queue: aspect-medium
                   bazel:
-                        flags:
-                              - --config=aspect_rbe                  
+                      flags:
+                          - --config=aspect_rbe
             - format:
                   without: true
             - buildifier:
@@ -223,8 +223,8 @@ workspaces:
             - test:
                   queue: aspect-medium
                   bazel:
-                        flags:
-                              - --config=aspect_rbe                  
+                      flags:
+                          - --config=aspect_rbe
             - format:
                   without: true
             - buildifier:
@@ -239,8 +239,8 @@ workspaces:
             - test:
                   queue: aspect-medium
                   bazel:
-                        flags:
-                              - --config=aspect_rbe                  
+                      flags:
+                          - --config=aspect_rbe
             - format:
                   without: true
             - buildifier:
@@ -255,8 +255,8 @@ workspaces:
             - test:
                   queue: aspect-medium
                   bazel:
-                        flags:
-                              - --config=aspect_rbe                  
+                      flags:
+                          - --config=aspect_rbe
             - format:
                   without: true
             - buildifier:
@@ -271,8 +271,24 @@ workspaces:
             - test:
                   queue: aspect-medium
                   bazel:
-                        flags:
-                              - --config=aspect_rbe                  
+                      flags:
+                          - --config=aspect_rbe
+            - format:
+                  without: true
+            - buildifier:
+                  without: true
+            - configure:
+                  without: true
+            - delivery:
+                  without: true
+    e2e/runfiles:
+        icon: js
+        tasks:
+            - test:
+                  queue: aspect-medium
+                  bazel:
+                      flags:
+                          - --config=aspect_rbe
             - format:
                   without: true
             - buildifier:
@@ -287,8 +303,8 @@ workspaces:
             - test:
                   queue: aspect-medium
                   bazel:
-                        flags:
-                              - --config=aspect_rbe                  
+                      flags:
+                          - --config=aspect_rbe
             - format:
                   without: true
             - buildifier:

diff --git a/.bazelignore b/.bazelignore
@@ -12,6 +12,7 @@ examples/npm_package/packages/pkg_b/node_modules/
 examples/npm_package/packages/pkg_c/node_modules/
 examples/npm_package/packages/pkg_d/node_modules/
 examples/npm_package/packages/pkg_e/node_modules/
+examples/runfiles/node_modules
 examples/webpack_cli/node_modules/
 js/private/coverage/bundle/node_modules
 js/private/image/node_modules

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -60,6 +60,7 @@ jobs:
                     e2e/pnpm_workspace
                     e2e/pnpm_workspace_deps
                     e2e/pnpm_workspace_rerooted
+                    e2e/runfiles
                     e2e/rules_foo
                     e2e/stamped_package_json
                     e2e/update_pnpm_lock

diff --git a/.github/workflows/release_prep.sh b/.github/workflows/release_prep.sh
@@ -33,7 +33,7 @@ bazel_dep(name = "aspect_rules_js", version = "${TAG:1}")
 ####### Node.js version #########
 # By default you get the node version from DEFAULT_NODE_VERSION in @rules_nodejs//nodejs:repositories.bzl
 # Optionally you can pin a different node version:
-bazel_dep(name = "rules_nodejs", version = "6.2.0")
+bazel_dep(name = "rules_nodejs", version = "6.3.0")
 node = use_extension("@rules_nodejs//nodejs:extensions.bzl", "node", dev_dependency = True)
 node.toolchain(node_version = "16.14.2")
 #################################

diff --git a/MODULE.bazel b/MODULE.bazel
@@ -13,7 +13,7 @@ bazel_dep(name = "aspect_bazel_lib", version = "2.7.7")
 bazel_dep(name = "bazel_features", version = "1.9.0")
 bazel_dep(name = "bazel_skylib", version = "1.5.0")
 bazel_dep(name = "platforms", version = "0.0.5")
-bazel_dep(name = "rules_nodejs", version = "6.2.0")
+bazel_dep(name = "rules_nodejs", version = "6.3.0")
 
 node = use_extension("@rules_nodejs//nodejs:extensions.bzl", "node")
 use_repo(node, "nodejs_darwin_amd64")
@@ -140,6 +140,7 @@ npm.npm_translate_lock(
         "//examples/npm_package/packages/pkg_b:package.json",
         "//examples/npm_package/packages/pkg_d:package.json",
         "//examples/npm_package/packages/pkg_e:package.json",
+        "//examples/runfiles:package.json",
         "//examples/webpack_cli:package.json",
         "//js/private/coverage/bundle:package.json",
         "//js/private/image:package.json",

diff --git a/WORKSPACE b/WORKSPACE
@@ -89,6 +89,7 @@ npm_translate_lock(
         "//examples/npm_package/packages/pkg_b:package.json",
         "//examples/npm_package/packages/pkg_d:package.json",
         "//examples/npm_package/packages/pkg_e:package.json",
+        "//examples/runfiles:package.json",
         "//examples/webpack_cli:package.json",
         "//js/private/coverage/bundle:package.json",
         "//js/private/image:package.json",

diff --git a/e2e/js_image_oci/MODULE.bazel b/e2e/js_image_oci/MODULE.bazel
@@ -7,7 +7,7 @@ local_path_override(
 bazel_dep(name = "aspect_bazel_lib", version = "2.7.7", dev_dependency = True)
 bazel_dep(name = "container_structure_test", version = "1.16.0", dev_dependency = True)
 bazel_dep(name = "platforms", version = "0.0.10", dev_dependency = True)
-bazel_dep(name = "rules_nodejs", version = "6.2.0", dev_dependency = True)
+bazel_dep(name = "rules_nodejs", version = "6.3.0", dev_dependency = True)
 bazel_dep(name = "rules_oci", version = "2.0.0-alpha2", dev_dependency = True)
 
 npm = use_extension("@aspect_rules_js//npm:extensions.bzl", "npm", dev_dependency = True)

diff --git a/e2e/pnpm_lockfiles/MODULE.bazel b/e2e/pnpm_lockfiles/MODULE.bazel
@@ -24,7 +24,7 @@ PNPM_LOCK_TEST_CASES = [
 bazel_dep(name = "aspect_bazel_lib", version = "2.7.7")
 
 bazel_dep(name = "bazel_skylib", version = "1.5.0", dev_dependency = True)
-bazel_dep(name = "rules_nodejs", version = "6.2.0", dev_dependency = True)
+bazel_dep(name = "rules_nodejs", version = "6.3.0", dev_dependency = True)
 
 bazel_dep(name = "platforms", version = "0.0.5")
 

diff --git a/e2e/pnpm_repo_install/MODULE.bazel b/e2e/pnpm_repo_install/MODULE.bazel
@@ -4,7 +4,7 @@ local_path_override(
     path = "../..",
 )
 
-bazel_dep(name = "rules_nodejs", version = "6.2.0", dev_dependency = True)
+bazel_dep(name = "rules_nodejs", version = "6.3.0", dev_dependency = True)
 
 node = use_extension(
     "@rules_nodejs//nodejs:extensions.bzl",

diff --git a/e2e/pnpm_workspace/MODULE.bazel b/e2e/pnpm_workspace/MODULE.bazel
@@ -8,7 +8,7 @@ local_path_override(
 
 bazel_dep(name = "aspect_bazel_lib", version = "2.7.7", dev_dependency = True)
 bazel_dep(name = "bazel_skylib", version = "1.5.0", dev_dependency = True)
-bazel_dep(name = "rules_nodejs", version = "6.2.0", dev_dependency = True)
+bazel_dep(name = "rules_nodejs", version = "6.3.0", dev_dependency = True)
 
 node = use_extension(
     "@rules_nodejs//nodejs:extensions.bzl",

diff --git a/e2e/pnpm_workspace_rerooted/MODULE.bazel b/e2e/pnpm_workspace_rerooted/MODULE.bazel
@@ -8,7 +8,7 @@ local_path_override(
 
 bazel_dep(name = "aspect_bazel_lib", version = "2.7.7", dev_dependency = True)
 bazel_dep(name = "bazel_skylib", version = "1.5.0", dev_dependency = True)
-bazel_dep(name = "rules_nodejs", version = "6.2.0", dev_dependency = True)
+bazel_dep(name = "rules_nodejs", version = "6.3.0", dev_dependency = True)
 
 node = use_extension(
     "@rules_nodejs//nodejs:extensions.bzl",

diff --git a/e2e/runfiles/.bazelignore b/e2e/runfiles/.bazelignore
@@ -0,0 +1 @@
+node_modules
diff --git a/e2e/runfiles/.npmrc b/e2e/runfiles/.npmrc
@@ -0,0 +1,4 @@
+# Disabling pnpm [hoisting](https://pnpm.io/npmrc#hoist) by setting `hoist=false` is recommended on
+# projects using rules_js so that pnpm outside of Bazel lays out a node_modules tree similar to what
+# rules_js lays out under Bazel (without a hidden node_modules/.pnpm/node_modules)
+hoist=false
diff --git a/e2e/runfiles/BUILD.bazel b/e2e/runfiles/BUILD.bazel
@@ -0,0 +1,23 @@
+load("@aspect_rules_js//js:defs.bzl", "js_test")
+load("@npm//:defs.bzl", "npm_link_all_packages")
+
+npm_link_all_packages()
+
+js_test(
+    name = "runfiles",
+    data = [
+        "test_fixture.md",
+        "test_fixture.md.generated_file_suffix",
+        ":node_modules/@bazel/runfiles",
+    ],
+    entry_point = "test.js",
+)
+
+# Path of file must start similar to `test_fixture.md` in order to regression-test a
+# scenario where the runfile resolution would accidentally resolve the path to
+# `test_fixture.md` through a runfile manifest entry that starts similarly.
+genrule(
+    name = "gen-data",
+    outs = ["test_fixture.md.generated_file_suffix"],
+    cmd = """echo "Generated" > $@""",
+)
diff --git a/e2e/runfiles/MODULE.bazel b/e2e/runfiles/MODULE.bazel
@@ -0,0 +1,22 @@
+module(name = "e2e_runfiles")
+
+bazel_dep(name = "aspect_rules_js", version = "0.0.0", dev_dependency = True)
+local_path_override(
+    module_name = "aspect_rules_js",
+    path = "../..",
+)
+
+bazel_dep(name = "aspect_bazel_lib", version = "2.7.7", dev_dependency = True)
+
+npm = use_extension(
+    "@aspect_rules_js//npm:extensions.bzl",
+    "npm",
+    dev_dependency = True,
+)
+npm.npm_translate_lock(
+    name = "npm",
+    npmrc = "//:.npmrc",
+    pnpm_lock = "//:pnpm-lock.yaml",
+    verify_node_modules_ignored = "//:.bazelignore",
+)
+use_repo(npm, "npm")
diff --git a/e2e/runfiles/WORKSPACE b/e2e/runfiles/WORKSPACE
@@ -0,0 +1,2 @@
+# The presence of this file causes WORKSPACE to be ignored when bzlmod is enabled.
+# See https://docs.google.com/document/d/1JtXIVnXyFZ4bmbiBCr5gsTH4-opZAFf5DMMb-54kES0/edit#heading=h.y054fjub9max
diff --git a/e2e/runfiles/package.json b/e2e/runfiles/package.json
@@ -0,0 +1,10 @@
+{
+    "name": "@examples/runfiles",
+    "private": true,
+    "dependencies": {
+        "@bazel/runfiles": "^6.3.0"
+    },
+    "pnpm": {
+        "onlyBuiltDependencies": []
+    }
+}
diff --git a/e2e/runfiles/pnpm-lock.yaml b/e2e/runfiles/pnpm-lock.yaml
diff --git a/e2e/runfiles/pnpm-workspace.yaml b/e2e/runfiles/pnpm-workspace.yaml
@@ -0,0 +1,2 @@
+packages:
+    - '.'