Merge branch 'dev' into zhiwei/TPT-4656/nodebalancer-type-backend-connectivity

Author: zliang-akamai

.github/workflows/ci.yml

@@ -67,5 +67,5 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Run tests
         run: |
-          pip install ".[test]"
-          tox
+          pip install ".[unit-test]"
+          make test-unit

AGENTS.md

@@ -3,8 +3,7 @@
 ## Source of Truth
 
 - This is the official synchronous Python SDK for the Linode API. Supported
-  Python versions come from [pyproject.toml](pyproject.toml) (`>=3.10`); do not
-  infer support from the older environment names still present in [tox.ini](tox.ini).
+  Python versions come from [pyproject.toml](pyproject.toml) (`>=3.10`).
 - Make changes only in canonical source trees such as `linode_api4/`, `test/`,
   `docs/`, `examples/`, and `.github/`. Do not edit generated copies or output in
   `build/`, `dist/`, `docs/build/`, `docs/_build/`, or `linode_api4.egg-info/`.

README.rst

@@ -102,14 +102,13 @@ Tests
 -----
 
 Tests live in the ``test`` directory.  When invoking tests, make sure you are
-in the root directory of this project.  To run the full suite across all
-supported python versions, use tox_:
+in the root directory of this project.  Install unit-test dependencies and run
+the mocked unit suite with:
 
 .. code-block:: shell
 
-   tox
-
-Running tox also runs pylint and coverage reports.
+   python3 -m pip install -e ".[unit-test]"
+   make test-unit
 
 The test suite uses fixtures stored as JSON in ``test/fixtures``.  These files
 contain sanitized JSON responses from the API - the file name is the URL called
@@ -131,8 +130,6 @@ from the api base url that should be returned, for example::
      linode = self.client.linode.instance_create('g6-standard-2', 'us-east')
      self.assertEqual(linode.id, 123) # passes
 
-.. _tox: http://tox.readthedocs.io
-
 
 Integration Tests
 -----------------

linode_api4/groups/vpc.py

@@ -11,6 +11,7 @@
     VPCIPv6RangeOptions,
 )
 from linode_api4.objects.base import _flatten_request_body_recursive
+from linode_api4.objects.vpc import VPCType
 from linode_api4.paginated_list import PaginatedList
 from linode_api4.util import drop_null_keys
 
@@ -44,6 +45,7 @@ def create(
         subnets: Optional[List[Dict[str, Any]]] = None,
         ipv6: Optional[List[Union[VPCIPv6RangeOptions, Dict[str, Any]]]] = None,
         ipv4: Optional[List[Union[VPCIPv4RangeOptions, Dict[str, Any]]]] = None,
+        vpc_type: Optional[Union[VPCType, str]] = None,
         **kwargs,
     ) -> VPC:
         """
@@ -61,6 +63,11 @@ def create(
         :type subnets: List[Dict[str, Any]]
         :param ipv6: The IPv6 address ranges for this VPC.
         :type ipv6: List[Union[VPCIPv6RangeOptions, Dict[str, Any]]]
+        :param vpc_type: The type of VPC to create. Defaults to ``regular`` on
+                         the API side. Set to ``rdma`` to create a GPUDirect
+                         RDMA VPC (requires the ``GPUDirect RDMA`` account
+                         capability).
+        :type vpc_type: Optional[Union[VPCType, str]]
         :param ipv4: The IPv4 address ranges for this VPC. Note that IPv4 VPCs may not currently be available to all users.
         :type ipv4: List[Union[VPCIPv4RangeOptions, Dict[str, Any]]]
 
@@ -74,6 +81,7 @@ def create(
             "ipv4": ipv4,
             "ipv6": ipv6,
             "subnets": subnets,
+            "vpc_type": vpc_type,
         }
 
         if subnets is not None and len(subnets) > 0:

linode_api4/login_client.py

@@ -30,10 +30,11 @@ class OAuthScopes:
     Lists of OAuth Scopes are accepted when calling the :any:`generate_login_url`
     method of the :any:`LinodeLoginClient`.
 
-    All contained enumerations of OAuth Scopes have two levels, "read_only" and
+    Most contained enumerations of OAuth Scopes have two levels, "read_only" and
     "read_write".  "read_only" access grants you the ability to get resources and
     of that type, but not to change, create, or delete them.  "read_write" access
-    allows to full access to resources of the requested type.  In the above
+    allows to full access to resources of the requested type.  :any:`OAuthScopes.VPC`
+    is the exception and exposes only "read_write" and "all".  In the above
     example, you are requesting access to view, modify, create, and delete
     Linodes, and to view Domains.
     """
