TPT-4234: Fix firewall device for linode interfaces and add entities field to firewall (#901)

* Fix firewall device for linode interfaces#829

* Fix unit test

* Update the unit test

* feat: add entities field to Firewall struct and define FirewallEntity type

* Fix unit test

* Integration test update

* Apply suggestion from @Copilot

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update FirewallDeviceEntity and tests

* Reuse FirewallDeviceEntity

* fmt

* Fix test

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Michal Wojcik <32574975+mgwoj@users.noreply.github.com>

Author: 3 people

firewall_devices.go

@@ -57,10 +57,11 @@ func (device *FirewallDevice) UnmarshalJSON(b []byte) error {
 
 // FirewallDeviceEntity contains information about a device associated with a Firewall
 type FirewallDeviceEntity struct {
-	ID    int                `json:"id"`
-	Type  FirewallDeviceType `json:"type"`
-	Label string             `json:"label"`
-	URL   string             `json:"url"`
+	ID           int                   `json:"id"`
+	Type         FirewallDeviceType    `json:"type"`
+	Label        string                `json:"label"`
+	URL          string                `json:"url"`
+	ParentEntity *FirewallDeviceEntity `json:"parent_entity"`
 }
 
 // ListFirewallDevices get devices associated with a given Firewall

firewalls.go

@@ -20,20 +20,21 @@ const (
 
 // A Firewall is a set of networking rules (iptables) applied to Devices with which it is associated
 type Firewall struct {
-	ID      int             `json:"id"`
-	Label   string          `json:"label"`
-	Status  FirewallStatus  `json:"status"`
-	Tags    []string        `json:"tags,omitempty"`
-	Rules   FirewallRuleSet `json:"rules"`
-	Created *time.Time      `json:"-"`
-	Updated *time.Time      `json:"-"`
+	ID       int                    `json:"id"`
+	Label    string                 `json:"label"`
+	Status   FirewallStatus         `json:"status"`
+	Tags     []string               `json:"tags"`
+	Rules    FirewallRuleSet        `json:"rules"`
+	Entities []FirewallDeviceEntity `json:"entities"`
+	Created  *time.Time             `json:"-"`
+	Updated  *time.Time             `json:"-"`
 }
 
 // DevicesCreationOptions fields are used when adding devices during the Firewall creation process.
 type DevicesCreationOptions struct {
-	Linodes       []int `json:"linodes,omitempty"`
-	NodeBalancers []int `json:"nodebalancers,omitempty"`
-	Interfaces    []int `json:"interfaces,omitempty"`
+	Linodes          []int `json:"linodes,omitempty"`
+	NodeBalancers    []int `json:"nodebalancers,omitempty"`
+	LinodeInterfaces []int `json:"linode_interfaces,omitempty"`
 }
 
 // FirewallCreateOptions fields are those accepted by CreateFirewall

test/integration/firewalls_devices_test.go

@@ -24,6 +24,22 @@ func TestFirewallDevices_List_smoke(t *testing.T) {
 	}
 	defer teardownFirewall()
 
+	if len(firewall.Entities) != 1 {
+		t.Errorf("expected exactly 1 firewall entity on create response, got %d", len(firewall.Entities))
+	}
+
+	if len(firewall.Entities) > 0 {
+		if firewall.Entities[0].Type != linodego.FirewallDeviceLinode {
+			t.Errorf("expected entity type %q, got %q", linodego.FirewallDeviceLinode, firewall.Entities[0].Type)
+		}
+		if firewall.Entities[0].ID != instance.ID {
+			t.Errorf("expected entity id %d, got %d", instance.ID, firewall.Entities[0].ID)
+		}
+		if firewall.Entities[0].ParentEntity != nil {
+			t.Errorf("expected parent entity to be nil for a linode device, got %+v", firewall.Entities[0].ParentEntity)
+		}
+	}
+
 	firewallDevices, err := client.ListFirewallDevices(context.Background(), firewall.ID, nil)
 	if err != nil {
 		t.Error(err)
@@ -32,6 +48,21 @@ func TestFirewallDevices_List_smoke(t *testing.T) {
 	if len(firewallDevices) != 1 {
 		t.Errorf("expected 1 firewall device but got %d", len(firewallDevices))
 	}
+
+	if len(firewallDevices) > 0 {
+		if firewallDevices[0].Entity.Type != linodego.FirewallDeviceLinode {
+			t.Errorf("expected device entity type %q, got %q", linodego.FirewallDeviceLinode, firewallDevices[0].Entity.Type)
+		}
+		if firewallDevices[0].Entity.ID != instance.ID {
+			t.Errorf("expected device entity id %d, got %d", instance.ID, firewallDevices[0].Entity.ID)
+		}
+		if firewallDevices[0].Entity.Label == "" {
+			t.Error("expected non-empty device entity label")
+		}
+		if firewallDevices[0].Entity.ParentEntity != nil {
+			t.Errorf("expected parent entity to be nil for a linode device, got %+v", firewallDevices[0].Entity.ParentEntity)
+		}
+	}
 }
 
 func TestFirewallDevice_Get(t *testing.T) {
@@ -59,6 +90,31 @@ func TestFirewallDevice_Get(t *testing.T) {
 		t.Error(err)
 	} else if !cmp.Equal(device, firewallDevice) {
 		t.Errorf("expected device to match create result but got diffs: %s", cmp.Diff(device, firewallDevice))
+	} else {
+		if device.Entity.Label == "" {
+			t.Error("expected non-empty device entity label")
+		}
+		if device.Entity.ParentEntity != nil {
+			t.Errorf("expected parent entity to be nil for a linode device, got %+v", device.Entity.ParentEntity)
+		}
+	}
+
+	refreshedFirewall, err := client.GetFirewall(context.Background(), firewall.ID)
+	if err != nil {
+		t.Error(err)
+	}
+
+	if len(refreshedFirewall.Entities) != 1 {
+		t.Errorf("expected exactly 1 firewall entity after device attach, got %d", len(refreshedFirewall.Entities))
+	}
+
+	if len(refreshedFirewall.Entities) > 0 {
+		if refreshedFirewall.Entities[0].Type != linodego.FirewallDeviceLinode {
+			t.Errorf("expected entity type %q, got %q", linodego.FirewallDeviceLinode, refreshedFirewall.Entities[0].Type)
+		}
+		if refreshedFirewall.Entities[0].ID != instance.ID {
+			t.Errorf("expected entity id %d, got %d", instance.ID, refreshedFirewall.Entities[0].ID)
+		}
 	}
 }
 

test/integration/firewalls_test.go

@@ -77,6 +77,10 @@ func TestFirewall_Get(t *testing.T) {
 		t.Errorf("failed to get newly created firewall %d: %s", created.ID, err)
 	}
 
+	if len(result.Entities) != 0 {
+		t.Errorf("expected no firewall entities for a newly created firewall, got %d", len(result.Entities))
+	}
+
 	if result.Rules.Inbound[0].Label != rules.Inbound[0].Label {
 		t.Errorf("Expected firewall rules to be %#v but got %#v", rules, result.Rules)
 	}
@@ -120,6 +124,10 @@ func TestFirewall_Update(t *testing.T) {
 		t.Error(err)
 	}
 
+	if len(updated.Entities) != 0 {
+		t.Errorf("expected no firewall entities after update, got %d", len(updated.Entities))
+	}
+
 	if !cmp.Equal(updated.Tags, *updateOpts.Tags) {
 		t.Errorf("expected tags to be updated: %s", cmp.Diff(updated.Tags, *updateOpts.Tags))
 	}