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

…2749)
mongodb · Mar 11, 2024 · 83e3044 · 83e3044
1 parent 3e9e7b7
commit 83e3044
Show file tree

Hide file tree

Showing 53 changed files with 160 additions and 19 deletions.
diff --git a/docs/command/atlas-accessLists-list.txt b/docs/command/atlas-accessLists-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-alerts-list.txt b/docs/command/atlas-alerts-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-backups-exports-buckets-list.txt b/docs/command/atlas-backups-exports-buckets-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-backups-exports-jobs-list.txt b/docs/command/atlas-backups-exports-jobs-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-backups-restores-list.txt b/docs/command/atlas-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-backups-snapshots-list.txt b/docs/command/atlas-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-clusters-list.txt b/docs/command/atlas-clusters-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-clusters-onlineArchives-list.txt b/docs/command/atlas-clusters-onlineArchives-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-dataLakePipelines-availableSnapshots-list.txt b/docs/command/atlas-dataLakePipelines-availableSnapshots-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-dbusers-list.txt b/docs/command/atlas-dbusers-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-metrics-databases-list.txt b/docs/command/atlas-metrics-databases-list.txt
@@ -64,6 +64,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-metrics-disks-list.txt b/docs/command/atlas-metrics-disks-list.txt
@@ -64,6 +64,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-networking-containers-list.txt b/docs/command/atlas-networking-containers-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-networking-peering-list.txt b/docs/command/atlas-networking-peering-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/internal/cli/atlas/accesslists/list.go b/internal/cli/atlas/accesslists/list.go
@@ -82,6 +82,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/accesslists/list_test.go b/internal/cli/atlas/accesslists/list_test.go
@@ -82,6 +82,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/alerts/list.go b/internal/cli/atlas/alerts/list.go
@@ -22,6 +22,7 @@ import (
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli/require"
 	"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/pointer"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/store"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/usage"
 	"github.com/spf13/cobra"
@@ -54,6 +55,11 @@ func (opts *ListOpts) Run() error {
 		ItemsPerPage: &opts.ItemsPerPage,
 		PageNum:      &opts.PageNum,
 	}
+
+	if opts.OmitCount {
+		params.IncludeCount = pointer.Get(false)
+	}
+
 	if opts.status != "" {
 		params.Status = &opts.status
 	}
@@ -94,6 +100,8 @@ 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.status, flag.Status, "", usage.Status)
 	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/alerts/list_test.go b/internal/cli/atlas/alerts/list_test.go
@@ -4,7 +4,7 @@
 // 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
+//	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,
@@ -22,6 +22,7 @@ import (
 
 	"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/pointer"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/test"
@@ -75,3 +76,12 @@ func TestList_Run(t *testing.T) {
 	t.Log(buf.String())
 	test.VerifyOutputTemplate(t, listTemplate, expected)
 }
+
+func TestListBuilder(t *testing.T) {
+	test.CmdValidator(
+		t,
+		ListBuilder(),
+		0,
+		[]string{flag.ProjectID, flag.Output, flag.Page, flag.Limit, flag.OmitCount, flag.Status},
+	)
+}
diff --git a/internal/cli/atlas/backup/exports/buckets/list.go b/internal/cli/atlas/backup/exports/buckets/list.go
@@ -84,6 +84,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/backup/exports/buckets/list_test.go b/internal/cli/atlas/backup/exports/buckets/list_test.go
@@ -72,6 +72,7 @@ func TestListBuilder(t *testing.T) {
 			flag.Limit,
 			flag.ProjectID,
 			flag.Output,
+			flag.OmitCount,
 		},
 	)
 }
diff --git a/internal/cli/atlas/backup/exports/jobs/list.go b/internal/cli/atlas/backup/exports/jobs/list.go
@@ -88,6 +88,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/backup/exports/jobs/list_test.go b/internal/cli/atlas/backup/exports/jobs/list_test.go
@@ -57,6 +57,7 @@ func TestListBuilder(t *testing.T) {
 			flag.Limit,
 			flag.ProjectID,
 			flag.Output,
+			flag.OmitCount,
 		},
 	)
 }
