api-unit-test.yml

# This workflow will build the golang project, create a Mongo database and test it

name: 🕵️‍♂️ API Unit Tests

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]
    paths:
    - API/**

jobs:

  api-unit-test:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: ./API

    steps:
    - uses: actions/checkout@v4

    - name: Set up Go
      uses: actions/setup-go@v4
      with:
        go-version: 1.21

    - name: Install gotestsum
      run: go install gotest.tools/gotestsum@latest

    - name: Install gocov
      run: go install github.com/axw/gocov/gocov@latest

    - name: Install gocov-xml
      run: go install github.com/AlekSi/gocov-xml@latest

    - name: Create MongoDB Container
      run: cd ../deploy/docker && make test_api

    - name: Build
      run: make

    - name: Test
      run: gotestsum --junitfile tests-api.xml -- -coverpkg=./... -coverprofile=coverage_api.out -p 1 ./...

    - name: Log Test Coverage
      run: go tool cover -func coverage_api.out | grep total

    - name: Generate coverage XML report
      run: gocov convert coverage_api.out | gocov-xml > coverage_api.xml

    - name: Test Report
      uses: dorny/test-reporter@v1
      if: github.actor != 'dependabot[bot]'
      with:
        name: API Tests Report  # Name of the check run which will be created
        path: ./API/tests-api.xml     # Path to test results
        reporter: java-junit                 # Format of test results

    - uses: actions/upload-artifact@v4
      with:
        name: coverage
        path: ./API/coverage_api.out

    - uses: actions/upload-artifact@v4
      with:
        name: coverage_api_xml
        path: ./API/coverage_api.xml

  generate-coverage-badge:
    needs: api-unit-test
    runs-on: ubuntu-latest
    permissions:
      contents: write
    defaults:
      run:
        working-directory: ./
    if: github.ref == 'refs/heads/main' && github.event.head_commit.author.name != 'GitHubActions'

    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: "0"

      - name: Generate Badge
        uses: ./.github/actions/coverage/generate-badge
        with:
          COVERAGE_REPORT_ARTIFACT: coverage_api_xml
          COVERAGE_REPORT_NAME: coverage_api.xml
          LABEL: "API coverage"
          OUTPUT_FILE: api_coverage_badge.svg
          RED_LIMIT: "50"
          GREEN_LIMIT: "65"
          BADGE_ARTIFACT_NAME: api_coverage_badge

  upload-coverage-badge:
    needs: generate-coverage-badge
    runs-on: ubuntu-latest
    permissions:
      contents: write
    defaults:
      run:
        working-directory: ./
    if: github.ref == 'refs/heads/main' && github.event.head_commit.author.name != 'GitHubActions'

    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: "0"

      - name: Upload Badge
        uses: ./.github/actions/coverage/upload-badge
        with:
          BADGE_ARTIFACT_NAME: api_coverage_badge
          BADGE_FILE_NAME: api_coverage_badge.svg
          BRANCH_NAME: coverage_badges
          github_token: ${{ secrets.GITHUB_TOKEN }}