test-e2e-vizro-screenshots.yml

name: e2e vizro screenshots tests

defaults:
  run:
    working-directory: vizro-core

on:
  push:
    branches: [main]
  pull_request:
    branches:
      - main

env:
  PYTHONUNBUFFERED: 1
  FORCE_COLOR: 1
  PYTHON_VERSION: "3.12"

jobs:
  test-e2e-vizro-screenshots:
    name: test-e2e-vizro-screenshots for ${{ matrix.config.browser }}
    runs-on: ubuntu-latest

    strategy:
      fail-fast: false
      matrix:
        config:
          - browser: chrome
            command: "-m 'not mobile_screenshots'"
          - browser: chrome_mobile
            command: "-m mobile_screenshots"
          - browser: firefox
            command: "--webdriver Firefox -m 'not mobile_screenshots'"

    steps:
      - uses: actions/checkout@v4

      - name: Set up Python ${{ env.PYTHON_VERSION }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Install Hatch
        run: pip install hatch

      - name: Install pixelmatch
        run: sudo npm install pixelmatch -g

      - name: Show dependency tree
        run: hatch run pip tree

      - name: Run e2e vizro-screenshots tests
        run: |
          export BROWSER=${{ matrix.config.browser }}
          hatch run test-e2e-vizro-screenshots ${{ matrix.config.command }}

      - name: Create artifacts and slack notifications
        if: failure()
        uses: ./.github/actions/failed-artifacts-and-slack-notifications
        env:
          TESTS_NAME: Vizro e2e vizro screenshots tests for ${{ matrix.config.browser }}
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
          PROJECT_PATH: /home/runner/work/vizro/vizro/vizro-core/
          FAILED_SCREENSHOTS_ARCHIVE_POSTFIX: ${{ matrix.config.browser }}