Go-SDK-PR-Check.yaml

# Copyright 2025 The Serverless Workflow Specification Authors
#
# 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.

name: Go SDK PR Checks

on:
  pull_request:
    paths-ignore:
      - "**.md"
      - "hack/**"
      - "LICENSE"
      - "Makefile"
    branches:
      - main


permissions:
  contents: read

env:
  GO_VERSION: 1.22

jobs:
  basic_checks:
    name: Basic Checks
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v4

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

      - name: Cache Go Modules
        uses: actions/cache@v4
        with:
          path: |
            ~/.cache/go-build
            ~/go/pkg/mod
          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
          restore-keys: |
            ${{ runner.os }}-go-

      - name: Cache Tools
        uses: actions/cache@v4
        with:
          path: ~/go/bin
          key: ${{ runner.os }}-go-tools-${{ hashFiles('**/tools.sum') }}
          restore-keys: |
            ${{ runner.os }}-go-tools-

      - name: Check Headers
        run: |
          make addheaders
          changed_files=$(git status -s | grep -v 'go.mod\|go.sum\|tools.mod\|tools.sum' || :)
          if [[ -n "$changed_files" ]]; then
            echo "❌ Some files are missing headers:\n$changed_files"
            exit 1
          fi

      - name: Check Formatting
        run: |
          make fmt
          changed_files=$(git status -s | grep -v 'go.mod\|go.sum\|tools.mod\|tools.sum' || :)
          if [[ -n "$changed_files" ]]; then
            echo "❌ Some files are not formatted correctly:\n$changed_files"
            exit 1
          fi

      - name: Run Linter
        uses: golangci/golangci-lint-action@ec5d18412c0aeab7936cb16880d708ba2a64e1ae # v6.1.1 - Please ALWAYS use SHA to avoid GH sec issues
        with:
          version: latest

      - name: Install Cover Tool
        run: go install golang.org/x/tools/cmd/cover@latest

      - name: Run Unit Tests
        run: go test ./... -coverprofile=test_coverage.out -covermode=atomic

      - name: Upload Coverage Report
        uses: actions/upload-artifact@v3
        with:
          name: Test Coverage Report
          path: test_coverage.out

  integration_tests:
    name: Integration Tests
    runs-on: ubuntu-latest
    needs: basic_checks
    steps:
      - name: Checkout Code
        uses: actions/checkout@v4

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

      - name: Run Integration Tests
        run: |
          chmod +x ./hack/integration-test.sh
          ./hack/integration-test.sh
        continue-on-error: true

      - name: Upload JUnit Report
        if: always()
        uses: actions/upload-artifact@v3
        with:
          name: Integration Test JUnit Report
          path: ./integration-test-junit.xml