Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(dist): only detect falcon* as packages #2385

Merged
merged 4 commits into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions .github/workflows/test-dist.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Test source distribution and pure-Python wheel.
name: test-dist

on:
push:
branches:
- "*"

jobs:
test-dist:
name: test-${{ matrix.build }}
runs-on: ubuntu-latest
strategy:
matrix:
build:
- sdist
- wheel

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 2

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.12"

- name: Build dist
env:
FALCON_DISABLE_CYTHON: "Y"
run: |
pip install --upgrade pip
pip install --upgrade build
python -m build --${{ matrix.build }}

- name: Test sdist
if: matrix.build == 'sdist'
run: |
tools/test_dist.py dist/*.tar.gz

- name: Test pure-Python wheel
if: matrix.build == 'wheel'
run: |
tools/test_dist.py dist/*.whl
2 changes: 1 addition & 1 deletion .github/workflows/tox-sdist.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:

jobs:
run_tox:
name: tox (default envlist on ${{matrix.python-version}})
name: tox (python${{ matrix.python-version }})
runs-on: "ubuntu-latest"
strategy:
fail-fast: false
Expand Down
4 changes: 4 additions & 0 deletions docs/_newsfragments/2384.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Installing Falcon 4.0.0 unexpectly copies many unintended directories from the
source tree to the venv's ``site-packages``. This issue has been rectified, and
our CI has been extended with new tests (that verify what is actually installed
from the distribution) to make sure this regression does not resurface.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ zip-safe = false
version = {attr = "falcon.version.__version__"}

[tool.setuptools.packages.find]
exclude = ["examples", "tests"]
include = ["falcon*"]

[tool.mypy]
exclude = [
Expand Down
33 changes: 27 additions & 6 deletions tools/test_dist.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,43 @@
REQUIREMENTS = FALCON_ROOT / 'requirements' / 'cibwtest'
TESTS = FALCON_ROOT / 'tests'

EXPECTED_SCRIPTS = set({'falcon-bench', 'falcon-inspect-app', 'falcon-print-routes'})
EXPECTED_PACKAGES = set({'falcon'})


def test_package(package):
with tempfile.TemporaryDirectory() as tmpdir:
venv = pathlib.Path(tmpdir) / 'venv'
venv_bin = venv / 'bin'
venv_pip = venv_bin / 'pip'
subprocess.check_call((sys.executable, '-m', 'venv', venv))
logging.info(f'Created a temporary venv in {venv}.')

subprocess.check_call((venv / 'bin' / 'pip', 'install', '--upgrade', 'pip'))
subprocess.check_call((venv / 'bin' / 'pip', 'install', '-r', REQUIREMENTS))
subprocess.check_call((venv_pip, 'install', '--upgrade', 'pip'))
subprocess.check_call((venv_pip, 'install', '-r', REQUIREMENTS))
logging.info(f'Installed test requirements in {venv}.')
subprocess.check_call(
(venv / 'bin' / 'pip', 'install', package),
)

(venv_site_pkg,) = venv.glob('lib/python*/site-packages')
bin_before = {path.name for path in venv_bin.iterdir()}
pkg_before = {path.name for path in venv_site_pkg.iterdir()}

subprocess.check_call((venv_pip, 'install', package))
logging.info(f'Installed {package} into {venv}.')

subprocess.check_call((venv / 'bin' / 'pytest', TESTS), cwd=venv)
bin_after = {path.name for path in venv_bin.iterdir()}
assert bin_after - bin_before == EXPECTED_SCRIPTS, (
f'Unexpected scripts installed in {venv_bin} from {package}: '
f'{bin_after - bin_before - EXPECTED_SCRIPTS}'
)
pkg_after = {
path.name for path in venv_site_pkg.iterdir() if path.suffix != '.dist-info'
}
assert pkg_after - pkg_before == EXPECTED_PACKAGES, (
f'Unexpected packages installed in {venv_site_pkg} from {package}: '
f'{pkg_after - pkg_before - EXPECTED_PACKAGES}'
)

subprocess.check_call((venv_bin / 'pytest', TESTS), cwd=venv)
logging.info(f'{package} passes tests.')


Expand Down