no penalty on fail

Author: skovranek

checks/runner.go

@@ -111,13 +111,27 @@ 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, result api.VerificationResult, ch chan tea.Msg) {
+	failure := result.StructuredErrCLI
+	noop := result.StructuredNoopCLI
+
+	var failedStepIndex int
+	var failedTestIndex int
+	if failure != nil {
+		failedStepIndex = failure.FailedStepIndex
+		failedTestIndex = failure.FailedTestIndex
+	}
+	if noop != nil {
+		failedStepIndex = noop.FailedStepIndex
+		failedTestIndex = noop.FailedTestIndex
+	}
+
 	for i, step := range cliData.Steps {
 		stepPass := true
 		isFailedStep := false
-		if failure != nil {
-			stepPass = i < failure.FailedStepIndex
-			isFailedStep = i == failure.FailedStepIndex
+		if failure != nil || noop != nil {
+			stepPass = i < failedStepIndex
+			isFailedStep = i == failedStepIndex
 		}
 
 		ch <- messages.ResolveStepMsg{
@@ -127,11 +141,11 @@ func ApplySubmissionResults(cliData api.CLIData, failure *api.VerificationResult
 
 		if step.CLICommand != nil {
 			for j := range step.CLICommand.Tests {
-				if isFailedStep && j > failure.FailedTestIndex {
+				if isFailedStep && j > failedTestIndex {
 					break
 				}
 
-				testPass := stepPass || (isFailedStep && j < failure.FailedTestIndex)
+				testPass := stepPass || (isFailedStep && j < failedTestIndex)
 				ch <- messages.ResolveTestMsg{
 					StepIndex: i,
 					TestIndex: j,
@@ -141,11 +155,11 @@ func ApplySubmissionResults(cliData api.CLIData, failure *api.VerificationResult
 		}
 		if step.HTTPRequest != nil {
 			for j := range step.HTTPRequest.Tests {
-				if isFailedStep && j > failure.FailedTestIndex {
+				if isFailedStep && j > failedTestIndex {
 					break
 				}
 
-				testPass := stepPass || (isFailedStep && j < failure.FailedTestIndex)
+				testPass := stepPass || (isFailedStep && j < failedTestIndex)
 				ch <- messages.ResolveTestMsg{
 					StepIndex: i,
 					TestIndex: j,

client/lessons.go

@@ -22,6 +22,7 @@ const BaseURLOverrideRequired = "override"
 
 type CLIData struct {
 	// ContainsCompleteDir bool
+	// NoPenaltyOnFail         bool
 	BaseURLDefault          string
 	Steps                   []CLIStep
 	AllowedOperatingSystems []string
@@ -189,12 +190,14 @@ type lessonSubmissionCLI struct {
 	CLIResults []CLIStepResult
 }
 
-type verificationResult struct {
-	ResultSlug string
+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
+	// for "noop" on "noPenaltyOnFail" CLI lessons
+	StructuredNoopCLI *VerificationResultStructuredErrCLI
 }
 
 type VerificationResultStructuredErrCLI struct {
@@ -203,27 +206,27 @@ type VerificationResultStructuredErrCLI struct {
 	FailedTestIndex int    `json:"FailedTestIndex"`
 }
 
-func SubmitCLILesson(uuid string, results []CLIStepResult) (*VerificationResultStructuredErrCLI, error) {
+func SubmitCLILesson(uuid string, results []CLIStepResult) (VerificationResult, error) {
 	bytes, err := json.Marshal(lessonSubmissionCLI{CLIResults: results})
 	if err != nil {
-		return nil, err
+		return VerificationResult{}, err
 	}
 	endpoint := fmt.Sprintf("/v1/lessons/%v/", uuid)
 	resp, code, err := fetchWithAuthAndPayload("POST", endpoint, bytes)
 	if err != nil {
-		return nil, err
+		return VerificationResult{}, 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 VerificationResult{}, 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 VerificationResult{}, fmt.Errorf("failed to submit CLI lesson (code %v): %s", code, string(resp))
 	}
 
-	result := verificationResult{}
+	result := VerificationResult{}
 	err = json.Unmarshal(resp, &result)
 	if err != nil {
-		return nil, err
+		return VerificationResult{}, 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)
+		submissionResults, err := api.SubmitCLILesson(lessonUUID, cliResults)
 		if err != nil {
 			return err
 		}
-		checks.ApplySubmissionResults(data, failure, ch)
-
-		finalise(failure)
+		checks.ApplySubmissionResults(data, submissionResults, ch)
+		finalise(submissionResults)
 	} else {
-		finalise(nil)
+		finalise(api.VerificationResult{})
 	}
 	return nil
 }

messages/messages.go

@@ -22,6 +22,7 @@ type ResolveTestMsg struct {
 
 type DoneStepMsg struct {
 	Failure *api.VerificationResultStructuredErrCLI
+	Noop    *api.VerificationResultStructuredErrCLI
 }
 
 type ResolveStepMsg struct {

render/models.go

@@ -25,6 +25,7 @@ type rootModel struct {
 	steps     []stepModel
 	spinner   spinner.Model
 	failure   *api.VerificationResultStructuredErrCLI
+	noop      *api.VerificationResultStructuredErrCLI
 	isSubmit  bool
 	success   bool
 	finalized bool

render/render.go

@@ -31,7 +31,8 @@ func (m rootModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case messages.DoneStepMsg:
 		m.failure = msg.Failure
-		if m.failure == nil && m.isSubmit {
+		m.noop = msg.Noop
+		if m.failure == nil && m.noop == nil && m.isSubmit {
 			m.success = true
 		}
 		m.clear = true
@@ -93,7 +94,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.VerificationResult) {
 	var wg sync.WaitGroup
 	p := tea.NewProgram(initModel(isSubmit), tea.WithoutSignalHandler())
 
@@ -117,8 +118,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(result api.VerificationResult) {
+		ch <- messages.DoneStepMsg{
+			Failure: result.StructuredErrCLI,
+			Noop:    result.StructuredNoopCLI,
+		}
 		wg.Wait()
 	}
 }

render/view.go

@@ -161,10 +161,16 @@ func (m rootModel) View() string {
 			str.WriteString(printHTTPRequestResult(*step.result.HTTPRequestResult))
 		}
 	}
+
 	if m.failure != nil {
 		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.noop != nil {
+		str.WriteString("\n\n" + red.Render("Tests failed! ❌"))
+		str.WriteString(red.Render(fmt.Sprintf("\n\nFailed Step: %v", m.noop.FailedStepIndex+1)))
+		str.WriteString(red.Render("\nError: " + m.noop.ErrorMessage + "\n"))
+		str.WriteString(red.Render("\nYou haven't passed, but you also haven't been penalized.") + "\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")