CLOUDP-222791: expose "include total" on paginated commands - Part 2 (#…

…2754)
mongodb · Mar 12, 2024 · 45109b4 · 45109b4
1 parent 53f3f6b
commit 45109b4
Show file tree

Hide file tree

Showing 52 changed files with 207 additions and 35 deletions.
diff --git a/docs/command/atlas-organizations-apiKeys-accessLists-list.txt b/docs/command/atlas-organizations-apiKeys-accessLists-list.txt
@@ -63,6 +63,10 @@ Options
      - 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.
+   * - --omitCount
+     - 
+     - false
+     - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.
    * - --orgId
      - string
      - false

diff --git a/docs/command/atlas-organizations-apiKeys-list.txt b/docs/command/atlas-organizations-apiKeys-list.txt
@@ -49,6 +49,10 @@ Options
      - 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.
+   * - --omitCount
+     - 
+     - false
+     - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.
    * - --orgId
      - string
      - false

diff --git a/docs/command/atlas-organizations-list.txt b/docs/command/atlas-organizations-list.txt
@@ -53,6 +53,10 @@ Options
      - string
      - false
      - Organization name to perform a case-insensitive search for.
+   * - --omitCount
+     - 
+     - false
+     - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.
    * - -o, --output
      - string
      - false

diff --git a/docs/command/atlas-organizations-users-list.txt b/docs/command/atlas-organizations-users-list.txt
@@ -45,6 +45,10 @@ Options
      - 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.
+   * - --omitCount
+     - 
+     - false
+     - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.
    * - --orgId
      - string
      - false

diff --git a/docs/command/atlas-processes-list.txt b/docs/command/atlas-processes-list.txt
@@ -49,6 +49,10 @@ Options
      - 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.
+   * - --omitCount
+     - 
+     - false
+     - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.
    * - -o, --output
      - string
      - false

diff --git a/docs/command/atlas-projects-apiKeys-list.txt b/docs/command/atlas-projects-apiKeys-list.txt
@@ -49,6 +49,10 @@ Options
      - 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.
+   * - --omitCount
+     - 
+     - false
+     - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.
    * - -o, --output
      - string
      - false

diff --git a/docs/command/atlas-projects-list.txt b/docs/command/atlas-projects-list.txt
@@ -45,6 +45,10 @@ Options
      - 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.
+   * - --omitCount
+     - 
+     - false
+     - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.
    * - --orgId
      - string
      - false

diff --git a/docs/command/atlas-projects-teams-list.txt b/docs/command/atlas-projects-teams-list.txt
@@ -45,6 +45,10 @@ Options
      - 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.
+   * - --omitCount
+     - 
+     - false
+     - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.
    * - -o, --output
      - string
      - false

diff --git a/docs/command/atlas-projects-users-list.txt b/docs/command/atlas-projects-users-list.txt
@@ -49,6 +49,10 @@ Options
      - 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.
+   * - --omitCount
+     - 
+     - false
+     - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.
    * - -o, --output
      - string
      - false

diff --git a/docs/command/atlas-serverless-backups-restores-list.txt b/docs/command/atlas-serverless-backups-restores-list.txt
@@ -61,6 +61,10 @@ Options
      - 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.
+   * - --omitCount
+     - 
+     - false
+     - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.
    * - -o, --output
      - string
      - false

diff --git a/docs/command/atlas-serverless-backups-snapshots-list.txt b/docs/command/atlas-serverless-backups-snapshots-list.txt
@@ -61,6 +61,10 @@ Options
      - 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.
+   * - --omitCount
+     - 
+     - false
+     - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.
    * - -o, --output
      - string
      - false

diff --git a/docs/command/atlas-serverless-list.txt b/docs/command/atlas-serverless-list.txt
@@ -45,6 +45,10 @@ Options
      - 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.
+   * - --omitCount
+     - 
+     - false
+     - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.
    * - -o, --output
      - string
      - false

diff --git a/docs/command/atlas-teams-list.txt b/docs/command/atlas-teams-list.txt
@@ -49,6 +49,10 @@ Options
      - 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.
+   * - --omitCount
+     - 
+     - false
+     - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.
    * - --orgId
      - string
      - false

