gha-workflows/.github/workflows/ci-python.yml

name: Python CI
on:
  workflow_call:
    inputs:
      python-version:
        type: string
        default: "3.11"
        description: "Version of Python to use for testing environment"
    secrets:
      SONAR_TOKEN:
        required: true
      SNYK_TOKEN:
        required: true

jobs:
  ci:
    runs-on: ubuntu-latest
    steps:
      - name: Set python-version
        id: python-version
        run: |
          PYTHON_VERSION=${{ inputs.python-version }}
          echo "value=${PYTHON_VERSION:-"3.11"}" >> $GITHUB_OUTPUT
      - name: Check out repository code
        uses: actions/checkout@v4.2.2
        with:
          fetch-depth: 0
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "${{ steps.python-version.outputs.value }}"
      - name: Update Pip
        run: |
          pip install -U pip
      - name: Install dependencies
        run: |
          pip install -r requirements.txt
          pip install -r requirements-dev.txt
      - name: Lint
        run: pylint --fail-under=8 --recursive=yes --output-format=parseable --output=lintreport.txt .
      - name: Unit Test
        run: |
          coverage run -m pytest -v --junitxml=testresults.xml
          coverage xml
          sed -i 's@${{ github.workspace }}@/github/workspace@g' coverage.xml
      - name: SonarQube Cloud Scan
        uses: SonarSource/sonarqube-scan-action@v4.2.1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
      - name: Snyk Vulnerability Scan
        uses: snyk/actions/python-3.10@master
        continue-on-error: true # To make sure that SARIF upload gets called
        env:
          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
        with:
          args: --sarif-file-output=snyk.sarif --all-projects
      - name: Upload result to GitHub Code Scanning
        uses: github/codeql-action/upload-sarif@v3
        with:
          sarif_file: snyk.sarif