unit_tests.yaml

name: CI - Unit Tests

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  # run unit tests
  test:
    runs-on: ubuntu-latest

    steps:
      # checkout the repository
      - uses: actions/checkout@v4
      
      # enable caching of pip and platformio
      - uses: actions/cache@v4
        with:
          path: |
            ~/.cache/pip
            ~/.platformio/.cache
          key: ${{ runner.os }}-pio
      
      # install GCC for platformio native platform
      # https://docs.platformio.org/en/latest/platforms/native.html#installation
      - name: Install GCC
        run: sudo apt-get install -y build-essential

      # install python
      - uses: actions/setup-python@v5
        with:
          python-version: '3.9'

      # install platformio
      - name: Install PlatformIO core
        run: pip install --upgrade platformio
      
      # create test/.pio/test/ folder
      - name: Create test/.pio/test folder
        run: mkdir -p test/.pio/test

      # run unit tests using 'test-native' environment
      - name: Run Unit Tests (native)
        run: pio test --project-dir ./test --environment native --junit-output-path 'test/.pio/test/native.xml'

      # upload test results
      - uses: test-summary/action@v2
        with:
          paths: "test/.pio/test/*.xml"
          show: "all"
        if: always()