From 75bb22785dd0d91bb2f11537ad5b69bf5c965616 Mon Sep 17 00:00:00 2001 From: Jared Watts Date: Tue, 21 Mar 2017 21:17:18 -0700 Subject: [PATCH] Update API routes to use DELETE verb and URL query params --- pkg/api/filesystem.go | 14 +++++++++---- pkg/api/filesystem_test.go | 2 +- pkg/api/image.go | 18 +++++++---------- pkg/api/image_test.go | 16 +++++++-------- pkg/api/object.go | 4 ++-- pkg/api/object_test.go | 2 +- pkg/api/routes.go | 12 ++++++------ pkg/rook/client/block.go | 37 +++++++++++++++++++++++------------ pkg/rook/client/filesystem.go | 35 +++++++++++++++++++++------------ 9 files changed, 81 insertions(+), 59 deletions(-) diff --git a/pkg/api/filesystem.go b/pkg/api/filesystem.go index a0b6fba7c..8cb683f96 100644 --- a/pkg/api/filesystem.go +++ b/pkg/api/filesystem.go @@ -86,11 +86,17 @@ func (h *Handler) CreateFileSystem(w http.ResponseWriter, r *http.Request) { } // Removes an existing filesystem from this cluster. -// POST -// /filesystem/remove +// DELETE +// /filesystem?name= func (h *Handler) RemoveFileSystem(w http.ResponseWriter, r *http.Request) { - fs, ok := handleReadFilesystemRequest(w, r, "remove filesystem") - if !ok { + fsName := r.URL.Query().Get("name") + fs := &model.FilesystemRequest{ + Name: fsName, + } + + if fs.Name == "" { + logger.Errorf("filesystem missing required fields: %+v", fs) + w.WriteHeader(http.StatusBadRequest) return } diff --git a/pkg/api/filesystem_test.go b/pkg/api/filesystem_test.go index 84bdbfdd8..c86305a2d 100644 --- a/pkg/api/filesystem_test.go +++ b/pkg/api/filesystem_test.go @@ -128,7 +128,7 @@ func TestRemoveFileSystemHandler(t *testing.T) { etcdClient.SetValue("/rook/services/ceph/fs/desired/myfs1/pool", "myfs1-pool") context := &clusterd.Context{EtcdClient: etcdClient} - req, err := http.NewRequest("POST", "http://10.0.0.100/filesystem/remove", strings.NewReader(`{"name": "myfs1"}`)) + req, err := http.NewRequest("DELETE", "http://10.0.0.100/filesystem?name=myfs1", nil) if err != nil { logger.Fatal(err) } diff --git a/pkg/api/image.go b/pkg/api/image.go index 115718bf2..28dcc03ba 100644 --- a/pkg/api/image.go +++ b/pkg/api/image.go @@ -143,19 +143,15 @@ func (h *Handler) CreateImage(w http.ResponseWriter, r *http.Request) { } // Deletes a block image from this cluster. -// POST -// /image/remove +// DELETE +// /image?name=&pool= func (h *Handler) DeleteImage(w http.ResponseWriter, r *http.Request) { - var deleteImageReq model.BlockImage - body, ok := handleReadBody(w, r, "delete image") - if !ok { - return - } + imageName := r.URL.Query().Get("name") + imagePool := r.URL.Query().Get("pool") - if err := json.Unmarshal(body, &deleteImageReq); err != nil { - logger.Errorf("failed to unmarshal delete image request body '%s': %+v", string(body), err) - w.WriteHeader(http.StatusBadRequest) - return + deleteImageReq := model.BlockImage{ + Name: imageName, + PoolName: imagePool, } if deleteImageReq.Name == "" || deleteImageReq.PoolName == "" { diff --git a/pkg/api/image_test.go b/pkg/api/image_test.go index dd0f1e8e8..3357c31fb 100644 --- a/pkg/api/image_test.go +++ b/pkg/api/image_test.go @@ -226,7 +226,7 @@ func TestCreateImageHandlerFailure(t *testing.T) { func TestDeleteImageHandler(t *testing.T) { context := &clusterd.Context{} - req, err := http.NewRequest("POST", "http://10.0.0.100/image/remove", nil) + req, err := http.NewRequest("DELETE", "http://10.0.0.100/image", nil) if err != nil { logger.Fatal(err) } @@ -238,14 +238,14 @@ func TestDeleteImageHandler(t *testing.T) { return cephFactory.NewConnWithClusterAndUser("mycluster", "admin") } - // image is missing from request body, should be bad request + // no image params are passed via URL query string, bad request h := newTestHandler(context, connFactory, cephFactory) h.DeleteImage(w, req) assert.Equal(t, http.StatusBadRequest, w.Code) assert.Equal(t, ``, w.Body.String()) - // request body exists but it's bad json, should be bad request - req, err = http.NewRequest("POST", "http://10.0.0.100/image/remove", strings.NewReader(`bad json`)) + // bad query param passed, should be bad request + req, err = http.NewRequest("DELETE", "http://10.0.0.100/image?badparam=foo", nil) if err != nil { logger.Fatal(err) } @@ -255,8 +255,8 @@ func TestDeleteImageHandler(t *testing.T) { assert.Equal(t, http.StatusBadRequest, w.Code) assert.Equal(t, ``, w.Body.String()) - // missing fields for the image passed via request body, should be bad request - req, err = http.NewRequest("POST", "http://10.0.0.100/image/remove", strings.NewReader(`{"imageName":"myImage1"}`)) + // missing fields for the image passed via query params, should be bad request + req, err = http.NewRequest("DELETE", "http://10.0.0.100/image?name=myImage1", nil) if err != nil { logger.Fatal(err) } @@ -267,7 +267,7 @@ func TestDeleteImageHandler(t *testing.T) { assert.Equal(t, ``, w.Body.String()) // well formed successful request to delete an image - req, err = http.NewRequest("POST", "http://10.0.0.100/image/remove", strings.NewReader(`{"imageName":"myImage1","poolName":"myPool1"}`)) + req, err = http.NewRequest("DELETE", "http://10.0.0.100/image?name=myImage1&pool=myPool1", nil) if err != nil { logger.Fatal(err) } @@ -292,7 +292,7 @@ func TestDeleteImageHandler(t *testing.T) { func TestDeleteImageHandlerFailure(t *testing.T) { context := &clusterd.Context{} - req, err := http.NewRequest("POST", "http://10.0.0.100/image/remove", strings.NewReader(`{"imageName":"myImage1","poolName":"myPool1"}`)) + req, err := http.NewRequest("DELETE", "http://10.0.0.100/image?name=myImage1&pool=myPool1", nil) if err != nil { logger.Fatal(err) } diff --git a/pkg/api/object.go b/pkg/api/object.go index a64f6594b..9429fd3d3 100644 --- a/pkg/api/object.go +++ b/pkg/api/object.go @@ -42,8 +42,8 @@ func (h *Handler) CreateObjectStore(w http.ResponseWriter, r *http.Request) { } // RemoveObjectStore removes the object store from this cluster. -// POST -// /objectstore/remove +// DELETE +// /objectstore func (h *Handler) RemoveObjectStore(w http.ResponseWriter, r *http.Request) { if err := h.config.ClusterHandler.RemoveObjectStore(); err != nil { logger.Errorf("failed to remove object store: %+v", err) diff --git a/pkg/api/object_test.go b/pkg/api/object_test.go index 384801ce6..6795f0555 100644 --- a/pkg/api/object_test.go +++ b/pkg/api/object_test.go @@ -65,7 +65,7 @@ func TestRemoveObjectStoreHandler(t *testing.T) { context := &clusterd.Context{EtcdClient: etcdClient} - req, err := http.NewRequest("POST", "http://10.0.0.100/objectstore/remove", nil) + req, err := http.NewRequest("DELETE", "http://10.0.0.100/objectstore", nil) if err != nil { logger.Fatal(err) } diff --git a/pkg/api/routes.go b/pkg/api/routes.go index dc7021d56..34aa8bc83 100644 --- a/pkg/api/routes.go +++ b/pkg/api/routes.go @@ -61,8 +61,8 @@ func (h *Handler) GetRoutes() []Route { }, { "DeleteImage", - "POST", - "/image/remove", + "DELETE", + "/image", h.DeleteImage, }, { @@ -91,8 +91,8 @@ func (h *Handler) GetRoutes() []Route { }, { "RemoveObjectStore", - "POST", - "/objectstore/remove", + "DELETE", + "/objectstore", h.RemoveObjectStore, }, { @@ -151,8 +151,8 @@ func (h *Handler) GetRoutes() []Route { }, { "RemoveFileSystem", - "POST", - "/filesystem/remove", + "DELETE", + "/filesystem", h.RemoveFileSystem, }, { diff --git a/pkg/rook/client/block.go b/pkg/rook/client/block.go index e2c43e13b..71a92c311 100644 --- a/pkg/rook/client/block.go +++ b/pkg/rook/client/block.go @@ -18,14 +18,13 @@ package client import ( "bytes" "encoding/json" - "path" + "net/url" "github.com/rook/rook/pkg/model" ) const ( - imageQueryName = "image" - imageRemoveQueryName = "remove" + imageQueryName = "image" ) func (c *RookNetworkRestClient) GetBlockImages() ([]model.BlockImage, error) { @@ -44,20 +43,32 @@ func (c *RookNetworkRestClient) GetBlockImages() ([]model.BlockImage, error) { } func (c *RookNetworkRestClient) CreateBlockImage(newImage model.BlockImage) (string, error) { - return c.handleBlockRequest(newImage, imageQueryName) -} - -func (c *RookNetworkRestClient) DeleteBlockImage(image model.BlockImage) (string, error) { - return c.handleBlockRequest(image, path.Join(imageQueryName, imageRemoveQueryName)) -} - -func (c *RookNetworkRestClient) handleBlockRequest(i model.BlockImage, queryPath string) (string, error) { - body, err := json.Marshal(i) + body, err := json.Marshal(newImage) if err != nil { return "", err } - resp, err := c.DoPost(queryPath, bytes.NewReader(body)) + resp, err := c.DoPost(imageQueryName, bytes.NewReader(body)) + if err != nil { + return "", err + } + + return string(resp), nil +} + +func (c *RookNetworkRestClient) DeleteBlockImage(image model.BlockImage) (string, error) { + baseURL, err := url.Parse(imageQueryName) + if err != nil { + return "", err + } + + params := url.Values{} + params.Add("name", image.Name) + params.Add("pool", image.PoolName) + + baseURL.RawQuery = params.Encode() + + resp, err := c.DoDelete(baseURL.String()) if err != nil { return "", err } diff --git a/pkg/rook/client/filesystem.go b/pkg/rook/client/filesystem.go index 2c0dbf5c5..66ce3b789 100644 --- a/pkg/rook/client/filesystem.go +++ b/pkg/rook/client/filesystem.go @@ -18,14 +18,13 @@ package client import ( "bytes" "encoding/json" - "path" + "net/url" "github.com/rook/rook/pkg/model" ) const ( - filesystemQueryName = "filesystem" - filesystemRemoveQueryName = "remove" + filesystemQueryName = "filesystem" ) func (c *RookNetworkRestClient) GetFilesystems() ([]model.Filesystem, error) { @@ -44,20 +43,30 @@ func (c *RookNetworkRestClient) GetFilesystems() ([]model.Filesystem, error) { } func (c *RookNetworkRestClient) CreateFilesystem(newFilesystem model.FilesystemRequest) (string, error) { - return c.handleFilesystemRequest(newFilesystem, filesystemQueryName) -} - -func (c *RookNetworkRestClient) DeleteFilesystem(deleteFilesystem model.FilesystemRequest) (string, error) { - return c.handleFilesystemRequest(deleteFilesystem, path.Join(filesystemQueryName, filesystemRemoveQueryName)) -} - -func (c *RookNetworkRestClient) handleFilesystemRequest(fs model.FilesystemRequest, queryPath string) (string, error) { - body, err := json.Marshal(fs) + body, err := json.Marshal(newFilesystem) if err != nil { return "", err } - resp, err := c.DoPost(queryPath, bytes.NewReader(body)) + resp, err := c.DoPost(filesystemQueryName, bytes.NewReader(body)) + if err != nil { + return "", err + } + + return string(resp), nil +} + +func (c *RookNetworkRestClient) DeleteFilesystem(deleteFilesystem model.FilesystemRequest) (string, error) { + baseURL, err := url.Parse(filesystemQueryName) + if err != nil { + return "", err + } + + params := url.Values{} + params.Add("name", deleteFilesystem.Name) + baseURL.RawQuery = params.Encode() + + resp, err := c.DoDelete(baseURL.String()) if err != nil { return "", err }