@@ -268,6 +269,33 @@ def __repr__(self):
                 return "images:*"
             return "images:{}".format(self.name)
 
+    class Databases(Enum):
+        """
+        Access to Managed Databases
+        """
+
+        read_only = 0
+        read_write = 1
+        all = 2
+
+        def __repr__(self):
+            if self.name == "all":
+                return "databases:*"
+            return "databases:{}".format(self.name)
+
+    class VPC(Enum):
+        """
+        Access to VPCs and subnets
+        """
+
+        read_write = 1
+        all = 2
+
+        def __repr__(self):
+            if self.name == "all":
+                return "vpc:*"
+            return "vpc:{}".format(self.name)
+
     _scope_families = {
         "linodes": Linodes,
         "domains": Domains,
@@ -286,6 +314,8 @@ def __repr__(self):
         "nodebalancers": NodeBalancers,
         "longview": Longview,
         "images": Images,
+        "databases": Databases,
+        "vpc": VPC,
     }
 
     @staticmethod

linode_api4/objects/linode.py

@@ -2115,10 +2115,22 @@ def interface_create(
         :param vpc: The VPC-specific configuration of the new interface.
                     If set, the new instance will be a VPC interface.
 
+        .. note::
+           RDMA VPC interfaces (``rdma_vpc``) cannot be added via this
+           endpoint. They may only be specified at instance creation time via
+           :func:`linode_api4.LinodeGroup.instance_create`.
+
         :returns: The newly created Linode Interface.
         :rtype: LinodeInterface
         """
 
+        if kwargs.get("rdma_vpc") is not None:
+            raise ValueError(
+                "RDMA VPC interfaces (rdma_vpc) cannot be added via "
+                "interface_create(). They may only be specified at instance "
+                "creation time via LinodeGroup.instance_create()."
+            )
+
         params = {
             "firewall_id": firewall,
             "default_route": default_route,

linode_api4/objects/linode_interfaces.py

@@ -187,6 +187,47 @@ class LinodeInterfaceVLANOptions(JSONObject):
     ipam_address: Optional[str] = None
 
 
+@dataclass
+class LinodeInterfaceRDMAVPCIPv4AddressOptions(JSONObject):
+    """
+    Options accepted for a single address when creating or updating the IPv4
+    configuration of an RDMA VPC Linode Interface.
+
+    Only one address is supported per RDMA VPC interface, and it must be
+    marked as primary.
+    """
+
+    address: Optional[str] = None
+    primary: Optional[bool] = None
+
+
+@dataclass
+class LinodeInterfaceRDMAVPCIPv4Options(JSONObject):
+    """
+    Options accepted when creating or updating the IPv4 configuration of an
+    RDMA VPC Linode Interface.
+
+    The ``addresses`` list MUST contain exactly one element. If omitted, the
+    API defaults to a single primary ``auto`` address.
+    """
+
+    addresses: Optional[List[LinodeInterfaceRDMAVPCIPv4AddressOptions]] = None
+
+
+@dataclass
+class LinodeInterfaceRDMAVPCOptions(JSONObject):
+    """
+    RDMA-VPC-exclusive options accepted when creating or updating a Linode
+    Interface.
+
+    Used for GPUDirect RDMA interfaces. Default routes and NAT 1:1 addresses
+    are not supported on RDMA VPC interfaces.
+    """
+
+    subnet_id: int = 0
+    ipv4: Optional[LinodeInterfaceRDMAVPCIPv4Options] = None
+
+
 @dataclass
 class LinodeInterfaceOptions(JSONObject):
     """
@@ -204,6 +245,7 @@ class LinodeInterfaceOptions(JSONObject):
     vpc: Optional[LinodeInterfaceVPCOptions] = None
     public: Optional[LinodeInterfacePublicOptions] = None
     vlan: Optional[LinodeInterfaceVLANOptions] = None
+    rdma_vpc: Optional[LinodeInterfaceRDMAVPCOptions] = None
 
 
 # Interface GET Response
@@ -409,6 +451,45 @@ class LinodeInterfaceVLAN(JSONObject):
     ipam_address: Optional[str] = None
 
 
+@dataclass
+class LinodeInterfaceRDMAVPCIPv4Address(JSONObject):
+    """
+    A single address under the IPv4 configuration of an RDMA VPC Linode Interface.
+    """
+
+    put_class = LinodeInterfaceRDMAVPCIPv4AddressOptions
+
+    address: str = ""
+    primary: bool = False
+
+
+@dataclass
+class LinodeInterfaceRDMAVPCIPv4(JSONObject):
+    """
+    The IPv4 configuration of an RDMA VPC Linode Interface.
+    """
+
+    put_class = LinodeInterfaceRDMAVPCIPv4Options
+
+    addresses: List[LinodeInterfaceRDMAVPCIPv4Address] = field(
+        default_factory=list
+    )
+
+
+@dataclass
+class LinodeInterfaceRDMAVPC(JSONObject):
+    """
+    RDMA VPC-specific configuration field for a Linode Interface.
+    """
+
+    put_class = LinodeInterfaceRDMAVPCOptions
+
+    vpc_id: int = 0
+    subnet_id: int = 0
+
+    ipv4: Optional[LinodeInterfaceRDMAVPCIPv4] = None
+
+
 class LinodeInterface(DerivedBase):
     """
     A Linode's network interface.
@@ -449,6 +530,7 @@ class LinodeInterface(DerivedBase):
         "public": Property(mutable=True, json_object=LinodeInterfacePublic),
         "vlan": Property(mutable=True, json_object=LinodeInterfaceVLAN),
         "vpc": Property(mutable=True, json_object=LinodeInterfaceVPC),
+        "rdma_vpc": Property(mutable=True, json_object=LinodeInterfaceRDMAVPC),
     }
 
     def firewalls(self, *filters) -> List[Firewall]:

linode_api4/objects/region.py

@@ -67,6 +67,7 @@ class Capability(StrEnum):
     ruleset = "Cloud Firewall Rule Set"
     prefixlists = "Cloud Firewall Prefix Lists"
     current_prefixlists = "Cloud Firewall Prefix List Current References"
+    gpudirect_rdma = "GPUDirect RDMA"
 
 
 @dataclass

linode_api4/objects/vpc.py

@@ -5,11 +5,20 @@
 from linode_api4.objects import Base, DerivedBase, Property, Region
 from linode_api4.objects.base import _flatten_request_body_recursive
 from linode_api4.objects.networking import VPCIPAddress
-from linode_api4.objects.serializable import JSONObject
+from linode_api4.objects.serializable import JSONObject, StrEnum
 from linode_api4.paginated_list import PaginatedList
 from linode_api4.util import drop_null_keys
 
 
+class VPCType(StrEnum):
+    """
+    VPCType represents the supported VPC types.
+    """
+
+    regular = "regular"
+    rdma = "rdma"
+
+
 @dataclass
 class VPCIPv4DefaultRange(JSONObject):
     """
@@ -119,6 +128,7 @@ class VPCSubnet(DerivedBase):
         "ipv6": Property(json_object=VPCSubnetIPv6Range, unordered=True),
         "linodes": Property(json_object=VPCSubnetLinode, unordered=True),
         "databases": Property(json_object=VPCSubnetDatabase, unordered=True),
+        "vpc_type": Property(),
         "created": Property(is_datetime=True),
         "updated": Property(is_datetime=True),
     }
