distinguish variable not found from empty

Author: theodore-s-beers

render/variables.go

@@ -13,6 +13,7 @@ import (
 type variableEntry struct {
 	name        string
 	value       string
+	found       bool
 	description string
 }
 
@@ -27,41 +28,46 @@ func renderVariableSection(title string, entries []variableEntry) string {
 	var str strings.Builder
 	fmt.Fprintf(&str, "  %s: \n", title)
 	for _, entry := range entries {
-		fmt.Fprintf(&str, "   - %s: %s (%s)\n", entry.name, formatVariableValue(entry.value), entry.description)
+		fmt.Fprintf(&str, "   - %s: %s (%s)\n", entry.name, formatVariableValue(entry.value, entry.found), entry.description)
 	}
 	return str.String()
 }
 
-func formatVariableValue(value string) string {
-	if value == "" {
+func formatVariableValue(value string, found bool) string {
+	if !found {
 		return "[not found]"
 	}
+	if value == "" {
+		return "[empty]"
+	}
 	return value
 }
 
 func savedVariablesForHTTPResult(result api.HTTPRequestResult) []variableEntry {
 	var entries []variableEntry
 	for _, responseVariable := range result.Request.ResponseVariables {
-		value := result.Variables[responseVariable.Name]
-		if value == "" {
+		value, found := result.Variables[responseVariable.Name]
+		if !found {
 			continue
 		}
 
 		description := responseVariableDescription(responseVariable)
 		entries = append(entries, variableEntry{
 			name:        responseVariable.Name,
 			value:       value,
+			found:       true,
 			description: description,
 		})
 	}
 	for _, responseHeaderVariable := range result.Request.ResponseHeaderVariables {
-		value := result.Variables[responseHeaderVariable.Name]
-		if value == "" {
+		value, found := result.Variables[responseHeaderVariable.Name]
+		if !found {
 			continue
 		}
 		entries = append(entries, variableEntry{
 			name:        responseHeaderVariable.Name,
 			value:       value,
+			found:       true,
 			description: responseHeaderVariableDescription(responseHeaderVariable),
 		})
 	}
@@ -71,7 +77,7 @@ func savedVariablesForHTTPResult(result api.HTTPRequestResult) []variableEntry {
 func missingSaveVariablesForHTTPResult(result api.HTTPRequestResult) []variableEntry {
 	var entries []variableEntry
 	for _, responseVariable := range result.Request.ResponseVariables {
-		if result.Variables[responseVariable.Name] != "" {
+		if _, found := result.Variables[responseVariable.Name]; found {
 			continue
 		}
 
@@ -82,7 +88,7 @@ func missingSaveVariablesForHTTPResult(result api.HTTPRequestResult) []variableE
 		})
 	}
 	for _, responseHeaderVariable := range result.Request.ResponseHeaderVariables {
-		if result.Variables[responseHeaderVariable.Name] != "" {
+		if _, found := result.Variables[responseHeaderVariable.Name]; found {
 			continue
 		}
 		entries = append(entries, variableEntry{
@@ -108,7 +114,7 @@ func availableVariablesForHTTPResult(result api.HTTPRequestResult) (entries []va
 			return
 		}
 		expectsVariables = true
-		value := result.Variables[name]
+		value, found := result.Variables[name]
 		key := name + "\x00" + description
 		if seen[key] {
 			return
@@ -117,6 +123,7 @@ func availableVariablesForHTTPResult(result api.HTTPRequestResult) (entries []va
 		entries = append(entries, variableEntry{
 			name:        name,
 			value:       value,
+			found:       found,
 			description: description,
 		})
 	}
@@ -167,7 +174,7 @@ func availableVariablesForCLIResult(result api.CLICommandResult) (entries []vari
 
 	add := func(name, description string) {
 		expectsVariables = true
-		value := result.Variables[name]
+		value, found := result.Variables[name]
 		key := name + "\x00" + description
 		if seen[key] {
 			return
@@ -176,6 +183,7 @@ func availableVariablesForCLIResult(result api.CLICommandResult) (entries []vari
 		entries = append(entries, variableEntry{
 			name:        name,
 			value:       value,
+			found:       found,
 			description: description,
 		})
 	}

render/variables_test.go

@@ -83,13 +83,48 @@ func TestAvailableVariablesPrintsNotFoundWhenExpectedButUnavailable(t *testing.T
 	}
 }
 
+func TestHTTPVariableSectionsDistinguishEmptyFromMissing(t *testing.T) {
+	result := api.HTTPRequestResult{
+		Variables: map[string]string{"emptyCode": ""},
+		Request: api.CLIStepHTTPRequest{
+			ResponseVariables: []api.HTTPRequestResponseVariable{
+				{Name: "emptyCode", Path: ".empty_code"},
+				{Name: "missingCode", Path: ".missing_code"},
+			},
+			Request: api.HTTPRequest{
+				Headers: map[string]string{"X-Code": "${emptyCode}"},
+			},
+		},
+	}
+
+	got := printHTTPRequestResult(result)
+	for _, expected := range []string{
+		"emptyCode: [empty] (JSON Body .empty_code)",
+		"missingCode: [not found] (JSON Body .missing_code)",
+		"emptyCode: [empty] (Request Header \"X-Code\")",
+	} {
+		if !strings.Contains(got, expected) {
+			t.Errorf("output missing %q\n%s", expected, got)
+		}
+	}
+	for _, unexpected := range []string{
+		"emptyCode: [not found]",
+		"missingCode: [empty]",
+	} {
+		if strings.Contains(got, unexpected) {
+			t.Errorf("output unexpectedly contains %q\n%s", unexpected, got)
+		}
+	}
+}
+
 func TestCLIAvailableVariables(t *testing.T) {
 	result := api.CLICommandResult{
 		Variables: map[string]string{
-			"url": "http://localhost:42069",
+			"empty": "",
+			"url":   "http://localhost:42069",
 		},
 		Command: api.CLIStepCLICommand{
-			Command: "curl ${url}",
+			Command: "curl ${url} ${empty}",
 			Tests: []api.CLICommandTest{
 				{StdoutContainsAll: []string{"${expected}"}},
 			},
@@ -105,6 +140,9 @@ func TestCLIAvailableVariables(t *testing.T) {
 	if !strings.Contains(got, "url: http://localhost:42069 (Command)") {
 		t.Fatalf("expected url entry in:\n%s", got)
 	}
+	if !strings.Contains(got, "empty: [empty] (Command)") {
+		t.Fatalf("expected empty entry in:\n%s", got)
+	}
 	if !strings.Contains(got, "expected: [not found] (Stdout Contains Test)") {
 		t.Fatalf("expected missing expected entry in:\n%s", got)
 	}