Merge pull request #54 from codecrafters-io/add-error-types

Refactor error logging to include expected error type

Author: ryan-gang

internal/test_cases/evaluate_test_case.go

@@ -40,12 +40,11 @@ func (t *EvaluateTestCase) Run(executable *interpreter_executable.InterpreterExe
 	if t.ExpectsError && exitCode == 0 {
 		return fmt.Errorf("CodeCrafters internal error: faulty test case, expected this test case to raise an error, but it didn't")
 	}
-
 	if !t.ExpectsError && exitCode != 0 {
 		return fmt.Errorf("CodeCrafters internal error: faulty test case, expected this test case to not raise an error, but it did")
 	}
 	if result.ExitCode != exitCode {
-		return fmt.Errorf("expected exit code %v, got %v", exitCode, result.ExitCode)
+		return fmt.Errorf("expected %v (exit code %v), got exit code %v", exitCodeToErrorTypeMapping[exitCode], exitCode, result.ExitCode)
 	}
 
 	expectedStdoutLines := []string{expectedStdout}

internal/test_cases/parse_test_case.go

@@ -46,13 +46,11 @@ func (t *ParseTestCase) Run(executable *interpreter_executable.InterpreterExecut
 	if t.ExpectsError && exitCode == 0 {
 		return fmt.Errorf("CodeCrafters internal error: faulty test case, expected this test case to raise an error, but it didn't.")
 	}
-
 	if !t.ExpectsError && exitCode != 0 {
 		return fmt.Errorf("CodeCrafters internal error: faulty test case, expected this test case to not raise an error, but it did.")
 	}
-
 	if result.ExitCode != exitCode {
-		return fmt.Errorf("expected exit code %v, got %v", exitCode, result.ExitCode)
+		return fmt.Errorf("expected %v (exit code %v), got exit code %v", exitCodeToErrorTypeMapping[exitCode], exitCode, result.ExitCode)
 	}
 
 	// We are intentionally not testing the errors lines printed to stderr

internal/test_cases/run_test_case.go

@@ -63,9 +63,9 @@ func NewRunTestCaseFromFilePath(filePath string) RunTestCase {
 		panic(fmt.Sprintf("CodeCrafters Internal Error: %s has malformed frontmatter: missing expected_error_type field", filePath))
 	}
 
-	if !(frontMatter.ExpectedErrorType == "none" ||
-		frontMatter.ExpectedErrorType == "compile" ||
-		frontMatter.ExpectedErrorType == "runtime") {
+	if frontMatter.ExpectedErrorType != "none" &&
+		frontMatter.ExpectedErrorType != "compile" &&
+		frontMatter.ExpectedErrorType != "runtime" {
 		panic(fmt.Sprintf("CodeCrafters Internal Error: %s has malformed frontmatter field: expected_error_type shouldn't be %s", filePath, frontMatter.ExpectedErrorType))
 	}
 
@@ -100,9 +100,8 @@ func (t *RunTestCase) Run(executable *interpreter_executable.InterpreterExecutab
 	if t.ExpectedExitCode != ourLoxExitCode {
 		return fmt.Errorf("CodeCrafters internal error: faulty test case, expected %d exit code, our lox returned %d", t.ExpectedExitCode, ourLoxExitCode)
 	}
-
 	if result.ExitCode != t.ExpectedExitCode {
-		return fmt.Errorf("expected exit code %v, got %v", t.ExpectedExitCode, result.ExitCode)
+		return fmt.Errorf("expected %v (exit code %v), got exit code %v", exitCodeToErrorTypeMapping[t.ExpectedExitCode], t.ExpectedExitCode, result.ExitCode)
 	}
 
 	if t.OutputAssertion == nil {

internal/test_cases/tokenize_test_case.go

@@ -43,13 +43,12 @@ func (t *TokenizeTestCase) Run(executable *interpreter_executable.InterpreterExe
 	if t.ExpectsError && exitCode == 0 {
 		return fmt.Errorf("CodeCrafters internal error: faulty test case, expected this test case to raise an error, but it didn't")
 	}
-
 	if !t.ExpectsError && exitCode != 0 {
 		return fmt.Errorf("CodeCrafters internal error: faulty test case, expected this test case to not raise an error, but it did")
 	}
 
 	if result.ExitCode != exitCode {
-		return fmt.Errorf("expected exit code %v, got %v", exitCode, result.ExitCode)
+		return fmt.Errorf("expected %v (exit code %v), got exit code %v", exitCodeToErrorTypeMapping[exitCode], exitCode, result.ExitCode)
 	}
 
 	if len(expectedStderr) > 0 {

internal/test_cases/utils.go

@@ -52,3 +52,9 @@ func logReadableFileContents(logger *logger.Logger, fileContents string) {
 		logger.Plainf(color.YellowString("[test.lox]") + " " + line)
 	}
 }
+
+var exitCodeToErrorTypeMapping = map[int]string{
+	0:  "no error",
+	65: "compile error",
+	70: "runtime error",
+}