test.yaml

name: tests

on:
  push:
  pull_request:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref != 'refs/heads/master' && github.ref || github.run_id }}-${{ github.event_name }}
  cancel-in-progress: true

env:
  RUN: docker run -v ${{ github.workspace }}:/tmp/openpilot/panda -w /tmp/openpilot/panda -v $GITHUB_WORKSPACE/panda_cache:/tmp/panda_cache --rm panda /bin/bash -c
  BUILD: |
      export DOCKER_BUILDKIT=1
      docker build --pull --build-arg BUILDKIT_INLINE_CACHE=1 --cache-from ghcr.io/commaai/panda:latest -t panda -f Dockerfile .

  PYTHONWARNINGS: "error"

jobs:
  docker_push:
    name: docker push
    runs-on: ubuntu-20.04
    timeout-minutes: 20
    if: github.ref == 'refs/heads/master' && github.event_name != 'pull_request' && github.repository == 'commaai/panda'
    steps:
      - uses: actions/checkout@v2
      - name: Build Docker image
        timeout-minutes: 11
        run: eval "$BUILD"
      - name: Login to dockerhub
        run: docker login ghcr.io -u ${{ github.actor }} -p ${{ secrets.GITHUB_TOKEN }}
      - name: Tag image
        run: docker tag panda ghcr.io/commaai/panda:latest
      - name: Push image
        run: docker push ghcr.io/commaai/panda:latest

  build:
    name: build
    runs-on: ubuntu-20.04
    timeout-minutes: 20
    steps:
      - uses: actions/checkout@v2
      - name: Build Docker image
        run: eval "$BUILD"
      - name: Test python package installer
        run: ${{ env.RUN }} "python setup.py install"
      - name: Build panda + pedal images and bootstub
        run: ${{ env.RUN }} "scons -j4"
      - name: Build panda with SPI support
        run: ${{ env.RUN }} "ENABLE_SPI=1 scons -j4"
      - name: Build with UBSan
        run: ${{ env.RUN }} "scons -j4 --ubsan"
      - name: Build jungle firmware with FINAL_PROVISIONING support
        run: ${{ env.RUN }} "FINAL_PROVISIONING=1 scons -j4 board/jungle"

  unit_tests:
    name: unit tests
    runs-on: ubuntu-20.04
    timeout-minutes: 20
    steps:
      - uses: actions/checkout@v2
      - name: Build Docker image
        run: eval "$BUILD"
      - name: Build panda
        run: ${{ env.RUN }} "scons -j4"
      - name: Test communication protocols
        run: ${{ env.RUN }} "cd tests/usbprotocol && ./test.sh"

  safety:
    name: safety
    runs-on: ubuntu-20.04
    strategy:
      matrix:
        flags: ['', '--ubsan']
    timeout-minutes: 20
    steps:
      - uses: actions/checkout@v2
      - name: Build Docker image
        run: eval "$BUILD"
      - name: Run safety tests
        timeout-minutes: 5
        run: |
          ${{ env.RUN }} "cd .. && \
                          scons -c && \
                          scons -j$(nproc) opendbc/ cereal/ && \
                          cd panda && \
                          scons -j$(nproc) ${{ matrix.flags }} && \
                          tests/safety/test.sh"

  safety_coverage:
    name: safety coverage
    runs-on: ubuntu-20.04
    timeout-minutes: 20
    steps:
      - uses: actions/checkout@v2
      - name: Build Docker image
        run: eval "$BUILD"
      - name: Run safety coverage test
        timeout-minutes: 5
        run: |
          ${{ env.RUN }} "cd .. && \
                          scons -c && \
                          scons -j$(nproc) opendbc/ cereal/ && \
                          cd panda/tests/safety && \
                          ./test_coverage.sh"

  misra:
    name: MISRA C:2012
    runs-on: ubuntu-20.04
    timeout-minutes: 20
    steps:
      - uses: actions/checkout@v2
      - name: Build Docker image
        run: eval "$BUILD"
      - name: Setup CI cache
        id: restore-panda-cache
        uses: actions/cache@v3
        with:
          path: $GITHUB_WORKSPACE/panda_cache
          key: ${{ runner.os }}-${{ hashFiles('**/test_mutation.py') }}-${{ hashFiles('**/test_misra.sh') }}
      - name: cache setup
        if: steps.restore-panda-cache.outputs.cache-hit != 'true'
        run: mkdir -p $GITHUB_WORKSPACE/panda_cache
      - name: Build FW
        run: ${{ env.RUN }} "scons -j$(nproc)"
      - name: Run MISRA C:2012 analysis
        timeout-minutes: 1
        run: ${{ env.RUN }} "cd tests/misra && ./test_misra.sh"
      - name: MISRA mutation tests
        timeout-minutes: 5
        run: ${{ env.RUN }} "cd tests/misra && ./test_mutation.py"

  python_linter:
    name: python linter
    runs-on: ubuntu-20.04
    timeout-minutes: 20
    steps:
      - uses: actions/checkout@v2
      - name: Build Docker image
        run: eval "$BUILD"
      - name: Run static analysis
        timeout-minutes: 3
        run: ${{ env.RUN }} "pre-commit run --all"