fix: display test snapshot error message (#4091)

Author: fmenezes

.github/workflows/code-health.yml

@@ -317,8 +317,6 @@ jobs:
           config: ${{ vars.PERMISSIONS_CONFIG }}
       - name: Checkout repository
         uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
       - name: Install Go
         uses: actions/setup-go@v5
         with:
@@ -332,7 +330,14 @@ jobs:
         with:
           app-id: ${{ secrets.APIXBOT_APP_ID }}
           private-key: ${{ secrets.APIXBOT_APP_PEM }}
-      - run: make e2e-test-snapshots
+      - run: |
+          set +e
+          make e2e-test-snapshots
+          EXIT_CODE=$?
+          if [ $EXIT_CODE -ne 0 ]; then
+            echo "::error::Snapshot tests failed, consider adding label 'update-snapshots' to re-generate them"
+          fi
+          exit $EXIT_CODE
         env:
           GH_TOKEN: ${{ steps.app-token.outputs.token }}
           TEST_CMD: gotestsum --junitfile e2e-tests.xml --format standard-verbose --

.github/workflows/update-e2e-tests.yml

@@ -78,7 +78,7 @@ jobs:
       - run: make e2e-test
         env:
           TEST_CMD: gotestsum --junitfile e2e-tests.xml --format standard-verbose --
-          E2E_TEST_PACKAGES: ./test/e2e/{{ matrix.packages }}..
+          E2E_TEST_PACKAGES: ./test/e2e/{{ matrix.packages }}/...
           MONGODB_ATLAS_ORG_ID: ${{ secrets.MONGODB_ATLAS_ORG_ID }}
           MONGODB_ATLAS_PROJECT_ID: ${{ secrets.MONGODB_ATLAS_PROJECT_ID }}
           MONGODB_ATLAS_PUBLIC_API_KEY: ${{ secrets.MONGODB_ATLAS_PUBLIC_API_KEY }}
@@ -136,7 +136,7 @@ jobs:
       - run: make e2e-test
         env:
           TEST_CMD: gotestsum --junitfile e2e-tests.xml --format standard-verbose --
-          E2E_TEST_PACKAGES: ./test/internal..
+          E2E_TEST_PACKAGES: ./test/internal/...
           MONGODB_ATLAS_ORG_ID: ${{ secrets.MONGODB_ATLAS_ORG_ID }}
           MONGODB_ATLAS_PROJECT_ID: ${{ secrets.MONGODB_ATLAS_PROJECT_ID }}
           MONGODB_ATLAS_PUBLIC_API_KEY: ${{ secrets.MONGODB_ATLAS_PUBLIC_API_KEY }}

.golangci.yml

@@ -1,7 +1,5 @@
 version: "2"
 run:
-  build-tags:
-    - e2e
   modules-download-mode: readonly
   tests: true
 linters:

CONTRIBUTING.md

@@ -78,18 +78,6 @@ We provide a git pre-commit hook to format and check the code, to install it run
 We use [mockgen](go.uber.org/mock) to handle mocking in our unit tests.
 If you need a new mock please update or add the `//go:generate` instruction to the appropriate file.
 
-#### Compilation in VSCode
-
-Please add the following line to your `.vscode/settings.json` file :
-```json
-{
-    "go.buildTags": "e2e",
-    "go.testTags": "e2e"
-}
-```
-
-This will enable compilation for unit and end-to-end tests.
-
 #### Debugging in VSCode
 
 To debug in VSCode, you must create a debug configuration for the command with the required arguments.
@@ -136,8 +124,6 @@ Review and replace the atlas settings.
 
 ```json
 {
-  "go.buildTags": "e2e",
-  "go.testTags": "e2e",
   "go.testEnvVars": {
     "ATLAS_E2E_BINARY": "${workspaceFolder}/bin/atlas",
     "UPDATE_SNAPSHOTS": "skip",

Makefile

@@ -25,7 +25,7 @@ export SNAPSHOTS_DIR?=$(abspath test/e2e/testdata/.snapshots)
 DEBUG_FLAGS=all=-N -l
 
 TEST_CMD?=go test
-E2E_TEST_PACKAGES?=./test/e2e..
+E2E_TEST_PACKAGES?=./test/e2e/...
 E2E_TIMEOUT?=60m
 E2E_PARALLEL?=1
 E2E_EXTRA_ARGS?=
@@ -174,11 +174,11 @@ build-debug: ## Generate a binary in ./bin for debugging atlascli
 e2e-test: build-debug ## Run E2E tests
 # the target assumes the MCLI_* environment variables are exported
 	@echo "==> Running E2E tests..."
-	$(TEST_CMD) -v -p 1 -parallel $(E2E_PARALLEL) -v -timeout $(E2E_TIMEOUT) ${E2E_TEST_PACKAGES}. $(E2E_EXTRA_ARGS)
+	$(TEST_CMD) -v -p 1 -parallel $(E2E_PARALLEL) -v -timeout $(E2E_TIMEOUT) ${E2E_TEST_PACKAGES} $(E2E_EXTRA_ARGS)
 
 .PHONY: e2e-test-snapshots
 e2e-test-snapshots: build-debug ## Run E2E tests
-	UPDATE_SNAPSHOTS=false E2E_SKIP_CLEANUP=true DO_NOT_TRACK=1 $(TEST_CMD) -v -timeout $(E2E_TIMEOUT) ${E2E_TEST_PACKAGES}. $(E2E_EXTRA_ARGS)
+	UPDATE_SNAPSHOTS=false E2E_SKIP_CLEANUP=true DO_NOT_TRACK=1 $(TEST_CMD) -v -timeout $(E2E_TIMEOUT) ${E2E_TEST_PACKAGES} $(E2E_EXTRA_ARGS)
 	go tool covdata textfmt -i $(GOCOVERDIR) -o $(COVERAGE)
 
 .PHONY: unit-test