@@ -144,6 +154,7 @@ class VPC(Base):
         ),
         "ipv6": Property(json_object=VPCIPv6Range, unordered=True),
         "subnets": Property(derived_class=VPCSubnet),
+        "vpc_type": Property(),
         "created": Property(is_datetime=True),
         "updated": Property(is_datetime=True),
     }

pyproject.toml

@@ -35,32 +35,37 @@ dependencies = ["requests", "polling", "deprecated"]
 dynamic = ["version"]
 
 [project.optional-dependencies]
-test = ["tox>=4.4.0"]
-
-dev = [
-    "tox>=4.4.0",
-    "mock>=5.0.0",
+test-shared = [
     "pytest>=7.3.1",
     "httpretty>=1.1.4",
+    "pytest-rerunfailures",
+]
+unit-test = [
+    "linode_api4[test-shared]",
+    "mock>=5.0.0",
+]
+int-test = [
+    "linode_api4[test-shared]",
+]
+lint = [
     "black>=23.1.0",
     "isort>=5.12.0",
     "autoflake>=2.0.1",
     "pylint",
     "twine>=4.0.2",
     "build>=0.10.0",
-    "Sphinx>=6.0.0",
-    "sphinx-autobuild>=2021.3.14",
-    "sphinxcontrib-fulltoc>=1.2.0",
-    "build>=0.10.0",
-    "twine>=4.0.2",
-    "pytest-rerunfailures",
 ]
-
 doc = [
     "Sphinx>=6.0.0",
     "sphinx-autobuild>=2021.3.14",
     "sphinxcontrib-fulltoc>=1.2.0",
 ]
+dev = [
+    "linode_api4[unit-test]",
+    "linode_api4[int-test]",
+    "linode_api4[lint]",
+    "linode_api4[doc]",
+]
 
 [project.urls]
 Homepage = "https://github.com/linode/linode_api4-python"