Merge pull request #224 from lkollar/non-platform-wheel

Correctly detect non-platform wheels

Author: lkollar

auditwheel/main_addtag.py

@@ -24,9 +24,13 @@ def execute(args, p):
     import os
     from wheel.wheelfile import WHEEL_INFO_RE  # type: ignore
     from .wheeltools import InWheelCtx, add_platforms, WheelToolsError
-    from .wheel_abi import analyze_wheel_abi
+    from .wheel_abi import analyze_wheel_abi, NonPlatformWheel
 
-    wheel_abi = analyze_wheel_abi(args.WHEEL_FILE)
+    try:
+        wheel_abi = analyze_wheel_abi(args.WHEEL_FILE)
+    except NonPlatformWheel:
+        logger.info('This does not look like a platform wheel')
+        return 1
 
     parsed_fname = WHEEL_INFO_RE.search(basename(args.WHEEL_FILE))
     in_fname_tags = parsed_fname.groupdict()['plat'].split('.')

auditwheel/main_repair.py

@@ -47,7 +47,7 @@ def execute(args, p):
     import os
     from distutils.spawn import find_executable
     from .repair import repair_wheel
-    from .wheel_abi import analyze_wheel_abi
+    from .wheel_abi import analyze_wheel_abi, NonPlatformWheel
 
     if not isfile(args.WHEEL_FILE):
         p.error('cannot access %s. No such file' % args.WHEEL_FILE)
@@ -59,7 +59,12 @@ def execute(args, p):
     if not exists(args.WHEEL_DIR):
         os.makedirs(args.WHEEL_DIR)
 
-    wheel_abi = analyze_wheel_abi(args.WHEEL_FILE)
+    try:
+        wheel_abi = analyze_wheel_abi(args.WHEEL_FILE)
+    except NonPlatformWheel:
+        logger.info('This does not look like a platform wheel')
+        return 1
+
     reqd_tag = get_priority_by_name(args.PLAT)
 
     if reqd_tag > get_priority_by_name(wheel_abi.sym_tag):

auditwheel/main_show.py

@@ -1,8 +1,12 @@
+import logging
+
 try:
     from collections.abc import OrderedDict
 except ImportError:
     from collections import OrderedDict
 
+logger = logging.getLogger(__name__)
+
 
 def configure_parser(sub_parsers):
     help = "Audit a wheel for external shared library dependencies."
@@ -23,13 +27,18 @@ def execute(args, p):
     from .policy import (load_policies, get_priority_by_name,
                          POLICY_PRIORITY_LOWEST, POLICY_PRIORITY_HIGHEST,
                          get_policy_name)
-    from .wheel_abi import analyze_wheel_abi
+    from .wheel_abi import analyze_wheel_abi, NonPlatformWheel
     fn = basename(args.WHEEL_FILE)
 
     if not isfile(args.WHEEL_FILE):
         p.error('cannot access %s. No such file' % args.WHEEL_FILE)
 
-    winfo = analyze_wheel_abi(args.WHEEL_FILE)
+    try:
+        winfo = analyze_wheel_abi(args.WHEEL_FILE)
+    except NonPlatformWheel:
+        logger.info('This does not look like a platform wheel')
+        return 1
+
     libs_with_versions = ['%s with versions %s' % (k, v)
                           for k, v in winfo.versioned_symbols.items()]
 

auditwheel/wheel_abi.py

@@ -26,6 +26,14 @@
                            'pyfpe_tag'])
 
 
+class WheelAbiError(Exception):
+    """Root exception class"""
+
+
+class NonPlatformWheel(WheelAbiError):
+    """No ELF binaries in the wheel"""
+
+
 @functools.lru_cache()
 def get_wheel_elfdata(wheel_fn: str):
     full_elftree = {}
@@ -38,7 +46,9 @@ def get_wheel_elfdata(wheel_fn: str):
     with InGenericPkgCtx(wheel_fn) as ctx:
         shared_libraries_in_purelib = []
 
+        platform_wheel = False
         for fn, elf in elf_file_filter(ctx.iter_files()):
