Support Object Storage quota limits visibility (#717)

* obj quota

* fmt

* address comment

Author: yec-akamai

object_storage_quota.go

@@ -0,0 +1,42 @@
+package linodego
+
+import (
+	"context"
+)
+
+// ObjectStorageQuota represents a Object Storage related quota information on your account.
+type ObjectStorageQuota struct {
+	QuotaID        string `json:"quota_id"`
+	QuotaName      string `json:"quota_name"`
+	EndpointType   string `json:"endpoint_type"`
+	S3Endpoint     string `json:"s3_endpoint"`
+	Description    string `json:"description"`
+	QuotaLimit     int    `json:"quota_limit"`
+	ResourceMetric string `json:"resource_metric"`
+}
+
+// ObjectStorageQuotaUsage is the usage data for a specific Object Storage related quota on your account.
+type ObjectStorageQuotaUsage struct {
+	QuotaLimit int  `json:"quota_limit"`
+	Usage      *int `json:"usage"`
+}
+
+// ListObjectStorageQuotas lists the active ObjectStorage-related quotas applied to your account.
+// Object Storage Quota related features are under v4beta and may not currently be available to all users.
+func (c *Client) ListObjectStorageQuotas(ctx context.Context, opts *ListOptions) ([]ObjectStorageQuota, error) {
+	return getPaginatedResults[ObjectStorageQuota](ctx, c, formatAPIPath("object-storage/quotas"), opts)
+}
+
+// GetObjectStorageQuota gets information about a specific ObjectStorage-related quota on your account.
+// Object Storage Quota related features are under v4beta and may not currently be available to all users.
+func (c *Client) GetObjectStorageQuota(ctx context.Context, quotaID string) (*ObjectStorageQuota, error) {
+	e := formatAPIPath("object-storage/quotas/%s", quotaID)
+	return doGETRequest[ObjectStorageQuota](ctx, c, e)
+}
+
+// GetObjectStorageQuotaUsage gets usage data for a specific ObjectStorage Quota resource you can have on your account and the current usage for that resource.
+// Object Storage Quota related features are under v4beta and may not currently be available to all users.
+func (c *Client) GetObjectStorageQuotaUsage(ctx context.Context, quotaID string) (*ObjectStorageQuotaUsage, error) {
+	e := formatAPIPath("object-storage/quotas/%s/usage", quotaID)
+	return doGETRequest[ObjectStorageQuotaUsage](ctx, c, e)
+}

test/unit/fixtures/object_storage_quotas_get.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/unit/fixtures/object_storage_quotas_list.json

@@ -0,0 +1,24 @@
+{
+  "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/unit/fixtures/object_storage_quotas_usage_get.json

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

test/unit/object_storage_quota_test.go

@@ -0,0 +1,80 @@
+package unit
+
+import (
+	"context"
+	"testing"
+
+	"github.com/linode/linodego"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestObjectStorageQuotas_Get(t *testing.T) {
+	fixtureData, err := fixtures.GetFixture("object_storage_quotas_get")
+	assert.NoError(t, err)
+
+	var base ClientBaseCase
+	base.SetUp(t)
+	defer base.TearDown(t)
+
+	base.MockGet("object-storage/quotas/obj-objects-us-ord-1", fixtureData)
+
+	quota, err := base.Client.GetObjectStorageQuota(context.Background(), "obj-objects-us-ord-1")
+	if err != nil {
+		t.Fatalf("Error getting object-storage quota: %v", err)
+	}
+
+	assert.Equal(t, "obj-objects-us-ord-1", quota.QuotaID)
+	assert.Equal(t, "Object Storage Maximum Objects", quota.QuotaName)
+	assert.Equal(t, "Maximum number of Objects this customer is allowed to have on this endpoint.", quota.Description)
+	assert.Equal(t, "E1", quota.EndpointType)
+	assert.Equal(t, "us-iad-1.linodeobjects.com", quota.S3Endpoint)
+	assert.Equal(t, 50, quota.QuotaLimit)
+	assert.Equal(t, "object", quota.ResourceMetric)
+}
+
+func TestObjectStorageQuotas_List(t *testing.T) {
+	fixtureData, err := fixtures.GetFixture("object_storage_quotas_list")
+	assert.NoError(t, err)
+
+	var base ClientBaseCase
+	base.SetUp(t)
+	defer base.TearDown(t)
+
+	base.MockGet("object-storage/quotas", fixtureData)
+
+	quotas, err := base.Client.ListObjectStorageQuotas(context.Background(), &linodego.ListOptions{})
+	if err != nil {
+		t.Fatalf("Error listing object-storage quotas: %v", err)
+	}
+
+	if len(quotas) < 1 {
+		t.Fatalf("Expected to get a list of object-storage quotas but failed.")
+	}
+
+	assert.Equal(t, "obj-objects-us-ord-1", quotas[0].QuotaID)
+	assert.Equal(t, "Object Storage Maximum Objects", quotas[0].QuotaName)
+	assert.Equal(t, "Maximum number of Objects this customer is allowed to have on this endpoint.", quotas[0].Description)
+	assert.Equal(t, "E1", quotas[0].EndpointType)
+	assert.Equal(t, "us-iad-1.linodeobjects.com", quotas[0].S3Endpoint)
+	assert.Equal(t, 50, quotas[0].QuotaLimit)
+	assert.Equal(t, "object", quotas[0].ResourceMetric)
+}
+
+func TestObjectStorageQuotaUsage_Get(t *testing.T) {
+	fixtureData, err := fixtures.GetFixture("object_storage_quotas_usage_get")
+	assert.NoError(t, err)
+
+	var base ClientBaseCase
+	base.SetUp(t)
+	defer base.TearDown(t)
+
+	base.MockGet("object-storage/quotas/obj-bucket-us-ord-1/usage", fixtureData)
+
+	quotaUsage, err := base.Client.GetObjectStorageQuotaUsage(context.Background(), "obj-bucket-us-ord-1")
+	if err != nil {
+		t.Fatalf("Error getting object storage quota usage: %v", err)
+	}
+
+	assert.Equal(t, 100, quotaUsage.QuotaLimit)
+	assert.Equal(t, 10, *quotaUsage.Usage)
+}