[chore] added global verbose flag

- use verbose output in login command and requests class
- add new printer method for debug output

Author: Kharonus

cmd/login.go

@@ -41,17 +41,20 @@ func login(_ *cobra.Command, _ []string) {
 	var token string
 
 	for {
-		fmt.Print("OpenProject host URL: ")
+		printer.Debug(Verbose, "Parsing host URL ...")
+		printer.Input("OpenProject host URL: ")
+
 		ok, msg, host := parseHostUrl()
 		if !ok {
-			fmt.Println(msg)
+			printer.ErrorText(msg)
 			continue
 		}
 
-		requests.Init(host, "")
+		printer.Debug(Verbose, "Initializing requests client ...")
+		requests.Init(host, "", Verbose)
 		ok = checkOpenProjectApi()
 		if !ok {
-			fmt.Println(noOpInstanceError)
+			printer.ErrorText(noOpInstanceError)
 			continue
 		}
 
@@ -69,7 +72,7 @@ func login(_ *cobra.Command, _ []string) {
 
 		token = common.SanitizeLineBreaks(t)
 
-		requests.Init(hostUrl, token)
+		requests.Init(hostUrl, token, Verbose)
 		user, err := users.Me()
 		if err != nil {
 			printer.Error(err)
@@ -92,24 +95,39 @@ func parseHostUrl() (ok bool, errMessage string, host *url.URL) {
 
 	input, err := reader.ReadString('\n')
 	if err != nil {
+		printer.Debug(Verbose, fmt.Sprintf("Error reading string input: %+v", err))
 		return false, urlInputError, nil
 	}
 
+	printer.Debug(Verbose, fmt.Sprintf("Parsed input %q.", input))
+	printer.Debug(Verbose, "Sanitizing input ...")
+
 	input = common.SanitizeLineBreaks(input)
 	input = strings.TrimSuffix(input, "/")
+
+	printer.Debug(Verbose, fmt.Sprintf("Sanitized input '%s'.", input))
+	printer.Debug(Verbose, "Parsing input as url ...")
+
 	parsed, err := url.Parse(input)
 	if err != nil {
+		printer.Debug(Verbose, fmt.Sprintf("Error parsing url: %+v", err))
 		return false, urlInputError, nil
 	}
 
+	printer.Debug(Verbose, fmt.Sprintf("Parsed url '%s'.", parsed))
+	printer.Debug(Verbose, "Checking for http host and scheme ...")
+
 	if parsed.Scheme == "" || parsed.Host == "" {
 		return false, missingSchemeError, nil
 	}
 
+	printer.Debug(Verbose, "Parsing input successful, continuing with next steps.")
 	return true, "", parsed
 }
 
 func checkOpenProjectApi() bool {
+	printer.Debug(Verbose, "Fetching API root to check for instance configuration ...")
+
 	response, err := requests.Get(paths.Root(), nil)
 	if err != nil {
 		return false

cmd/root.go

@@ -21,6 +21,7 @@ import (
 	"github.com/opf/openproject-cli/components/routes"
 )
 
+var Verbose bool
 var showVersionFlag bool
 
 var rootCmd = &cobra.Command{
@@ -70,7 +71,7 @@ func init() {
 		printer.Error(err)
 	}
 
-	requests.Init(parse, token)
+	requests.Init(parse, token, Verbose)
 	routes.Init(parse)
 
 	rootCmd.Flags().BoolVarP(
@@ -81,6 +82,14 @@ func init() {
 		"Show version information of the OpenProject CLI",
 	)
 
+	rootCmd.PersistentFlags().BoolVarP(
+		&Verbose,
+		"verbose",
+		"",
+		false,
+		"Print verbose information of any process that supports this output.",
+	)
+
 	rootCmd.AddCommand(
 		loginCmd,
 		list.RootCmd,

components/printer/common.go

@@ -2,6 +2,7 @@ package printer
 
 import (
 	"encoding/json"
+
 	"github.com/opf/openproject-cli/components/errors"
 )
 
@@ -15,6 +16,10 @@ func Info(msg string) {
 	activePrinter.Println(msg)
 }
 
+func Input(prompt string) {
+	activePrinter.Printf(prompt)
+}
+
 func Done() {
 	activePrinter.Println(Green("DONE"))
 }
@@ -29,6 +34,12 @@ func Error(err error) {
 	}
 }
 
+func Debug(verboseFlag bool, msg string) {
+	if verboseFlag {
+		activePrinter.Printf("%s %s\n", Magenta("[DEBUG]"), msg)
+	}
+}
+
 func ErrorText(msg string) {
 	activePrinter.Printf("%s %s\n", Red("[ERROR]"), msg)
 }

components/requests/requests.go

@@ -1,6 +1,7 @@
 package requests
 
 import (
+	"fmt"
 	"io"
 	"net/http"
 	"net/url"
@@ -13,16 +14,18 @@ import (
 var client *http.Client
 var host *url.URL
 var token string
+var verbose bool
 
 type RequestData struct {
 	ContentType string
 	Body        io.Reader
 }
 
-func Init(hostUrl *url.URL, tokenValue string) {
+func Init(hostUrl *url.URL, tokenValue string, verboseFlag bool) {
 	client = &http.Client{}
 	host = hostUrl
 	token = tokenValue
+	verbose = verboseFlag
 }
 
 func Get(path string, query *Query) (responseBody []byte, err error) {
@@ -44,6 +47,12 @@ func Patch(path string, requestBody *RequestData) (responseBody []byte, err erro
 }
 
 func Do(method string, path string, query *Query, requestData *RequestData) (responseBody []byte, err error) {
+	printer.Debug(verbose, "Building HTTP request:")
+	printer.Debug(verbose, fmt.Sprintf("\twith Method: %s", method))
+	printer.Debug(verbose, fmt.Sprintf("\twith Path: %s", path))
+	printer.Debug(verbose, fmt.Sprintf("\twith Query: %+v", query))
+	printer.Debug(verbose, fmt.Sprintf("\twith Body: %+v", requestData))
+
 	if client == nil || hostUnitialised() {
 		return nil, errors.Custom("Cannot execute requests without initializing request client first. Run `op login`")
 	}
@@ -76,6 +85,8 @@ func Do(method string, path string, query *Query, requestData *RequestData) (res
 		request.SetBasicAuth("apikey", token)
 	}
 
+	printer.Debug(verbose, fmt.Sprintf("Running HTTP request %s %s", request.Method, request.URL))
+
 	resp, err := client.Do(request)
 	if err != nil {
 		return nil, err
@@ -87,6 +98,8 @@ func Do(method string, path string, query *Query, requestData *RequestData) (res
 		return nil, err
 	}
 
+	printer.Debug(verbose, fmt.Sprintf("Received response:\n%s", response))
+
 	if !isSuccess(resp.StatusCode) {
 		return nil, errors.NewResponseError(resp.StatusCode, response)
 	}