Test installation PyPI #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Test installation of the latest version from PyPI works. | |
# We make sure that we run the tests that apply to the version we installed, | |
# rather than the latest tests in main. | |
# The reason we do this, is that we want this workflow to test | |
# that installing from PyPI leads to a correct installation. | |
# If we tested against main, the tests could fail | |
# because the tests from main require the new features in main to pass. | |
name: Test installation PyPI | |
on: | |
workflow_dispatch: | |
schedule: | |
# * is a special character in YAML so you have to quote this string | |
# This means At 03:00 on Wednesday. | |
# see https://crontab.guru/#0_0_*_*_3 | |
- cron: '0 3 * * 3' | |
jobs: | |
test-pypi-install: | |
name: Test PyPI install ${{ matrix.install-target }} (${{ matrix.python-version }}, ${{ matrix.os }}) | |
strategy: | |
fail-fast: false | |
matrix: | |
os: ["ubuntu-latest", "macos-latest", "windows-latest"] | |
# Test against all security and bugfix versions: https://devguide.python.org/versions/ | |
python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ] | |
# Check both 'library' install and the 'application' (i.e. locked) install | |
install-target: ["attribution-scratch", "attribution-scratch[locked]"] | |
runs-on: "${{ matrix.os }}" | |
steps: | |
- name: Set up Python "${{ matrix.python-version }}" | |
id: setup-python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "${{ matrix.python-version }}" | |
- name: Install | |
run: | | |
pip install --upgrade pip wheel | |
pip install "${{ matrix.install-target }}" 2>stderr.txt | |
- name: Check no warnings | |
if: matrix.os != 'windows-latest' | |
run: | | |
if grep -q "WARN" stderr.txt; then echo "Warnings in pip install output" && cat stderr.txt && exit 1; else exit 0; fi | |
- name: Get version non-windows | |
if: matrix.os != 'windows-latest' | |
run: | | |
INSTALLED_VERSION=`python -c 'import attribution_scratch; print(f"v{attribution_scratch.__version__}")'` | |
echo $INSTALLED_VERSION | |
echo "INSTALLED_VERSION=$INSTALLED_VERSION" >> $GITHUB_ENV | |
- name: Get version windows | |
if: matrix.os == 'windows-latest' | |
run: | | |
chcp 65001 # use utf-8 | |
python -c 'import attribution_scratch; f = open("version.txt", "w"); f.write(f"INSTALLED_VERSION=v{attribution_scratch.__version__}"); f.close()' | |
echo "Showing version.txt" | |
type version.txt | |
type version.txt >> $env:GITHUB_ENV | |
- name: Check installed version environment variable | |
run: | | |
echo "${{ env.INSTALLED_VERSION }}" | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
with: | |
ref: ${{ env.INSTALLED_VERSION }} | |
- name: Test installation | |
run: | | |
which python | |
python scripts/test-install.py | |
- name: Install min test dependencies | |
run: | | |
pip install -r requirements-only-tests-min-locked.txt | |
- name: Run tests | |
run: | | |
# Can't run doctests here because the paths are different. | |
# This only runs with minimum test dependencies installed. | |
# So this is really just a smoke test, | |
# rather than a super thorough integration test. | |
# You will have to make sure that your tests run | |
# without all the extras installed for this to pass. | |
pytest tests -r a -vv tests | |
- name: Install all test dependencies | |
run: | | |
pip install -r requirements-only-tests-locked.txt | |
- name: Run tests with extra test dependencies installed | |
run: | | |
# Can't run doctests here because the paths are different. | |
pytest tests -r a -vv tests |