Introduce reportWarnRaw functions

Author: jasonpaulos

cmd/goal/account.go

@@ -396,7 +396,7 @@ var newMultisigCmd = &cobra.Command{
 			}
 		}
 		if duplicatesDetected {
-			reportWarnln(warnMultisigDuplicatesDetected)
+			reportWarnRawln(warnMultisigDuplicatesDetected)
 		}
 		// Generate a new address in the default wallet
 		addr, err := client.CreateMultisigAccount(wh, threshold, args)
@@ -1369,7 +1369,7 @@ var importRootKeysCmd = &cobra.Command{
 			if err != nil {
 				// If error is 'like' "key already exists", treat as warning and not an error
 				if strings.Contains(err.Error(), "key already exists") {
-					reportWarnf("Warning: "+errorRequestFail, err.Error()+"\n > Key File: "+filename)
+					reportWarnf(errorRequestFail, err.Error()+"\n > Key File: "+filename)
 				} else {
 					reportErrorf(errorRequestFail, err)
 				}

cmd/goal/application.go

@@ -448,7 +448,7 @@ var createAppCmd = &cobra.Command{
 
 		switch onCompletionEnum {
 		case transactions.CloseOutOC, transactions.ClearStateOC:
-			reportWarnf("Warning: '--on-completion %s' may be ill-formed for 'goal app create'", onCompletion)
+			reportWarnf("'--on-completion %s' may be ill-formed for 'goal app create'", onCompletion)
 		}
 
 		tx, err := client.MakeUnsignedAppCreateTx(onCompletionEnum, approvalProg, clearProg, globalSchema, localSchema, appArgs, appAccounts, foreignApps, foreignAssets, extraPages)
@@ -1204,7 +1204,7 @@ var methodAppCmd = &cobra.Command{
 
 			switch onCompletionEnum {
 			case transactions.CloseOutOC, transactions.ClearStateOC:
-				reportWarnf("Warning: '--on-completion %s' may be ill-formed for use with --create", onCompletion)
+				reportWarnf("'--on-completion %s' may be ill-formed for use with --create", onCompletion)
 			}
 		} else {
 			if appIdx == 0 {

cmd/goal/asset.go

@@ -141,7 +141,7 @@ var assetCmd = &cobra.Command{
 
 func lookupAssetID(cmd *cobra.Command, creator string, client libgoal.Client) {
 	if cmd.Flags().Changed("asset") {
-		reportWarnln("Warning: The [--asset] flag is deprecated and will be removed in a future release, use [--unitname] instead.")
+		reportWarnln("The [--asset] flag is deprecated and will be removed in a future release, use [--unitname] instead.")
 	}
 
 	if cmd.Flags().Changed("asset") && cmd.Flags().Changed("unitname") {

cmd/goal/clerk.go

@@ -469,7 +469,7 @@ var sendCmd = &cobra.Command{
 
 			// Append the signer since it's a rekey txn
 			if basics.Address(addr) == stx.Txn.Sender {
-				reportWarnln("Warning:" + rekeySenderTargetSameError)
+				reportWarnln(rekeySenderTargetSameError)
 			}
 			stx.AuthAddr = basics.Address(addr)
 		}
@@ -557,7 +557,7 @@ var rawsendCmd = &cobra.Command{
 				for _, txn := range txgroup {
 					txnErrors[txn.ID()] = err.Error()
 				}
-				reportWarnf("Warning: "+errorBroadcastingTX, err)
+				reportWarnf(errorBroadcastingTX, err)
 				continue
 			}
 
@@ -584,7 +584,7 @@ var rawsendCmd = &cobra.Command{
 				txn, err := client.PendingTransactionInformation(txidStr)
 				if err != nil {
 					txnErrors[txid] = err.Error()
-					reportWarnf("Warning: "+errorRequestFail, err)
+					reportWarnf(errorRequestFail, err)
 					continue
 				}
 
@@ -595,7 +595,7 @@ var rawsendCmd = &cobra.Command{
 
 				if txn.PoolError != "" {
 					txnErrors[txid] = txn.PoolError
-					reportWarnf("Warning: "+txPoolError, txidStr, txn.PoolError)
+					reportWarnf(txPoolError, txidStr, txn.PoolError)
 					continue
 				}
 
@@ -950,13 +950,13 @@ func assembleFile(fname string, printWarnings bool) (program []byte) {
 
 	if printWarnings && len(ops.Warnings) != 0 {
 		for _, warning := range ops.Warnings {
-			reportWarnln(warning.Error())
+			reportWarnRawln(warning.Error())
 		}
 		plural := "s"
 		if len(ops.Warnings) == 1 {
 			plural = ""
 		}
-		reportWarnf("%d warning%s", len(ops.Warnings), plural)
+		reportWarnRawf("%d warning%s", len(ops.Warnings), plural)
 	}
 
 	return ops.Program

cmd/goal/commands.go

@@ -517,7 +517,9 @@ func reportInfof(format string, args ...interface{}) {
 	reportInfoln(fmt.Sprintf(format, args...))
 }
 
-func reportWarnln(args ...interface{}) {
+// reportWarnRawln prints a warning message to stderr. Only use this function if that warning
+// message already indicates that it's a warning. Otherwise, use reportWarnln
+func reportWarnRawln(args ...interface{}) {
 	for _, line := range strings.Split(fmt.Sprint(args...), "\n") {
 		printable, line := unicodePrintable(line)
 		if !printable {
@@ -528,6 +530,20 @@ func reportWarnln(args ...interface{}) {
 	}
 }
 
+// reportWarnRawf prints a warning message to stderr. Only use this function if that warning message
+// already indicates that it's a warning. Otherwise, use reportWarnf
+func reportWarnRawf(format string, args ...interface{}) {
+	reportWarnRawln(fmt.Sprintf(format, args...))
+}
+
+// reportWarnln prints a warning message to stderr. The message will be prefixed with "Warning: ".
+// If you don't want this prefix, use reportWarnRawln
+func reportWarnln(args ...interface{}) {
+	reportWarnRawf("Warning: %s", args...)
+}
+
+// reportWarnf prints a warning message to stderr. The message will be prefixed with "Warning: ". If
+// you don't want this prefix, use reportWarnRawf
 func reportWarnf(format string, args ...interface{}) {
 	reportWarnln(fmt.Sprintf(format, args...))
 }

cmd/goal/interact.go

@@ -574,7 +574,7 @@ var appExecuteCmd = &cobra.Command{
 		if appIdx == 0 {
 			switch onCompletion {
 			case transactions.CloseOutOC, transactions.ClearStateOC:
-				reportWarnf("Warning: OnCompletion %s may be ill-formed when creating an application", onCompletion)
+				reportWarnf("OnCompletion %s may be ill-formed when creating an application", onCompletion)
 			}
 		}
 

cmd/goal/logging.go

@@ -50,7 +50,7 @@ var loggingCmd = &cobra.Command{
 	Long:  `Enable/disable and configure Algorand remote logging.`,
 	Args:  validateNoPosArgsFn,
 	Run: func(cmd *cobra.Command, _ []string) {
-		fmt.Fprintf(os.Stderr, "Warning: `goal logging` deprecated, use `diagcfg telemetry status`\n")
+		reportWarnln("`goal logging` deprecated, use `diagcfg telemetry status`")
 		dataDir := ensureSingleDataDir()
 		cfg, err := logging.EnsureTelemetryConfig(&dataDir, "")
 
@@ -72,7 +72,7 @@ var enableCmd = &cobra.Command{
 	Long:  `This will turn on remote logging. The "friendly name" for the node, used by logging, will be determined by -n nodename.`,
 	Args:  validateNoPosArgsFn,
 	Run: func(cmd *cobra.Command, _ []string) {
-		fmt.Fprintf(os.Stderr, "Warning: `goal logging enable` deprecated, use `diagcfg telemetry enable`\n")
+		reportWarnln("`goal logging enable` deprecated, use `diagcfg telemetry enable`")
 		dataDir := ensureSingleDataDir()
 		cfg, err := logging.EnsureTelemetryConfig(&dataDir, "")
 		if err != nil {
@@ -93,7 +93,7 @@ var disableCmd = &cobra.Command{
 	Short: "Disable Algorand remote logging",
 	Args:  validateNoPosArgsFn,
 	Run: func(cmd *cobra.Command, _ []string) {
-		fmt.Fprintf(os.Stderr, "Warning: `goal logging disable` deprecated, use `diagcfg telemetry disable`\n")
+		reportWarnf("`goal logging disable` deprecated, use `diagcfg telemetry disable`")
 		dataDir := ensureSingleDataDir()
 		cfg, err := logging.EnsureTelemetryConfig(&dataDir, "")