Merge branch 'master' into CLOUDP-333877

Waybo26 · Waybo26 · commit ea66a4b84749 · 2025-07-31T11:31:57.000-05:00
diff --git a/.github/workflows/breaking-changes.yaml b/.github/workflows/breaking-changes.yaml
@@ -7,8 +7,6 @@ jobs:
   breaking-changes-manifest:
     name: Generate Breaking Changes Manifest
     runs-on: ubuntu-latest
-    outputs:
-      breaking-changes: ${{ steps.breakvalidator.outputs.JSON }}
     steps:
       - uses: GitHubSecurityLab/actions-permissions/monitor@v1
         with:
@@ -24,7 +22,6 @@ jobs:
       - name: Install dependencies
         run: go mod download
       - name: Run breaking changes validator
-        id: breakvalidator
         run: |
           set -e
           go run ./tools/cmd/breakvalidator generate > main.json
@@ -51,7 +48,6 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: breaking-changes-manifest
-          path: main.json
       - name: Run breaking changes validator
         run: |
           set -e
diff --git a/.github/workflows/code-health.yml b/.github/workflows/code-health.yml
@@ -34,7 +34,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: GitHubSecurityLab/actions-permissions/monitor@v1
-        if: ${{ matrix.os=='ubuntu-latest' }}
+        if: matrix.os == 'ubuntu-latest'
         with:
           config: ${{ vars.PERMISSIONS_CONFIG }}
       - name: Checkout repository
@@ -45,108 +45,40 @@ jobs:
         uses: actions/setup-go@v5
         with:
           go-version-file: 'go.mod'
-      - run: go install gotest.tools/gotestsum@latest
+      - run: |
+          go install gotest.tools/gotestsum@v1.12.3
+          go install github.com/mattn/goveralls@v0.0.12
       - run: make unit-test
