Distinguish patched versions

Author: fmeum

src/test/py/bazel/bzlmod/bazel_lockfile_test.py

@@ -44,16 +44,16 @@ def setUp(self):
         [
             # In ipv6 only network, this has to be enabled.
             # 'startup --host_jvm_args=-Djava.net.preferIPv6Addresses=true',
-            'build --experimental_isolated_extension_usages',
-            'build --registry=' + self.main_registry.getURL(),
+            'common --experimental_isolated_extension_usages',
+            'common --registry=' + self.main_registry.getURL(),
             # We need to have BCR here to make sure built-in modules like
             # bazel_tools can work.
-            'build --registry=https://bcr.bazel.build',
-            'build --verbose_failures',
+            'common --registry=https://bcr.bazel.build',
+            'common --verbose_failures',
             # Set an explicit Java language version
-            'build --java_language_version=8',
-            'build --tool_java_language_version=8',
-            'build --lockfile_mode=update',
+            'common --java_language_version=8',
+            'common --tool_java_language_version=8',
+            'common --lockfile_mode=update',
         ],
     )
     # TODO(pcloudy): investigate why this is needed, MODULE.bazel.lock is not

src/test/py/bazel/bzlmod/bazel_module_test.py

@@ -26,6 +26,7 @@
 from src.test.py.bazel import test_base
 from src.test.py.bazel.bzlmod.test_utils import BazelRegistry
 from src.test.py.bazel.bzlmod.test_utils import integrity
+from src.test.py.bazel.bzlmod.test_utils import queryTargetAttr
 from src.test.py.bazel.bzlmod.test_utils import read
 from src.test.py.bazel.bzlmod.test_utils import scratchFile
 
@@ -114,13 +115,6 @@ def writeMainProjectFiles(self):
         executable=True,
     )
 
