feat(instance): add tags to private nics (#2793)

Co-authored-by: Jules Castéran <jcasteran@scaleway.com>

Author: scaleway-bot

cmd/scw/testdata/test-all-usage-instance-private-nic-create-usage.golden

@@ -8,6 +8,7 @@ USAGE:
 ARGS:
   server-id            UUID of the server the private NIC will be attached to
   private-network-id   UUID of the private network where the private NIC will be attached
+  [tags.{index}]       The private NIC tags
   [zone=fr-par-1]      Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
 
 FLAGS:

cmd/scw/testdata/test-all-usage-instance-private-nic-list-usage.golden

@@ -14,7 +14,8 @@ EXAMPLES:
 
 ARGS:
   server-id         The server the private NIC is attached to
-  [zone=fr-par-1]   Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
+  [tags.{index}]    The private NIC tags
+  [zone=fr-par-1]   Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2 | all)
 
 FLAGS:
   -h, --help   help for list

cmd/scw/testdata/test-all-usage-instance-server-update-usage.golden

@@ -46,6 +46,7 @@ ARGS:
   [private-nics.{index}.private-network-id]   The private network where the private NIC is attached
   [private-nics.{index}.mac-address]          The private NIC MAC address
   [private-nics.{index}.state]                The private NIC state (available | syncing | syncing_error)
+  [private-nics.{index}.tags.{index}]         The private NIC tags
   [zone=fr-par-1]                             Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
 
 DEPRECATED ARGS:

docs/commands/instance.md

@@ -847,6 +847,7 @@ scw instance private-nic create [arg=value ...]
 |------|---|-------------|
 | server-id | Required | UUID of the server the private NIC will be attached to |
 | private-network-id | Required | UUID of the private network where the private NIC will be attached |
+| tags.{index} |  | The private NIC tags |
 | zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config |
 
 
@@ -909,7 +910,8 @@ scw instance private-nic list [arg=value ...]
 | Name |   | Description |
 |------|---|-------------|
 | server-id | Required | The server the private NIC is attached to |
-| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config |
+| tags.{index} |  | The private NIC tags |
+| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2`, `all` | Zone to target. If none is passed will use default zone from the config |
 
 
 **Examples:**
@@ -1835,6 +1837,7 @@ scw instance server update <server-id ...> [arg=value ...]
 | private-nics.{index}.private-network-id |  | The private network where the private NIC is attached |
 | private-nics.{index}.mac-address |  | The private NIC MAC address |
 | private-nics.{index}.state | One of: `available`, `syncing`, `syncing_error` | The private NIC state |
+| private-nics.{index}.tags.{index} |  | The private NIC tags |
 | zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config |
 
 

internal/namespaces/instance/v1/custom.go

@@ -172,7 +172,6 @@ func GetCommands() *core.Commands {
 	//
 	human.RegisterMarshalerFunc(instance.PrivateNICState(""), human.EnumMarshalFunc(privateNICStateMarshalSpecs))
 
-	cmds.MustFind("instance", "private-nic", "list").Override(privateNicListBuilder)
 	cmds.MustFind("instance", "private-nic", "get").Override(privateNicGetBuilder)
 
 	return cmds

internal/namespaces/instance/v1/custom_privatenics.go

@@ -18,21 +18,6 @@ var (
 	}
 )
 
-func privateNicListBuilder(c *core.Command) *core.Command {
-	c.AddInterceptors(func(ctx context.Context, argsI interface{}, runner core.CommandRunner) (i interface{}, err error) {
-		listPrivateNicResp, err := runner(ctx, argsI)
-		if err != nil {
-			return listPrivateNicResp, err
-		}
-		l := listPrivateNicResp.(*instance.ListPrivateNICsResponse)
-		privateNic := l.PrivateNics
-
-		return privateNic, nil
-	})
-
-	return c
-}
-
 func privateNicGetBuilder(c *core.Command) *core.Command {
 	c.ArgSpecs.GetByName("private-nic-id").Short = "The private NIC unique ID or MAC address"
 

internal/namespaces/instance/v1/custom_privatenics_test.go

@@ -8,10 +8,17 @@ import (
 )
 
 func Test_ListNICs(t *testing.T) {
+	cmds := GetCommands()
+	cmds.Merge(vpc.GetCommands())
+
 	t.Run("Simple", core.Test(&core.TestConfig{
-		Commands: GetCommands(),
-		// Temporary in waiting for the private network support in the CLI
-		Cmd: "scw instance private-nic list server-id=4fe24c2a-3c65-4530-b274-574b22ba3d14",
+		Commands: cmds,
+		BeforeFunc: core.BeforeFuncCombine(
+			createPN(),
+			createServer("Server"),
+			createNIC(),
+		),
+		Cmd: "scw instance private-nic list server-id={{ .Server.ID }}",
 		Check: core.TestCheckCombine(
 			core.TestCheckGolden(),
 		),

internal/namespaces/instance/v1/instance_cli.go

@@ -707,6 +707,13 @@ func instanceServerUpdate() *core.Command {
 				Positional: false,
 				EnumValues: []string{"available", "syncing", "syncing_error"},
 			},
+			{
+				Name:       "private-nics.{index}.tags.{index}",
+				Short:      `The private NIC tags`,
+				Required:   false,
+				Deprecated: false,
+				Positional: false,
+			},
 			core.ZoneArgSpec(scw.ZoneFrPar1, scw.ZoneFrPar2, scw.ZoneFrPar3, scw.ZoneNlAms1, scw.ZoneNlAms2, scw.ZonePlWaw1, scw.ZonePlWaw2),
 		},
 		Run: func(ctx context.Context, args interface{}) (i interface{}, e error) {
@@ -2749,14 +2756,30 @@ func instancePrivateNicList() *core.Command {
 				Deprecated: false,
 				Positional: false,
 			},
-			core.ZoneArgSpec(scw.ZoneFrPar1, scw.ZoneFrPar2, scw.ZoneFrPar3, scw.ZoneNlAms1, scw.ZoneNlAms2, scw.ZonePlWaw1, scw.ZonePlWaw2),
+			{
+				Name:       "tags.{index}",
+				Short:      `The private NIC tags`,
+				Required:   false,
+				Deprecated: false,
+				Positional: false,
+			},
+			core.ZoneArgSpec(scw.ZoneFrPar1, scw.ZoneFrPar2, scw.ZoneFrPar3, scw.ZoneNlAms1, scw.ZoneNlAms2, scw.ZonePlWaw1, scw.ZonePlWaw2, scw.Zone(core.AllLocalities)),
 		},
 		Run: func(ctx context.Context, args interface{}) (i interface{}, e error) {
 			request := args.(*instance.ListPrivateNICsRequest)
 
 			client := core.ExtractClient(ctx)
 			api := instance.NewAPI(client)
-			return api.ListPrivateNICs(request)
+			opts := []scw.RequestOption{scw.WithAllPages()}
+			if request.Zone == scw.Zone(core.AllLocalities) {
+				opts = append(opts, scw.WithZones(api.Zones()...))
+				request.Zone = ""
+			}
+			resp, err := api.ListPrivateNICs(request, opts...)
+			if err != nil {
+				return nil, err
+			}
+			return resp.PrivateNics, nil
 
 		},
 		Examples: []*core.Example{
@@ -2796,6 +2819,13 @@ func instancePrivateNicCreate() *core.Command {
 				Deprecated: false,
 				Positional: false,
 			},
+			{
+				Name:       "tags.{index}",
+				Short:      `The private NIC tags`,
+				Required:   false,
+				Deprecated: false,
+				Positional: false,
+			},
 			core.ZoneArgSpec(scw.ZoneFrPar1, scw.ZoneFrPar2, scw.ZoneFrPar3, scw.ZoneNlAms1, scw.ZoneNlAms2, scw.ZonePlWaw1, scw.ZonePlWaw2),
 		},
 		Run: func(ctx context.Context, args interface{}) (i interface{}, e error) {