Stackit git: add vertical table on describe and limit list command

Author: peremanent

docs/stackit_git_create.md

@@ -4,7 +4,7 @@ Creates STACKIT Git instance
 
 ### Synopsis
 
-Create an STACKIT Git instance by name.
+Create a STACKIT Git instance by name.
 
 ```
 stackit git create [flags]
@@ -13,7 +13,7 @@ stackit git create [flags]
 ### Examples
 
 ```
-  Create an instance with name 'my-new-instance'
+  Create a instance with name 'my-new-instance'
   $ stackit git create --name my-new-instance
 ```
 

docs/stackit_git_delete.md

@@ -4,7 +4,7 @@ Deletes STACKIT Git instance
 
 ### Synopsis
 
-Deletes an STACKIT Git instance by its internal ID.
+Deletes a STACKIT Git instance by its internal ID.
 
 ```
 stackit git delete INSTANCE_ID [flags]
@@ -13,7 +13,7 @@ stackit git delete INSTANCE_ID [flags]
 ### Examples
 
 ```
-  Delete an instance with ID "xxx"
+  Delete a instance with ID "xxx"
   $ stackit git delete xxx
 ```
 

docs/stackit_git_describe.md

@@ -4,7 +4,7 @@ Describes STACKIT Git instance
 
 ### Synopsis
 
-Describes an STACKIT Git instance by its internal ID.
+Describes a STACKIT Git instance by its internal ID.
 
 ```
 stackit git describe INSTANCE_ID [flags]

docs/stackit_git_list.md

@@ -15,12 +15,16 @@ stackit git list [flags]
 ```
   List all STACKIT Git instances
   $ stackit git instance list
+
+  Lists up to 10 STACKIT Git instances
+  $ stackit git instance list --limit=10
 ```
 
 ### Options
 
 ```
