feat: Convert tags, labels, timeouts, advanced_configuration, bi_connector_config and pinned_fcv (#21)

* basic tags

* improve example

* simple timeouts

* add labels

* fix quotes

* fix timeout empty

* arrays brackets in new lines

* add advanced configuration support and refactor timeout handling

* Block always as first param

* bi_connector

* pinn_fcv

* allow unresolved expressions in keys in tags and labels

* doc clarification

* readme

---------

Co-authored-by: Espen Albert <[email protected]>

Author: lantoli

README.md

@@ -2,11 +2,12 @@
 
 [![Code Health](https://github.com/mongodb-labs/atlas-cli-plugin-terraform/actions/workflows/code-health.yml/badge.svg)](https://github.com/mongodb-labs/atlas-cli-plugin-terraform/actions/workflows/code-health.yml)
 
-This repository contains the Atlas CLI plugin for Terraform's MongoDB Atlas Provider.
+This repository contains the Atlas CLI plugin for [Terraform's MongoDB Atlas Provider](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs).
 
-WIP
+It has the following commands to help with your Terraform configurations:
+- **clusterToAdvancedCluster**: Convert a `mongodbatlas_cluster` Terraform configuration to `mongodbatlas_advanced_cluster` (preview provider v2).
 
-## Installing
+## Installation
 
 Install the [Atlas CLI](https://github.com/mongodb/mongodb-atlas-cli) if you haven't done it yet.
 
@@ -37,7 +38,6 @@ If you want to overwrite the output file if it exists, or even use the same outp
 - `priority` is required in `regions_config` and must be a resolved number between 7 and 1, e.g. `var.priority` is not supported. This is to allow reordering them by descending priority as this is expected in `mongodbatlas_advanced_cluster`.
 - `dynamic` blocks to generate `replication_specs`, `regions_config`, etc. are not supported.
 
-
 ## Contributing
 
 See our [CONTRIBUTING.md](CONTRIBUTING.md) guide.

internal/convert/const_names.go

@@ -4,6 +4,12 @@ const (
 	nRepSpecs                   = "replication_specs"
 	nConfig                     = "region_configs"
 	nConfigSrc                  = "regions_config"
+	nTags                       = "tags"
+	nLabels                     = "labels"
+	nTimeouts                   = "timeouts"
+	nAdvConf                    = "advanced_configuration"
+	nPinnedFCV                  = "pinned_fcv"
+	nBiConnector                = "bi_connector_config"
 	nElectableSpecs             = "electable_specs"
 	nAutoScaling                = "auto_scaling"
 	nReadOnlySpecs              = "read_only_specs"
@@ -38,4 +44,6 @@ const (
 	nElectableNodes             = "electable_nodes"
 	nReadOnlyNodes              = "read_only_nodes"
 	nAnalyticsNodes             = "analytics_nodes"
+	nKey                        = "key"
+	nValue                      = "value"
 )

internal/convert/convert.go

@@ -4,7 +4,10 @@ import (
 	"errors"
 	"fmt"
 	"sort"
+	"strconv"
+	"strings"
 
+	"github.com/hashicorp/hcl/v2/hclsyntax"
 	"github.com/hashicorp/hcl/v2/hclwrite"
 	"github.com/mongodb-labs/atlas-cli-plugin-terraform/internal/hcl"
 	"github.com/zclconf/go-cty/cty"
@@ -86,11 +89,11 @@ func fillFreeTier(resourceb *hclwrite.Body) error {
 	if err := hcl.MoveAttr(resourceb, electableSpec.Body(), nInstanceSizeSrc, nInstanceSize, errFreeCluster); err != nil {
 		return err
 	}
-	configb.SetAttributeRaw(nElectableSpecs, hcl.TokensObject(electableSpec))
+	configb.SetAttributeRaw(nElectableSpecs, hcl.TokensObject(electableSpec.Body()))
 
 	repSpecs := hclwrite.NewEmptyFile()
-	repSpecs.Body().SetAttributeRaw(nConfig, hcl.TokensArraySingle(config))
-	resourceb.SetAttributeRaw(nRepSpecs, hcl.TokensArraySingle(repSpecs))
+	repSpecs.Body().SetAttributeRaw(nConfig, hcl.TokensArraySingle(configb))
+	resourceb.SetAttributeRaw(nRepSpecs, hcl.TokensArraySingle(repSpecs.Body()))
 	return nil
 }
 
@@ -115,14 +118,31 @@ func fillReplicationSpecs(resourceb *hclwrite.Body) error {
 	}
 	repSpecs := hclwrite.NewEmptyFile()
 	repSpecs.Body().SetAttributeRaw(nConfig, configs)
-
-	resourceb.SetAttributeRaw(nRepSpecs, hcl.TokensArraySingle(repSpecs))
+	resourceb.SetAttributeRaw(nRepSpecs, hcl.TokensArraySingle(repSpecs.Body()))
+	tags, errTags := getTagsLabelsOpt(resourceb, nTags)
+	if errTags != nil {
+		return errTags
+	}
+	if tags != nil {
+		resourceb.SetAttributeRaw(nTags, tags)
+	}
+	labels, errLabels := getTagsLabelsOpt(resourceb, nLabels)
+	if errLabels != nil {
+		return errLabels
+	}
+	if labels != nil {
+		resourceb.SetAttributeRaw(nLabels, labels)
+	}
+	fillBlockOpt(resourceb, nTimeouts)
+	fillBlockOpt(resourceb, nAdvConf)
+	fillBlockOpt(resourceb, nBiConnector)
+	fillBlockOpt(resourceb, nPinnedFCV)
 	resourceb.RemoveBlock(repSpecsSrc)
 	return nil
 }
 
 func getRegionConfigs(repSpecsSrc *hclwrite.Block, root attrVals) (hclwrite.Tokens, error) {
-	var configs []*hclwrite.File
+	var configs []*hclwrite.Body
 	for {
 		configSrc := repSpecsSrc.Body().FirstMatchingBlock(nConfigSrc, nil)
 		if configSrc == nil {
@@ -132,15 +152,15 @@ func getRegionConfigs(repSpecsSrc *hclwrite.Block, root attrVals) (hclwrite.Toke
 		if err != nil {
 			return nil, err
 		}
-		configs = append(configs, config)
+		configs = append(configs, config.Body())
 		repSpecsSrc.Body().RemoveBlock(configSrc)
 	}
 	if len(configs) == 0 {
 		return nil, fmt.Errorf("%s: %s not found", errRepSpecs, nConfigSrc)
 	}
 	sort.Slice(configs, func(i, j int) bool {
-		pi, _ := hcl.GetAttrInt(configs[i].Body().GetAttribute(nPriority), errPriority)
-		pj, _ := hcl.GetAttrInt(configs[j].Body().GetAttribute(nPriority), errPriority)
+		pi, _ := hcl.GetAttrInt(configs[i].GetAttribute(nPriority), errPriority)
+		pj, _ := hcl.GetAttrInt(configs[j].GetAttribute(nPriority), errPriority)
 		return pi > pj
 	})
 	return hcl.TokensArray(configs), nil
@@ -156,15 +176,15 @@ func getRegionConfig(configSrc *hclwrite.Block, root attrVals) (*hclwrite.File,
 	if err := setPriority(fileb, configSrc.Body().GetAttribute(nPriority)); err != nil {
 		return nil, err
 	}
-	electableSpecs, errElec := getSpecs(nElectableNodes, configSrc, root)
+	electableSpecs, errElec := getSpecs(configSrc, nElectableNodes, root)
 	if errElec != nil {
 		return nil, errElec
 	}
 	fileb.SetAttributeRaw(nElectableSpecs, electableSpecs)
-	if readOnly, _ := getSpecs(nReadOnlyNodes, configSrc, root); readOnly != nil {
+	if readOnly, _ := getSpecs(configSrc, nReadOnlyNodes, root); readOnly != nil {
 		fileb.SetAttributeRaw(nReadOnlySpecs, readOnly)
 	}
-	if analytics, _ := getSpecs(nAnalyticsNodes, configSrc, root); analytics != nil {
+	if analytics, _ := getSpecs(configSrc, nAnalyticsNodes, root); analytics != nil {
 		fileb.SetAttributeRaw(nAnalyticsSpecs, analytics)
 	}
 	if autoScaling := getAutoScalingOpt(root.opt); autoScaling != nil {
@@ -173,7 +193,7 @@ func getRegionConfig(configSrc *hclwrite.Block, root attrVals) (*hclwrite.File,
 	return file, nil
 }
 
-func getSpecs(countName string, configSrc *hclwrite.Block, root attrVals) (hclwrite.Tokens, error) {
+func getSpecs(configSrc *hclwrite.Block, countName string, root attrVals) (hclwrite.Tokens, error) {
 	var (
 		file  = hclwrite.NewEmptyFile()
 		fileb = file.Body()
@@ -196,7 +216,7 @@ func getSpecs(countName string, configSrc *hclwrite.Block, root attrVals) (hclwr
 	if root.opt[nDiskIOPSSrc] != nil {
 		fileb.SetAttributeRaw(nDiskIOPS, root.opt[nDiskIOPSSrc])
 	}
-	return hcl.TokensObject(file), nil
+	return hcl.TokensObject(fileb), nil
 }
 
 func getAutoScalingOpt(opt map[string]hclwrite.Tokens) hclwrite.Tokens {
@@ -209,19 +229,55 @@ func getAutoScalingOpt(opt map[string]hclwrite.Tokens) hclwrite.Tokens {
 			{nComputeScaleDownEnabledSrc, nComputeScaleDownEnabled},
 		}
 		file  = hclwrite.NewEmptyFile()
+		fileb = file.Body()
 		found = false
 	)
 	for _, tuple := range names {
 		src, dst := tuple[0], tuple[1]
 		if tokens := opt[src]; tokens != nil {
-			file.Body().SetAttributeRaw(dst, tokens)
+			fileb.SetAttributeRaw(dst, tokens)
 			found = true
 		}
 	}
 	if !found {
 		return nil
 	}
-	return hcl.TokensObject(file)
+	return hcl.TokensObject(fileb)
+}
+
+func getTagsLabelsOpt(resourceb *hclwrite.Body, name string) (hclwrite.Tokens, error) {
+	var (
+		file  = hclwrite.NewEmptyFile()
+		fileb = file.Body()
+		found = false
+	)
+	for {
+		block := resourceb.FirstMatchingBlock(name, nil)
+		if block == nil {
+			break
+		}
+		key := block.Body().GetAttribute(nKey)
+		value := block.Body().GetAttribute(nValue)
+		if key == nil || value == nil {
+			return nil, fmt.Errorf("%s: %s or %s not found", name, nKey, nValue)
+		}
+		setKeyValue(fileb, key, value)
+		resourceb.RemoveBlock(block)
+		found = true
+	}
+	if !found {
+		return nil, nil
+	}
+	return hcl.TokensObject(fileb), nil
+}
+
+func fillBlockOpt(resourceb *hclwrite.Body, name string) {
+	block := resourceb.FirstMatchingBlock(name, nil)
+	if block == nil {
+		return
+	}
+	resourceb.RemoveBlock(block)
+	resourceb.SetAttributeRaw(name, hcl.TokensObject(block.Body()))
 }
 
 func checkDynamicBlock(body *hclwrite.Body) error {
@@ -233,6 +289,19 @@ func checkDynamicBlock(body *hclwrite.Body) error {
 	return nil
 }
 
+func setKeyValue(body *hclwrite.Body, key, value *hclwrite.Attribute) {
+	keyStr, err := hcl.GetAttrString(key, "")
+	if err == nil {
+		if !hclsyntax.ValidIdentifier(keyStr) {
+			keyStr = strconv.Quote(keyStr) // wrap in quotes so invalid identifiers (e.g. with blanks) can be used as attribute names
+		}
+	} else {
+		keyStr = strings.TrimSpace(string(key.Expr().BuildTokens(nil).Bytes()))
+		keyStr = "(" + keyStr + ")" // wrap in parentheses so unresolved expressions can be used as attribute names
+	}
+	body.SetAttributeRaw(keyStr, value.Expr().BuildTokens(nil))
+}
+
 func setPriority(body *hclwrite.Body, priority *hclwrite.Attribute) error {
 	if priority == nil {
 		return fmt.Errorf("%s: %s not found", errRepSpecs, nPriority)

internal/convert/testdata/clu2adv/adv_config_bi_connector_pinned_fcv.in.tf

@@ -0,0 +1,29 @@
+resource "mongodbatlas_cluster" "this" {
+  project_id                  = var.project_id
+  name                        = var.cluster_name
+  cluster_type                = "REPLICASET"
+  provider_name               = "AWS"
+  provider_instance_size_name = var.instance_size
+  advanced_configuration {
+    # comments in advanced_configuration are kept
+    javascript_enabled = true
+  }
+  bi_connector_config {
+    # comments in bi_connector_config are kept
+    enabled         = true
+    read_preference = "secondary"
+  }
+  pinned_fcv {
+    # comments in pinned_fcv are kept
+    expiration_date = var.fcv_date
+    version         = var.fcv_date
+  }
+  replication_specs {
+    num_shards = 1
+    regions_config {
+      region_name     = "US_WEST_1"
+      electable_nodes = 2
+      priority        = 7
+    }
+  }
+}

internal/convert/testdata/clu2adv/adv_config_bi_connector_pinned_fcv.out.tf

@@ -0,0 +1,37 @@
+resource "mongodbatlas_advanced_cluster" "this" {
+  project_id   = var.project_id
+  name         = var.cluster_name
+  cluster_type = "REPLICASET"
+  replication_specs = [
+    {
+      region_configs = [
+        {
+          provider_name = "AWS"
+          region_name   = "US_WEST_1"
+          priority      = 7
+          electable_specs = {
+            node_count    = 2
+            instance_size = var.instance_size
+          }
+        }
+      ]
+    }
+  ]
+  advanced_configuration = {
+    # comments in advanced_configuration are kept
+    javascript_enabled = true
+  }
+  bi_connector_config = {
+    # comments in bi_connector_config are kept
+    enabled         = true
+    read_preference = "secondary"
+  }
+  pinned_fcv = {
+    # comments in pinned_fcv are kept
+    expiration_date = var.fcv_date
+    version         = var.fcv_date
+  }
+
+  # Generated by atlas-cli-plugin-terraform.
+  # Please confirm that all references to this resource are updated.
+}

internal/convert/testdata/clu2adv/analytics_read_only_all_params.out.tf

@@ -2,34 +2,38 @@ resource "mongodbatlas_advanced_cluster" "ar" {
   project_id   = var.project_id
   name         = "ar"
   cluster_type = "REPLICASET"
-  replication_specs = [{
-    region_configs = [{
-      provider_name = "AWS"
-      region_name   = "US_EAST_1"
-      priority      = 7
-      electable_specs = {
-        node_count      = 3
-        instance_size   = "M10"
-        disk_size_gb    = 90
-        ebs_volume_type = "PROVISIONED"
-        disk_iops       = 100
-      }
-      read_only_specs = {
-        node_count      = 1
-        instance_size   = "M10"
-        disk_size_gb    = 90
-        ebs_volume_type = "PROVISIONED"
-        disk_iops       = 100
-      }
-      analytics_specs = {
-        node_count      = 2
-        instance_size   = "M10"
-        disk_size_gb    = 90
-        ebs_volume_type = "PROVISIONED"
-        disk_iops       = 100
-      }
-    }]
-  }]
+  replication_specs = [
+    {
+      region_configs = [
+        {
+          provider_name = "AWS"
+          region_name   = "US_EAST_1"
+          priority      = 7
+          electable_specs = {
+            node_count      = 3
+            instance_size   = "M10"
+            disk_size_gb    = 90
+            ebs_volume_type = "PROVISIONED"
+            disk_iops       = 100
+          }
+          read_only_specs = {
+            node_count      = 1
+            instance_size   = "M10"
+            disk_size_gb    = 90
+            ebs_volume_type = "PROVISIONED"
+            disk_iops       = 100
+          }
+          analytics_specs = {
+            node_count      = 2
+            instance_size   = "M10"
+            disk_size_gb    = 90
+            ebs_volume_type = "PROVISIONED"
+            disk_iops       = 100
+          }
+        }
+      ]
+    }
+  ]
 
   # Generated by atlas-cli-plugin-terraform.
   # Please confirm that all references to this resource are updated.