test(build): add smoke tests for sdist & wheel package

nejch · JohnVillalovos · commit b8a47bae3342 · 2021-09-02T18:25:47.000-07:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -25,6 +25,8 @@ jobs:
             toxenv: py38
           - python-version: 3.9
             toxenv: py39
+          - python-version: 3.9
+            toxenv: smoke
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}
diff --git a/pyproject.toml b/pyproject.toml
@@ -16,7 +16,8 @@ module = [
     "setup",
     "tests.functional.*",
     "tests.functional.api.*",
-    "tests.unit.*"
+    "tests.unit.*",
+    "tests.smoke.*"
 ]
 ignore_errors = true
 
diff --git a/tests/smoke/__init__.py b/tests/smoke/__init__.py
diff --git a/tests/smoke/test_dists.py b/tests/smoke/test_dists.py
@@ -0,0 +1,33 @@
+import tarfile
+import zipfile
+from pathlib import Path
+from sys import version_info
+
+import pytest
+from setuptools import sandbox
+
+from gitlab import __title__, __version__
+
+DIST_DIR = Path("dist")
+TEST_DIR = "tests"
+SDIST_FILE = f"{__title__}-{__version__}.tar.gz"
+WHEEL_FILE = (
+    f"{__title__.replace('-', '_')}-{__version__}-py{version_info.major}-none-any.whl"
+)
+
+
+@pytest.fixture(scope="function")
+def build():
+    sandbox.run_setup("setup.py", ["clean", "--all"])
+    return sandbox.run_setup("setup.py", ["sdist", "bdist_wheel"])
+
+
+def test_sdist_includes_tests(build):
+    sdist = tarfile.open(DIST_DIR / SDIST_FILE, "r:gz")
+    test_dir = sdist.getmember(f"{__title__}-{__version__}/{TEST_DIR}")
+    assert test_dir.isdir()
+
+
+def test_wheel_excludes_tests(build):
+    wheel = zipfile.ZipFile(DIST_DIR / WHEEL_FILE)
+    assert [not file.startswith(TEST_DIR) for file in wheel.namelist()]
diff --git a/tox.ini b/tox.ini
@@ -96,3 +96,7 @@ commands =
 deps = -r{toxinidir}/requirements-docker.txt
 commands =
   pytest --cov --cov-report xml tests/functional/api {posargs}
+
+[testenv:smoke]
+deps = -r{toxinidir}/requirements-test.txt
+commands = pytest tests/smoke {posargs}

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,8 @@ module = [`
`16`	`16`	`"setup",`
`17`	`17`	`"tests.functional.*",`
`18`	`18`	`"tests.functional.api.*",`
`19`		`- "tests.unit.*"`
	`19`	`+ "tests.unit.*",`
	`20`	`+ "tests.smoke.*"`
`20`	`21`	`]`
`21`	`22`	`ignore_errors = true`
`22`	`23`