Fix/network area and network missing label selector (#627)

* Onboard: Labels for network-area

Signed-off-by: Alexander Dahmen <alexander.dahmen@inovex.de>

* Onboard: Labels for network

Signed-off-by: Alexander Dahmen <alexander.dahmen@inovex.de>

* generate-docs

Signed-off-by: Alexander Dahmen <alexander.dahmen@inovex.de>

---------

Signed-off-by: Alexander Dahmen <alexander.dahmen@inovex.de>

Author: Fyusel

docs/stackit_beta_network-area_create.md

@@ -21,6 +21,9 @@ stackit beta network-area create [flags]
 
   Create a network area with name "network-area-3" in organization with ID "xxx" with network ranges, transfer network and additional options
   $ stackit beta network-area create --name network-area-3 --organization-id xxx --network-ranges "1.1.1.0/24,192.123.1.0/24" --transfer-network "192.160.0.0/24" --default-prefix-length 25 --max-prefix-length 29 --min-prefix-length 24
+
+  Create a network area with name "network-area-1" in organization with ID "xxx" with network ranges and a transfer network and labels "key=value,key1=value1"
+  $ stackit beta network-area create --name network-area-1 --organization-id xxx --network-ranges "1.1.1.0/24,192.123.1.0/24" --transfer-network "192.160.0.0/24" --labels key=value,key1=value1
 ```
 
 ### Options
@@ -29,6 +32,7 @@ stackit beta network-area create [flags]
       --default-prefix-length int   The default prefix length for networks in the network area
       --dns-name-servers strings    List of DNS name server IPs
   -h, --help                        Help for "stackit beta network-area create"
+      --labels stringToString       Labels are key-value string pairs which can be attached to a network-area. E.g. '--labels key1=value1,key2=value2,...' (default [])
       --max-prefix-length int       The maximum prefix length for networks in the network area
       --min-prefix-length int       The minimum prefix length for networks in the network area
   -n, --name string                 Network area name

docs/stackit_beta_network-area_list.md

@@ -21,12 +21,16 @@ stackit beta network-area list [flags]
 
   Lists up to 10 network areas of organization "xxx"
   $ stackit beta network-area list --organization-id xxx --limit 10
+
+  Lists all network areas of organization "xxx" which contains the label yyy
+  $ stackit beta network-area list --organization-id xxx --label-selector yyy
 ```
 
 ### Options
 
 ```
   -h, --help                     Help for "stackit beta network-area list"
+      --label-selector string    Filter by label
       --limit int                Maximum number of entries to list
       --organization-id string   Organization ID
 ```

docs/stackit_beta_network-area_update.md

@@ -23,6 +23,7 @@ stackit beta network-area update AREA_ID [flags]
       --default-prefix-length int   The default prefix length for networks in the network area
       --dns-name-servers strings    List of DNS name server IPs
   -h, --help                        Help for "stackit beta network-area update"
+      --labels stringToString       Labels are key-value string pairs which can be attached to a network-area. E.g. '--labels key1=value1,key2=value2,...' (default [])
       --max-prefix-length int       The maximum prefix length for networks in the network area
       --min-prefix-length int       The minimum prefix length for networks in the network area
   -n, --name string                 Network area name

docs/stackit_beta_network_create.md

@@ -22,6 +22,9 @@ stackit beta network create [flags]
   Create a network with name "network-1" and no gateway
   $ stackit beta network create --name network-1 --no-ipv4-gateway
 
+  Create a network with name "network-1" and labels "key=value,key1=value1"
+  $ stackit beta network create --name network-1 --labels key=value,key1=value1
+
   Create an IPv4 network with name "network-1" with DNS name servers, a prefix and a gateway
   $ stackit beta network create --name network-1  --ipv4-dns-name-servers "1.1.1.1,8.8.8.8,9.9.9.9" --ipv4-prefix "10.1.2.0/24" --ipv4-gateway "10.1.2.3"
 
@@ -41,6 +44,7 @@ stackit beta network create [flags]
       --ipv6-gateway string             The IPv6 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway
       --ipv6-prefix string              The IPv6 prefix of the network (CIDR)
       --ipv6-prefix-length int          The prefix length of the IPv6 network
+      --labels stringToString           Labels are key-value string pairs which can be attached to a network. E.g. '--labels key1=value1,key2=value2,...' (default [])
   -n, --name string                     Network name
       --no-ipv4-gateway                 If set to true, the network doesn't have an IPv4 gateway
       --no-ipv6-gateway                 If set to true, the network doesn't have an IPv6 gateway

docs/stackit_beta_network_list.md

@@ -21,13 +21,17 @@ stackit beta network list [flags]
 
   Lists up to 10 networks
   $ stackit beta network list --limit 10
+
+  Lists all networks which contains the label xxx
+  $ tackit beta network list --label-selector xxx
 ```
 
 ### Options
 
 ```
-  -h, --help        Help for "stackit beta network list"
-      --limit int   Maximum number of entries to list
+  -h, --help                    Help for "stackit beta network list"
+      --label-selector string   Filter by label
+      --limit int               Maximum number of entries to list
 ```
 
 ### Options inherited from parent commands

docs/stackit_beta_network_update.md

@@ -34,6 +34,7 @@ stackit beta network update NETWORK_ID [flags]
       --ipv4-gateway string             The IPv4 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway
       --ipv6-dns-name-servers strings   List of DNS name servers for IPv6. Nameservers cannot be defined for routed networks
       --ipv6-gateway string             The IPv6 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway
+      --labels stringToString           Labels are key-value string pairs which can be attached to a network. E.g. '--labels key1=value1,key2=value2,...' (default [])
   -n, --name string                     Network name
       --no-ipv4-gateway                 If set to true, the network doesn't have an IPv4 gateway
       --no-ipv6-gateway                 If set to true, the network doesn't have an IPv6 gateway

internal/cmd/beta/network-area/create/create.go

@@ -29,6 +29,7 @@ const (
 	defaultPrefixLengthFlag = "default-prefix-length"
 	maxPrefixLengthFlag     = "max-prefix-length"
 	minPrefixLengthFlag     = "min-prefix-length"
+	labelFlag               = "labels"
 )
 
 type inputModel struct {
@@ -41,6 +42,7 @@ type inputModel struct {
 	DefaultPrefixLength *int64
 	MaxPrefixLength     *int64
 	MinPrefixLength     *int64
+	Labels              *map[string]string
 }
 
 func NewCmd(p *print.Printer) *cobra.Command {
@@ -62,6 +64,10 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Create a network area with name "network-area-3" in organization with ID "xxx" with network ranges, transfer network and additional options`,
 				`$ stackit beta network-area create --name network-area-3 --organization-id xxx --network-ranges "1.1.1.0/24,192.123.1.0/24" --transfer-network "192.160.0.0/24" --default-prefix-length 25 --max-prefix-length 29 --min-prefix-length 24`,
 			),