diff --git a/internal/cli/atlas/organizations/apikeys/accesslists/list.go b/internal/cli/atlas/organizations/apikeys/accesslists/list.go
@@ -56,6 +56,7 @@ func (opts *ListOpts) Run() error {
 		ApiUserId:    opts.id,
 		PageNum:      pointer.Get(listOpts.PageNum),
 		ItemsPerPage: pointer.Get(listOpts.ItemsPerPage),
+		IncludeCount: pointer.Get(listOpts.IncludeCount),
 	}
 	result, err := opts.store.OrganizationAPIKeyAccessLists(params)
 	if err != nil {
@@ -95,6 +96,7 @@ func ListBuilder() *cobra.Command {
 
 	cmd.Flags().IntVar(&opts.PageNum, flag.Page, cli.DefaultPage, usage.Page)
 	cmd.Flags().IntVar(&opts.ItemsPerPage, flag.Limit, cli.DefaultPageLimit, usage.Limit)
+	cmd.Flags().BoolVar(&opts.OmitCount, flag.OmitCount, false, usage.OmitCount)
 
 	cmd.Flags().StringVar(&opts.OrgID, flag.OrgID, "", usage.OrgID)
 	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)

diff --git a/internal/cli/atlas/organizations/apikeys/accesslists/list_test.go b/internal/cli/atlas/organizations/apikeys/accesslists/list_test.go
@@ -41,6 +41,7 @@ func TestListOpts_Run(t *testing.T) {
 		ApiUserId:    opts.id,
 		PageNum:      pointer.Get(listOpts.PageNum),
 		ItemsPerPage: pointer.Get(listOpts.ItemsPerPage),
+		IncludeCount: pointer.Get(listOpts.IncludeCount),
 	}
 	expected := admin.PaginatedApiUserAccessList{
 		Results: &[]admin.UserAccessList{},
@@ -62,6 +63,6 @@ func TestListBuilder(t *testing.T) {
 		t,
 		ListBuilder(),
 		0,
-		[]string{flag.OrgID, flag.Output, flag.Page, flag.Limit},
+		[]string{flag.OrgID, flag.Output, flag.Page, flag.Limit, flag.OmitCount},
 	)
 }
diff --git a/internal/cli/atlas/organizations/apikeys/list.go b/internal/cli/atlas/organizations/apikeys/list.go
@@ -86,6 +86,7 @@ func ListBuilder() *cobra.Command {
 
 	cmd.Flags().IntVar(&opts.PageNum, flag.Page, cli.DefaultPage, usage.Page)
 	cmd.Flags().IntVar(&opts.ItemsPerPage, flag.Limit, cli.DefaultPageLimit, usage.Limit)
+	cmd.Flags().BoolVar(&opts.OmitCount, flag.OmitCount, false, usage.OmitCount)
 
 	cmd.Flags().StringVar(&opts.OrgID, flag.OrgID, "", usage.OrgID)
 	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)

diff --git a/internal/cli/atlas/organizations/apikeys/list_test.go b/internal/cli/atlas/organizations/apikeys/list_test.go
@@ -20,6 +20,7 @@ import (
 	"testing"
 
 	"github.com/golang/mock/gomock"
+	"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/v20231115007/admin"
@@ -46,3 +47,12 @@ func TestListOpts_Run(t *testing.T) {
 	}
 	test.VerifyOutputTemplate(t, listTemplate, expected)
 }
+
+func TestListBuilder(t *testing.T) {
+	test.CmdValidator(
+		t,
+		ListBuilder(),
+		0,
+		[]string{flag.Page, flag.Limit, flag.OmitCount, flag.OrgID, flag.Output, flag.CompactResponse},
+	)
+}
diff --git a/internal/cli/atlas/organizations/list.go b/internal/cli/atlas/organizations/list.go
@@ -64,6 +64,7 @@ func (opts *ListOpts) newOrganizationListOptions() *atlasv2.ListOrganizationsApi
 	if listOpt := opts.NewListOptions(); listOpt != nil {
 		params.PageNum = &listOpt.PageNum
 		params.ItemsPerPage = &listOpt.ItemsPerPage
+		params.IncludeCount = &listOpt.IncludeCount
 	}
 	return params
 }
@@ -96,11 +97,12 @@ func ListBuilder() *cobra.Command {
 		},
 	}
 
-	cmd.Flags().StringVar(&opts.name, flag.Name, "", usage.OrgNameFilter)
-	cmd.Flags().BoolVar(&opts.includeDeletedOrgs, flag.IncludeDeleted, false, usage.OrgIncludeDeleted)
-
 	cmd.Flags().IntVar(&opts.PageNum, flag.Page, cli.DefaultPage, usage.Page)
 	cmd.Flags().IntVar(&opts.ItemsPerPage, flag.Limit, cli.DefaultPageLimit, usage.Limit)
