make http response var capture more generic

Author: theodore-s-beers

checks/http.go

@@ -199,16 +199,40 @@ func truncateAndStringifyBody(body []byte) string {
 }
 
 func parseVariables(body []byte, vardefs []api.HTTPRequestResponseVariable, variables map[string]string) error {
+	bodyString := string(body)
+
 	for _, vardef := range vardefs {
-		vals, err := valsFromJqPath(vardef.Path, string(body))
-		if err != nil {
-			return err
-		}
-		if len(vals) != 1 || vals[0] == nil {
-			continue
+		switch {
+		case vardef.Path != "" && vardef.BodyRegex != "":
+			return fmt.Errorf("invalid response variable configuration")
+
+		case vardef.BodyRegex != "":
+			re, err := regexp.Compile(vardef.BodyRegex)
+			if err != nil {
+				return fmt.Errorf("invalid response body variable configuration")
+			}
+			if re.NumSubexp() != 1 {
+				return fmt.Errorf("invalid response body variable configuration")
+			}
+			matches := re.FindStringSubmatch(bodyString)
+			if len(matches) == 2 && matches[1] != "" {
+				variables[vardef.Name] = matches[1]
+			}
+
+		case vardef.Path != "":
+			vals, err := valsFromJqPath(vardef.Path, bodyString)
+			if err != nil {
+				return err
+			}
+			if len(vals) == 1 && vals[0] != nil {
+				variables[vardef.Name] = fmt.Sprintf("%v", vals[0])
+			}
+
+		default:
+			return fmt.Errorf("invalid response variable configuration")
 		}
-		variables[vardef.Name] = fmt.Sprintf("%v", vals[0])
 	}
+
 	return nil
 }
 
@@ -223,10 +247,10 @@ func parseHeaderVariables(headers map[string]string, vardefs []api.HTTPRequestRe
 		if vardef.Regex != "" {
 			re, err := regexp.Compile(vardef.Regex)
 			if err != nil {
-				return err
+				return fmt.Errorf("invalid response header variable configuration")
 			}
 			if re.NumSubexp() != 1 {
-				return fmt.Errorf("regex for header variable %q must have exactly one capture group", vardef.Name)
+				return fmt.Errorf("invalid response header variable configuration")
 			}
 
 			matches := re.FindStringSubmatch(headerValue)

checks/http_test.go

@@ -202,6 +202,38 @@ func TestParseVariablesLeavesMissingValuesUnset(t *testing.T) {
 	}
 }
 
+func TestParseVariablesCapturesBodyRegex(t *testing.T) {
+	variables := map[string]string{}
+	err := parseVariables(
+		[]byte(`<a href="/password-reset/abc123">reset</a>`),
+		[]api.HTTPRequestResponseVariable{
+			{Name: "resetToken", BodyRegex: `/password-reset/([a-z0-9]+)`},
+		},
+		variables,
+	)
+	if err != nil {
+		t.Fatalf("unexpected parseVariables error: %v", err)
+	}
+	if variables["resetToken"] != "abc123" {
+		t.Fatalf("resetToken = %q, want abc123", variables["resetToken"])
+	}
+}
+
+func TestParseVariablesRequiresCaptureSource(t *testing.T) {
+	variables := map[string]string{}
+	err := parseVariables(
+		[]byte(`{"token":"abc123"}`),
+		[]api.HTTPRequestResponseVariable{{Name: "token"}},
+		variables,
+	)
+	if err == nil {
+		t.Fatal("expected parseVariables error")
+	}
+	if err.Error() != "invalid response variable configuration" {
+		t.Fatalf("error = %q, want invalid response variable configuration", err.Error())
+	}
+}
+
 func TestParseHeaderVariablesLeavesMissingValuesUnset(t *testing.T) {
 	variables := map[string]string{}
 	err := parseHeaderVariables(

client/lessons.go

@@ -110,8 +110,9 @@ type HTTPBasicAuth struct {
 }
 
 type HTTPRequestResponseVariable struct {
-	Name string `yaml:"name"`
-	Path string `yaml:"path"`
+	Name      string `yaml:"name"`
+	Path      string `yaml:"path"`
+	BodyRegex string `yaml:"bodyRegex"`
 }
 
 type HTTPRequestResponseHeaderVariable struct {

render/variables.go

@@ -46,10 +46,12 @@ func savedVariablesForHTTPResult(result api.HTTPRequestResult) []variableEntry {
 		if value == "" {
 			continue
 		}
+
+		description := responseVariableDescription(responseVariable)
 		entries = append(entries, variableEntry{
 			name:        responseVariable.Name,
 			value:       value,
-			description: "JSON Body " + responseVariable.Path,
+			description: description,
 		})
 	}
 	for _, responseHeaderVariable := range result.Request.ResponseHeaderVariables {
@@ -72,9 +74,11 @@ func missingSaveVariablesForHTTPResult(result api.HTTPRequestResult) []variableE
 		if result.Variables[responseVariable.Name] != "" {
 			continue
 		}
+
+		description := responseVariableDescription(responseVariable)
 		entries = append(entries, variableEntry{
 			name:        responseVariable.Name,
-			description: "JSON Body " + responseVariable.Path,
+			description: description,
 		})
 	}
 	for _, responseHeaderVariable := range result.Request.ResponseHeaderVariables {
@@ -205,3 +209,10 @@ func availableVariablesForCLIResult(result api.CLICommandResult) (entries []vari
 
 	return entries, expectsVariables
 }
+
+func responseVariableDescription(v api.HTTPRequestResponseVariable) string {
+	if v.BodyRegex != "" {
+		return "Response Body pattern"
+	}
+	return "JSON Body " + v.Path
+}

render/variables_test.go

@@ -10,14 +10,17 @@ import (
 func TestHTTPVariableSections(t *testing.T) {
 	result := api.HTTPRequestResult{
 		Variables: map[string]string{
-			"authToken": "token-123",
-			"shortCode": "abc123",
-			"sessionID": "session-123",
+			"authToken":  "token-123",
+			"resetToken": "reset-123",
+			"shortCode":  "abc123",
+			"sessionID":  "session-123",
 		},
 		Request: api.CLIStepHTTPRequest{
 			ResponseVariables: []api.HTTPRequestResponseVariable{
 				{Name: "shortCode", Path: ".short_code"},
+				{Name: "resetToken", BodyRegex: `/password-reset/([a-z0-9]+)`},
 				{Name: "missingCode", Path: ".missing_code"},
+				{Name: "missingResetToken", BodyRegex: `/missing/([a-z0-9]+)`},
 			},
 			ResponseHeaderVariables: []api.HTTPRequestResponseHeaderVariable{
 				{Name: "sessionID", Header: "Set-Cookie", Regex: "session_id=([^;]+)"},
@@ -42,10 +45,12 @@ func TestHTTPVariableSections(t *testing.T) {
 
 	wantContains := []string{
 		"Variables Saved:",
+		"resetToken: reset-123 (Response Body pattern)",
 		"sessionID: session-123 (Response Header Set-Cookie matching session_id=([^;]+))",
 		"shortCode: abc123 (JSON Body .short_code)",
 		"Variables Missing:",
 		"missingCode: [not found] (JSON Body .missing_code)",
+		"missingResetToken: [not found] (Response Body pattern)",
 		"missingSessionID: [not found] (Response Header Set-Cookie matching missing=([^;]+))",
 		"Variables Available:",
 		"authToken: token-123 (Request Header \"Authorization\")",