-  def getTargetAttr(self, target, attr_name):
-    _, stdout, _ = self.RunBazel(['query', '--output=streamed_jsonproto', target])
-    query_json = json.loads('\n'.join(stdout))
-    attrs = [attr for attr in query_json["rule"]["attribute"] if attr["name"] == attr_name]
-    self.assertEqual(len(attrs), 1)
-    return attrs[0]
-
   def testSimple(self):
     self.ScratchFile('MODULE.bazel', [
         'bazel_dep(name = "aaa", version = "1.0")',
@@ -150,10 +144,10 @@ def testSimple(self):
     self.assertIn('main function => aaa@1.0', stdout)
 
     # Verify the default package metadata.
-    package_metadata = self.getTargetAttr('@aaa//:lib_aaa', 'package_metadata')['stringListValue']
+    package_metadata = queryTargetAttr(self, '@aaa//:lib_aaa', 'package_metadata')['stringListValue']
     self.assertEqual(len(package_metadata), 1)
     package_metadata_target = package_metadata[0]
-    purl = self.getTargetAttr(package_metadata_target, 'purl')['stringValue']
+    purl = queryTargetAttr(self, package_metadata_target, 'purl')['stringValue']
     self.assertEqual(purl, 'pkg:bazel/aaa@1.0')
 
   def testSimpleTransitive(self):

src/test/py/bazel/bzlmod/bazel_overrides_test.py

@@ -21,6 +21,7 @@
 from absl.testing import absltest
 from src.test.py.bazel import test_base
 from src.test.py.bazel.bzlmod.test_utils import BazelRegistry
+from src.test.py.bazel.bzlmod.test_utils import queryTargetAttr
 
 
 class BazelOverridesTest(test_base.TestBase):
@@ -46,15 +47,15 @@ def setUp(self):
         [
             # In ipv6 only network, this has to be enabled.
             # 'startup --host_jvm_args=-Djava.net.preferIPv6Addresses=true',
-            'build --registry=' + self.main_registry.getURL(),
+            'common --registry=' + self.main_registry.getURL(),
             # We need to have BCR here to make sure built-in modules like
             # bazel_tools can work.
-            'build --registry=https://bcr.bazel.build',
-            'build --verbose_failures',
+            'common --registry=https://bcr.bazel.build',
+            'common --verbose_failures',
             # Set an explicit Java language version
-            'build --java_language_version=8',
-            'build --tool_java_language_version=8',
-            'build --lockfile_mode=update',
+            'common --java_language_version=8',
+            'common --tool_java_language_version=8',
+            'common --lockfile_mode=update',
         ],
     )
 
@@ -125,6 +126,13 @@ def testSingleVersionOverrideWithPatch(self):
     self.assertIn('main function => bbb@1.1', stdout)
     self.assertIn('bbb@1.1 => aaa@1.0 (locally patched)', stdout)
 
+    # Verify the default package metadata.
+    package_metadata = queryTargetAttr(self, '@aaa//:lib_aaa', 'package_metadata')['stringListValue']
+    self.assertEqual(len(package_metadata), 1)
+    package_metadata_target = package_metadata[0]
+    purl = queryTargetAttr(self, package_metadata_target, 'purl')['stringValue']
+    self.assertEqual(purl, 'pkg:bazel/aaa@1.0.patched.2e17a4fe')
+
   def testSingleVersionOverrideWithPatchCmds(self):
     self.writeMainProjectFiles()
     self.ScratchFile(
@@ -153,6 +161,13 @@ def testSingleVersionOverrideWithPatchCmds(self):
         'bbb@1.1 => aaa@1.0 (locally patched with patch_cmds)', stdout
     )
 
+    # Verify the default package metadata.
+    package_metadata = queryTargetAttr(self, '@aaa//:lib_aaa', 'package_metadata')['stringListValue']
+    self.assertEqual(len(package_metadata), 1)
+    package_metadata_target = package_metadata[0]
+    purl = queryTargetAttr(self, package_metadata_target, 'purl')['stringValue']
+    self.assertEqual(purl, 'pkg:bazel/aaa@1.0.patched.1a1372d')
+
   def testSingleVersionOverrideWithPatchAndPatchCmds(self):
     self.writeMainProjectFiles()
     self.ScratchFile(
@@ -186,6 +201,14 @@ def testSingleVersionOverrideWithPatchAndPatchCmds(self):
         stdout,
     )
 
+
+    # Verify the default package metadata.
+    package_metadata = queryTargetAttr(self, '@aaa//:lib_aaa', 'package_metadata')['stringListValue']
+    self.assertEqual(len(package_metadata), 1)
+    package_metadata_target = package_metadata[0]
+    purl = queryTargetAttr(self, package_metadata_target, 'purl')['stringValue']
+    self.assertEqual(purl, 'pkg:bazel/aaa@1.0.patched.1efd6af1')
+
   def testSingleVersionOverrideVersionTooLow(self):
     self.writeMainProjectFiles()
     self.ScratchFile(

src/test/py/bazel/bzlmod/bazel_repo_mapping_test.py

@@ -43,17 +43,17 @@ def setUp(self):
         [
             # In ipv6 only network, this has to be enabled.
             # 'startup --host_jvm_args=-Djava.net.preferIPv6Addresses=true',
-            'build --registry=' + self.main_registry.getURL(),
+            'common --registry=' + self.main_registry.getURL(),
             # We need to have BCR here to make sure built-in modules like
             # bazel_tools can work.
-            'build --registry=https://bcr.bazel.build',
-            'build --verbose_failures',
+            'common --registry=https://bcr.bazel.build',
+            'common --verbose_failures',
             # Set an explicit Java language version
-            'build --java_language_version=8',
-            'build --tool_java_language_version=8',
-            'build --lockfile_mode=update',
+            'common --java_language_version=8',
+            'common --tool_java_language_version=8',
+            'common --lockfile_mode=update',
             (  # fmt: skip pylint: disable=line-too-long
-                'build'
+                'common'
                 ' --extra_toolchains=@bazel_tools//tools/python:autodetecting_toolchain'
             ),
         ],

src/test/py/bazel/bzlmod/bazel_yanked_versions_test.py

@@ -64,21 +64,21 @@ def writeBazelrcFile(self, allow_yanked_versions=True):
         [
             # In ipv6 only network, this has to be enabled.
             # 'startup --host_jvm_args=-Djava.net.preferIPv6Addresses=true',
-            'build --registry=' + self.main_registry.getURL(),
+            'common --registry=' + self.main_registry.getURL(),
             # We need to have BCR here to make sure built-in modules like
             # bazel_tools can work.
-            'build --registry=https://bcr.bazel.build',
-            'build --verbose_failures',
+            'common --registry=https://bcr.bazel.build',
+            'common --verbose_failures',
             # Set an explicit Java language version
-            'build --java_language_version=8',
-            'build --tool_java_language_version=8',
-            'build --lockfile_mode=update',
+            'common --java_language_version=8',
+            'common --tool_java_language_version=8',
+            'common --lockfile_mode=update',
         ]
         + (
             [
                 # Disable yanked version check so we are not affected BCR
                 # changes.
-                'build --allow_yanked_versions=all',
+                'common --allow_yanked_versions=all',
             ]
             if allow_yanked_versions
             else []

src/test/py/bazel/bzlmod/mod_command_test.py

@@ -43,14 +43,14 @@ def setUp(self):
         [
             # In ipv6 only network, this has to be enabled.
             # 'startup --host_jvm_args=-Djava.net.preferIPv6Addresses=true',
-            'mod --registry=' + self.main_registry.getURL(),
+            'common --registry=' + self.main_registry.getURL(),
             # We need to have BCR here to make sure built-in modules like
             # bazel_tools can work.
-            'mod --registry=https://bcr.bazel.build',
+            'common --registry=https://bcr.bazel.build',
             # Disable yanked version check so we are not affected BCR changes.
-            'mod --allow_yanked_versions=all',
+            'common --allow_yanked_versions=all',
             # Make sure Bazel CI tests pass in all environments
-            'mod --charset=ascii',
+            'common --charset=ascii',
         ],
     )
 

src/test/py/bazel/bzlmod/repo_contents_cache_test.py

@@ -32,7 +32,7 @@ def setUp(self):
     self.ScratchFile(
         '.bazelrc',
         [
-            'build --verbose_failures',
+            'common --verbose_failures',
             'common --repo_contents_cache=%s' % self.repo_contents_cache,
         ],
     )

src/test/py/bazel/bzlmod/test_utils.py

@@ -55,6 +55,15 @@ def scratchFile(path, lines=None):
         f.write(l)
         f.write('\n')
 
+def queryTargetAttr(test_base, target, attr_name):
+  """Returns the attribute info returned by a query for a particular target and attribute."""
+  _, stdout, _ = test_base.RunBazel(['query', '--output=streamed_jsonproto', target])
+  test_base.assertEqual(len(stdout), 1)
+  query_json = json.loads(stdout[0])
+  attrs = [attr for attr in query_json["rule"]["attribute"] if attr["name"] == attr_name]
+  test_base.assertEqual(len(attrs), 1)
+  return attrs[0]
+
 
 class Module:
   """A class to represent information of a Bazel module."""

tools/build_defs/repo/utils.bzl

@@ -280,12 +280,20 @@ def patch(ctx, patches = None, patch_cmds = None, patch_cmds_win = None, patch_t
         # Ensure that local patches (applied via single_version_override) result
         # in a different version number than unmodified registry modules.
         if patches or patch_cmds:
-            hash = hash((patch_cmds, patch_args))
-            for patch in patches:
-                hash = ctx.read(ctx.path(patch))
+            hashes = [hash(ctx.read(ctx.path(patch))) for patch in patches]
+            hashes += [hash(cmd) for cmd in patch_cmds]
+            hashes += [hash(arg) for arg in patch_args]
+            combined_hash = abs(hash(" ".join([str(h) for h in hashes])))
+            purl_fragments = dict(purl_fragments)
+            # Additional segments can be appended to both the release and
+            # prerelease part. Modules in Bazel registries never have build
+            # metadata (the + part of semver) as Bazel drops this before
+            # requesting a module version.
+            purl_fragments["version"] += ".patched.%x" % combined_hash
         ctx.file(
             ".bazel_package_metadata/BUILD.bazel",
-            """# Generated by Bazel. Add a custom REPO.bazel file to disable generation.
+            """# Generated by Bazel.
+# Add a custom REPO.bazel file to disable generation.
 
 package(default_visibility = ["//:__subpackages__"])
 
@@ -302,7 +310,8 @@ package_metadata(
         )
         ctx.file(
             "REPO.bazel",
-            """# Generated by Bazel. Add a custom REPO.bazel file to disable generation.
+            """# Generated by Bazel.
+# Add a custom REPO.bazel file to disable generation.
 
 repo(default_package_metadata = ["//.bazel_package_metadata:package_metadata"])
 """,