libcosmic/.github/workflows/ci.yml

name: Continuous Integration

on:
  push:
    branches:
      - master
  pull_request:


jobs:
  format:
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout sources
        uses: actions/checkout@v3
      - name: Rust toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt
      - name: Cargo cache
        uses: actions/cache@v3
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
          key: ${{ runner.os }}-cargo-rust_stable-${{ hashFiles('**/Cargo.toml') }}
      - name: Format
        run: cargo fmt -- --check

  tests:
    needs:
      - format
    strategy:
      fail-fast: false
      matrix:
        features:
        - "" # for cosmic-comp, don't remove!
        - 'winit_debug'
        - 'winit_tokio'
        - winit
        - winit_wgpu
        - wayland
        - applet
        - desktop,smol
        - desktop,tokio
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout sources
        uses: actions/checkout@v3
        with:
          submodules: recursive
      - name: Get date for registry cache
        id: date
        run: echo "::set-output name=date::$(date +'%Y-%m-%d')"
      - name: Cargo registry cache
        uses: actions/cache@v3
        with:
          path: |
            ~/.cargo/registry/index
            ~/.cargo/registry/cache
            ~/.cargo/git
          key: ${{ runner.os }}-cargo-registry-${{ steps.date.outputs.date }}
          restore-keys: ${{ runner.os }}-cargo-registry-
      - name: System dependencies
        run: sudo apt-get update; sudo apt-get install -y libxkbcommon-dev libwayland-dev
      - name: Rust toolchain
        uses: dtolnay/rust-toolchain@stable
      - name: Test features
        run: cargo test --no-default-features --features "${{ matrix.features }}"
        env:
          RUST_BACKTRACE: full

  visual-tests:
    needs:
      - format
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout sources
        uses: actions/checkout@v3
        with:
          submodules: recursive
      - name: Get date for registry cache
        id: date
        run: echo "::set-output name=date::$(date +'%Y-%m-%d')"
      - name: Cargo registry cache
        uses: actions/cache@v3
        with:
          path: |
            ~/.cargo/registry/index
            ~/.cargo/registry/cache
            ~/.cargo/git
          key: ${{ runner.os }}-cargo-registry-visual-${{ steps.date.outputs.date }}
          restore-keys: ${{ runner.os }}-cargo-registry-visual-
      - name: System dependencies
        run: sudo apt-get update; sudo apt-get install -y libxkbcommon-dev libwayland-dev
      - name: Rust toolchain
        uses: dtolnay/rust-toolchain@stable
      - name: Run visual snapshot tests
        run: cargo test --no-default-features --test visual_tests
        env:
          RUST_BACKTRACE: full
      - name: Run theme consistency tests
        run: cargo test --no-default-features --test theme_tests
        env:
          RUST_BACKTRACE: full
      - name: Run property-based tests
        run: cargo test --no-default-features --test property_tests
        env:
          RUST_BACKTRACE: full
      - name: Run widget unit tests
        run: cargo test --no-default-features --test widget_unit_tests
        env:
          RUST_BACKTRACE: full
      - name: Upload snapshot artifacts on failure
        if: failure()
        uses: actions/upload-artifact@v3
        with:
          name: snapshot-diffs
          path: |
            tests/snapshots/*.actual.png
            tests/snapshots/*.diff.png

  examples:
    needs:
      - format
    strategy:
      fail-fast: false
      matrix:
        examples:
          - "application"
          - "open-dialog"
          - "context-menu"
          - "nav-context"
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout sources
        uses: actions/checkout@v3
        with:
          submodules: recursive
      - name: Get date for registry cache
        id: date
        run: echo "::set-output name=date::$(date +'%Y-%m-%d')"
      - name: Cargo registry cache
        uses: actions/cache@v3
        with:
          path: |
            ~/.cargo/registry/index
            ~/.cargo/registry/cache
            ~/.cargo/git
          key: ${{ runner.os }}-cargo-registry-${{ steps.date.outputs.date }}
          restore-keys: ${{ runner.os }}-cargo-registry-
      - name: System dependencies
        run: sudo apt-get update; sudo apt-get install -y libxkbcommon-dev libwayland-dev
      - name: Rust toolchain
        uses: dtolnay/rust-toolchain@stable
      - name: Test example
        run: cargo check -p "${{ matrix.examples }}"
        env:
          RUST_BACKTRACE: full