test_stub_quality.yml

name: test_stub_quality
on: [ pull_request, workflow_dispatch] # Not on push to avoid wasting 15 mins CPU 

env:
  # Setting an environment variable with the value of a configuration variable
  SNIPPET_SCORE: ${{ vars.SNIPPET_SCORE }}
  GH_TOKEN_VARS: ${{ secrets.GH_TOKEN_VARS }}
  # fix:  DeprecationWarning: Jupyter is migrating its paths to use standard platformdirs
  JUPYTER_PLATFORM_DIRS: "1"


jobs:
  test_snippets:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      #----------------------------------------------

      - name: Install poetry # poetry is not in the default image
        run: pipx install poetry

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11" # Replace with the Python version you're using

      - name: Testspace client install & config
        uses: testspace-com/setup-testspace@v1
        with:
          domain: josverl
      #----------------------------------------------
      # install project
      #----------------------------------------------
      - name: Install dependencies for group test
        run: | 
          pip install -r requirements-test.txt

      #----------------------------------------------
      # stubber clone
      # repos needed for tests
      #----------------------------------------------
      - name: stubber clone
        run: stubber clone


      - name: update the stubs (not pushed) 
        continue-on-error: true
        run: |
          pwsh -file ./update-stubs.ps1

      - name: Test the snippets 
        continue-on-error: true
        run: |
          pytest -m 'snippets' --cache-clear --junitxml=./results/results.xml

      - name: Testspace push test content
        run: |
          testspace ./results/results.xml

      - name: compare and update
        run: |
          python .github/workflows/compare_score.py