tests.yml

name: Tests

on:
  push:
    branches:
    - master
    paths:
    - '**.py'
    - 'pip-dep/**'

  pull_request:
    types: [opened, synchronize, reopened]
    paths:
    - '**.py'
    - 'pip-dep/**'

jobs:
  python-tests:

    runs-on: ubuntu-latest
    strategy:
      max-parallel: 4
      matrix:
        python-version: [3.6, 3.7]

    steps:
    - uses: actions/checkout@v2
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v1
      with:
        python-version: ${{ matrix.python-version }}
    - uses: actions/cache@v1.1.2
      id: cache-reqs
      with:
        path: ~/.cache/pip
        key: ${{ runner.os }}-python-${{ matrix.python-version }}-pip-${{ hashFiles('pip-dep/requirements*.txt') }}
    - name: Install dependencies
      run: |
        sudo apt-get update
        python -m pip install --upgrade pip
        hash -r
        pip3 install -r pip-dep/requirements.txt
        pip3 install -r pip-dep/requirements_dev.txt
        pip3 install -r pip-dep/requirements_udacity.txt
        pip3 install -r pip-dep/requirements_notebooks.txt
        python setup.py install
    - name: Lint, format, and type-check
      run: |
        pip3 install flake8
        #- pip3 install flake8-docstrings
        pip3 install flake8-comprehensions
        pip3 install pep8-naming
        # stop the build if there are Python syntax errors or undefined names
        flake8 --config=.flake8 .
        black --check --verbose .
        # exit-zero treats all errors as warnings.
        # diverting from the standard 79 character line length in
        # accordance with this:
        # https://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds
        flake8 . --count --exit-zero --statistics --select=E,F,W,C90
        # Run type checker in CI such that type errors can be identified and gradually addressed.
        # Once all existing type errors are addressed, the `|| echo` after the mypy call can be removed.
        mypy syft || echo "Type errors found, continuing build..."
    - name: Scan for security issues
      run: |
            bandit -r syft -ll
    - name: Install codecov
      run: |
        pip3 install codecov
    - name: Run tests
      run: |
        coverage run -m pytest test/ --randomly-dont-reset-seed --deselect=test/efficiency --deselect=test/notebooks
    - name: Check test coverage
      run: |
        coverage report --ignore-errors --fail-under 95 -m
        # ensuring coverage of tests stays at 100 until entire coverage can be 100
        coverage report --ignore-errors --fail-under 100 -m --include="test/*"
    - name: Run codecov
      run: |
        bash <(curl -s https://codecov.io/bash) -t a74f260d-4d79-4591-a38b-77f81447c9fb -X gcov
    - name: Build docs
      run: |
        # delete stale existing documentation if there's one
        make -C ./docs/ clean
        make -C ./docs/ html