Python Tests #127
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
# GitHub Actions workflow for testing and continuous integration. | |
# | |
# This file performs testing using tox and tox.ini to define and configure the test environments. | |
name: Python Tests | |
on: | |
push: | |
pull_request: | |
schedule: | |
# Weekly Monday 4 AM build | |
# * is a special character in YAML so you have to quote this string | |
- cron: '0 4 * * 1' | |
jobs: | |
# Set up matrix to run tox tests across lists of os, python version, and tox environment | |
matrix_tests: | |
runs-on: ${{ matrix.os }} | |
if: "!contains(github.event.head_commit.message, '[ci skip]')" # github actions doesn't yet support this natively so add here | |
strategy: | |
matrix: | |
# Github actions supports ubuntu, windows, and macos virtual environments: | |
# https://help.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners | |
# | |
# Only run on ubuntu by default, but can add other os's to the test matrix here. | |
# For example -- os: [ubuntu-latest, macos-latest, windows-latest] | |
# windows-latest not possible due to how temp files are used in tests currently | |
# macos failing due to an issue installing h5py - KDG 14may24 | |
# os: [ubuntu-latest, macos-latest] | |
os: [ubuntu-latest] | |
# Test python version 3.x | |
python-ver: [10, 11, 12] | |
# Specify which tox environments to test in this list. | |
# tox-env: [cov, alldeps, devdeps, astropylts] | |
tox-env: [alldeps] | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up python 3.${{ matrix.python-ver }} with tox environment py3${{ matrix.python-ver }}-${{ matrix.tox-env }} on ${{ matrix.os }} | |
uses: actions/setup-python@v4 | |
with: | |
python-version: 3.${{ matrix.python-ver }} | |
- name: Install base dependencies | |
run: | | |
python -m pip install --upgrade pip | |
python -m pip install tox | |
- name: Test with tox | |
run: | | |
tox -e py3${{ matrix.python-ver }}-${{ matrix.tox-env }} | |
# Dev version test | |
# dev_test: | |
# runs-on: ubuntu-latest | |
# if: "!contains(github.event.head_commit.message, '[ci skip]')" | |
# steps: | |
# - uses: actions/checkout@v1 | |
# - name: Set up python for astropy, numpy dev test | |
# uses: actions/setup-python@v1 | |
# with: | |
# python-version: 3.8 | |
# - name: Install base dependencies | |
# run: | | |
# python -m pip install --upgrade pip | |
# python -m pip install tox | |
# - name: Test with tox | |
# run: | | |
# tox -e py38-devdeps | |
# LTS version test | |
lts_test: | |
runs-on: ubuntu-latest | |
if: "!contains(github.event.head_commit.message, '[ci skip]')" | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up python for astropy lts test | |
uses: actions/setup-python@v4 | |
with: | |
python-version: 3.11 | |
- name: Install base dependencies | |
run: | | |
python -m pip install --upgrade pip | |
python -m pip install tox | |
- name: Test with tox | |
run: | | |
tox -e py311-astropylts | |
# Coverage test | |
cov_test: | |
runs-on: ubuntu-latest | |
if: "!contains(github.event.head_commit.message, '[ci skip]')" | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up python for coverage test | |
uses: actions/setup-python@v4 | |
with: | |
python-version: 3.9 | |
- name: Install base dependencies | |
run: | | |
python -m pip install --upgrade pip | |
python -m pip install tox | |
- name: Test with tox | |
run: | | |
tox -e py309-cov -- --remote-data | |
- name: Upload coverage to codecov | |
uses: codecov/codecov-action@v4 | |
with: | |
token: ${{ secrets.CODECOV }} | |
fail_ci_if_error: true | |
# if: matrix.tox-env == 'cov' && matrix.python-ver == '8' | |
# uses: coverallsapp/github-action@master | |
# with: | |
# github_token: ${{ secrets.COVERALLS }} | |
# # file: ./coverage.xml | |
# fail_ci_if_error: true | |
# Test building of docs and check the links | |
doc_test: | |
runs-on: ubuntu-latest | |
if: "!contains(github.event.head_commit.message, '[ci skip]')" | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python to build docs with sphinx | |
uses: actions/setup-python@v4 | |
with: | |
python-version: 3.12 | |
- name: Install base dependencies | |
run: | | |
python -m pip install --upgrade pip | |
python -m pip install tox | |
sudo apt-get install graphviz | |
- name: Build and check docs using tox | |
run: | | |
tox -e build_docs | |
tox -e linkcheck | |
# Perform codestyle check | |
codestyle: | |
runs-on: ubuntu-latest | |
if: "!contains(github.event.head_commit.message, '[ci skip]')" | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Python codestyle check | |
uses: actions/setup-python@v4 | |
with: | |
python-version: 3.12 | |
- name: Install base dependencies | |
run: | | |
python -m pip install --upgrade pip | |
python -m pip install tox | |
- name: Check codestyle using tox | |
run: | | |
tox -e codestyle |