Feat/network labels (#201)

Author: ka-myl

CHANGELOG.md

@@ -7,9 +7,7 @@ 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
-- network peering: label support
-- load-balancer: label support
+- labels support for: load-balancers, networks, network-peerings, routers
 
 ## Deprecated
 - request: `ServerFilter` and `ServerGroupFilter` types will be replaced with `QueryFilter` type in the future

upcloud/network.go

@@ -163,6 +163,7 @@ type Network struct {
 	Zone       string             `json:"zone"`
 	Router     string             `json:"router"`
 	Servers    NetworkServerSlice `json:"servers"`
+	Labels     []Label            `json:"labels"`
 }
 
 // UnmarshalJSON is a custom unmarshaller that deals with

upcloud/network_test.go

@@ -30,6 +30,12 @@ func TestUnmarshalNetworks(t *testing.T) {
 				  }
 				]
 			  },
+			  "labels": [
+				{
+					"key": "managedBy",
+					"value": "upcloud"
+				}
+  			  ],
 			  "name": "Public 80.69.172.0/22",
 			  "type": "public",
 			  "uuid": "03000000-0000-4000-8001-000000000000",
@@ -93,6 +99,12 @@ func TestUnmarshalNetworks(t *testing.T) {
 					Gateway: "80.69.172.1",
 				},
 			},
+			Labels: []Label{
+				{
+					Key:   "managedBy",
+					Value: "upcloud",
+				},
+			},
 			Name: "Public 80.69.172.0/22",
 			Type: NetworkTypePublic,
 			UUID: "03000000-0000-4000-8001-000000000000",
