Add tests for PEP 660 hooks

Author: sbidoul

tests/samples/buildsys_pkgs/buildsys.py

@@ -14,11 +14,18 @@ def get_requires_for_build_wheel(config_settings):
     return ['wheelwright']
 
 
+def get_requires_for_build_editable(config_settings):
+    return ['wheelwright', 'editables']
+
+
 def prepare_metadata_for_build_wheel(metadata_directory, config_settings):
     for distinfo in glob('*.dist-info'):
         shutil.copytree(distinfo, pjoin(metadata_directory, distinfo))
 
 
+prepare_metadata_for_build_editable = prepare_metadata_for_build_wheel
+
+
 def prepare_build_wheel_files(build_directory, config_settings):
     shutil.copy('pyproject.toml', build_directory)
     for pyfile in glob('*.py'):
@@ -37,6 +44,9 @@ def build_wheel(wheel_directory, config_settings, metadata_directory=None):
     return whl_file
 
 
+build_editable = build_wheel
+
+
 def get_requires_for_build_sdist(config_settings):
     return ['frog']
 

tests/samples/buildsys_pkgs/buildsys_minimal_editable.py

@@ -0,0 +1,4 @@
+from buildsys_minimal import build_sdist, build_wheel  # noqa
+
+
+build_editable = build_wheel

tests/samples/pkg3/pkg3-0.5.dist-info/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Thomas Kluyver
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

tests/samples/pkg3/pkg3-0.5.dist-info/METADATA

@@ -0,0 +1,9 @@
+Metadata-Version: 1.2
+Name: pkg3
+Version: 0.5
+Summary: Sample package for tests
+Home-page: https://github.com/takluyver/pkg3
+License: UNKNOWN
+Author: Thomas Kluyver
+Author-email: [email protected]
+Classifier: License :: OSI Approved :: MIT License

tests/samples/pkg3/pkg3-0.5.dist-info/RECORD

@@ -0,0 +1,5 @@
+pkg3.py,sha256=ZawKBtrxtdGEheOCWvwzGZsO8Q1OSzEzecGNsRz-ekc,52
+pkg3-0.5.dist-info/LICENSE,sha256=GyKwSbUmfW38I6Z79KhNjsBLn9-xpR02DkK0NCyLQVQ,1081
+pkg3-0.5.dist-info/WHEEL,sha256=jxKvNaDKHDacpaLi69-vnLKkBSynwBzmMS82pipt1T0,100
+pkg3-0.5.dist-info/METADATA,sha256=4zQxJqc4Rvnlf5Y-seXnRx8g-1FK-sjTuS0A1KP0ajk,251
+pkg3-0.5.dist-info/RECORD,,

tests/samples/pkg3/pkg3-0.5.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: flit 0.11.3
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any

tests/samples/pkg3/pkg3.py

@@ -0,0 +1,3 @@
+"""Sample package for tests"""
+
+__version__ = '0.5'

tests/samples/pkg3/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = []
+build-backend = "buildsys_minimal_editable"

tests/test_call_hooks.py

@@ -49,6 +49,13 @@ def test_get_requires_for_build_wheel():
     assert res == ['wheelwright']
 
 
+def test_get_requires_for_build_editable():
+    hooks = get_hooks('pkg1')
+    with modified_env({'PYTHONPATH': BUILDSYS_PKGS}):
+        res = hooks.get_requires_for_build_editable({})
+    assert res == ['wheelwright', 'editables']
+
+
 def test_get_requires_for_build_sdist():
     hooks = get_hooks('pkg1')
     with modified_env({'PYTHONPATH': BUILDSYS_PKGS}):
@@ -65,6 +72,15 @@ def test_prepare_metadata_for_build_wheel():
         assert_isfile(pjoin(metadatadir, 'pkg1-0.5.dist-info', 'METADATA'))
 
 
