feat: Adds optionally moved blocks (#26)

* remove adv2 command

* e2e tests

* flags file

* includeMoved

* atlas cli setup

* add e2e tests

* fix linter

* add moved e2e test

* extract comments to const

* note to remind delete old clusters

* typo

* func comments for getResourceName and getResourceLabel

Author: lantoli

.github/workflows/code-health.yml

@@ -20,6 +20,20 @@ jobs:
       run: make build
     - name: Unit Test
       run: make test
+
+  e2e:
+    runs-on: ubuntu-latest
+    permissions: {}
+    steps:
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+    - uses: actions/setup-go@f111f3307d8850f501ac008e886eec1fd1932a34
+      with:
+        go-version-file: 'go.mod'
+    - name: setup Atlas CLI
+      uses: mongodb/atlas-github-action@15663d068c40a8582d881560961fce9d45e0df9a
+    - name: E2E Test
+      run: make test-e2e
+    
   lint:
     runs-on: ubuntu-latest
     permissions: {}

Makefile

@@ -25,11 +25,15 @@ clean: ## Clean binary folders
 
 .PHONY: test
 test: ## Run unit tests
-	go test ./... -timeout=30s -parallel=4 -race
+	go test ./internal/... -timeout=30s -parallel=4 -race
 
 .PHONY: test-update
 test-update: ## Run unit tests and update the golden files
-	go test ./... -timeout=30s -parallel=4 -race -update
+	go test ./internal/... -timeout=30s -parallel=4 -race -update
+
+.PHONY: test-e2e
+test-e2e: local ## Run E2E tests (running the plugin binary)
+	ATLAS_CLI_EXTRA_PLUGIN_DIRECTORY="${PWD}/bin-plugin" go test ./test/... -timeout=30s -parallel=4 -race
 
 .PHONY: local
 local: clean build ## Allow to run the plugin locally

README.md

@@ -32,9 +32,11 @@ you can also use shorter aliases, e.g.:
 atlas tf clu2adv -f in.tf -o out.tf
 ```
 
-If you want to overwrite the output file if it exists, or even use the same output file as the input file, use the `--replaceOutput true` or the `-r` flag.
+If you want to include the `moved blocks` in the output file, use the `--includeMoved` or the `-m` flag.
 
-You can use the `--watch true` or the `-w` flag to keep the plugin running and watching for changes in the input file. You can have input and output files open in an editor and see easily how changes to the input file affect the output file.
+If you want to overwrite the output file if it exists, or even use the same output file as the input file, use the `--replaceOutput` or the `-r` flag.
+
+You can use the `--watch` or the `-w` flag to keep the plugin running and watching for changes in the input file. You can have input and output files open in an editor and see easily how changes to the input file affect the output file.
 
 ### Limitations
 

cmd/plugin/main.go

@@ -4,7 +4,6 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/mongodb-labs/atlas-cli-plugin-terraform/internal/cli/adv2"
 	"github.com/mongodb-labs/atlas-cli-plugin-terraform/internal/cli/clu2adv"
 	"github.com/spf13/cobra"
 )
@@ -15,7 +14,7 @@ func main() {
 		Short:   "Utilities for Terraform's MongoDB Atlas Provider",
 		Aliases: []string{"tf"},
 	}
-	terraformCmd.AddCommand(clu2adv.Builder(), adv2.Builder())
+	terraformCmd.AddCommand(clu2adv.Builder())
 
 	completionOption := &cobra.CompletionOptions{
 		DisableDefaultCmd:   true,

internal/cli/adv2/adv2.go

@@ -1,6 +1,7 @@
 package clu2adv
 
 import (
+	"github.com/mongodb-labs/atlas-cli-plugin-terraform/internal/flag"
 	"github.com/spf13/afero"
 	"github.com/spf13/cobra"
 )
@@ -19,11 +20,12 @@ func Builder() *cobra.Command {
 			return o.Run()
 		},
 	}
-	cmd.Flags().StringVarP(&o.file, "file", "f", "", "input file")
-	_ = cmd.MarkFlagRequired("file")
-	cmd.Flags().StringVarP(&o.output, "output", "o", "", "output file")
-	_ = cmd.MarkFlagRequired("output")
-	cmd.Flags().BoolVarP(&o.replaceOutput, "replaceOutput", "r", false, "replace output file if exists")
-	cmd.Flags().BoolVarP(&o.watch, "watch", "w", false, "keeps the plugin running and watches the input file for changes")
+	cmd.Flags().StringVarP(&o.file, flag.File, flag.FileShort, "", "input file")
+	_ = cmd.MarkFlagRequired(flag.File)
+	cmd.Flags().StringVarP(&o.output, flag.Output, flag.OutputShort, "", "output file")
+	_ = cmd.MarkFlagRequired(flag.Output)
+	cmd.Flags().BoolVarP(&o.replaceOutput, flag.ReplaceOutput, flag.ReplaceOutputShort, false, "replace output file if exists")
+	cmd.Flags().BoolVarP(&o.watch, flag.Watch, flag.WatchShort, false, "keeps the plugin running and watches the input file for changes")
+	cmd.Flags().BoolVarP(&o.includeMoved, flag.IncludeMoved, flag.IncludeMovedShort, false, "include moved blocks in the output file")
 	return cmd
 }

internal/cli/clu2adv/clu2adv.go

@@ -16,6 +16,7 @@ type opts struct {
 	output        string
 	replaceOutput bool
 	watch         bool
+	includeMoved  bool
 }
 
 func (o *opts) PreRun() error {
@@ -43,7 +44,7 @@ func (o *opts) generateFile(allowParseErrors bool) error {
 	if err != nil {
 		return fmt.Errorf("failed to read file %s: %w", o.file, err)
 	}
-	outConfig, err := convert.ClusterToAdvancedCluster(inConfig)
+	outConfig, err := convert.ClusterToAdvancedCluster(inConfig, o.includeMoved)
 	if err != nil {
 		if allowParseErrors {
 			outConfig = []byte("# CONVERT ERROR: " + err.Error() + "\n\n")

internal/cli/clu2adv/opts.go

@@ -48,4 +48,7 @@ const (
 	nKey                        = "key"
 	nValue                      = "value"
 	nUseRepSpecsPerShard        = "use_replication_spec_per_shard"
+	nMoved                      = "moved"
+	nFrom                       = "from"
+	nTo                         = "to"
 )

internal/convert/const_names.go

@@ -23,11 +23,17 @@ const (
 	valClusterType   = "REPLICASET"
 	valMaxPriority   = 7
 	valMinPriority   = 1
-	errFreeCluster   = "free cluster (because no " + nRepSpecs + ")"
-	errRepSpecs      = "setting " + nRepSpecs
-	errConfigs       = "setting " + nConfig
-	errPriority      = "setting " + nPriority
-	errNumShards     = "setting " + nNumShards
+
+	errFreeCluster = "free cluster (because no " + nRepSpecs + ")"
+	errRepSpecs    = "setting " + nRepSpecs
+	errConfigs     = "setting " + nConfig
+	errPriority    = "setting " + nPriority
+	errNumShards   = "setting " + nNumShards
+
+	commentGeneratedBy       = "Generated by atlas-cli-plugin-terraform."
+	commentConfirmReferences = "Please confirm that all references to this resource are updated."
+	commentMovedBlock        = "Moved blocks"
+	commentRemovedOld        = "Note: Remember to remove or comment out the old cluster definitions."
 )
 
 type attrVals struct {
@@ -40,24 +46,33 @@ type attrVals struct {
 // All other resources and data sources are left untouched.
 // Note: hclwrite.Tokens are used instead of cty.Value so expressions with interpolations like var.region can be preserved.
 // cty.Value only supports literal expressions.
-func ClusterToAdvancedCluster(config []byte) ([]byte, error) {
+func ClusterToAdvancedCluster(config []byte, includeMoved bool) ([]byte, error) {
+	var moveLabels []string
 	parser, err := hcl.GetParser(config)
 	if err != nil {
 		return nil, err
 	}
-	for _, block := range parser.Body().Blocks() {
-		converted, err := convertResource(block)
+	parserb := parser.Body()
+	for _, block := range parserb.Blocks() {
+		convertedResource, err := convertResource(block)
 		if err != nil {
-			return nil, err
+			return nil,
+				err
 		}
-		converted = converted || convertDataSource(block)
-		if converted {
+		if includeMoved && convertedResource {
+			if moveLabel := getResourceLabel(block); moveLabel != "" {
+				moveLabels = append(moveLabels, moveLabel)
+			}
+		}
+		convertedDataSource := convertDataSource(block)
+		if convertedResource || convertedDataSource {
 			blockb := block.Body()
 			blockb.AppendNewline()
-			hcl.AppendComment(blockb, "Generated by atlas-cli-plugin-terraform.")
-			hcl.AppendComment(blockb, "Please confirm that all references to this resource are updated.")
+			hcl.AppendComment(blockb, commentGeneratedBy)
+			hcl.AppendComment(blockb, commentConfirmReferences)
 		}
 	}
+	fillMovedBlocks(parserb, moveLabels)
 	return parser.Bytes(), nil
 }
 
@@ -99,6 +114,25 @@ func convertDataSource(block *hclwrite.Block) bool {
 	return false
 }
 
+func fillMovedBlocks(body *hclwrite.Body, moveLabels []string) {
+	if len(moveLabels) == 0 {
+		return
+	}
+	body.AppendNewline()
+	hcl.AppendComment(body, commentMovedBlock)
+	hcl.AppendComment(body, commentRemovedOld)
+	body.AppendNewline()
+	for i, moveLabel := range moveLabels {
+		block := body.AppendNewBlock(nMoved, nil)
+		blockb := block.Body()
+		hcl.SetAttrExpr(blockb, nFrom, fmt.Sprintf("%s.%s", cluster, moveLabel))
+		hcl.SetAttrExpr(blockb, nTo, fmt.Sprintf("%s.%s", advCluster, moveLabel))
+		if i < len(moveLabels)-1 {
+			body.AppendNewline()
+		}
+	}
+}
+
 // fillFreeTierCluster is the entry point to convert clusters in free tier
 func fillFreeTierCluster(resourceb *hclwrite.Body) error {
 	resourceb.SetAttributeValue(nClusterType, cty.StringVal(valClusterType))
@@ -338,6 +372,8 @@ func setResourceName(resource *hclwrite.Block, name string) {
 	resource.SetLabels(labels)
 }
 
+// getResourceName returns the first label of a block, if it exists.
+// e.g. in resource "mongodbatlas_cluster" "mycluster", the first label is "mongodbatlas_cluster".
 func getResourceName(resource *hclwrite.Block) string {
 	labels := resource.Labels()
 	if len(labels) == 0 {
@@ -346,6 +382,16 @@ func getResourceName(resource *hclwrite.Block) string {
 	return labels[0]
 }
 
+// getResourceLabel returns the second label of a block, if it exists.
+// e.g. in resource "mongodbatlas_cluster" "mycluster", the second label is "mycluster".
+func getResourceLabel(resource *hclwrite.Block) string {
+	labels := resource.Labels()
+	if len(labels) <= 1 {
+		return ""
+	}
+	return labels[1]
+}
+
 func checkDynamicBlock(body *hclwrite.Body) error {
 	for _, block := range body.Blocks() {
 		if block.Type() == "dynamic" {

internal/convert/convert.go

@@ -38,7 +38,8 @@ func TestClusterToAdvancedCluster(t *testing.T) {
 		t.Run(testName, func(t *testing.T) {
 			inConfig, err := afero.ReadFile(fs, inputFile)
 			require.NoError(t, err)
-			outConfig, err := convert.ClusterToAdvancedCluster(inConfig)
+			includeMoved := strings.Contains(testName, "includeMoved")
+			outConfig, err := convert.ClusterToAdvancedCluster(inConfig, includeMoved)
 			if err == nil {
 				g.Assert(t, testName, outConfig)
 			} else {