Merge remote-tracking branch 'origin/master' into CLOUDP-113344

Author: gssbzn

.github/workflows/docs.yml

@@ -10,11 +10,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Install Go
         uses: actions/setup-go@v2
         with:
           go-version: 1.17
+      - name: Cache Dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/go/pkg/mod
+          key: Linux-go-1.17-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            Linux-go-1.17-
       - name: Generate docs
         run: make gen-docs > /dev/null
       - name: Check for uncommited files

.github/workflows/go-test.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Install Go
         uses: actions/setup-go@v2
         with:

.github/workflows/golangci-lint.yml

@@ -10,7 +10,7 @@ jobs:
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Install Go
         uses: actions/setup-go@v2
         with:

.github/workflows/mocks.yml

@@ -0,0 +1,39 @@
+---
+name: Check Mock Generation
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+jobs:
+  mocks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.17
+      - name: Cache Dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/go/pkg/mod
+          key: Linux-go-1.17-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            Linux-go-1.17-
+      - name: Intsall go-mock
+        run: go install github.com/golang/mock/mockgen@latest
+      - name: Generate mocks
+        run: make gen-mocks
+      - 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 "Try running: make gen-mocks"
+            exit 1
+          fi

.github/workflows/security.yml

@@ -8,7 +8,7 @@ jobs:
   security:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Run Snyk to check for vulnerabilities
         uses: snyk/actions/golang@master
         env:

.github/workflows/shellcheck.yml

@@ -10,6 +10,6 @@ jobs:
     name: shellcheck
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Run ShellCheck
         uses: bewuethr/shellcheck-action@v2

.gitignore

@@ -28,3 +28,6 @@ gon_arm64.json
 
 # We don't want to commit env variables
 *.env
+
+# Tool generated files
+*.idea

CONTRIBUTING.md

@@ -111,7 +111,7 @@ Flags are a way to modify the command, also may be called "options". Flags alway
 
 #### Documentation Requirements
 
