fix: handle optional flags correctly in VRF route update

Author: ctreatma

internal/vrf/updateroute.go

@@ -29,10 +29,16 @@ func (c *Client) UpdateRoute() *cobra.Command {
 			inc := []string{}
 			exc := []string{}
 
-			vrfRouteUpdateInput := metalv1.VrfRouteUpdateInput{
-				Prefix:  &prefix,
-				NextHop: &nextHop,
-				Tags:    tags,
+			vrfRouteUpdateInput := metalv1.VrfRouteUpdateInput{}
+
+			if prefix != "" {
+				vrfRouteUpdateInput.Prefix = &prefix
+			}
+			if nextHop != "" {
+				vrfRouteUpdateInput.NextHop = &nextHop
+			}
+			if cmd.Flag("tags").Changed {
+				vrfRouteUpdateInput.Tags = tags
 			}
 
 			vrfRoute, _, err := c.Service.UpdateVrfRouteById(context.Background(), vrfID).VrfRouteUpdateInput(vrfRouteUpdateInput).Include(c.Servicer.Includes(inc)).Exclude(c.Servicer.Excludes(exc)).Execute()

test/e2e/vrfstest/vrf_route_test.go

@@ -5,6 +5,7 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/equinix/equinix-sdk-go/services/metalv1"
 	root "github.com/equinix/metal-cli/internal/cli"
 	outputPkg "github.com/equinix/metal-cli/internal/outputs"
 	"github.com/equinix/metal-cli/internal/vrf"
@@ -113,10 +114,6 @@ func TestCli_Vrf_Route(t *testing.T) {
 			},
 			want: &cobra.Command{},
 			cmdFunc: func(t *testing.T, c *cobra.Command) {
-				// Actually user have to wait for 5 min to updae the VRF-routes. This test case is skipped intentionally
-				if true {
-					t.Skip("Skipping this test because someCondition is true")
-				}
 				root := c.Root()
 
 				projName := "metal-cli-" + randName + "-vrf-list-test"
@@ -128,19 +125,19 @@ func TestCli_Vrf_Route(t *testing.T) {
 
 					ipReservation := helper.CreateTestVrfIpRequest(t, projectId.GetId(), vrf.GetId())
 					_ = helper.CreateTestVrfGateway(t, projectId.GetId(), ipReservation.VrfIpReservation.GetId(), vlan.GetId())
-					_ = helper.CreateTestVrfRoute(t, vrf.GetId())
+					route := helper.CreateTestVrfRoute(t, vrf.GetId())
 
-					if vlan.GetId() != "" && vrf.GetId() != "" {
-						root.SetArgs([]string{subCommand, "update-route", "-i", vrf.GetId(), "-t", "foobar"})
+					_ := helper.WaitForVrfRouteState(t, route.GetId(), metalv1.VRFROUTESTATUS_ACTIVE)
 
-						out := helper.ExecuteAndCaptureOutput(t, root)
+					root.SetArgs([]string{subCommand, "update-route", "-i", route.GetId(), "-t", "foobar"})
 
-						if !strings.Contains(string(out[:]), "TYPE") &&
-							!strings.Contains(string(out[:]), "static") &&
-							!strings.Contains(string(out[:]), "PREFIX") &&
-							!strings.Contains(string(out[:]), "0.0.0.0/0") {
-							t.Error("expected output should include TYPE static PREFIX and 0.0.0.0/0, in the out string ")
-						}
+					out := helper.ExecuteAndCaptureOutput(t, root)
+
+					if !strings.Contains(string(out[:]), "TYPE") &&
+						!strings.Contains(string(out[:]), "static") &&
+						!strings.Contains(string(out[:]), "PREFIX") &&
+						!strings.Contains(string(out[:]), "0.0.0.0/0") {
+						t.Error("expected output should include TYPE static PREFIX and 0.0.0.0/0, in the out string ")
 					}
 				}
 			},

test/helper/helper.go

@@ -188,6 +188,33 @@ func WaitForDeviceState(t *testing.T, deviceId string, states ...metalv1.DeviceS
 	return false, fmt.Errorf("timed out waiting for device %v state %v to become one of %v", deviceId, device.GetState(), states)
 }
 
+func WaitForVrfRouteState(t *testing.T, routeId string, statuses ...metalv1.VrfRouteStatus) bool {
+	var route *metalv1.VrfRoute
+	var err error
+	t.Helper()
+	predefinedTime := 900 * time.Second // Adjust this as needed
+	retryInterval := 10 * time.Second   // Adjust this as needed
+	startTime := time.Now()
+	client := TestClient()
+	for time.Since(startTime) < predefinedTime {
+		route, _, err = client.VRFsApi.FindVrfRouteById(context.Background(), routeId).Execute()
+		if err != nil {
+			t.Fatal(err)
+			return false
+		}
+		for _, status := range statuses {
+			if route.GetStatus() == status {
+				return true
+			}
+		}
+
+		// Sleep for the specified interval
+		time.Sleep(retryInterval)
+	}
+	t.Fatalf("timed out waiting for VRF route %v status %v to become one of %v", routeId, route.GetStatus(), statuses)
+	return false
+}
+
 func WaitForAttachVlanToPort(t *testing.T, portId string, attach bool) error {
 	t.Helper()
 	ticker := time.NewTicker(5 * time.Second)