Integration test framework

.github/.golangci.yml

@@ -0,0 +1,145 @@
+# https://golangci-lint.run/usage/configuration/#config-file
+linters:
+  disable-all: true
+  enable:
+    - errcheck
+    - goimports
+    - importas
+    #  - paralleltest # missing the call to method parallel, but testify does not seem to work well with parallel test: https://github.com/stretchr/testify/issues/187
+    - revive # revive supersedes golint, which is now archived
+    - staticcheck
+    - govet
+    - forbidigo
+    - exhaustive
+    - godox
+issues:
+  exclude-dirs:
+    - ^api
+    - ^proto
+    - ^.git
+  exclude-rules:
+    - path-except: _test\.go|internal/tests/.+\.go
+      text: "time.Sleep"
+      linters:
+        - forbidigo
+    - path: _test\.go|internal/tests/.+\.go
+      text: "(cyclomatic|cognitive)"  # false positives when using subtests
+      linters:
+        - revive
+    - path: _test\.go|internal/tests/.+\.go
+      text: "(dot-imports|unchecked-type-assertion)"  # helpful in tests
+      linters:
+        - revive
+    - path: ^tools\/.+\.go
+      linters:
+        - revive
+linters-settings:
+  godox:
+    keywords:
+      - FIXME # marks TODOs that must be fixed before merging
+  govet:
+    fieldalignment: 0
+  forbidigo:
+    forbid:
+      - p: panic
+        msg: "Please avoid using panic in application code"
+  importas:
+    # Enforce the aliases below.
+    no-unaliased: true
+    # Still allow aliases outside of the rules below.
+    no-extra-aliases: false
+    alias:
+      # no pb services (or their mocks) are aliased - must be at the top!
+      - pkg: go.temporal.io(/server)?/api/(\w+)service(mock)?/v1
+        alias: # ie no alias - this can only be specified once!
+      # public API pbs have a suffix
+      - pkg: go.temporal.io/api/(\w+)/v1
+        alias: ${1}pb
+      # internal server pbs have their own suffix to avoid naming conflicts
+      - pkg: go.temporal.io/server/api/(\w+)/v1
+        alias: ${1}spb
+  exhaustive:
+    # Presence of "default" case in switch statements satisfies exhaustiveness,
+    # even if all enum members are not listed.
+    # Default: false
+    default-signifies-exhaustive: true
+  revive:
+    severity: error
+    confidence: 0.8
+    enable-all-rules: true
+    rules:
+      # Disabled rules
+      - name: add-constant
+        disabled: true
+      - name: argument-limit
+        disabled: true
+      - name: bare-return
+        disabled: true
+      - name: banned-characters
+        disabled: true
+      - name: bool-literal-in-expr
+        disabled: true
+      - name: confusing-naming
+        disabled: true
+      - name: empty-lines
+        disabled: true
+      - name: error-naming
+        disabled: true
+      - name: errorf
+        disabled: true
+      - name: exported
+        disabled: true
+      - name: file-header
+        disabled: true
+      - name: function-length
+        disabled: true
+      - name: imports-blacklist
+        disabled: true
+      - name: increment-decrement
+        disabled: true
+      - name: line-length-limit
+        disabled: true
+      - name: max-public-structs
+        disabled: true
+      - name: nested-structs
+        disabled: true
+      - name: package-comments
+        disabled: true
+      - name: string-format
+        disabled: true
+      - name: unexported-naming
+        disabled: true
+      - name: unexported-return
+        disabled: true
+      - name: unused-parameter
+        disabled: true
+      - name: unused-receiver
+        disabled: true
+      - name: use-any
+        disabled: true
+      - name: var-naming
+        disabled: true
+      - name: empty-block
+        disabled: true
+      - name: flag-parameter
+        disabled: true
+      - name: unnecessary-stmt
+        disabled: true
+      - name: range-val-in-closure
+        disabled: true
+
+      # Rule tuning
+      - name: cognitive-complexity
+        arguments:
+          - 25
+      - name: cyclomatic
+        arguments:
+          - 25
+      - name: function-result-limit
+        arguments:
+          - 5
+      - name: unhandled-error
+        arguments:
+          - "fmt.*"
+          - "bytes.Buffer.*"
+          - "strings.Builder.*"

.github/workflows/linters.yml

@@ -0,0 +1,90 @@
+name: linters
+on:
+  pull_request:
+permissions:
+  contents: read
+jobs:
+  lint-actions:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: 'go.mod'
+          check-latest: true
+
+      - name: lint actions
+        run: |
+          bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash)
+          make lint-actions
+        shell: bash
+
+  fmt-imports:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: 'go.mod'
+          check-latest: true
+
+      - name: format golang import statements
+        run: |
+          make fmt-imports
+
+      - name: check-is-dirty
+        run: |
+          if [[ -n $(git status --porcelain) ]]; then
+            echo "Detected uncommitted changes."
+            git status
+            git diff
+            exit 1
+          fi
+
+  golangci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: 'go.mod'
+          check-latest: true
+
+      - name: lint code
+        run: |
+          make GOLANGCI_LINT_FIX=false GOLANGCI_LINT_BASE_REV=HEAD~ lint-code
+
+      - name: check-is-dirty
+        run: |
+          if [[ -n $(git status --porcelain) ]]; then
+            echo "Detected uncommitted changes."
+            git status
+            git diff
+            exit 1
+          fi
+
+  linters-succeed:
+    name: All Linters Succeed
+    needs:
+      - lint-actions
+      - fmt-imports
+      - golangci
+    runs-on: ubuntu-latest
+    if: always()
+    env:
+      RESULTS: ${{ toJSON(needs.*.result) }}
+    steps:
+      - name: Check results
+        run: |
+          if [[ -n $(echo "$RESULTS" | jq '.[] | select (. != "success")') ]]; then
+            exit 1
+          fi

.github/workflows/test-integration.yml

@@ -0,0 +1,110 @@
+name: Integration Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  test-integration:
+    name: Run Integration Tests
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: '1.21'
+        cache: true
+
+    - name: Install Temporal CLI
+      run: |
+        curl -sSf https://temporal.download/cli.sh | sh
+        echo "$HOME/.temporalio/bin" >> "$GITHUB_PATH"
+
+    - name: Install kubectl
+      uses: azure/setup-kubectl@v3
+      with:
+        version: 'latest'
+
+    - name: Install Helm
+      uses: azure/setup-helm@v3
+      with:
+        version: 'v3.14.3'
+
+    - name: Install controller-gen
+      run: |
+        go install sigs.k8s.io/controller-tools/cmd/[email protected]
+
+    - name: Install envtest
+      run: |
+        go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
+
+    - name: Download dependencies
+      run: go mod download
+
+    - name: Run integration tests
+      run: make test-integration
+
+    - name: Upload test results
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: test-results
+        path: |
+          cover.out
+          bin/
+        retention-days: 7
+
+  unit-test:
+    name: Run Unit Tests
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: '1.21'
+        cache: true
+
+    - name: Download dependencies
+      run: go mod download
+
+    - name: Run unit tests
+      run: make test-unit
+
+    - name: Upload test results
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: unit-test-results
+        path: |
+          cover.out
+          bin/
+        retention-days: 7 
+
+  go-vet:
+    name: Run Go Vet
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: '1.21'
+        cache: true
+
+    - name: Download dependencies
+      run: go mod download
+
+    - name: Run go vet
+      run: go vet ./...