Merge pull request #486 from fujiwara/diff-exit-code

Add diff --exit-code

Author: fujiwara

cli.go

@@ -122,7 +122,7 @@ func ParseCLI(args []string) (string, *CLIOptions, func(), error) {
 func CLI(ctx context.Context, parse CLIParseFunc) (int, error) {
 	sub, opts, usage, err := parse(os.Args[1:])
 	if err != nil {
-		return 1, err
+		return extractExitCodeAndError(err)
 	}
 
 	color.NoColor = !opts.Color
@@ -143,10 +143,8 @@ func CLI(ctx context.Context, parse CLIParseFunc) (int, error) {
 	}
 	log.SetOutput(filter)
 
-	if err := dispatchCLI(ctx, sub, usage, opts); err != nil {
-		return 1, err
-	}
-	return 0, nil
+	err = dispatchCLI(ctx, sub, usage, opts)
+	return extractExitCodeAndError(err)
 }
 
 func dispatchCLI(ctx context.Context, sub string, usage func(), opts *CLIOptions) error {

diff.go

@@ -27,6 +27,7 @@ type DiffOption struct {
 	Qualifier   *string `help:"the qualifier to compare"`
 	FunctionURL string  `help:"path to function-url definition" default:"" env:"LAMBROLL_FUNCTION_URL"`
 	Ignore      string  `help:"ignore diff by jq query" default:""`
+	ExitCode    bool    `help:"exit with code 2 if there are differences" default:"false"`
 
 	ZipOption
 }
@@ -93,6 +94,7 @@ func (app *App) Diff(ctx context.Context, opt *DiffOption) error {
 	remoteJSON, _ := marshalAny(remoteFunc)
 	newJSON, _ := marshalAny(newFunc)
 	remoteArn := fullQualifiedFunctionName(app.functionArn(ctx, name), opt.Qualifier)
+	hasDiff := false
 
 	if diff, err := jsondiff.Diff(
 		&jsondiff.Input{Name: remoteArn, X: remoteJSON},
@@ -101,6 +103,7 @@ func (app *App) Diff(ctx context.Context, opt *DiffOption) error {
 	); err != nil {
 		return fmt.Errorf("failed to diff: %w", err)
 	} else if diff != "" {
+		hasDiff = true
 		fmt.Print(coloredDiff(diff))
 	}
 
@@ -126,25 +129,33 @@ func (app *App) Diff(ctx context.Context, opt *DiffOption) error {
 			fmt.Println(color.RedString("---" + app.functionArn(ctx, name)))
 			fmt.Println(color.GreenString("+++" + "--src=" + opt.Src))
 			fmt.Println(coloredDiff(ds))
+			hasDiff = true
 		}
 	}
 
-	if opt.FunctionURL == "" {
-		return nil
+	if opt.FunctionURL != "" {
+		if d, err := app.diffFunctionURL(ctx, name, opt); err != nil {
+			return err
+		} else if d {
+			hasDiff = true
+		}
 	}
 
-	if err := app.diffFunctionURL(ctx, name, opt); err != nil {
-		return err
+	if hasDiff && opt.ExitCode {
+		// exit with code 2 if there are differences
+		// but actually, it's not an error
+		return ErrDiff
 	}
 	return nil
 }
 
-func (app *App) diffFunctionURL(ctx context.Context, name string, opt *DiffOption) error {
+func (app *App) diffFunctionURL(ctx context.Context, name string, opt *DiffOption) (bool, error) {
 	var remote, local *types.FunctionUrlConfig
+	var hasDiff bool
 
 	fu, err := app.loadFunctionUrl(opt.FunctionURL, name)
 	if err != nil {
-		return fmt.Errorf("failed to load function-url: %w", err)
+		return hasDiff, fmt.Errorf("failed to load function-url: %w", err)
 	} else {
 		fillDefaultValuesFunctionUrlConfig(fu.Config)
 		local = &types.FunctionUrlConfig{
@@ -170,7 +181,7 @@ func (app *App) diffFunctionURL(ctx context.Context, name string, opt *DiffOptio
 			// empty
 			remote = &types.FunctionUrlConfig{}
 		} else {
-			return fmt.Errorf("failed to get function url config: %w", err)
+			return hasDiff, fmt.Errorf("failed to get function url config: %w", err)
 		}
 	} else {
 		log.Println("[debug] FunctionUrlConfig found")
@@ -187,15 +198,16 @@ func (app *App) diffFunctionURL(ctx context.Context, name string, opt *DiffOptio
 		&jsondiff.Input{Name: fqName, X: r},
 		&jsondiff.Input{Name: opt.FunctionURL, X: l},
 	); err != nil {
-		return fmt.Errorf("failed to diff: %w", err)
+		return hasDiff, fmt.Errorf("failed to diff: %w", err)
 	} else if diff != "" {
+		hasDiff = true
 		fmt.Print(coloredDiff(diff))
 	}
 
 	// permissions
 	adds, removes, err := app.calcFunctionURLPermissionsDiff(ctx, fu)
 	if err != nil {
-		return err
+		return hasDiff, err
 	}
 	var addsB []byte
 	for _, in := range adds {
@@ -211,9 +223,10 @@ func (app *App) diffFunctionURL(ctx context.Context, name string, opt *DiffOptio
 		fmt.Println(color.RedString("--- permissions"))
 		fmt.Println(color.GreenString("+++ permissions"))
 		fmt.Print(coloredDiff(ds))
+		hasDiff = true
 	}
 
-	return nil
+	return hasDiff, nil
 }
 
 func coloredDiff(src string) string {

error.go

@@ -0,0 +1,41 @@
+package lambroll
+
+import "errors"
+
+type ExitCode int
+
+const (
+	ExitCodeOK           = ExitCode(0)
+	ExitCodeGeneralError = ExitCode(1)
+	ExitCodeDiffFound    = ExitCode(2)
+)
+
+var ErrDiff = &ExitError{Code: ExitCodeDiffFound, Err: nil}
+
+type ExitError struct {
+	Code ExitCode
+	Err  error
+}
+
+func (e *ExitError) Error() string {
+	if e.Err == nil {
+		return ""
+	}
+	return e.Err.Error()
+}
+
+func (e *ExitError) Unwrap() error {
+	return nil
+}
+
+// ExtractExitCode extracts exit code from error.
+func extractExitCodeAndError(err error) (int, error) {
+	if err == nil {
+		return int(ExitCodeOK), nil
+	}
+	var e *ExitError
+	if errors.As(err, &e) {
+		return int(e.Code), e.Err
+	}
+	return int(ExitCodeGeneralError), err
+}

error_test.go

@@ -0,0 +1,32 @@
+package lambroll_test
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/fujiwara/lambroll"
+)
+
+var errGeneral = errors.New("error")
+
+var ExitErrorTests = []struct {
+	err            error
+	code           int
+	extractedError error
+}{
+	{lambroll.ErrDiff, 2, nil},
+	{errGeneral, 1, errGeneral},
+	{nil, 0, nil},
+}
+
+func TestExitError(t *testing.T) {
+	for _, tt := range ExitErrorTests {
+		code, err := lambroll.ExtractExitCodeAndError(tt.err)
+		if code != tt.code {
+			t.Errorf("ExtractExitCode(%v) => %d, want %d", tt.err, code, tt.code)
+		}
+		if err != nil && tt.extractedError != nil && err != tt.extractedError {
+			t.Errorf("ExtractExitCode(%v) => %v, want %v", tt.err, err, tt.extractedError)
+		}
+	}
+}

export_test.go

@@ -6,16 +6,17 @@ import (
 )
 
 var (
-	CreateZipArchive  = createZipArchive
-	ExpandExcludeFile = expandExcludeFile
-	LoadZipArchive    = loadZipArchive
-	MergeTags         = mergeTags
-	FillDefaultValues = fillDefaultValues
-	JSONStr           = jsonStr
-	MarshalJSON       = marshalJSON
-	NewFunctionFrom   = newFunctionFrom
-	NewCallerIdentity = newCallerIdentity
-	Unzip             = unzip
+	CreateZipArchive        = createZipArchive
+	ExpandExcludeFile       = expandExcludeFile
+	LoadZipArchive          = loadZipArchive
+	MergeTags               = mergeTags
+	FillDefaultValues       = fillDefaultValues
+	JSONStr                 = jsonStr
+	MarshalJSON             = marshalJSON
+	NewFunctionFrom         = newFunctionFrom
+	NewCallerIdentity       = newCallerIdentity
+	Unzip                   = unzip
+	ExtractExitCodeAndError = extractExitCodeAndError
 )
 
 type VersionsOutput = versionsOutput