local dev

Author: lantoli

.gitignore

@@ -1 +1,2 @@
 bin
+bin-plugin

CONTRIBUTING.md

@@ -1,3 +1,11 @@
 # Contributing to the Atlas CLI plugin for Terraform's MongoDB Atlas Provider
 
 WIP
+
+## Building
+
+You can build the binary plugin by running `make build`. You'll need to have Go installed. Then you can run directly the generated binary `./bin/binary terraform [command]` to test your changes.
+
+## Using the plugin from the CLI
+
+You can also use the plugin with your changes from the CLI by running: `make local` and following the instructions displayed.

GNUmakefile

@@ -0,0 +1,55 @@
+CLI_SOURCE_FILES?=./cmd/plugin
+CLI_BINARY_NAME?=binary
+CLI_DESTINATION=./bin/$(CLI_BINARY_NAME)
+MANIFEST_FILE?=./bin/manifest.yml
+WIN_MANIFEST_FILE?=./bin/manifest.windows.yml
+
+GOLANGCI_VERSION=v1.63.4 # Also update golangci-lint GH action in code-health.yml when updating this version
+
+.PHONY: build 
+build: ## Generate the binary in ./bin
+	@echo "==> Building plugin binary: $(CLI_BINARY_NAME)"
+	go build -o $(CLI_DESTINATION) $(CLI_SOURCE_FILES)
+
+.PHONY: tools 
+tools: ## Install the dev tools (dependencies)
+	@echo "==> Installing dev tools..."
+	go telemetry off # disable sending telemetry data, more info: https://go.dev/doc/telemetry
+	go install github.com/rhysd/actionlint/cmd/actionlint@latest
+	go install golang.org/x/tools/go/analysis/passes/fieldalignment/cmd/fieldalignment@latest
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin $(GOLANGCI_VERSION)
+
+.PHONY: clean
+clean: ## Clean binary folders
+	rm -rf ./bin ./bin-plugin
+
+.PHONY: local
+local: clean build ## Allow to run the plugin locally
+	@echo "==> Configuring plugin locally"
+	VERSION=0.0.1-local GITHUB_REPOSITORY_OWNER=owner GITHUB_REPOSITORY_NAME=repo $(MAKE) generate-manifest
+	@mkdir -p ./bin-plugin
+	cp -r ./bin ./bin-plugin/atlas-cli-plugin-terraform
+	@echo
+	@echo "==> Plugin is ready to be used locally"	
+	@echo "run: export ATLAS_CLI_EXTRA_PLUGIN_DIRECTORY=./bin-plugin"
+	@echo "then this command should show the plugin: atlas plugin list"
+
+.PHONY: generate-all-manifests
+generate-all-manifests: generate-manifest generate-manifest-windows ## Generate all the manifest files
+
+.PHONY: generate-manifest
+generate-manifest: ## Generate the manifest file for non-windows OSes
+	@echo "==> Generating non-windows manifest file"
+	@mkdir -p ./bin
+	BINARY=$(CLI_BINARY_NAME) envsubst < manifest.template.yml > $(MANIFEST_FILE)
+
+.PHONY: generate-manifest-windows
+generate-manifest-windows: ## Generate the manifest file for windows OSes
+	@echo "==> Generating windows manifest file"
+	CLI_BINARY_NAME="${CLI_BINARY_NAME}.exe" MANIFEST_FILE="$(WIN_MANIFEST_FILE)" $(MAKE) generate-manifest
+
+.PHONY: help
+.DEFAULT_GOAL := help
+help:
+	@grep -h -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+	

Makefile

@@ -11,7 +11,7 @@ import (
 func main() {
 	terraformCmd := &cobra.Command{
 		Use:     "terraform",
-		Short:   "Root command of the Atlas CLI plugin for Terraform's MongoDB Atlas Provider",
+		Short:   "Utilities for Terraform's MongoDB Atlas Provider",
 		Aliases: []string{"tf"},
 	}
 

cmd/plugin/main.go

@@ -0,0 +1,12 @@
+name: atlas-cli-plugin-terraform
+description: Utilities for Terraform's MongoDB Atlas Provider
+version: $VERSION
+github:
+    owner: $GITHUB_REPOSITORY_OWNER
+    name: $GITHUB_REPOSITORY_NAME
+binary: $BINARY
+commands:
+    terraform:
+        description: Utilities for Terraform's MongoDB Atlas Provider
+    tf:
+        description: Alias for the terraform command