+	cmd.Flags().BoolVar(&opts.OmitCount, flag.OmitCount, false, usage.OmitCount)
+
+	cmd.Flags().StringVar(&opts.name, flag.Name, "", usage.OrgNameFilter)
+	cmd.Flags().BoolVar(&opts.includeDeletedOrgs, flag.IncludeDeleted, false, usage.OrgIncludeDeleted)
 
 	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)
 	_ = cmd.RegisterFlagCompletionFunc(flag.Output, opts.AutoCompleteOutputFlag())

diff --git a/internal/cli/atlas/organizations/list_test.go b/internal/cli/atlas/organizations/list_test.go
@@ -20,6 +20,7 @@ import (
 	"testing"
 
 	"github.com/golang/mock/gomock"
+	"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/v20231115007/admin"
@@ -44,3 +45,12 @@ func TestList_Run(t *testing.T) {
 	}
 	test.VerifyOutputTemplate(t, listTemplate, expected)
 }
+
+func TestListBuilder(t *testing.T) {
+	test.CmdValidator(
+		t,
+		ListBuilder(),
+		0,
+		[]string{flag.Page, flag.Limit, flag.OmitCount, flag.IncludeDeleted, flag.Output, flag.Name},
+	)
+}
diff --git a/internal/cli/atlas/organizations/users/list.go b/internal/cli/atlas/organizations/users/list.go
@@ -87,6 +87,7 @@ func ListBuilder() *cobra.Command {
 
 	cmd.Flags().IntVar(&opts.PageNum, flag.Page, cli.DefaultPage, usage.Page)
 	cmd.Flags().IntVar(&opts.ItemsPerPage, flag.Limit, cli.DefaultPageLimit, usage.Limit)
+	cmd.Flags().BoolVar(&opts.OmitCount, flag.OmitCount, false, usage.OmitCount)
 
 	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)
 	_ = cmd.RegisterFlagCompletionFunc(flag.Output, opts.AutoCompleteOutputFlag())

diff --git a/internal/cli/atlas/organizations/users/list_test.go b/internal/cli/atlas/organizations/users/list_test.go
@@ -69,6 +69,7 @@ func TestListBuilder(t *testing.T) {
 			flag.Limit,
 			flag.Output,
 			flag.OrgID,
+			flag.OmitCount,
 		},
 	)
 }

diff --git a/internal/cli/atlas/privateendpoints/datalake/aws/list.go b/internal/cli/atlas/privateendpoints/datalake/aws/list.go
@@ -63,6 +63,7 @@ func (opts *ListOpts) newDatalakePrivateEndpointsListOpts() *atlasv2.ListDataFed
 		GroupId:      opts.ConfigProjectID(),
 		PageNum:      pointer.Get(opts.PageNum),
 		ItemsPerPage: pointer.Get(opts.ItemsPerPage),
+		IncludeCount: pointer.Get(!opts.OmitCount),
 	}
 }
 
@@ -93,6 +94,7 @@ func ListBuilder() *cobra.Command {
 
 	cmd.Flags().IntVar(&opts.PageNum, flag.Page, cli.DefaultPage, usage.Page)
 	cmd.Flags().IntVar(&opts.ItemsPerPage, flag.Limit, cli.DefaultPageLimit, usage.Limit)
+	cmd.Flags().BoolVar(&opts.OmitCount, flag.OmitCount, false, usage.OmitCount)
 
 	cmd.Flags().StringVar(&opts.ProjectID, flag.ProjectID, "", usage.ProjectID)
 	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)

diff --git a/internal/cli/atlas/privateendpoints/datalake/aws/list_test.go b/internal/cli/atlas/privateendpoints/datalake/aws/list_test.go
@@ -52,6 +52,6 @@ func TestListBuilder(t *testing.T) {
 		t,
 		ListBuilder(),
 		0,
-		[]string{flag.ProjectID, flag.Output},
+		[]string{flag.ProjectID, flag.Output, flag.OmitCount, flag.Page, flag.Limit},
 	)
 }
diff --git a/internal/cli/atlas/processes/list.go b/internal/cli/atlas/processes/list.go
@@ -73,6 +73,10 @@ func (opts *ListOpts) newProcessesListParams() *atlasv2.ListAtlasProcessesApiPar
 	if listOpts.ItemsPerPage > 0 {
 		processesList.ItemsPerPage = &listOpts.ItemsPerPage
 	}
+
+	if listOpts.IncludeCount {
+		processesList.IncludeCount = &listOpts.IncludeCount
+	}
 	return processesList
 }
 
