python_test_and_lint.yml

name: Testing and Linting

on:
  push:
    branches:
      - main
      - develop

jobs:
  build:
    runs-on: ubuntu-latest
    outputs:
      has_coverage: ${{ steps.generate_coverage.outputs.has_coverage }}
    strategy:
      matrix:
        python-version: ["3.8", "3.9", "3.10"]
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
      - name: Detect dependencies
        run: |
          python -m pip install --upgrade pip
          pip install pipreqs flake8 pytest coverage

      - name: Merge dependencies
        run: |
          pipreqs --encoding utf-8 --savepath requirements.pipreqs.txt
          if [ -f requirements.txt ]; then
            sort requirements.txt requirements.pipreqs.txt | uniq > requirements.txt.new
            mv requirements.txt.new requirements.txt
            rm requirements.pipreqs.txt
          else
            mv requirements.pipreqs.txt requirements.txt
          fi
      - name: Install dependencies
        run: |
          pip install -r requirements.txt

      - name: Lint with flake8
        run: |
          # stop the build if there are Python syntax errors or undefined names
          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
      - name: Test with pytest
        run: |
          pytest

      - name: Run coverage
        id: generate_coverage
        run: |
          coverage run -m unittest
          echo "# Coverage report $(date)" > coverage.tmp
          echo "" >> coverage.tmp
          echo "\`\`\`bash" >> coverage.tmp
          coverage report >> coverage.tmp
          echo "\`\`\`" >> coverage.tmp
          echo "" >> coverage.tmp
          echo "Automatically generated file by github action"
          
          if cmp -s "coverage.tmp" "COVERAGE.md"; then
            echo "No change to coverage"
          else            
            echo ::set-output name=has_coverage::True
            mv coverage.tmp COVERAGE.md
          fi

      - uses: actions/upload-artifact@v2
        if: steps.generate_coverage.outputs.has_coverage == 'True'
        with:
          name: coverage_md
          path: COVERAGE.md

  coverage_commit:
    runs-on: ubuntu-latest
    needs: [build]
    if: needs.build.outputs.has_coverage == 'True'
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0 # OR "2" -> To retrieve the preceding commit.
      - uses: actions/download-artifact@v2
        with:
          name: coverage_md

      - uses: stefanzweifel/git-auto-commit-action@v4
        with:
          commit_message: Update coverage report