CLOUDP-230402: Implemented project tagging (#2666)

Author: jeroenvervaeke

docs/atlascli/command/atlas-projects-create.txt

@@ -75,6 +75,10 @@ Options
      - string
      - false
      - Unique 24-digit string that identifies the Atlas user to be granted the Project Owner role on the specified project. If unspecified, this value defaults to the user ID of the oldest Organization Owner.
+   * - --tag
+     - stringToString
+     - false
+     - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. This value defaults to [].
    * - --withoutDefaultAlertSettings
      - 
      - false

internal/cli/atlas/projects/create.go

@@ -17,11 +17,13 @@ package projects
 import (
 	"context"
 	"fmt"
+	"sort"
 
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli"
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli/require"
 	"github.com/mongodb/mongodb-atlas-cli/internal/config"
 	"github.com/mongodb/mongodb-atlas-cli/internal/flag"
+	"github.com/mongodb/mongodb-atlas-cli/internal/pointer"
 	store "github.com/mongodb/mongodb-atlas-cli/internal/store/atlas"
 	"github.com/mongodb/mongodb-atlas-cli/internal/usage"
 	"github.com/spf13/cobra"
@@ -37,6 +39,7 @@ type CreateOpts struct {
 	projectOwnerID              string
 	regionUsageRestrictions     bool
 	withoutDefaultAlertSettings bool
+	tag                         map[string]string
 	store                       store.ProjectCreator
 }
 
@@ -57,12 +60,42 @@ func (opts *CreateOpts) Run() error {
 	return opts.Print(r)
 }
 
+func (opts *CreateOpts) newCreateProjectGroupTags() *[]atlasv2.ResourceTag {
+	if len(opts.tag) == 0 {
+		return nil
+	}
+
+	tags := make([]atlasv2.ResourceTag, 0)
+
+	keys := make([]string, 0)
+	for k := range opts.tag {
+		keys = append(keys, k)
+	}
+	sort.Strings(keys)
+
+	for _, key := range keys {
+		value := opts.tag[key]
+		if key == "" || value == "" {
+			continue
+		}
+
+		resourceTag := *atlasv2.NewResourceTag()
+		resourceTag.Key = pointer.Get(key)
+		resourceTag.Value = pointer.Get(value)
+
+		tags = append(tags, resourceTag)
+	}
+
+	return &tags
+}
+
 func (opts *CreateOpts) newCreateProjectGroup() *atlasv2.Group {
 	return &atlasv2.Group{
 		Name:                      opts.name,
 		OrgId:                     opts.ConfigOrgID(),
 		WithDefaultAlertsSettings: opts.defaultAlertSettings(),
 		RegionUsageRestrictions:   opts.newRegionUsageRestrictions(),
+		Tags:                      opts.newCreateProjectGroupTags(),
 	}
 }
 
@@ -123,6 +156,7 @@ func CreateBuilder() *cobra.Command {
 	cmd.Flags().StringVar(&opts.projectOwnerID, flag.OwnerID, "", usage.ProjectOwnerID)
 	cmd.Flags().BoolVar(&opts.regionUsageRestrictions, flag.GovCloudRegionsOnly, false, usage.GovCloudRegionsOnly)
 	cmd.Flags().BoolVar(&opts.withoutDefaultAlertSettings, flag.WithoutDefaultAlertSettings, false, usage.WithoutDefaultAlertSettings)
+	cmd.Flags().StringToStringVar(&opts.tag, flag.Tag, nil, usage.ProjectTag)
 	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)
 	_ = cmd.RegisterFlagCompletionFunc(flag.Output, opts.AutoCompleteOutputFlag())
 

internal/cli/atlas/projects/create_test.go

@@ -22,6 +22,7 @@ import (
 	"github.com/golang/mock/gomock"
 	"github.com/mongodb/mongodb-atlas-cli/internal/flag"
 	mocks "github.com/mongodb/mongodb-atlas-cli/internal/mocks/atlas"
+	"github.com/mongodb/mongodb-atlas-cli/internal/pointer"
 	"github.com/mongodb/mongodb-atlas-cli/internal/test"
 	atlasv2 "go.mongodb.org/atlas-sdk/v20231115007/admin"
 )
@@ -31,11 +32,20 @@ func TestCreate_Run(t *testing.T) {
 	mockStore := mocks.NewMockProjectCreator(ctrl)
 
 	opts := CreateOpts{}
-	expected := &atlasv2.Group{}
+	expected := &atlasv2.Group{
+		Tags: &[]atlasv2.ResourceTag{
+			{Key: pointer.Get("environment"), Value: pointer.Get("unit-testing")},
+			{Key: pointer.Get("production"), Value: pointer.Get("false")},
+		},
+	}
 
 	createOpts := &CreateOpts{
 		store: mockStore,
 		name:  "ProjectBar",
+		tag: map[string]string{
+			"environment": "unit-testing",
+			"production":  "false",
+		},
 	}
 	createOpts.OrgID = "5a0a1e7e0f2912c554080adc"
 	params := &atlasv2.CreateProjectApiParams{

internal/usage/usage.go

@@ -450,6 +450,7 @@ dbName and collection are required only for built-in roles.`
 	CompletedAfter                            = "Date filter for when the backup snapshots were completed. You must use the YYYY-MM-DD format."
 	Tag                                       = "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster."
 	DeploymentTag                             = "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the deployment."
+	ProjectTag                                = "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project."
 	ServerlessTag                             = "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance."
 	UpdateWarning                             = " Passing this flag replaces preexisting data."
 	EnableWatch                               = "Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option."

test/e2e/iam/atlas_projects_test.go

@@ -47,6 +47,8 @@ func TestAtlasProjects(t *testing.T) {
 			projectsEntity,
 			"create",
 			projectName,
+			"--tag", "env=e2e",
+			"--tag", "prod=false",
 			"-o=json")
 		cmd.Env = os.Environ()
 		resp, err := cmd.CombinedOutput()
@@ -84,6 +86,33 @@ func TestAtlasProjects(t *testing.T) {
 		require.NoError(t, err, string(resp))
 	})
 
+	t.Run("Tags", func(t *testing.T) {
+		cmd := exec.Command(cliPath,
+			projectsEntity,
+			"describe",
+			projectID,
+			"-o=json")
+		cmd.Env = os.Environ()
+		resp, err := cmd.CombinedOutput()
+		require.NoError(t, err, string(resp))
+		var project admin.Group
+		if err := json.Unmarshal(resp, &project); err != nil {
+			t.Fatalf("unexpected error: %v", err)
+		}
+
+		require.Len(t, project.GetTags(), 2)
+
+		expectedTags := map[string]string{"env": "e2e", "prod": "false"}
+		for _, tag := range project.GetTags() {
+			expectedValue, ok := expectedTags[tag.GetKey()]
+			if !ok {
+				t.Errorf("unexpected tag key %s in tags: %v, expected tags: %v\n", tag.GetKey(), project.Tags, expectedTags)
+			}
+
+			require.Equal(t, expectedValue, tag.GetValue())
+		}
+	})
+
 	t.Run("Users", func(t *testing.T) {
 		cmd := exec.Command(cliPath,
 			projectsEntity,