Add ability to set filters to GetProjectQuotas method (#176)

Author: arla-arla-s

.golangci.yml

@@ -1,5 +1,5 @@
 run:
-  deadline: 5m
+  timeout: 5m
 
 linters:
   fast: false
@@ -51,4 +51,7 @@ linters-settings:
   goimports:
     local-prefixes: github.com/selectel/go-selvpcclient
   gci:
-    local-prefixes: github.com/selectel/go-selvpcclient
+    sections:
+      - standard
+      - default
+      - prefix(github.com/selectel/go-selvpcclient)

selvpcclient/quotamanager/quotas/requests.go

@@ -3,6 +3,7 @@ package quotas
 import (
 	"fmt"
 	"net/http"
+	"net/url"
 	"strings"
 
 	"github.com/selectel/go-selvpcclient/v4/selvpcclient"
@@ -11,6 +12,17 @@ import (
 
 const resourcePrefix = "projects"
 
+func WithResourceFilter(name string) func(url.Values) {
+	return func(query url.Values) {
+		if query == nil {
+			query = make(url.Values)
+		}
+		if name != "" {
+			query.Add("resource", name)
+		}
+	}
+}
+
 // GetLimits returns limits for a single project referenced by id in specific region.
 func GetLimits(client *selvpcclient.Client, projectID, region string,
 ) ([]*Quota, *clientservices.ResponseResult, error) {
@@ -19,9 +31,9 @@ func GetLimits(client *selvpcclient.Client, projectID, region string,
 		return nil, nil, fmt.Errorf("failed to get endpoint, err: %w", err)
 	}
 
-	url := strings.Join([]string{endpoint, resourcePrefix, projectID, "limits"}, "/")
+	fullURL := strings.Join([]string{endpoint, resourcePrefix, projectID, "limits"}, "/")
 
-	responseResult, err := client.QuotaManager.Requests.Do(http.MethodGet, url, &clientservices.RequestOptions{
+	responseResult, err := client.QuotaManager.Requests.Do(http.MethodGet, fullURL, &clientservices.RequestOptions{
 		OkCodes: []int{200},
 	})
 	if err != nil {
@@ -43,16 +55,21 @@ func GetLimits(client *selvpcclient.Client, projectID, region string,
 }
 
 // GetProjectQuotas returns the quotas info for a single project referenced by id in specific region.
-func GetProjectQuotas(client *selvpcclient.Client, projectID, region string,
+func GetProjectQuotas(client *selvpcclient.Client, projectID, region string, options ...func(url.Values),
 ) ([]*Quota, *clientservices.ResponseResult, error) {
+	resourceFilters := url.Values{}
+	for _, opts := range options {
+		opts(resourceFilters)
+	}
 	endpoint, err := client.QuotaManager.GetEndpoint(region)
 	if err != nil {
 		return nil, nil, fmt.Errorf("failed to get endpoint, err: %w", err)
 	}
 
-	url := strings.Join([]string{endpoint, resourcePrefix, projectID, "quotas"}, "/")
+	baseURL := strings.Join([]string{endpoint, resourcePrefix, projectID, "quotas"}, "/")
+	fullURL := baseURL + "?" + resourceFilters.Encode()
 
-	responseResult, err := client.QuotaManager.Requests.Do(http.MethodGet, url, &clientservices.RequestOptions{
+	responseResult, err := client.QuotaManager.Requests.Do(http.MethodGet, fullURL, &clientservices.RequestOptions{
 		OkCodes: []int{200},
 	})
 	if err != nil {
@@ -82,9 +99,9 @@ func UpdateProjectQuotas(client *selvpcclient.Client, projectID, region string,
 		return nil, nil, fmt.Errorf("failed to get endpoint, err: %w", err)
 	}
 
-	url := strings.Join([]string{endpoint, resourcePrefix, projectID, "quotas"}, "/")
+	fullURL := strings.Join([]string{endpoint, resourcePrefix, projectID, "quotas"}, "/")
 
-	responseResult, err := client.QuotaManager.Requests.Do(http.MethodPatch, url, &clientservices.RequestOptions{
+	responseResult, err := client.QuotaManager.Requests.Do(http.MethodPatch, fullURL, &clientservices.RequestOptions{
 		JSONBody: &updateOpts,
 		OkCodes:  []int{200},
 	})

selvpcclient/quotamanager/quotas/testing/fixtures.go

@@ -62,6 +62,26 @@ const TestGetProjectQuotasResponseSingleRaw = `
 }
 `
 
+// TestGetProjectQuotasResponseSingleRaw represents a raw response with a single quota from the GetProject request.
+const TestGetProjectQuotasResponseFilteredRaw = `
+{
+    "quotas": {
+        "compute_ram": [
+            {
+                "value": 51200,
+                "zone": "ru-1a"
+            }
+        ],
+        "compute_cores": [
+            {
+                "value": 300,
+                "zone": "ru-1a"
+            }
+        ]
+    }
+}
+`
+
 // TestGetProjectQuotasResponseSingle represents the unmarshalled TestGetProjectQuotasResponseSingleRaw response.
 var TestGetProjectQuotasResponseSingle = []*quotas.Quota{
 	{
@@ -76,6 +96,30 @@ var TestGetProjectQuotasResponseSingle = []*quotas.Quota{
 	},
 }
 
+// TestGetProjectQuotasResponseFiltered represents the unmarshalled TestGetProjectQuotasResponseFilteredRaw response.
+var TestGetProjectQuotasResponseFiltered = []*quotas.Quota{
+	{
+		Name: "compute_ram",
+		ResourceQuotasEntities: []quotas.ResourceQuotaEntity{
+			{
+				Zone:  "ru-1a",
+				Value: 51200,
+			},
+		},
+		ResourceQuotasErrors: []quotas.ResourceError{},
+	},
+	{
+		Name: "compute_cores",
+		ResourceQuotasEntities: []quotas.ResourceQuotaEntity{
+			{
+				Zone:  "ru-1a",
+				Value: 300,
+			},
+		},
+		ResourceQuotasErrors: []quotas.ResourceError{},
+	},
+}
+
 var (
 	ramQuotaZone  = "ru-1a"
 	ramQuotaValue = 64000

selvpcclient/quotamanager/quotas/testing/requests_test.go

@@ -202,6 +202,80 @@ func TestGetProjectQuotasSingle(t *testing.T) {
 	}
 }
 
+func TestGetProjectQuotasFiltered(t *testing.T) {
+	endpointCalled := false
+
+	testEnv := testutils.SetupTestEnv()
+	defer testEnv.TearDownTestEnv()
+	testEnv.NewSelVPCClient()
+	testutils.HandleReqWithoutBody(t, &testutils.HandleReqOpts{
+		Mux:         testEnv.Mux,
+		URL:         strings.Join([]string{testBaseURL, "quotas"}, "/"),
+		RawResponse: TestGetProjectQuotasResponseFilteredRaw,
+		Method:      http.MethodGet,
+		Status:      http.StatusOK,
+		CallFlag:    &endpointCalled,
+	})
+
+	actual, _, err := quotas.GetProjectQuotas(
+		testEnv.Client,
+		testProjectID,
+		testRegion,
+		quotas.WithResourceFilter("compute_ram"),
+		quotas.WithResourceFilter("compute_cores"),
+	)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	expected := TestGetProjectQuotasResponseFiltered
+
+	if !endpointCalled {
+		t.Fatal("endpoint wasn't called")
+	}
+	if !reflect.DeepEqual(actual, expected) {
+		t.Fatalf("expected %#v, but got %#v", expected, actual)
+	}
+}
+
+func TestGetProjectQuotasFilteredHTTPError(t *testing.T) {
+	endpointCalled := false
+
+	testEnv := testutils.SetupTestEnv()
+	defer testEnv.TearDownTestEnv()
+	testEnv.NewSelVPCClient()
+	testutils.HandleReqWithoutBody(t, &testutils.HandleReqOpts{
+		Mux:         testEnv.Mux,
+		URL:         strings.Join([]string{testBaseURL, "quotas"}, "/"),
+		RawResponse: TestGetProjectQuotasResponseRaw,
+		Method:      http.MethodGet,
+		Status:      http.StatusBadGateway,
+		CallFlag:    &endpointCalled,
+	})
+
+	allQuotas, httpResponse, err := quotas.GetProjectQuotas(
+		testEnv.Client,
+		testProjectID,
+		testRegion,
+		quotas.WithResourceFilter("compute_ram"),
+		quotas.WithResourceFilter("compute_cores"),
+	)
+
+	if !endpointCalled {
+		t.Fatal("endpoint wasn't called")
+	}
+	if allQuotas != nil {
+		t.Fatal("expected no quotas from the GetProjectQuotas method")
+	}
+	if err == nil {
+		t.Fatal("expected error from the GetProjectQuotas method")
+	}
+	if httpResponse.StatusCode != http.StatusBadGateway {
+		t.Fatalf("expected %d status in the HTTP response, but got %d",
+			http.StatusBadGateway, httpResponse.StatusCode)
+	}
+}
+
 func TestGetProjectQuotasHTTPError(t *testing.T) {
 	endpointCalled := false