Enhance virtual terminal and assertion handling features

internal/assertion_collection/assertion_collection.go

@@ -23,7 +23,7 @@ func (c *AssertionCollection) AddAssertion(assertion assertions.Assertion) {
 	c.Assertions = append(c.Assertions, assertion)
 }
 
-func (c *AssertionCollection) RunWithPromptAssertion(screenState [][]string) error {
+func (c *AssertionCollection) RunWithPromptAssertion(screenState [][]string) *assertions.AssertionError {
 	return c.runWithExtraAssertions(screenState, []assertions.Assertion{
 		assertions.PromptAssertion{ExpectedPrompt: "$ "},
 	})
@@ -33,7 +33,8 @@ func (c *AssertionCollection) RunWithoutPromptAssertion(screenState [][]string)
 	return c.runWithExtraAssertions(screenState, nil)
 }
 
-func (c *AssertionCollection) runWithExtraAssertions(screenState [][]string, extraAssertions []assertions.Assertion) error {
+// ToDo: Remove all debug logs
+func (c *AssertionCollection) runWithExtraAssertions(screenState [][]string, extraAssertions []assertions.Assertion) *assertions.AssertionError {
 	allAssertions := append(c.Assertions, extraAssertions...)
 	currentRowIndex := 0
 
@@ -42,6 +43,14 @@ func (c *AssertionCollection) runWithExtraAssertions(screenState [][]string, ext
 	}
 
 	for _, assertion := range allAssertions {
+		if len(screenState) == 0 {
+			panic("CodeCrafters internal error: expected screen to have at least one row, but it was empty")
+		}
+
+		if currentRowIndex >= len(screenState) {
+			panic("CodeCrafters internal error: startRowIndex is larger than screenState rows")
+		}
+
 		processedRowCount, err := assertion.Run(screenState, currentRowIndex)
 		if err != nil {
 			if ShouldPrintDebugLogs {

internal/assertions/assertion_error.go

@@ -8,4 +8,9 @@
 
 func (e AssertionError) Error() string {
 	return `CodeCrafters Internal Error: AssertionError#Error() should not be called`
-}
+}
+
+// ToDo: Review and possibly remove
+func (e AssertionError) ErrorMessage() string {
+	return e.Message
+}

internal/assertions/prompt_assertion.go

@@ -21,15 +21,6 @@ func (t PromptAssertion) Run(screenState [][]string, startRowIndex int) (process
 	// We don't want to count the processed prompt as a complete row
 	processedRowCount = 0
 
-	// TODO: Move these to assertion collection
-	if len(screenState) == 0 {
-		panic("CodeCrafters internal error: Expected screen state to have at least one row")
-	}
-
-	if startRowIndex >= len(screenState) {
-		panic("CodeCrafters internal error: startRowIndex is larger than screenState rows")
-	}
-
 	rawRow := screenState[startRowIndex] // Could be nil?
 	cleanedRow := utils.BuildCleanedRow(rawRow)
 

internal/assertions/single_line_assertion.go

@@ -21,15 +21,6 @@ func (a SingleLineAssertion) Inspect() string {
 }
 
 func (a SingleLineAssertion) Run(screenState [][]string, startRowIndex int) (processedRowCount int, err *AssertionError) {
-	// TODO: Move these to assertion collection
-	if len(screenState) == 0 {
-		panic("CodeCrafters internal error: expected screen to have at least one row, but it was empty")
-	}
-
-	if startRowIndex >= len(screenState) {
-		panic("CodeCrafters internal error: startRowIndex is larger than screenState rows")
-	}
-
 	if a.ExpectedOutput == "" {
 		panic("CodeCrafters Internal Error: ExpectedOutput must be provided")
 	}
@@ -44,12 +35,11 @@ func (a SingleLineAssertion) Run(screenState [][]string, startRowIndex int) (pro
 	}
 
 	if cleanedRow != a.ExpectedOutput {
-		// TODO: Return colored error message when constructing AssertionError
-		// detailedErrorMessage := BuildColoredErrorMessage(t.expectedPatternExplanation, cleanedRow)
+		detailedErrorMessage := utils.BuildColoredErrorMessage(a.ExpectedOutput, cleanedRow)
 		return 0, &AssertionError{
 			StartRowIndex: startRowIndex,
 			ErrorRowIndex: startRowIndex,
-			Message:       fmt.Sprintf("Expected %q, got %q", a.ExpectedOutput, cleanedRow),
+			Message:       "Output does not match expected value.\n" + detailedErrorMessage,
 		}
 	} else {
 		return 1, nil

internal/logged_shell_asserter/logged_shell_asserter.go

@@ -35,13 +35,17 @@ func (a *LoggedShellAsserter) AddAssertion(assertion assertions.Assertion) {
 }
 
 func (a *LoggedShellAsserter) Assert() error {
-	assertFn := func() error {
+	assertFn := func() *assertions.AssertionError {
 		return a.AssertionCollection.RunWithPromptAssertion(a.Shell.GetScreenState())
 	}
 
-	if readErr := a.Shell.ReadUntil(utils.AsBool(assertFn)); readErr != nil {
+	conditionFn := func() bool {
+		return assertFn() == nil
+	}
+
+	if readErr := a.Shell.ReadUntil(conditionFn); readErr != nil {
 		if assertionErr := assertFn(); assertionErr != nil {
-			a.logAssertionError(assertionErr)
+			a.logAssertionError(*assertionErr)
 			// TODO: Figure out remaining output in SUCCESS scenario
 			// asserter.LogRemainingOutput()
 
@@ -77,13 +81,23 @@ func (a *LoggedShellAsserter) onAssertionSuccess(startRowIndex int, processedRow
 	a.lastLoggedRowIndex += processedRowCount
 }
 
-func (a *LoggedShellAsserter) logAssertionError(err error) {
-	// TODO: Log all shell output remaining
+func (a *LoggedShellAsserter) logAssertionError(err assertions.AssertionError) {
+	a.logRows(a.lastLoggedRowIndex, err.ErrorRowIndex)
+	l := a.Shell.GetLogger()
+	l.Errorf("%s", err.Message)
+	a.logRows(err.ErrorRowIndex, len(a.Shell.GetScreenState()))
 }
 
 func (a *LoggedShellAsserter) LogRemainingOutput() {
+	// if we ever call this, before logging anything
+	// a.lastLoggedRowIndex would be -1, we want it to be 0
+	startRowIndex := max(0, a.lastLoggedRowIndex)
 	endRowIndex := len(a.Shell.GetScreenState())
-	for i := a.lastLoggedRowIndex + 1; i < endRowIndex; i++ {
+	a.logRows(startRowIndex, endRowIndex)
+}
+
+func (a *LoggedShellAsserter) logRows(startRowIndex int, endRowIndex int) {
+	for i := startRowIndex; i < endRowIndex; i++ {
 		rawRow := a.Shell.GetScreenState()[i]
 		cleanedRow := utils.BuildCleanedRow(rawRow)
 		if len(cleanedRow) > 0 {

internal/shell_executable/shell_executable.go

@@ -185,3 +185,8 @@
 
 	return readerErr
 }
+
+// ToDo: Review and possibly remove
+func (b *ShellExecutable) GetLogger() *logger.Logger {
+	return b.logger
+}

internal/shell_executable/virtual_terminal.go

@@ -5,9 +5,9 @@
 	"github.com/gookit/color"
 )
 
-const VT_SENTINEL_CHARACTER = "."
+const VT_SENTINEL_CHARACTER = "★"
 
 // TODO: See if we can remove this wrapper entirely, and only add helpers to fetch rows/data from the vterm instance directly
 type VirtualTerminal struct {
 	vt   *vterm.VTerm
 	rows int
@@ -17,9 +17,11 @@
 func NewStandardVT() *VirtualTerminal {
 	// TODO: Check if this affects performance
 	// This affects performance majorly, improve all functions operating on this
-	return NewCustomVT(100, 100)
+	return NewCustomVT(100, 120)
 }
 
+// ToDo: Add check if last line gets written to and panic then
+
 func NewCustomVT(rows, cols int) *VirtualTerminal {
 	return &VirtualTerminal{
 		vt:   vterm.New(rows, cols),
@@ -39,7 +41,7 @@
 	return vt.vt.Write(p)
 }
 
 // TODO: What if there are tabs, will we have SENTINEL_CHAR in the middle of a row?
 func (vt *VirtualTerminal) GetScreenState(retainColors bool) [][]string {
 	screenState := make([][]string, vt.rows)
 	for i := 0; i < vt.rows; i++ {

internal/stage1.go

@@ -23,12 +23,7 @@ func testPrompt(stageHarness *test_case_harness.TestCaseHarness) error {
 	// ensures that we never accept starter code that wouldn't work in those stages.
 	shell.Setenv("HOME", randomDir)
 
-	if err := shell.Start(); err != nil {
-		return err
-	}
-
-	// First prompt assertion
-	if err := asserter.Assert(); err != nil {
+	if err := startShellAndAssertPrompt(asserter, shell); err != nil {
 		return err
 	}
 

internal/stage2.go

@@ -15,12 +15,7 @@ func testMissingCommand(stageHarness *test_case_harness.TestCaseHarness) error {
 	shell := shell_executable.NewShellExecutable(stageHarness)
 	asserter := logged_shell_asserter.NewLoggedShellAsserter(shell)
 
-	if err := shell.Start(); err != nil {
-		return err
-	}
-
-	// First prompt assertion
-	if err := asserter.Assert(); err != nil {
+	if err := startShellAndAssertPrompt(asserter, shell); err != nil {
 		return err
 	}
 
@@ -40,6 +35,5 @@ func testMissingCommand(stageHarness *test_case_harness.TestCaseHarness) error {
 		return err
 	}
 
-	asserter.LogRemainingOutput()
-	return nil
+	return logAndQuit(asserter, nil)
 }

internal/stage3.go

@@ -19,12 +19,7 @@ func testREPL(stageHarness *test_case_harness.TestCaseHarness) error {
 
 	numberOfCommands := random.RandomInt(3, 6)
 
-	if err := shell.Start(); err != nil {
-		return err
-	}
-
-	// First prompt assertion
-	if err := asserter.Assert(); err != nil {
+	if err := startShellAndAssertPrompt(asserter, shell); err != nil {
 		return err
 	}
 
@@ -47,6 +42,5 @@ func testREPL(stageHarness *test_case_harness.TestCaseHarness) error {
 	}
 
 	// Assert() already makes sure that the prompt is present in the last row
-	asserter.LogRemainingOutput()
-	return nil
+	return logAndQuit(asserter, nil)
 }

internal/stage4.go

@@ -19,12 +19,7 @@ func testExit(stageHarness *test_case_harness.TestCaseHarness) error {
 	shell := shell_executable.NewShellExecutable(stageHarness)
 	asserter := logged_shell_asserter.NewLoggedShellAsserter(shell)
 
-	if err := shell.Start(); err != nil {
-		return err
-	}
-
-	// First prompt assertion
-	if err := asserter.Assert(); err != nil {
+	if err := startShellAndAssertPrompt(asserter, shell); err != nil {
 		return err
 	}
 
@@ -83,5 +78,5 @@ func testExit(stageHarness *test_case_harness.TestCaseHarness) error {
 
 	logger.Successf("✓ No output after exit command")
 
-	return nil
+	return logAndQuit(asserter, nil)
 }

internal/stage5.go

@@ -18,12 +18,7 @@ func testEcho(stageHarness *test_case_harness.TestCaseHarness) error {
 
 	numberOfCommands := random.RandomInt(2, 4)
 
-	if err := shell.Start(); err != nil {
-		return err
-	}
-
-	// First prompt assertion
-	if err := asserter.Assert(); err != nil {
+	if err := startShellAndAssertPrompt(asserter, shell); err != nil {
 		return err
 	}
 
@@ -42,6 +37,5 @@ func testEcho(stageHarness *test_case_harness.TestCaseHarness) error {
 		}
 	}
 
-	asserter.LogRemainingOutput()
-	return nil
+	return logAndQuit(asserter, nil)
 }

internal/stage6.go

@@ -17,12 +17,7 @@ func testType1(stageHarness *test_case_harness.TestCaseHarness) error {
 
 	builtIns := []string{"echo", "exit", "type"}
 
-	if err := shell.Start(); err != nil {
-		return err
-	}
-
-	// First prompt assertion
-	if err := asserter.Assert(); err != nil {
+	if err := startShellAndAssertPrompt(asserter, shell); err != nil {
 		return err
 	}
 
@@ -56,6 +51,5 @@ func testType1(stageHarness *test_case_harness.TestCaseHarness) error {
 		}
 	}
 
-	asserter.LogRemainingOutput()
-	return nil
+	return logAndQuit(asserter, nil)
 }

internal/stage7.go

@@ -34,12 +34,7 @@ func testType2(stageHarness *test_case_harness.TestCaseHarness) error {
 		return err
 	}
 
-	if err := shell.Start(); err != nil {
-		return err
-	}
-
-	// First prompt assertion
-	if err := asserter.Assert(); err != nil {
+	if err := startShellAndAssertPrompt(asserter, shell); err != nil {
 		return err
 	}
 
@@ -86,6 +81,5 @@ func testType2(stageHarness *test_case_harness.TestCaseHarness) error {
 		}
 	}
 
-	asserter.LogRemainingOutput()
-	return nil
+	return logAndQuit(asserter, nil)
 }

internal/stage8.go

@@ -27,12 +27,7 @@ func testRun(stageHarness *test_case_harness.TestCaseHarness) error {
 	currentPath := os.Getenv("PATH")
 	shell.Setenv("PATH", fmt.Sprintf("%s:%s", randomDir, currentPath))
 
-	if err := shell.Start(); err != nil {
-		return err
-	}
-
-	// First prompt assertion
-	if err := asserter.Assert(); err != nil {
+	if err := startShellAndAssertPrompt(asserter, shell); err != nil {
 		return err
 	}
 
@@ -51,14 +46,13 @@ func testRun(stageHarness *test_case_harness.TestCaseHarness) error {
 
 	testCase := test_cases.CommandResponseTestCase{
 		Command:          strings.Join(command, " "),
-		ExpectedOutput:   fmt.Sprintf("Hello %s! The secret code is %s", randomName, randomCode),
+		ExpectedOutput:   fmt.Sprintf("Hello %s! The secret code is %s.", randomName, randomCode),
 		FallbackPatterns: nil,
 		SuccessMessage:   "Received expected response",
 	}
 	if err := testCase.Run(asserter, shell, logger); err != nil {
 		return err
 	}
 
-	asserter.LogRemainingOutput()
-	return nil
+	return logAndQuit(asserter, nil)
 }

internal/stages_test.go

@@ -33,6 +33,13 @@ func TestStages(t *testing.T) {
 			StdoutFixturePath:   "./test_helpers/fixtures/missing_command/wrong_output",
 			NormalizeOutputFunc: normalizeTesterOutput,
 		},
+		"no_command_fail": {
+			UntilStageSlug:      "cz2",
+			CodePath:            "./test_helpers/scenarios/missing_command/no_output",
+			ExpectedExitCode:    1,
+			StdoutFixturePath:   "./test_helpers/fixtures/missing_command/no_output",
+			NormalizeOutputFunc: normalizeTesterOutput,
+		},
 		"quoting_pass": {
 			StageSlugs:          []string{"ni6", "tg6", "yt5", "le5", "gu3", "qj0"},
 			CodePath:            "./test_helpers/bash",