Added support for OBJ Gen 2

Author: ezilber-akamai

linode_api4/groups/object_storage.py

@@ -5,7 +5,11 @@
 
 from deprecated import deprecated
 
-from linode_api4 import ObjectStorageEndpoint, ObjectStorageEndpointType
+from linode_api4 import (
+    ObjectStorageEndpoint,
+    ObjectStorageEndpointType,
+    PaginatedList,
+)
 from linode_api4.errors import UnexpectedResponseError
 from linode_api4.groups import Group
 from linode_api4.objects import (
@@ -273,10 +277,15 @@ def transfer(self):
 
         return MappedObject(**result)
 
-    def endpoints(self, *filters):
+    def endpoints(self, *filters) -> PaginatedList:
         """
         Returns a paginated list of all Object Storage endpoints available in your account.
 
+        This is intended to be called from the :any:`LinodeClient`
+        class, like this::
+
+           endpoints = client.object_storage.endpoints()
+
         API Documentation: https://techdocs.akamai.com/linode-api/reference/get-object-storage-endpoints
 
         :param filters: Any number of filters to apply to this query.
@@ -286,7 +295,11 @@ def endpoints(self, *filters):
         :returns: A list of Object Storage Endpoints that matched the query.
         :rtype: PaginatedList of ObjectStorageEndpoint
         """
-        return self.client._get_and_filter(ObjectStorageEndpoint, *filters)
+        return self.client._get_and_filter(
+            ObjectStorageEndpoint,
+            *filters,
+            endpoint="/object-storage/endpoints",
+        )
 
     def buckets(self, *filters):
         """

linode_api4/objects/object_storage.py

@@ -12,7 +12,7 @@
     Property,
     Region,
 )
-from linode_api4.objects.serializable import StrEnum
+from linode_api4.objects.serializable import JSONObject, StrEnum
 from linode_api4.util import drop_null_keys
 
 
@@ -36,23 +36,18 @@ class ObjectStorageEndpointType(StrEnum):
     E3 = "E3"
 
 
-class ObjectStorageEndpoint(Base):
+@dataclass
+class ObjectStorageEndpoint(JSONObject):
     """
-    .. note:: At this time, the Linode API only supports listing ObjectStorageEndpoints.
+    ObjectStorageEndpoint contains the core fields of an object storage endpoint object.
 
-    An instance of an ObjectStorageEndpoint.
-    ObjectStorageEndpoints determine which S3 endpoints or types of endpoints are available to the requesting customer when using the API to create a bucket in a particular region
-
-    API Documentation: https://techdocs.akamai.com/linode-api/reference/get-object-storage-endpoints
+    NOTE: This is not implemented as a typical API object (Base) because Object Storage Endpoints
+    cannot be refreshed, as there is no singular GET endpoint.
     """
 
-    api_endpoint = "/object-storage/endpoints"
-
-    properties = {
-        "region": Property(),
-        "s3_endpoint": Property(),
-        "endpoint_type": Property(),
-    }
+    region: str = ""
+    endpoint_type: str = ""
+    s3_endpoint: Optional[str] = None
 
 
 class ObjectStorageBucket(DerivedBase):
@@ -92,13 +87,10 @@ def make_instance(cls, id, client, parent_id=None, json=None):
         Override this method to pass in the parent_id from the _raw_json object
         when it's available.
         """
-        if json is None:
-            return None
-
-        cluster_or_region = json.get("region") or json.get("cluster")
-
-        if parent_id is None and cluster_or_region:
-            parent_id = cluster_or_region
+        if json is not None:
+            cluster_or_region = json.get("region") or json.get("cluster")
+            if parent_id is None and cluster_or_region:
+                parent_id = cluster_or_region
 
         if parent_id:
             return super().make(id, client, cls, parent_id=parent_id, json=json)
@@ -114,14 +106,17 @@ def access_get(self):
         API Documentation: TODO
 
         :returns: A result object which wraps the access that this ObjectStorageBucket is currently configured with.
-        :rtype: dict
+        :rtype: MappedObject
         """
         result = self._client.get(
             "{}/access".format(self.api_endpoint),
             model=self,
         )
 
-        if not any(key in result for key in ["acl", "acl_xml", "cors_enabled", "cors_xml"]):
+        if not any(
+            key in result
+            for key in ["acl", "acl_xml", "cors_enabled", "cors_xml"]
+        ):
             raise UnexpectedResponseError(
                 "Unexpected response when getting the bucket access config of a bucket!",
                 json=result,

test/fixtures/object-storage_buckets_us-east-1.json

@@ -6,7 +6,9 @@
         "hostname": "example-bucket.us-east-1.linodeobjects.com",
         "label": "example-bucket",
         "objects": 4,
-        "size": 188318981
+        "size": 188318981,
+        "endpoint_type": "E1",
+        "s3_endpoint": "us-east-12.linodeobjects.com"
       }
     ],
     "page": 1,

test/fixtures/object-storage_buckets_us-east-1_example-bucket.json

@@ -5,5 +5,7 @@
   "hostname": "example-bucket.us-east-1.linodeobjects.com",
   "label": "example-bucket",
   "objects": 4,
-  "size": 188318981
+  "size": 188318981,
+  "endpoint_type": "E1",
+  "s3_endpoint": "us-east-12.linodeobjects.com"
 }

test/fixtures/object-storage_buckets_us-east_example-bucket_access.json

@@ -0,0 +1,6 @@
+{
+    "acl": "authenticated-read",
+    "acl_xml": "<AccessControlPolicy...",
+    "cors_enabled": true,
+    "cors_xml": "<CORSConfiguration>..."
+}

test/integration/models/object_storage/test_obj.py

@@ -8,6 +8,7 @@
     ObjectStorageACL,
     ObjectStorageBucket,
     ObjectStorageCluster,
+    ObjectStorageEndpointType,
     ObjectStorageKeyPermission,
     ObjectStorageKeys,
 )
@@ -19,7 +20,14 @@ def region(test_linode_client: LinodeClient):
 
 
 @pytest.fixture(scope="session")
-def bucket(test_linode_client: LinodeClient, region: str) -> ObjectStorageBucket:
+def endpoints(test_linode_client: LinodeClient):
+    return test_linode_client.object_storage.endpoints()
+
+
+@pytest.fixture(scope="session")
+def bucket(
+    test_linode_client: LinodeClient, region: str
+) -> ObjectStorageBucket:
     bucket = test_linode_client.object_storage.bucket_create(
         cluster_or_region=region,
         label="bucket-" + str(time.time_ns()),
@@ -31,6 +39,31 @@ def bucket(test_linode_client: LinodeClient, region: str) -> ObjectStorageBucket
     bucket.delete()
 
 
+@pytest.fixture(scope="session")
+def bucket_with_endpoint(
+    test_linode_client: LinodeClient, endpoints
+) -> ObjectStorageBucket:
+    selected_endpoint = next(
+        (
+            e
+            for e in endpoints
+            if e.endpoint_type == ObjectStorageEndpointType.E1
+        ),
+        None,
+    )
+
+    bucket = test_linode_client.object_storage.bucket_create(
+        cluster_or_region=selected_endpoint.region,
+        label="bucket-" + str(time.time_ns()),
+        acl=ObjectStorageACL.PRIVATE,
+        cors_enabled=False,
+        endpoint_type=selected_endpoint.endpoint_type,
+    )
+
+    yield bucket
+    bucket.delete()
+
+
 @pytest.fixture(scope="session")
 def obj_key(test_linode_client: LinodeClient):
     key = test_linode_client.object_storage.keys_create(
@@ -71,28 +104,36 @@ def test_keys(
 
     assert loaded_key.label == obj_key.label
     assert loaded_limited_key.label == obj_limited_key.label
+    assert (
+        loaded_limited_key.regions[0].endpoint_type
+        in ObjectStorageEndpointType.__members__.values()
+    )
 
 
 def test_bucket(test_linode_client: LinodeClient, bucket: ObjectStorageBucket):
-    print("The bucket's region is:", bucket.region)
-    print("The bucket's cluster is:", bucket.cluster)
-
     loaded_bucket = test_linode_client.load(
-        ObjectStorageBucket, target_id=bucket.label, target_parent_id=bucket.region
+        ObjectStorageBucket,
+        target_id=bucket.label,
+        target_parent_id=bucket.region,
     )
 
     assert loaded_bucket.label == bucket.label
-    assert loaded_bucket.cluster == bucket.cluster
+    assert loaded_bucket.region == bucket.region
 
-# def test_bucket(test_linode_client: LinodeClient, bucket: ObjectStorageBucket):
-#     buckets = test_linode_client.object_storage.buckets()
-#
-#     target_bucket = next((b for b in buckets if b.id == bucket.id), None)
-#
-#     assert target_bucket is not None, f"Bucket with ID {bucket.id} not found"
-#
-#     assert target_bucket.label == bucket.label
-#     assert target_bucket.region == bucket.region
+
+def test_bucket_with_endpoint(
+    test_linode_client: LinodeClient, bucket_with_endpoint: ObjectStorageBucket
+):
+    loaded_bucket = test_linode_client.load(
+        ObjectStorageBucket,
+        target_id=bucket_with_endpoint.label,
+        target_parent_id=bucket_with_endpoint.region,
+    )
+
+    assert loaded_bucket.label == bucket_with_endpoint.label
+    assert loaded_bucket.region == bucket_with_endpoint.region
+    assert loaded_bucket.s3_endpoint is not None
+    assert loaded_bucket.endpoint_type == "E1"
 
 
 def test_buckets_in_region(
@@ -115,6 +156,14 @@ def test_list_obj_storage_bucket(
     assert any(target_bucket_id == b.id for b in buckets)
 
 
+def test_bucket_access_get(bucket: ObjectStorageBucket):
+    access = bucket.access_get()
+
+    assert access.acl is not None
+    assert access.acl_xml is not None
+    assert access.cors_enabled is not None
+
+
 def test_bucket_access_modify(bucket: ObjectStorageBucket):
     bucket.access_modify(ObjectStorageACL.PRIVATE, cors_enabled=True)
 

test/unit/objects/object_storage_test.py

@@ -1,6 +1,7 @@
 from datetime import datetime
 from test.unit.base import ClientBaseCase
 
+from linode_api4 import ObjectStorageEndpointType
 from linode_api4.objects import (
     ObjectStorageACL,
     ObjectStorageBucket,
@@ -35,6 +36,14 @@ def test_object_storage_bucket_api_get(self):
             )
             self.assertEqual(object_storage_bucket.objects, 4)
             self.assertEqual(object_storage_bucket.size, 188318981)
+            self.assertEqual(
+                object_storage_bucket.endpoint_type,
+                ObjectStorageEndpointType.E1,
+            )
+            self.assertEqual(
+                object_storage_bucket.s3_endpoint,
+                "us-east-12.linodeobjects.com",
+            )
             self.assertEqual(m.call_url, object_storage_bucket_api_get_url)
 
     def test_object_storage_bucket_delete(self):
@@ -48,6 +57,22 @@ def test_object_storage_bucket_delete(self):
             object_storage_bucket.delete()
             self.assertEqual(m.call_url, object_storage_bucket_delete_url)
 
+    def test_bucket_access_get(self):
+        bucket_access_get_url = (
+            "/object-storage/buckets/us-east/example-bucket/access"
+        )
+        with self.mock_get(bucket_access_get_url) as m:
+            object_storage_bucket = ObjectStorageBucket(
+                self.client, "example-bucket", "us-east"
+            )
+            result = object_storage_bucket.access_get()
+            self.assertIsNotNone(result)
+            self.assertEqual(m.call_url, bucket_access_get_url)
+            self.assertEqual(result.acl, "authenticated-read")
+            self.assertEqual(result.cors_enabled, True)
+            self.assertEqual(result.acl_xml, "<AccessControlPolicy...")
+            self.assertEqual(result.cors_xml, "<CORSConfiguration>...")
+
     def test_bucket_access_modify(self):
         """
         Test that you can modify bucket access settings.
@@ -115,6 +140,8 @@ def test_buckets_in_cluster(self):
             self.assertEqual(bucket.label, "example-bucket")
             self.assertEqual(bucket.objects, 4)
             self.assertEqual(bucket.size, 188318981)
+            self.assertEqual(bucket.endpoint_type, ObjectStorageEndpointType.E1)
+            self.assertEqual(bucket.s3_endpoint, "us-east-12.linodeobjects.com")
 
     def test_ssl_cert_delete(self):
         """