roman_ci.yml

name: CI

on:
  push:
    branches:
      - main
      - '*.x'
    tags:
      - '*'
  pull_request:
    branches:
      - main
  schedule:
    # Weekly Monday 9AM build
    # * is a special character in YAML so you have to quote this string
    - cron: '0 9 * * 1'

env:
  CRDS_SERVER_URL: https://roman-crds-test.stsci.edu
  CRDS_PATH: $HOME/crds_cache
  CRDS_CLIENT_RETRY_COUNT: 3
  CRDS_CLIENT_RETRY_DELAY_SECONDS: 20

jobs:
  style:
    name: Code style checks
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3.0.2
      - uses: actions/setup-python@v4.1.0
        id: python
        with:
          python-version: 3.9
      - uses: actions/cache@v3.0.5
        with:
          path: ${{ env.pythonLocation }}
          key: style-${{ runner.os }}-${{ env.pythonLocation }}-${{ hashFiles('**/pyproject.toml', '**/setup.*') }}
      - run: pip install pyproject-flake8
      - run: pip freeze
      - run: pflake8
  audit:
    name: Bandit security audit
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3.0.2
      - uses: actions/setup-python@v4.1.0
        id: python
        with:
          python-version: 3.9
      - uses: actions/cache@v3.0.5
        with:
          path: ${{ env.pythonLocation }}
          key: audit-${{ runner.os }}-${{ env.pythonLocation }}-${{ hashFiles('**/pyproject.toml', '**/setup.*') }}
      - run: pip install bandit
      - run: pip freeze
      - run: bandit romancal -r -x tests,regtest
  dependencies:
    name: verify dependencies are correct
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3.0.2
      - uses: actions/setup-python@v4.1.0
        id: python
        with:
          python-version: 3.9
      - uses: actions/cache@v3.0.5
        with:
          path: ${{ env.pythonLocation }}
          key: dependencies-${{ runner.os }}-${{ env.pythonLocation }}-${{ hashFiles('**/pyproject.toml', '**/setup.*') }}
      - run: pip install .
      - run: pip freeze
      - run: verify_install_requires
  test:
    name: test (${{ matrix.os }}, Python ${{ matrix.python }})
    needs: [ style, audit, dependencies ]
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-latest, macos-latest ]
        python: [ 3.8, 3.9, '3.10' ]
    steps:
      - uses: actions/checkout@v3.0.2
      - uses: actions/setup-python@v4.1.0
        id: python
        with:
          python-version: ${{ matrix.python }}
      - uses: actions/cache@v3.0.5
        with:
          path: ${{ env.pythonLocation }}
          key: test-${{ runner.os }}-${{ env.pythonLocation }}-${{ hashFiles('**/pyproject.toml', '**/setup.*') }}
      - run: pip install ".[test]" pytest-xdist
      - run: pip freeze
      - run: echo "CRDS_CONTEXT=$(crds list --operational-context)" >> $GITHUB_ENV
      - uses: actions/cache@v3.0.5
        if: env.CRDS_CONTEXT != ''
        with:
          path: ${{ env.CRDS_PATH }}
          key: crds-${{ env.CRDS_CONTEXT }}
      - run: crds sync --contexts ${{ env.CRDS_CONTEXT }}
        if: env.CRDS_CONTEXT != ''
      - run: pytest -n auto
  test_alldeps:
    name: test optional dependencies (${{ matrix.os }}, Python ${{ matrix.python }})
    needs: [ test ]
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-latest, macos-latest ]
        python: [ 3.8, 3.9, '3.10' ]
    steps:
      - uses: actions/checkout@v3.0.2
      - uses: actions/setup-python@v4.1.0
        id: python
        with:
          python-version: ${{ matrix.python }}
      - uses: actions/cache@v3.0.5
        with:
          path: ${{ env.pythonLocation }}
          key: test-alldeps-${{ runner.os }}-${{ env.pythonLocation }}-${{ hashFiles('**/pyproject.toml', '**/setup.*') }}
      - run: pip install ".[test,all]" pytest-xdist
      - run: pip freeze
      - run: echo "CRDS_CONTEXT=$(crds list --operational-context)" >> $GITHUB_ENV
      - uses: actions/cache@v3.0.5
        if: env.CRDS_CONTEXT != ''
        with:
          path: ${{ env.CRDS_PATH }}
          key: crds-${{ env.CRDS_CONTEXT }}
      - run: crds sync --contexts ${{ env.CRDS_CONTEXT }}
        if: env.CRDS_CONTEXT != ''
      - run: pytest -n auto
  test_devdeps:
    name: test developer versions (${{ matrix.os }}, Python ${{ matrix.python }})
    needs: [ test ]
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-latest, macos-latest ]
        python: [ 3.8, 3.9, '3.10' ]
    steps:
      - uses: actions/checkout@v3.0.2
      - uses: actions/setup-python@v4.1.0
        id: python
        with:
          python-version: ${{ matrix.python }}
      - uses: actions/cache@v3.0.5
        with:
          path: ${{ env.pythonLocation }}
          key: test-devdeps-${{ runner.os }}-${{ env.pythonLocation }}-${{ hashFiles('**/pyproject.toml', '**/setup.*') }}
      - run: pip install git+https://github.com/asdf-format/asdf git+https://github.com/spacetelescope/stpipe git+https://github.com/spacetelescope/stdatamodels --pre astropy numpy
      - run: pip install ".[test]" pytest-xdist
      - run: pip freeze
      - run: echo "CRDS_CONTEXT=$(crds list --operational-context)" >> $GITHUB_ENV
      - uses: actions/cache@v3.0.5
        if: env.CRDS_CONTEXT != ''
        with:
          path: ${{ env.CRDS_PATH }}
          key: crds-${{ env.CRDS_CONTEXT }}
      - run: crds sync --contexts ${{ env.CRDS_CONTEXT }}
        if: env.CRDS_CONTEXT != ''
      - run: pytest -n auto
  test_pyargs:
    name: test --pyargs (${{ matrix.os }}, Python ${{ matrix.python }})
    needs: [ test ]
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-latest, macos-latest ]
        python: [ 3.8, 3.9, '3.10' ]
        exclude:
          - os: macos-latest
            python: '3.10'
    steps:
      - uses: actions/checkout@v3.0.2
      - uses: actions/setup-python@v4.1.0
        id: python
        with:
          python-version: ${{ matrix.python }}
      - uses: actions/cache@v3.0.5
        with:
          path: ${{ env.pythonLocation }}
          key: test-pyargs-${{ runner.os }}-${{ env.pythonLocation }}-${{ hashFiles('**/pyproject.toml', '**/setup.*') }}
      - run: pip install ".[test]" pytest-xdist
      - run: pip freeze
      - run: echo "CRDS_CONTEXT=$(crds list --operational-context)" >> $GITHUB_ENV
      - uses: actions/cache@v3.0.5
        if: env.CRDS_CONTEXT != ''
        with:
          path: ${{ env.CRDS_PATH }}
          key: crds-${{ env.CRDS_CONTEXT }}
      - run: crds sync --contexts ${{ env.CRDS_CONTEXT }}
        if: env.CRDS_CONTEXT != ''
      - run: pytest -n auto --pyargs romancal
  test_older_numpy:
    name: test Numpy ${{ matrix.numpy }} (${{ matrix.os }}, Python ${{ matrix.python }})
    needs: [ test ]
    runs-on: ${{ matrix.os }}
    continue-on-error: true
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-latest ]
        python: [ 3.8, 3.9, '3.10' ]
        numpy: [ '1.18.*', '1.19.*', '1.20.*', '1.21.*', '1.22.*' ]
        exclude:
          - python: '3.10'
            numpy: '1.18.*'
          - python: '3.10'
            numpy: '1.19.*'
          - python: '3.10'
            numpy: '1.20.*'
    steps:
      - uses: actions/checkout@v3.0.2
      - uses: actions/setup-python@v4.1.0
        id: python
        with:
          python-version: ${{ matrix.python }}
      - uses: actions/cache@v3.0.5
        with:
          path: ${{ env.pythonLocation }}
          key: test-numpy${{ matrix.numpy }}-${{ runner.os }}-${{ env.pythonLocation }}-${{ hashFiles('**/pyproject.toml', '**/setup.*') }}
      - run: pip install -e ".[test]" pytest-xdist
      - run: pip install numpy==${{ matrix.numpy }}
      - run: pip freeze
      - run: echo "CRDS_CONTEXT=$(crds list --operational-context)" >> $GITHUB_ENV
      - uses: actions/cache@v3.0.5
        if: env.CRDS_CONTEXT != ''
        with:
          path: ${{ env.CRDS_PATH }}
          key: crds-${{ env.CRDS_CONTEXT }}
      - run: crds sync --contexts ${{ env.CRDS_CONTEXT }}
        if: env.CRDS_CONTEXT != ''
      - run: pytest -n auto
  test_with_coverage:
    name: test with coverage
    needs: [ test, test_alldeps, test_devdeps, test_pyargs, test_older_numpy ]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3.0.2
      - uses: actions/setup-python@v4.1.0
        id: python
        with:
          python-version: 3.9
      - uses: actions/cache@v3.0.5
        with:
          path: ${{ env.pythonLocation }}
          key: test-coverage-${{ runner.os }}-${{ env.pythonLocation }}-${{ hashFiles('**/pyproject.toml', '**/setup.*') }}
      - run: pip install ".[test]" pytest-xdist pytest-cov
      - run: pip freeze
      - run: echo "CRDS_CONTEXT=$(crds list --operational-context)" >> $GITHUB_ENV
      - uses: actions/cache@v3.0.5
        if: env.CRDS_CONTEXT != ''
        with:
          path: ${{ env.CRDS_PATH }}
          key: crds-${{ env.CRDS_CONTEXT }}
      - run: crds sync --contexts ${{ env.CRDS_CONTEXT }}
        if: env.CRDS_CONTEXT != ''
      - run: pytest -n auto --pyargs romancal --cov-report xml --cov
      - run: coverage report -m
      - uses: codecov/codecov-action@master
        with:
          file: ./coverage.xml
          flags: unit
          fail_ci_if_error: true
  build_docs:
    name: build HTML docs
    needs: [ test, test_alldeps, test_devdeps, test_pyargs, test_older_numpy ]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3.0.2
      - uses: actions/setup-python@v4.1.0
        id: python
        with:
          python-version: 3.9
      - uses: actions/cache@v3.0.5
        with:
          path: ${{ env.pythonLocation }}
          key: build-docs-${{ runner.os }}-${{ env.pythonLocation }}-${{ hashFiles('**/pyproject.toml', '**/setup.*') }}
      - run: sudo apt-get install graphviz texlive-latex-extra dvipng
      - run: pip install ".[docs]"
      - run: pip freeze
      - run: sphinx-build -W docs docs/_build