feat(load-balancer): label support (#202)

Author: peknur

CHANGELOG.md

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

upcloud/load_balancer.go

@@ -230,6 +230,7 @@ type LoadBalancer struct {
 	NetworkUUID      string                       `json:"network_uuid,omitempty"` // deprecated
 	Networks         []LoadBalancerNetwork        `json:"networks,omitempty"`
 	DNSName          string                       `json:"dns_name,omitempty"` // deprecated
+	Labels           []Label                      `json:"labels,omitempty"`
 	ConfiguredStatus LoadBalancerConfiguredStatus `json:"configured_status,omitempty"`
 	OperationalState LoadBalancerOperationalState `json:"operational_state,omitempty"`
 	Frontends        []LoadBalancerFrontend       `json:"frontends,omitempty"`

upcloud/load_balancer_test.go

@@ -21,6 +21,12 @@ func TestMarshalLoadBalancer(t *testing.T) {
 			"updated_at": "2022-02-11T17:33:59.898714Z",
 			"uuid": "0aff6dac-143c-4300-9b33-ee2756f6592d",
 			"zone": "fi-hel1",
+			"labels": [
+				{
+					"key": "managedby",
+					"value": "upcloud-go-sdk-unit-test"
+				}
+			],
 			"resolvers": [
 				{
 					"cache_invalid": 30,
@@ -134,6 +140,12 @@ func TestMarshalLoadBalancer(t *testing.T) {
 		OperationalState: LoadBalancerOperationalStateRunning,
 		CreatedAt:        timeParse("2021-12-07T13:58:30.817272Z"),
 		UpdatedAt:        timeParse("2022-02-11T17:33:59.898714Z"),
+		Labels: []Label{
+			{
+				Key:   "managedby",
+				Value: "upcloud-go-sdk-unit-test",
+			},
+		},
 		Frontends: []LoadBalancerFrontend{
 			{
 				Name:           "example-frontend",

upcloud/network_test.go

@@ -502,7 +502,7 @@ func TestUnmarshalRouter(t *testing.T) {
 		Name: "Example router",
 		Type: "normal",
 		UUID: "04c0df35-2658-4b0c-8ac7-962090f4e92a",
-		Labels: LabelSlice{
+		Labels: []Label{
 			{
 				Key:   "managedBy",
 				Value: "upcloud-go-sdk-unit-test",

upcloud/request/load_balancer.go

@@ -12,14 +12,23 @@ const loadBalancerCertificateBundleBaseURL string = "/load-balancer/certificate-
 // GetLoadBalancersRequest represents a request to list load balancers
 // List size can be filtered using optional Page object
 type GetLoadBalancersRequest struct {
-	Page *Page
+	Page    *Page
+	Filters []QueryFilter
 }
 
 func (r *GetLoadBalancersRequest) RequestURL() string {
+	u := "/load-balancer"
+	f := make([]QueryFilter, len(r.Filters))
+	copy(f, r.Filters)
 	if r.Page != nil {
-		return fmt.Sprintf("/load-balancer?%s", r.Page.String())
+		f = append(f, r.Page)
 	}
-	return "/load-balancer"
+
+	if len(f) == 0 {
+		return u
+	}
+
+	return fmt.Sprintf("%s?%s", u, encodeQueryFilters(f))
 }
 
 // GetLoadBalancerRequest represents a request to get load balancer details
@@ -50,6 +59,7 @@ type CreateLoadBalancerRequest struct {
 	Frontends        []LoadBalancerFrontend               `json:"frontends"`
 	Backends         []LoadBalancerBackend                `json:"backends"`
 	Resolvers        []LoadBalancerResolver               `json:"resolvers"`
+	Labels           []upcloud.Label                      `json:"labels,omitempty"`
 }
 
 func (r *CreateLoadBalancerRequest) RequestURL() string {
@@ -58,10 +68,11 @@ func (r *CreateLoadBalancerRequest) RequestURL() string {
 
 // ModifyLoadBalancerRequest represents a request to modify load balancer
 type ModifyLoadBalancerRequest struct {
-	UUID             string `json:"-"`
-	Name             string `json:"name,omitempty"`
-	Plan             string `json:"plan,omitempty"`
-	ConfiguredStatus string `json:"configured_status,omitempty"`
+	UUID             string           `json:"-"`
+	Name             string           `json:"name,omitempty"`
+	Plan             string           `json:"plan,omitempty"`
+	ConfiguredStatus string           `json:"configured_status,omitempty"`
+	Labels           *[]upcloud.Label `json:"labels,omitempty"`
 }
 
 func (r *ModifyLoadBalancerRequest) RequestURL() string {

upcloud/request/load_balancer_test.go

@@ -13,6 +13,39 @@ import (
 func TestGetLoadBalancersRequest(t *testing.T) {
 	assert.Equal(t, "/load-balancer", (&GetLoadBalancersRequest{}).RequestURL())
 	assert.Equal(t, "/load-balancer?limit=50&offset=450", (&GetLoadBalancersRequest{Page: &Page{Number: 10, Size: 50}}).RequestURL())
+
+	assert.Equal(t, "/load-balancer?label=size&label=color%3Dred&limit=50&offset=450", (&GetLoadBalancersRequest{
+		Page: &Page{
+			Number: 10,
+			Size:   50,
+		},
+		Filters: []QueryFilter{
+			FilterLabelKey{Key: "size"},
+			FilterLabel{
+				upcloud.Label{
+					Key:   "color",
+					Value: "red",
+				},
+			},
+		},
+	}).RequestURL())
+
+	// this should work also because Page is also QueryFilter
+	assert.Equal(t, "/load-balancer?label=size&label=color%3Dred&limit=50&offset=450", (&GetLoadBalancersRequest{
+		Filters: []QueryFilter{
+			&Page{
+				Number: 10,
+				Size:   50,
+			},
+			FilterLabelKey{Key: "size"},
+			FilterLabel{
+				upcloud.Label{
+					Key:   "color",
+					Value: "red",
+				},
+			},
+		},
+	}).RequestURL())
 }
 
 func TestCreateLoadBalancerRequest(t *testing.T) {
@@ -1263,3 +1296,85 @@ func ExampleCreateLoadBalancerRequest() {
 		fmt.Println(string(js))
 	}
 }
+
+func TestCreateLoadBalancerLabelsRequest(t *testing.T) {
+	expected := `
+	{
+		"name": "example-service",
+		"plan": "development",
+		"zone": "fi-hel1",
+		"network_uuid": "03631160-d57a-4926-ad48-a2f828229dcb",
+		"configured_status": "started",
+		"frontends": [],
+		"backends": [],
+		"resolvers": [],
+		"labels": [
+			{
+				"key": "managedby",
+				"value": "upcloud-go-sdk-unit-test"
+			}
+		]
+	}
+	`
+	r := CreateLoadBalancerRequest{
+		Name:             "example-service",
+		Plan:             "development",
+		Zone:             "fi-hel1",
+		NetworkUUID:      "03631160-d57a-4926-ad48-a2f828229dcb",
+		ConfiguredStatus: upcloud.LoadBalancerConfiguredStatusStarted,
+		Frontends:        []LoadBalancerFrontend{},
+		Backends:         []LoadBalancerBackend{},
+		Resolvers:        []LoadBalancerResolver{},
+		Labels: []upcloud.Label{
+			{
+				Key:   "managedby",
+				Value: "upcloud-go-sdk-unit-test",
+			},
+		},
+	}
+	actual, err := json.Marshal(&r)
+	assert.NoError(t, err)
+	assert.JSONEq(t, expected, string(actual))
+}
+
+func TestModifyLoadBalancerLabelsRequest(t *testing.T) {
+	expected := `
+	{
+		"labels": [
+			{
+				"key": "managedby",
+				"value": "upcloud-go-sdk-unit-test"
+			}
+		]
+	}
+	`
+	r := ModifyLoadBalancerRequest{
+		Labels: &[]upcloud.Label{
+			{
+				Key:   "managedby",
+				Value: "upcloud-go-sdk-unit-test",
+			},
+		},
+	}
+	actual, err := json.Marshal(&r)
+	assert.NoError(t, err)
+	assert.JSONEq(t, expected, string(actual))
+
+	expected = `
+	{
+		"labels": []
+	}
+	`
+	r = ModifyLoadBalancerRequest{
+		Labels: &[]upcloud.Label{},
+	}
+	actual, err = json.Marshal(&r)
+	assert.NoError(t, err)
+	assert.JSONEq(t, expected, string(actual))
+
+	expected = `{}`
+	r = ModifyLoadBalancerRequest{}
+	actual, err = json.Marshal(&r)
+	assert.NoError(t, err)
+	assert.JSONEq(t, expected, string(actual))
+}

upcloud/request/page.go

@@ -65,3 +65,7 @@ func (p *Page) Previous() *Page {
 func (p *Page) String() string {
 	return p.Values().Encode()
 }
+
+func (p *Page) ToQueryParam() string {
+	return p.String()
+}