feat(instance): get pnic from mac address (#2715)

Co-authored-by: Rémy Léone <rleone@scaleway.com>

Author: yfodil

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

@@ -7,7 +7,7 @@ USAGE:
 
 ARGS:
   server-id         The server the private NIC is attached to
-  private-nic-id    The private NIC unique ID
+  private-nic-id    The private NIC unique ID or MAC address
   [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:

docs/commands/instance.md

@@ -888,7 +888,7 @@ scw instance private-nic get [arg=value ...]
 | Name |   | Description |
 |------|---|-------------|
 | server-id | Required | The server the private NIC is attached to |
-| private-nic-id | Required | The private NIC unique ID |
+| private-nic-id | Required | The private NIC unique ID or MAC address |
 | 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

@@ -173,6 +173,7 @@ 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

@@ -2,6 +2,7 @@ package instance
 
 import (
 	"context"
+	"net"
 
 	"github.com/fatih/color"
 	"github.com/scaleway/scaleway-cli/v2/internal/core"
@@ -31,3 +32,38 @@ func privateNicListBuilder(c *core.Command) *core.Command {
 
 	return c
 }
+
+func privateNicGetBuilder(c *core.Command) *core.Command {
+	c.ArgSpecs.GetByName("private-nic-id").Short = "The private NIC unique ID or MAC address"
+
+	c.Interceptor = func(ctx context.Context, argsI interface{}, runner core.CommandRunner) (interface{}, error) {
+		tmpRequest := argsI.(*instance.GetPrivateNICRequest)
+
+		if isMacAddress(tmpRequest.PrivateNicID) {
+			client := core.ExtractClient(ctx)
+			api := instance.NewAPI(client)
+
+			listPrivateNICs, err := api.ListPrivateNICs(&instance.ListPrivateNICsRequest{
+				Zone:     tmpRequest.Zone,
+				ServerID: tmpRequest.ServerID,
+			})
+			if err != nil {
+				return nil, err
+			}
+			for _, pn := range listPrivateNICs.PrivateNics {
+				if pn.MacAddress == tmpRequest.PrivateNicID {
+					tmpRequest.PrivateNicID = pn.ID
+				}
+			}
+		}
+
+		return runner(ctx, tmpRequest)
+	}
+
+	return c
+}
+
+func isMacAddress(address string) bool {
+	_, err := net.ParseMAC(address)
+	return err == nil
+}

internal/namespaces/instance/v1/custom_privatenics_test.go

@@ -4,6 +4,7 @@ import (
 	"testing"
 
 	"github.com/scaleway/scaleway-cli/v2/internal/core"
+	"github.com/scaleway/scaleway-cli/v2/internal/namespaces/vpc/v1"
 )
 
 func Test_ListNICs(t *testing.T) {
@@ -16,3 +17,34 @@ func Test_ListNICs(t *testing.T) {
 		),
 	}))
 }
+
+func Test_GetPrivateNIC(t *testing.T) {
+	cmds := GetCommands()
+	cmds.Merge(vpc.GetCommands())
+
+	t.Run("Get from ID", core.Test(&core.TestConfig{
+		Commands: cmds,
+		BeforeFunc: core.BeforeFuncCombine(
+			createPN(),
+			createServer("Server"),
+			createNIC(),
+		),
+		Cmd: "scw instance private-nic get server-id={{ .Server.ID }} private-nic-id={{ .NIC.PrivateNic.ID }}",
+		Check: core.TestCheckCombine(
+			core.TestCheckGolden(),
+		),
+	}))
+
+	t.Run("Get from MAC address", core.Test(&core.TestConfig{
+		Commands: cmds,
+		BeforeFunc: core.BeforeFuncCombine(
+			createPN(),
+			createServer("Server"),
+			createNIC(),
+		),
+		Cmd: "scw instance private-nic get server-id={{ .Server.ID }} private-nic-id={{ .NIC.PrivateNic.MacAddress }}",
+		Check: core.TestCheckCombine(
+			core.TestCheckGolden(),
+		),
+	}))
+}

internal/namespaces/instance/v1/helpers_test.go

@@ -135,3 +135,17 @@ func deleteSecurityGroup(metaKey string) core.AfterFunc {
 func deleteSnapshot(metaKey string) core.AfterFunc {
 	return core.ExecAfterCmd("scw instance snapshot delete {{ ." + metaKey + ".Snapshot.ID }}")
 }
+
+func createPN() core.BeforeFunc {
+	return core.ExecStoreBeforeCmd(
+		"PN",
+		"scw vpc private-network create",
+	)
+}
+
+func createNIC() core.BeforeFunc {
+	return core.ExecStoreBeforeCmd(
+		"NIC",
+		"scw instance private-nic create server-id={{ .Server.ID }} private-network-id={{ .PN.ID }}",
+	)
+}

internal/namespaces/instance/v1/testdata/test-get-private-nic-get-from-id.cassette.yaml

@@ -0,0 +1,17 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟩🟩🟩 STDOUT️ 🟩🟩🟩️
+PrivateNic.ID                528c9810-73cd-4322-bb15-8ae2d9774ed6
+PrivateNic.ServerID          72bdf9f6-f398-43fb-94f5-645a7cb2683a
+PrivateNic.PrivateNetworkID  b2fe1ee6-93ad-474d-b350-b5f3462e1969
+PrivateNic.MacAddress        02:00:00:11:e0:f1
+PrivateNic.State             available
+🟩🟩🟩 JSON STDOUT 🟩🟩🟩
+{
+  "private_nic": {
+    "id": "528c9810-73cd-4322-bb15-8ae2d9774ed6",
+    "server_id": "72bdf9f6-f398-43fb-94f5-645a7cb2683a",
+    "private_network_id": "b2fe1ee6-93ad-474d-b350-b5f3462e1969",
+    "mac_address": "02:00:00:11:e0:f1",
+    "state": "available"
+  }
+}