Merge pull request #71 from UpCloudLtd/object-storage

Object storage

Author: Iivari Leinonen

go.sum

@@ -17,6 +17,7 @@ github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=

upcloud/client/client.go

@@ -14,7 +14,7 @@ import (
 
 // Constants
 const (
-	DefaultAPIVersion = "1.3.4"
+	DefaultAPIVersion = "1.3.6"
 	DefaultAPIBaseURL = "https://api.upcloud.com"
 
 	// The default timeout (in seconds)

upcloud/object_storage.go

@@ -0,0 +1,64 @@
+package upcloud
+
+import "encoding/json"
+
+// ObjectStorage represents a Object Storage
+type ObjectStorage struct {
+	Created     string `json:"created"`
+	Description string `json:"description"`
+	Name        string `json:"name"`
+	Size        int    `json:"size"`
+	State       string `json:"state"`
+	URL         string `json:"url"`
+	UUID        string `json:"uuid"`
+	Zone        string `json:"zone"`
+}
+
+// ObjectStorages represent a /object-storage response
+type ObjectStorages struct {
+	ObjectStorages []ObjectStorage `json:"object_storages"`
+}
+
+// UnmarshalJSON is a custom unmarshaller that deals with
+// deeply embedded values.
+func (o *ObjectStorages) UnmarshalJSON(b []byte) error {
+	type objectStorageWrapper struct {
+		ObjectStorages []ObjectStorage `json:"object_storage"`
+	}
+
+	v := struct {
+		ObjectStorages objectStorageWrapper `json:"object_storages"`
+	}{}
+	err := json.Unmarshal(b, &v)
+	if err != nil {
+		return err
+	}
+
+	o.ObjectStorages = v.ObjectStorages.ObjectStorages
+
+	return nil
+}
+
+// ObjectStorageDetails represents details about a Object Storage
+type ObjectStorageDetails struct {
+	ObjectStorage
+	UsedSpace int `json:"used_space"`
+}
+
+// UnmarshalJSON is a custom unmarshaller that deals with
+// deeply embedded values.
+func (o *ObjectStorageDetails) UnmarshalJSON(b []byte) error {
+	type localObjectStorageDetails ObjectStorageDetails
+
+	v := struct {
+		ObjectStorageDetails localObjectStorageDetails `json:"object_storage"`
+	}{}
+	err := json.Unmarshal(b, &v)
+	if err != nil {
+		return err
+	}
+
+	(*o) = ObjectStorageDetails(v.ObjectStorageDetails)
+
+	return nil
+}

upcloud/object_storage_test.go

@@ -0,0 +1,45 @@
+package upcloud
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+// TestUnmarshalObjectStorages tests that Object Storages are unmarshaled correctly
+func TestUnmarshalObjectStorages(t *testing.T) {
+	originalJSON := `
+		{
+			"object_storages": {
+				"object_storage": [
+					{
+						"created": "2020-07-23T05:06:35Z",
+						"description": "Example object storage",
+						"name": "example-object-storage",
+						"size": 250,
+						"state": "started",
+						"url": "https://example-object-storage.nl-ams1.upcloudobjects.com/",
+						"uuid": "06832a75-be7b-4d23-be05-130dc3dfd9e7",
+						"zone": "uk-lon1"
+					}
+				]
+			}
+		}
+	`
+
+	objectStorages := ObjectStorages{}
+	err := json.Unmarshal([]byte(originalJSON), &objectStorages)
+	assert.Nil(t, err)
+	assert.Len(t, objectStorages.ObjectStorages, 1)
+
+	objectStorage := objectStorages.ObjectStorages[0]
+	assert.Equal(t, "2020-07-23T05:06:35Z", objectStorage.Created)
+	assert.Equal(t, "Example object storage", objectStorage.Description)
+	assert.Equal(t, "example-object-storage", objectStorage.Name)
+	assert.Equal(t, 250, objectStorage.Size)
+	assert.Equal(t, "started", objectStorage.State)
+	assert.Equal(t, "https://example-object-storage.nl-ams1.upcloudobjects.com/", objectStorage.URL)
+	assert.Equal(t, "06832a75-be7b-4d23-be05-130dc3dfd9e7", objectStorage.UUID)
+	assert.Equal(t, "uk-lon1", objectStorage.Zone)
+}

upcloud/request/object_storage.go

@@ -0,0 +1,79 @@
+package request
+
+import (
+	"encoding/json"
+	"fmt"
+)
+
+// GetObjectStorageDetailsRequest represents a request for retrieving details about a Object Storage device
+type GetObjectStorageDetailsRequest struct {
+	UUID string
+}
+
+// RequestURL implements the Request interface
+func (r *GetObjectStorageDetailsRequest) RequestURL() string {
+	return fmt.Sprintf("/object-storage/%s", r.UUID)
+}
+
+// CreateObjectStorageRequest represents a request for creating a new Object Storage device
+type CreateObjectStorageRequest struct {
+	Name        string `json:"name,omitempty"`
+	Description string `json:"description,omitempty"`
+	Zone        string `json:"zone"`
+	AccessKey   string `json:"access_key"`
+	SecretKey   string `json:"secret_key"`
+	Size        int    `json:"size"`
+}
+
+// MarshalJSON is a custom marshaller that deals with
+// deeply embedded values.
+func (r CreateObjectStorageRequest) MarshalJSON() ([]byte, error) {
+	type localCreateObjectStorageRequest CreateObjectStorageRequest
+	v := struct {
+		ObjectStorage localCreateObjectStorageRequest `json:"object_storage"`
+	}{}
+	v.ObjectStorage = localCreateObjectStorageRequest(r)
+
+	return json.Marshal(&v)
+}
+
+// RequestURL implements the Request interface
+func (r *CreateObjectStorageRequest) RequestURL() string {
+	return "/object-storage"
+}
+
+// ModifyObjectStorageRequest represents a request to modify a Object Storage
+type ModifyObjectStorageRequest struct {
+	UUID        string `json:"-"`
+	Description string `json:"description,omitempty"`
+	AccessKey   string `json:"access_key,omitempty"`
+	SecretKey   string `json:"secret_key,omitempty"`
+	Size        int    `json:"size,omitempty"`
+}
+
+// MarshalJSON is a custom marshaller that deals with
+// deeply embedded values.
+func (r ModifyObjectStorageRequest) MarshalJSON() ([]byte, error) {
+	type localModifyObjectStorageRequest ModifyObjectStorageRequest
+	v := struct {
+		ModifyObjectStorageRequest localModifyObjectStorageRequest `json:"object_storage"`
+	}{}
+	v.ModifyObjectStorageRequest = localModifyObjectStorageRequest(r)
+
+	return json.Marshal(&v)
+}
+
+// RequestURL implements the Request interface
+func (r *ModifyObjectStorageRequest) RequestURL() string {
+	return fmt.Sprintf("/object-storage/%s", r.UUID)
+}
+
+// DeleteObjectStorageRequest represents a request to delete a Object Storage
+type DeleteObjectStorageRequest struct {
+	UUID string
+}
+
+// RequestURL implements the Request interface
+func (r *DeleteObjectStorageRequest) RequestURL() string {
+	return fmt.Sprintf("/object-storage/%s", r.UUID)
+}

upcloud/request/object_storage_test.go

@@ -0,0 +1,81 @@
+package request
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+// TestGetObjectStorageDetailsRequest tests that GetObjectStorageDetailsRequest objects behave correctly
+func TestGetObjectStorageDetailsRequest(t *testing.T) {
+	request := GetObjectStorageDetailsRequest{
+		UUID: "foo",
+	}
+
+	assert.Equal(t, "/object-storage/foo", request.RequestURL())
+}
+
+// TestCreateObjectStorageRequest tests that CreateObjectStorageRequest objects behave correctly
+func TestCreateObjectStorageRequest(t *testing.T) {
+	request := CreateObjectStorageRequest{
+		Name:        "app-object-storage",
+		Description: "App object storage",
+		Zone:        "fi-hel2",
+		Size:        500,
+		AccessKey:   "UCOB5HE4NVTVFMXXRBQ2",
+		SecretKey:   "ssLDVHvTRjHaEAPRcMiFep3HItcqdNUNtql3DcLx",
+	}
+
+	expectedJSON := `
+		{
+			"object_storage": {
+				"access_key": "UCOB5HE4NVTVFMXXRBQ2",
+				"description": "App object storage",
+				"name": "app-object-storage",
+				"secret_key": "ssLDVHvTRjHaEAPRcMiFep3HItcqdNUNtql3DcLx",
+				"zone": "fi-hel2",
+				"size": 500
+			}
+		}
+	`
+
+	actualJSON, err := json.Marshal(&request)
+	assert.NoError(t, err)
+	assert.JSONEq(t, expectedJSON, string(actualJSON))
+	assert.Equal(t, "/object-storage", request.RequestURL())
+}
+
+// TestModifyObjectStorageRequest tests that ModifyObjectStorageRequest objects behave correctly
+func TestModifyObjectStorageRequest(t *testing.T) {
+	request := ModifyObjectStorageRequest{
+		UUID:        "foo",
+		Description: "Modified object storage",
+		AccessKey:   "UCOB5HE4NVTVFMXXRBQ2",
+		SecretKey:   "ssLDVHvTRjHaEAPRcMiFep3HItcqdNUNtql3DcLx",
+	}
+
+	expectedJSON := `
+		{
+			"object_storage": {
+				"access_key": "UCOB5HE4NVTVFMXXRBQ2",
+				"description": "Modified object storage",
+				"secret_key": "ssLDVHvTRjHaEAPRcMiFep3HItcqdNUNtql3DcLx"
+			}
+		}
+	`
+
+	actualJSON, err := json.Marshal(&request)
+	assert.Nil(t, err)
+	assert.JSONEq(t, expectedJSON, string(actualJSON))
+	assert.Equal(t, "/object-storage/foo", request.RequestURL())
+}
+
+// TestDeleteObjectStorageRequest tests that DeleteObjectStorageRequest objects behave correctly
+func TestDeleteObjectStorageRequest(t *testing.T) {
+	request := DeleteObjectStorageRequest{
+		UUID: "foo",
+	}
+
+	assert.Equal(t, "/object-storage/foo", request.RequestURL())
+}

upcloud/service/fixtures/getobjectstoragedetails.yaml

@@ -0,0 +1,81 @@
+---
+version: 1
+interactions:
+- request:
+    body: '{"object_storage":{"name":"go-test-getobjectstoragedetails","description":"App object storage","zone":"fi-hel2","access_key":"UCOB5HE4NVTVFMXXRBQ2","secret_key":"ssLDVHvTRjHaEAPRcMiFep3HItcqdNUNtql3DcLx","size":500}}'
+    form: {}
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+    url: https://api.upcloud.com/1.3/object-storage
+    method: POST
+  response:
+    body: |
+      {
+         "object_storage" : {
+            "created" : "2020-11-12T07:20:22Z",
+            "description" : "App object storage",
+            "name" : "go-test-getobjectstoragedetails",
+            "size" : 500,
+            "state" : "started",
+            "url" : "https://go-test-getobjectstoragedetails.fi-hel2.upcloudobjects.com/",
+            "used_space" : 0,
+            "uuid" : "060f379b-6bab-440f-bcc8-6e49647dc3e2",
+            "zone" : "fi-hel2"
+         }
+      }
+    headers:
+      Content-Length:
+      - "405"
+      Content-Type:
+      - application/json; charset=UTF-8
+      Date:
+      - Thu, 12 Nov 2020 07:20:04 GMT
+      Server:
+      - Apache
+      Strict-Transport-Security:
+      - max-age=63072000
+    status: 201 Created
+    code: 201
+    duration: ""
+- request:
+    body: ""
+    form: {}
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+    url: https://api.upcloud.com/1.3/object-storage/060f379b-6bab-440f-bcc8-6e49647dc3e2
+    method: GET
+  response:
+    body: |
+      {
+         "object_storage" : {
+            "created" : "2020-11-12T07:20:22Z",
+            "description" : "App object storage",
+            "name" : "go-test-getobjectstoragedetails",
+            "size" : 500,
+            "state" : "started",
+            "url" : "https://go-test-getobjectstoragedetails.fi-hel2.upcloudobjects.com/",
+            "used_space" : 0,
+            "uuid" : "060f379b-6bab-440f-bcc8-6e49647dc3e2",
+            "zone" : "fi-hel2"
+         }
+      }
+    headers:
+      Content-Length:
+      - "405"
+      Content-Type:
+      - application/json; charset=UTF-8
+      Date:
+      - Thu, 12 Nov 2020 07:20:23 GMT
+      Server:
+      - Apache
+      Strict-Transport-Security:
+      - max-age=63072000
+    status: 200 OK
+    code: 200
+    duration: ""