diff options
Diffstat (limited to 'examples/wheel/wheel_test.py')
| -rw-r--r-- | examples/wheel/wheel_test.py | 414 |
1 files changed, 414 insertions, 0 deletions
diff --git a/examples/wheel/wheel_test.py b/examples/wheel/wheel_test.py new file mode 100644 index 0000000..f51a0ec --- /dev/null +++ b/examples/wheel/wheel_test.py @@ -0,0 +1,414 @@ +# Copyright 2018 The Bazel Authors. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import os +import platform +import subprocess +import unittest +import zipfile + + +class WheelTest(unittest.TestCase): + maxDiff = None + + 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", + ) + with zipfile.ZipFile(filename) as zf: + self.assertEqual( + zf.namelist(), + [ + "examples/wheel/lib/module_with_data.py", + "examples/wheel/lib/simple_module.py", + "example_minimal_library-0.0.1.dist-info/WHEEL", + "example_minimal_library-0.0.1.dist-info/METADATA", + "example_minimal_library-0.0.1.dist-info/RECORD", + ], + ) + + def test_py_package_wheel(self): + filename = os.path.join( + os.environ["TEST_SRCDIR"], + "rules_python", + "examples", + "wheel", + "example_minimal_package-0.0.1-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", + "example_minimal_package-0.0.1.dist-info/WHEEL", + "example_minimal_package-0.0.1.dist-info/METADATA", + "example_minimal_package-0.0.1.dist-info/RECORD", + ], + ) + + def test_customized_wheel(self): + filename = os.path.join( + os.environ["TEST_SRCDIR"], + "rules_python", + "examples", + "wheel", + "example_customized-0.0.1-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", + "example_customized-0.0.1.dist-info/WHEEL", + "example_customized-0.0.1.dist-info/METADATA", + "example_customized-0.0.1.dist-info/entry_points.txt", + "example_customized-0.0.1.dist-info/NOTICE", + "example_customized-0.0.1.dist-info/README", + "example_customized-0.0.1.dist-info/RECORD", + ], + ) + record_contents = zf.read("example_customized-0.0.1.dist-info/RECORD") + wheel_contents = zf.read("example_customized-0.0.1.dist-info/WHEEL") + metadata_contents = zf.read("example_customized-0.0.1.dist-info/METADATA") + entry_point_contents = zf.read( + "example_customized-0.0.1.dist-info/entry_points.txt" + ) + + self.assertEqual( + 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 +""", + ) + self.assertEqual( + wheel_contents, + b"""\ +Wheel-Version: 1.0 +Generator: bazel-wheelmaker 1.0 +Root-Is-Purelib: true +Tag: py3-none-any +""", + ) + self.assertEqual( + metadata_contents, + b"""\ +Metadata-Version: 2.1 +Name: example_customized +Author: Example Author with non-ascii characters: \xc5\xbc\xc3\xb3\xc5\x82w +Author-email: example@example.com +Home-page: www.example.com +License: Apache 2.0 +Description-Content-Type: text/markdown +Summary: A one-line summary of this test package +Project-URL: Bug Tracker, www.example.com/issues +Project-URL: Documentation, www.example.com/docs +Classifier: License :: OSI Approved :: Apache Software License +Classifier: Intended Audience :: Developers +Requires-Dist: pytest +Version: 0.0.1 + +This is a sample description of a wheel. +""", + ) + self.assertEqual( + entry_point_contents, + b"""\ +[console_scripts] +another = foo.bar:baz +customized_wheel = examples.wheel.main:main + +[group2] +first = first.main:f +second = second.main:s""", + ) + + def test_filename_escaping(self): + filename = os.path.join( + os.environ["TEST_SRCDIR"], + "rules_python", + "examples", + "wheel", + "file_name_escaping-0.0.1_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.1_r7.dist-info/WHEEL", + "file_name_escaping-0.0.1_r7.dist-info/METADATA", + "file_name_escaping-0.0.1_r7.dist-info/RECORD", + ], + ) + metadata_contents = zf.read( + "file_name_escaping-0.0.1_r7.dist-info/METADATA" + ) + self.assertEqual( + metadata_contents, + b"""\ +Metadata-Version: 2.1 +Name: file~~name-escaping +Version: 0.0.1-r7 + +UNKNOWN +""", + ) + + def test_custom_package_root_wheel(self): + filename = os.path.join( + os.environ["TEST_SRCDIR"], + "rules_python", + "examples", + "wheel", + "examples_custom_package_root-0.0.1-py3-none-any.whl", + ) + + with zipfile.ZipFile(filename) as zf: + self.assertEqual( + zf.namelist(), + [ + "wheel/lib/data.txt", + "wheel/lib/module_with_data.py", + "wheel/lib/simple_module.py", + "wheel/main.py", + "examples_custom_package_root-0.0.1.dist-info/WHEEL", + "examples_custom_package_root-0.0.1.dist-info/METADATA", + "examples_custom_package_root-0.0.1.dist-info/entry_points.txt", + "examples_custom_package_root-0.0.1.dist-info/RECORD", + ], + ) + + record_contents = zf.read( + "examples_custom_package_root-0.0.1.dist-info/RECORD" + ).decode("utf-8") + + # Ensure RECORD files do not have leading forward slashes + for line in record_contents.splitlines(): + self.assertFalse(line.startswith("/")) + + def test_custom_package_root_multi_prefix_wheel(self): + filename = os.path.join( + os.environ["TEST_SRCDIR"], + "rules_python", + "examples", + "wheel", + "example_custom_package_root_multi_prefix-0.0.1-py3-none-any.whl", + ) + + with zipfile.ZipFile(filename) as zf: + self.assertEqual( + zf.namelist(), + [ + "data.txt", + "module_with_data.py", + "simple_module.py", + "main.py", + "example_custom_package_root_multi_prefix-0.0.1.dist-info/WHEEL", + "example_custom_package_root_multi_prefix-0.0.1.dist-info/METADATA", + "example_custom_package_root_multi_prefix-0.0.1.dist-info/RECORD", + ], + ) + + record_contents = zf.read( + "example_custom_package_root_multi_prefix-0.0.1.dist-info/RECORD" + ).decode("utf-8") + + # Ensure RECORD files do not have leading forward slashes + for line in record_contents.splitlines(): + self.assertFalse(line.startswith("/")) + + def test_custom_package_root_multi_prefix_reverse_order_wheel(self): + filename = os.path.join( + os.environ["TEST_SRCDIR"], + "rules_python", + "examples", + "wheel", + "example_custom_package_root_multi_prefix_reverse_order-0.0.1-py3-none-any.whl", + ) + + with zipfile.ZipFile(filename) as zf: + self.assertEqual( + zf.namelist(), + [ + "lib/data.txt", + "lib/module_with_data.py", + "lib/simple_module.py", + "main.py", + "example_custom_package_root_multi_prefix_reverse_order-0.0.1.dist-info/WHEEL", + "example_custom_package_root_multi_prefix_reverse_order-0.0.1.dist-info/METADATA", + "example_custom_package_root_multi_prefix_reverse_order-0.0.1.dist-info/RECORD", + ], + ) + + record_contents = zf.read( + "example_custom_package_root_multi_prefix_reverse_order-0.0.1.dist-info/RECORD" + ).decode("utf-8") + + # Ensure RECORD files do not have leading forward slashes + for line in record_contents.splitlines(): + self.assertFalse(line.startswith("/")) + + def test_python_requires_wheel(self): + filename = os.path.join( + os.environ["TEST_SRCDIR"], + "rules_python", + "examples", + "wheel", + "example_python_requires_in_a_package-0.0.1-py3-none-any.whl", + ) + with zipfile.ZipFile(filename) as zf: + metadata_contents = zf.read( + "example_python_requires_in_a_package-0.0.1.dist-info/METADATA" + ) + # The entries are guaranteed to be sorted. + self.assertEqual( + metadata_contents, + b"""\ +Metadata-Version: 2.1 +Name: example_python_requires_in_a_package +Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.* +Version: 0.0.1 + +UNKNOWN +""", + ) + + def test_python_abi3_binary_wheel(self): + arch = "amd64" + if platform.system() != "Windows": + arch = subprocess.check_output(["uname", "-m"]).strip().decode() + # These strings match the strings from py_wheel() in BUILD + os_strings = { + "Linux": "manylinux2014", + "Darwin": "macosx_11_0", + "Windows": "win", + } + os_string = os_strings[platform.system()] + filename = os.path.join( + os.environ["TEST_SRCDIR"], + "rules_python", + "examples", + "wheel", + f"example_python_abi3_binary_wheel-0.0.1-cp38-abi3-{os_string}_{arch}.whl", + ) + with zipfile.ZipFile(filename) as zf: + metadata_contents = zf.read( + "example_python_abi3_binary_wheel-0.0.1.dist-info/METADATA" + ) + # The entries are guaranteed to be sorted. + self.assertEqual( + metadata_contents, + b"""\ +Metadata-Version: 2.1 +Name: example_python_abi3_binary_wheel +Requires-Python: >=3.8 +Version: 0.0.1 + +UNKNOWN +""", + ) + wheel_contents = zf.read( + "example_python_abi3_binary_wheel-0.0.1.dist-info/WHEEL" + ) + self.assertEqual( + wheel_contents.decode(), + f"""\ +Wheel-Version: 1.0 +Generator: bazel-wheelmaker 1.0 +Root-Is-Purelib: false +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", + "use_rule_with_dir_in_outs-0.0.1-py3-none-any.whl", + ) + + with zipfile.ZipFile(filename) as zf: + self.assertEqual( + zf.namelist(), + [ + "examples/wheel/main.py", + "examples/wheel/someDir/foo.py", + "use_rule_with_dir_in_outs-0.0.1.dist-info/WHEEL", + "use_rule_with_dir_in_outs-0.0.1.dist-info/METADATA", + "use_rule_with_dir_in_outs-0.0.1.dist-info/RECORD", + ], + ) + + 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", + ) + + with zipfile.ZipFile(filename) as zf: + metadata_file = None + for f in zf.namelist(): + self.assertNotIn("_BUILD_TIMESTAMP_", f) + self.assertNotIn("_BUILD_USER_", f) + if os.path.basename(f) == "METADATA": + metadata_file = f + self.assertIsNotNone(metadata_file) + + version = None + name = None + with zf.open(metadata_file) as fp: + for line in fp: + if line.startswith(b"Version:"): + version = line.decode().split()[-1] + if line.startswith(b"Name:"): + name = line.decode().split()[-1] + self.assertIsNotNone(version) + self.assertIsNotNone(name) + self.assertNotIn("{BUILD_TIMESTAMP}", version) + self.assertNotIn("{BUILD_USER}", name) + + +if __name__ == "__main__": + unittest.main() |