@@ -101,6 +105,7 @@ func ListBuilder() *cobra.Command {
 
 	cmd.Flags().IntVar(&opts.PageNum, flag.Page, cli.DefaultPage, usage.Page)
 	cmd.Flags().IntVar(&opts.ItemsPerPage, flag.Limit, cli.DefaultPageLimit, usage.Limit)
+	cmd.Flags().BoolVar(&opts.OmitCount, flag.OmitCount, false, usage.OmitCount)
 
 	cmd.Flags().StringVar(&opts.ProjectID, flag.ProjectID, "", usage.ProjectID)
 	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)

diff --git a/internal/cli/atlas/processes/list_test.go b/internal/cli/atlas/processes/list_test.go
@@ -42,7 +42,9 @@ func TestList_Run(t *testing.T) {
 	listOpts := &ListOpts{
 		store: mockStore,
 	}
-	params := atlasv2.ListAtlasProcessesApiParams{}
+	params := atlasv2.ListAtlasProcessesApiParams{
+		IncludeCount: pointer.Get(true),
+	}
 
 	mockStore.
 		EXPECT().
@@ -61,6 +63,6 @@ func TestListBuilder(t *testing.T) {
 		t,
 		ListBuilder(),
 		0,
-		[]string{flag.ProjectID, flag.Output, flag.Page, flag.Limit},
+		[]string{flag.ProjectID, flag.Output, flag.Page, flag.Limit, flag.OmitCount},
 	)
 }
diff --git a/internal/cli/atlas/projects/apikeys/list.go b/internal/cli/atlas/projects/apikeys/list.go
@@ -87,6 +87,7 @@ func ListBuilder() *cobra.Command {
 
 	cmd.Flags().IntVar(&opts.PageNum, flag.Page, cli.DefaultPage, usage.Page)
 	cmd.Flags().IntVar(&opts.ItemsPerPage, flag.Limit, cli.DefaultPageLimit, usage.Limit)
+	cmd.Flags().BoolVar(&opts.OmitCount, flag.OmitCount, false, usage.OmitCount)
 
 	cmd.Flags().StringVar(&opts.ProjectID, flag.ProjectID, "", usage.ProjectID)
 	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)

diff --git a/internal/cli/atlas/projects/apikeys/list_test.go b/internal/cli/atlas/projects/apikeys/list_test.go
@@ -20,6 +20,7 @@ import (
 	"testing"
 
 	"github.com/golang/mock/gomock"
+	"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/pointer"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/test"
@@ -53,3 +54,12 @@ func TestList_Run(t *testing.T) {
 	}
 	test.VerifyOutputTemplate(t, listTemplate, expected)
 }
+
+func TestListBuilder(t *testing.T) {
+	test.CmdValidator(
+		t,
+		ListBuilder(),
+		0,
+		[]string{flag.Page, flag.Limit, flag.OmitCount, flag.ProjectID, flag.Output, flag.CompactResponse},
+	)
+}
diff --git a/internal/cli/atlas/projects/list.go b/internal/cli/atlas/projects/list.go
@@ -87,6 +87,7 @@ func ListBuilder() *cobra.Command {
 
 	cmd.Flags().IntVar(&opts.PageNum, flag.Page, cli.DefaultPage, usage.Page)
 	cmd.Flags().IntVar(&opts.ItemsPerPage, flag.Limit, cli.DefaultPageLimit, usage.Limit)
+	cmd.Flags().BoolVar(&opts.OmitCount, flag.OmitCount, false, usage.OmitCount)
 
 	cmd.Flags().StringVar(&opts.OrgID, flag.OrgID, "", usage.OrgID)
 	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)

diff --git a/internal/cli/atlas/projects/list_test.go b/internal/cli/atlas/projects/list_test.go
@@ -20,7 +20,9 @@ import (
 	"testing"
 
 	"github.com/golang/mock/gomock"
+	"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"
 	"github.com/stretchr/testify/require"
 	atlasv2 "go.mongodb.org/atlas-sdk/v20231115007/admin"
 )
@@ -54,3 +56,12 @@ func TestList_Run(t *testing.T) {
 		require.NoError(t, listOpts.Run())
 	})
 }
+
+func TestListBuilder(t *testing.T) {
+	test.CmdValidator(
+		t,
+		ListBuilder(),
+		0,
+		[]string{flag.Page, flag.Limit, flag.OmitCount, flag.OrgID, flag.Output},
+	)
+}