Nodebalancer VPC support (#678)

* Adding the funcs for the List VPC and Get VPC for Nodebalancers endpoints

* Adding test cases  - they don't work until we update some nodebalancer funcs to allow creation of nb with vpc options

* IPv6 can sometime be empty so adding omiempty here

* add vpcs config during nodebalancer create

* update node config as well

* add nb vpc test

* Adding records for fixtures

* add generated fixtures

* fix cleanup failures

* Update the fixture for nb vpc list and get

* fix formatting

* Update nodebalancer_config_vpc.go

Co-authored-by: Lena Garber <114949949+lgarber-akamai@users.noreply.github.com>

* Fix naming

* Adding disclaimer for letting users know this might not be available to everyone

* Remove use of pointers with VPC options

---------

Co-authored-by: Rahul Sharma <rahsharm@akamai.com>
Co-authored-by: Lena Garber <114949949+lgarber-akamai@users.noreply.github.com>
Co-authored-by: Zhiwei Liang <121905282+zliang-akamai@users.noreply.github.com>

Author: 4 people

nodebalancer.go

@@ -44,6 +44,12 @@ type NodeBalancerTransfer struct {
 	In *float64 `json:"in"`
 }
 
+type NodeBalancerVPCOptions struct {
+	IPv4Range string `json:"ipv4_range"`
+	IPv6Range string `json:"ipv6_range,omitempty"`
+	SubnetID  int    `json:"subnet_id"`
+}
+
 // NodeBalancerCreateOptions are the options permitted for CreateNodeBalancer
 type NodeBalancerCreateOptions struct {
 	Label              *string                            `json:"label,omitempty"`
@@ -52,6 +58,7 @@ type NodeBalancerCreateOptions struct {
 	Configs            []*NodeBalancerConfigCreateOptions `json:"configs,omitempty"`
 	Tags               []string                           `json:"tags"`
 	FirewallID         int                                `json:"firewall_id,omitempty"`
+	VPCs               []NodeBalancerVPCOptions           `json:"vpcs,omitempty"`
 }
 
 // NodeBalancerUpdateOptions are the options permitted for UpdateNodeBalancer

nodebalancer_config_nodes.go

@@ -35,10 +35,11 @@ var (
 
 // NodeBalancerNodeCreateOptions fields are those accepted by CreateNodeBalancerNode
 type NodeBalancerNodeCreateOptions struct {
-	Address string   `json:"address"`
-	Label   string   `json:"label"`
-	Weight  int      `json:"weight,omitempty"`
-	Mode    NodeMode `json:"mode,omitempty"`
+	Address  string   `json:"address"`
+	Label    string   `json:"label"`
+	Weight   int      `json:"weight,omitempty"`
+	Mode     NodeMode `json:"mode,omitempty"`
+	SubnetID int      `json:"subnet_id,omitempty"`
 }
 
 // NodeBalancerNodeUpdateOptions fields are those accepted by UpdateNodeBalancerNode

nodebalancer_config_vpc.go

@@ -0,0 +1,28 @@
+package linodego
+
+import (
+	"context"
+)
+
+// NodeBalancerVPCConfig objects represent a VPC config for a NodeBalancer
+// s
+// NOTE: NodeBalancer VPC support may not currently be available to all users.
+type NodeBalancerVPCConfig struct {
+	ID             int    `json:"id"`
+	IPv4Range      string `json:"ipv4_range"`
+	IPv6Range      string `json:"ipv6_range,omitempty"`
+	NodeBalancerID int    `json:"nodebalancer_id"`
+	SubnetID       int    `json:"subnet_id"`
+	VPCID          int    `json:"vpc_id"`
+}
+
+// ListNodeBalancerVPCConfigs lists NodeBalancer VPC configs
+func (c *Client) ListNodeBalancerVPCConfigs(ctx context.Context, nodebalancerID int, opts *ListOptions) ([]NodeBalancerVPCConfig, error) {
+	return getPaginatedResults[NodeBalancerVPCConfig](ctx, c, formatAPIPath("nodebalancers/%d/vpcs", nodebalancerID), opts)
+}
+
+// GetNodeBalancerVPCConfig gets the NodeBalancer VPC config with the specified id
+func (c *Client) GetNodeBalancerVPCConfig(ctx context.Context, nodebalancerID int, vpcID int) (*NodeBalancerVPCConfig, error) {
+	e := formatAPIPath("nodebalancers/%d/vpcs/%d", nodebalancerID, vpcID)
+	return doGETRequest[NodeBalancerVPCConfig](ctx, c, e)
+}

test/integration/fixtures/TestNodeBalancerVpcConfig_Get.yaml

@@ -0,0 +1,49 @@
+package integration
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestNodeBalancerVPCConfig_List(t *testing.T) {
+	client, nodebalancer, teardown, err := setupNodeBalancerWithVPC(t, "fixtures/TestNodeBalancerVpcConfig_List")
+	if err != nil {
+		t.Errorf("Error setting up nodebalancer: %s", err)
+	}
+	defer teardown()
+
+	configs, err := client.ListNodeBalancerVPCConfigs(context.Background(), nodebalancer.ID, nil)
+	if err != nil {
+		t.Errorf("Error listing nodebalancer VPC configs: %s", err)
+	}
+
+	// We expect the list to be not empty and have at least one VPC config
+	require.NotEmpty(t, configs)
+	require.Len(t, configs, 1)
+}
+
+func TestNodeBalancerVPCConfig_Get(t *testing.T) {
+	client, nodebalancer, teardown, err := setupNodeBalancerWithVPC(t, "fixtures/TestNodeBalancerVpcConfig_Get")
+	if err != nil {
+		t.Errorf("Error setting up nodebalancer: %s", err)
+	}
+	defer teardown()
+
+	// Get the VPC config list for the nodebalancer (should only have one)
+	configs, err := client.ListNodeBalancerVPCConfigs(context.Background(), nodebalancer.ID, nil)
+	if err != nil {
+		t.Errorf("Error listing nodebalancer VPC configs: %s", err)
+	}
+	require.NotEmpty(t, configs)
+	require.Len(t, configs, 1)
+
+	// Get the VPC config by ID
+	config, err := client.GetNodeBalancerVPCConfig(context.Background(), nodebalancer.ID, configs[0].ID)
+	if err != nil {
+		t.Errorf("Error getting nodebalancer VPC config: %s", err)
+	}
+	require.NotNil(t, config)
+	require.Equal(t, configs[0].ID, config.ID)
+}

test/integration/fixtures/TestNodeBalancerVpcConfig_List.yaml

@@ -30,6 +30,23 @@ func TestNodeBalancer_Create_create_smoke(t *testing.T) {
 	assertDateSet(t, nodebalancer.Updated)
 }
 
+func TestNodeBalancer_Create_with_vpc(t *testing.T) {
+	_, nodebalancer, teardown, err := setupNodeBalancerWithVPC(t, "fixtures/TestNodeBalancer_With_VPC_Create")
+	defer teardown()
+
+	if err != nil {
+		t.Errorf("Error creating nodebalancer: %v", err)
+	}
+
+	// when comparing fixtures to random value Label will differ, compare the known suffix
+	if !strings.Contains(*nodebalancer.Label, label) {
+		t.Errorf("nodebalancer returned does not match nodebalancer create request")
+	}
+
+	assertDateSet(t, nodebalancer.Created)
+	assertDateSet(t, nodebalancer.Updated)
+}
+
 func TestNodeBalancer_Update(t *testing.T) {
 	client, nodebalancer, teardown, err := setupNodeBalancer(t, "fixtures/TestNodeBalancer_Update")
 	defer teardown()
@@ -104,3 +121,40 @@ func setupNodeBalancer(t *testing.T, fixturesYaml string) (*linodego.Client, *li
 	}
 	return client, nodebalancer, teardown, err
 }
+
+func setupNodeBalancerWithVPC(t *testing.T, fixturesYaml string) (*linodego.Client, *linodego.NodeBalancer, func(), error) {
+	t.Helper()
+	var fixtureTeardown func()
+	client, fixtureTeardown := createTestClient(t, fixturesYaml)
+	vpc, subnet, vpcTeardown, err := createVPCWithSubnet(t, client)
+	if err != nil {
+		t.Errorf("Error creating vpc, got error %v", err)
+	}
+	createOpts := linodego.NodeBalancerCreateOptions{
+		Label:              &label,
+		Region:             vpc.Region,
+		ClientConnThrottle: &clientConnThrottle,
+		FirewallID:         GetFirewallID(),
+		VPCs: []linodego.NodeBalancerVPCOptions{
+			{
+				IPv4Range: "192.168.0.64/30",
+				IPv6Range: "",
+				SubnetID:  subnet.ID,
+			},
+		},
+	}
+
+	nodebalancer, err := client.CreateNodeBalancer(context.Background(), createOpts)
+	if err != nil {
+		t.Fatalf("Error listing nodebalancers, expected struct, got error %v", err)
+	}
+
+	teardown := func() {
+		if err := client.DeleteNodeBalancer(context.Background(), nodebalancer.ID); err != nil {
+			t.Errorf("Expected to delete a nodebalancer, but got %v", err)
+		}
+		vpcTeardown()
+		fixtureTeardown()
+	}
+	return client, nodebalancer, teardown, err
+}