+			examples.NewExample(
+				`Create a network area with name "network-area-1" in organization with ID "xxx" with network ranges and a transfer network and labels "key=value,key1=value1"`,
+				`$ stackit beta network-area create --name network-area-1 --organization-id xxx --network-ranges "1.1.1.0/24,192.123.1.0/24" --transfer-network "192.160.0.0/24" --labels key=value,key1=value1`,
+			),
 		),
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			ctx := context.Background()
@@ -121,6 +127,7 @@ func configureFlags(cmd *cobra.Command) {
 	cmd.Flags().Int64(defaultPrefixLengthFlag, 0, "The default prefix length for networks in the network area")
 	cmd.Flags().Int64(maxPrefixLengthFlag, 0, "The maximum prefix length for networks in the network area")
 	cmd.Flags().Int64(minPrefixLengthFlag, 0, "The minimum prefix length for networks in the network area")
+	cmd.Flags().StringToString(labelFlag, nil, "Labels are key-value string pairs which can be attached to a network-area. E.g. '--labels key1=value1,key2=value2,...'")
 
 	err := flags.MarkFlagsRequired(cmd, nameFlag, organizationIdFlag, networkRangesFlag, transferNetworkFlag)
 	cobra.CheckErr(err)
@@ -139,6 +146,7 @@ func parseInput(p *print.Printer, cmd *cobra.Command) (*inputModel, error) {
 		DefaultPrefixLength: flags.FlagToInt64Pointer(p, cmd, defaultPrefixLengthFlag),
 		MaxPrefixLength:     flags.FlagToInt64Pointer(p, cmd, maxPrefixLengthFlag),
 		MinPrefixLength:     flags.FlagToInt64Pointer(p, cmd, minPrefixLengthFlag),
+		Labels:              flags.FlagToStringToStringPointer(p, cmd, labelFlag),
 	}
 
 	if p.IsVerbosityDebug() {
@@ -163,8 +171,18 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *iaas.APICli
 		}
 	}
 
