feat(router): label support (#199)

Author: peknur

CHANGELOG.md

@@ -7,6 +7,10 @@ See updating [Changelog example here](https://keepachangelog.com/en/1.0.0/)
 
 ### Added
 - storage: possibility to control what to do with backups related to the storage that is about to be deleted
+- router: label support
+
+## Deprecated
+- request: `ServerFilter` and `ServerGroupFilter` types will be replaced with `QueryFilter` type in the future
 
 ## [5.2.1]
 

upcloud/network.go

@@ -290,6 +290,7 @@ type Router struct {
 	Name             string             `json:"name"`
 	Type             string             `json:"type"`
 	UUID             string             `json:"uuid"`
+	Labels           []Label            `json:"labels"`
 }
 
 // UnmarshalJSON is a custom unmarshaller that deals with

upcloud/network_test.go

@@ -450,30 +450,35 @@ func TestUnmarshalRouters(t *testing.T) {
 // behaves correctly.
 func TestUnmarshalRouter(t *testing.T) {
 	originalJSON := `
-	  {
+	{
 		"router": {
-		  "attached_networks": {
-			"network": [
-				{
-					"uuid" : "03206c92-50f2-40b0-ad05-5f02cab2e932"
-				},
-				{
-					"uuid" : "03d781c3-65e3-4a7a-b6cd-a7ce7e23b8c5"
-				},
-				{
-					"uuid" : "03854a28-fafe-428f-964f-760cd1b83f1f"
-				},
-				{
-					"uuid" : "03bae36d-a30a-4640-9a35-f2ccb0e2cddc"
-				}
-			]
+		  	"attached_networks": {
+				"network": [
+					{
+						"uuid" : "03206c92-50f2-40b0-ad05-5f02cab2e932"
+					},
+					{
+						"uuid" : "03d781c3-65e3-4a7a-b6cd-a7ce7e23b8c5"
+					},
+					{
+						"uuid" : "03854a28-fafe-428f-964f-760cd1b83f1f"
+					},
+					{
+						"uuid" : "03bae36d-a30a-4640-9a35-f2ccb0e2cddc"
+					}
+				]
 		  },
 		  "name": "Example router",
 		  "type": "normal",
-		  "uuid": "04c0df35-2658-4b0c-8ac7-962090f4e92a"
+		  "uuid": "04c0df35-2658-4b0c-8ac7-962090f4e92a",
+		  "labels": [
+				{
+					"key": "managedBy",
+					"value": "upcloud-go-sdk-unit-test"
+				}
+			]
 		}
-	  }
-	`
+	}`
 
 	var router Router
 	err := json.Unmarshal([]byte(originalJSON), &router)
@@ -497,6 +502,12 @@ func TestUnmarshalRouter(t *testing.T) {
 		Name: "Example router",
 		Type: "normal",
 		UUID: "04c0df35-2658-4b0c-8ac7-962090f4e92a",
+		Labels: LabelSlice{
+			{
+				Key:   "managedBy",
+				Value: "upcloud-go-sdk-unit-test",
+			},
+		},
 	}
 
 	assert.Equal(t, testRouter, router)

upcloud/request/kubernetes.go

@@ -19,32 +19,22 @@ func (r *GetKubernetesClustersRequest) RequestURL() string {
 	return kubernetesClusterBasePath
 }
 
-type KubernetesFilter interface {
-	ToQueryParam() string
-}
+// Deprecated: KubernetesFilter filter is deprecated. Use QueryFilter instead.
+type KubernetesFilter = QueryFilter
 
 // GetKubernetesClustersWithFiltersRequest represents a request to get all clusters
 // using labels or label keys as filters.
 // Using multiple filters returns only clusters that match all.
 type GetKubernetesClustersWithFiltersRequest struct {
-	Filters []KubernetesFilter
+	Filters []QueryFilter
 }
 
 // RequestURL implements the Request interface.
 func (r *GetKubernetesClustersWithFiltersRequest) RequestURL() string {
 	if len(r.Filters) == 0 {
 		return kubernetesClusterBasePath
 	}
-
-	params := ""
-	for _, v := range r.Filters {
-		if len(params) > 0 {
-			params += "&"
-		}
-		params += v.ToQueryParam()
-	}
-
-	return fmt.Sprintf("%s?%s", kubernetesClusterBasePath, params)
+	return fmt.Sprintf("%s?%s", kubernetesClusterBasePath, encodeQueryFilters(r.Filters))
 }
 
 // GetKubernetesClusterRequest represents a request to get a Kubernetes cluster details

upcloud/request/kubernetes_test.go

@@ -89,8 +89,8 @@ func TestKubernetes(t *testing.T) {
 		expected := fmt.Sprintf(
 			"%s?%s&%s",
 			kubernetesClusterBasePath,
-			"labels=managedBy",
-			"labels=managedBy=upcloud-go-sdk-unit-test",
+			"label=managedBy",
+			"label=managedBy%3Dupcloud-go-sdk-unit-test",
 		)
 
 		r := exampleGetKubernetesClustersWithFiltersRequest()

upcloud/request/label.go

@@ -11,13 +11,13 @@ type FilterLabel struct {
 }
 
 func (l FilterLabel) ToQueryParam() string {
-	return fmt.Sprintf("labels=%s=%s", l.Key, l.Value)
+	return fmt.Sprintf("label=%s=%s", l.Key, l.Value)
 }
 
 type FilterLabelKey struct {
 	Key string
 }
 
 func (k FilterLabelKey) ToQueryParam() string {
-	return fmt.Sprintf("labels=%s", k.Key)
+	return fmt.Sprintf("label=%s", k.Key)
 }

upcloud/request/network.go

@@ -232,6 +232,21 @@ func (r ModifyNetworkInterfaceRequest) MarshalJSON() ([]byte, error) {
 	return json.Marshal(&v)
 }
 
+// GetRouterssequest represents a request to list routers.
+type GetRoutersRequest struct {
+	Filters []QueryFilter
+}
+
+func (r *GetRoutersRequest) RequestURL() string {
+	basePath := "/router"
+
+	if len(r.Filters) == 0 {
+		return basePath
+	}
+
+	return fmt.Sprintf("%s?%s", basePath, encodeQueryFilters(r.Filters))
+}
+
 // GetRouterDetailsRequest represents a request to get details about a single router.
 type GetRouterDetailsRequest struct {
 	UUID string
@@ -244,7 +259,8 @@ func (r *GetRouterDetailsRequest) RequestURL() string {
 
 // CreateRouterRequest represents a request to create a new router.
 type CreateRouterRequest struct {
-	Name string `json:"name"`
+	Name   string          `json:"name"`
+	Labels []upcloud.Label `json:"labels,omitempty"`
 }
 
 // RequestURL implements the Request interface.
@@ -266,9 +282,9 @@ func (r CreateRouterRequest) MarshalJSON() ([]byte, error) {
 
 // ModifyRouterRequest represents a request to modify an existing router.
 type ModifyRouterRequest struct {
-	UUID string `json:"-"`
-
-	Name string `json:"name"`
+	UUID   string           `json:"-"`
+	Name   string           `json:"name"`
+	Labels *[]upcloud.Label `json:"labels,omitempty"`
 }
 
 // RequestURL implements the Request interface.

upcloud/request/network_test.go

@@ -320,4 +320,24 @@ func TestMarshalModifyRouterRequest(t *testing.T) {
 	assert.JSONEq(t, expectedJSON, string(actualJSON))
 
 	assert.Equal(t, "/router/foo", request.RequestURL())
+
+	request = ModifyRouterRequest{
+		UUID:   "",
+		Name:   "Modified router",
+		Labels: &[]upcloud.Label{},
+	}
+
+	expectedJSON = `
+	  {
+		"router": {
+		  "name": "Modified router",
+		  "labels": []
+		}
+	  }
+	`
+
+	actualJSON, err = json.Marshal(&request)
+	assert.NoError(t, err)
+
+	assert.JSONEq(t, expectedJSON, string(actualJSON))
 }

upcloud/request/request.go

@@ -1,7 +1,26 @@
 package request
 
+import "net/url"
+
 // Request is the interface for request objects
 type Request interface {
 	// RequestURL returns the relative API URL for the request, excluding the API version.
 	RequestURL() string
 }
+
+type QueryFilter interface {
+	ToQueryParam() string
+}
+
+func encodeQueryFilters(f []QueryFilter) string {
+	u := url.Values{}
+	for _, v := range f {
+		p, err := url.ParseQuery(v.ToQueryParam())
+		if err == nil {
+			for key := range p {
+				u.Add(key, p.Get(key))
+			}
+		}
+	}
+	return u.Encode()
+}

upcloud/request/request_test.go

@@ -0,0 +1,22 @@
+package request
+
+import (
+	"testing"
+
+	"github.com/UpCloudLtd/upcloud-go-api/v5/upcloud"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestEncodeQueryFilters(t *testing.T) {
+	want := "label=env%3Dprod&label=v2"
+	got := encodeQueryFilters([]QueryFilter{
+		FilterLabel{
+			Label: upcloud.Label{
+				Key:   "env",
+				Value: "prod",
+			},
+		},
+		FilterLabelKey{Key: "v2"},
+	})
+	assert.Equal(t, want, got)
+}