Project: Linode Interfaces (#735)

* Implement changes for account APIs (#715)

* Implement changes for account APIs

* Cleanup and re-add tests

* gofumpt

* Add availability notice

* Added support for `networking/` and `vpcs/` endpoint changs for VPC Linodes Enhanced Interfaces (#727)

* Added support for networking/firewalls related changes

* Added support for Networking IPs and VPC changes

* Addressed PR comments

* Add support for firewall template (#726)

* Add firewall template functions

* Add integration tests

* Fix inline doc

* Adding VPC Enhanced Interfaces (#724)

## 📝 Description

**What does this PR do and why is this change necessary?**

Initial additions for interfaces

## ✔️ How to Test

**How do I run the relevant unit/integration tests?**

```bash
make test-unit
```

* Linode instance changes for Linode Interfaces (#723)

* Add linode instance changes for linode interfaces

* Fix interface structs

* Add tests

* go work sum

* Make default firewall IDs pointers (#765)

* Add DoublePointer helper function

* Remove duplicated DoublePointer in test

* Fix

* Add DoublePointerNull

* lint

* Make nullable default firewall IDs pointer

* Make default firewall IDs in update options double pointers

* Update unit test to utilize DoublePointer helper func

* Firewall Related integration tests  (#760)

* firewall_tests

* fix

* fix

* fix_format

* fixPRcomments

* fix

* Linode Interfaces: Consolidate InterfaceGeneration and LinodeInterfaces fields into InstanceCreateOptions (#759)

* Consolidate InterfaceGeneration and LinodeInterfaces fields into InstanceCreateOptions

* Add network_helper to create opts

* Add unmarshal

* Re-run fixtures

* Fix various issues

* Fix firewall settings tests (#772)

* Make interface optional fields pointers (#773)

* Fix firewall settings tests

* Make optional fields pointers for Linode interface structs

* Rename Label field to VLANLabel to align with API attribute naming

* golangci-lint run --fix

* fix a comment

* Nullable default firewall ids (#776)

* Make default_firewall_ids nullable

* Fix unit test

* Add future breaking change notice for ConfigID in VPC IP (#775)

* Add future breaking change notice for ConfigID in VPC IP

* Update wording

* Make FirewallID in linode interface creation options a double ptr (#792)

* Make FirewallID in linode interface creation options a double ptr

* golangci-lint fmt

* Refresh the monthly transfer test fixture

* Make `address` of interface ipv4 optional (#804)

* Make `address` of interface ipv4 optional

* Update test

* Add omitempty

---------

Co-authored-by: Erik Zilber <[email protected]>
Co-authored-by: Jacob Riddle <[email protected]>
Co-authored-by: Vinay <[email protected]>
Co-authored-by: Lena Garber <[email protected]>

Author: 5 people

account_settings.go

@@ -4,6 +4,15 @@ import (
 	"context"
 )
 
+type InterfacesForNewLinodes string
+
+const (
+	LegacyConfigOnly                    InterfacesForNewLinodes = "legacy_config_only"
+	LegacyConfigDefaultButLinodeAllowed InterfacesForNewLinodes = "legacy_config_default_but_linode_allowed"
+	LinodeDefaultButLegacyConfigAllowed InterfacesForNewLinodes = "linode_default_but_legacy_config_allowed"
+	LinodeOnly                          InterfacesForNewLinodes = "linode_only"
+)
+
 // AccountSettings are the account wide flags or plans that effect new resources
 type AccountSettings struct {
 	// The default backups enrollment status for all new Linodes for all users on the account.  When enabled, backups are mandatory per instance.
@@ -21,6 +30,10 @@ type AccountSettings struct {
 	// A string like "disabled", "suspended", or "active" describing the status of this account’s Object Storage service enrollment.
 	ObjectStorage *string `json:"object_storage"`
 
+	// NOTE: Interfaces for new linode setting may not currently be available to all users.
+	// A new configuration flag defines whether new Linodes can use Linode and/or legacy config interfaces.
+	InterfacesForNewLinodes InterfacesForNewLinodes `json:"interfaces_for_new_linodes"`
+
 	// The slug of the maintenance policy associated with the account.
 	// NOTE: MaintenancePolicy can only be used with v4beta.
 	MaintenancePolicy string `json:"maintenance_policy"`
@@ -34,6 +47,10 @@ type AccountSettingsUpdateOptions struct {
 	// The default network helper setting for all new Linodes and Linode Configs for all users on the account.
 	NetworkHelper *bool `json:"network_helper,omitempty"`
 
+	// NOTE: Interfaces for new linode setting may not currently be available to all users.
+	// A new configuration flag defines whether new Linodes can use Linode and/or legacy config interfaces.
+	InterfacesForNewLinodes *InterfacesForNewLinodes `json:"interfaces_for_new_linodes"`
+
 	// The slug of the maintenance policy to set the account to.
 	// NOTE: MaintenancePolicy can only be used with v4beta.
 	MaintenancePolicy *string `json:"maintenance_policy,omitempty"`

firewall_devices.go

@@ -15,6 +15,7 @@ type FirewallDeviceType string
 const (
 	FirewallDeviceLinode       FirewallDeviceType = "linode"
 	FirewallDeviceNodeBalancer FirewallDeviceType = "nodebalancer"
+	FirewallDeviceInterface    FirewallDeviceType = "interface"
 )
 
 // FirewallDevice represents a device governed by a Firewall

firewall_templates.go

@@ -0,0 +1,23 @@
+package linodego
+
+import (
+	"context"
+)
+
+type FirewallTemplate struct {
+	Slug  string          `json:"slug"`
+	Rules FirewallRuleSet `json:"rules"`
+}
+
+// NOTE: This feature may not currently be available to all users.
+// GetFirewallTemplate gets a FirewallTemplate given a slug.
+func (c *Client) GetFirewallTemplate(ctx context.Context, slug string) (*FirewallTemplate, error) {
+	e := formatAPIPath("networking/firewalls/templates/%s", slug)
+	return doGETRequest[FirewallTemplate](ctx, c, e)
+}
+
+// NOTE: This feature may not currently be available to all users.
+// ListFirewallTemplates gets all available firewall templates for the account.
+func (c *Client) ListFirewallTemplates(ctx context.Context, opts *ListOptions) ([]FirewallTemplate, error) {
+	return getPaginatedResults[FirewallTemplate](ctx, c, "networking/firewalls/templates", opts)
+}

firewalls.go

@@ -33,6 +33,7 @@ type Firewall struct {
 type DevicesCreationOptions struct {
 	Linodes       []int `json:"linodes,omitempty"`
 	NodeBalancers []int `json:"nodebalancers,omitempty"`
+	Interfaces    []int `json:"interfaces,omitempty"`
 }
 
 // FirewallCreateOptions fields are those accepted by CreateFirewall
@@ -50,6 +51,31 @@ type FirewallUpdateOptions struct {
 	Tags   *[]string      `json:"tags,omitempty"`
 }
 
+// FirewallSettings represents the default firewalls for Linodes,
+// Linode VPC and public interfaces, and NodeBalancers.
+type FirewallSettings struct {
+	DefaultFirewallIDs DefaultFirewallIDs `json:"default_firewall_ids"`
+}
+
+type DefaultFirewallIDs struct {
+	Linode          *int `json:"linode"`
+	NodeBalancer    *int `json:"nodebalancer"`
+	PublicInterface *int `json:"public_interface"`
+	VPCInterface    *int `json:"vpc_interface"`
+}
+
+// FirewallSettingsUpdateOptions is an options struct used when Updating FirewallSettings
+type FirewallSettingsUpdateOptions struct {
+	DefaultFirewallIDs *DefaultFirewallIDsOptions `json:"default_firewall_ids,omitempty"`
+}
+
+type DefaultFirewallIDsOptions struct {
+	Linode          **int `json:"linode,omitempty"`
+	NodeBalancer    **int `json:"nodebalancer,omitempty"`
+	PublicInterface **int `json:"public_interface,omitempty"`
+	VPCInterface    **int `json:"vpc_interface,omitempty"`
+}
+
 // GetUpdateOptions converts a Firewall to FirewallUpdateOptions for use in Client.UpdateFirewall.
 func (f *Firewall) GetUpdateOptions() FirewallUpdateOptions {
 	return FirewallUpdateOptions{
@@ -109,3 +135,13 @@ func (c *Client) DeleteFirewall(ctx context.Context, firewallID int) error {
 	e := formatAPIPath("networking/firewalls/%d", firewallID)
 	return doDELETERequest(ctx, c, e)
 }
+
+// GetFirewallSettings returns default firewalls for Linodes, Linode VPC and public interfaces, and NodeBalancers.
+func (c *Client) GetFirewallSettings(ctx context.Context) (*FirewallSettings, error) {
+	return doGETRequest[FirewallSettings](ctx, c, "networking/firewalls/settings")
+}
+
+// UpdateFirewallSettings updates the default firewalls for Linodes, Linode VPC and public interfaces, and NodeBalancers.
+func (c *Client) UpdateFirewallSettings(ctx context.Context, opts FirewallSettingsUpdateOptions) (*FirewallSettings, error) {
+	return doPUTRequest[FirewallSettings](ctx, c, "networking/firewalls/settings", opts)
+}

instance_ips.go

@@ -21,17 +21,18 @@ type InstanceIPv4Response struct {
 
 // InstanceIP represents an Instance IP with additional DNS and networking details
 type InstanceIP struct {
-	Address    string             `json:"address"`
-	Gateway    string             `json:"gateway"`
-	SubnetMask string             `json:"subnet_mask"`
-	Prefix     int                `json:"prefix"`
-	Type       InstanceIPType     `json:"type"`
-	Public     bool               `json:"public"`
-	RDNS       string             `json:"rdns"`
-	LinodeID   int                `json:"linode_id"`
-	Region     string             `json:"region"`
-	VPCNAT1To1 *InstanceIPNAT1To1 `json:"vpc_nat_1_1"`
-	Reserved   bool               `json:"reserved"`
+	Address     string             `json:"address"`
+	Gateway     string             `json:"gateway"`
+	SubnetMask  string             `json:"subnet_mask"`
+	Prefix      int                `json:"prefix"`
+	Type        InstanceIPType     `json:"type"`
+	Public      bool               `json:"public"`
+	RDNS        string             `json:"rdns"`
+	LinodeID    int                `json:"linode_id"`
+	InterfaceID *int               `json:"interface_id"`
+	Region      string             `json:"region"`
+	VPCNAT1To1  *InstanceIPNAT1To1 `json:"vpc_nat_1_1"`
+	Reserved    bool               `json:"reserved"`
 }
 
 // VPCIP represents a private IP address in a VPC subnet with additional networking details
@@ -47,8 +48,10 @@ type VPCIP struct {
 	NAT1To1      *string `json:"nat_1_1"`
 	VPCID        int     `json:"vpc_id"`
 	SubnetID     int     `json:"subnet_id"`
-	ConfigID     int     `json:"config_id"`
 	InterfaceID  int     `json:"interface_id"`
+
+	// The type of this field will be made a pointer in the next major release of linodego.
+	ConfigID int `json:"config_id"`
 }
 
 // InstanceIPv6Response contains the IPv6 addresses and ranges for an Instance

instances.go

@@ -3,6 +3,7 @@ package linodego
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 	"net"
 	"time"
 
@@ -180,23 +181,32 @@ type InstancePasswordResetOptions struct {
 
 // InstanceCreateOptions require only Region and Type
 type InstanceCreateOptions struct {
-	Region              string                                 `json:"region"`
-	Type                string                                 `json:"type"`
-	Label               string                                 `json:"label,omitempty"`
-	RootPass            string                                 `json:"root_pass,omitempty"`
-	AuthorizedKeys      []string                               `json:"authorized_keys,omitempty"`
-	AuthorizedUsers     []string                               `json:"authorized_users,omitempty"`
-	StackScriptID       int                                    `json:"stackscript_id,omitempty"`
-	StackScriptData     map[string]string                      `json:"stackscript_data,omitempty"`
-	BackupID            int                                    `json:"backup_id,omitempty"`
-	Image               string                                 `json:"image,omitempty"`
-	Interfaces          []InstanceConfigInterfaceCreateOptions `json:"interfaces,omitempty"`
-	BackupsEnabled      bool                                   `json:"backups_enabled,omitempty"`
-	PrivateIP           bool                                   `json:"private_ip,omitempty"`
-	Tags                []string                               `json:"tags,omitempty"`
-	Metadata            *InstanceMetadataOptions               `json:"metadata,omitempty"`
-	FirewallID          int                                    `json:"firewall_id,omitempty"`
-	InterfaceGeneration InterfaceGeneration                    `json:"interface_generation,omitempty"`
+	Region              string                   `json:"region"`
+	Type                string                   `json:"type"`
+	Label               string                   `json:"label,omitempty"`
+	RootPass            string                   `json:"root_pass,omitempty"`
+	AuthorizedKeys      []string                 `json:"authorized_keys,omitempty"`
+	AuthorizedUsers     []string                 `json:"authorized_users,omitempty"`
+	StackScriptID       int                      `json:"stackscript_id,omitempty"`
+	StackScriptData     map[string]string        `json:"stackscript_data,omitempty"`
+	BackupID            int                      `json:"backup_id,omitempty"`
+	Image               string                   `json:"image,omitempty"`
+	BackupsEnabled      bool                     `json:"backups_enabled,omitempty"`
+	PrivateIP           bool                     `json:"private_ip,omitempty"`
+	NetworkHelper       *bool                    `json:"network_helper,omitempty"`
+	Tags                []string                 `json:"tags,omitempty"`
+	Metadata            *InstanceMetadataOptions `json:"metadata,omitempty"`
+	FirewallID          int                      `json:"firewall_id,omitempty"`
+	InterfaceGeneration InterfaceGeneration      `json:"interface_generation,omitempty"`
+
+	// Linode Interfaces to create the new instance with.
+	// Conflicts with Interfaces.
+	// NOTE: Linode Interfaces may not currently be available to all users.
+	LinodeInterfaces []LinodeInterfaceCreateOptions `json:"-"`
+
+	// Legacy (config) Interfaces to create the new instance with.
+	// Conflicts with LinodeInterfaces.
+	Interfaces []InstanceConfigInterfaceCreateOptions `json:"-"`
 
 	// NOTE: Disk encryption may not currently be available to all users.
 	DiskEncryption InstanceDiskEncryption `json:"disk_encryption,omitempty"`
@@ -238,6 +248,83 @@ type InstanceUpdateOptions struct {
 	MaintenancePolicy *string `json:"maintenance_policy,omitempty"`
 }
 
+// MarshalJSON contains logic necessary to populate the `interfaces` field of
+// InstanceCreateOptions depending on whether Interfaces or LinodeInterfaces
+// is specified.
+func (i InstanceCreateOptions) MarshalJSON() ([]byte, error) {
+	type Mask InstanceCreateOptions
+
+	resultData := struct {
+		*Mask
+
+		Interfaces any `json:"interfaces,omitempty"`
+	}{
+		Mask:       (*Mask)(&i),
+		Interfaces: nil,
+	}
+
+	if i.Interfaces != nil && i.LinodeInterfaces != nil {
+		return nil, fmt.Errorf("fields Interfaces and LinodeInterfaces cannot be specified together")
+	}
+
+	if i.Interfaces != nil {
+		resultData.Interfaces = i.Interfaces
+	}
+
+	if i.LinodeInterfaces != nil {
+		resultData.Interfaces = i.LinodeInterfaces
+	}
+
+	return json.Marshal(resultData)
+}
+
+// UnmarshalJSON contains logic necessary to populate the Interfaces field
+// depending on the value of interface_generation.
+func (i *InstanceCreateOptions) UnmarshalJSON(b []byte) error {
+	type Mask InstanceCreateOptions
+
+	p := struct {
+		*Mask
+
+		GenericInterfaces any `json:"interfaces,omitempty"`
+	}{
+		Mask: (*Mask)(i),
+	}
+
+	if err := json.Unmarshal(b, &p); err != nil {
+		return err
+	}
+
+	if p.GenericInterfaces == nil {
+		// No interfaces were given - nothing to do here.
+		return nil
+	}
+
+	if i.InterfaceGeneration == GenerationLinode {
+		data := struct {
+			Interfaces []LinodeInterfaceCreateOptions `json:"interfaces"`
+		}{}
+
+		err := json.Unmarshal(b, &data)
+		i.LinodeInterfaces = data.Interfaces
+
+		return err
+	}
+
+	if i.InterfaceGeneration == GenerationLegacyConfig {
+		data := struct {
+			Interfaces []InstanceConfigInterfaceCreateOptions `json:"interfaces"`
+		}{}
+
+		err := json.Unmarshal(b, &data)
+		i.Interfaces = data.Interfaces
+
+		return err
+	}
+
+	return fmt.Errorf("cannot unmarshal interfaces without valid value for interface_generation")
+}
+
 // UnmarshalJSON implements the json.Unmarshaler interface
 func (i *Instance) UnmarshalJSON(b []byte) error {
 	type Mask Instance