feat(iaas): support description field for network and network area cmds (#1673)

STACKITCLI-476

Author: cgoetz-inovex

docs/stackit_network_create.md

@@ -16,6 +16,9 @@ stackit network create [flags]
   Create a network with name "network-1"
   $ stackit network create --name network-1
 
+  Create a network with name "network-1" and a description
+  $ stackit network create --name network-1 --description "My network"
+
   Create a non-routed network with name "network-1"
   $ stackit network create --name network-1 --non-routed
 
@@ -38,6 +41,7 @@ stackit network create [flags]
 ### Options
 
 ```
+      --description string              Description of the network (up to 255 characters)
   -h, --help                            Help for "stackit network create"
       --ipv4-dns-name-servers strings   List of DNS name servers for IPv4. Nameservers cannot be defined for routed networks
       --ipv4-gateway string             The IPv4 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway

docs/stackit_network_update.md

@@ -16,6 +16,12 @@ stackit network update NETWORK_ID [flags]
   Update network with ID "xxx" with new name "network-1-new"
   $ stackit network update xxx --name network-1-new
 
+  Update the description of network with ID "xxx"
+  $ stackit network update xxx --description "My network"
+
+  Clear the description of network with ID "xxx"
+  $ stackit network update xxx --description ""
+
   Update network with ID "xxx" with no gateway
   $ stackit network update --no-ipv4-gateway
 
@@ -32,6 +38,7 @@ stackit network update NETWORK_ID [flags]
 ### Options
 
 ```
+      --description string              Description of the network (up to 255 characters). Use an empty string to clear it
   -h, --help                            Help for "stackit network update"
       --ipv4-dns-name-servers strings   List of DNS name servers IPv4. Nameservers cannot be defined for routed networks
       --ipv4-gateway string             The IPv4 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway

go.mod

@@ -24,7 +24,7 @@ require (
 	github.com/stackitcloud/stackit-sdk-go/services/dns v0.23.1
 	github.com/stackitcloud/stackit-sdk-go/services/edge v0.13.2
 	github.com/stackitcloud/stackit-sdk-go/services/git v0.14.1
-	github.com/stackitcloud/stackit-sdk-go/services/iaas v1.14.5
+	github.com/stackitcloud/stackit-sdk-go/services/iaas v1.15.0
 	github.com/stackitcloud/stackit-sdk-go/services/intake v0.12.0
 	github.com/stackitcloud/stackit-sdk-go/services/logs v0.10.2
 	github.com/stackitcloud/stackit-sdk-go/services/mongodbflex v1.13.0

go.sum

@@ -626,8 +626,8 @@ github.com/stackitcloud/stackit-sdk-go/services/edge v0.13.2 h1:UDkXmgOAlP3y/u7F
 github.com/stackitcloud/stackit-sdk-go/services/edge v0.13.2/go.mod h1:hlUcPvOgH/CzZqH7u4SwV81qiismCVAtvw5pTAf6si4=
 github.com/stackitcloud/stackit-sdk-go/services/git v0.14.1 h1:7R5peSRer3Y83mfB6wcdCP0vhEjsq4myUdVhl24q6to=
 github.com/stackitcloud/stackit-sdk-go/services/git v0.14.1/go.mod h1:kz2pl17t9MNQx0+fNXg10ZAVfjmvOtsHB7VlAzu/Io8=
-github.com/stackitcloud/stackit-sdk-go/services/iaas v1.14.5 h1:CVRo4/hCy6vLlh6LQjQikTDnh/0KF43nRhKsiicxyXc=
-github.com/stackitcloud/stackit-sdk-go/services/iaas v1.14.5/go.mod h1:oJmNZY04vvjrQI+y91ZZWOQiCAREcCldkh6cib+YtP0=
+github.com/stackitcloud/stackit-sdk-go/services/iaas v1.15.0 h1:DZEd4ORWEAu3/t92xLD7ah5gCshP+n5mOYxdOzdiZLc=
+github.com/stackitcloud/stackit-sdk-go/services/iaas v1.15.0/go.mod h1:o6Mt/ZUB/3qvIwtu4B57m9IlyaUxAFS2Tu5XImiZxCE=
 github.com/stackitcloud/stackit-sdk-go/services/intake v0.12.0 h1:1RDIGabA3U/kWrV0vkbkTof075liEHMdn39BsNwDI4k=
 github.com/stackitcloud/stackit-sdk-go/services/intake v0.12.0/go.mod h1:+v3VG6bXopAB2/uRz5yDXNFUwMSw0qJVRPxb3SDsACM=
 github.com/stackitcloud/stackit-sdk-go/services/kms v1.14.0 h1:6vZhGEIEqXUcs6pzpVNsHRAcskAVuKRq9lNMCMlYn+Q=

internal/cmd/network-area/route/list/list.go

@@ -152,14 +152,14 @@ func outputResult(p *print.Printer, outputFormat, networkAreaLabel string, route
 			routeNexthop := route.Nexthop
 			if routeNexthop.NexthopIPv4 != nil {
 				nextHop = routeNexthop.NexthopIPv4.Value
-				nextHopType = routeNexthop.NexthopIPv4.Type
+				nextHopType = string(routeNexthop.NexthopIPv4.Type)
 			} else if routeNexthop.NexthopIPv6 != nil {
 				nextHop = routeNexthop.NexthopIPv6.Value
-				nextHopType = routeNexthop.NexthopIPv6.Type
+				nextHopType = string(routeNexthop.NexthopIPv6.Type)
 			} else if routeNexthop.NexthopBlackhole != nil {
-				nextHopType = routeNexthop.NexthopBlackhole.Type
+				nextHopType = string(routeNexthop.NexthopBlackhole.Type)
 			} else if routeNexthop.NexthopInternet != nil {
-				nextHopType = routeNexthop.NexthopInternet.Type
+				nextHopType = string(routeNexthop.NexthopInternet.Type)
 			}
 
 			table.AddRow(

internal/cmd/network-area/routingtable/route/create/create.go

@@ -210,14 +210,14 @@ func buildDestination(model *inputModel) *iaas.RouteDestination {
 	case destTypeCIDRv4:
 		return &iaas.RouteDestination{
 			DestinationCIDRv4: &iaas.DestinationCIDRv4{
-				Type:  model.DestinationType,
+				Type:  iaas.DestinationCIDRv4Type(model.DestinationType),
 				Value: *model.DestinationValue,
 			},
 		}
 	case destTypeCIDRv6:
 		return &iaas.RouteDestination{
 			DestinationCIDRv6: &iaas.DestinationCIDRv6{
-				Type:  model.DestinationType,
+				Type:  iaas.DestinationCIDRv6Type(model.DestinationType),
 				Value: *model.DestinationValue,
 			},
 		}
@@ -232,27 +232,27 @@ func buildNextHop(model *inputModel) *iaas.RouteNexthop {
 	case nextHopTypeIPv4:
 		return &iaas.RouteNexthop{
 			NexthopIPv4: &iaas.NexthopIPv4{
-				Type:  model.NextHopType,
+				Type:  iaas.NexthopIPv4Type(model.NextHopType),
 				Value: *model.NextHopValue,
 			},
 		}
 	case nextHopTypeIPv6:
 		return &iaas.RouteNexthop{
 			NexthopIPv6: &iaas.NexthopIPv6{
-				Type:  model.NextHopType,
+				Type:  iaas.NexthopIPv6Type(model.NextHopType),
 				Value: *model.NextHopValue,
 			},
 		}
 	case nextHopTypeInternet:
 		return &iaas.RouteNexthop{
 			NexthopInternet: &iaas.NexthopInternet{
-				Type: model.NextHopType,
+				Type: iaas.NexthopInternetType(model.NextHopType),
 			},
 		}
 	case nextHopTypeBlackhole:
 		return &iaas.RouteNexthop{
 			NexthopBlackhole: &iaas.NexthopBlackhole{
-				Type: model.NextHopType,
+				Type: iaas.NexthopBlackholeType(model.NextHopType),
 			},
 		}
 	default:

internal/cmd/network/create/create.go

@@ -25,6 +25,7 @@ import (
 
 const (
 	nameFlag               = "name"
+	descriptionFlag        = "description"
 	ipv4DnsNameServersFlag = "ipv4-dns-name-servers"
 	ipv4PrefixLengthFlag   = "ipv4-prefix-length"
 	ipv4PrefixFlag         = "ipv4-prefix"
@@ -43,6 +44,7 @@ const (
 type inputModel struct {
 	*globalflags.GlobalFlagModel
 	Name               string
+	Description        *string
 	IPv4DnsNameServers []string
 	IPv4PrefixLength   *int64
 	IPv4Prefix         *string
@@ -69,6 +71,10 @@ func NewCmd(params *types.CmdParams) *cobra.Command {
 				`Create a network with name "network-1"`,
 				`$ stackit network create --name network-1`,
 			),
+			examples.NewExample(
+				`Create a network with name "network-1" and a description`,
+				`$ stackit network create --name network-1 --description "My network"`,
+			),
 			examples.NewExample(
 				`Create a non-routed network with name "network-1"`,
 				`$ stackit network create --name network-1 --non-routed`,
@@ -122,7 +128,7 @@ func NewCmd(params *types.CmdParams) *cobra.Command {
 			}
 
 			// Call API
-			req := buildRequest(ctx, model, apiClient)
+			req := buildRequest(ctx, model, apiClient.DefaultAPI)
 			resp, err := req.Execute()
 			if err != nil {
 				return fmt.Errorf("create network : %w", err)
@@ -152,6 +158,7 @@ func NewCmd(params *types.CmdParams) *cobra.Command {
 
 func configureFlags(cmd *cobra.Command) {
 	cmd.Flags().StringP(nameFlag, "n", "", "Network name")
+	cmd.Flags().String(descriptionFlag, "", "Description of the network (up to 255 characters)")
 	cmd.Flags().StringSlice(ipv4DnsNameServersFlag, []string{}, "List of DNS name servers for IPv4. Nameservers cannot be defined for routed networks")
 	cmd.Flags().Int64(ipv4PrefixLengthFlag, 0, "The prefix length of the IPv4 network")
 	cmd.Flags().String(ipv4PrefixFlag, "", "The IPv4 prefix of the network (CIDR)")
@@ -190,6 +197,7 @@ func parseInput(p *print.Printer, cmd *cobra.Command, _ []string) (*inputModel,
 	model := inputModel{
 		GlobalFlagModel:    globalFlags,
 		Name:               flags.FlagToStringValue(p, cmd, nameFlag),
+		Description:        flags.FlagToStringPointer(p, cmd, descriptionFlag),
 		IPv4DnsNameServers: flags.FlagToStringSliceValue(p, cmd, ipv4DnsNameServersFlag),
 		IPv4PrefixLength:   flags.FlagToInt64Pointer(p, cmd, ipv4PrefixLengthFlag),
 		IPv4Prefix:         flags.FlagToStringPointer(p, cmd, ipv4PrefixFlag),
@@ -246,8 +254,8 @@ func parseInput(p *print.Printer, cmd *cobra.Command, _ []string) (*inputModel,
 	return &model, nil
 }
 
-func buildRequest(ctx context.Context, model *inputModel, apiClient *iaas.APIClient) iaas.ApiCreateNetworkRequest {
-	req := apiClient.DefaultAPI.CreateNetwork(ctx, model.ProjectId, model.Region)
+func buildRequest(ctx context.Context, model *inputModel, apiClient iaas.DefaultAPI) iaas.ApiCreateNetworkRequest {
+	req := apiClient.CreateNetwork(ctx, model.ProjectId, model.Region)
 	var ipv4Network *iaas.CreateNetworkIPv4
 	var ipv6Network *iaas.CreateNetworkIPv6
 
@@ -297,6 +305,7 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *iaas.APICli
 
 	payload := iaas.CreateNetworkPayload{
 		Name:           model.Name,
+		Description:    model.Description,
 		Labels:         model.Labels,
 		Routed:         utils.Ptr(!model.NonRouted),
 		Ipv4:           ipv4Network,

internal/cmd/network/create/create_test.go

@@ -234,6 +234,26 @@ func TestParseInput(t *testing.T) {
 			isValid:       true,
 			expectedModel: fixtureInputModel(),
 		},
+		{
+			description: "description set",
+			flagValues: fixtureFlagValues(func(flagValues map[string]string) {
+				flagValues[descriptionFlag] = "My network"
+			}),
+			isValid: true,
+			expectedModel: fixtureInputModel(func(model *inputModel) {
+				model.Description = new("My network")
+			}),
+		},
+		{
+			description: "description empty",
+			flagValues: fixtureFlagValues(func(flagValues map[string]string) {
+				flagValues[descriptionFlag] = ""
+			}),
+			isValid: true,
+			expectedModel: fixtureInputModel(func(model *inputModel) {
+				model.Description = new("")
+			}),
+		},
 		{
 			description: "required only",
 			flagValues: map[string]string{
@@ -509,6 +529,28 @@ func TestBuildRequest(t *testing.T) {
 			model:           fixtureInputModel(),
 			expectedRequest: fixtureRequest(),
 		},
+		{
+			description: "description set",
+			model: fixtureInputModel(func(model *inputModel) {
+				model.Description = new("My network")
+			}),
+			expectedRequest: fixtureRequest(func(request *iaas.ApiCreateNetworkRequest) {
+				*request = request.CreateNetworkPayload(fixturePayload(func(payload *iaas.CreateNetworkPayload) {
+					payload.Description = new("My network")
+				}))
+			}),
+		},
+		{
+			description: "description empty",
+			model: fixtureInputModel(func(model *inputModel) {
+				model.Description = new("")
+			}),
+			expectedRequest: fixtureRequest(func(request *iaas.ApiCreateNetworkRequest) {
+				*request = request.CreateNetworkPayload(fixturePayload(func(payload *iaas.CreateNetworkPayload) {
+					payload.Description = new("")
+				}))
+			}),
+		},
 		{
 			description: "only name in payload",
 			model: &inputModel{
@@ -632,7 +674,7 @@ func TestBuildRequest(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.description, func(t *testing.T) {
-			request := buildRequest(testCtx, tt.model, testClient)
+			request := buildRequest(testCtx, tt.model, testClient.DefaultAPI)
 
 			diff := cmp.Diff(tt.expectedRequest, request,
 				cmp.AllowUnexported(tt.expectedRequest),

internal/cmd/network/describe/describe.go

@@ -136,6 +136,8 @@ func outputResult(p *print.Printer, outputFormat string, network *iaas.Network)
 		table.AddSeparator()
 		table.AddRow("NAME", network.Name)
 		table.AddSeparator()
+		table.AddRow("DESCRIPTION", utils.PtrString(network.Description))
+		table.AddSeparator()
 		table.AddRow("STATE", network.Status)
 		table.AddSeparator()
 

internal/cmd/network/list/list.go

@@ -143,7 +143,7 @@ func outputResult(p *print.Printer, outputFormat, projectLabel string, networks
 		}
 
 		table := tables.NewTable()
-		table.SetHeader("ID", "NAME", "STATUS", "PUBLIC IP", "PREFIXES", "ROUTED", "ROUTING TABLE ID")
+		table.SetHeader("ID", "NAME", "DESCRIPTION", "STATUS", "PUBLIC IP", "PREFIXES", "ROUTED", "ROUTING TABLE ID")
 
 		for _, network := range networks {
 			var publicIp, prefixes string
@@ -160,6 +160,7 @@ func outputResult(p *print.Printer, outputFormat, projectLabel string, networks
 			table.AddRow(
 				network.Id,
 				network.Name,
+				utils.Truncate(network.Description, 70),
 				network.Status,
 				publicIp,
 				prefixes,