feat: retry deployments (#37)

internal/command/consts.go

@@ -27,5 +27,6 @@ var (
 	envID          string
 
 	deploy  bool
+	retry   bool
 	verbose bool
 )

internal/command/delta.go

@@ -38,6 +38,7 @@ func init() {
 	deltaCmd.MarkFlagRequired("env")
 
 	deltaCmd.Flags().BoolVar(&deploy, "deploy", false, "Trigger a new delta deployment at the end")
+	deltaCmd.Flags().BoolVar(&retry, "retry", false, "Retry deployments when a deployment is currently in progress")
 	deltaCmd.Flags().BoolVar(&verbose, "verbose", false, "Enable diagnostic messages (written to STDERR)")
 
 	rootCmd.AddCommand(deltaCmd)
@@ -94,7 +95,7 @@ func delta(cmd *cobra.Command, args []string) error {
 	//
 	if deploy {
 		log.Printf("Starting a new deployment for delta '%s'...\n", res.ID)
-		_, err := client.StartDeployment(context.Background(), orgID, appID, envID, &ht.StartDeploymentRequest{
+		_, err := client.StartDeployment(context.Background(), orgID, appID, envID, retry, &ht.StartDeploymentRequest{
 			DeltaID: res.ID,
 			Comment: "Auto-deployment (SCORE)",
 		})

internal/humanitec_go/client/deployments.go

@@ -12,14 +12,19 @@ import (
 	"encoding/json"
 	"fmt"
 	"net/http"
+	"time"
 
 	"github.com/sendgrid/rest"
 
 	humanitec "github.com/score-spec/score-humanitec/internal/humanitec_go/types"
 )
 
+var (
+	retryDelay = 5 * time.Second
+)
+
 // StartDeployment starts a new Deployment.
-func (api *apiClient) StartDeployment(ctx context.Context, orgID, appID, envID string, deployment *humanitec.StartDeploymentRequest) (*humanitec.Deployment, error) {
+func (api *apiClient) StartDeployment(ctx context.Context, orgID, appID, envID string, retry bool, deployment *humanitec.StartDeploymentRequest) (*humanitec.Deployment, error) {
 	data, err := json.Marshal(deployment)
 	if err != nil {
 		return nil, fmt.Errorf("marshalling payload into JSON: %w", err)
@@ -53,6 +58,13 @@ func (api *apiClient) StartDeployment(ctx context.Context, orgID, appID, envID s
 			return &res, nil
 		}
 
+	case http.StatusConflict:
+		if retry {
+			time.Sleep(retryDelay)
+			return api.StartDeployment(ctx, orgID, appID, envID, retry, deployment)
+		}
+
+		fallthrough
 	default:
 		return nil, fmt.Errorf("humanitec api: %s %s: HTTP %d - %s", req.Method, req.BaseURL, resp.StatusCode, http.StatusText(resp.StatusCode))
 	}

internal/humanitec_go/client/deployments_test.go

@@ -34,7 +34,8 @@ func TestStartDeployment(t *testing.T) {
 		Name           string
 		ApiUrl         string
 		Data           *humanitec.StartDeploymentRequest
-		StatusCode     int
+		Retry          bool
+		StatusCode     []int
 		Response       []byte
 		ExpectedResult *humanitec.Deployment
 		ExpectedError  error
@@ -47,7 +48,7 @@ func TestStartDeployment(t *testing.T) {
 				DeltaID: "test-delta",
 				Comment: "Test deployment",
 			},
-			StatusCode: http.StatusCreated,
+			StatusCode: []int{http.StatusCreated},
 			Response: []byte(`{
 				"id": "qwe...rty",
 				"env_id": "test-env",
@@ -81,19 +82,61 @@ func TestStartDeployment(t *testing.T) {
 		},
 		{
 			Name:          "Should handle API errors",
-			StatusCode:    http.StatusInternalServerError,
+			StatusCode:    []int{http.StatusInternalServerError},
 			ExpectedError: errors.New("HTTP 500"),
 		},
 		{
 			Name:          "Should handle response parsing errors",
-			StatusCode:    http.StatusOK,
+			StatusCode:    []int{http.StatusOK},
 			Response:      []byte(`{NOT A VALID JSON}`),
 			ExpectedError: errors.New("parsing response"),
 		},
+		{
+			Name: "Should return conflict errors without retry",
+			Data: &humanitec.StartDeploymentRequest{
+				DeltaID: "test-delta",
+				Comment: "Test deployment",
+			},
+			Retry:         false,
+			StatusCode:    []int{http.StatusConflict},
+			ExpectedError: errors.New("HTTP 409"),
+		},
+		{
+			Name: "Should retry conflict errors with retry",
+			Data: &humanitec.StartDeploymentRequest{
+				DeltaID: "test-delta",
+				Comment: "Test deployment",
+			},
+			Retry:      true,
+			StatusCode: []int{http.StatusConflict, http.StatusCreated},
+			Response: []byte(`{
+				"id": "qwe...rty",
+				"env_id": "test-env",
+				"from_id": "qwe...rty",
+				"delta_id": "test-delta",
+				"comment": "Test deployment",
+				"status": "in progress",
+				"status_changed_at": "2020-05-22T14:59:01Z",
+				"created_at": "2020-05-22T14:58:07Z",
+				"created_by": "a.user@example.com"
+			}`),
+			ExpectedResult: &humanitec.Deployment{
+				ID:              "qwe...rty",
+				EnvID:           "test-env",
+				FromID:          "qwe...rty",
+				DeltaID:         "test-delta",
+				Comment:         "Test deployment",
+				Status:          "in progress",
+				StatusChangedAt: time.Time{},
+				CreatedBy:       "a.user@example.com",
+				CreatedAt:       time.Time{},
+			},
+		},
 	}
 
 	for _, tt := range tests {
 		t.Run(tt.Name, func(t *testing.T) {
+			request := 0
 			fakeServer := httptest.NewServer(
 				http.HandlerFunc(
 					func(w http.ResponseWriter, r *http.Request) {
@@ -114,11 +157,13 @@ func TestStartDeployment(t *testing.T) {
 								assert.Equal(t, tt.Data, &body)
 							}
 
-							w.WriteHeader(tt.StatusCode)
+							w.WriteHeader(tt.StatusCode[request])
 							if len(tt.Response) > 0 {
 								w.Header().Set("Content-Type", "application/json")
 								w.Write(tt.Response)
 							}
+
+							request++
 							return
 						}
 
@@ -134,7 +179,7 @@ func TestStartDeployment(t *testing.T) {
 
 			client, err := NewClient(tt.ApiUrl, apiToken, fakeServer.Client())
 			assert.NoError(t, err)
-			res, err := client.StartDeployment(testutil.TestContext(), orgID, appID, envID, tt.Data)
+			res, err := client.StartDeployment(testutil.TestContext(), orgID, appID, envID, tt.Retry, tt.Data)
 
 			if tt.ExpectedError != nil {
 				// On Error

internal/humanitec_go/client/types.go

@@ -26,5 +26,5 @@ type Client interface {
 
 	// Deployments
 	//
-	StartDeployment(ctx context.Context, orgID, appID, envID string, deployment *humanitec.StartDeploymentRequest) (*humanitec.Deployment, error)
+	StartDeployment(ctx context.Context, orgID, appID, envID string, retry bool, deployment *humanitec.StartDeploymentRequest) (*humanitec.Deployment, error)
 }