improve no penalty on fail ux in cli

Author: squashd

checks/runner.go

@@ -30,8 +30,9 @@ func CLIChecks(cliData api.CLIData, overrideBaseURL string, ch chan tea.Msg) (re
 		// This is the magic of the initial message sent before executing the test
 		if step.CLICommand != nil {
 			ch <- messages.StartStepMsg{
-				CMD:       step.CLICommand.Command,
-				TmdlQuery: step.CLICommand.StdoutFilterTmdl,
+				CMD:             step.CLICommand.Command,
+				TmdlQuery:       step.CLICommand.StdoutFilterTmdl,
+				NoPenaltyOnFail: step.NoPenaltyOnFail,
 			}
 		} else if step.HTTPRequest != nil {
 			finalBaseURL := baseURL
@@ -43,8 +44,9 @@ func CLIChecks(cliData api.CLIData, overrideBaseURL string, ch chan tea.Msg) (re
 			interpolatedURL := InterpolateVariables(fullURL, variables)
 
 			ch <- messages.StartStepMsg{
-				URL:    interpolatedURL,
-				Method: step.HTTPRequest.Request.Method,
+				URL:             interpolatedURL,
+				Method:          step.HTTPRequest.Request.Method,
+				NoPenaltyOnFail: step.NoPenaltyOnFail,
 			}
 		}
 

client/lessons.go

@@ -22,15 +22,15 @@ const BaseURLOverrideRequired = "override"
 
 type CLIData struct {
 	// ContainsCompleteDir     bool
-	// NoPenaltyOnFail         bool
 	BaseURLDefault          string
 	Steps                   []CLIStep
 	AllowedOperatingSystems []string
 }
 
 type CLIStep struct {
-	CLICommand  *CLIStepCLICommand
-	HTTPRequest *CLIStepHTTPRequest
+	CLICommand      *CLIStepCLICommand
+	HTTPRequest     *CLIStepHTTPRequest
+	NoPenaltyOnFail bool
 }
 
 type CLIStepCLICommand struct {

messages/messages.go

@@ -3,10 +3,11 @@ package messages
 import api "github.com/bootdotdev/bootdev/client"
 
 type StartStepMsg struct {
-	CMD       string
-	URL       string
-	Method    string
-	TmdlQuery *string
+	CMD             string
+	URL             string
+	Method          string
+	TmdlQuery       *string
+	NoPenaltyOnFail bool
 }
 
 type StartTestMsg struct {

render/models.go

@@ -12,12 +12,13 @@ type testModel struct {
 }
 
 type stepModel struct {
-	step       string
-	passed     *bool
-	result     *api.CLIStepResult
-	finished   bool
-	tests      []testModel
-	sleepAfter string
+	step            string
+	passed          *bool
+	result          *api.CLIStepResult
+	finished        bool
+	tests           []testModel
+	sleepAfter      string
+	noPenaltyOnFail bool
 }
 
 type rootModel struct {

render/render.go

@@ -18,6 +18,7 @@ var (
 	red       lipgloss.Style
 	magenta   lipgloss.Style
 	gray      lipgloss.Style
+	white     lipgloss.Style
 	borderBox = lipgloss.NewStyle().Border(lipgloss.RoundedBorder())
 )
 
@@ -26,6 +27,7 @@ func (m rootModel) Init() tea.Cmd {
 	red = lipgloss.NewStyle().Foreground(lipgloss.Color(viper.GetString("color.red")))
 	magenta = lipgloss.NewStyle().Foreground(lipgloss.Color(viper.GetString("color.magenta")))
 	gray = lipgloss.NewStyle().Foreground(lipgloss.Color(viper.GetString("color.gray")))
+	white = lipgloss.NewStyle().Foreground(lipgloss.Color("15"))
 	return m.spinner.Tick
 }
 
@@ -46,8 +48,9 @@ func (m rootModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 			step = fmt.Sprintf("%s %s", msg.Method, msg.URL)
 		}
 		m.steps = append(m.steps, stepModel{
-			step:  step,
-			tests: []testModel{},
+			step:            step,
+			tests:           []testModel{},
+			noPenaltyOnFail: msg.NoPenaltyOnFail,
 		})
 		return m, nil
 

render/view.go

@@ -11,7 +11,12 @@ import (
 	"github.com/charmbracelet/lipgloss"
 )
 
-func renderTestHeader(header string, spinner spinner.Model, isFinished bool, isSubmit bool, passed *bool) string {
+const safeStepIcon = "🛡︎"
+
+func renderTestHeader(header string, spinner spinner.Model, isFinished bool, isSubmit bool, passed *bool, noPenaltyOnFail bool) string {
+	if noPenaltyOnFail {
+		header = fmt.Sprintf("%s %s", header, white.Render(safeStepIcon))
+	}
 	cmdStr := renderTest(header, spinner.View(), isFinished, &isSubmit, passed)
 	box := borderBox.Render(fmt.Sprintf(" %s ", cmdStr))
 	sliced := strings.Split(box, "\n")
@@ -97,7 +102,7 @@ func (m rootModel) View() string {
 	s := m.spinner.View()
 	var str strings.Builder
 	for _, step := range m.steps {
-		str.WriteString(renderTestHeader(step.step, m.spinner, step.finished, m.isSubmit, step.passed))
+		str.WriteString(renderTestHeader(step.step, m.spinner, step.finished, m.isSubmit, step.passed, step.noPenaltyOnFail))
 		str.WriteString(renderTests(step.tests, s))
 
 		if step.sleepAfter != "" && step.finished {
@@ -152,7 +157,8 @@ func (m rootModel) View() string {
 		str.WriteString("\n\nTests failed! ❌")
 		fmt.Fprintf(&str, "\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")
+		str.WriteString("\n" + white.Render(safeStepIcon) + " This was a safe step.\n")
+		str.WriteString("You haven't passed, but you also haven't lost armor or Sharpshooter progress.\n\n")
 	} else if m.result == api.VerificationResultSlugFailure {
 		str.WriteString("\n\n" + red.Render("Tests failed! ❌"))
 		if m.failure != nil {