Add documentation for IPv6 in ipsubnet filter. Add unit tests

changelogs/fragments/add_ipfilter_doc_ut.yaml

@@ -0,0 +1,5 @@
+---
+trivial:
+  - Add example for IPv6 in ipsubnet filter documentation.
+  - Fix typo in ipsubnet documentation.
+  - Add unit tests for ipsubnet filter.

plugins/filter/ipsubnet.py

@@ -75,6 +75,8 @@ class mac_linux(netaddr.mac_unix):
 vars:
     address: '192.168.144.5'
     subnet: '192.168.0.0/16'
+    ipv6_address: '2001:4860:4860::8888'
+    ipv6_subnet: '2600:1f1c:1b3:8f00::/56'
 tasks:
       # If the given string is an IP address, it will be converted into a subnet.
       - name: convert IP address to subnet
@@ -101,6 +103,16 @@ class mac_linux(netaddr.mac_unix):
         debug:
           msg: "{{ subnet | ansible.utils.ipsubnet(20, -1) }}"
 
+      # Get a new subnet with the specified index.
+      - name: Get first IPv6 subnet that has prefix length /120
+        debug:
+          msg: "{{ ipv6_subnet | ansible.utils.ipsubnet(120, 0) }}"
+
+      # Get a new subnet with the specified index.
+      - name: Get last subnet that has prefix length /120
+        debug:
+          msg: "{{ ipv6_subnet | ansible.utils.ipsubnet(120, -1) }}"
+
       # If you specify an IP address instead of a subnet, and give a subnet size as the first argument, the ipsubnet() |
       # filter will instead return the biggest subnet that contains that given IP address.
       - name: Get biggest subnet that contains that given IP address.
@@ -137,7 +149,7 @@ class mac_linux(netaddr.mac_unix):
 
       # By specifying another subnet as a second argument, if the second subnet includes the first, you can determine |
       # the rank of the first subnet in the second.
-      - name: he fifth subnet /30 in a /24
+      - name: The fifth subnet /30 in a /24
         debug:
           msg: "{{ '192.168.144.16/30' | ansible.utils.ipsubnet('192.168.144.0/24') }}"
 

tests/unit/plugins/filter/test_ipsubnet.py

@@ -94,3 +94,26 @@ def test_ipvsubnet_filter_rank_address_in_subnet3(self):
         args = ["", "192.168.144.16/30", "192.168.144.0/24"]
         result = _ipsubnet(*args)
         self.assertEqual(result, "5")
+
+    def test_ipvsubnet_get_subnet(self):
+        test_cases = [
+            [["", "2600:1f1c:1b3:8f00::/56", 64, 0], "2600:1f1c:1b3:8f00::/64"],
+            [["", "2600:1f1c:1b3:8f00::/56", "64", "1"], "2600:1f1c:1b3:8f01::/64"],
+            [["", "2600:1f1c:1b3:8f00::/56", "64", "2"], "2600:1f1c:1b3:8f02::/64"],
+            [["", "2600:1f1c:1b3:8f00::/56", "64", "-2"], "2600:1f1c:1b3:8ffe::/64"],
+            [["", "2600:1f1c:1b3:8f00::/56", "64", "-1"], "2600:1f1c:1b3:8fff::/64"],
+            [["", "2600:1f1c:1b3:8f00::/56", "65", "0"], "2600:1f1c:1b3:8f00::/65"],
+            [["", "2600:1f1c:1b3:8f00::/56", "65", "1"], "2600:1f1c:1b3:8f00:8000::/65"],
+            [["", "2600:1f1c:1b3:8f00::/56", "65", "2"], "2600:1f1c:1b3:8f01::/65"],
+            [["", "2600:1f1c:1b3:8f00::/56", "65", "-2"], "2600:1f1c:1b3:8fff::/65"],
+            [["", "2600:1f1c:1b3:8f00::/56", "65", "-1"], "2600:1f1c:1b3:8fff:8000::/65"],
+            [["", "2600:1f1c:1b3:8f00::/56", "64", "257"], False],  # subnet id too big for /64
+            [["", "2600:1f1c:1b3:8f00:::/56", "64", "0"], False],  # Too many colons
+            [["", "2600:1f1c:1b3:8f00::/56", "129", "0"], False],  # Must be /128 or less
+        ]
+        for args, expected in test_cases:
+            self.assertEqual(
+                _ipsubnet(*args),
+                expected,
+                msg="Testing {0}".format(args),
+            )