Fix callback (#95)

* Remove repeated code.

* Updates build tag location

* Adds helper methods

* Adds callback status

* Update test

* Remove pending status from handler

* Adds cfn test

* MockScheduler

* Update test to use func as value

* Add create test data

* Adds publisher no tag option

* Adds no client to no tag publisher

* Adds no op

* Adds no op

* Adds no tag option to scheduler

* Fix publisher build tag

* Fix publisher build tag

* Fixed typo

*  Added mocked context

* Adds error testing

* Adds invaild action

* Adds invaild action

* Updates Makefile

* Adds reportErr

* Adds reportErr

* Updated  logging

* Addslogger

* Fix logging

* Updates  testing

Author: brianterry

cfn/callback/callback.go

@@ -20,31 +20,58 @@ import (
 )
 
 const (
-	//ServiceInternalError ...
+	// ServiceInternalError ...
 	ServiceInternalError string = "ServiceInternal"
-	//MaxRetries is the number of retries allowed to report status.
+	// MaxRetries is the number of retries allowed to report status.
 	MaxRetries uint = 3
 )
 
-//CloudFormationCallbackAdapter used to report progress events back to CloudFormation.
+// CloudFormationCallbackAdapter used to report progress events back to CloudFormation.
 type CloudFormationCallbackAdapter struct {
-	logger *log.Logger
-	client cloudformationiface.CloudFormationAPI
+	client      cloudformationiface.CloudFormationAPI
+	bearerToken string
+	logger      *log.Logger
 }
 
-//New creates a CloudFormationCallbackAdapter and returns a pointer to the struct.
-func New(client cloudformationiface.CloudFormationAPI) *CloudFormationCallbackAdapter {
+// New creates a CloudFormationCallbackAdapter and returns a pointer to the struct.
+func New(client cloudformationiface.CloudFormationAPI, bearerToken string) *CloudFormationCallbackAdapter {
 	return &CloudFormationCallbackAdapter{
-		logger: logging.New("callback: "),
-		client: client,
+		client:      client,
+		bearerToken: bearerToken,
+		logger:      logging.New("callback"),
 	}
 }
 
-//ReportProgress reports the current status back to the Cloudformation service.
-func (c *CloudFormationCallbackAdapter) ReportProgress(bearerToken string, code string, operationStatus string, currentOperationStatus string, resourceModel string, statusMessage string) error {
+// ReportStatus reports the status back to the Cloudformation service of a handler
+// that has moved from Pending to In_Progress
+func (c *CloudFormationCallbackAdapter) ReportStatus(operationStatus Status, model []byte, message string, errCode string) error {
+	if err := c.reportProgress(errCode, operationStatus, InProgress, model, message); err != nil {
+		return err
+	}
+	return nil
+}
+
+// ReportInitialStatus reports the initial status back to the Cloudformation service.
+func (c *CloudFormationCallbackAdapter) ReportInitialStatus() error {
+	if err := c.reportProgress("", InProgress, Pending, []byte(""), ""); err != nil {
+		return err
+	}
+	return nil
+}
+
+//ReportFailureStatus reports the failure status back to the Cloudformation service.
+func (c *CloudFormationCallbackAdapter) ReportFailureStatus(model []byte, errCode string, handlerError error) error {
+	if err := c.reportProgress(errCode, Failed, InProgress, model, handlerError.Error()); err != nil {
+		return err
+	}
+	return nil
+}
+
+// ReportProgress reports the current status back to the Cloudformation service.
+func (c *CloudFormationCallbackAdapter) reportProgress(errCode string, operationStatus Status, currentOperationStatus Status, resourceModel []byte, statusMessage string) error {
 
 	in := cloudformation.RecordHandlerProgressInput{
-		BearerToken:     aws.String(bearerToken),
+		BearerToken:     aws.String(c.bearerToken),
 		OperationStatus: aws.String(TranslateOperationStatus(operationStatus)),
 	}
 
@@ -53,15 +80,15 @@ func (c *CloudFormationCallbackAdapter) ReportProgress(bearerToken string, code
 	}
 
 	if len(resourceModel) != 0 {
-		in.SetResourceModel(resourceModel)
+		in.SetResourceModel(string(resourceModel))
 	}
 
-	if len(code) != 0 {
-		in.SetErrorCode(TranslateErrorCode(code))
+	if len(errCode) != 0 {
+		in.SetErrorCode(TranslateErrorCode(errCode))
 	}
 
 	if len(currentOperationStatus) != 0 {
-		in.SetCurrentOperationStatus(currentOperationStatus)
+		in.SetCurrentOperationStatus(TranslateOperationStatus(currentOperationStatus))
 	}
 
 	// Do retries and emit logs.
@@ -86,7 +113,7 @@ func (c *CloudFormationCallbackAdapter) ReportProgress(bearerToken string, code
 	return nil
 }
 
-//TranslateErrorCode : Translate the error code into a standard Cloudformation error
+// TranslateErrorCode : Translate the error code into a standard Cloudformation error
 func TranslateErrorCode(errorCode string) string {
 
 	switch errorCode {
@@ -124,16 +151,18 @@ func TranslateErrorCode(errorCode string) string {
 	}
 }
 
-//TranslateOperationStatus Translate the operation Status into a standard Cloudformation error
-func TranslateOperationStatus(operationStatus string) string {
+// TranslateOperationStatus Translate the operation Status into a standard Cloudformation error
+func TranslateOperationStatus(operationStatus Status) string {
 
 	switch operationStatus {
-	case "SUCCESS":
+	case Success:
 		return cloudformation.OperationStatusSuccess
-	case "FAILED":
+	case Failed:
 		return cloudformation.OperationStatusFailed
-	case "IN_PROGRESS":
+	case InProgress:
 		return cloudformation.OperationStatusInProgress
+	case Pending:
+		return cloudformation.OperationStatusPending
 	default:
 		// default will be to fail on unknown status
 		return cloudformation.OperationStatusFailed

cfn/callback/callback_notag.go

@@ -11,25 +11,52 @@ import (
 	"github.com/aws/aws-sdk-go/service/cloudformation/cloudformationiface"
 )
 
-//CloudFormationCallbackAdapter used to report progress events back to CloudFormation.
+// CloudFormationCallbackAdapter used to report progress events back to CloudFormation.
 type CloudFormationCallbackAdapter struct {
-	logger *log.Logger
-	client cloudformationiface.CloudFormationAPI
+	logger      *log.Logger
+	client      cloudformationiface.CloudFormationAPI
+	bearerToken string
 }
 
-//New creates a CloudFormationCallbackAdapter and returns a pointer to the struct.
-func New(client cloudformationiface.CloudFormationAPI) *CloudFormationCallbackAdapter {
+// New creates a CloudFormationCallbackAdapter and returns a pointer to the struct.
+func New(client cloudformationiface.CloudFormationAPI, bearerToken string) *CloudFormationCallbackAdapter {
 	return &CloudFormationCallbackAdapter{
-		logger: logging.New("callback: "),
-		client: client,
+		client:      client,
+		bearerToken: bearerToken,
+		logger:      logging.New("callback"),
 	}
 }
 
-//ReportProgress reports the current status back to the Cloudformation service.
-func (c *CloudFormationCallbackAdapter) ReportProgress(bearerToken string, code string, operationStatus string, currentOperationStatus string, resourceModel string, statusMessage string) error {
+// ReportStatus reports the status back to the Cloudformation service of a handler
+// that has moved from Pending to In_Progress
+func (c *CloudFormationCallbackAdapter) ReportStatus(operationStatus Status, model []byte, message string, errCode string) error {
+	if err := c.reportProgress(errCode, operationStatus, InProgress, model, message); err != nil {
+		return err
+	}
+	return nil
+}
+
+// ReportInitialStatus reports the initial status back to the Cloudformation service.
+func (c *CloudFormationCallbackAdapter) ReportInitialStatus() error {
+	if err := c.reportProgress("", InProgress, Pending, []byte(""), ""); err != nil {
+		return err
+	}
+	return nil
+}
+
+// ReportFailureStatus reports the failure status back to the Cloudformation service.
+func (c *CloudFormationCallbackAdapter) ReportFailureStatus(model []byte, errCode string, handlerError error) error {
+	if err := c.reportProgress(errCode, Failed, InProgress, model, handlerError.Error()); err != nil {
+		return err
+	}
+	return nil
+}
+
+// ReportProgress reports the current status back to the Cloudformation service.
+func (c *CloudFormationCallbackAdapter) reportProgress(code string, operationStatus Status, currentOperationStatus Status, resourceModel []byte, statusMessage string) error {
 
 	in := cloudformation.RecordHandlerProgressInput{
-		BearerToken:     aws.String(bearerToken),
+		BearerToken:     aws.String(c.bearerToken),
 		OperationStatus: aws.String(TranslateOperationStatus(operationStatus)),
 	}
 
@@ -38,23 +65,23 @@ func (c *CloudFormationCallbackAdapter) ReportProgress(bearerToken string, code
 	}
 
 	if len(resourceModel) != 0 {
-		in.SetResourceModel(resourceModel)
+		in.SetResourceModel(string(resourceModel))
 	}
 
 	if len(code) != 0 {
 		in.SetErrorCode(TranslateErrorCode(code))
 	}
 
 	if len(currentOperationStatus) != 0 {
-		in.SetCurrentOperationStatus(currentOperationStatus)
+		in.SetCurrentOperationStatus(string(currentOperationStatus))
 	}
 
 	c.logger.Printf("Record progress: %v", &in)
 
 	return nil
 }
 
-//TranslateErrorCode : Translate the error code into a standard Cloudformation error
+// TranslateErrorCode : Translate the error code into a standard Cloudformation error
 func TranslateErrorCode(errorCode string) string {
 
 	switch errorCode {
@@ -92,16 +119,18 @@ func TranslateErrorCode(errorCode string) string {
 	}
 }
 
-//TranslateOperationStatus Translate the operation Status into a standard Cloudformation error
-func TranslateOperationStatus(operationStatus string) string {
+// TranslateOperationStatus Translate the operation Status into a standard Cloudformation error
+func TranslateOperationStatus(operationStatus Status) string {
 
 	switch operationStatus {
-	case "SUCCESS":
+	case Success:
 		return cloudformation.OperationStatusSuccess
-	case "FAILED":
+	case Failed:
 		return cloudformation.OperationStatusFailed
-	case "IN_PROGRESS":
+	case InProgress:
 		return cloudformation.OperationStatusInProgress
+	case Pending:
+		return cloudformation.OperationStatusPending
 	default:
 		// default will be to fail on unknown status
 		return cloudformation.OperationStatusFailed

cfn/callback/callback_test.go

@@ -9,9 +9,9 @@ import (
 	"github.com/aws/aws-sdk-go/service/cloudformation/cloudformationiface"
 )
 
-const MockModel string = "{\"foo\": \"bar\"}"
+var MockModel = []byte("{\"foo\": \"bar\"}")
 
-//MockedEvents mocks the call to AWS CloudWatch Events
+// MockedEvents mocks the call to AWS CloudWatch Events
 type MockedCallback struct {
 	cloudformationiface.CloudFormationAPI
 	errCount int
@@ -35,7 +35,7 @@ func (m *MockedCallback) RecordHandlerProgress(in *cloudformation.RecordHandlerP
 
 func TestTranslateOperationStatus(t *testing.T) {
 	type args struct {
-		operationStatus string
+		operationStatus Status
 	}
 	tests := []struct {
 		name string
@@ -89,16 +89,16 @@ func TestTranslateErrorCode(t *testing.T) {
 	}
 }
 
-func TestCloudFormationCallbackAdapter_ReportProgress(t *testing.T) {
+func TestCloudFormationCallbackAdapterReportProgress(t *testing.T) {
 	type fields struct {
 		client cloudformationiface.CloudFormationAPI
 	}
 	type args struct {
 		bearerToken     string
 		code            string
-		status          string
-		operationStatus string
-		resourceModel   string
+		status          Status
+		operationStatus Status
+		resourceModel   []byte
 		statusMessage   string
 	}
 	tests := []struct {
@@ -112,10 +112,11 @@ func TestCloudFormationCallbackAdapter_ReportProgress(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			c := &CloudFormationCallbackAdapter{
-				client: tt.fields.client,
-				logger: logging.New("callback: "),
+				client:      tt.fields.client,
+				logger:      logging.New("callback: "),
+				bearerToken: tt.args.bearerToken,
 			}
-			if err := c.ReportProgress(tt.args.bearerToken, tt.args.code, tt.args.status, tt.args.operationStatus, tt.args.resourceModel, tt.args.statusMessage); (err != nil) != tt.wantErr {
+			if err := c.reportProgress(tt.args.code, tt.args.status, tt.args.operationStatus, tt.args.resourceModel, tt.args.statusMessage); (err != nil) != tt.wantErr {
 				t.Errorf("CloudFormationCallbackAdapter.ReportProgress() error = %v, wantErr %v", err, tt.wantErr)
 			}
 		})

cfn/callback/status.go

@@ -0,0 +1,26 @@
+package callback
+
+//Status represents the status of the handler during invocation.
+type Status string
+
+const (
+	// UnknownStatus represents all states that aren't covered
+	// elsewhere.
+	UnknownStatus Status = "UNKNOWN"
+
+	// InProgress is when a resource provider
+	// is in the process of being operated on.
+	InProgress Status = "IN_PROGRESS"
+
+	// Success is when the resource provider
+	// has finished it's operation.
+	Success Status = "SUCCESS"
+
+	// Failed is when the resource provider
+	// has failed.
+	Failed Status = "FAILED"
+
+	// Pending is the resource provider
+	// initial state.
+	Pending Status = "PENDING"
+)