Project: Limits Visibility M1 (#544)

* Support Object Storage Quota Limits Visibility (#531)

* obj quota

* add comment

* build json object

* add obj quotas int tests (#535)

* Update Object Storage quota doc link (#543)

---------

Co-authored-by: Youjung Kim <126618609+ykim-akamai@users.noreply.github.com>

Author: yec-akamai

linode_api4/groups/object_storage.py

@@ -21,6 +21,7 @@
     ObjectStorageCluster,
     ObjectStorageKeyPermission,
     ObjectStorageKeys,
+    ObjectStorageQuota,
 )
 from linode_api4.util import drop_null_keys
 
@@ -517,3 +518,18 @@ def object_url_create(
             )
 
         return MappedObject(**result)
+
+    def quotas(self, *filters):
+        """
+        Lists the active ObjectStorage-related quotas applied to your account.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-object-storage-quotas
+
+        :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 Object Storage Quotas that matched the query.
+        :rtype: PaginatedList of ObjectStorageQuota
+        """
+        return self.client._get_and_filter(ObjectStorageQuota, *filters)

linode_api4/objects/object_storage.py

@@ -51,6 +51,16 @@ class ObjectStorageEndpoint(JSONObject):
     s3_endpoint: Optional[str] = None
 
 
+@dataclass
+class ObjectStorageQuotaUsage(JSONObject):
+    """
+    ObjectStorageQuotaUsage contains the fields of an object storage quota usage information.
+    """
+
+    quota_limit: int = 0
+    usage: int = 0
+
+
 class ObjectStorageType(Base):
     """
     An ObjectStorageType represents the structure of a valid Object Storage type.
@@ -566,3 +576,42 @@ class ObjectStorageKeys(Base):
         "limited": Property(),
         "regions": Property(unordered=True),
     }
+
+
+class ObjectStorageQuota(Base):
+    """
+    An Object Storage related quota information on your account.
+    Object Storage Quota related features are under v4beta and may not currently be available to all users.
+
+    API documentation: https://techdocs.akamai.com/linode-api/reference/get-object-storage-quota
+    """
+
+    api_endpoint = "/object-storage/quotas/{quota_id}"
+    id_attribute = "quota_id"
+
+    properties = {
+        "quota_id": Property(identifier=True),
+        "quota_name": Property(),
+        "endpoint_type": Property(),
+        "s3_endpoint": Property(),
+        "description": Property(),
+        "quota_limit": Property(),
+        "resource_metric": Property(),
+    }
+
+    def usage(self):
+        """
+        Gets usage data for a specific ObjectStorage Quota resource you can have on your account and the current usage for that resource.
+
+        API documentation: https://techdocs.akamai.com/linode-api/reference/get-object-storage-quota-usage
+
+        :returns: The Object Storage Quota usage.
+        :rtype: ObjectStorageQuotaUsage
+        """
+
+        result = self._client.get(
+            f"{type(self).api_endpoint}/usage",
+            model=self,
+        )
+
+        return ObjectStorageQuotaUsage.from_json(result)

test/fixtures/object-storage_quotas.json

@@ -0,0 +1,25 @@
+{
+  "data": [
+    {
+      "quota_id": "obj-objects-us-ord-1",
+      "quota_name": "Object Storage Maximum Objects",
+      "description": "Maximum number of Objects this customer is allowed to have on this endpoint.",
+      "endpoint_type": "E1",
+      "s3_endpoint": "us-iad-1.linodeobjects.com",
+      "quota_limit": 50,
+      "resource_metric": "object"
+    },
+    {
+      "quota_id": "obj-bucket-us-ord-1",
+      "quota_name": "Object Storage Maximum Buckets",
+      "description": "Maximum number of buckets this customer is allowed to have on this endpoint.",
+      "endpoint_type": "E1",
+      "s3_endpoint": "us-iad-1.linodeobjects.com",
+      "quota_limit": 50,
+      "resource_metric": "bucket"
+    }
+  ],
+  "page": 1,
+  "pages": 1,
+  "results": 2
+}

test/fixtures/object-storage_quotas_obj-objects-us-ord-1.json

@@ -0,0 +1,9 @@
+{
+  "quota_id": "obj-objects-us-ord-1",
+  "quota_name": "Object Storage Maximum Objects",
+  "description": "Maximum number of Objects this customer is allowed to have on this endpoint.",
+  "endpoint_type": "E1",
+  "s3_endpoint": "us-iad-1.linodeobjects.com",
+  "quota_limit": 50,
+  "resource_metric": "object"
+}

test/fixtures/object-storage_quotas_obj-objects-us-ord-1_usage.json

@@ -0,0 +1,4 @@
+{
+  "quota_limit": 100,
+  "usage": 10
+}

test/integration/models/object_storage/test_obj_quotas.py

@@ -0,0 +1,58 @@
+from linode_api4.objects.object_storage import (
+    ObjectStorageQuota,
+    ObjectStorageQuotaUsage,
+)
+
+
+def test_list_obj_storage_quotas(test_linode_client):
+    quotas = test_linode_client.object_storage.quotas()
+
+    target_quota_id = "obj-buckets-us-sea-1.linodeobjects.com"
+
+    found_quota = None
+    for quota in quotas:
+        if quota.quota_id == target_quota_id:
+            found_quota = quota
+            break
+
+    assert (
+        found_quota is not None
+    ), f"Quota with ID {target_quota_id} not found."
+
+    assert found_quota.quota_id == "obj-buckets-us-sea-1.linodeobjects.com"
+    assert found_quota.quota_name == "max_buckets"
+    assert found_quota.endpoint_type == "E1"
+    assert found_quota.s3_endpoint == "us-sea-1.linodeobjects.com"
+    assert (
+        found_quota.description
+        == "Maximum number of buckets this customer is allowed to have on this endpoint"
+    )
+    assert found_quota.quota_limit == 1000
+    assert found_quota.resource_metric == "bucket"
+
+
+def test_get_obj_storage_quota(test_linode_client):
+    quota_id = "obj-objects-us-ord-1.linodeobjects.com"
+    quota = test_linode_client.load(ObjectStorageQuota, quota_id)
+
+    assert quota.quota_id == "obj-objects-us-ord-1.linodeobjects.com"
+    assert quota.quota_name == "max_objects"
+    assert quota.endpoint_type == "E1"
+    assert quota.s3_endpoint == "us-ord-1.linodeobjects.com"
+    assert (
+        quota.description
+        == "Maximum number of objects this customer is allowed to have on this endpoint"
+    )
+    assert quota.quota_limit == 100000000
+    assert quota.resource_metric == "object"
+
+
+def test_get_obj_storage_quota_usage(test_linode_client):
+    quota_id = "obj-objects-us-ord-1.linodeobjects.com"
+    quota = test_linode_client.load(ObjectStorageQuota, quota_id)
+
+    quota_usage = quota.usage()
+
+    assert isinstance(quota_usage, ObjectStorageQuotaUsage)
+    assert quota_usage.quota_limit == 100000000
+    assert quota_usage.usage >= 0

test/unit/objects/object_storage_test.py

@@ -6,6 +6,7 @@
     ObjectStorageACL,
     ObjectStorageBucket,
     ObjectStorageCluster,
+    ObjectStorageQuota,
 )
 
 
@@ -284,3 +285,53 @@ def test_object_acl_config_update(self):
                     "name": "example",
                 },
             )
+
+    def test_quota_get_and_list(self):
+        """
+        Test that you can get and list an Object storage quota and usage information.
+        """
+        quota = ObjectStorageQuota(
+            self.client,
+            "obj-objects-us-ord-1",
+        )
+
+        self.assertIsNotNone(quota)
+        self.assertEqual(quota.quota_id, "obj-objects-us-ord-1")
+        self.assertEqual(quota.quota_name, "Object Storage Maximum Objects")
+        self.assertEqual(
+            quota.description,
+            "Maximum number of Objects this customer is allowed to have on this endpoint.",
+        )
+        self.assertEqual(quota.endpoint_type, "E1")
+        self.assertEqual(quota.s3_endpoint, "us-iad-1.linodeobjects.com")
+        self.assertEqual(quota.quota_limit, 50)
+        self.assertEqual(quota.resource_metric, "object")
+
+        quota_usage_url = "/object-storage/quotas/obj-objects-us-ord-1/usage"
+        with self.mock_get(quota_usage_url) as m:
+            usage = quota.usage()
+            self.assertIsNotNone(usage)
+            self.assertEqual(m.call_url, quota_usage_url)
+            self.assertEqual(usage.quota_limit, 100)
+            self.assertEqual(usage.usage, 10)
+
+        quota_list_url = "/object-storage/quotas"
+        with self.mock_get(quota_list_url) as m:
+            quotas = self.client.object_storage.quotas()
+            self.assertIsNotNone(quotas)
+            self.assertEqual(m.call_url, quota_list_url)
+            self.assertEqual(len(quotas), 2)
+            self.assertEqual(quotas[0].quota_id, "obj-objects-us-ord-1")
+            self.assertEqual(
+                quotas[0].quota_name, "Object Storage Maximum Objects"
+            )
+            self.assertEqual(
+                quotas[0].description,
+                "Maximum number of Objects this customer is allowed to have on this endpoint.",
+            )
+            self.assertEqual(quotas[0].endpoint_type, "E1")
+            self.assertEqual(
+                quotas[0].s3_endpoint, "us-iad-1.linodeobjects.com"
+            )
+            self.assertEqual(quotas[0].quota_limit, 50)
+            self.assertEqual(quotas[0].resource_metric, "object")