Fix piping for commands needin wallet unlock

Author: ptrus

cmd/common/helpers.go

@@ -2,6 +2,7 @@ package common
 
 import (
 	"fmt"
+	"os"
 
 	"github.com/spf13/cobra"
 
@@ -11,6 +12,16 @@ import (
 	"github.com/oasisprotocol/cli/config"
 )
 
+// Warnf prints a message to stderr with formatting.
+func Warnf(format string, args ...interface{}) {
+	fmt.Fprintf(os.Stderr, format+"\n", args...)
+}
+
+// Warn prints a message to stderr.
+func Warn(msg string) {
+	fmt.Fprintln(os.Stderr, msg)
+}
+
 // CheckForceErr treats error as warning, if --force is provided.
 func CheckForceErr(err interface{}) {
 	// No error.
@@ -20,7 +31,7 @@ func CheckForceErr(err interface{}) {
 
 	// --force is provided.
 	if IsForce() {
-		fmt.Printf("Warning: %s\nProceeding by force as requested\n", err)
+		Warnf("Warning: %s\nProceeding by force as requested", err)
 		return
 	}
 

cmd/common/prompts.go

@@ -2,11 +2,25 @@ package common
 
 import (
 	"fmt"
+	"os"
 
 	"github.com/AlecAivazis/survey/v2"
 	"github.com/spf13/cobra"
 )
 
+// SurveyStdio is the standard survey option to direct prompts to stderr.
+var SurveyStdio = survey.WithStdio(os.Stdin, os.Stderr, os.Stderr)
+
+// Ask wraps survey.AskOne while forcing prompts to stderr.
+func Ask(p survey.Prompt, response interface{}, opts ...survey.AskOpt) error {
+	return survey.AskOne(p, response, append([]survey.AskOpt{SurveyStdio}, opts...)...)
+}
+
+// AskMulti wraps survey.Ask while forcing prompts to stderr.
+func AskMulti(qs []*survey.Question, response interface{}, opts ...survey.AskOpt) error {
+	return survey.Ask(qs, response, append([]survey.AskOpt{SurveyStdio}, opts...)...)
+}
+
 var (
 	// PromptPassphrase is the standard passphrase prompt.
 	PromptPassphrase = &survey.Password{
@@ -27,12 +41,12 @@ var (
 // Confirm asks the user for confirmation and aborts when rejected.
 func Confirm(msg, abortMsg string) {
 	if answerYes {
-		fmt.Printf("? %s Yes\n", msg)
+		fmt.Fprintf(os.Stderr, "? %s Yes\n", msg)
 		return
 	}
 
 	var proceed bool
-	err := survey.AskOne(&survey.Confirm{Message: msg}, &proceed)
+	err := Ask(&survey.Confirm{Message: msg}, &proceed)
 	cobra.CheckErr(err)
 	if !proceed {
 		cobra.CheckErr(abortMsg)
@@ -61,7 +75,7 @@ func AskNewPassphrase() string {
 			},
 		},
 	}
-	err := survey.Ask(questions, &answers)
+	err := AskMulti(questions, &answers)
 	cobra.CheckErr(err)
 
 	return answers.Passphrase

cmd/common/wallet.go

@@ -2,9 +2,9 @@ package common
 
 import (
 	"fmt"
+	"os"
 	"strings"
 
-	"github.com/AlecAivazis/survey/v2"
 	ethCommon "github.com/ethereum/go-ethereum/common"
 	"github.com/spf13/cobra"
 
@@ -61,9 +61,10 @@ func LoadAccount(cfg *config.Config, name string) wallet.Account {
 	var passphrase string
 	if af.RequiresPassphrase() && !answerYes {
 		// Ask for passphrase to decrypt the account.
-		fmt.Printf("Unlock your account.\n")
+		// Use stderr for prompts so they work when stdout is piped.
+		fmt.Fprintln(os.Stderr, "Unlock your account.")
 
-		err = survey.AskOne(PromptPassphrase, &passphrase)
+		err = Ask(PromptPassphrase, &passphrase)
 		cobra.CheckErr(err)
 	}
 

cmd/network/governance/show.go

@@ -362,15 +362,11 @@ var (
 				// Try to figure out the human readable names for all the entities.
 				fromRegistry, err := metadata.EntitiesFromRegistry(ctx)
 				if err != nil {
-					fmt.Println()
-					fmt.Printf("Warning: failed to query metadata registry: %v", err)
-					fmt.Println()
+					common.Warnf("\nWarning: failed to query metadata registry: %v\n", err)
 				}
 				fromOasisscan, err := metadata.EntitiesFromOasisscan(ctx)
 				if err != nil {
-					fmt.Println()
-					fmt.Printf("Warning: failed to query oasisscan: %v", err)
-					fmt.Println()
+					common.Warnf("\nWarning: failed to query oasisscan: %v\n", err)
 				}
 
 				getName := func(addr staking.Address) string {

cmd/network/network.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/config"
 
+	"github.com/oasisprotocol/cli/cmd/common"
 	"github.com/oasisprotocol/cli/cmd/network/governance"
 )
 
@@ -41,7 +42,7 @@ func networkDetailsFromSurvey(net *config.Network) {
 		Symbol      string
 		Decimals    uint8
 	}{}
-	err := survey.Ask(questions, &answers)
+	err := common.AskMulti(questions, &answers)
 	cobra.CheckErr(err)
 
 	net.Description = answers.Description

cmd/network/remove.go

@@ -24,7 +24,7 @@ var rmCmd = &cobra.Command{
 		}
 
 		if !common.GetAnswerYes() && len(net.ParaTimes.All) > 0 {
-			fmt.Printf("WARNING: Network '%s' contains %d ParaTimes.\n", name, len(net.ParaTimes.All))
+			common.Warnf("WARNING: Network '%s' contains %d ParaTimes.", name, len(net.ParaTimes.All))
 			common.Confirm("Are you sure you want to remove the network?", "not removing network")
 		}
 

cmd/network/trust.go

@@ -66,7 +66,7 @@ WARNING:
 			fmt.Println("Trust height: ", trust.Height)
 			fmt.Println("Trust hash: ", trust.Hash)
 			fmt.Println()
-			fmt.Println("WARNING: Cannot be trusted unless the CLI is connected to the RPC endpoint you control.")
+			common.Warn("WARNING: Cannot be trusted unless the CLI is connected to the RPC endpoint you control.")
 		}
 
 		return nil

cmd/paratime/add.go

@@ -86,7 +86,7 @@ var (
 					},
 				}
 
-				err := survey.Ask(questions, &paratimeInfo)
+				err := common.AskMulti(questions, &paratimeInfo)
 				cobra.CheckErr(err)
 			}
 

cmd/paratime/statistics.go

@@ -384,7 +384,7 @@ var statsCmd = &cobra.Command{
 		if err != nil {
 			// Non-fatal, this is informative and gathering stats is time
 			// consuming.
-			fmt.Printf("\nWarning: failed to query metadata registry: %v\n", err)
+			common.Warnf("\nWarning: failed to query metadata registry: %v", err)
 		}
 
 		stats.prepareEntitiesOutput(entityMetadataLookup)

cmd/rofl/build/build.go

@@ -312,7 +312,7 @@ func setupBuildEnv(deployment *buildRofl.Deployment, npa *common.NPASelection) {
 	trustRoot, err := fetchTrustRoot(npa, deployment.TrustRoot)
 	if deployment.Debug && err != nil {
 		// Trust root is not mandatory for debug builds.
-		fmt.Printf("WARNING: no trust root will be provided during compilation: %v\n", err)
+		common.Warnf("WARNING: no trust root will be provided during compilation: %v", err)
 		return
 	}
 	cobra.CheckErr(err)