improve handling of system-error submissions

Author: theodore-s-beers

cmd/submit.go

@@ -92,14 +92,25 @@ func submissionHandler(cmd *cobra.Command, args []string) error {
 		if err != nil {
 			return err
 		}
-		checks.ApplySubmissionResults(data, submissionEvent.StructuredErrCLI, ch)
+		submissionErr := applySubmissionEvent(data, submissionEvent, ch)
 		finalise(submissionEvent)
+		if submissionErr != nil {
+			return submissionErr
+		}
 	} else {
 		finalise(api.LessonSubmissionEvent{})
 	}
 	return nil
 }
 
+func applySubmissionEvent(data api.CLIData, event api.LessonSubmissionEvent, ch chan tea.Msg) error {
+	if event.ResultSlug == api.VerificationResultSlugSystemError {
+		return errors.New("lesson verification failed due to a system error; please try again")
+	}
+	checks.ApplySubmissionResults(data, event.StructuredErrCLI, ch)
+	return nil
+}
+
 func reportDebugFileWrite(path string, err error) {
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "warning: failed to write submission debug output: %v\n", err)

cmd/submit_test.go

@@ -0,0 +1,29 @@
+package cmd
+
+import (
+	"strings"
+	"testing"
+
+	api "github.com/bootdotdev/bootdev/client"
+	tea "github.com/charmbracelet/bubbletea"
+)
+
+func TestApplySubmissionEventRejectsSystemErrorWithoutMarkingStepsPassed(t *testing.T) {
+	data := api.CLIData{Steps: []api.CLIStep{{
+		CLICommand: &api.CLIStepCLICommand{Tests: []api.CLICommandTest{{}}},
+	}}}
+	ch := make(chan tea.Msg, 1)
+
+	err := applySubmissionEvent(data, api.LessonSubmissionEvent{
+		ResultSlug: api.VerificationResultSlugSystemError,
+	}, ch)
+	if err == nil || !strings.Contains(err.Error(), "system error") {
+		t.Fatalf("applySubmissionEvent() error = %v, want system error", err)
+	}
+
+	select {
+	case msg := <-ch:
+		t.Fatalf("system error unexpectedly emitted result message: %#v", msg)
+	default:
+	}
+}

render/view.go

@@ -168,6 +168,17 @@ func (m rootModel) View() string {
 		str.WriteString(green.Render("Return to your browser to continue with the next lesson."))
 		str.WriteByte('\n')
 		str.WriteByte('\n')
+	} else if m.result == api.VerificationResultSlugSystemError {
+		str.WriteByte('\n')
+		str.WriteByte('\n')
+		str.WriteString(red.Render("Unable to verify this lesson due to a system error."))
+		if m.failure != nil && m.failure.ErrorMessage != "" {
+			str.WriteString(red.Render(fmt.Sprintf("\nError: %s", m.failure.ErrorMessage)))
+		}
+		str.WriteByte('\n')
+		str.WriteString(red.Render("Please try again."))
+		str.WriteByte('\n')
+		str.WriteByte('\n')
 	} else if m.result == api.VerificationResultSlugNoop {
 		str.WriteString("\n\nTests failed! ❌")
 		fmt.Fprintf(&str, "\n\nFailed Step: %v", m.failure.FailedStepIndex+1)

render/view_test.go

@@ -145,6 +145,32 @@ func TestVerboseViewStaysCompactUntilFinalized(t *testing.T) {
 	}
 }
 
+func TestSystemErrorViewDoesNotShowStepsAsPassed(t *testing.T) {
+	m := initModel(true, false)
+	m.finalized = true
+	m.result = api.VerificationResultSlugSystemError
+	m.steps = []stepModel{{
+		description: "The command prints a greeting",
+		finished:    true,
+	}}
+
+	view := m.View()
+	for _, expected := range []string{
+		"?  The command prints a greeting",
+		"Unable to verify this lesson due to a system error.",
+		"Please try again.",
+	} {
+		if !strings.Contains(view, expected) {
+			t.Errorf("view missing %q\n%s", expected, view)
+		}
+	}
+	for _, unexpected := range []string{"✓  The command prints a greeting", "All tests passed!"} {
+		if strings.Contains(view, unexpected) {
+			t.Errorf("view unexpectedly contains %q\n%s", unexpected, view)
+		}
+	}
+}
+
 func TestStartStepFallsBackToTechnicalDescription(t *testing.T) {
 	m := initModel(true, false)
 	updated, _ := m.Update(messages.StartStepMsg{CMD: "go test ./..."})