Add connectedOrgConfigs list command (#2892)

Author: blva

docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt

@@ -0,0 +1,86 @@
+.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list:
+
+=========================================================================
+atlas federatedAuthentication federationSettings connectedOrgConfigs list
+=========================================================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Describe a Connected Org Config.
+
+Syntax
+------
+
+.. code-block::
+   :caption: Command Syntax
+
+   atlas federatedAuthentication federationSettings connectedOrgConfigs list [options]
+
+.. Code end marker, please don't delete this comment
+
+Options
+-------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - --federationSettingsId
+     - string
+     - true
+     - Unique identifier of the federation settings.
+   * - -h, --help
+     - 
+     - false
+     - help for list
+   * - --limit
+     - int
+     - false
+     - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100.
+   * - --orgId
+     - string
+     - false
+     - Organization ID to use. This option overrides the settings in the configuration file or environment variable.
+   * - -o, --output
+     - string
+     - false
+     - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
+   * - --page
+     - int
+     - false
+     - Page number that specifies a page of results. This value defaults to 1.
+
+Inherited Options
+-----------------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - -P, --profile
+     - string
+     - false
+     - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
+
+Examples
+--------
+
+.. code-block::
+
+   # List all connected org config with federationSettingsId 5d1113b25a115342acc2d1aa 
+   atlas federatedAuthentication connectedOrgsConfig list --federationSettingsId 5d1113b25a115342acc2d1aa 
+

docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt

@@ -53,6 +53,7 @@ Related Commands
 * :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete` - Delete a connected org config Organization.
 * :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe` - Describe a Connected Org Config.
 * :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect` - Connect an Identity Provider to an Organization.
+* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list` - Describe a Connected Org Config.
 * :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update` - Update One Org Config Connected to One Federation Setting.
 
 
@@ -63,5 +64,6 @@ Related Commands
    delete </command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete>
    describe </command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe>
    disconnect </command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect>
+   list </command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list>
    update </command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update>
 

internal/cli/federatedauthentication/federationsettings/connectedorgsconfigs/connected_orgs_configs.go

@@ -30,6 +30,7 @@ func Builder() *cobra.Command {
 		ConnectBuilder(),
 		DisconnectBuilder(),
 		DescribeBuilder(),
+		ListBuilder(),
 		DeleteBuilder(),
 		UpdateBuilder(),
 	)

internal/cli/federatedauthentication/federationsettings/connectedorgsconfigs/list.go

@@ -0,0 +1,102 @@
+// Copyright 2024 MongoDB Inc
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package connectedorgsconfigs
+
+import (
+	"context"
+
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli"
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/config"
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/flag"
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/store"
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/usage"
+	"github.com/spf13/cobra"
+	atlasv2 "go.mongodb.org/atlas-sdk/v20231115013/admin"
+)
+
+type ListOpts struct {
+	cli.GlobalOpts
+	cli.OutputOpts
+	cli.InputOpts
+	cli.ListOpts
+	store store.ConnectedOrgConfigsLister
+
+	federationSettingsID string
+}
+
+const listTemplate = `ORG ID	IDENTITY PROVIDER ID	DATA ACCESS IDENTITY PRODIVER IDs{{range valueOrEmptySlice .Results}}
+{{.OrgId}}	{{if .IdentityProviderId }}	{{ .IdentityProviderId }}{{else}}N/A{{end}}	{{if and .DataAccessIdentityProviderIds (gt (len .DataAccessIdentityProviderIds) 0)}}{{range $index, $element := .DataAccessIdentityProviderIds}}{{if $index}}, {{end}}{{$element}}{{end}}{{else}}N/A{{end}}{{end}}`
+
+func (opts *ListOpts) Run() error {
+	params := &atlasv2.ListConnectedOrgConfigsApiParams{
+		FederationSettingsId: opts.federationSettingsID,
+		ItemsPerPage:         &opts.ItemsPerPage,
+		PageNum:              &opts.PageNum,
+	}
+
+	r, err := opts.store.ListConnectedOrgConfigs(params)
+	if err != nil {
+		return err
+	}
+
+	return opts.Print(r)
+}
+
+func (opts *ListOpts) InitStore(ctx context.Context) func() error {
+	return func() error {
+		if opts.store != nil {
+			return nil
+		}
+
+		var err error
+		opts.store, err = store.New(store.AuthenticatedPreset(config.Default()), store.WithContext(ctx))
+		return err
+	}
+}
+
+// atlas federatedAuthentication connectedOrgsConfig list --federationSettingsId federationSettingsId [-o/--output output].
+func ListBuilder() *cobra.Command {
+	opts := new(ListOpts)
+	cmd := &cobra.Command{
+		Use:   "list",
+		Short: "Describe a Connected Org Config.",
+		Args:  cobra.NoArgs,
+		Example: `  # List all connected org config with federationSettingsId 5d1113b25a115342acc2d1aa 
+  atlas federatedAuthentication connectedOrgsConfig list --federationSettingsId 5d1113b25a115342acc2d1aa 
+`,
+		PreRunE: func(cmd *cobra.Command, _ []string) error {
+			return opts.PreRunE(
+				opts.ValidateOrgID,
+				opts.InitStore(cmd.Context()),
+				opts.InitOutput(cmd.OutOrStdout(), listTemplate),
+			)
+		},
+		RunE: func(_ *cobra.Command, _ []string) error {
+			return opts.Run()
+		},
+	}
+
+	cmd.Flags().StringVar(&opts.federationSettingsID, flag.FederationSettingsID, "", usage.FederationSettingsID)
+	cmd.Flags().StringVar(&opts.OrgID, flag.OrgID, "", usage.OrgID)
+	cmd.Flags().IntVar(&opts.PageNum, flag.Page, cli.DefaultPage, usage.Page)
+	cmd.Flags().IntVar(&opts.ItemsPerPage, flag.Limit, cli.DefaultPageLimit, usage.Limit)
+
+	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)
+	_ = cmd.RegisterFlagCompletionFunc(flag.Output, opts.AutoCompleteOutputFlag())
+
+	_ = cmd.MarkFlagRequired(flag.FederationSettingsID)
+
+	return cmd
+}

internal/cli/federatedauthentication/federationsettings/connectedorgsconfigs/list_test.go

@@ -0,0 +1,74 @@
+// Copyright 2024 MongoDB Inc
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//go:build unit
+
+package connectedorgsconfigs
+
+import (
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli"
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/flag"
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/mocks"
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/test"
+	atlasv2 "go.mongodb.org/atlas-sdk/v20231115013/admin"
+)
+
+func TestList_Run(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	listStore := mocks.NewMockConnectedOrgConfigsLister(ctrl)
+
+	listOpts := &ListOpts{
+		federationSettingsID: "federationSettingsID",
+		store:                listStore,
+		OutputOpts: cli.OutputOpts{
+			Template: listTemplate,
+		},
+		ListOpts: cli.ListOpts{},
+	}
+
+	idpID := "id"
+	expected := &atlasv2.PaginatedConnectedOrgConfigs{
+		Results: &[]atlasv2.ConnectedOrgConfig{
+			{
+				OrgId:                         "id",
+				IdentityProviderId:            &idpID,
+				DataAccessIdentityProviderIds: &[]string{"id", "id2"},
+			},
+		},
+	}
+
+	listStore.
+		EXPECT().
+		ListConnectedOrgConfigs(gomock.Any()).
+		Return(expected, nil).
+		Times(1)
+
+	if err := listOpts.Run(); err != nil {
+		t.Fatalf("Run() unexpected error: %v", err)
+	}
+
+	test.VerifyOutputTemplate(t, listTemplate, expected)
+}
+
+func TestListBuilder(t *testing.T) {
+	test.CmdValidator(
+		t,
+		ListBuilder(),
+		0,
+		[]string{flag.Output, flag.FederationSettingsID, flag.OrgID, flag.Page, flag.Limit},
+	)
+}

internal/mocks/mock_connected_orgs_store.go

@@ -18,7 +18,7 @@ import (
 	atlasv2 "go.mongodb.org/atlas-sdk/v20231115013/admin"
 )
 
-//go:generate mockgen -destination=../mocks/mock_connected_orgs_store.go -package=mocks github.com/mongodb/mongodb-atlas-cli/atlascli/internal/store ConnectedOrgConfigsUpdater,ConnectedOrgConfigsDescriber,ConnectedOrgConfigsDeleter
+//go:generate mockgen -destination=../mocks/mock_connected_orgs_store.go -package=mocks github.com/mongodb/mongodb-atlas-cli/atlascli/internal/store ConnectedOrgConfigsUpdater,ConnectedOrgConfigsDescriber,ConnectedOrgConfigsDeleter,ConnectedOrgConfigsLister
 
 type ConnectedOrgConfigsUpdater interface {
 	UpdateConnectedOrgConfig(opts *atlasv2.UpdateConnectedOrgConfigApiParams) (*atlasv2.ConnectedOrgConfig, error)
@@ -28,6 +28,9 @@ type ConnectedOrgConfigsDescriber interface {
 	GetConnectedOrgConfig(opts *atlasv2.GetConnectedOrgConfigApiParams) (*atlasv2.ConnectedOrgConfig, error)
 }
 
+type ConnectedOrgConfigsLister interface {
+	ListConnectedOrgConfigs(opts *atlasv2.ListConnectedOrgConfigsApiParams) (*atlasv2.PaginatedConnectedOrgConfigs, error)
+}
 type ConnectedOrgConfigsDeleter interface {
 	DeleteConnectedOrgConfig(federationSettingsID string, orgID string) error
 }
@@ -44,6 +47,12 @@ func (s *Store) GetConnectedOrgConfig(opts *atlasv2.GetConnectedOrgConfigApiPara
 	return result, err
 }
 
+// ListConnectedOrgConfigs encapsulate the logic to manage different cloud providers.
+func (s *Store) ListConnectedOrgConfigs(opts *atlasv2.ListConnectedOrgConfigsApiParams) (*atlasv2.PaginatedConnectedOrgConfigs, error) {
+	result, _, err := s.clientv2.FederatedAuthenticationApi.ListConnectedOrgConfigsWithParams(s.ctx, opts).Execute()
+	return result, err
+}
+
 // DeleteConnectedOrgConfig encapsulate the logic to manage different cloud providers.
 func (s *Store) DeleteConnectedOrgConfig(federationSettingsID string, orgID string) error {
 	_, _, err := s.clientv2.FederatedAuthenticationApi.RemoveConnectedOrgConfig(s.ctx, federationSettingsID, orgID).Execute()

internal/store/connected_org_configs.go

@@ -397,6 +397,30 @@ func TestIdentityProviders(t *testing.T) {
 		req.NoError(json.Unmarshal(resp, &provider))
 	})
 
+	t.Run("List connectedOrgsConfig", func(t *testing.T) {
+		cmd := exec.Command(cliPath,
+			federatedAuthenticationEntity,
+			federationSettingsEntity,
+			connectedOrgsConfigsEntity,
+			"list",
+			"--federationSettingsId",
+			federationSettingsID,
+			"-o=json",
+		)
+
+		cmd.Env = os.Environ()
+		resp, err := cmd.CombinedOutput()
+		req.NoError(err, string(resp))
+
+		var config atlasv2.PaginatedConnectedOrgConfigs
+		req.NoError(json.Unmarshal(resp, &config))
+
+		assert.NotEmpty(t, config.GetResults())
+		assert.Len(t, config.GetResults(), 1)
+		assert.NotContains(t, config.GetResults()[0].GetDataAccessIdentityProviderIds(), oidcIWorkforceIdpID)
+		assert.NotContains(t, config.GetResults()[0].GetDataAccessIdentityProviderIds(), oidcWorkloadIdpID)
+	})
+
 	t.Run("Describe OIDC IdP WORKFORCE", func(t *testing.T) {
 		cmd := exec.Command(cliPath,
 			federatedAuthenticationEntity,