implementation

Author: lgarber-akamai

linode_api4/groups/networking.py

@@ -4,6 +4,7 @@
     VLAN,
     Base,
     Firewall,
+    FirewallTemplate,
     Instance,
     IPAddress,
     IPv6Pool,
@@ -94,6 +95,21 @@ def firewall_create(self, label, rules, **kwargs):
         f = Firewall(self.client, result["id"], result)
         return f
 
+    def firewall_templates(self, *filters):
+        """
+        Returns a list of Firewall Templates available to the current user.
+
+        API Documentation: Not yet available.
+
+        :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
+
+        :returns: A list of Firewall Templates available to the current user.
+        :rtype: PaginatedList of FirewallTemplate
+        """
+        return self.client._get_and_filter(FirewallTemplate, *filters)
+
     def ips(self, *filters):
         """
         Returns a list of IP addresses on this account, excluding private addresses.

linode_api4/objects/networking.py

@@ -307,6 +307,20 @@ def device_create(self, id, type="linode", **kwargs):
         return c
 
 
+class FirewallTemplate(Base):
+    """
+    Represents a single Linode Firewall template.
+
+    API documentation: Not yet available.
+    """
+
+    api_endpoint = "/networking/firewalls/templates/{slug}"
+
+    id_attribute = "slug"
+
+    properties = {"slug": Property(identifier=True), "rules": Property()}
+
+
 class NetworkTransferPrice(Base):
     """
     An NetworkTransferPrice represents the structure of a valid network transfer price.

…tures/networking_firewall_templates.json …ures/networking_firewalls_templates.jsontest/fixtures/networking_firewall_templates.json renamed to test/fixtures/networking_firewalls_templates.json test/fixtures/networking_firewall_templates.json renamed to test/fixtures/networking_firewalls_templates.json

@@ -0,0 +1,17 @@
+from test.unit.base import ClientBaseCase
+from test.unit.objects.firewall_test import FirewallTemplatesTest
+
+
+class NetworkingGroupTest(ClientBaseCase):
+    """
+    Tests methods under the NetworkingGroup class.
+    """
+
+    def test_get_templates(self):
+        templates = self.client.networking.firewall_templates()
+
+        assert templates[0].slug == "public"
+        FirewallTemplatesTest.assert_rules(templates[0].rules)
+
+        assert templates[1].slug == "vpc"
+        FirewallTemplatesTest.assert_rules(templates[1].rules)

…etworking_firewall_templates_public.json …tworking_firewalls_templates_public.jsontest/fixtures/networking_firewall_templates_public.json renamed to test/fixtures/networking_firewalls_templates_public.json test/fixtures/networking_firewall_templates_public.json renamed to test/fixtures/networking_firewalls_templates_public.json

@@ -1,6 +1,6 @@
 from test.unit.base import ClientBaseCase
 
-from linode_api4 import MappedObject
+from linode_api4 import FirewallTemplate, MappedObject
 from linode_api4.objects import Firewall, FirewallDevice
 
 
@@ -85,7 +85,8 @@ def test_get_device(self):
 
 
 class FirewallTemplatesTest(ClientBaseCase):
-    def _assert_rules(self, rules: MappedObject):
+    @staticmethod
+    def assert_rules(rules: MappedObject):
         assert rules.outbound_policy == "DROP"
         assert len(rules.outbound) == 1
 
@@ -95,8 +96,8 @@ def _assert_rules(self, rules: MappedObject):
         outbound_rule = rules.outbound[0]
         assert outbound_rule.action == "ACCEPT"
         assert outbound_rule.addresses.ipv4[0] == "192.0.2.0/24"
-        assert outbound_rule.addresses.ipv4[0] == "198.51.100.2/32"
-        assert outbound_rule.addresses.ipv6[0] == "2001::DB8::/128"
+        assert outbound_rule.addresses.ipv4[1] == "198.51.100.2/32"
+        assert outbound_rule.addresses.ipv6[0] == "2001:DB8::/128"
         assert outbound_rule.description == "test"
         assert outbound_rule.label == "test-rule"
         assert outbound_rule.ports == "22-24, 80, 443"
@@ -105,28 +106,19 @@ def _assert_rules(self, rules: MappedObject):
         inbound_rule = rules.outbound[0]
         assert inbound_rule.action == "ACCEPT"
         assert inbound_rule.addresses.ipv4[0] == "192.0.2.0/24"
-        assert inbound_rule.addresses.ipv4[0] == "198.51.100.2/32"
-        assert inbound_rule.addresses.ipv6[0] == "2001::DB8::/128"
+        assert inbound_rule.addresses.ipv4[1] == "198.51.100.2/32"
+        assert inbound_rule.addresses.ipv6[0] == "2001:DB8::/128"
         assert inbound_rule.description == "test"
         assert inbound_rule.label == "test-rule"
         assert inbound_rule.ports == "22-24, 80, 443"
         assert inbound_rule.protocol == "TCP"
 
-    def test_get_templates(self):
-        templates = self.client.networking.firewall_templates()
-
-        assert templates[0].slug == "public"
-        self._assert_rules(templates[0].rules)
-
-        assert templates[1].slug == "vpc"
-        self._assert_rules(templates[1].rules)
-
-    def test_get_template_public(self):
+    def test_get_public(self):
         template = self.client.load(FirewallTemplate, "public")
         assert template.slug == "public"
-        self._assert_rules(template.rules)
+        self.assert_rules(template.rules)
 
-    def test_get_template_vpc(self):
+    def test_get_vpc(self):
         template = self.client.load(FirewallTemplate, "vpc")
         assert template.slug == "vpc"
-        self._assert_rules(template.rules)
+        self.assert_rules(template.rules)