diff options
Diffstat (limited to 'examples/wheel/wheel_test.py')
| -rw-r--r-- | examples/wheel/wheel_test.py | 197 |
1 files changed, 132 insertions, 65 deletions
diff --git a/examples/wheel/wheel_test.py b/examples/wheel/wheel_test.py index f51a0ec..43fbe0c 100644 --- a/examples/wheel/wheel_test.py +++ b/examples/wheel/wheel_test.py @@ -12,25 +12,61 @@ # See the License for the specific language governing permissions and # limitations under the License. +import hashlib import os import platform import subprocess import unittest import zipfile +from python.runfiles import runfiles + class WheelTest(unittest.TestCase): maxDiff = None + def setUp(self): + super().setUp() + self.runfiles = runfiles.Create() + + def _get_path(self, filename): + runfiles_path = os.path.join("rules_python/examples/wheel", filename) + path = self.runfiles.Rlocation(runfiles_path) + # The runfiles API can return None if the path doesn't exist or + # can't be resolved. + if not path: + raise AssertionError(f"Runfiles failed to resolve {runfiles_path}") + elif not os.path.exists(path): + # A non-None value doesn't mean the file actually exists, though + raise AssertionError( + f"Path {path} does not exist (from runfiles path {runfiles_path}" + ) + else: + return path + + def assertFileSha256Equal(self, filename, want): + hash = hashlib.sha256() + with open(filename, "rb") as f: + while True: + buf = f.read(2**20) + if not buf: + break + hash.update(buf) + self.assertEqual(want, hash.hexdigest()) + + def assertAllEntriesHasReproducibleMetadata(self, zf): + for zinfo in zf.infolist(): + self.assertEqual(zinfo.date_time, (1980, 1, 1, 0, 0, 0), msg=zinfo.filename) + self.assertEqual(zinfo.create_system, 3, msg=zinfo.filename) + self.assertEqual(zinfo.external_attr, 0o777 << 16, msg=zinfo.filename) + self.assertEqual( + zinfo.compress_type, zipfile.ZIP_DEFLATED, msg=zinfo.filename + ) + def test_py_library_wheel(self): - filename = os.path.join( - os.environ["TEST_SRCDIR"], - "rules_python", - "examples", - "wheel", - "example_minimal_library-0.0.1-py3-none-any.whl", - ) + filename = self._get_path("example_minimal_library-0.0.1-py3-none-any.whl") with zipfile.ZipFile(filename) as zf: + self.assertAllEntriesHasReproducibleMetadata(zf) self.assertEqual( zf.namelist(), [ @@ -41,16 +77,16 @@ class WheelTest(unittest.TestCase): "example_minimal_library-0.0.1.dist-info/RECORD", ], ) + self.assertFileSha256Equal( + filename, "2818e70fdebd148934f41820f8c54d5d7676d783c0d66c7c8af2ee9141e7ddc7" + ) def test_py_package_wheel(self): - filename = os.path.join( - os.environ["TEST_SRCDIR"], - "rules_python", - "examples", - "wheel", + filename = self._get_path( "example_minimal_package-0.0.1-py3-none-any.whl", ) with zipfile.ZipFile(filename) as zf: + self.assertAllEntriesHasReproducibleMetadata(zf) self.assertEqual( zf.namelist(), [ @@ -63,16 +99,16 @@ class WheelTest(unittest.TestCase): "example_minimal_package-0.0.1.dist-info/RECORD", ], ) + self.assertFileSha256Equal( + filename, "273e27adf9bf90287a42ac911dcece8aa95f2905c37d786725477b26de23627c" + ) def test_customized_wheel(self): - filename = os.path.join( - os.environ["TEST_SRCDIR"], - "rules_python", - "examples", - "wheel", + filename = self._get_path( "example_customized-0.0.1-py3-none-any.whl", ) with zipfile.ZipFile(filename) as zf: + self.assertAllEntriesHasReproducibleMetadata(zf) self.assertEqual( zf.namelist(), [ @@ -99,16 +135,16 @@ class WheelTest(unittest.TestCase): record_contents, # The entries are guaranteed to be sorted. b"""\ -example_customized-0.0.1.dist-info/METADATA,sha256=QYQcDJFQSIqan8eiXqL67bqsUfgEAwf2hoK_Lgi1S-0,559 -example_customized-0.0.1.dist-info/NOTICE,sha256=Xpdw-FXET1IRgZ_wTkx1YQfo1-alET0FVf6V1LXO4js,76 -example_customized-0.0.1.dist-info/README,sha256=WmOFwZ3Jga1bHG3JiGRsUheb4UbLffUxyTdHczS27-o,40 -example_customized-0.0.1.dist-info/RECORD,, -example_customized-0.0.1.dist-info/WHEEL,sha256=sobxWSyDDkdg_rinUth-jxhXHqoNqlmNMJY3aTZn2Us,91 -example_customized-0.0.1.dist-info/entry_points.txt,sha256=pqzpbQ8MMorrJ3Jp0ntmpZcuvfByyqzMXXi2UujuXD0,137 examples/wheel/lib/data.txt,sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12 examples/wheel/lib/module_with_data.py,sha256=8s0Khhcqz3yVsBKv2IB5u4l4TMKh7-c_V6p65WVHPms,637 examples/wheel/lib/simple_module.py,sha256=z2hwciab_XPNIBNH8B1Q5fYgnJvQTeYf0ZQJpY8yLLY,637 examples/wheel/main.py,sha256=sgg5iWN_9inYBjm6_Zw27hYdmo-l24fA-2rfphT-IlY,909 +example_customized-0.0.1.dist-info/WHEEL,sha256=sobxWSyDDkdg_rinUth-jxhXHqoNqlmNMJY3aTZn2Us,91 +example_customized-0.0.1.dist-info/METADATA,sha256=QYQcDJFQSIqan8eiXqL67bqsUfgEAwf2hoK_Lgi1S-0,559 +example_customized-0.0.1.dist-info/entry_points.txt,sha256=pqzpbQ8MMorrJ3Jp0ntmpZcuvfByyqzMXXi2UujuXD0,137 +example_customized-0.0.1.dist-info/NOTICE,sha256=Xpdw-FXET1IRgZ_wTkx1YQfo1-alET0FVf6V1LXO4js,76 +example_customized-0.0.1.dist-info/README,sha256=WmOFwZ3Jga1bHG3JiGRsUheb4UbLffUxyTdHczS27-o,40 +example_customized-0.0.1.dist-info/RECORD,, """, ) self.assertEqual( @@ -152,16 +188,16 @@ customized_wheel = examples.wheel.main:main first = first.main:f second = second.main:s""", ) + self.assertFileSha256Equal( + filename, "48eed93258bba0bb366c879b77917d947267d89e7e60005d1766d844fb909118" + ) - def test_filename_escaping(self): - filename = os.path.join( - os.environ["TEST_SRCDIR"], - "rules_python", - "examples", - "wheel", + def test_legacy_filename_escaping(self): + filename = self._get_path( "file_name_escaping-0.0.1_r7-py3-none-any.whl", ) with zipfile.ZipFile(filename) as zf: + self.assertAllEntriesHasReproducibleMetadata(zf) self.assertEqual( zf.namelist(), [ @@ -190,17 +226,51 @@ Version: 0.0.1-r7 UNKNOWN """, ) + self.assertFileSha256Equal( + filename, "ace5fab6458f8c3b4b50801b8e8214288bba786472e81547fced743a67531312" + ) + + def test_filename_escaping(self): + filename = self._get_path( + "file_name_escaping-0.0.1rc1+ubuntu.r7-py3-none-any.whl", + ) + with zipfile.ZipFile(filename) as zf: + self.assertEqual( + zf.namelist(), + [ + "examples/wheel/lib/data.txt", + "examples/wheel/lib/module_with_data.py", + "examples/wheel/lib/simple_module.py", + "examples/wheel/main.py", + # PEP calls for replacing only in the archive filename. + # Alas setuptools also escapes in the dist-info directory + # name, so let's be compatible. + "file_name_escaping-0.0.1rc1+ubuntu.r7.dist-info/WHEEL", + "file_name_escaping-0.0.1rc1+ubuntu.r7.dist-info/METADATA", + "file_name_escaping-0.0.1rc1+ubuntu.r7.dist-info/RECORD", + ], + ) + metadata_contents = zf.read( + "file_name_escaping-0.0.1rc1+ubuntu.r7.dist-info/METADATA" + ) + self.assertEqual( + metadata_contents, + b"""\ +Metadata-Version: 2.1 +Name: File--Name-Escaping +Version: 0.0.1rc1+ubuntu.r7 + +UNKNOWN +""", + ) def test_custom_package_root_wheel(self): - filename = os.path.join( - os.environ["TEST_SRCDIR"], - "rules_python", - "examples", - "wheel", + filename = self._get_path( "examples_custom_package_root-0.0.1-py3-none-any.whl", ) with zipfile.ZipFile(filename) as zf: + self.assertAllEntriesHasReproducibleMetadata(zf) self.assertEqual( zf.namelist(), [ @@ -222,17 +292,17 @@ UNKNOWN # Ensure RECORD files do not have leading forward slashes for line in record_contents.splitlines(): self.assertFalse(line.startswith("/")) + self.assertFileSha256Equal( + filename, "16e0345c102c6866fed34999d8de5aed7f351adbf372b27adef3bc15161db65e" + ) def test_custom_package_root_multi_prefix_wheel(self): - filename = os.path.join( - os.environ["TEST_SRCDIR"], - "rules_python", - "examples", - "wheel", + filename = self._get_path( "example_custom_package_root_multi_prefix-0.0.1-py3-none-any.whl", ) with zipfile.ZipFile(filename) as zf: + self.assertAllEntriesHasReproducibleMetadata(zf) self.assertEqual( zf.namelist(), [ @@ -253,17 +323,17 @@ UNKNOWN # Ensure RECORD files do not have leading forward slashes for line in record_contents.splitlines(): self.assertFalse(line.startswith("/")) + self.assertFileSha256Equal( + filename, "d2031eb21c69e290db5eac76b0dc026858e9dbdb3da2dc0314e4e9f69eab2e1a" + ) def test_custom_package_root_multi_prefix_reverse_order_wheel(self): - filename = os.path.join( - os.environ["TEST_SRCDIR"], - "rules_python", - "examples", - "wheel", + filename = self._get_path( "example_custom_package_root_multi_prefix_reverse_order-0.0.1-py3-none-any.whl", ) with zipfile.ZipFile(filename) as zf: + self.assertAllEntriesHasReproducibleMetadata(zf) self.assertEqual( zf.namelist(), [ @@ -284,16 +354,16 @@ UNKNOWN # Ensure RECORD files do not have leading forward slashes for line in record_contents.splitlines(): self.assertFalse(line.startswith("/")) + self.assertFileSha256Equal( + filename, "a37b90685600ccfa56cc5405d1e9a3729ed21dfb31c76fd356e491e2af989566" + ) def test_python_requires_wheel(self): - filename = os.path.join( - os.environ["TEST_SRCDIR"], - "rules_python", - "examples", - "wheel", + filename = self._get_path( "example_python_requires_in_a_package-0.0.1-py3-none-any.whl", ) with zipfile.ZipFile(filename) as zf: + self.assertAllEntriesHasReproducibleMetadata(zf) metadata_contents = zf.read( "example_python_requires_in_a_package-0.0.1.dist-info/METADATA" ) @@ -309,6 +379,9 @@ Version: 0.0.1 UNKNOWN """, ) + self.assertFileSha256Equal( + filename, "529afa454113572e6cd91f069cc9cfe5c28369f29cd495fff19d0ecce389d8e4" + ) def test_python_abi3_binary_wheel(self): arch = "amd64" @@ -321,14 +394,11 @@ UNKNOWN "Windows": "win", } os_string = os_strings[platform.system()] - filename = os.path.join( - os.environ["TEST_SRCDIR"], - "rules_python", - "examples", - "wheel", + filename = self._get_path( f"example_python_abi3_binary_wheel-0.0.1-cp38-abi3-{os_string}_{arch}.whl", ) with zipfile.ZipFile(filename) as zf: + self.assertAllEntriesHasReproducibleMetadata(zf) metadata_contents = zf.read( "example_python_abi3_binary_wheel-0.0.1.dist-info/METADATA" ) @@ -358,15 +428,12 @@ Tag: cp38-abi3-{os_string}_{arch} ) def test_rule_creates_directory_and_is_included_in_wheel(self): - filename = os.path.join( - os.environ["TEST_SRCDIR"], - "rules_python", - "examples", - "wheel", + filename = self._get_path( "use_rule_with_dir_in_outs-0.0.1-py3-none-any.whl", ) with zipfile.ZipFile(filename) as zf: + self.assertAllEntriesHasReproducibleMetadata(zf) self.assertEqual( zf.namelist(), [ @@ -377,17 +444,17 @@ Tag: cp38-abi3-{os_string}_{arch} "use_rule_with_dir_in_outs-0.0.1.dist-info/RECORD", ], ) + self.assertFileSha256Equal( + filename, "cc9484d527075f07651ca0e7dff4a185c1314020726bcad55fe28d1bba0fec2e" + ) def test_rule_expands_workspace_status_keys_in_wheel_metadata(self): - filename = os.path.join( - os.environ["TEST_SRCDIR"], - "rules_python", - "examples", - "wheel", - "example_minimal_library_BUILD_USER_-0.1._BUILD_TIMESTAMP_-py3-none-any.whl", + filename = self._get_path( + "example_minimal_library_BUILD_USER_-0.1._BUILD_TIMESTAMP_-py3-none-any.whl" ) with zipfile.ZipFile(filename) as zf: + self.assertAllEntriesHasReproducibleMetadata(zf) metadata_file = None for f in zf.namelist(): self.assertNotIn("_BUILD_TIMESTAMP_", f) |