+      - name: Send coverage
+        env:
+          COVERALLS_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+        run: goveralls -parallel -coverprofile="$COVERAGE" -ignore=test/* -service=github
       - name: Test Summary
         id: test_summary
         uses: test-summary/action@31493c76ec9e7aa675f1585d3ed6f1da69269a86
         with:
           paths: unit-tests.xml
         if: always() && matrix.os == 'ubuntu-latest'
-      - name: Upload coverage file
-        if: matrix.os == 'ubuntu-latest' && github.event_name == 'pull_request'
-        uses: actions/upload-artifact@v4
-        with:
-          name: coverage-file
-          path: coverage.out
 
-  code-coverage:
-    permissions:
-      pull-requests: write  # Required to comment on PRs
-    needs: unit-tests
-    if: github.event_name == 'pull_request'
+  coverage:
     runs-on: ubuntu-latest
+    needs: [unit-tests, e2e-tests]
     steps:
       - uses: GitHubSecurityLab/actions-permissions/monitor@v1
         with:
           config: ${{ vars.PERMISSIONS_CONFIG }}
       - name: Checkout repository
         uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - name: Get merge base
-        id: merge_base
-        run: |
-          MERGE_BASE=$(git merge-base "${{ github.event.pull_request.head.sha }}" "${{ github.event.pull_request.base.sha }}")
-          echo "merge_base=$MERGE_BASE" >> "$GITHUB_OUTPUT"
-          echo "Checking coverage against: $MERGE_BASE"
       - name: Install Go
         uses: actions/setup-go@v5
         with:
           go-version-file: 'go.mod'
-      - name: Download coverage file
-        uses: actions/download-artifact@v4
-        with:
-          name: coverage-file
-      - name: Check coverage cache
-        id: cache-coverage
-        uses: actions/cache@v4
-        with:
-          path: coverage.base.out
-          key: coverage-${{ steps.merge_base.outputs.merge_base }}
-      - name: Generate base coverage
-        if: steps.cache-coverage.outputs.cache-hit != 'true'
-        run: |
-          # Get coverage from base branch
-          git checkout ${{ steps.merge_base.outputs.merge_base }}
-          COVERAGE=coverage.base.out make unit-test
-      - name: Save coverage to cache
-        if: steps.cache-coverage.outputs.cache-hit != 'true'
-        uses: actions/cache/save@v4
-        with:
-          path: coverage.base.out
-          key: coverage-${{ steps.merge_base.outputs.merge_base }}
-      - name: Compare coverage
-        id: compare
+      - name: Install goveralls
+        run: go install github.com/mattn/goveralls@v0.0.12
+      - name: Send coverage
         env:
-          BASE_REF: ${{ github.base_ref }}
-          HEAD_REF: ${{ github.head_ref }}
-        run: |
-          # use go tool cover to calculate coverage percentage
-          base_coverage=$(go tool cover -func=coverage.base.out | grep total: | awk '{print $3}' | sed 's/%//')
-          pr_coverage=$(go tool cover -func=coverage.out | grep total: | awk '{print $3}' | sed 's/%//')
-          
-          # Calculate difference
-          diff=$(echo "$pr_coverage - $base_coverage" | bc)
-          echo "diff=$diff" >> "$GITHUB_OUTPUT"
-          
-          # Create comment content
-          if (( $(echo "$diff >= 0" | bc -l) )); then
-            trend="📈"
-          else
-            trend="📉"
-          fi
-          
-          {
-            echo "Coverage Report $trend"
-            echo "| Branch | Commit | Coverage |"
-            echo "|--------|--------|----------|"
-            echo "| ${BASE_REF} | ${{ steps.merge_base.outputs.merge_base }} | ${base_coverage}% |"
-            echo "| ${HEAD_REF} | ${{ github.event.pull_request.head.sha }} | ${pr_coverage}% |"
-            echo "|        | Difference | ${diff}% |"
-          } > comment.md
-          cat "comment.md" >> "$GITHUB_STEP_SUMMARY"
-      - name: Comment PR
-        uses: marocchino/sticky-pull-request-comment@d2ad0de260ae8b0235ce059e63f2949ba9e05943
-        if: github.event.pull_request.head.repo.full_name == github.repository
-        with:
-          recreate: true
-          path: comment.md
-      - name: Check coverage threshold
-        run: |
-          if (( $(echo "${{ steps.compare.outputs.diff }} < 0" | bc -l) )); then
-            echo "Error: Coverage difference (${{ steps.compare.outputs.diff }}%) is negative"
-          fi
+          COVERALLS_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+        run: goveralls -parallel-finish -ignore=test/* -service=github
 
   libraryOwners:
     runs-on: ubuntu-latest
@@ -390,7 +322,9 @@ jobs:
         uses: actions/setup-go@v5
         with:
           go-version-file: 'go.mod'
-      - run: go install gotest.tools/gotestsum@latest
+      - run: |
+          go install gotest.tools/gotestsum@v1.12.3
+          go install github.com/mattn/goveralls@v0.0.12
       - name: set Apix Bot token
         id: app-token
         uses: mongodb/apix-action/token@3024080388613583e3bd119bfb1ab4b4dbf43c42
@@ -401,6 +335,12 @@ jobs:
         env:
           GH_TOKEN: ${{ steps.app-token.outputs.token }}
           TEST_CMD: gotestsum --junitfile e2e-tests.xml --format standard-verbose --
+          COVERAGE: coverage.out
+      - name: Send coverage
+        env:
+          COVERALLS_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+          COVERAGE: coverage.out
+        run: goveralls -parallel -coverprofile="$COVERAGE" -ignore=test/* -service=github
       - name: Test Summary
         if: always()
         uses: test-summary/action@31493c76ec9e7aa675f1585d3ed6f1da69269a86
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -82,10 +82,12 @@ If you need a new mock please update or add the `//go:generate` instruction to t
 
 #### Compilation in VSCode
 
-Please add the following line to your settings.json file :
-```
+Please add the following line to your `.vscode/settings.json` file :
+```json
+{
     "go.buildTags": "unit,e2e",
     "go.testTags": "unit,e2e"
+}
 ```
 
 This will enable compilation for unit and end-to-end tests.
@@ -95,7 +97,7 @@ This will enable compilation for unit and end-to-end tests.
 To debug in VSCode, you must create a debug configuration for the command with the required arguments.
 Run the following commands to create a new launch.json file for the debugger:
 
-```
+```shell
 touch .vscode/launch.json
 ```
 Then put the following example configuration into the file.
@@ -125,6 +127,36 @@ Review and replace the command name and arguments depending on the command you w
 } 
 ```
 
+To debug e2e tests.
+
+```shell
+touch .vscode/settings.json
+```
+
+Then put the following example configuration into the file.
+Review and replace the atlas settings.
+
+```json
+{
+  "go.buildTags": "unit,e2e",
+  "go.testTags": "unit,e2e",
+  "go.testEnvVars": {
+    "ATLAS_E2E_BINARY": "${workspaceFolder}/bin/atlas",
+    "UPDATE_SNAPSHOTS": "skip",
+    "SNAPSHOTS_DIR": "${workspaceFolder}/test/e2e/testdata/.snapshots",
+    "GOCOVERDIR": "${workspaceFolder}/cov",
+    "DO_NOT_TRACK": "1",
+    "E2E_SKIP_CLEANUP": "false",
+    "MONGODB_ATLAS_ORG_ID": "<default org id>",
+    "MONGODB_ATLAS_PROJECT_ID": "<default project id>",
+    "MONGODB_ATLAS_PRIVATE_API_KEY": "<private key>",
+    "MONGODB_ATLAS_PUBLIC_API_KEY": "<public key>",
+    "MONGODB_ATLAS_OPS_MANAGER_URL": "https://cloud.mongodb.com/",
+    "MONGODB_ATLAS_SERVICE": "cloud",
+  }
+}
+```
+
 ### Contributing New Command Group
 
 `Atlas CLI` uses the [Cobra Framework](https://umarcor.github.io/cobra/).
diff --git a/Makefile b/Makefile
@@ -181,6 +181,7 @@ e2e-test: build-debug ## Run E2E tests
 .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) -tags="e2eSnap" ${E2E_TEST_PACKAGES}. $(E2E_EXTRA_ARGS)
+	go tool covdata textfmt -i $(GOCOVERDIR) -o $(COVERAGE)
 
 .PHONY: unit-test
 unit-test: build-debug ## Run unit-tests
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+[![Coverage Status](https://coveralls.io/repos/github/mongodb/mongodb-atlas-cli/badge.svg?branch=master)](https://coveralls.io/github/mongodb/mongodb-atlas-cli?branch=master)
+
 ## MongoDB Atlas CLI
 
 The MongoDB Atlas CLI is a modern command line interface that enables you to manage MongoDB Atlas from the terminal.
diff --git a/tools/cmd/breakvalidator/main.go b/tools/cmd/breakvalidator/main.go
@@ -21,14 +21,14 @@ import (
 )
 
 type flagData struct {
-	Type    string `json:"type"`
-	Default string `json:"default"`
-	Short   string `json:"short"`
+	Type    string `json:"type,omitempty"`
+	Default string `json:"default,omitempty"`
+	Short   string `json:"short,omitempty"`
 }
 
 type cmdData struct {
-	Aliases []string            `json:"aliases"`
-	Flags   map[string]flagData `json:"flags"`
+	Aliases []string            `json:"aliases,omitempty"`
+	Flags   map[string]flagData `json:"flags,omitempty"`
 }
 
 func buildRootCmd() *cobra.Command {

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+[![Coverage Status](https://coveralls.io/repos/github/mongodb/mongodb-atlas-cli/badge.svg?branch=master)](https://coveralls.io/github/mongodb/mongodb-atlas-cli?branch=master)`
	`2`	`+`
`1`	`3`	`## MongoDB Atlas CLI`
`2`	`4`
`3`	`5`	`The MongoDB Atlas CLI is a modern command line interface that enables you to manage MongoDB Atlas from the terminal.`
Original file line number	Diff line number	Diff line change
`@@ -21,14 +21,14 @@ import (`
`21`	`21`	`)`
`22`	`22`
`23`	`23`	`type flagData struct {`
`24`		- Type string `json:"type"`
`25`		- Default string `json:"default"`
`26`		- Short string `json:"short"`
	`24`	+ Type string `json:"type,omitempty"`
	`25`	+ Default string `json:"default,omitempty"`
	`26`	+ Short string `json:"short,omitempty"`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`type cmdData struct {`
`30`		- Aliases []string `json:"aliases"`
`31`		- Flags map[string]flagData `json:"flags"`
	`30`	+ Aliases []string `json:"aliases,omitempty"`
	`31`	+ Flags map[string]flagData `json:"flags,omitempty"`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`func buildRootCmd() *cobra.Command {`