backend-test.yaml

#
# This file is part of Edgehog.
#
# Copyright 2021-2024 SECO Mind Srl
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
#

name: Backend CI

on:
  # Run when pushing to stable branches
  push:
    paths:
    - 'backend/**'
    - '.tool-versions'
    - '.github/workflows/backend-test.yaml'
    branches:
    - 'main'
    - 'release-*'
  # Run on pull requests matching apps
  pull_request:
    paths:
    - 'backend/**'
    - '.tool-versions'
    - '.github/workflows/backend-test.yaml'

env:
  MIX_ENV: test
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

defaults:
  run:
    # Define the default working-directory for all run steps
    working-directory: backend

jobs:
  lint:
    name: Lint
    runs-on: ubuntu-22.04
    steps:
    - name: Checkout repository
      uses: actions/checkout@v4
      with:
        show-progress: false

    - name: Install OTP and Elixir
      uses: erlef/setup-beam@v1
      id: beam
      with:
        version-file: .tool-versions
        version-type: strict

    - name: Cache dependencies
      id: cache-deps
      uses: actions/cache@v3
      with:
        path: |
          backend/deps
          backend/_build
        key: "${{ runner.os }}-\
              otp-${{ steps.beam.outputs.otp-version }}-\
              elixir-${{ steps.beam.outputs.elixir-version }}-\
              ${{ hashFiles('backend/mix.lock') }}"

    - name: Install and compile dependencies
      if: steps.cache-deps.outputs.cache-hit != 'true'
      run: |
        mix deps.get --only test
        mix deps.compile

    - name: Check formatting
      run: mix format --check-formatted

    - name: Run Credo code analysis
      run: mix credo --strict

    - name: Check for unused dependencies
      run: mix do deps.get, deps.unlock --check-unused

    - name: Compile with --warnings-as-errors
      run: mix compile --warnings-as-errors --force

    # Don't cache PLTs based on mix.lock hash, as Dialyzer can incrementally update even old ones
    # Cache key based on Elixir & Erlang version (also useful when running in matrix)
    - name: Cache Dialyzer's PLT
      uses: actions/cache/restore@v3
      id: plt_cache
      with:
        key: "${{ runner.os }}-\
              otp-${{ steps.beam.outputs.otp-version }}-\
              elixir-${{ steps.beam.outputs.elixir-version }}-\
              dialyzer-plt"
        path: backend/priv/plts

    # Create PLTs if no cache was found
    - name: Create PLTs
      if: steps.plt_cache.outputs.cache-hit != 'true'
      run: mix dialyzer --plt

    # By default, the GitHub Cache action will only save the cache if all steps in the job succeed,
    # so we separate the cache restore and save steps in case running dialyzer fails.
    - name: Save PLT cache
      uses: actions/cache/save@v3
      if: steps.plt_cache.outputs.cache-hit != 'true'
      id: plt_cache_save
      with:
        key: "${{ steps.plt_cache.outputs.cache-primary-key }}"
        path: backend/priv/plts

    - name: Run dialyzer
      run: mix dialyzer --format github

  test-coverage:
    name: Build and Test
    strategy:
      matrix:
        postgres: [13, 14, 15, 16]
    env:
      postgres_version_uploading_to_coveralls: 16
    runs-on: ubuntu-22.04
    services:
      postgres:
        image: postgres:${{ matrix.postgres }}
        env:
          POSTGRES_PASSWORD: postgres
        ports:
        - 5432:5432
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4
      with:
        show-progress: false

    - name: Install OTP and Elixir
      uses: erlef/setup-beam@v1
      id: beam
      with:
        version-file: .tool-versions
        version-type: strict

    - name: Cache dependencies
      id: cache-deps
      uses: actions/cache@v3
      with:
        path: |
          backend/deps
          backend/_build
        key: "${{ runner.os }}-\
              otp-${{ steps.beam.outputs.otp-version }}-\
              elixir-${{ steps.beam.outputs.elixir-version }}-\
              ${{ hashFiles('backend/mix.lock') }}"


    - name: Install and compile dependencies
      if: steps.cache-deps.outputs.cache-hit != 'true'
      run: |
        mix deps.get --only test
        mix deps.compile

    # Only send upload coverage from a single test in the matrix
    - name: Test and upload coverage
      if: matrix.postgres == env.postgres_version_uploading_to_coveralls
      run: mix coveralls.github -o coverage_results --warnings-as-errors

    - name: Test
      if: matrix.postgres != env.postgres_version_uploading_to_coveralls
      run: mix test

  build-docker-image:
    name: Build Docker image
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          show-progress: false

      - name: Build Docker image
        run: docker build .