refactor: use LogFailWithError to allow a unified exit code for golang commands when the app is missing

plugins/app-json/src/triggers/triggers.go

@@ -36,6 +36,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/apps/src/subcommands/subcommands.go

@@ -82,6 +82,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/apps/src/triggers/triggers.go

@@ -41,6 +41,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/buildpacks/src/subcommands/subcommands.go

@@ -76,6 +76,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/buildpacks/src/triggers/triggers.go

@@ -46,6 +46,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/common/common.go

@@ -515,10 +515,17 @@ func isValidAppNameOld(appName string) error {
 	return errors.New("App name must begin with lowercase alphanumeric character, and cannot include uppercase characters, or colons")
 }
 
+// AppDoesNotExist wraps error to include the app name
+// and is used to distinguish between a normal error and an error
+// where the app is missing
 type AppDoesNotExist struct {
 	appName string
 }
 
+func (err *AppDoesNotExist) ExitCode() int {
+	return 20
+}
+
 func (err *AppDoesNotExist) Error() string {
 	return fmt.Sprintf("App %s does not exist", err.appName)
 }

plugins/common/log.go

@@ -8,6 +8,11 @@ import (
 	"strings"
 )
 
+// ErrWithExitCode wraps error and exposes an ExitCode method
+type ErrWithExitCode interface {
+	ExitCode() int
+}
+
 // LogFail is the failure log formatter
 // prints text to stderr and exits with status 1
 func LogFail(text string) {
@@ -15,6 +20,16 @@ func LogFail(text string) {
 	os.Exit(1)
 }
 
+// LogFailWithError is the failure log formatter
+// prints text to stderr and exits with the specified exit code
+func LogFailWithError(err error) {
+	fmt.Fprintln(os.Stderr, fmt.Sprintf(" !     %s", err.Error()))
+	if errExit, ok := err.(ErrWithExitCode); ok {
+		os.Exit(errExit.ExitCode())
+	}
+	os.Exit(1)
+}
+
 // LogFailQuiet is the failure log formatter (with quiet option)
 // prints text to stderr and exits with status 1
 func LogFailQuiet(text string) {

plugins/common/properties.go

@@ -16,7 +16,7 @@ import (
 func CommandPropertySet(pluginName, appName, property, value string, properties map[string]string, globalProperties map[string]bool) {
 	if appName != "--global" {
 		if err := VerifyAppName(appName); err != nil {
-			LogFail(err.Error())
+			LogFailWithError(err)
 		}
 	}
 	if appName == "--global" && !globalProperties[property] {
@@ -42,9 +42,8 @@ func CommandPropertySet(pluginName, appName, property, value string, properties
 		PropertyWrite(pluginName, appName, property, value)
 	} else {
 		LogInfo2Quiet(fmt.Sprintf("Unsetting %s", property))
-		err := PropertyDelete(pluginName, appName, property)
-		if err != nil {
-			LogFail(err.Error())
+		if err := PropertyDelete(pluginName, appName, property); err != nil {
+			LogFailWithError(err)
 		}
 	}
 }

plugins/config/config.go

@@ -137,9 +137,11 @@ func getEnvironment(appName string, merged bool) (env *Env) {
 	} else {
 		env, err = loadAppOrGlobalEnv(appName)
 	}
+
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
+
 	return env
 }
 

plugins/config/environment.go

@@ -77,7 +77,7 @@ func LoadMergedAppEnv(appName string) (env *Env, err error) {
 	}
 	global, err := LoadGlobalEnv()
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 	global.Merge(env)
 	global.filename = ""

plugins/config/src/commands/commands.go

@@ -48,7 +48,7 @@ func main() {
 		appName := args.Arg(0)
 		err := config.CommandShow(appName, *global, *merged, *shell, *export)
 		if err != nil {
-			common.LogFail(err.Error())
+			common.LogFailWithError(err)
 		}
 	case "config:help":
 		usage()

plugins/config/src/subcommands/subcommands.go

@@ -109,6 +109,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/config/src/triggers/triggers.go

@@ -36,6 +36,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/cron/src/subcommands/subcommands.go

@@ -37,6 +37,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/cron/src/triggers/triggers.go

@@ -32,6 +32,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/logs/src/commands/commands.go

@@ -54,7 +54,7 @@ func main() {
 		appName := args.Arg(0)
 		err := logs.CommandDefault(appName, *num, *ps, *tail, *quiet)
 		if err != nil {
-			common.LogFail(err.Error())
+			common.LogFailWithError(err)
 		}
 	case "logs:help":
 		usage()

plugins/logs/src/subcommands/subcommands.go

@@ -66,6 +66,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/logs/src/triggers/triggers.go

@@ -38,6 +38,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/network/src/subcommands/subcommands.go

@@ -72,6 +72,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/network/src/triggers/triggers.go

@@ -94,6 +94,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/proxy/src/subcommands/subcommands.go

@@ -87,6 +87,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/proxy/src/triggers/triggers.go

@@ -38,6 +38,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/ps/src/subcommands/subcommands.go

@@ -90,6 +90,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/ps/src/triggers/triggers.go

@@ -79,6 +79,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/repo/src/subcommands/subcommands.go

@@ -33,6 +33,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/repo/src/triggers/triggers.go

@@ -29,6 +29,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/resource/src/subcommands/subcommands.go

@@ -92,6 +92,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }

plugins/resource/src/triggers/triggers.go

@@ -49,6 +49,6 @@ func main() {
 	}
 
 	if err != nil {
-		common.LogFail(err.Error())
+		common.LogFailWithError(err)
 	}
 }