+	var labelsMap *map[string]interface{}
+	if model.Labels != nil && len(*model.Labels) > 0 {
+		// convert map[string]string to map[string]interface{}
+		labelsMap = utils.Ptr(map[string]interface{}{})
+		for k, v := range *model.Labels {
+			(*labelsMap)[k] = v
+		}
+	}
+
 	payload := iaas.CreateNetworkAreaPayload{
-		Name: model.Name,
+		Name:   model.Name,
+		Labels: labelsMap,
 		AddressFamily: &iaas.CreateAreaAddressFamily{
 			Ipv4: &iaas.CreateAreaIPv4{
 				DefaultNameservers: model.DnsNameServers,

internal/cmd/beta/network-area/create/create_test.go

@@ -31,6 +31,7 @@ func fixtureFlagValues(mods ...func(flagValues map[string]string)) map[string]st
 		defaultPrefixLengthFlag: "24",
 		maxPrefixLengthFlag:     "24",
 		minPrefixLengthFlag:     "24",
+		labelFlag:               "key=value",
 	}
 	for _, mod := range mods {
 		mod(flagValues)
@@ -51,6 +52,9 @@ func fixtureInputModel(mods ...func(model *inputModel)) *inputModel {
 		DefaultPrefixLength: utils.Ptr(int64(24)),
 		MaxPrefixLength:     utils.Ptr(int64(24)),
 		MinPrefixLength:     utils.Ptr(int64(24)),
+		Labels: utils.Ptr(map[string]string{
+			"key": "value",
+		}),
 	}
 	for _, mod := range mods {
 		mod(model)
@@ -70,6 +74,9 @@ func fixtureRequest(mods ...func(request *iaas.ApiCreateNetworkAreaRequest)) iaa
 func fixturePayload(mods ...func(payload *iaas.CreateNetworkAreaPayload)) iaas.CreateNetworkAreaPayload {
 	payload := iaas.CreateNetworkAreaPayload{
 		Name: utils.Ptr("example-network-area-name"),
+		Labels: utils.Ptr(map[string]interface{}{
+			"key": "value",
+		}),
 		AddressFamily: &iaas.CreateAreaAddressFamily{
 			Ipv4: &iaas.CreateAreaIPv4{
 				DefaultNameservers: utils.Ptr([]string{"1.1.1.0", "1.1.2.0"}),
@@ -171,6 +178,16 @@ func TestParseInput(t *testing.T) {
 			}),
 			isValid: false,
 		},
+		{
+			description: "labels missing",
+			flagValues: fixtureFlagValues(func(flagValues map[string]string) {
+				delete(flagValues, labelFlag)
+			}),
+			expectedModel: fixtureInputModel(func(model *inputModel) {
+				model.Labels = nil
+			}),
+			isValid: true,
+		},
 	}
 
 	for _, tt := range tests {

internal/cmd/beta/network-area/describe/describe.go

@@ -202,6 +202,14 @@ func outputResult(p *print.Printer, outputFormat string, networkArea *iaas.Netwo
 				table.AddSeparator()
 			}
 		}
+		if networkArea.Labels != nil && len(*networkArea.Labels) > 0 {
+			var labels []string
+			for key, value := range *networkArea.Labels {
+				labels = append(labels, fmt.Sprintf("%s: %s", key, value))
+			}
+			table.AddRow("LABELS", strings.Join(labels, "\n"))
+			table.AddSeparator()
+		}
 		if len(attachedProjects) > 0 {
 			table.AddRow("ATTACHED PROJECTS IDS", strings.Join(attachedProjects, "\n"))
 			table.AddSeparator()

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

@@ -24,12 +24,14 @@ import (
 const (
 	limitFlag          = "limit"
 	organizationIdFlag = "organization-id"
+	labelSelectorFlag  = "label-selector"
 )
 
 type inputModel struct {
 	*globalflags.GlobalFlagModel
 	Limit          *int64
 	OrganizationId *string
+	LabelSelector  *string
 }
 
 func NewCmd(p *print.Printer) *cobra.Command {
@@ -51,6 +53,10 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Lists up to 10 network areas of organization "xxx"`,
 				"$ stackit beta network-area list --organization-id xxx --limit 10",
 			),
+			examples.NewExample(
+				`Lists all network areas of organization "xxx" which contains the label yyy`,
+				"$ stackit beta network-area list --organization-id xxx --label-selector yyy",
+			),
 		),
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			ctx := context.Background()
@@ -106,6 +112,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
 func configureFlags(cmd *cobra.Command) {
 	cmd.Flags().Int64(limitFlag, 0, "Maximum number of entries to list")
 	cmd.Flags().Var(flags.UUIDFlag(), organizationIdFlag, "Organization ID")
+	cmd.Flags().String(labelSelectorFlag, "", "Filter by label")
 
 	err := flags.MarkFlagsRequired(cmd, organizationIdFlag)
 	cobra.CheckErr(err)
@@ -125,6 +132,7 @@ func parseInput(p *print.Printer, cmd *cobra.Command) (*inputModel, error) {
 		GlobalFlagModel: globalFlags,
 		Limit:           limit,
 		OrganizationId:  flags.FlagToStringPointer(p, cmd, organizationIdFlag),
+		LabelSelector:   flags.FlagToStringPointer(p, cmd, labelSelectorFlag),
 	}
 
 	if p.IsVerbosityDebug() {
@@ -140,7 +148,11 @@ func parseInput(p *print.Printer, cmd *cobra.Command) (*inputModel, error) {
 }
 
 func buildRequest(ctx context.Context, model *inputModel, apiClient *iaas.APIClient) iaas.ApiListNetworkAreasRequest {
-	return apiClient.ListNetworkAreas(ctx, *model.OrganizationId)
+	req := apiClient.ListNetworkAreas(ctx, *model.OrganizationId)
+	if model.LabelSelector != nil {
+		req = req.LabelSelector(*model.LabelSelector)
+	}
+	return req
 }
 
 func outputResult(p *print.Printer, outputFormat string, networkAreas []iaas.NetworkArea) error {