pr.yml

name: PR
on:
  push:
    branches:
      - main
  pull_request:

jobs:
  format:
    name: format
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Install Rust
        uses: actions-rs/toolchain@v1
        with:
          profile: minimal
          toolchain: stable
          override: true

      - name: Add rustfmt
        run: rustup component add rustfmt

      - name: rustfmt
        run: cargo fmt --check

  lint:
    name: lint
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Install Rust
        uses: actions-rs/toolchain@v1
        with:
          profile: minimal
          toolchain: stable
          override: true

      - name: Install tools
        run: sudo apt update && sudo apt install libgtk-3-dev -y

      - name: Add clippy
        run: rustup component add clippy

      - name: clippy
        run: cargo clippy --all-targets -- -D warnings

  tests:
    name: tests
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Install Rust
        uses: actions-rs/toolchain@v1
        with:
          profile: minimal
          toolchain: stable
          override: true

      - name: Install tools
        run: sudo apt update && sudo apt install libgtk-3-dev -y

      # TODO: incorporate code coverage with tarpaulin or grcov
      - name: Run tests
        uses: actions-rs/cargo@v1
        with:
          command: test
          args: --no-fail-fast

  compile:
    name: build
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Install Rust
        uses: actions-rs/toolchain@v1
        with:
          profile: minimal
          toolchain: stable
          override: true

      - name: Install tools
        run: sudo apt update && sudo apt install libgtk-3-dev -y

      - name: Compile
        uses: actions-rs/cargo@v1
        with:
          command: build

  visual-regression-tests:
    name: visual-regression-tests
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Install Node JS 16
        uses: actions/setup-node@v3
        with:
          node-version: 16

      - name: Install jq
        run: |
          sudo apt-get -qq update
          sudo apt-get install -y jq

      - name: Build Docker Image
        run: docker build . -t squint-local

      - name: Start Squint Container
        run: docker run -d -p 3001:3001 --name local-squint-container squint-local

      - name: Install testing packages
        run: |
          cd visual_regression_testing
          npm ci

      - name: Run Visual Regression Tests
        run: |
          cd visual_regression_testing
          ./compare.sh

      - name: Archive diffs
        if: always()
        uses: actions/upload-artifact@v3
        with:
          name: diffs
          path: visual_regression_testing/diffs

      - name: Stop Squint Container
        run: docker stop local-squint-container