add local test command

Author: theodore-s-beers

checks/jq_test.go

@@ -56,7 +56,7 @@ func TestRunStdoutJqQuery(t *testing.T) {
 		},
 		{
 			name:   "returns jq error",
-			stdout: `{"name":"Theo"}`,
+			stdout: `{"name":"Kaladin"}`,
 			test: api.StdoutJqTest{
 				InputMode: "json",
 				Query:     `.name[`,
@@ -106,13 +106,13 @@ func TestFormatJqResults(t *testing.T) {
 }
 
 func TestFormatJqExpectedValueInterpolatesOnlyStrings(t *testing.T) {
-	variables := map[string]string{"name": "Theo"}
+	variables := map[string]string{"name": "Allan"}
 
 	gotString := formatJqExpectedValue(api.JqExpectedResult{
 		Type:  api.JqTypeString,
 		Value: "hello ${name}",
 	}, variables)
-	if gotString != `"hello Theo"` {
+	if gotString != `"hello Allan"` {
 		t.Fatalf("expected interpolated string value, got %q", gotString)
 	}
 

checks/local.go

@@ -0,0 +1,310 @@
+package checks
+
+import (
+	"fmt"
+	"math"
+	"strconv"
+	"strings"
+
+	api "github.com/bootdotdev/bootdev/client"
+)
+
+func LocalSubmissionEvent(cliData api.CLIData, results []api.CLIStepResult) api.LessonSubmissionEvent {
+	failure := EvaluateCLIResults(cliData, results)
+	slug := api.VerificationResultSlugSuccess
+	if failure != nil {
+		slug = api.VerificationResultSlugFailure
+		if failure.FailedStepIndex >= 0 &&
+			failure.FailedStepIndex < len(cliData.Steps) &&
+			cliData.Steps[failure.FailedStepIndex].NoPenaltyOnFail {
+			slug = api.VerificationResultSlugNoop
+		}
+	}
+
+	return api.LessonSubmissionEvent{
+		ResultSlug:       slug,
+		StructuredErrCLI: failure,
+		XPReward:         -1,
+	}
+}
+
+func EvaluateCLIResults(cliData api.CLIData, results []api.CLIStepResult) *api.StructuredErrCLI {
+	for stepIndex, step := range cliData.Steps {
+		if stepIndex >= len(results) {
+			return localFailure(stepIndex, 0, "missing result for step")
+		}
+
+		switch {
+		case step.CLICommand != nil:
+			result := results[stepIndex].CLICommandResult
+			if result == nil {
+				return localFailure(stepIndex, 0, "missing CLI command result")
+			}
+			if failure := evaluateCLICommandTests(stepIndex, *step.CLICommand, *result); failure != nil {
+				return failure
+			}
+		case step.HTTPRequest != nil:
+			result := results[stepIndex].HTTPRequestResult
+			if result == nil {
+				return localFailure(stepIndex, 0, "missing HTTP request result")
+			}
+			if failure := evaluateHTTPRequestTests(stepIndex, *step.HTTPRequest, *result); failure != nil {
+				return failure
+			}
+		default:
+			return localFailure(stepIndex, 0, "missing step definition")
+		}
+	}
+
+	return nil
+}
+
+func evaluateCLICommandTests(stepIndex int, cmd api.CLIStepCLICommand, result api.CLICommandResult) *api.StructuredErrCLI {
+	for testIndex, test := range cmd.Tests {
+		var err error
+
+		switch {
+		case test.ExitCode != nil:
+			if result.ExitCode != *test.ExitCode {
+				err = fmt.Errorf("expected exit code %d, got %d", *test.ExitCode, result.ExitCode)
+			}
+		case len(test.StdoutContainsAll) > 0:
+			for _, contains := range test.StdoutContainsAll {
+				needle := InterpolateVariables(contains, result.Variables)
+				if !strings.Contains(result.Stdout, needle) {
+					err = fmt.Errorf("expected stdout to contain %q", needle)
+					break
+				}
+			}
+		case len(test.StdoutContainsNone) > 0:
+			for _, containsNone := range test.StdoutContainsNone {
+				needle := InterpolateVariables(containsNone, result.Variables)
+				if strings.Contains(result.Stdout, needle) {
+					err = fmt.Errorf("expected stdout to not contain %q", needle)
+					break
+				}
+			}
+		case test.StdoutLinesGt != nil:
+			lineCount := stdoutLineCount(result.Stdout)
+			if lineCount <= *test.StdoutLinesGt {
+				err = fmt.Errorf("expected stdout to have more than %d lines, got %d", *test.StdoutLinesGt, lineCount)
+			}
+		case test.StdoutJq != nil:
+			err = evaluateStdoutJq(result.Stdout, *test.StdoutJq, result.Variables)
+		default:
+			err = fmt.Errorf("unsupported CLI command test")
+		}
+
+		if err != nil {
+			return localFailure(stepIndex, testIndex, err.Error())
+		}
+	}
+
+	return nil
+}
+
+func evaluateHTTPRequestTests(stepIndex int, req api.CLIStepHTTPRequest, result api.HTTPRequestResult) *api.StructuredErrCLI {
+	if result.Err != "" {
+		return localFailure(stepIndex, 0, result.Err)
+	}
+
+	for testIndex, test := range req.Tests {
+		var err error
+
+		switch {
+		case test.StatusCode != nil:
+			if result.StatusCode != *test.StatusCode {
+				err = fmt.Errorf("expected status code %d, got %d", *test.StatusCode, result.StatusCode)
+			}
+		case test.BodyContains != nil:
+			needle := InterpolateVariables(*test.BodyContains, result.Variables)
+			if !strings.Contains(result.BodyString, needle) {
+				err = fmt.Errorf("expected body to contain %q", needle)
+			}
+		case test.BodyContainsNone != nil:
+			needle := InterpolateVariables(*test.BodyContainsNone, result.Variables)
+			if strings.Contains(result.BodyString, needle) {
+				err = fmt.Errorf("expected body to not contain %q", needle)
+			}
+		case test.HeadersContain != nil:
+			err = evaluateHeaderContains(result.ResponseHeaders, *test.HeadersContain, result.Variables, "header")
+		case test.TrailersContain != nil:
+			err = evaluateHeaderContains(result.ResponseTrailers, *test.TrailersContain, result.Variables, "trailer")
+		case test.JSONValue != nil:
+			err = evaluateHTTPJSONValue(result.BodyString, *test.JSONValue, result.Variables)
+		default:
+			err = fmt.Errorf("unsupported HTTP request test")
+		}
+
+		if err != nil {
+			return localFailure(stepIndex, testIndex, err.Error())
+		}
+	}
+
+	return nil
+}
+
+func evaluateHeaderContains(headers map[string]string, test api.HTTPRequestTestHeader, variables map[string]string, label string) error {
+	key := InterpolateVariables(test.Key, variables)
+	want := InterpolateVariables(test.Value, variables)
+
+	got, ok := findHeaderValue(headers, key)
+	if !ok {
+		return fmt.Errorf("expected %s %q to exist", label, key)
+	}
+	if !strings.Contains(got, want) {
+		return fmt.Errorf("expected %s %q to contain %q, got %q", label, key, want, got)
+	}
+
+	return nil
+}
+
+func evaluateHTTPJSONValue(body string, test api.HTTPRequestTestJSONValue, variables map[string]string) error {
+	got, err := valFromJqPath(test.Path, body)
+	if err != nil {
+		return err
+	}
+
+	want, err := httpJSONExpectedValue(test, variables)
+	if err != nil {
+		return err
+	}
+
+	if !compareValues(got, test.Operator, want) {
+		return fmt.Errorf("expected JSON at %s %s %v, got %v", test.Path, test.Operator, want, got)
+	}
+
+	return nil
+}
+
+func httpJSONExpectedValue(test api.HTTPRequestTestJSONValue, variables map[string]string) (any, error) {
+	switch {
+	case test.IntValue != nil:
+		return *test.IntValue, nil
+	case test.StringValue != nil:
+		return InterpolateVariables(*test.StringValue, variables), nil
+	case test.BoolValue != nil:
+		return *test.BoolValue, nil
+	default:
+		return nil, fmt.Errorf("missing expected JSON value")
+	}
+}
+
+func evaluateStdoutJq(stdout string, test api.StdoutJqTest, variables map[string]string) error {
+	queryText := InterpolateVariables(test.Query, variables)
+
+	input, err := parseJqInput(stdout, test.InputMode)
+	if err != nil {
+		return err
+	}
+
+	results, err := executeJqQuery(queryText, input)
+	if err != nil {
+		return err
+	}
+	if len(results) != len(test.ExpectedResults) {
+		return fmt.Errorf("expected jq query %q to return %d result(s), got %d", queryText, len(test.ExpectedResults), len(results))
+	}
+
+	for i, expected := range test.ExpectedResults {
+		want, err := jqExpectedValue(expected, variables)
+		if err != nil {
+			return err
+		}
+		if !compareValues(results[i], api.OperatorType(expected.Operator), want) {
+			return fmt.Errorf("expected jq result %d to be %s %v, got %v", i+1, expected.Operator, want, results[i])
+		}
+	}
+
+	return nil
+}
+
+func jqExpectedValue(expected api.JqExpectedResult, variables map[string]string) (any, error) {
+	switch expected.Type {
+	case api.JqTypeString:
+		if str, ok := expected.Value.(string); ok {
+			return InterpolateVariables(str, variables), nil
+		}
+		return expected.Value, nil
+	case api.JqTypeInt:
+		if str, ok := expected.Value.(string); ok {
+			parsed, err := strconv.Atoi(InterpolateVariables(str, variables))
+			if err != nil {
+				return nil, err
+			}
+			return parsed, nil
+		}
+		return expected.Value, nil
+	case api.JqTypeBool:
+		if str, ok := expected.Value.(string); ok {
+			parsed, err := strconv.ParseBool(InterpolateVariables(str, variables))
+			if err != nil {
+				return nil, err
+			}
+			return parsed, nil
+		}
+		return expected.Value, nil
+	default:
+		return nil, fmt.Errorf("unsupported jq expected result type %q", expected.Type)
+	}
+}
+
+func compareValues(got any, operator api.OperatorType, want any) bool {
+	switch operator {
+	case api.OpEquals, "==":
+		return valuesEqual(got, want)
+	case api.OpGreaterThan, ">":
+		gotNum, gotOK := numberValue(got)
+		wantNum, wantOK := numberValue(want)
+		return gotOK && wantOK && gotNum > wantNum
+	case api.OpContains:
+		return strings.Contains(fmt.Sprintf("%v", got), fmt.Sprintf("%v", want))
+	case api.OpNotContains:
+		return !strings.Contains(fmt.Sprintf("%v", got), fmt.Sprintf("%v", want))
+	default:
+		return false
+	}
+}
+
+func valuesEqual(got any, want any) bool {
+	if gotNum, gotOK := numberValue(got); gotOK {
+		wantNum, wantOK := numberValue(want)
+		return wantOK && math.Abs(gotNum-wantNum) < 0.000000001
+	}
+	return fmt.Sprintf("%v", got) == fmt.Sprintf("%v", want)
+}
+
+func numberValue(value any) (float64, bool) {
+	switch v := value.(type) {
+	case int:
+		return float64(v), true
+	case int64:
+		return float64(v), true
+	case float64:
+		return v, true
+	case jsonNumber:
+		parsed, err := strconv.ParseFloat(v.String(), 64)
+		return parsed, err == nil
+	default:
+		return 0, false
+	}
+}
+
+func stdoutLineCount(stdout string) int {
+	if stdout == "" {
+		return 0
+	}
+	return strings.Count(stdout, "\n") + 1
+}
+
+func localFailure(stepIndex int, testIndex int, message string) *api.StructuredErrCLI {
+	return &api.StructuredErrCLI{
+		ErrorMessage:    message,
+		FailedStepIndex: stepIndex,
+		FailedTestIndex: testIndex,
+	}
+}
+
+type jsonNumber interface {
+	String() string
+}