Move build_archive() from test_sdist to common helpers module

This will allow to reuse it in later commits. Change the function to
return a pathlib.Path instead of a string because that is what is used
internally and because it is easy to turn that into a string when
needed, but it is a bit more cumbersome to do the opposite.

Author: dnicolodi

tests/helpers.py

@@ -13,12 +13,41 @@
 # limitations under the License.
 """Test functions useful across twine's tests."""
 
+import io
 import os
 import pathlib
+import tarfile
+import textwrap
+import zipfile
 
 TESTS_DIR = pathlib.Path(__file__).parent
 FIXTURES_DIR = os.path.join(TESTS_DIR, "fixtures")
 SDIST_FIXTURE = os.path.join(FIXTURES_DIR, "twine-1.5.0.tar.gz")
 WHEEL_FIXTURE = os.path.join(FIXTURES_DIR, "twine-1.5.0-py2.py3-none-any.whl")
 NEW_SDIST_FIXTURE = os.path.join(FIXTURES_DIR, "twine-1.6.5.tar.gz")
 NEW_WHEEL_FIXTURE = os.path.join(FIXTURES_DIR, "twine-1.6.5-py2.py3-none-any.whl")
+
+
+def build_archive(path, name, archive_format, files):
+    filepath = path / f"{name}.{archive_format}"
+
+    if archive_format == "tar.gz":
+        with tarfile.open(filepath, "x:gz") as archive:
+            for mname, content in files.items():
+                if isinstance(content, tarfile.TarInfo):
+                    content.name = mname
+                    archive.addfile(content)
+                else:
+                    data = textwrap.dedent(content).encode("utf8")
+                    member = tarfile.TarInfo(mname)
+                    member.size = len(data)
+                    archive.addfile(member, io.BytesIO(data))
+        return filepath
+
+    if archive_format == "zip":
+        with zipfile.ZipFile(filepath, mode="w") as archive:
+            for mname, content in files.items():
+                archive.writestr(mname, textwrap.dedent(content))
+        return filepath
+
+    raise ValueError(format)

tests/test_sdist.py

@@ -1,16 +1,14 @@
-import io
 import os
 import pathlib
 import tarfile
-import textwrap
-import zipfile
 
 import pytest
 
 from twine import exceptions
 from twine import sdist
 
 from .helpers import TESTS_DIR
+from .helpers import build_archive
 
 
 @pytest.fixture(
@@ -29,31 +27,6 @@ def archive_format(request):
     return request.param
 
 
-def build_archive(path, name, archive_format, files):
-    filepath = path / f"{name}.{archive_format}"
-
-    if archive_format == "tar.gz":
-        with tarfile.open(filepath, "x:gz") as archive:
-            for mname, content in files.items():
-                if isinstance(content, tarfile.TarInfo):
-                    content.name = mname
-                    archive.addfile(content)
-                else:
-                    data = textwrap.dedent(content).encode("utf8")
-                    member = tarfile.TarInfo(mname)
-                    member.size = len(data)
-                    archive.addfile(member, io.BytesIO(data))
-        return str(filepath)
-
-    if archive_format == "zip":
-        with zipfile.ZipFile(filepath, mode="w") as archive:
-            for mname, content in files.items():
-                archive.writestr(mname, textwrap.dedent(content))
-        return str(filepath)
-
-    raise ValueError(format)
-
-
 def test_read_example(example_sdist):
     """Parse metadata from a valid sdist file."""
     metadata = example_sdist.read()
@@ -78,7 +51,7 @@ def test_formar_not_supported():
 
 def test_read(archive_format, tmp_path):
     """Read PKG-INFO from a valid sdist."""
-    filename = build_archive(
+    filepath = build_archive(
         tmp_path,
         "test-1.2.3",
         archive_format,
@@ -92,15 +65,15 @@ def test_read(archive_format, tmp_path):
         },
     )
 
-    metadata = sdist.SDist(filename).read()
+    metadata = sdist.SDist(str(filepath)).read()
     assert b"Metadata-Version: 1.1" in metadata
     assert b"Name: test" in metadata
     assert b"Version: 1.2.3" in metadata
 
 
 def test_missing_pkg_info(archive_format, tmp_path):
     """Raise an exception when sdist does not contain PKG-INFO."""
-    filename = build_archive(
+    filepath = build_archive(
         tmp_path,
         "test-1.2.3",
         archive_format,
@@ -110,12 +83,12 @@ def test_missing_pkg_info(archive_format, tmp_path):
     )
 
     with pytest.raises(exceptions.InvalidDistribution, match="No PKG-INFO in archive"):
-        sdist.SDist(filename).read()
+        sdist.SDist(str(filepath)).read()
 
 
 def test_invalid_pkg_info(archive_format, tmp_path):
     """Raise an exception when PKG-INFO does not contain ``Metadata-Version``."""
-    filename = build_archive(
+    filepath = build_archive(
         tmp_path,
         "test-1.2.3",
         archive_format,
@@ -129,12 +102,12 @@ def test_invalid_pkg_info(archive_format, tmp_path):
     )
 
     with pytest.raises(exceptions.InvalidDistribution, match="No PKG-INFO in archive"):
-        sdist.SDist(filename).read()
+        sdist.SDist(str(filepath)).read()
 
 
 def test_pkg_info_directory(archive_format, tmp_path):
     """Raise an exception when PKG-INFO is a directory."""
-    filename = build_archive(
+    filepath = build_archive(
         tmp_path,
         "test-1.2.3",
         archive_format,
@@ -149,7 +122,7 @@ def test_pkg_info_directory(archive_format, tmp_path):
     )
 
     with pytest.raises(exceptions.InvalidDistribution, match="No PKG-INFO in archive"):
-        sdist.SDist(filename).read()
+        sdist.SDist(str(filepath)).read()
 
 
 def test_pkg_info_not_regular_file(tmp_path):
@@ -158,7 +131,7 @@ def test_pkg_info_not_regular_file(tmp_path):
     link.type = tarfile.LNKTYPE
     link.linkname = "README"
 
-    filename = build_archive(
+    filepath = build_archive(
         tmp_path,
         "test-1.2.3",
         "tar.gz",
@@ -169,12 +142,12 @@ def test_pkg_info_not_regular_file(tmp_path):
     )
 
     with pytest.raises(exceptions.InvalidDistribution, match="PKG-INFO is not a reg"):
-        sdist.SDist(filename).read()
+        sdist.SDist(str(filepath)).read()
 
 
 def test_multiple_top_level(archive_format, tmp_path):
     """Raise an exception when there are too many top-level members."""
-    filename = build_archive(
+    filepath = build_archive(
         tmp_path,
         "test-1.2.3",
         archive_format,
@@ -190,7 +163,7 @@ def test_multiple_top_level(archive_format, tmp_path):
     )
 
     with pytest.raises(exceptions.InvalidDistribution, match="Too many top-level"):
-        sdist.SDist(filename).read()
+        sdist.SDist(str(filepath)).read()
 
 
 def test_py_version(example_sdist):