More specific types for ObjectStorage response object fields (#74)
* more accurate types for objectstorage response object fields (e.g. ContentLength: string -> in64)
* containers unit tests for new field types
* more specific types for accounts headers fields
* update accounts unit tests
* download header unmarshal method and unit test
* object results unmarshal methods
diff --git a/openstack/objectstorage/v1/containers/results.go b/openstack/objectstorage/v1/containers/results.go
index 9eec3f4..ebe6eba 100644
--- a/openstack/objectstorage/v1/containers/results.go
+++ b/openstack/objectstorage/v1/containers/results.go
@@ -1,7 +1,9 @@
package containers
import (
+ "encoding/json"
"fmt"
+ "strconv"
"strings"
"github.com/gophercloud/gophercloud"
@@ -11,10 +13,10 @@
// Container represents a container resource.
type Container struct {
// The total number of bytes stored in the container.
- Bytes int `json:"bytes"`
+ Bytes int64 `json:"bytes"`
// The total number of objects stored in the container.
- Count int `json:"count"`
+ Count int64 `json:"count"`
// The name of the container.
Name string `json:"name"`
@@ -87,15 +89,68 @@
// GetHeader represents the headers returned in the response from a Get request.
type GetHeader struct {
AcceptRanges string `json:"Accept-Ranges"`
- BytesUsed string `json:"X-Account-Bytes-Used"`
- ContentLength string `json:"Content-Length"`
+ BytesUsed int64 `json:"-"`
+ ContentLength int64 `json:"-"`
ContentType string `json:"Content-Type"`
Date gophercloud.JSONRFC1123 `json:"Date"`
- ObjectCount string `json:"X-Container-Object-Count"`
- Read string `json:"X-Container-Read"`
+ ObjectCount int64 `json:"-"`
+ Read []string `json:"-"`
TransID string `json:"X-Trans-Id"`
VersionsLocation string `json:"X-Versions-Location"`
- Write string `json:"X-Container-Write"`
+ Write []string `json:"-"`
+}
+
+func (h *GetHeader) UnmarshalJSON(b []byte) error {
+ type tmp GetHeader
+ var getHeader *struct {
+ tmp
+ BytesUsed string `json:"X-Container-Bytes-Used"`
+ ContentLength string `json:"Content-Length"`
+ ObjectCount string `json:"X-Container-Object-Count"`
+ Write string `json:"X-Container-Write"`
+ Read string `json:"X-Container-Read"`
+ }
+ err := json.Unmarshal(b, &getHeader)
+ if err != nil {
+ return err
+ }
+
+ *h = GetHeader(getHeader.tmp)
+
+ switch getHeader.BytesUsed {
+ case "":
+ h.BytesUsed = 0
+ default:
+ h.BytesUsed, err = strconv.ParseInt(getHeader.BytesUsed, 10, 64)
+ if err != nil {
+ return err
+ }
+ }
+
+ switch getHeader.ContentLength {
+ case "":
+ h.ContentLength = 0
+ default:
+ h.ContentLength, err = strconv.ParseInt(getHeader.ContentLength, 10, 64)
+ if err != nil {
+ return err
+ }
+ }
+
+ switch getHeader.ObjectCount {
+ case "":
+ h.ObjectCount = 0
+ default:
+ h.ObjectCount, err = strconv.ParseInt(getHeader.ObjectCount, 10, 64)
+ if err != nil {
+ return err
+ }
+ }
+
+ h.Read = strings.Split(getHeader.Read, ",")
+ h.Write = strings.Split(getHeader.Write, ",")
+
+ return nil
}
// GetResult represents the result of a get operation.
@@ -129,12 +184,38 @@
// CreateHeader represents the headers returned in the response from a Create request.
type CreateHeader struct {
- ContentLength string `json:"Content-Length"`
+ ContentLength int64 `json:"-"`
ContentType string `json:"Content-Type"`
Date gophercloud.JSONRFC1123 `json:"Date"`
TransID string `json:"X-Trans-Id"`
}
+func (h *CreateHeader) UnmarshalJSON(b []byte) error {
+ type tmp CreateHeader
+ var header *struct {
+ tmp
+ ContentLength string `json:"Content-Length"`
+ }
+ err := json.Unmarshal(b, &header)
+ if err != nil {
+ return err
+ }
+
+ *h = CreateHeader(header.tmp)
+
+ switch header.ContentLength {
+ case "":
+ h.ContentLength = 0
+ default:
+ h.ContentLength, err = strconv.ParseInt(header.ContentLength, 10, 64)
+ if err != nil {
+ return err
+ }
+ }
+
+ return nil
+}
+
// CreateResult represents the result of a create operation. To extract the
// the headers from the HTTP response, you can invoke the 'ExtractHeader'
// method on the result struct.
@@ -152,12 +233,38 @@
// UpdateHeader represents the headers returned in the response from a Update request.
type UpdateHeader struct {
- ContentLength string `json:"Content-Length"`
+ ContentLength int64 `json:"-"`
ContentType string `json:"Content-Type"`
Date gophercloud.JSONRFC1123 `json:"Date"`
TransID string `json:"X-Trans-Id"`
}
+func (h *UpdateHeader) UnmarshalJSON(b []byte) error {
+ type tmp UpdateHeader
+ var header *struct {
+ tmp
+ ContentLength string `json:"Content-Length"`
+ }
+ err := json.Unmarshal(b, &header)
+ if err != nil {
+ return err
+ }
+
+ *h = UpdateHeader(header.tmp)
+
+ switch header.ContentLength {
+ case "":
+ h.ContentLength = 0
+ default:
+ h.ContentLength, err = strconv.ParseInt(header.ContentLength, 10, 64)
+ if err != nil {
+ return err
+ }
+ }
+
+ return nil
+}
+
// UpdateResult represents the result of an update operation. To extract the
// the headers from the HTTP response, you can invoke the 'ExtractHeader'
// method on the result struct.
@@ -175,12 +282,38 @@
// DeleteHeader represents the headers returned in the response from a Delete request.
type DeleteHeader struct {
- ContentLength string `json:"Content-Length"`
+ ContentLength int64 `json:"-"`
ContentType string `json:"Content-Type"`
Date gophercloud.JSONRFC1123 `json:"Date"`
TransID string `json:"X-Trans-Id"`
}
+func (h *DeleteHeader) UnmarshalJSON(b []byte) error {
+ type tmp DeleteHeader
+ var header *struct {
+ tmp
+ ContentLength string `json:"Content-Length"`
+ }
+ err := json.Unmarshal(b, &header)
+ if err != nil {
+ return err
+ }
+
+ *h = DeleteHeader(header.tmp)
+
+ switch header.ContentLength {
+ case "":
+ h.ContentLength = 0
+ default:
+ h.ContentLength, err = strconv.ParseInt(header.ContentLength, 10, 64)
+ if err != nil {
+ return err
+ }
+ }
+
+ return nil
+}
+
// DeleteResult represents the result of a delete operation. To extract the
// the headers from the HTTP response, you can invoke the 'ExtractHeader'
// method on the result struct.
diff --git a/openstack/objectstorage/v1/containers/testing/fixtures.go b/openstack/objectstorage/v1/containers/testing/fixtures.go
index fe579d8..b68230a 100644
--- a/openstack/objectstorage/v1/containers/testing/fixtures.go
+++ b/openstack/objectstorage/v1/containers/testing/fixtures.go
@@ -103,7 +103,10 @@
th.TestHeader(t, r, "Accept", "application/json")
w.Header().Add("X-Container-Meta-Foo", "bar")
- w.Header().Add("X-Trans-Id", "1234567")
+ w.Header().Set("Content-Length", "0")
+ w.Header().Set("Content-Type", "text/html; charset=UTF-8")
+ w.Header().Set("Date", "Wed, 17 Aug 2016 19:25:43 GMT")
+ w.Header().Set("X-Trans-Id", "tx554ed59667a64c61866f1-0058b4ba37")
w.WriteHeader(http.StatusNoContent)
})
}
@@ -137,6 +140,15 @@
th.TestMethod(t, r, "HEAD")
th.TestHeader(t, r, "X-Auth-Token", fake.TokenID)
th.TestHeader(t, r, "Accept", "application/json")
+ w.Header().Set("Accept-Ranges", "bytes")
+ w.Header().Set("Content-Type", "application/json; charset=utf-8")
+ w.Header().Set("Date", "Wed, 17 Aug 2016 19:25:43 GMT")
+ w.Header().Set("X-Container-Bytes-Used", "100")
+ w.Header().Set("X-Container-Object-Count", "4")
+ w.Header().Set("X-Container-Read", "test")
+ w.Header().Set("X-Container-Write", "test2,user4")
+ w.Header().Set("X-Timestamp", "1471298837.95721")
+ w.Header().Set("X-Trans-Id", "tx554ed59667a64c61866f1-0057b4ba37")
w.WriteHeader(http.StatusNoContent)
})
}
diff --git a/openstack/objectstorage/v1/containers/testing/requests_test.go b/openstack/objectstorage/v1/containers/testing/requests_test.go
index 0d32882..abac922 100644
--- a/openstack/objectstorage/v1/containers/testing/requests_test.go
+++ b/openstack/objectstorage/v1/containers/testing/requests_test.go
@@ -2,14 +2,19 @@
import (
"testing"
+ "time"
+ "github.com/gophercloud/gophercloud"
"github.com/gophercloud/gophercloud/openstack/objectstorage/v1/containers"
"github.com/gophercloud/gophercloud/pagination"
th "github.com/gophercloud/gophercloud/testhelper"
fake "github.com/gophercloud/gophercloud/testhelper/client"
)
-var metadata = map[string]string{"gophercloud-test": "containers"}
+var (
+ metadata = map[string]string{"gophercloud-test": "containers"}
+ loc, _ = time.LoadLocation("GMT")
+)
func TestListContainerInfo(t *testing.T) {
th.SetupHTTP()
@@ -83,10 +88,17 @@
options := containers.CreateOpts{ContentType: "application/json", Metadata: map[string]string{"foo": "bar"}}
res := containers.Create(fake.ServiceClient(), "testContainer", options)
- c, err := res.Extract()
- th.CheckNoErr(t, err)
th.CheckEquals(t, "bar", res.Header["X-Container-Meta-Foo"][0])
- th.CheckEquals(t, "1234567", c.TransID)
+
+ expected := &containers.CreateHeader{
+ ContentLength: 0,
+ ContentType: "text/html; charset=UTF-8",
+ Date: gophercloud.JSONRFC1123(time.Date(2016, time.August, 17, 19, 25, 43, 0, loc)), //Wed, 17 Aug 2016 19:25:43 GMT
+ TransID: "tx554ed59667a64c61866f1-0058b4ba37",
+ }
+ actual, err := res.Extract()
+ th.CheckNoErr(t, err)
+ th.AssertDeepEquals(t, expected, actual)
}
func TestDeleteContainer(t *testing.T) {
@@ -113,6 +125,21 @@
defer th.TeardownHTTP()
HandleGetContainerSuccessfully(t)
- _, err := containers.Get(fake.ServiceClient(), "testContainer").ExtractMetadata()
+ res := containers.Get(fake.ServiceClient(), "testContainer")
+ _, err := res.ExtractMetadata()
th.CheckNoErr(t, err)
+
+ expected := &containers.GetHeader{
+ AcceptRanges: "bytes",
+ BytesUsed: 100,
+ ContentType: "application/json; charset=utf-8",
+ Date: gophercloud.JSONRFC1123(time.Date(2016, time.August, 17, 19, 25, 43, 0, loc)), //Wed, 17 Aug 2016 19:25:43 GMT
+ ObjectCount: 4,
+ Read: []string{"test"},
+ TransID: "tx554ed59667a64c61866f1-0057b4ba37",
+ Write: []string{"test2", "user4"},
+ }
+ actual, err := res.Extract()
+ th.CheckNoErr(t, err)
+ th.AssertDeepEquals(t, expected, actual)
}