@@ -155,6 +167,16 @@ func TestUnmarshalNetwork(t *testing.T) {
 		  "uuid": "034c12bc-cf15-4b19-97b2-0ab4e51bb98d",
 		  "zone": "uk-lon1",
 		  "router": "04c0df35-2658-4b0c-8ac7-962090f4e92a",
+		  "labels": [
+			{
+				"key": "managedBy",
+				"value": "upcloud"
+			},
+			{
+				"key": "env",
+				"value": "test"
+			}
+		  ],
 		  "ip_networks": {
 			"ip_network": [
 			  {
@@ -190,6 +212,16 @@ func TestUnmarshalNetwork(t *testing.T) {
 		UUID:   "034c12bc-cf15-4b19-97b2-0ab4e51bb98d",
 		Zone:   "uk-lon1",
 		Router: "04c0df35-2658-4b0c-8ac7-962090f4e92a",
+		Labels: []Label{
+			{
+				Key:   "managedBy",
+				Value: "upcloud",
+			},
+			{
+				Key:   "env",
+				Value: "test",
+			},
+		},
 		IPNetworks: []IPNetwork{
 			{
 				Address:          "172.16.0.0/22",

upcloud/request/network.go

@@ -7,15 +7,33 @@ import (
 	"github.com/UpCloudLtd/upcloud-go-api/v5/upcloud"
 )
 
+// GetNetworksRequest represents a rwquest to get all networks
+type GetNetworksRequest struct {
+	Filters []QueryFilter
+}
+
+func (r *GetNetworksRequest) RequestURL() string {
+	if len(r.Filters) == 0 {
+		return "/network"
+	}
+
+	return fmt.Sprintf("/network?%s", encodeQueryFilters(r.Filters))
+}
+
 // GetNetworksInZoneRequest represents a request to get all networks
 // within the specified zone.
 type GetNetworksInZoneRequest struct {
-	Zone string
+	Zone    string
+	Filters []QueryFilter
 }
 
 // RequestURL implements the Request interface.
 func (r *GetNetworksInZoneRequest) RequestURL() string {
-	return fmt.Sprintf("/network/?zone=%s", r.Zone)
+	if len(r.Filters) == 0 {
+		return fmt.Sprintf("/network/?zone=%s", r.Zone)
+	}
+
+	return fmt.Sprintf("/network?zone=%s&%s", r.Zone, encodeQueryFilters(r.Filters))
 }
 
 // GetNetworkDetailsRequest represents a request to the the details of
@@ -35,6 +53,7 @@ type CreateNetworkRequest struct {
 	Zone       string                 `json:"zone,omitempty"`
 	Router     string                 `json:"router,omitempty"`
 	IPNetworks upcloud.IPNetworkSlice `json:"ip_networks,omitempty"`
+	Labels     []upcloud.Label        `json:"labels,omitempty"`
 }
 
 // RequestURL implements the Request interface.
@@ -61,6 +80,7 @@ type ModifyNetworkRequest struct {
 	Name       string                 `json:"name,omitempty"`
 	Zone       string                 `json:"zone,omitempty"`
 	IPNetworks upcloud.IPNetworkSlice `json:"ip_networks,omitempty"`
+	Labels     *[]upcloud.Label       `json:"labels,omitempty"`
 }
 
 // RequestURL implements the Request interface.

upcloud/request/network_test.go

@@ -9,13 +9,43 @@ import (
 	"github.com/UpCloudLtd/upcloud-go-api/v5/upcloud"
 )
 
+func TestMarshalGetNetworks(t *testing.T) {
+	request := GetNetworksRequest{}
+	assert.Equal(t, "/network", request.RequestURL())
+
+	request = GetNetworksRequest{Filters: []QueryFilter{
+		FilterLabel{Label: upcloud.Label{
+			Key:   "env",
+			Value: "test",
+		}},
+		FilterLabelKey{Key: "managedBy"},
+	}}
+
+	assert.Equal(t, "/network?label=env%3Dtest&label=managedBy", request.RequestURL())
+}
+
 // TestMarshalGetNetworksInZoneRequest tests that GetNetworksInZoneRequest behaves correctly
 func TestMarshalGetNetworksInZoneRequest(t *testing.T) {
 	request := GetNetworksInZoneRequest{
 		Zone: "foo",
 	}
 
 	assert.Equal(t, "/network/?zone=foo", request.RequestURL())
+
+	requestWithFilters := GetNetworksInZoneRequest{
+		Zone: "fi-hel1",
+		Filters: []QueryFilter{
+			FilterLabel{Label: upcloud.Label{
+				Key:   "env",
+				Value: "test",
+			}},
+			FilterLabelKey{
+				Key: "managed",
+			},
+		},
+	}
+
+	assert.Equal(t, "/network?zone=fi-hel1&label=env%3Dtest&label=managed", requestWithFilters.RequestURL())
 }
 
 // TestMarshalGetNetworkDetailsRequest tests that GetNetworkDetailsRequest behaves correctly
@@ -33,6 +63,12 @@ func TestMarshalCreateNetworkRequest(t *testing.T) {
 		Name:   "Test private net",
 		Zone:   "uk-lon1",
 		Router: "04c0df35-2658-4b0c-8ac7-962090f4e92a",
+		Labels: []upcloud.Label{
+			{
+				Key:   "env",
+				Value: "test",
+			},
+		},
 		IPNetworks: []upcloud.IPNetwork{
 			{
 				Address:          "172.16.0.0/22",
@@ -54,6 +90,12 @@ func TestMarshalCreateNetworkRequest(t *testing.T) {
 		  "name": "Test private net",
 		  "zone": "uk-lon1",
 		  "router": "04c0df35-2658-4b0c-8ac7-962090f4e92a",
+		  "labels": [
+			{
+				"key": "env",
+				"value": "test"
+			}
+		  ],
 		  "ip_networks" : {
 			"ip_network" : [
 			  {
@@ -114,6 +156,36 @@ func TestMarshalModifyNetworkRequest(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equal(t, "/network/foo", request.RequestURL())
 	assert.JSONEq(t, expectedJSON, string(actualJSON))
+
+	request = ModifyNetworkRequest{
+		UUID: "foo",
+		Name: "supername",
+		Labels: &[]upcloud.Label{
+			{
+				Key:   "env",
+				Value: "test",
+			},
+		},
+	}
+
+	expectedJSON = `
+	  {
+		"network": {
+		  "name": "supername",
+		  "labels": [
+			{
+				"key": "env",
+				"value": "test"
+			}
+		  ]
+	  	}
+	  }	
+	`
+
+	actualJSON, err = json.Marshal(&request)
+	assert.NoError(t, err)
+	assert.Equal(t, "/network/foo", request.RequestURL())
+	assert.JSONEq(t, expectedJSON, string(actualJSON))
 }
 
 // TestMarshalDeleteNetwork tests the DeleteNetworkRequest behaves correctly