no penalty on fail (#152)

Author: skovranek

checks/runner.go

@@ -111,7 +111,7 @@ func sendHTTPRequestResults(ch chan tea.Msg, req api.CLIStepHTTPRequest, result
 	}
 }
 
-func ApplySubmissionResults(cliData api.CLIData, failure *api.VerificationResultStructuredErrCLI, ch chan tea.Msg) {
+func ApplySubmissionResults(cliData api.CLIData, failure *api.StructuredErrCLI, ch chan tea.Msg) {
 	for i, step := range cliData.Steps {
 		stepPass := true
 		isFailedStep := false

client/lessons.go

@@ -14,14 +14,15 @@ type Lesson struct {
 }
 
 type LessonDataCLI struct {
-	// Readme string
+	// Readme  string
 	CLIData CLIData
 }
 
 const BaseURLOverrideRequired = "override"
 
 type CLIData struct {
-	// ContainsCompleteDir bool
+	// ContainsCompleteDir     bool
+	// NoPenaltyOnFail         bool
 	BaseURLDefault          string
 	Steps                   []CLIStep
 	AllowedOperatingSystems []string
@@ -189,41 +190,48 @@ type lessonSubmissionCLI struct {
 	CLIResults []CLIStepResult
 }
 
-type verificationResult struct {
-	ResultSlug string
-	// user friendly message to put in the toast
-	ResultMessage string
-	// only present if the lesson is an CLI type
-	StructuredErrCLI *VerificationResultStructuredErrCLI
+type LessonSubmissionEvent struct {
+	ResultSlug       VerificationResultSlug
+	StructuredErrCLI *StructuredErrCLI
 }
 
-type VerificationResultStructuredErrCLI struct {
+type StructuredErrCLI struct {
 	ErrorMessage    string `json:"Error"`
 	FailedStepIndex int    `json:"FailedStepIndex"`
 	FailedTestIndex int    `json:"FailedTestIndex"`
 }
 
-func SubmitCLILesson(uuid string, results []CLIStepResult) (*VerificationResultStructuredErrCLI, error) {
+type VerificationResultSlug string
+
+const (
+	// "noop" is for "noPenaltyOnFail" on the CLI type
+	VerificationResultSlugNoop        VerificationResultSlug = "noop"
+	VerificationResultSlugSystemError VerificationResultSlug = "system-error"
+	VerificationResultSlugSuccess     VerificationResultSlug = "success"
+	VerificationResultSlugFailure     VerificationResultSlug = "failure"
+)
+
+func SubmitCLILesson(uuid string, results []CLIStepResult) (LessonSubmissionEvent, error) {
 	bytes, err := json.Marshal(lessonSubmissionCLI{CLIResults: results})
 	if err != nil {
-		return nil, err
+		return LessonSubmissionEvent{}, err
 	}
 	endpoint := fmt.Sprintf("/v1/lessons/%v/", uuid)
 	resp, code, err := fetchWithAuthAndPayload("POST", endpoint, bytes)
 	if err != nil {
-		return nil, err
+		return LessonSubmissionEvent{}, err
 	}
 	if code == 402 {
-		return nil, fmt.Errorf("to run and submit the tests for this lesson, you must have an active Boot.dev membership\nhttps://boot.dev/pricing")
+		return LessonSubmissionEvent{}, fmt.Errorf("to run and submit the tests for this lesson, you must have an active Boot.dev membership\nhttps://boot.dev/pricing")
 	}
 	if code != 200 {
-		return nil, fmt.Errorf("failed to submit CLI lesson (code %v): %s", code, string(resp))
+		return LessonSubmissionEvent{}, fmt.Errorf("failed to submit CLI lesson (code %v): %s", code, string(resp))
 	}
 
-	result := verificationResult{}
+	result := LessonSubmissionEvent{}
 	err = json.Unmarshal(resp, &result)
 	if err != nil {
-		return nil, err
+		return LessonSubmissionEvent{}, err
 	}
-	return result.StructuredErrCLI, nil
+	return result, nil
 }

cmd/submit.go

@@ -68,18 +68,17 @@ func submissionHandler(cmd *cobra.Command, args []string) error {
 	// StartRenderer and returns immediately, finalise function blocks the execution until the renderer is closed.
 	finalise := render.StartRenderer(data, isSubmit, ch)
 
-	results := checks.CLIChecks(data, overrideBaseURL, ch)
+	cliResults := checks.CLIChecks(data, overrideBaseURL, ch)
 
 	if isSubmit {
-		failure, err := api.SubmitCLILesson(lessonUUID, results)
+		submissionEvent, err := api.SubmitCLILesson(lessonUUID, cliResults)
 		if err != nil {
 			return err
 		}
-		checks.ApplySubmissionResults(data, failure, ch)
-
-		finalise(failure)
+		checks.ApplySubmissionResults(data, submissionEvent.StructuredErrCLI, ch)
+		finalise(submissionEvent)
 	} else {
-		finalise(nil)
+		finalise(api.LessonSubmissionEvent{})
 	}
 	return nil
 }

messages/messages.go

@@ -21,7 +21,8 @@ type ResolveTestMsg struct {
 }
 
 type DoneStepMsg struct {
-	Failure *api.VerificationResultStructuredErrCLI
+	Result  api.VerificationResultSlug
+	Failure *api.StructuredErrCLI
 }
 
 type ResolveStepMsg struct {

render/models.go

@@ -24,9 +24,9 @@ type stepModel struct {
 type rootModel struct {
 	steps     []stepModel
 	spinner   spinner.Model
-	failure   *api.VerificationResultStructuredErrCLI
+	result    api.VerificationResultSlug
+	failure   *api.StructuredErrCLI
 	isSubmit  bool
-	success   bool
 	finalized bool
 	clear     bool
 }

render/render.go

@@ -30,10 +30,8 @@ func (m rootModel) Init() tea.Cmd {
 func (m rootModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case messages.DoneStepMsg:
+		m.result = msg.Result
 		m.failure = msg.Failure
-		if m.failure == nil && m.isSubmit {
-			m.success = true
-		}
 		m.clear = true
 		return m, tea.Quit
 
@@ -93,7 +91,7 @@ func (m rootModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 	}
 }
 
-func StartRenderer(data api.CLIData, isSubmit bool, ch chan tea.Msg) func(*api.VerificationResultStructuredErrCLI) {
+func StartRenderer(data api.CLIData, isSubmit bool, ch chan tea.Msg) func(api.LessonSubmissionEvent) {
 	var wg sync.WaitGroup
 	p := tea.NewProgram(initModel(isSubmit), tea.WithoutSignalHandler())
 
@@ -117,8 +115,11 @@ func StartRenderer(data api.CLIData, isSubmit bool, ch chan tea.Msg) func(*api.V
 		}
 	}()
 
-	return func(failure *api.VerificationResultStructuredErrCLI) {
-		ch <- messages.DoneStepMsg{Failure: failure}
+	return func(submissionEvent api.LessonSubmissionEvent) {
+		ch <- messages.DoneStepMsg{
+			Result:  submissionEvent.ResultSlug,
+			Failure: submissionEvent.StructuredErrCLI,
+		}
 		wg.Wait()
 	}
 }

render/view.go

@@ -161,13 +161,20 @@ func (m rootModel) View() string {
 			str.WriteString(printHTTPRequestResult(*step.result.HTTPRequestResult))
 		}
 	}
-	if m.failure != nil {
+
+	if m.result == api.VerificationResultSlugSuccess && m.isSubmit {
+		str.WriteString("\n\n" + green.Render("All tests passed! 🎉") + "\n\n")
+		str.WriteString(green.Render("Return to your browser to continue with the next lesson.") + "\n\n")
+	} else if m.result == api.VerificationResultSlugNoop {
+		str.WriteString("\n\nTests failed! ❌")
+		str.WriteString(fmt.Sprintf("\n\nFailed Step: %v", m.failure.FailedStepIndex+1))
+		str.WriteString("\nError: " + m.failure.ErrorMessage + "\n")
+		str.WriteString("\nYou haven't passed, but you also haven't been penalized.\n\n")
+	} else if m.result == api.VerificationResultSlugFailure {
 		str.WriteString("\n\n" + red.Render("Tests failed! ❌"))
 		str.WriteString(red.Render(fmt.Sprintf("\n\nFailed Step: %v", m.failure.FailedStepIndex+1)))
 		str.WriteString(red.Render("\nError: "+m.failure.ErrorMessage) + "\n\n")
-	} else if m.success {
-		str.WriteString("\n\n" + green.Render("All tests passed! 🎉") + "\n\n")
-		str.WriteString(green.Render("Return to your browser to continue with the next lesson.") + "\n\n")
 	}
+
 	return str.String()
 }