ci-unit-tests.yml

#
# ci-unit-tests.yml
# Build and execute unit tests to catch functional issues in code
#

name: CI - Unit Tests

on:
  pull_request:
    branches:
    - 2024-December
    paths-ignore:
    - configurations/**
    - display assets/**
    - data/**
    - docs/**
    - docker/**
    - slicer scripts/**
    - test/**
    - themes/**
    - Marlin/tests/**
    - '**/*.md'
  push:
    branches:
    - 2024-December
    paths-ignore:
    - configurations/**
    - display assets/**
    - data/**
    - docs/**
    - docker/**
    - slicer scripts/**
    - test/**
    - themes/**
    - Marlin/tests/**
    - '**/*.md'

jobs:
  # This runs all unit tests as a single job. While it should be possible to break this up into
  # multiple jobs, they currently run quickly and finish long before the compilation tests.
  run_unit_tests:
    name: Unit Test
    # These tests will only be able to run on the bugfix-2.1.x branch, until the next release
    # pulls them into additional branches.
    if: github.repository == 'classicrocker883/MRiscoCProUI'

    runs-on: ubuntu-latest

    steps:
    - name: Check out the PR
      uses: actions/checkout@main

    - name: Cache pip
      uses: actions/cache@main
      with:
        path: ~/.cache/pip
        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
        restore-keys: |
          ${{ runner.os }}-pip-

    - name: Cache PlatformIO
      uses: actions/cache@main
      with:
        path: ~/.platformio
        key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}

    - name: Select Python 3.11
      uses: actions/setup-python@main
      with:
        python-version: '3.11'
        architecture: 'x64'

    - name: Install PlatformIO
      run: |
        pip install -U pip wheel platformio
        pio upgrade --dev
        pio pkg update --global

    - name: Run All Unit Tests
      run: |
        make unit-test-all-local