chore: Creates mock generation infrastructure

.github/workflows/code-health.yml

@@ -16,22 +16,34 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - name: Set up Go
-      uses: actions/setup-go@v5
+    - uses: actions/setup-go@v5
       with:
         go-version-file: 'go.mod'
+    - name: Install tools for mocks and linter
+      run: make tools
+    - name: Mock generation
+      run: mockery
+    - name: Check for uncommited files
+      run: |
+        export FILES=$(git ls-files -o -m --directory --exclude-standard --no-empty-directory)
+        export LINES=$(echo "$FILES" | awk 'NF' | wc -l)
+        if [ $LINES -ne 0 ]; then
+          echo "Detected files that need to be committed:"
+          echo "$FILES" | sed -e "s/^/  /"
+          echo ""
+          echo "Mock skeletons are not up-to-date, you may have forgotten to run mockery before committing your changes."
+          exit 1
+        fi
     - name: Build
       run: make build
+    - name: Linter
+      run: make lint
   unit-test:
     needs: build
     runs-on: ubuntu-latest
-    permissions:
-      pull-requests: write
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Set up Go
-        uses: actions/setup-go@v5
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
           go-version-file: 'go.mod'
       - name: Unit Test
@@ -56,28 +68,11 @@ jobs:
         with:
           recreate: true
           path: code-coverage-results.md
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Install Go
-        uses: actions/setup-go@v5
-        with:
-          go-version-file: 'go.mod'
-          cache: false # see https://github.com/golangci/golangci-lint-action/issues/807
-      - name: golangci-lint
-        uses: golangci/[email protected]
-        with:
-          version: v1.55.0
-          args: --timeout 10m
   website-lint:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Install Go
-        uses: actions/setup-go@v5
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
           go-version-file: 'go.mod'
       - name: website lint
@@ -89,11 +84,11 @@ jobs:
       - name: Run ShellCheck
         uses: bewuethr/shellcheck-action@v2
   call-acceptance-tests-workflow:
-    needs: [build, lint, shellcheck, unit-test, website-lint]
+    needs: [build, shellcheck, unit-test, website-lint]
     secrets: inherit
     uses: ./.github/workflows/acceptance-tests.yml
   call-migration-tests-workflow:
-    needs: [build, lint, shellcheck, unit-test, website-lint]
+    needs: [build, shellcheck, unit-test, website-lint]
     secrets: inherit
     uses: ./.github/workflows/migration-tests.yml
 

.golangci.yml

@@ -145,9 +145,8 @@ issues:
       text: "^hugeParam: req is heavy"
 
 run:
+  timeout: 10m
   tests: true
   build-tags:
     - integration
-  skip-dirs:
-    - internal/mocks
   modules-download-mode: readonly

.mockery.yaml

@@ -0,0 +1,11 @@
+with-expecter: false
+disable-version-string: true
+dir: internal/testutil/mocksvc
+outpkg: mocksvc
+filename: "{{ .InterfaceName | snakecase }}.go"
+mockname: "{{.InterfaceName}}"
+
+packages:
+  ? github.com/mongodb/terraform-provider-mongodbatlas/internal/service/searchdeployment
+  : interfaces:
+      DeploymentService:

CONTRIBUTING.md

@@ -303,6 +303,8 @@ To do this you can:
 - Helper methods must have their own tests, e.g. `common_advanced_cluster_test.go` has tests for `common_advanced_cluster.go`.
 - `internal/testutils/acc` contains helper test methods for Acceptance and Migration tests.
 - Tests that need the provider binary like End-to-End tests don’t belong to the source code packages and go in `test/e2e`.
+- [Testify Mock](https://pkg.go.dev/github.com/stretchr/testify/mock) and [Mockery](https://github.com/vektra/mockery) are used for test doubles in unit tests. Mocked interfaces are generated in folder `internal/testutil/mocksvc`.
+
 
 ### Creating New Resource and Data Sources
 

GNUmakefile

@@ -14,6 +14,7 @@ VERSION=$(GITTAG:v%=%)
 LINKER_FLAGS=-s -w -X 'github.com/mongodb/terraform-provider-mongodbatlas/version.ProviderVersion=${VERSION}'
 
 GOLANGCI_VERSION=v1.55.0
+MOCKERY_VERSION=v2.38.0
 
 export PATH := $(shell go env GOPATH)/bin:$(PATH)
 export SHELL := env PATH=$(PATH) /bin/bash
@@ -74,7 +75,9 @@ tools:  ## Install dev tools
 	go install github.com/terraform-linters/[email protected]
 	go install github.com/rhysd/actionlint/cmd/actionlint@latest
 	go install golang.org/x/tools/go/analysis/passes/fieldalignment/cmd/fieldalignment@latest
+	go install github.com/vektra/mockery/v2@$(MOCKERY_VERSION)
 	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin $(GOLANGCI_VERSION)
+	@echo "==> Note for asdf users: you may want to run: asdf reshim golang"
 
 .PHONY: check
 check: test lint