feat(service-account): add pagination to list command (#1771)

Author: rkpattnaik780

docs/commands/rhoas_service-account_list.md

@@ -5,6 +5,9 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/redhat-developer/app-services-cli/internal/build"
+	"github.com/redhat-developer/app-services-cli/pkg/cmd/serviceaccount/svcaccountcmdutil/validation"
+	"github.com/redhat-developer/app-services-cli/pkg/core/cmdutil"
 	"github.com/redhat-developer/app-services-cli/pkg/core/cmdutil/flagutil"
 	"github.com/redhat-developer/app-services-cli/pkg/core/config"
 	"github.com/redhat-developer/app-services-cli/pkg/core/ioutil/dump"
@@ -28,6 +31,8 @@ type options struct {
 
 	output       string
 	enableAuthV2 bool
+	page         int32
+	size         int32
 }
 
 // svcAcctRow contains the properties used to
@@ -62,6 +67,18 @@ func NewListCommand(f *factory.Factory) *cobra.Command {
 				return flagutil.InvalidValueError("output", opts.output, flagutil.ValidOutputFormats...)
 			}
 
+			validator := &validation.Validator{
+				Localizer: opts.localizer,
+			}
+
+			if err := validator.ValidatePage(opts.page); err != nil {
+				return err
+			}
+
+			if err := validator.ValidateSize(opts.size); err != nil {
+				return err
+			}
+
 			return runList(opts)
 		},
 	}
@@ -71,6 +88,10 @@ func NewListCommand(f *factory.Factory) *cobra.Command {
 
 	_ = cmd.Flags().MarkDeprecated("enable-auth-v2", opts.localizer.MustLocalize("serviceAccount.common.flag.deprecated.enableAuthV2"))
 
+	cmd.Flags().Int32VarP(&opts.page, "page", "", int32(cmdutil.ConvertPageValueToInt32(build.DefaultPageNumber)), opts.localizer.MustLocalize("serviceAccount.list.flag.page.description"))
+	// Default has been set to 100 to preserve how list worked before
+	cmd.Flags().Int32VarP(&opts.size, "size", "", 100, opts.localizer.MustLocalize("serviceAccount.list.flag.size.description"))
+
 	flagutil.EnableOutputFlagCompletion(cmd)
 
 	return cmd
@@ -82,7 +103,14 @@ func runList(opts *options) (err error) {
 		return err
 	}
 
-	serviceaccounts, _, err := conn.API().ServiceAccountMgmt().GetServiceAccounts(opts.Context).Execute()
+	a := conn.API().ServiceAccountMgmt().GetServiceAccounts(opts.Context)
+
+	// Calculate offset based on page and size provided
+	calculatedFirst := (opts.page - 1) * opts.size
+	a = a.First(calculatedFirst)
+	a = a.Max(opts.size)
+
+	serviceaccounts, _, err := a.Execute()
 	if err != nil {
 		return err
 	}

pkg/cmd/serviceaccount/list/list.go

@@ -1,9 +1,10 @@
 package validation
 
 import (
+	"regexp"
+
 	"github.com/redhat-developer/app-services-cli/pkg/core/errors"
 	"github.com/redhat-developer/app-services-cli/pkg/core/localize"
-	"regexp"
 )
 
 const (
@@ -56,3 +57,37 @@ func (v *Validator) ValidateUUID(val interface{}) error {
 
 	return v.Localizer.MustLocalizeError("serviceAccount.common.validation.id.error.invalidID", localize.NewEntry("ID", id))
 }
+
+// ValidatePage validates if page number is valid
+func (v *Validator) ValidatePage(val interface{}) error {
+	page, ok := val.(int32)
+	if !ok {
+		return errors.NewCastError(val, "int32")
+	}
+
+	if page < 1 {
+		return v.Localizer.MustLocalizeError("serviceAccount.list.validation.page.error", localize.NewEntry("Page", page))
+	}
+
+	return nil
+
+}
+
+// ValidateSize validates if a valid size is provided
+func (v *Validator) ValidateSize(val interface{}) error {
+	size, ok := val.(int32)
+	if !ok {
+		return errors.NewCastError(val, "int32")
+	}
+
+	if size > 100 {
+		return v.Localizer.MustLocalizeError("serviceAccount.list.validation.size.error.max", localize.NewEntry("Size", size))
+	}
+
+	if size < 1 {
+		return v.Localizer.MustLocalizeError("serviceAccount.list.validation.size.error.min", localize.NewEntry("Size", size))
+	}
+
+	return nil
+
+}

pkg/cmd/serviceaccount/svcaccountcmdutil/validation/validation.go

@@ -24,6 +24,12 @@ one = 'Format in which to display the service account (choose from: "json", "yml
 [serviceAccount.list.flag.output.description]
 one = 'Format in which to display the service accounts (choose from: "json", "yml", "yaml")'
 
+[serviceAccount.list.flag.page.description]
+one = 'Current page number for the list'
+
+[serviceAccount.list.flag.size.description]
+one = 'Maximum number of items to be returned per page'
+
 [serviceAccount.common.flag.deprecated.enableAuthV2]
 one = '''migration has been completed to the new Service Account SDK
 

pkg/core/localize/locales/en/cmd/serviceaccount.en.toml

@@ -29,3 +29,12 @@ one = 'unable to list service accounts'
 [serviceAccount.list.log.info.noneFound]
 description = 'Info message when no service accounts were found'
 one = 'No service accounts were found.'
+
+[serviceAccount.list.validation.page.error]
+one = 'invalid page number {{.Page}}, minimum value is 1'
+
+[serviceAccount.list.validation.size.error.min]
+one = 'invalid size {{.Size}}, minimum value is 1'
+
+[serviceAccount.list.validation.size.error.max]
+one = 'invalid size {{.Size}}, maximum value is 100'