Merge pull request #141 from moul/debug-curl

Printing `curl` commands when debugging API requests

Author: moul

README.md

@@ -1128,6 +1128,7 @@ $ scw inspect myserver | jq '.[0].public_ip.address'
 
 #### Features
 
+* `-D,--debug` mode shows ready to copy-paste `curl` commands when using the API (must be used with `--sensitive` to unhide private token)
 * Support of `_patch SERVER tags="tag1 tag2=value2 tag3"`
 * `scw -D login` displays a fake password
 * Support --skip-ssh-key `scw login` ([#129](https://github.com/scaleway/scaleway-cli/issues/129))

pkg/api/api.go

@@ -22,6 +22,7 @@ import (
 
 	log "github.com/scaleway/scaleway-cli/vendor/github.com/Sirupsen/logrus"
 	"github.com/scaleway/scaleway-cli/vendor/github.com/moul/anonuuid"
+	"github.com/scaleway/scaleway-cli/vendor/github.com/moul/http2curl"
 )
 
 // Default values
@@ -626,13 +627,21 @@ func (s *ScalewayAPI) Sync() {
 // GetResponse returns an http.Response object for the requested resource
 func (s *ScalewayAPI) GetResponse(resource string) (*http.Response, error) {
 	uri := fmt.Sprintf("%s/%s", strings.TrimRight(s.APIUrl, "/"), resource)
-	log.Debugf("GET %s", uri)
+
 	req, err := http.NewRequest("GET", uri, nil)
 	if err != nil {
 		return nil, err
 	}
 	req.Header.Set("X-Auth-Token", s.Token)
 	req.Header.Set("Content-Type", "application/json")
+
+	curl, err := http2curl.GetCurlCommand(req)
+	if os.Getenv("SCW_SENSITIVE") != "1" {
+		log.Debug(s.HideAPICredentials(curl.String()))
+	} else {
+		log.Debug(curl.String())
+	}
+
 	return s.client.Do(req)
 }
 
@@ -645,18 +654,20 @@ func (s *ScalewayAPI) PostResponse(resource string, data interface{}) (*http.Res
 		return nil, err
 	}
 
-	payloadString := strings.TrimSpace(fmt.Sprintf("%s", payload))
-	if os.Getenv("SCW_SENSITIVE") != "1" {
-		payloadString = s.HideAPICredentials(payloadString)
-	}
-	log.Debugf("POST %s payload=%s", uri, payloadString)
-
 	req, err := http.NewRequest("POST", uri, payload)
 	if err != nil {
 		return nil, err
 	}
 	req.Header.Set("X-Auth-Token", s.Token)
 	req.Header.Set("Content-Type", "application/json")
+
+	curl, err := http2curl.GetCurlCommand(req)
+	if os.Getenv("SCW_SENSITIVE") != "1" {
+		log.Debug(s.HideAPICredentials(curl.String()))
+	} else {
+		log.Debug(curl.String())
+	}
+
 	return s.client.Do(req)
 }
 
@@ -669,18 +680,20 @@ func (s *ScalewayAPI) PatchResponse(resource string, data interface{}) (*http.Re
 		return nil, err
 	}
 
-	payloadString := strings.TrimSpace(fmt.Sprintf("%s", payload))
-	if os.Getenv("SCW_SENSITIVE") != "1" {
-		payloadString = s.HideAPICredentials(payloadString)
-	}
-	log.Debugf("PATCH %s payload=%s", uri, payloadString)
-
 	req, err := http.NewRequest("PATCH", uri, payload)
 	if err != nil {
 		return nil, err
 	}
 	req.Header.Set("X-Auth-Token", s.Token)
 	req.Header.Set("Content-Type", "application/json")
+
+	curl, err := http2curl.GetCurlCommand(req)
+	if os.Getenv("SCW_SENSITIVE") != "1" {
+		log.Debug(s.HideAPICredentials(curl.String()))
+	} else {
+		log.Debug(curl.String())
+	}
+
 	return s.client.Do(req)
 }
 
@@ -693,31 +706,41 @@ func (s *ScalewayAPI) PutResponse(resource string, data interface{}) (*http.Resp
 		return nil, err
 	}
 
-	payloadString := strings.TrimSpace(fmt.Sprintf("%s", payload))
-	if os.Getenv("SCW_SENSITIVE") != "1" {
-		payloadString = s.HideAPICredentials(payloadString)
-	}
-	log.Debugf("PUT %s payload=%s", uri, payloadString)
-
 	req, err := http.NewRequest("PUT", uri, payload)
 	if err != nil {
 		return nil, err
 	}
 	req.Header.Set("X-Auth-Token", s.Token)
 	req.Header.Set("Content-Type", "application/json")
+
+	curl, err := http2curl.GetCurlCommand(req)
+	if os.Getenv("SCW_SENSITIVE") != "1" {
+		log.Debug(s.HideAPICredentials(curl.String()))
+	} else {
+		log.Debug(curl.String())
+	}
+
 	return s.client.Do(req)
 }
 
 // DeleteResponse returns an http.Response object for the deleted resource
 func (s *ScalewayAPI) DeleteResponse(resource string) (*http.Response, error) {
 	uri := fmt.Sprintf("%s/%s", strings.TrimRight(s.APIUrl, "/"), resource)
-	log.Debugf("DELETE %s", uri)
+
 	req, err := http.NewRequest("DELETE", uri, nil)
 	if err != nil {
 		return nil, err
 	}
 	req.Header.Set("X-Auth-Token", s.Token)
 	req.Header.Set("Content-Type", "application/json")
+
+	curl, err := http2curl.GetCurlCommand(req)
+	if os.Getenv("SCW_SENSITIVE") != "1" {
+		log.Debug(s.HideAPICredentials(curl.String()))
+	} else {
+		log.Debug(curl.String())
+	}
+
 	return s.client.Do(req)
 }
 

pkg/cli/x_patch.go

@@ -104,7 +104,7 @@ func runPatch(cmd *Command, args []string) error {
 			log.Debugf("no changes, not updating server")
 		}
 		if err != nil {
-			log.Fatalf("Cannot rename server: %v", err)
+			log.Fatalf("Cannot update server: %v", err)
 		}
 	default:
 		log.Fatalf("_patch not implemented for this kind of object")

pkg/sshcommand/sshcommand.go

@@ -107,8 +107,9 @@ func (c *Command) Slice() []string {
 func (c *Command) String() string {
 	slice := c.Slice()
 	for i := range slice {
-		if strings.Contains(slice[i], " ") {
-			slice[i] = fmt.Sprintf("%q", slice[i])
+		quoted := fmt.Sprintf("%q", slice[i])
+		if strings.Contains(slice[i], " ") || len(quoted) != len(slice[i])+2 {
+			slice[i] = quoted
 		}
 	}
 	return strings.Join(slice, " ")