Merge pull request #317 from linode/dev

Release v5.7.1

Author: zliang-akamai

linode_api4/groups/group.py

@@ -1,3 +1,11 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from linode_api4 import LinodeClient
+
+
 class Group:
-    def __init__(self, client: "LinodeClient"):
+    def __init__(self, client: LinodeClient):
         self.client = client

linode_api4/groups/networking.py

@@ -284,22 +284,32 @@ def ips_share(self, linode, *ips):
 
     def ip_addresses_share(self, ips, linode):
         """
-        Configure shared IPs. P sharing allows IP address reassignment
+        Configure shared IPs. IP sharing allows IP address reassignment
         (also referred to as IP failover) from one Linode to another if the
         primary Linode becomes unresponsive. This means that requests to the primary Linode’s
         IP address can be automatically rerouted to secondary Linodes at the configured shared IP addresses.
 
+        API Documentation: https://www.linode.com/docs/api/networking/#ip-addresses-share
+
         :param linode: The id of the Instance or the Instance to share the IPAddresses with.
                           This Instance will be able to bring up the given addresses.
         :type: linode: int or Instance
-        :param ips: Any number of IPAddresses to share to the Instance.
+        :param ips: Any number of IPAddresses to share to the Instance. Enter an empty array to
+                    remove all shared IP addresses.
         :type ips: str or IPAddress
         """
 
+        shared_ips = []
+        for ip in ips:
+            if isinstance(ip, str):
+                shared_ips.append(ip)
+            elif isinstance(ip, IPAddress):
+                shared_ips.append(ip.address)
+            else:
+                shared_ips.append(str(ip))  # and hope that works
+
         params = {
-            "ips": ips
-            if not isinstance(ips[0], IPAddress)
-            else [ip.address for ip in ips],
+            "ips": shared_ips,
             "linode_id": linode
             if not isinstance(linode, Instance)
             else linode.id,

linode_api4/linode_client.py

@@ -10,8 +10,25 @@
 from requests.adapters import HTTPAdapter, Retry
 
 from linode_api4.errors import ApiError, UnexpectedResponseError
-from linode_api4.groups import *
-from linode_api4.objects import *
+from linode_api4.groups import (
+    AccountGroup,
+    DatabaseGroup,
+    DomainGroup,
+    ImageGroup,
+    LinodeGroup,
+    LKEGroup,
+    LongviewGroup,
+    NetworkingGroup,
+    NodeBalancerGroup,
+    ObjectStorageGroup,
+    PollingGroup,
+    ProfileGroup,
+    RegionGroup,
+    SupportGroup,
+    TagGroup,
+    VolumeGroup,
+)
+from linode_api4.objects import Image, and_
 from linode_api4.objects.filtering import Filter
 
 from .common import SSH_KEY_TYPES, load_and_validate_keys

pyproject.toml

@@ -11,7 +11,7 @@ line-length = 80
 target-version = ["py37", "py38", "py39", "py310", "py311"]
 
 [tool.autoflake]
-expand-star-imports = false
+expand-star-imports = true
 ignore-init-module-imports = true
 ignore-pass-after-docstring = true
 in-place = true

test/fixtures/networking_ips_share.json

@@ -0,0 +1 @@
+{}

test/integration/models/test_networking.py

@@ -13,3 +13,39 @@ def test_get_networking_rules(get_client, create_firewall):
     assert "inbound_policy" in str(rules)
     assert "outbound" in str(rules)
     assert "outbound_policy" in str(rules)
+
+
+@pytest.mark.smoke
+def test_ip_addresses_share(self):
+    """
+    Test that you can share IP addresses with Linode.
+    """
+    ip_share_url = "/networking/ips/share"
+    ips = ["127.0.0.1"]
+    linode_id = 12345
+    with self.mock_post(ip_share_url) as m:
+        result = self.client.networking.ip_addresses_share(ips, linode_id)
+
+        self.assertIsNotNone(result)
+        self.assertEqual(m.call_url, ip_share_url)
+        self.assertEqual(
+            m.call_data,
+            {
+                "ips": ips,
+                "linode": linode_id,
+            },
+        )
+
+    # Test that entering an empty IP array is allowed.
+    with self.mock_post(ip_share_url) as m:
+        result = self.client.networking.ip_addresses_share([], linode_id)
+
+        self.assertIsNotNone(result)
+        self.assertEqual(m.call_url, ip_share_url)
+        self.assertEqual(
+            m.call_data,
+            {
+                "ips": [],
+                "linode": linode_id,
+            },
+        )