-  -h, --help   Help for "stackit git list"
+  -h, --help        Help for "stackit git list"
+      --limit int   Limit the output to the first n elements
 ```
 
 ### Options inherited from parent commands

internal/cmd/git/create/create.go

@@ -34,11 +34,11 @@ func NewCmd(p *print.Printer) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "create",
 		Short: "Creates STACKIT Git instance",
-		Long:  "Create an STACKIT Git instance by name.",
+		Long:  "Create a STACKIT Git instance by name.",
 		Args:  args.NoArgs,
 		Example: examples.Build(
 			examples.NewExample(
-				`Create an instance with name 'my-new-instance'`,
+				`Create a instance with name 'my-new-instance'`,
 				`$ stackit git create --name my-new-instance`,
 			),
 		),

internal/cmd/git/delete/delete.go

@@ -30,10 +30,10 @@ func NewCmd(p *print.Printer) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   fmt.Sprintf("delete %s", instanceIdArg),
 		Short: "Deletes STACKIT Git instance",
-		Long:  "Deletes an STACKIT Git instance by its internal ID.",
+		Long:  "Deletes a STACKIT Git instance by its internal ID.",
 		Args:  args.SingleArg(instanceIdArg, utils.ValidateUUID),
 		Example: examples.Build(
-			examples.NewExample(`Delete an instance with ID "xxx"`, `$ stackit git delete xxx`),
+			examples.NewExample(`Delete a instance with ID "xxx"`, `$ stackit git delete xxx`),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()

internal/cmd/git/describe/describe.go

@@ -29,7 +29,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   fmt.Sprintf("describe %s", instanceIdArg),
 		Short: "Describes STACKIT Git instance",
-		Long:  "Describes an STACKIT Git instance by its internal ID.",
+		Long:  "Describes a STACKIT Git instance by its internal ID.",
 		Args:  args.SingleArg(instanceIdArg, utils.ValidateUUID),
 		Example: examples.Build(
 			examples.NewExample(`Describe instance "xxx"`, `$ stackit git describe xxx`),
@@ -116,15 +116,30 @@ func outputResult(p *print.Printer, outputFormat string, resp *git.Instance) err
 		return nil
 	default:
 		table := tables.NewTable()
-		table.SetHeader("ID", "NAME", "URL", "VERSION", "STATE", "CREATED")
-		table.AddRow(
-			utils.PtrString(resp.Id),
-			utils.PtrString(resp.Name),
-			utils.PtrString(resp.Url),
-			utils.PtrString(resp.Version),
-			utils.PtrString(resp.State),
-			utils.PtrString(resp.Created),
-		)
+		if id := resp.Id; id != nil {
+			table.AddRow("ID", *id)
+			table.AddSeparator()
+		}
+		if name := resp.Name; name != nil {
+			table.AddRow("NAME", *name)
+			table.AddSeparator()
+		}
+		if url := resp.Url; url != nil {
+			table.AddRow("URL", *url)
+			table.AddSeparator()
+		}
+		if version := resp.Version; version != nil {
+			table.AddRow("VERSION", *version)
+			table.AddSeparator()
+		}
+		if state := resp.State; state != nil {
+			table.AddRow("STATE", *state)
+			table.AddSeparator()
+		}
+		if created := resp.Created; created != nil {
+			table.AddRow("CREATED", *created)
+			table.AddSeparator()
+		}
 
 		if err := table.Display(p); err != nil {
 			return fmt.Errorf("render table: %w", err)

internal/cmd/git/list/list.go

@@ -10,6 +10,7 @@ import (
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/errors"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/examples"
+	"github.com/stackitcloud/stackit-cli/internal/pkg/flags"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/print"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/projectname"
@@ -21,8 +22,11 @@ import (
 
 type inputModel struct {
 	*globalflags.GlobalFlagModel
+	Limit *int64
 }
 
+const limitFlag = "limit"
+
 func NewCmd(p *print.Printer) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "list",
@@ -33,6 +37,10 @@ func NewCmd(p *print.Printer) *cobra.Command {
 			examples.NewExample(
 				`List all STACKIT Git instances`,
 				"$ stackit git instance list"),
+			examples.NewExample(
+				"Lists up to 10 STACKIT Git instances",
+				"$ stackit git instance list --limit=10",
+			),
 		),
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			ctx := context.Background()
@@ -62,23 +70,37 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				}
 				p.Info("No instances found for project %q\n", projectLabel)
 				return nil
+			} else if model.Limit != nil && len(instances) > int(*model.Limit) {
+				instances = (instances)[:*model.Limit]
 			}
-
 			return outputResult(p, model.OutputFormat, instances)
 		},
 	}
-
+	configureFlags(cmd)
 	return cmd
 }
 
+func configureFlags(cmd *cobra.Command) {
+	cmd.Flags().Int64(limitFlag, 0, "Limit the output to the first n elements")
+}
+
 func parseInput(p *print.Printer, cmd *cobra.Command) (*inputModel, error) {
 	globalFlags := globalflags.Parse(p, cmd)
 	if globalFlags.ProjectId == "" {
 		return nil, &errors.ProjectIdError{}
 	}
 
+	limit := flags.FlagToInt64Pointer(p, cmd, limitFlag)
+	if limit != nil && *limit < 1 {
+		return nil, &errors.FlagValidationError{
+			Flag:    limitFlag,
+			Details: "must be greater than 0",
+		}
+	}
+
 	model := inputModel{
 		GlobalFlagModel: globalFlags,
+		Limit:           limit,
 	}
 
 	if p.IsVerbosityDebug() {

internal/cmd/git/list/list_test.go

@@ -2,13 +2,15 @@ package list
 
 import (
 	"context"
+	"strconv"
 	"testing"
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/google/go-cmp/cmp/cmpopts"
 	"github.com/google/uuid"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/print"
+	"github.com/stackitcloud/stackit-cli/internal/pkg/utils"
 	"github.com/stackitcloud/stackit-sdk-go/services/git"
 )
 
@@ -18,6 +20,10 @@ var testCtx = context.WithValue(context.Background(), testCtxKey{}, "foo")
 var testClient = &git.APIClient{}
 var testProjectId = uuid.NewString()
 
+const (
+	testLimit = 10
+)
+
 func fixtureFlagValues(mods ...func(flagValues map[string]string)) map[string]string {
 	flagValues := map[string]string{
 		globalflags.ProjectIdFlag: testProjectId,
@@ -88,6 +94,30 @@ func TestParseInput(t *testing.T) {
 			}),
 			isValid: false,
 		},
+		{
+			description: "with limit flag",
+			flagValues: fixtureFlagValues(func(flagValues map[string]string) {
+				flagValues["limit"] = strconv.Itoa(testLimit)
+			}),
+			isValid: true,
+			expectedModel: fixtureInputModel(func(model *inputModel) {
+				model.Limit = utils.Ptr(int64(testLimit))
+			}),
+		},
+		{
+			description: "with limit flag == 0",
+			flagValues: fixtureFlagValues(func(flagValues map[string]string) {
+				flagValues["limit"] = strconv.Itoa(0)
+			}),
+			isValid: false,
+		},
+		{
+			description: "with limit flag < 0",
+			flagValues: fixtureFlagValues(func(flagValues map[string]string) {
+				flagValues["limit"] = strconv.Itoa(-1)
+			}),
+			isValid: false,
+		},
 	}
 
 	for _, tt := range tests {