feat: allow choosing snapshot when creating a clone in CLI (#107)

agneum · astansler · commit 39ceb705e8cc · 2020-02-26T16:46:52.000Z
diff --git a/api/swagger-spec/dblab_server_swagger.yaml b/api/swagger-spec/dblab_server_swagger.yaml
@@ -97,7 +97,7 @@ paths:
           schema:
             $ref: '#/definitions/CreateClone'
       responses:
-        200:
+        201:
           description: "Successful operation"
           schema:
             $ref: "#/definitions/Clone"
@@ -172,6 +172,10 @@ paths:
           schema:
             $ref: '#/definitions/UpdateClone'
       responses:
+        200:
+          description: "Successful operation"
+          schema:
+            $ref: "#/definitions/Clone"
         404:
           description: "Not found"
           schema:
diff --git a/cmd/cli/commands/clone/actions.go b/cmd/cli/commands/clone/actions.go
@@ -12,7 +12,7 @@ import (
 	"github.com/urfave/cli/v2"
 
 	"gitlab.com/postgres-ai/database-lab/cmd/cli/commands"
-	"gitlab.com/postgres-ai/database-lab/pkg/client/dblabapi"
+	"gitlab.com/postgres-ai/database-lab/pkg/client/dblabapi/types"
 	"gitlab.com/postgres-ai/database-lab/pkg/models"
 )
 
@@ -48,16 +48,20 @@ func create() func(*cli.Context) error {
 			return err
 		}
 
-		cloneRequest := dblabapi.CreateRequest{
+		cloneRequest := types.CloneCreateRequest{
 			ID:        cliCtx.String("id"),
 			Project:   cliCtx.String("project"),
 			Protected: cliCtx.Bool("protected"),
-			DB: &dblabapi.DatabaseRequest{
+			DB: &types.DatabaseRequest{
 				Username: cliCtx.String("username"),
 				Password: cliCtx.String("password"),
 			},
 		}
 
+		if cliCtx.IsSet("snapshot-id") {
+			cloneRequest.Snapshot = &types.SnapshotCloneFieldRequest{ID: cliCtx.String("snapshot-id")}
+		}
+
 		var clone *models.Clone
 
 		if cliCtx.Bool("async") {
@@ -113,7 +117,7 @@ func update() func(*cli.Context) error {
 			return err
 		}
 
-		updateRequest := dblabapi.UpdateRequest{
+		updateRequest := types.CloneUpdateRequest{
 			Protected: cliCtx.Bool("protected"),
 		}
 
diff --git a/cmd/cli/commands/clone/command_list.go b/cmd/cli/commands/clone/command_list.go
@@ -47,6 +47,10 @@ func CommandList() []*cli.Command {
 						Name:  "id",
 						Usage: "clone ID (optional)",
 					},
+					&cli.StringFlag{
+						Name:  "snapshot-id",
+						Usage: "snapshot ID (optional)",
+					},
 					&cli.StringFlag{
 						Name:  "project",
 						Usage: "project name (optional)",
diff --git a/cmd/cli/commands/initialization/command_list.go b/cmd/cli/commands/initialization/command_list.go
@@ -19,7 +19,7 @@ func GlobalList() []*cli.Command {
 			CustomHelpTemplate: templates.CustomCommandHelpTemplate + templates.SupportProjectTemplate,
 			Flags: []cli.Flag{
 				&cli.StringFlag{
-					Name:     "environment_id",
+					Name:     "environment-id",
 					Usage:    "environment ID of Database Lab instance's API",
 					Required: true,
 				},
diff --git a/pkg/client/dblabapi/clone.go b/pkg/client/dblabapi/clone.go
@@ -14,6 +14,7 @@ import (
 
 	"github.com/pkg/errors"
 
+	"gitlab.com/postgres-ai/database-lab/pkg/client/dblabapi/types"
 	"gitlab.com/postgres-ai/database-lab/pkg/models"
 )
 
@@ -67,27 +68,13 @@ func (c *Client) GetClone(ctx context.Context, cloneID string) (*models.Clone, e
 	return &clone, nil
 }
 
-// CreateRequest represents clone params of a create request.
-type CreateRequest struct {
-	ID        string           `json:"id"`
-	Project   string           `json:"project"`
-	Protected bool             `json:"protected"`
-	DB        *DatabaseRequest `json:"db"`
-}
-
-// DatabaseRequest represents database params of a clone request.
-type DatabaseRequest struct {
-	Username string `json:"username"`
-	Password string `json:"password"`
-}
-
 // CreateClone creates a new Database Lab clone.
-func (c *Client) CreateClone(ctx context.Context, cloneRequest CreateRequest) (*models.Clone, error) {
+func (c *Client) CreateClone(ctx context.Context, cloneRequest types.CloneCreateRequest) (*models.Clone, error) {
 	u := c.URL("/clone")
 
 	body := bytes.NewBuffer(nil)
 	if err := json.NewEncoder(body).Encode(cloneRequest); err != nil {
-		return nil, errors.Wrap(err, "failed to encode CreateRequest")
+		return nil, errors.Wrap(err, "failed to encode CloneCreateRequest")
 	}
 
 	request, err := http.NewRequest(http.MethodPost, u.String(), body)
@@ -161,12 +148,12 @@ func (c *Client) watchCloneStatus(ctx context.Context, cloneID string, initialSt
 }
 
 // CreateCloneAsync asynchronously creates a new Database Lab clone.
-func (c *Client) CreateCloneAsync(ctx context.Context, cloneRequest CreateRequest) (*models.Clone, error) {
+func (c *Client) CreateCloneAsync(ctx context.Context, cloneRequest types.CloneCreateRequest) (*models.Clone, error) {
 	u := c.URL("/clone")
 
 	body := bytes.NewBuffer(nil)
 	if err := json.NewEncoder(body).Encode(cloneRequest); err != nil {
-		return nil, errors.Wrap(err, "failed to encode CreateRequest")
+		return nil, errors.Wrap(err, "failed to encode CloneCreateRequest")
 	}
 
 	request, err := http.NewRequest(http.MethodPost, u.String(), body)
@@ -190,18 +177,13 @@ func (c *Client) CreateCloneAsync(ctx context.Context, cloneRequest CreateReques
 	return &clone, nil
 }
 
-// UpdateRequest represents params of an update request.
-type UpdateRequest struct {
-	Protected bool `json:"protected"`
-}
-
 // UpdateClone updates an existing Database Lab clone.
-func (c *Client) UpdateClone(ctx context.Context, cloneID string, updateRequest UpdateRequest) (*models.Clone, error) {
+func (c *Client) UpdateClone(ctx context.Context, cloneID string, updateRequest types.CloneUpdateRequest) (*models.Clone, error) {
 	u := c.URL(fmt.Sprintf("/clone/%s", cloneID))
 
 	body := bytes.NewBuffer(nil)
 	if err := json.NewEncoder(body).Encode(updateRequest); err != nil {
-		return nil, errors.Wrap(err, "failed to encode UpdateRequest")
+		return nil, errors.Wrap(err, "failed to encode CloneUpdateRequest")
 	}
 
 	request, err := http.NewRequest(http.MethodPatch, u.String(), body)
diff --git a/pkg/client/dblabapi/clone_test.go b/pkg/client/dblabapi/clone_test.go
@@ -13,6 +13,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
+	"gitlab.com/postgres-ai/database-lab/pkg/client/dblabapi/types"
 	"gitlab.com/postgres-ai/database-lab/pkg/models"
 )
 
@@ -122,7 +123,7 @@ func TestClientCreateClone(t *testing.T) {
 			require.NoError(t, err)
 			defer func() { _ = r.Body.Close() }()
 
-			cloneRequest := CreateRequest{}
+			cloneRequest := types.CloneCreateRequest{}
 			err = json.Unmarshal(requestBody, &cloneRequest)
 			require.NoError(t, err)
 			clone = expectedClone
@@ -156,11 +157,11 @@ func TestClientCreateClone(t *testing.T) {
 	defer cancel()
 
 	// Send a request.
-	newClone, err := c.CreateClone(ctx, CreateRequest{
+	newClone, err := c.CreateClone(ctx, types.CloneCreateRequest{
 		ID:        "testCloneID",
 		Project:   "testProject",
 		Protected: true,
-		DB: &DatabaseRequest{
+		DB: &types.DatabaseRequest{
 			Username: "john",
 			Password: "doe",
 		},
@@ -198,7 +199,7 @@ func TestClientCreateCloneAsync(t *testing.T) {
 		require.NoError(t, err)
 		defer func() { _ = r.Body.Close() }()
 
-		cloneRequest := CreateRequest{}
+		cloneRequest := types.CloneCreateRequest{}
 		err = json.Unmarshal(requestBody, &cloneRequest)
 		require.NoError(t, err)
 
@@ -226,11 +227,11 @@ func TestClientCreateCloneAsync(t *testing.T) {
 	defer cancel()
 
 	// Send a request.
-	newClone, err := c.CreateCloneAsync(ctx, CreateRequest{
+	newClone, err := c.CreateCloneAsync(ctx, types.CloneCreateRequest{
 		ID:        "testCloneID",
 		Project:   "testProject",
 		Protected: true,
-		DB: &DatabaseRequest{
+		DB: &types.DatabaseRequest{
 			Username: "john",
 			Password: "doe",
 		},
@@ -258,7 +259,7 @@ func TestClientCreateCloneWithFailedRequest(t *testing.T) {
 
 	c.client = mockClient
 
-	clone, err := c.CreateClone(context.Background(), CreateRequest{})
+	clone, err := c.CreateClone(context.Background(), types.CloneCreateRequest{})
 	require.EqualError(t, err, "failed to decode a response body: EOF")
 	require.Nil(t, clone)
 }
@@ -365,7 +366,7 @@ func TestClientUpdateClone(t *testing.T) {
 		require.NoError(t, err)
 		defer func() { _ = r.Body.Close() }()
 
-		updateRequest := UpdateRequest{}
+		updateRequest := types.CloneUpdateRequest{}
 		err = json.Unmarshal(requestBody, &updateRequest)
 		require.NoError(t, err)
 
@@ -392,7 +393,7 @@ func TestClientUpdateClone(t *testing.T) {
 	c.client = mockClient
 
 	// Send a request.
-	newClone, err := c.UpdateClone(context.Background(), cloneModel.ID, UpdateRequest{
+	newClone, err := c.UpdateClone(context.Background(), cloneModel.ID, types.CloneUpdateRequest{
 		Protected: false,
 	})
 	require.NoError(t, err)
@@ -429,7 +430,7 @@ func TestClientUpdateCloneWithFailedRequest(t *testing.T) {
 
 	c.client = mockClient
 
-	clone, err := c.UpdateClone(context.Background(), "testCloneID", UpdateRequest{})
+	clone, err := c.UpdateClone(context.Background(), "testCloneID", types.CloneUpdateRequest{})
 	require.EqualError(t, err, `failed to get response: Code "BAD_REQUEST". Message: Wrong request format. Detail: Clone not found. Hint: Check request params.`)
 	require.Nil(t, clone)
 }
diff --git a/pkg/client/dblabapi/types/clone.go b/pkg/client/dblabapi/types/clone.go
@@ -0,0 +1,31 @@
+/*
+2020 © Postgres.ai
+*/
+
+// Package types provides request structures for Database Lab HTTP API.
+package types
+
+// CloneCreateRequest represents clone params of a create request.
+type CloneCreateRequest struct {
+	ID        string                     `json:"id"`
+	Project   string                     `json:"project"`
+	Protected bool                       `json:"protected"`
+	DB        *DatabaseRequest           `json:"db"`
+	Snapshot  *SnapshotCloneFieldRequest `json:"snapshot"`
+}
+
+// CloneUpdateRequest represents params of an update request.
+type CloneUpdateRequest struct {
+	Protected bool `json:"protected"`
+}
+
+// DatabaseRequest represents database params of a clone request.
+type DatabaseRequest struct {
+	Username string `json:"username"`
+	Password string `json:"password"`
+}
+
+// SnapshotCloneFieldRequest represents snapshot params of a create request.
+type SnapshotCloneFieldRequest struct {
+	ID string `json:"id"`
+}
diff --git a/pkg/services/cloning/cloning.go b/pkg/services/cloning/cloning.go
@@ -11,6 +11,7 @@ import (
 
 	"github.com/pkg/errors"
 
+	"gitlab.com/postgres-ai/database-lab/pkg/client/dblabapi/types"
 	"gitlab.com/postgres-ai/database-lab/pkg/log"
 	"gitlab.com/postgres-ai/database-lab/pkg/models"
 	"gitlab.com/postgres-ai/database-lab/pkg/services/provision"
@@ -43,10 +44,10 @@ type cloning struct {
 type Cloning interface {
 	Run(ctx context.Context) error
 
-	CreateClone(*models.Clone) error
+	CreateClone(*types.CloneCreateRequest) (*models.Clone, error)
 	DestroyClone(string) error
 	GetClone(string) (*models.Clone, error)
-	UpdateClone(string, *models.Clone) error
+	UpdateClone(string, *types.CloneUpdateRequest) (*models.Clone, error)
 	ResetClone(string) error
 
 	GetInstanceState() (*models.InstanceStatus, error)
diff --git a/pkg/services/cloning/mode_base.go b/pkg/services/cloning/mode_base.go
diff --git a/pkg/services/cloning/mode_base_test.go b/pkg/services/cloning/mode_base_test.go
diff --git a/pkg/services/cloning/mode_mock.go b/pkg/services/cloning/mode_mock.go
diff --git a/pkg/srv/routes.go b/pkg/srv/routes.go