+            platform_wheel = True
 
             # Check for invalid binary wheel format: no shared library should
             # be found in purelib
@@ -79,6 +89,9 @@ def get_wheel_elfdata(wheel_fn: str):
                     # its internal references later.
                     nonpy_elftree[fn] = elftree
 
+        if not platform_wheel:
+            raise NonPlatformWheel
+
         # If at least one shared library exists in purelib, raise an error
         if shared_libraries_in_purelib:
             raise RuntimeError(

tests/integration/plumbum-1.6.8-py2.py3-none-any.whl

@@ -104,11 +104,11 @@ def docker_container_ctx(image, io_dir=None, env_variables={}):
         container.remove(force=True)
 
 
-def docker_exec(container, cmd):
+def docker_exec(container, cmd, expected_retcode=0):
     logger.info("docker exec %s: %r", container.id[:12], cmd)
     ec, output = container.exec_run(cmd)
     output = output.decode(ENCODING)
-    if ec != 0:
+    if ec != expected_retcode:
         print(output)
         raise CalledProcessError(ec, cmd, output=output)
     return output
@@ -379,6 +379,7 @@ def test_build_repair_pure_wheel(any_manylinux_container, io_folder):
         # If six has already been built and put in cache, let's reuse this.
         shutil.copy2(op.join(WHEEL_CACHE_FOLDER, policy,  ORIGINAL_SIX_WHEEL),
                      op.join(io_folder, ORIGINAL_SIX_WHEEL))
+        logger.info("Copied six wheel from {} to {}".format(WHEEL_CACHE_FOLDER, io_folder))
     else:
         docker_exec(manylinux_ctr, 'pip wheel -w /io --no-binary=:all: six==1.11.0')
         os.makedirs(op.join(WHEEL_CACHE_FOLDER, policy), exist_ok=True)
@@ -394,21 +395,13 @@ def test_build_repair_pure_wheel(any_manylinux_container, io_folder):
     repair_command = (
         'auditwheel repair --plat {policy} -w /io /io/{orig_wheel}'
     ).format(policy=policy, orig_wheel=orig_wheel)
-    docker_exec(manylinux_ctr, repair_command)
-    filenames = os.listdir(io_folder)
-    assert len(filenames) == 1  # no new wheels
-    assert filenames == [ORIGINAL_SIX_WHEEL]
+    output = docker_exec(manylinux_ctr, repair_command, expected_retcode=1)
+    assert "This does not look like a platform wheel" in output
 
-    output = docker_exec(manylinux_ctr, 'auditwheel show /io/' + filenames[0])
-    expected = 'manylinux1' if PLATFORM in {'x86_64', 'i686'} else 'manylinux2014'
-    assert ''.join([
-        ORIGINAL_SIX_WHEEL,
-        ' is consistent with the following platform tag: ',
-        '"{}_{}".  '.format(expected, PLATFORM),
-        'The wheel references no external versioned symbols from system- ',
-        'provided shared libraries.  ',
-        'The wheel requires no external shared libraries! :)',
-    ]) in output.replace('\n', ' ')
+    output = docker_exec(manylinux_ctr, 'auditwheel show /io/{orig_wheel}'
+                         .format(orig_wheel=orig_wheel),
+                         expected_retcode=1)
+    assert "This does not look like a platform wheel" in output
 
 
 @pytest.mark.parametrize('dtag', ['rpath', 'runpath'])

tests/integration/test_manylinux.py

@@ -0,0 +1,17 @@
+import pathlib
+import subprocess
+
+import pytest
+
+HERE = pathlib.Path(__file__).parent.resolve()
+
+
+@pytest.mark.parametrize("mode", ["repair", "addtag", "show"])
+def test_non_platform_wheel_repair(mode):
+    wheel = HERE / "plumbum-1.6.8-py2.py3-none-any.whl"
+    proc = subprocess.run(["auditwheel", mode, str(wheel)],
+                          stderr=subprocess.PIPE,
+                          universal_newlines=True)
+    assert proc.returncode == 1
+    assert "This does not look like a platform wheel" in proc.stderr
+    assert "AttributeError" not in proc.stderr