+def test_prepare_metadata_for_build_editable():
+    hooks = get_hooks('pkg1')
+    with TemporaryDirectory() as metadatadir:
+        with modified_env({'PYTHONPATH': BUILDSYS_PKGS}):
+            hooks.prepare_metadata_for_build_editable(metadatadir, {})
+
+        assert_isfile(pjoin(metadatadir, 'pkg1-0.5.dist-info', 'METADATA'))
+
+
 def test_build_wheel():
     hooks = get_hooks('pkg1')
     with TemporaryDirectory() as builddir:
@@ -79,6 +95,20 @@ def test_build_wheel():
         assert zipfile.is_zipfile(whl_file)
 
 
+def test_build_editable():
+    hooks = get_hooks('pkg1')
+    with TemporaryDirectory() as builddir:
+        with modified_env({'PYTHONPATH': BUILDSYS_PKGS}):
+            whl_file = hooks.build_editable(builddir, {})
+
+        assert whl_file.endswith('.whl')
+        assert os.sep not in whl_file
+
+        whl_file = pjoin(builddir, whl_file)
+        assert_isfile(whl_file)
+        assert zipfile.is_zipfile(whl_file)
+
+
 def test_build_wheel_relpath():
     hooks = get_hooks('pkg1')
     with TemporaryWorkingDirectory() as builddir:

tests/test_hook_fallbacks.py

@@ -24,6 +24,13 @@ def test_get_requires_for_build_wheel():
     assert res == []
 
 
+def test_get_requires_for_build_editable():
+    hooks = get_hooks('pkg2')
+    with modified_env({'PYTHONPATH': BUILDSYS_PKGS}):
+        res = hooks.get_requires_for_build_editable({})
+    assert res == []
+
+
 def test_get_requires_for_build_sdist():
     hooks = get_hooks('pkg2')
     with modified_env({'PYTHONPATH': BUILDSYS_PKGS}):
@@ -40,6 +47,28 @@ def test_prepare_metadata_for_build_wheel():
         assert_isfile(pjoin(metadatadir, 'pkg2-0.5.dist-info', 'METADATA'))
 
 
+def test_prepare_metadata_for_build_editable():
+    hooks = get_hooks('pkg3')
+    with TemporaryDirectory() as metadatadir:
+        with modified_env({'PYTHONPATH': BUILDSYS_PKGS}):
+            hooks.prepare_metadata_for_build_editable(metadatadir, {})
+
+        assert_isfile(pjoin(metadatadir, 'pkg3-0.5.dist-info', 'METADATA'))
+
+
+def test_prepare_metadata_for_build_editable_missing_build_editable():
+    hooks = get_hooks('pkg2')
+    with TemporaryDirectory() as metadatadir:
+        with modified_env({'PYTHONPATH': BUILDSYS_PKGS}):
+            # pkg2's build system does not have build_editable
+            with pytest.raises(HookMissing) as exc_info:
+                hooks.prepare_metadata_for_build_editable(metadatadir, {})
+
+            e = exc_info.value
+            assert 'build_editable' == e.hook_name
+            assert 'build_editable' == str(e)
+
+
 def test_prepare_metadata_for_build_wheel_no_fallback():
     hooks = get_hooks('pkg2')
 
@@ -53,3 +82,18 @@ def test_prepare_metadata_for_build_wheel_no_fallback():
             e = exc_info.value
             assert 'prepare_metadata_for_build_wheel' == e.hook_name
             assert 'prepare_metadata_for_build_wheel' in str(e)
+
+
+def test_prepare_metadata_for_build_editable_no_fallback():
+    hooks = get_hooks('pkg2')
+
+    with TemporaryDirectory() as metadatadir:
+        with modified_env({'PYTHONPATH': BUILDSYS_PKGS}):
+            with pytest.raises(HookMissing) as exc_info:
+                hooks.prepare_metadata_for_build_editable(
+                    metadatadir, {}, _allow_fallback=False
+                )
+
+            e = exc_info.value
+            assert 'prepare_metadata_for_build_editable' == e.hook_name
+            assert 'prepare_metadata_for_build_editable' in str(e)