Merge pull request #96 from danielgtaylor/fix-send-defaults

fix: simplify option handling, send explicitly passed defaults

Author: danielgtaylor

cli/operation.go

@@ -6,7 +6,6 @@ import (
 	"log"
 	"net/http"
 	"net/url"
-	"reflect"
 	"strings"
 
 	"github.com/gosimple/slug"
@@ -74,18 +73,13 @@ func (o Operation) command() *cobra.Command {
 
 			query := url.Values{}
 			for _, param := range o.QueryParams {
-				flag := flags[param.Name]
-				if reflect.ValueOf(flag).Elem().Interface() == param.Default {
-					// No need to send the default value. Just skip it.
-					continue
-				}
-
-				if param.Default == nil && reflect.ValueOf(flag).Elem().IsZero() {
-					// No explicit default, so the implied default is the zero value.
-					// Again no need to send that default, so we skip.
+				if !cmd.Flags().Changed(param.OptionName()) {
+					// This option was not passed from the shell, so there is no need to
+					// send it, even if it is the default or zero value.
 					continue
 				}
 
+				flag := flags[param.Name]
 				for _, v := range param.Serialize(flag) {
 					query.Add(param.Name, v)
 				}
@@ -118,26 +112,12 @@ func (o Operation) command() *cobra.Command {
 
 			headers := http.Header{}
 			for _, param := range o.HeaderParams {
-				rv := reflect.ValueOf(flags[param.Name]).Elem()
-				if rv.Interface() == param.Default {
-					// No need to send the default value. Just skip it.
+				if !cmd.Flags().Changed(param.OptionName()) {
+					// This option was not passed from the shell, so there is no need to
+					// send it, even if it is the default or zero value.
 					continue
 				}
 
-				if param.Default == nil {
-					if rv.IsZero() {
-						// No explicit default, so the implied default is the zero value.
-						// Again no need to send that default, so we skip.
-						continue
-					}
-
-					if rv.Kind() == reflect.Slice && rv.Len() == 0 {
-						// IsZero() above fails for empty arrays, so if it's empty let's
-						// ignore it.
-						continue
-					}
-				}
-
 				for _, v := range param.Serialize(flags[param.Name]) {
 					headers.Add(param.Name, v)
 				}

cli/operation_test.go

@@ -13,9 +13,16 @@ import (
 func TestOperation(t *testing.T) {
 	defer gock.Off()
 
-	gock.New("http://example2.com").Get("/prefix/test/id1").MatchParam("search", "foo").Reply(200).JSON(map[string]interface{}{
-		"hello": "world",
-	})
+	gock.
+		New("http://example2.com").
+		Get("/prefix/test/id1").
+		MatchParam("search", "foo").
+		MatchParam("def3", "abc").
+		MatchHeader("Accept", "application/json").
+		Reply(200).
+		JSON(map[string]interface{}{
+			"hello": "world",
+		})
 
 	op := Operation{
 		Name:        "test",
@@ -51,6 +58,29 @@ func TestOperation(t *testing.T) {
 				Description: "desc",
 				Default:     "",
 			},
+			{
+				Type:        "string",
+				Name:        "def3",
+				DisplayName: "def3",
+				Description: "desc",
+				Default:     "abc",
+			},
+		},
+		HeaderParams: []*Param{
+			{
+				Type:        "string",
+				Name:        "Accept",
+				DisplayName: "Accept",
+				Description: "desc",
+				Default:     "application/json",
+			},
+			{
+				Type:        "string",
+				Name:        "Accept-Encoding",
+				DisplayName: "Accept-Encoding",
+				Description: "desc",
+				Default:     "gz",
+			},
 		},
 	}
 
@@ -63,9 +93,9 @@ func TestOperation(t *testing.T) {
 	capture := &strings.Builder{}
 	Stdout = capture
 	Stderr = capture
-	cmd.SetOut(Stdout)
+	cmd.SetOutput(Stdout)
 	viper.Set("rsh-server", "http://example2.com/prefix")
-	cmd.Flags().Parse([]string{"--search=foo"})
+	cmd.Flags().Parse([]string{"--search=foo", "--def-3=abc", "--accept=application/json"})
 	cmd.Run(cmd, []string{"id1"})
 
 	assert.Equal(t, "HTTP/1.1 200 OK\nContent-Type: application/json\n\n{\n  hello: \"world\"\n}\n", capture.String())

cli/param.go

@@ -95,14 +95,18 @@ func (p Param) Serialize(value interface{}) []string {
 	return nil
 }
 
-// AddFlag adds a new option flag to a command's flag set for this parameter.
-func (p Param) AddFlag(flags *pflag.FlagSet) interface{} {
+// OptionName returns the commandline option name for this parameter.
+func (p Param) OptionName() string {
 	name := p.Name
 	if p.DisplayName != "" {
 		name = p.DisplayName
 	}
-	name = strcase.ToDelimited(name, '-')
+	return strcase.ToDelimited(name, '-')
+}
 
+// AddFlag adds a new option flag to a command's flag set for this parameter.
+func (p Param) AddFlag(flags *pflag.FlagSet) interface{} {
+	name := p.OptionName()
 	def := p.Default
 
 	switch p.Type {