Improve eq checks and compare_output

Author: sjtrny

stanfordkarel/karel_ascii.py

@@ -220,14 +220,34 @@ def symmetric_difference(
             f"Student: {(first.avenue, first.street)}\n"
             f"Expected: {(second.avenue, second.street)}\n\n"
         )
-    if first.world.beepers != second.world.beepers:
+
+    if first.direction != second.direction:
+        result += (
+            "Karel not facing the correct direction.\n"
+            f"Student: {first.direction}\n"
+            f"Expected: {second.direction}\n\n"
+        )
+
+    if first.world.get_beepers() != second.world.get_beepers():
         extra_a, extra_b = symmetric_difference(
-            first.world.beepers, second.world.beepers
+            first.world.get_beepers(), second.world.get_beepers()
         )
         result += (
             "Beepers do not match: "
             "(Only beepers that appear in one world but not the other are listed)\n"
             f"Student: {extra_a}\n"
             f"Expected: {extra_b}\n\n"
         )
+
+    if first.world.get_colors() != second.world.get_colors():
+        extra_a, extra_b = symmetric_difference(
+            first.world.get_colors(), second.world.get_colors()
+        )
+        result += (
+            "Colors do not match: "
+            "(Only colors that appear in one world but not the other are listed)\n"
+            f"Student: {extra_a}\n"
+            f"Expected: {extra_b}\n\n"
+        )
+
     return result

stanfordkarel/karel_world.py

@@ -116,14 +116,36 @@ def __init__(self, world_file: str) -> None:
         # Save initial beeper state to enable world reset
         self.init_beepers = copy.deepcopy(self.beepers)
 
+    def get_beepers(self) -> dict[tuple[int, int], int]:
+        """
+        Return a beeper dictionary, which is free of any 0 count beepers that
+        occur as a side effect of calls such as `beepers_present`.
+        """
+        beepers: dict[tuple[int, int], int] = collections.defaultdict(int)
+        for (x, y), count in sorted(self.beepers.items()):
+            if count != 0:
+                beepers[(x, y)] = count
+        return beepers
+
+    def get_colors(self) -> dict[tuple[int, int], str]:
+        """
+        Return a color dictionary, which is free of any blank '' colors that
+        occur as a side effect of calls such as `corner_color_is`.
+        """
+        colors: dict[tuple[int, int], str] = collections.defaultdict(str)
+        for (x, y), color in sorted(self.corner_colors.items()):
+            if color != "":
+                colors[(x, y)] = color
+        return colors
+
     def __eq__(self, other: object) -> bool:
         if isinstance(other, KarelWorld):
             return (
-                self.beepers == other.beepers
-                and self.walls == other.walls
-                and self.num_streets == other.num_streets
+                self.num_streets == other.num_streets
                 and self.num_avenues == other.num_avenues
-                and self.corner_colors == other.corner_colors
+                and self.walls == other.walls
+                and self.get_beepers() == other.get_beepers()
+                and self.get_colors() == other.get_colors()
             )
         return NotImplemented
 

tests/programs/indent_error.txt tests/exception_programs/indent_error.txt

@@ -26,7 +26,9 @@
 
 @pytest.mark.parametrize(("code_file", "expected_error"), TEST_CASES)
 def test_exceptions(tmp_path: Path, code_file: str, expected_error: str) -> None:
-    txt_file_contents = Path(f"tests/programs/{code_file}").read_text(encoding="utf-8")
+    txt_file_contents = Path(f"tests/exception_programs/{code_file}").read_text(
+        encoding="utf-8"
+    )
     py_path = (tmp_path / code_file).with_suffix(".py")
     py_path.write_text(txt_file_contents)
     execute_karel_code(
@@ -39,7 +41,7 @@ def test_file_coverage() -> None:
     tested_files = {filepath for filepath, _ in TEST_CASES}
     test_programs = {
         filepath.name
-        for filepath in Path("tests/programs").glob("*.txt")
+        for filepath in Path("tests/exception_programs").glob("*.txt")
         if filepath.name not in IGNORED_FILES
     }
     untested_files = tested_files ^ test_programs

tests/programs/missing_main.txt tests/exception_programs/missing_main.txt

@@ -1,5 +1,6 @@
 from pathlib import Path
 
+from stanfordkarel.karel_application import StudentCode
 from stanfordkarel.karel_program import KarelProgram
 
 STONE_MASON_ASCII_OUTPUT = (
@@ -87,3 +88,48 @@ def test_save_to_file(tmp_path: Path) -> None:
         )
 
         assert output_file.read_text() == "\n".join(expected) + "\n"
+
+    @staticmethod
+    def test_empty_beepers(tmp_path: Path) -> None:
+        code_file = "empty_beeper.txt"
+        txt_file_contents = Path(f"tests/programs/{code_file}").read_text(
+            encoding="utf-8"
+        )
+        py_path = (tmp_path / code_file).with_suffix(".py")
+        py_path.write_text(txt_file_contents)
+
+        test_program = KarelProgram("1x1")
+
+        test_code = StudentCode(py_path)
+        test_code.inject_namespace(test_program)
+        test_code.main()
+
+        ref_program = KarelProgram("1x1")
+
+        assert ref_program.world.get_beepers() == test_program.world.get_beepers()
+
+    @staticmethod
+    def test_empty_colors(tmp_path: Path) -> None:
+        code_file = "empty_color.txt"
+        txt_file_contents = Path(f"tests/programs/{code_file}").read_text(
+            encoding="utf-8"
+        )
+        py_path = (tmp_path / code_file).with_suffix(".py")
+        py_path.write_text(txt_file_contents)
+
+        test_program = KarelProgram("1x1")
+
+        test_code = StudentCode(py_path)
+        test_code.inject_namespace(test_program)
+        test_code.main()
+
+        ref_program = KarelProgram("1x1")
+
+        assert ref_program.world.get_beepers() == test_program.world.get_beepers()
+
+    @staticmethod
+    def test_equal_worlds() -> None:
+        test_program = KarelProgram("1x1")
+        ref_program = KarelProgram("1x1")
+
+        assert ref_program.world == test_program.world

tests/programs/name_error.txt tests/exception_programs/name_error.txt

@@ -0,0 +1,10 @@
+from stanfordkarel import *
+
+
+def main():
+    if corner_color_is(PINK):
+        turn_left()
+
+
+if __name__ == "__main__":
+    run_karel_program()

tests/programs/syntax_error.txt tests/exception_programs/syntax_error.txt

@@ -0,0 +1,10 @@
+from stanfordkarel import *
+
+
+def main():
+    if beepers_present():
+        turn_left()
+
+
+if __name__ == "__main__":
+    run_karel_program()