diff --git a/internal/cli/atlas/backup/restores/list.go b/internal/cli/atlas/backup/restores/list.go
@@ -88,6 +88,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/backup/restores/list_test.go b/internal/cli/atlas/backup/restores/list_test.go
@@ -60,6 +60,7 @@ func TestListBuilder(t *testing.T) {
 			flag.Limit,
 			flag.ProjectID,
 			flag.Output,
+			flag.OmitCount,
 		},
 	)
 }
diff --git a/internal/cli/atlas/backup/snapshots/list.go b/internal/cli/atlas/backup/snapshots/list.go
@@ -88,6 +88,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/backup/snapshots/list_test.go b/internal/cli/atlas/backup/snapshots/list_test.go
@@ -22,6 +22,7 @@ import (
 
 	"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/pointer"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/test"
@@ -63,3 +64,18 @@ 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,
+		},
+	)
+}
diff --git a/internal/cli/atlas/clusters/list.go b/internal/cli/atlas/clusters/list.go
@@ -84,6 +84,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/clusters/list_test.go b/internal/cli/atlas/clusters/list_test.go
@@ -64,6 +64,6 @@ func TestListBuilder(t *testing.T) {
 		t,
 		ListBuilder(),
 		0,
-		[]string{flag.Limit, flag.Page, flag.Output, flag.ProjectID},
+		[]string{flag.Limit, flag.Page, flag.Output, flag.ProjectID, flag.OmitCount},
 	)
 }
diff --git a/internal/cli/atlas/clusters/onlinearchive/list.go b/internal/cli/atlas/clusters/onlinearchive/list.go
@@ -83,10 +83,11 @@ func ListBuilder() *cobra.Command {
 		},
 	}
 
-	cmd.Flags().StringVar(&opts.clusterName, flag.ClusterName, "", usage.ClusterName)
 	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.clusterName, flag.ClusterName, "", usage.ClusterName)
 	cmd.Flags().StringVar(&opts.ProjectID, flag.ProjectID, "", usage.ProjectID)
 	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)
 	_ = cmd.RegisterFlagCompletionFunc(flag.Output, opts.AutoCompleteOutputFlag())

diff --git a/internal/cli/atlas/clusters/onlinearchive/list_test.go b/internal/cli/atlas/clusters/onlinearchive/list_test.go
@@ -38,6 +38,7 @@ func TestListBuilder(t *testing.T) {
 			flag.Limit,
 			flag.Output,
 			flag.ProjectID,
+			flag.OmitCount,
 		},
 	)
 }

diff --git a/internal/cli/atlas/datalakepipelines/availablesnapshots/list.go b/internal/cli/atlas/datalakepipelines/availablesnapshots/list.go
@@ -111,6 +111,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/datalakepipelines/availablesnapshots/list_test.go b/internal/cli/atlas/datalakepipelines/availablesnapshots/list_test.go
@@ -88,6 +88,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, flag.CompletedAfter, flag.Pipeline},
 	)
 }
diff --git a/internal/cli/atlas/dbusers/list.go b/internal/cli/atlas/dbusers/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.ProjectID, flag.ProjectID, "", usage.ProjectID)
 	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)

diff --git a/internal/cli/atlas/dbusers/list_test.go b/internal/cli/atlas/dbusers/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"
@@ -52,3 +53,12 @@ func TestDBUserList_Run(t *testing.T) {
 	}
 	test.VerifyOutputTemplate(t, listTemplate, expected)
 }
+
+func TestListBuilder(t *testing.T) {
+	test.CmdValidator(
+		t,
+		ListBuilder(),
+		0,
+		[]string{flag.ProjectID, flag.Output, flag.OmitCount, flag.Page, flag.Limit, flag.CompactResponse},
+	)
+}