build_test.yml

name: Building and Testing

on:
  #triggers the workflow on push or pull request events but only for the master branch
  push:
    branches: [ main ]
    paths-ignore: 
      - '**/.md'
      - '**/.yml'
      - '**/.ipynb'
      - 'docs/**/*'
      - LICENSE
      - .gitignore
  pull_request:
    branches: [ main ]

  #allow for workflow to be manually triggered from the Actions tab
  workflow_dispatch:

#build and test iso3166_2
jobs:
  #build job
  test:
    name: Setup environment
    timeout-minutes: 15
    runs-on: ${{ matrix.os }}
    strategy:
        matrix:
            # os: [ubuntu-latest, windows-latest] #testing on multiple OS's, macos-latest
            os: [ubuntu-latest]
            python-version: ["3.8", "3.9", "3.10"]   #testing on multiple python versions
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v3
      with:
        python-version: ${{ matrix.python-version }}

    #install all required modules and dependancies using pip and setup.py installation
    - name: Install dependencies
      run: |
        python -m pip install pip
        python3 -m pip install setuptools wheel twine
        pip install flake8 pytest
        pip install pytest
        pip install codecov
        pip install pytest-cov
        pip install bandit
        pip install safety
        pip install importlib-metadata
        pip install iso3166-2
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
        python3 setup.py install
    
    #create artifacts dir
    - name: Artifacts mkdir
      run: mkdir artifacts

    #package vulnerability check
    - name: Package safety check
      run: |
        echo "Running package safety check"
        python3 -m safety check > artifacts/package_safety_output.txt
        cat artifacts/package_safety_output.txt
      continue-on-error: true

    #run Bandit security check for any known vulnerabilities in code
    - name: Bandit
      run: |
       echo "Running Bandit"
       python3 -m bandit -r iso3166_2 > artifacts/bandit_output.txt
       cat artifacts/bandit_output.txt
      continue-on-error: true

    #unit tests using pytest, unittest, flake8 and bandit frameworks
    - name: Testing with unittest
      env:
        GOOGLE_MAPS_API_KEY: ${{ secrets.GOOGLE_MAPS_API_KEY }}
      run: |
        echo "Testing using unittest..."
        python3 -m unittest discover tests -b
    
    #create coverage report using pytest package
    - name: Generate Coverage Report 
      run: |
        pytest --cov=./ --cov-report=xml
        codecov

    #upload to Code Coverage, only if matrix python version is 3.9
    - name: Upload Coverage Report to Codecov
      if: ${{ matrix.python-version == '3.9' }}
      uses: codecov/codecov-action@v3
      env: 
        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
      with:
        flags: iso3166_2_workflow  
   
    #upload test artifacts to workflow
    - name: Upload Test Artifacts
      uses: actions/upload-artifact@v3
      with:
        name: test_artifacts
        path: |
          artifacts/package_safety_output.txt
          artifacts/bandit_output.txt
          artifacts/coverage.txt
        if-no-files-found: error 

  #linter check on repo
  linter:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.8", "3.9", "3.10"]   #testing on multiple python versions

    steps:
      #checkout repo
      - name: Checkout repo
        uses: actions/checkout@v3

      # install all required modules and dependancies using pip installation
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install flake8 pytest
      
      #create temp artifacts repo
      - name: Artifacts mkdir
        run: mkdir flake8_artifacts

      #linting with flake8
      - name: Lint with flake8
        run: |
          echo "Testing using flake8..."
          # stop the build if there are Python syntax errors or undefined names
          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics > flake8_artifacts/flake8_output.txt
          # 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 >> flake8_artifacts/flake8_output.txt
        continue-on-error: true
      
      #upload artifacts to repo
      - name: Upload flake8 Artifact
        uses: actions/upload-artifact@v3
        with:
          name: flake8_artifact
          path: flake8_artifacts/flake8_output.txt
          if-no-files-found: error