lint-test.yml

---
# kics-scan disable=555ab8f9-2001-455e-a077-f2d0f41e2fb9
# Lint the code base and launch unit test at each push or pull request
name: Lint and test
on: # yamllint disable-line rule:truthy
  push:
    # execute when pushing only branches, not tags
    branches:
      - '**'
  workflow_dispatch:

permissions: read-all

jobs:
  build:
    runs-on: ubuntu-22.04
    permissions:
      # needed by ouzi-dev/commit-status-updater@v2
      statuses: write
      # needed by peter-evans/create-pull-request@v5
      pull-requests: write
      # needed by peter-evans/create-pull-request@v5
      contents: write
    strategy:
      fail-fast: true
      matrix:
        vendor:
          - ubuntu
          - alpine
        bashTarVersion:
          - '4.4'
          - '5.0'
          - '5.1'
        include:
          - vendor: ubuntu
            bashImage: ubuntu:20.04
            batsOptions: -j 30
            bashTarVersion: 4.4
            runPrecommitTests: false
          - vendor: ubuntu
            bashImage: ubuntu:20.04
            bashTarVersion: 5.0
            batsOptions: -j 30
            runPrecommitTests: false
          - vendor: ubuntu
            bashImage: ubuntu:20.04
            bashTarVersion: 5.1
            batsOptions: -j 30
            runPrecommitTests: true
          - vendor: alpine
            bashTarVersion: 4.4
            bashImage: amd64/bash:4.4-alpine3.18
            batsOptions: -j 30
            runPrecommitTests: false
          - vendor: alpine
            bashTarVersion: 5.0
            bashImage: amd64/bash:5.0-alpine3.18
            batsOptions: -j 30
            runPrecommitTests: false
          - vendor: alpine
            bashTarVersion: 5.1
            bashImage: amd64/bash:5.1-alpine3.18
            batsOptions: -j 30
            runPrecommitTests: false
    steps:
      - name: Checkout
        # kics-scan ignore-line
        uses: actions/checkout@v4

      - name: Set up Docker Buildx
        # kics-scan ignore-line
        uses: docker/setup-buildx-action@v3

      - name: Login to DockerHub
        # kics-scan ignore-line
        uses: docker/login-action@v3
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

      # kics-scan ignore-line
      - uses: ouzi-dev/commit-status-updater@v2
        with:
          name: build bash-tools-${{matrix.vendor}}-${{matrix.bashTarVersion}}
          status: pending

      # only if pre-commit
      - name: Set up Python
        if: matrix.runPrecommitTests
        # kics-scan ignore-line
        uses: actions/setup-python@v5
        with:
          python-version: 3.9

      - name: Install pre-commit
        if: matrix.runPrecommitTests
        run: pip install pre-commit

      # kics-scan ignore-line
      - uses: ouzi-dev/commit-status-updater@v2
        if: matrix.runPrecommitTests
        with:
          name: lint
          status: pending

      - name: Run pre-commit
        if: matrix.runPrecommitTests
        run: pre-commit run -a --hook-stage manual

      - name: Archive results
        if: matrix.runPrecommitTests && always()
        continue-on-error: true
        # kics-scan ignore-line
        uses: actions/upload-artifact@v3
        with:
          name: linter-reports
          path: |
            megalinter-reports/**
            bin/**

      - name: Create Pull Request
        if: matrix.runPrecommitTests && failure()
        # kics-scan ignore-line
        uses: peter-evans/create-pull-request@v5
        with:
          branch: update/pre-commit-fixes
          title: lint fixes
          commit-message: Auto-update lint fixes
          body: |
            some auto fixes have been generated during pre-commit run
          labels: updates

      # kics-scan ignore-line
      - uses: ouzi-dev/commit-status-updater@v2
        if: matrix.runPrecommitTests && always()
        with:
          name: lint
          status: ${{ job.status }}

      # Run unit tests
      - name: run unit tests
        run: |
          set -exo pipefail

          bin/installRequirements

          chmod -R 777 logs
          # shellcheck disable=SC2266
          USER_ID=1000 \
          GROUP_ID=1000 \
          vendor/bash-tools-framework/bin/test \
            --vendor "${{matrix.vendor}}" \
            --bash-version "${{matrix.bashTarVersion}}" \
            --bash-base-image "${{matrix.bashImage}}" \
            --branch-name "${GITHUB_REF##*/}" \
            ${{matrix.batsOptions}} --report-formatter junit -o logs -r src --ci

      - name: Upload Test Results
        if: always()
        # kics-scan ignore-line
        uses: actions/upload-artifact@v3
        with:
          name: Test Results ${{matrix.vendor}} ${{matrix.bashTarVersion}}
          path: logs/report.xml

      # kics-scan ignore-line
      - uses: ouzi-dev/commit-status-updater@v2
        if: always()
        with:
          name: build bash-tools-${{matrix.vendor}}-${{matrix.bashTarVersion}}
          status: ${{ job.status }}

  publishTestResults:
    name: 'Publish Tests Results'
    if: ${{ always() }}
    needs: [build]
    runs-on: ubuntu-latest
    permissions:
      checks: write

      # needed by ouzi-dev/commit-status-updater@v2
      statuses: write

      # only needed unless run with comment_mode: off
      pull-requests: write
    steps:
      - name: Download Artifacts
        # kics-scan ignore-line
        uses: actions/download-artifact@v3
        with:
          path: artifacts

      - name: Checkstyle aggregation
        # kics-scan ignore-line
        uses: lcollins/checkstyle-github-action@v2.0.0
        with:
          path: 'artifacts/**/*.xml'

      # run this action to get the workflow conclusion
      # You can get the conclusion via env (env.WORKFLOW_CONCLUSION)
      # kics-scan ignore-line
      - uses: technote-space/workflow-conclusion-action@v3

      # kics-scan ignore-line
      - uses: ouzi-dev/commit-status-updater@v2
        with:
          name: build
          # neutral, success, skipped, cancelled, timed_out, action_required, failure
          status: ${{ env.WORKFLOW_CONCLUSION }}