UpdateGuestNetworkInterface -> UpdateGuestNetworkInterfaceRateLimit

UpdateGuestNetworkInterface() takes ifaceID twice, as its second
parameter (as a string) and the third parameter (as a part of
PartialNetworkInterface).

While that is technically coming from Firecracker's OpenAPI spec.
This is odd and error-prone.

Instead this change introduces UpdateGuestNetworkInterfaceRateLimit()
which only takes ifaceID as its second parameter.

Author: kzys

machine.go

@@ -192,6 +192,14 @@ type NetworkInterface struct {
 	OutRateLimiter *models.RateLimiter
 }
 
+// RateLimiterSet represents a pair of RateLimiters (inbound and outbound)
+type RateLimiterSet struct {
+	// InRateLimiter limits the incoming bytes.
+	InRateLimiter *models.RateLimiter
+	// OutRateLimiter limits the outgoing bytes.
+	OutRateLimiter *models.RateLimiter
+}
+
 // VsockDevice represents a vsock connection between the host and the guest
 // microVM.
 type VsockDevice struct {
@@ -564,8 +572,17 @@ func (m *Machine) createNetworkInterface(ctx context.Context, iface NetworkInter
 	return err
 }
 
-// UpdateGuestNetworkInterface modifies the current guest network interface of ID index
-func (m *Machine) UpdateGuestNetworkInterface(ctx context.Context, ifaceID string, iface models.PartialNetworkInterface, opts ...PatchGuestNetworkInterfaceByIDOpt) error {
+// UpdateGuestNetworkInterfaceRateLimit modifies the specified network interface's rate limits
+func (m *Machine) UpdateGuestNetworkInterfaceRateLimit(ctx context.Context, ifaceID string, rateLimiters RateLimiterSet, opts ...PatchGuestNetworkInterfaceByIDOpt) error {
+	iface := models.PartialNetworkInterface{
+		IfaceID: &ifaceID,
+	}
+	if rateLimiters.InRateLimiter != nil {
+		iface.RxRateLimiter = rateLimiters.InRateLimiter
+	}
+	if rateLimiters.OutRateLimiter != nil {
+		iface.TxRateLimiter = rateLimiters.InRateLimiter
+	}
 	if _, err := m.client.PatchGuestNetworkInterfaceByID(ctx, ifaceID, &iface, opts...); err != nil {
 		m.logger.Errorf("Update network interface failed: %s: %v", ifaceID, err)
 		return err

machine_test.go

@@ -499,7 +499,13 @@ func testUpdateGuestDrive(ctx context.Context, t *testing.T, m *Machine) {
 }
 
 func testUpdateGuestNetworkInterface(ctx context.Context, t *testing.T, m *Machine) {
-	if err := m.UpdateGuestNetworkInterface(ctx, "1", models.PartialNetworkInterface{IfaceID: String("1")}); err != nil {
+	rateLimitSet := RateLimiterSet{
+		InRateLimiter: NewRateLimiter(
+			TokenBucketBuilder{}.WithBucketSize(10).WithRefillDuration(10).Build(),
+			TokenBucketBuilder{}.WithBucketSize(10).WithRefillDuration(10).Build(),
+		),
+	}
+	if err := m.UpdateGuestNetworkInterfaceRateLimit(ctx, "1", rateLimitSet); err != nil {
 		t.Fatalf("Failed to update the network interface %v", err)
 	}
 }

machineiface.go

@@ -15,8 +15,6 @@ package firecracker
 
 import (
 	"context"
-
-	models "github.com/firecracker-microvm/firecracker-go-sdk/client/models"
 )
 
 // This ensures the interface method signatures match that of Machine
@@ -31,5 +29,5 @@ type MachineIface interface {
 	Wait(context.Context) error
 	SetMetadata(context.Context, interface{}) error
 	UpdateGuestDrive(context.Context, string, string, ...PatchGuestDriveByIDOpt) error
-	UpdateGuestNetworkInterface(context.Context, string, models.PartialNetworkInterface, ...PatchGuestNetworkInterfaceByIDOpt) error
+	UpdateGuestNetworkInterfaceRateLimit(context.Context, string, RateLimiterSet, ...PatchGuestNetworkInterfaceByIDOpt) error
 }