feat: add paging flags for list commands that support paging

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Add managed object storage name to `show` and `list` command outputs.
 - Add completions for managed object storages and allow using managed object storage name (in addition to its UUID) as a positional argument.
+- Add paging flags (`--limit` and `--page`) to `database`, `gateway`, `loadbalancer`, and `objectstorage` list commands
 
 ## [3.6.0] - 2024-03-07
 

internal/commands/database/list.go

@@ -4,8 +4,10 @@ import (
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/commands"
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/format"
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/output"
+	"github.com/UpCloudLtd/upcloud-cli/v3/internal/paging"
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/ui"
 	"github.com/UpCloudLtd/upcloud-go-api/v8/upcloud/request"
+	"github.com/spf13/pflag"
 )
 
 // ListCommand creates the "database list" command
@@ -17,12 +19,21 @@ func ListCommand() commands.Command {
 
 type listCommand struct {
 	*commands.BaseCommand
+	paging.PageParameters
+}
+
+func (s *listCommand) InitCommand() {
+	fs := &pflag.FlagSet{}
+	s.ConfigureFlags(fs)
+	s.AddFlags(fs)
 }
 
 // ExecuteWithoutArguments implements commands.NoArgumentCommand
 func (s *listCommand) ExecuteWithoutArguments(exec commands.Executor) (output.Output, error) {
 	svc := exec.All()
-	databases, err := svc.GetManagedDatabases(exec.Context(), &request.GetManagedDatabasesRequest{})
+	databases, err := svc.GetManagedDatabases(exec.Context(), &request.GetManagedDatabasesRequest{
+		Page: s.Page(),
+	})
 	if err != nil {
 		return nil, err
 	}

internal/commands/database/list_test.go

@@ -9,29 +9,50 @@ import (
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/mockexecute"
 
 	"github.com/UpCloudLtd/upcloud-go-api/v8/upcloud"
+	"github.com/UpCloudLtd/upcloud-go-api/v8/upcloud/request"
 	"github.com/jedib0t/go-pretty/v6/text"
 	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/mock"
 )
 
 func TestDatabaseListTitleFallback(t *testing.T) {
 	text.DisableColors()
 	databases := []upcloud.ManagedDatabase{
-		{UUID: "091f1afe-4ddd-4d43-afad-6aa3069cc7fe", Title: "service-name", Name: "hotname-prefix-1", State: "running"},
-		{UUID: "091f1afe-4ddd-4d43-afad-6aa3069cc7fe", Name: "hotname-prefix-2", State: "running"},
+		{UUID: "091f1afe-4ddd-4d43-afad-6aa3069cc7fe", Title: "service-name", Name: "hostname-prefix-1", State: "running"},
+		{UUID: "091f1afe-4ddd-4d43-afad-6aa3069cc7fe", Name: "hostname-prefix-2", State: "running"},
 	}
 
-	mService := smock.Service{}
-	mService.On("GetManagedDatabases", mock.Anything).Return(databases, nil)
-
-	conf := config.New()
-	command := commands.BuildCommand(ListCommand(), nil, conf)
-
-	output, err := mockexecute.MockExecute(command, &mService, conf)
-
-	assert.NoError(t, err)
-	assert.Regexp(t, `UUID\s+Title\s+Type\s+Plan\s+Zone\s+State`, output)
-	assert.Contains(t, output, "service-name")
-	assert.NotContains(t, output, "hotname-prefix-1")
-	assert.Contains(t, output, "hotname-prefix-2")
+	for _, test := range []struct {
+		name string
+		args []string
+		page request.Page
+	}{
+		{
+			name: "default page",
+			page: request.Page{Size: 100, Number: 0},
+		},
+		{
+			name: "limit and page args",
+			page: request.Page{Size: 18, Number: 19},
+			args: []string{"--limit", "18", "--page", "19"},
+		},
+	} {
+		t.Run(test.name, func(t *testing.T) {
+			page := test.page
+
+			mService := smock.Service{}
+			mService.On("GetManagedDatabases", &request.GetManagedDatabasesRequest{Page: &page}).Return(databases, nil)
+
+			conf := config.New()
+			command := commands.BuildCommand(ListCommand(), nil, conf)
+			command.Cobra().SetArgs(test.args)
+
+			output, err := mockexecute.MockExecute(command, &mService, conf)
+
+			assert.NoError(t, err)
+			assert.Regexp(t, `UUID\s+Title\s+Type\s+Plan\s+Zone\s+State`, output)
+			assert.Contains(t, output, "service-name")
+			assert.NotContains(t, output, "hostname-prefix-1")
+			assert.Contains(t, output, "hostname-prefix-2")
+		})
+	}
 }

internal/commands/gateway/list.go

@@ -6,9 +6,11 @@ import (
 
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/commands"
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/output"
+	"github.com/UpCloudLtd/upcloud-cli/v3/internal/paging"
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/ui"
 	"github.com/UpCloudLtd/upcloud-go-api/v8/upcloud"
 	"github.com/jedib0t/go-pretty/v6/text"
+	"github.com/spf13/pflag"
 )
 
 // ListCommand creates the "gateway list" command
@@ -20,12 +22,19 @@ func ListCommand() commands.Command {
 
 type listCommand struct {
 	*commands.BaseCommand
+	paging.PageParameters
+}
+
+func (c *listCommand) InitCommand() {
+	fs := &pflag.FlagSet{}
+	c.PageParameters.ConfigureFlags(fs)
+	c.AddFlags(fs)
 }
 
 // ExecuteWithoutArguments implements commands.NoArgumentCommand
 func (c *listCommand) ExecuteWithoutArguments(exec commands.Executor) (output.Output, error) {
 	svc := exec.All()
-	gateways, err := svc.GetGateways(exec.Context())
+	gateways, err := svc.GetGateways(exec.Context(), c.Page())
 	if err != nil {
 		return nil, err
 	}

internal/commands/loadbalancer/list.go

@@ -4,8 +4,10 @@ import (
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/commands"
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/format"
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/output"
+	"github.com/UpCloudLtd/upcloud-cli/v3/internal/paging"
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/ui"
 	"github.com/UpCloudLtd/upcloud-go-api/v8/upcloud/request"
+	"github.com/spf13/pflag"
 )
 
 // ListCommand creates the "loadbalancer list" command
@@ -17,12 +19,21 @@ func ListCommand() commands.Command {
 
 type listCommand struct {
 	*commands.BaseCommand
+	paging.PageParameters
+}
+
+func (s *listCommand) InitCommand() {
+	fs := &pflag.FlagSet{}
+	s.ConfigureFlags(fs)
+	s.AddFlags(fs)
 }
 
 // ExecuteWithoutArguments implements commands.NoArgumentCommand
 func (s *listCommand) ExecuteWithoutArguments(exec commands.Executor) (output.Output, error) {
 	svc := exec.All()
-	loadbalancers, err := svc.GetLoadBalancers(exec.Context(), &request.GetLoadBalancersRequest{})
+	loadbalancers, err := svc.GetLoadBalancers(exec.Context(), &request.GetLoadBalancersRequest{
+		Page: s.Page(),
+	})
 	if err != nil {
 		return nil, err
 	}

internal/commands/objectstorage/list.go

@@ -4,7 +4,9 @@ import (
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/commands"
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/format"
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/output"
+	"github.com/UpCloudLtd/upcloud-cli/v3/internal/paging"
 	"github.com/UpCloudLtd/upcloud-cli/v3/internal/ui"
+	"github.com/spf13/pflag"
 
 	"github.com/UpCloudLtd/upcloud-go-api/v8/upcloud/request"
 )
@@ -18,12 +20,21 @@ func ListCommand() commands.Command {
 
 type listCommand struct {
 	*commands.BaseCommand
+	paging.PageParameters
+}
+
+func (c *listCommand) InitCommand() {
+	fs := &pflag.FlagSet{}
+	c.ConfigureFlags(fs)
+	c.AddFlags(fs)
 }
 
 // ExecuteWithoutArguments implements commands.NoArgumentCommand
 func (c *listCommand) ExecuteWithoutArguments(exec commands.Executor) (output.Output, error) {
 	svc := exec.All()
-	objectstorages, err := svc.GetManagedObjectStorages(exec.Context(), &request.GetManagedObjectStoragesRequest{})
+	objectstorages, err := svc.GetManagedObjectStorages(exec.Context(), &request.GetManagedObjectStoragesRequest{
+		Page: c.Page(),
+	})
 	if err != nil {
 		return nil, err
 	}

internal/paging/paging.go

@@ -0,0 +1,23 @@
+package paging
+
+import (
+	"github.com/UpCloudLtd/upcloud-go-api/v8/upcloud/request"
+	"github.com/spf13/pflag"
+)
+
+type PageParameters struct {
+	size   int
+	number int
+}
+
+func (pp *PageParameters) ConfigureFlags(fs *pflag.FlagSet) {
+	fs.IntVar(&pp.size, "limit", 100, "Number of entries to receive at most.")
+	fs.IntVar(&pp.number, "page", 0, "Page number to calculate first item to receive. Page numbers start from `1`.")
+}
+
+func (pp *PageParameters) Page() *request.Page {
+	return &request.Page{
+		Number: pp.number,
+		Size:   pp.size,
+	}
+}