Fix deployment patch API (#208)

* Fix the deployment patch API

Author: Noah Hanjun Lee

internal/interactor/deployment.go

@@ -121,6 +121,14 @@ func (i *Interactor) IsApproved(ctx context.Context, d *ent.Deployment) bool {
 
 // DeployToRemote create a new remote deployment after the deployment was approved.
 func (i *Interactor) DeployToRemote(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *vo.Env) (*ent.Deployment, error) {
+	if d.Status != deployment.StatusWaiting {
+		return nil, e.NewErrorWithMessage(
+			e.ErrorCodeDeploymentStatusInvalid,
+			"The deployment status is not waiting.",
+			nil,
+		)
+	}
+
 	if locked, err := i.Store.HasLockOfRepoForEnv(ctx, r, d.Env); locked {
 		return nil, e.NewError(
 			e.ErrorCodeDeploymentLocked,

internal/interactor/deployment_test.go

@@ -5,13 +5,15 @@ import (
 	"reflect"
 	"testing"
 
+	"github.com/golang/mock/gomock"
+	"go.uber.org/zap"
+
 	"github.com/gitploy-io/gitploy/ent"
 	"github.com/gitploy-io/gitploy/ent/deployment"
 	"github.com/gitploy-io/gitploy/ent/review"
 	"github.com/gitploy-io/gitploy/internal/interactor/mock"
+	"github.com/gitploy-io/gitploy/pkg/e"
 	"github.com/gitploy-io/gitploy/vo"
-	"github.com/golang/mock/gomock"
-	"go.uber.org/zap"
 )
 
 func newMockInteractor(store Store, scm SCM) *Interactor {
@@ -193,7 +195,7 @@ func TestInteractor_Deploy(t *testing.T) {
 func TestInteractor_DeployToRemote(t *testing.T) {
 	ctx := gomock.Any()
 
-	t.Run("create a new remote deployment and update the deployment.", func(t *testing.T) {
+	t.Run("Return an error when the deployment status is not waiting.", func(t *testing.T) {
 		input := struct {
 			d *ent.Deployment
 			e *vo.Env
@@ -206,6 +208,29 @@ func TestInteractor_DeployToRemote(t *testing.T) {
 		store := mock.NewMockStore(ctrl)
 		scm := mock.NewMockSCM(ctrl)
 
+		i := newMockInteractor(store, scm)
+
+		_, err := i.DeployToRemote(context.Background(), &ent.User{}, &ent.Repo{}, input.d, input.e)
+		if !e.HasErrorCode(err, e.ErrorCodeDeploymentStatusInvalid) {
+			t.Fatalf("CreateRemoteDeployment error = %v, wanted ErrorCodeDeploymentStatusInvalid", err)
+		}
+	})
+
+	t.Run("create a new remote deployment and update the deployment.", func(t *testing.T) {
+		input := struct {
+			d *ent.Deployment
+			e *vo.Env
+		}{
+			d: &ent.Deployment{
+				Status: deployment.StatusWaiting,
+			},
+			e: &vo.Env{},
+		}
+
+		ctrl := gomock.NewController(t)
+		store := mock.NewMockStore(ctrl)
+		scm := mock.NewMockSCM(ctrl)
+
 		const (
 			UID = 1000
 		)

internal/server/api/v1/repos/deployment.go

@@ -207,20 +207,18 @@ func (r *Repo) UpdateDeployment(c *gin.Context) {
 		return
 	}
 
-	if p.Status == string(deployment.StatusCreated) && d.Status == deployment.StatusWaiting {
-		if d, err = r.i.DeployToRemote(ctx, u, re, d, env); err != nil {
-			r.log.Check(gb.GetZapLogLevel(err), "It has failed to deploy to the remote.").Write(zap.Error(err))
-			gb.ResponseWithError(c, err)
-			return
-		}
+	if d, err = r.i.DeployToRemote(ctx, u, re, d, env); err != nil {
+		r.log.Check(gb.GetZapLogLevel(err), "It has failed to deploy to the remote.").Write(zap.Error(err))
+		gb.ResponseWithError(c, err)
+		return
+	}
 
-		if _, err := r.i.CreateEvent(ctx, &ent.Event{
-			Kind:         event.KindDeployment,
-			Type:         event.TypeUpdated,
-			DeploymentID: d.ID,
-		}); err != nil {
-			r.log.Error("It has failed to create an event.", zap.Error(err))
-		}
+	if _, err := r.i.CreateEvent(ctx, &ent.Event{
+		Kind:         event.KindDeployment,
+		Type:         event.TypeUpdated,
+		DeploymentID: d.ID,
+	}); err != nil {
+		r.log.Error("It has failed to create an event.", zap.Error(err))
 	}
 
 	// Get the deployment with edges.

openapi/v1.yaml

@@ -591,7 +591,7 @@ paths:
     patch: 
       tags:
         - Repo
-      summary: Deploy to SCM if a status of the deployment is waiting.
+      summary: Create a remote deployment when the status of the deployment is 'waiting'.
       parameters:
         - in: path
           name: namespace
@@ -609,17 +609,6 @@ paths:
           schema:
             type: integer
             description: The deployment number.
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-              properties:
-                status: 
-                  type: string
-                  default: created
-              required:
-                - status
       responses:
         '200':
           description: Deployment 

pkg/e/code.go

@@ -17,6 +17,8 @@ const (
 	ErrorCodeDeploymentLocked ErrorCode = "deployment_locked"
 	// ErrorCodeDeploymentUnapproved is when the deployment is not approved.
 	ErrorCodeDeploymentNotApproved ErrorCode = "deployment_not_approved"
+	// ErrorCodeDeploymentStatusNotWaiting is the status must be 'waiting' to create a remote deployment.
+	ErrorCodeDeploymentStatusInvalid ErrorCode = "deployment_status_invalid"
 	// ErrorCodeDeploymentUndeployable is that the merge conflict occurs or a commit status has failed.
 	ErrorCodeDeploymentUndeployable ErrorCode = "deployment_undeployable"
 

pkg/e/trans.go

@@ -3,19 +3,20 @@ package e
 import "net/http"
 
 var messages = map[ErrorCode]string{
-	ErrorCodeConfigParseError:       "The configuration is invalid.",
-	ErrorCodeDeploymentConflict:     "The conflict occurs, please retry.",
-	ErrorCodeDeploymentInvalid:      "The validation has failed.",
-	ErrorCodeDeploymentLocked:       "The environment is locked.",
-	ErrorCodeDeploymentNotApproved:  "The deployment is not approved",
-	ErrorCodeDeploymentUndeployable: "There is merge conflict or a commit status check failed.",
-	ErrorCodeLicenseDecode:          "Decoding the license is failed.",
-	ErrorCodeLicenseRequired:        "The license is required.",
-	ErrorCodeInvalidRequest:         "Invalid request parameter.",
-	ErrorPermissionRequired:         "The permission is required",
-	ErrorCodeNotFound:               "It is not found.",
-	ErrorCodeUnprocessableEntity:    "Invalid request payload.",
-	ErrorCodeInternalError:          "Server internal error.",
+	ErrorCodeConfigParseError:        "The configuration is invalid.",
+	ErrorCodeDeploymentConflict:      "The conflict occurs, please retry.",
+	ErrorCodeDeploymentInvalid:       "The validation has failed.",
+	ErrorCodeDeploymentLocked:        "The environment is locked.",
+	ErrorCodeDeploymentNotApproved:   "The deployment is not approved",
+	ErrorCodeDeploymentStatusInvalid: "The deployment status is invalid",
+	ErrorCodeDeploymentUndeployable:  "There is merge conflict or a commit status check failed.",
+	ErrorCodeLicenseDecode:           "Decoding the license is failed.",
+	ErrorCodeLicenseRequired:         "The license is required.",
+	ErrorCodeInvalidRequest:          "Invalid request parameter.",
+	ErrorPermissionRequired:          "The permission is required",
+	ErrorCodeNotFound:                "It is not found.",
+	ErrorCodeUnprocessableEntity:     "Invalid request payload.",
+	ErrorCodeInternalError:           "Server internal error.",
 }
 
 func GetMessage(code ErrorCode) string {
@@ -28,19 +29,20 @@ func GetMessage(code ErrorCode) string {
 }
 
 var httpCodes = map[ErrorCode]int{
-	ErrorCodeConfigParseError:       http.StatusUnprocessableEntity,
-	ErrorCodeDeploymentConflict:     http.StatusUnprocessableEntity,
-	ErrorCodeDeploymentInvalid:      http.StatusUnprocessableEntity,
-	ErrorCodeDeploymentLocked:       http.StatusUnprocessableEntity,
-	ErrorCodeDeploymentNotApproved:  http.StatusUnprocessableEntity,
-	ErrorCodeDeploymentUndeployable: http.StatusUnprocessableEntity,
-	ErrorCodeLicenseDecode:          http.StatusUnprocessableEntity,
-	ErrorCodeLicenseRequired:        http.StatusPaymentRequired,
-	ErrorCodeInvalidRequest:         http.StatusBadRequest,
-	ErrorCodeNotFound:               http.StatusNotFound,
-	ErrorPermissionRequired:         http.StatusForbidden,
-	ErrorCodeUnprocessableEntity:    http.StatusUnprocessableEntity,
-	ErrorCodeInternalError:          http.StatusInternalServerError,
+	ErrorCodeConfigParseError:        http.StatusUnprocessableEntity,
+	ErrorCodeDeploymentConflict:      http.StatusUnprocessableEntity,
+	ErrorCodeDeploymentInvalid:       http.StatusUnprocessableEntity,
+	ErrorCodeDeploymentLocked:        http.StatusUnprocessableEntity,
+	ErrorCodeDeploymentNotApproved:   http.StatusUnprocessableEntity,
+	ErrorCodeDeploymentStatusInvalid: http.StatusUnprocessableEntity,
+	ErrorCodeDeploymentUndeployable:  http.StatusUnprocessableEntity,
+	ErrorCodeLicenseDecode:           http.StatusUnprocessableEntity,
+	ErrorCodeLicenseRequired:         http.StatusPaymentRequired,
+	ErrorCodeInvalidRequest:          http.StatusBadRequest,
+	ErrorCodeNotFound:                http.StatusNotFound,
+	ErrorPermissionRequired:          http.StatusForbidden,
+	ErrorCodeUnprocessableEntity:     http.StatusUnprocessableEntity,
+	ErrorCodeInternalError:           http.StatusInternalServerError,
 }
 
 func GetHttpCode(code ErrorCode) int {

ui/src/apis/deployment.ts

@@ -216,15 +216,11 @@ export const createDeployment = async (namespace: string, name: string, type: De
     return deployment
 }
 
-export const updateDeploymentStatusCreated = async (namespace: string, name: string, number: number): Promise<Deployment> => {
-    const body = JSON.stringify({
-        status: "created"
-    })
+export const createRemoteDeployment = async (namespace: string, name: string, number: number): Promise<Deployment> => {
     const response = await _fetch(`${instance}/api/v1/repos/${namespace}/${name}/deployments/${number}`, {
         headers,
         credentials: 'same-origin',
         method: "PATCH",
-        body: body,
     })
     if (response.status === StatusCodes.FORBIDDEN) {
         const message = await response.json().then(data => data.message)

ui/src/apis/index.ts

@@ -14,7 +14,7 @@ import {
     listDeployments, 
     getDeployment,
     createDeployment, 
-    updateDeploymentStatusCreated, 
+    createRemoteDeployment, 
     rollbackDeployment, 
     listDeploymentChanges 
 } from './deployment'
@@ -54,7 +54,7 @@ export {
     listDeployments,
     getDeployment,
     createDeployment,
-    updateDeploymentStatusCreated,
+    createRemoteDeployment,
     rollbackDeployment,
     listDeploymentChanges,
     getConfig,

ui/src/redux/deployment.tsx

@@ -13,7 +13,7 @@ import {
 } from "../models"
 import { 
     getDeployment, 
-    updateDeploymentStatusCreated, 
+    createRemoteDeployment, 
     listReviews,
     getUserReview,
     approveReview,
@@ -83,7 +83,7 @@ export const deployToSCM = createAsyncThunk<Deployment, void, { state: {deployme
         }
 
         try {
-            const deployment = await updateDeploymentStatusCreated(namespace, name, number)
+            const deployment = await createRemoteDeployment(namespace, name, number)
             message.info("It starts to deploy.", 3)
 
             return deployment