-f you are adding a brand new command, or updating a command that has no doc annotations, please define the following doc structures for the command. For more information on all command structs, see [Cobra](https://pkg.go.dev/github.com/spf13/cobra#Command).
+If you are adding a brand new command, or updating a command that has no doc annotations, please define the following doc structures for the command. For more information on all command structs, see [Cobra](https://pkg.go.dev/github.com/spf13/cobra#Command).
 - Add `Use` - (Required) Shows the command and arguments if applicable. Will show up in 'help' output.
 - Add `Short` - (Required) Briefly describes the command. Will show up in 'help' output.
 - Add `Example` - (Required) Example of how to use the command. Will show up in 'help' output.

Makefile

@@ -1,27 +1,31 @@
 # A Self-Documenting Makefile: http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
 
-
 GOLANGCI_VERSION=v1.43.0
 COVERAGE=coverage.out
 
-
 MCLI_SOURCE_FILES?=./cmd/mongocli
 MCLI_BINARY_NAME=mongocli
-MCLI_VERSION?=$(shell git describe --always --tags)
+MCLI_VERSION?=$(shell git tag --list 'mongocli/v*' --sort=committerdate | tail -1 | cut -d "v" -f 2 |  xargs -I % sh -c 'echo %-next' )
 MCLI_GIT_SHA?=$(shell git rev-parse HEAD)
 MCLI_DESTINATION=./bin/$(MCLI_BINARY_NAME)
 MCLI_INSTALL_PATH="${GOPATH}/bin/$(MCLI_BINARY_NAME)"
 MCLI_E2E_BINARY?=../../bin/${MCLI_BINARY_NAME}
 
-
 ATLAS_SOURCE_FILES?=./cmd/atlas
 ATLAS_BINARY_NAME=atlas
+ATLAS_VERSION?=$(shell git tag --list 'atlascli/v*' --sort=committerdate | tail -1 | cut -d "v" -f 2 | xargs -I % sh -c 'echo %-next' )
 ATLAS_DESTINATION=./bin/$(ATLAS_BINARY_NAME)
 ATLAS_INSTALL_PATH="${GOPATH}/bin/$(ATLAS_BINARY_NAME)"
 
-LINKER_FLAGS=-s -w -X github.com/mongodb/mongocli/internal/version.Version=${MCLI_VERSION} -X github.com/mongodb/mongocli/internal/version.GitCommit=${MCLI_GIT_SHA}
-MCLI_LINKER_FLAGS=${LINKER_FLAGS} -X github.com/mongodb/mongocli/internal/config.ToolName=$(MCLI_BINARY_NAME)
-ATLAS_LINKER_FLAGS=${LINKER_FLAGS} -X github.com/mongodb/mongocli/internal/config.ToolName=atlascli
+
+ifeq ($(ATLAS_VERSION),) # use git describe if we don't have an atlascli tag
+	ATLAS_VERSION=$(shell git describe --always --tags | cut -d "v" -f 2)
+endif
+
+
+LINKER_FLAGS=-s -w -X github.com/mongodb/mongocli/internal/version.GitCommit=${MCLI_GIT_SHA}
+MCLI_LINKER_FLAGS=${LINKER_FLAGS} -X github.com/mongodb/mongocli/internal/config.ToolName=$(MCLI_BINARY_NAME) -X github.com/mongodb/mongocli/internal/version.Version=${MCLI_VERSION}
+ATLAS_LINKER_FLAGS=${LINKER_FLAGS} -X github.com/mongodb/mongocli/internal/config.ToolName=atlascli -X github.com/mongodb/mongocli/internal/version.Version=${ATLAS_VERSION}
 ATLAS_E2E_BINARY?=../../bin/${ATLAS_BINARY_NAME}
 
 DEBUG_FLAGS=all=-N -l
@@ -91,9 +95,15 @@ gen-mocks: ## Generate mocks
 	go generate ./internal...
 
 .PHONY: gen-docs
-gen-docs: ## Generate docs for commands
-	@echo "==> Generating docs"
-	go run ./internal/docs/main.go
+gen-docs: gen-docs-mongocli gen-docs-atlascli ## Generate docs for commands
+
+gen-docs-mongocli: ## Generate docs for mongocli commands
+	@echo "==> Generating docs for mongocli"
+	go run ./internal/docs/mongocli/main.go
+
+gen-docs-atlascli: ## Generate docs for atlascli commands
+	@echo "==> Generating docs for atlascli"
+	go run ./internal/docs/atlascli/main.go
 
 .PHONY: build
 build: build-mongocli ## Generate a binary for mongocli

README.md

@@ -1,113 +1,18 @@
-<p align="center">
-  <img width="80" height="80" src="https://raw.github.com/mongodb/mongocli/master/mongocli.svg" alt="MongoDB CLI Logo">
-</p>
-
+## MongoDB Atlas CLI
 
 ![GO tests](https://github.com/mongodb/mongocli/workflows/GO%20tests/badge.svg)
 ![golangci-lint](https://github.com/mongodb/mongocli/workflows/golangci-lint/badge.svg)
 
-The MongoDB CLI is a modern command line interface that enables you to manage your MongoDB services from the terminal.
-
-![mongocli-atlas-quickstart](https://user-images.githubusercontent.com/461027/126986233-0dd5c82a-2c75-4887-ab66-eb018c59e093.gif)
+The MongoDB Atlas CLI repository contains the following modern command line interfaces:
+- [Atlas CLI](atlascli.md)
+- [MongoDB CLI](mongocli.md)
 
 Use simple, one-line commands to interact with MongoDB Atlas, Cloud Manager, or Ops Manager, and to automate management tasks for your deployments.
 
-## Documentation
-
-See the [official docs](https://docs.mongodb.com/mongocli/stable/) for instructions on how to
-install, set up, and reference available commands.
-
-## Installing
-
-### Homebrew on macOS
-
-```bash
-brew install mongocli
-```
-
-### Pre-built Binaries
-
-Download the appropriate version for your platform from [mongocli releases](https://github.com/mongodb/mongocli/releases). 
-Once downloaded, the binary can be run from anywhere.
-You don't need to install it into a global location. 
-This works well for shared hosts and other systems where you don't have a privileged account.
-
-Ideally, you should place this binary somewhere in your `PATH` for easy use. 
-`/usr/local/bin` is the most probable location.
-
-### Build From Source 
-
-#### Prerequisite Tools 
-- [Git](https://git-scm.com/)
-- [Go (at least Go 1.17)](https://golang.org/dl/)
-
-#### Fetch Source
-
-```bash
-git clone https://github.com/mongodb/mongocli.git
-cd mongocli
-```
-
-#### Build
-
-To build `mongocli`, run:
-
-```bash
-make build
-```
-
-The resulting `mongocli` binary is placed in `./bin`.
-
-#### Install
-
-To install the `mongocli` binary in `$GOPATH/bin`, run:
-
-```bash
-make install
-```
-
-**Note:** running `make build` is not needed when running `make install`.
-
-## Usage
-
-Run `mongocli help` for a list of available commands
-or check our [online documentation](https://docs.mongodb.com/mongocli/master/) for more details.
-
-### Getting API Keys
-
-To use `mongocli` you'll need to get API keys, to get them follow the documentation 
-appropriate for the service you're using, 
-[Atlas](https://docs.atlas.mongodb.com/configure-api-access/),
-[Ops Manager](https://docs.opsmanager.mongodb.com/current/tutorial/configure-public-api-access/),
-or [Cloud Manager](https://docs.cloudmanager.mongodb.com/tutorial/manage-programmatic-api-keys/)
-
-### Configuring `mongocli`
-
-Run `mongocli config` to set up your credentials, 
-this is optional, you can use [env variables](https://docs.mongodb.com/mongocli/stable/configure/environment-variables/) instead.
-
-If you're working with Atlas Gov, Ops Manager or Cloud Manager you need to define the service using `--service`
-
-For Atlas Gov, `mongocli config --service cloudgov`.
-
-For Ops Manager, `mongocli config --service ops-manager`.
-
-For Cloud Manager, `mongocli config --service cloud-manager`.
-
-### Shell Completions
-
-If you install via [homebrew](#hombrew-on-macos) no additional actions are needed.
-
-To get specific instructions for your preferred shell run:
-
-```bash
-mongocli completion <bash|zsh|fish|powershell> --help
-```
-
 ## Contributing
 
 See our [CONTRIBUTING.md](CONTRIBUTING.md) guide.
 
 ## License
 
-MongoDB CLI is released under the Apache 2.0 license. See [LICENSE](LICENSE)
+MongoDB CLI and Atlas CLI are released under the Apache 2.0 license. See [LICENSE](LICENSE)

atlascli.md

@@ -0,0 +1,66 @@
+# Atlas CLI (Pre-Release)
+
+The MongoDB Atlas CLI is a modern command line interface that enables you to manage MongoDB Atlas from the terminal.
+
+![atlascli-atlas-quickstart](https://user-images.githubusercontent.com/5663078/156184669-57c8ddce-6f0a-4e84-9311-2d996cb27942.gif)
+
+## Installing
+
+Atlas CLI is currently in the pre-release phase. Do not use it in a production environment.
+
+### Pre-built Binaries
+
+Download the appropriate version for your platform from [Atlas CLI releases](https://github.com/mongodb/mongocli/releases).
+After you download the library, you can run it from anywhere and don't need to install it into a global location.
+This works well for shared hosts and other systems where you don't have a privileged account.
+
+You can place this binary somewhere in your `PATH` for ease of use.
+`/usr/local/bin` is the most probable location.
+
+### Build From Source
+
+#### Fetch Source
+
+```bash
+git clone https://github.com/mongodb/mongocli.git
+cd mongocli
+```
+
+#### Build
+
+To build `atlascli`, run:
+
+```bash
+make build-atlascli
+```
+
+The resulting `atlas` binary is placed in `./bin`.
+
+#### Install
+
+To install the `atlas` binary in `$GOPATH/bin`, run:
+
+```bash
+make install-atlascli
+```
+
+**Note:** running `make build-atlascli` is not needed when running `make install-atlascli`.
+
+
+## Usage
+
+To get a list of available commands, run `atlas help`
+or check our documentation for more details.
+
+### Configuring Atlas CLI
+To use `atlascli`, open your terminal, run `atlas auth login`, and follow the prompted steps.
+
+### Shell Completions
+
+If you install via [homebrew](#hombrew-on-macos) no additional actions are needed.
+
+To get specific instructions for your preferred shell, run:
+
+```bash
+atlas completion <bash|zsh|fish|powershell> --help
+```