static_checks_etc.yml

name: Static Code Checks, Etc.

on:
  - pull_request
  - push

permissions: read-all

env:
  GOPRIVATE: github.com/slackhq/vitess-addons
  GH_ACCESS_TOKEN: "${{ secrets.GH_ACCESS_TOKEN }}"

jobs:
  build:
    name: Static Code Checks Etc
    runs-on:
      group: vitess-ubuntu20

    steps:
      - name: Skip CI
        run: |
          if [[ "${{contains( github.event.pull_request.labels.*.name, 'Skip CI')}}" == "true" ]]; then
            echo "skipping CI due to the 'Skip CI' label"
            exit 1
          fi

      - name: Check if workflow needs to be skipped
        id: skip-workflow
        run: |
          skip='false'
          echo Skip ${skip}
          echo "skip-workflow=${skip}" >> $GITHUB_OUTPUT  

      - name: Checkout code
        if: steps.skip-workflow.outputs.skip-workflow == 'false'
        uses: actions/checkout@v4

      - name: Run FOSSA scan and upload build data
        # Fails on pull requests when using the API key secret.
        # In order to run it on pull requests we would need to
        # generate a push only token and specify that as plain
        # text here:
        #   https://github.com/fossa-contrib/fossa-action#push-only-api-token
        if: github.ref == 'refs/heads/main'
        uses: fossa-contrib/fossa-action@v2
        with:
          fossa-api-key: ${{ secrets.FOSSA_API_KEY }}

      - name: Check for changes in Go files
        if: steps.skip-workflow.outputs.skip-workflow == 'false'
        uses: dorny/paths-filter@v3.0.1
        id: changes
        with:
          token: ''
          filters: |
            go_files:
              - '**/*.go'
              - '*.go'
              - 'go.sum'
              - 'go.mod'
            parser_changes:
              - 'go/vt/sqlparser/**'
              - 'go.sum'
              - 'go.mod'
              - 'build.env'
              - 'bootstrap.sh'
              - 'tools/**'
              - '.github/workflows/static_checks_etc.yml'
            proto_changes:
              - 'bootstrap.sh'
              - 'tools/**'
              - 'build.env'
              - 'go.sum'
              - 'go.mod'
              - 'Makefile'
              - 'go/vt/proto/**'
              - 'proto/*.proto'
              - '.github/workflows/static_checks_etc.yml'
            sizegen:
              - 'go/**/*.go'
              - 'test.go'
              - 'Makefile'
              - 'build.env'
              - 'go.sum'
              - 'go.mod'
              - 'tools/**'
              - 'bootstrap.sh'
              - '.github/workflows/static_checks_etc.yml'
            visitor:
              - 'go/tools/asthelpergen/**'
              - 'go/vt/sqlparser/**'
              - 'Makefile'
              - 'build.env'
              - 'go.sum'
              - 'go.mod'
              - 'tools/**'
              - 'bootstrap.sh'
              - 'misc/git/hooks/asthelpers'
              - '.github/workflows/static_checks_etc.yml'
            end_to_end:
              - 'docker/**'
              - 'test.go'
              - 'Makefile'
              - 'bootstrap.sh'
              - '.github/workflows/static_checks_etc.yml'
            ci_config:
              - 'test/config.json'
              - '.github/workflows/static_checks_etc.yml'
            release_notes:
              - 'changelog/**'
              - './go/tools/releases/**'
              - '.github/workflows/static_checks_etc.yml'
            workflows:
              - '.github/**'
              - 'Makefile'
              - 'test/ci_workflow_gen.go'

      - name: Set up Go
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && (steps.changes.outputs.go_files == 'true' || steps.changes.outputs.parser_changes == 'true' || steps.changes.outputs.proto_changes == 'true')
        uses: actions/setup-go@v5
        with:
          go-version: 1.22.8

      - name: Setup github.com/slackhq/vitess-additions access token
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && (steps.changes.outputs.go_files == 'true' || steps.changes.outputs.parser_changes == 'true' || steps.changes.outputs.proto_changes == 'true')
        run: git config --global url.https://$GH_ACCESS_TOKEN@github.com/.insteadOf https://github.com/

      - name: Tune the OS
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.go_files == 'true'
        run: |
          sudo sysctl -w net.ipv4.ip_local_port_range="22768 65535"

      - name: Run go fmt
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.go_files == 'true'
        run: |
          gofmt -l . | grep -vF vendor/ && exit 1 || echo "All files formatted correctly"

      - name: Install goimports
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && (steps.changes.outputs.go_files == 'true' || steps.changes.outputs.visitor == 'true')
        run: |
          go install golang.org/x/tools/cmd/goimports@latest

      - name: Run goimports
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.go_files == 'true'
        run: |
          out=$(goimports -local vitess.io/vitess -l -w $(find . -name "*.go" | grep -v ".pb.go"))
          echo $out | grep go > /dev/null && echo -e "The following files are malformatted:\n$out" && exit 1 || echo "All the files are formatted correctly"

      - name: Get dependencies
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && (steps.changes.outputs.parser_changes == 'true' || steps.changes.outputs.go_files == 'true')
        run: |
          sudo apt-get update
          sudo apt-get install -y make unzip g++ etcd curl git wget
          sudo service etcd stop
          go mod download

      - name: Run make minimaltools
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && (steps.changes.outputs.parser_changes == 'true' || steps.changes.outputs.go_files == 'true')
        run: |
          make minimaltools

      - name: check_make_parser
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && (steps.changes.outputs.parser_changes == 'true' || steps.changes.outputs.go_files == 'true')
        run: |
          tools/check_make_parser.sh || exit 1

      - name: check_make_sizegen
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && (steps.changes.outputs.sizegen == 'true' || steps.changes.outputs.go_files == 'true')
        run: |
          tools/check_make_sizegen.sh || exit 1

      - name: check_make_visitor
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && (steps.changes.outputs.visitor == 'true' || steps.changes.outputs.go_files == 'true')
        run: |
          misc/git/hooks/asthelpers || exit 1

      - name: run ensure_bootstrap_version
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.end_to_end == 'true'
        run: |
          make ensure_bootstrap_version
          git status
          test -z "$(git diff-index --name-only HEAD --)" || exit 1

      - name: Install golangci-lint
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.go_files == 'true'
        run: go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.56.2

      - name: Clean Env
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.go_files == 'true'
        run: $(go env GOPATH)/bin/golangci-lint cache clean

      - name: Print linter version
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.go_files == 'true'
        run: $(go env GOPATH)/bin/golangci-lint --version

      - name: Run golangci-lint
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.go_files == 'true'
        run: $(go env GOPATH)/bin/golangci-lint run go/... --timeout 10m || exit 1

      - name: Run go mod tidy
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.go_files == 'true'
        run: |
          set -e
          go mod tidy
          output=$(git status -s)
          if [ -z "${output}" ]; then
            exit 0
          fi
          echo 'We wish to maintain a tidy state for go mod. Please run `go mod tidy` on your branch, commit and push again.'
          echo 'Running `go mod tidy` on this CI test yields with the following changes:'
          echo "$output"
          exit 1

      - name: check_make_proto
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.proto_changes == 'true'
        run: |
          tools/check_make_proto.sh || exit 1

      - name: Check test/config.json
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && (steps.changes.outputs.go_files == 'true' || steps.changes.outputs.ci_config == 'true')
        run: |
          go run ./go/tools/ci-config/main.go || exit 1

      - name: Check changelog
        if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.release_notes == 'true'
        run: |
          set -e
          go run ./go/tools/releases/releases.go
          output=$(git status -s)
          if [ -z "${output}" ]; then
            exit 0
          fi
          echo 'We wish to maintain a consistent changelog directory, please run `go run ./go/tools/releases/releases.go`, commit and push again.'
          echo 'Running `go run ./go/tools/releases/releases.go` on CI yields the following changes:'
          echo "$output"
          echo ""
          exit 1

      - name: Check make generate_ci_workflows
        if: steps.skip-workflow.outputs.skip-workflow == 'false'
        run: |
          set -e
          make generate_ci_workflows
          output=$(git status -s)
          if [ -z "${output}" ]; then
            exit 0
          fi
          echo 'Please run `make generate_ci_workflows`, commit and push again.'
          echo 'Running `make generate_ci_workflows` on CI yields the following changes:'
          echo "$output"
          echo ""
          exit 1