chore: Create plugin command with test infra #12

lantoli · 2025-01-22T17:33:54Z

Description

Create plugin command with test infra

Command is very basic at the moment, it just transforms the resource type
There is an example of tests using golden files

Link to any related issue(s): CLOUDP-295406

Type of change:

Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR. A migration guide must be created or updated if the new feature will go in a major version.
Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
This change requires a documentation update
Documentation fix/enhancement

Required Checklist:

I have signed the MongoDB CLA
I have read the contributing guides
I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
I have added any necessary documentation (if appropriate)
I have run make fmt and formatted my code
If changes include deprecations or removals I have added appropriate changelog entries.
If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

github-actions · 2025-01-28T00:06:22Z

This PR has gone 7 days without any activity and meets the project’s definition of "stale". This will be auto-closed if there is no new activity over the next 7 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!

lantoli · 2025-01-30T00:06:41Z

internal/cli/clu2adv/clu2adv.go

+			return o.Run()
+		},
+	}
+	cmd.Flags().StringVarP(&o.file, "file", "f", "", "input file")


I think that at the moment it's not necessary to have const files for Flag, Usage, etc.

EspenAlbert · 2025-01-30T07:44:29Z

cmd/plugin/main.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"os"

-	"github.com/mongodb-labs/atlas-cli-plugin-terraform/internal/cli/hello"
+	"github.com/mongodb-labs/atlas-cli-plugin-terraform/internal/cli/clu2adv"


A bit unconventional package name, but I like it

it's the (short) alias for the command, but let me know if you think of a better name

EspenAlbert · 2025-01-30T07:49:58Z

go.mod

+require (
+	github.com/hashicorp/hcl/v2 v2.23.0
+	github.com/sebdah/goldie/v2 v2.5.5
+	github.com/spf13/afero v1.12.0


Looks like a solid choice for fs handling

yes, same as in CLI

EspenAlbert · 2025-01-30T07:50:58Z

internal/hcl/hcl_test.go

+	"github.com/stretchr/testify/require"
+)
+
+func TestClusterToAdvancedCluster(t *testing.T) {


Nice! This will be easy to extend

yes, just drop the .in.tf , use make test-update, and check the output files are as expected, and there you have more tests

Makefile

internal/cli/clu2adv/clu2adv.go

EspenAlbert

Great job!

marcosuma · 2025-01-30T10:56:00Z

internal/hcl/hcl.go

+		isResource := resource.Type() == "resource"
+		labels := resource.Labels()
+		resourceName := labels[0]
+		if !isResource || resourceName != "mongodbatlas_cluster" {


can you make const strings from this file? mongodbatlas_cluster, mongodbatlas_advanced_cluster, resource

thanks, changed here: db532d0

marcosuma · 2025-01-30T10:56:58Z

internal/cli/clu2adv/clu2adv.go

+	o := &opts{fs: afero.NewOsFs()}
+	cmd := &cobra.Command{
+		Use:     "cluster_to_advanced",
+		Short:   "Upgrade cluster to advanced_cluster",


isn't actually Converts more accurate?

you're right, changed here: 1c24a51

marcosuma · 2025-01-30T11:00:11Z

internal/cli/clu2adv/clu2adv.go

+	cmd := &cobra.Command{
+		Use:     "cluster_to_advanced",
+		Short:   "Upgrade cluster to advanced_cluster",
+		Long:    "Upgrade Terraform config from mongodbatlas_cluster to mongodbatlas_advanced_cluster",


Suggested change

Long: "Upgrade Terraform config from mongodbatlas_cluster to mongodbatlas_advanced_cluster",

Long: "Converts a Terraform configuration from mongodbatlas_cluster to mongodbatlas_advanced_cluster",

changed here: 1c24a51
(keeping 2nd person form to be consistent)

lantoli · 2025-01-30T11:26:27Z

internal/cli/clu2adv/clu2adv.go

+	_ = cmd.MarkFlagRequired("file")
+	cmd.Flags().StringVarP(&o.output, "output", "o", "", "output file")
+	_ = cmd.MarkFlagRequired("output")
+	cmd.Flags().BoolVarP(&o.overwriteOutput, "overwriteOutput", "w", false, "overwrite output file if exists")


file and output are the standard params for input and output files

carriecwk

lgtm

README.md

Co-authored-by: carriecwk <[email protected]>

initial command

de79fb8

lantoli added stale not_stale and removed stale labels Jan 28, 2025

lantoli added 6 commits January 29, 2025 00:12

pass parameters

00651b5

overwriteOutput flag

ca8fc6d

add unit tests

01e590b

add simple transformation functionality

da1a0e4

transformation tests

9ba1d4e

add comment

c946233

lantoli commented Jan 30, 2025

View reviewed changes

lantoli marked this pull request as ready for review January 30, 2025 07:24

lantoli requested a review from a team as a code owner January 30, 2025 07:25

lantoli requested a review from jeroenvervaeke January 30, 2025 07:25

EspenAlbert reviewed Jan 30, 2025

View reviewed changes

Makefile Show resolved Hide resolved

EspenAlbert reviewed Jan 30, 2025

View reviewed changes

internal/cli/clu2adv/clu2adv.go Outdated Show resolved Hide resolved

EspenAlbert approved these changes Jan 30, 2025

View reviewed changes

marcosuma reviewed Jan 30, 2025

View reviewed changes

lantoli commented Jan 30, 2025

View reviewed changes

lantoli added 5 commits January 30, 2025 14:12

extract consts

db532d0

adjust doc

1c24a51

refactor PreRun so argument required checks can happen first

6fcce27

add scaffolding for convert command adv_cluster v1 to v2

e4debf7

adjust doc

6d78692

update usage doc

b3e869d

lantoli requested a review from a team January 30, 2025 15:05

typo

3055a72

carriecwk approved these changes Jan 30, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

2e0603c

Co-authored-by: carriecwk <[email protected]>

lantoli merged commit af30720 into main Jan 30, 2025
6 checks passed

lantoli deleted the CLOUDP-295406_test_commands branch January 30, 2025 20:02

	Long: "Upgrade Terraform config from mongodbatlas_cluster to mongodbatlas_advanced_cluster",
	Long: "Converts a Terraform configuration from mongodbatlas_cluster to mongodbatlas_advanced_cluster",

chore: Create plugin command with test infra #12

chore: Create plugin command with test infra #12

Uh oh!

Conversation

lantoli commented Jan 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change:

Required Checklist:

Further comments

Uh oh!

github-actions bot commented Jan 28, 2025

Uh oh!

lantoli Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lantoli Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lantoli Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lantoli Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

EspenAlbert left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lantoli Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

carriecwk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lantoli commented Jan 22, 2025 •

edited

Loading

lantoli Jan 30, 2025 •

edited

Loading

lantoli Jan 30, 2025 •

edited

Loading

lantoli Jan 30, 2025 •

edited

Loading

lantoli Jan 30, 2025 •

edited

Loading

lantoli Jan 30, 2025 •

edited

Loading