test-go-integration-task.yml

# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/test-go-integration-task.md
name: Test Integration

env:
  # See: https://github.com/actions/setup-go/tree/main#supported-version-syntax
  GO_VERSION: "1.17"
  # See: https://github.com/actions/setup-python/tree/main#available-versions-of-python
  PYTHON_VERSION: "3.9"

# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
  create:
  push:
    paths:
      - ".github/workflows/test-go-integration-task.ya?ml"
      - "Taskfile.ya?ml"
      - "**.go"
      - "go.mod"
      - "go.sum"
      - "poetry.lock"
      - "pyproject.toml"
      - "tests/**"
  pull_request:
    paths:
      - ".github/workflows/test-go-integration-task.ya?ml"
      - "Taskfile.ya?ml"
      - "**.go"
      - "go.mod"
      - "go.sum"
      - "poetry.lock"
      - "pyproject.toml"
      - "tests/**"
  schedule:
    # Run periodically to catch breakage caused by external changes.
    - cron: "0 10 * * WED"
  workflow_dispatch:
    inputs:
      arduino-lint-ref:
        description: Arduino Lint ref (leave empty for latest release)
        default: ""
  repository_dispatch:

jobs:
  run-determination:
    runs-on: ubuntu-latest
    outputs:
      result: ${{ steps.determination.outputs.result }}
    permissions: {}
    steps:
      - name: Determine if the rest of the workflow should run
        id: determination
        run: |
          RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x"
          # The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead.
          if [[
            "${{ github.event_name }}" != "create" ||
            "${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX
          ]]; then
            # Run the other jobs.
            RESULT="true"
          else
            # There is no need to run the other jobs.
            RESULT="false"
          fi

          echo "result=$RESULT" >> $GITHUB_OUTPUT

  test:
    needs: run-determination
    if: needs.run-determination.outputs.result == 'true'
    permissions:
      contents: read

    strategy:
      matrix:
        operating-system:
          - ubuntu-latest

    runs-on: ${{ matrix.operating-system }}

    env:
      ARDUINO_LINT_SOURCE_PATH: arduino-lint

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install Go
        uses: actions/setup-go@v5
        with:
          go-version: ${{ env.GO_VERSION }}

      - name: Install Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Install Poetry
        run: pip install poetry

      - name: Install Task
        uses: arduino/setup-task@v1
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          version: 3.x

      - name: Install latest release of Arduino Lint
        if: github.event.inputs.arduino-lint-ref == ''
        run: |
          ARDUINO_LINT_INSTALLATION_PATH="${{ runner.temp }}/arduino-lint"
          mkdir --parents "$ARDUINO_LINT_INSTALLATION_PATH"
          curl \
            -fsSL \
            https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/install.sh \
          | \
          BINDIR="$ARDUINO_LINT_INSTALLATION_PATH" \
          sh

          # Add installation folder to path
          echo "$ARDUINO_LINT_INSTALLATION_PATH" >> "$GITHUB_PATH"

      - name: Checkout Arduino Lint repository
        if: github.event.inputs.arduino-lint-ref != ''
        uses: actions/checkout@v4
        with:
          repository: arduino/arduino-lint
          ref: ${{ github.event.inputs.arduino-lint-ref }}
          path: ${{ env.ARDUINO_LINT_SOURCE_PATH }}

      - name: Build Arduino Lint
        if: github.event.inputs.arduino-lint-ref != ''
        working-directory: ${{ env.ARDUINO_LINT_SOURCE_PATH }}
        run: |
          task build
          # Add installation folder to path
          echo "$PWD" >> "$GITHUB_PATH"

      - name: Run integration tests
        run: task go:test-integration