From 84361597cc2234fca07a754331f398fec81a2c5d Mon Sep 17 00:00:00 2001
From: John Breaux <j@soft.fish>
Date: Mon, 27 Mar 2023 21:31:54 -0500
Subject: [PATCH] tests: Clean up integration tests

---
 tests/chip8_test_suite.rs                     | 103 ++++++++++++++++++
 .../64.bin => chip8-test-suite/IBM.bin}       | Bin
 .../flags.bin                                 | Bin
 .../quirks.bin                                | Bin
 .../splash.bin                                | Bin
 tests/tests.rs                                |  92 ----------------
 6 files changed, 103 insertions(+), 92 deletions(-)
 create mode 100644 tests/chip8_test_suite.rs
 rename tests/screens/{chip8-test-suite.ch8/64.bin => chip8-test-suite/IBM.bin} (100%)
 rename tests/screens/{chip8-test-suite.ch8 => chip8-test-suite}/flags.bin (100%)
 rename tests/screens/{chip8-test-suite.ch8 => chip8-test-suite}/quirks.bin (100%)
 rename tests/screens/{chip8-test-suite.ch8 => chip8-test-suite}/splash.bin (100%)
 delete mode 100644 tests/tests.rs

diff --git a/tests/chip8_test_suite.rs b/tests/chip8_test_suite.rs
new file mode 100644
index 0000000..efb15bc
--- /dev/null
+++ b/tests/chip8_test_suite.rs
@@ -0,0 +1,103 @@
+//! These are a series of interpreter tests using Timendus's incredible test suite
+
+pub use chirp::prelude::*;
+
+fn setup_environment() -> (CPU, Bus) {
+    let mut cpu = CPU::default();
+    cpu.flags = ControlFlags {
+        debug: true,
+        pause: false,
+        monotonic: Some(8),
+        ..Default::default()
+    };
+    (
+        cpu,
+        bus! {
+            // Load the charset into ROM
+            Charset [0x0050..0x00A0] = include_bytes!("../src/mem/charset.bin"),
+            // Load the ROM file into RAM
+            Program [0x0200..0x1000] = include_bytes!("../chip-8/BC_test.ch8"),
+            // Create a screen
+            Screen  [0x0F00..0x1000] = include_bytes!("../chip-8/IBM Logo.ch8"),
+        },
+    )
+}
+
+struct SuiteTest {
+    program: &'static [u8],
+    screen: &'static [u8],
+}
+
+fn run_screentest(test: SuiteTest, mut cpu: CPU, mut bus: Bus) {
+    // Load the test program
+    bus = bus.load_region(Program, test.program);
+    // The test suite always initiates a keypause on test completion
+    while !cpu.flags.keypause {
+        cpu.multistep(&mut bus, 8);
+    }
+    // Compare the screen to the reference screen buffer
+    bus.print_screen().unwrap();
+    bus! {crate::bus::Region::Screen [0..256] = test.screen}
+        .print_screen()
+        .unwrap();
+    assert_eq!(bus.get_region(Screen).unwrap(), test.screen);
+}
+
+#[test]
+fn splash_screen() {
+    let (mut c, b) = setup_environment();
+    c.flags.quirks = true.into();
+    run_screentest(
+        SuiteTest {
+            program: include_bytes!("chip8-test-suite/bin/chip8-test-suite.ch8"),
+            screen: include_bytes!("screens/chip8-test-suite/splash.bin"),
+        },
+        c,
+        b,
+    )
+}
+
+#[test]
+fn ibm_logo() {
+    let (mut c, mut b) = setup_environment();
+    c.flags.quirks = true.into();
+    b.write(0x1ffu16, 1u8);
+    run_screentest(
+        SuiteTest {
+            program: include_bytes!("chip8-test-suite/bin/chip8-test-suite.ch8"),
+            screen: include_bytes!("screens/chip8-test-suite/IBM.bin"),
+        },
+        c,
+        b,
+    )
+}
+
+#[test]
+fn flags_test() {
+    let (mut c, mut b) = setup_environment();
+    c.flags.quirks = true.into();
+    b.write(0x1ffu16, 3u8);
+    run_screentest(
+        SuiteTest {
+            program: include_bytes!("chip8-test-suite/bin/chip8-test-suite.ch8"),
+            screen: include_bytes!("screens/chip8-test-suite/flags.bin"),
+        },
+        c,
+        b,
+    )
+}
+
+#[test]
+fn quirks_test() {
+    let (mut c, mut b) = setup_environment();
+    c.flags.quirks = true.into();
+    b.write(0x1feu16, 0x0104u16);
+    run_screentest(
+        SuiteTest {
+            program: include_bytes!("chip8-test-suite/bin/chip8-test-suite.ch8"),
+            screen: include_bytes!("screens/chip8-test-suite/quirks.bin"),
+        },
+        c,
+        b,
+    )
+}
diff --git a/tests/screens/chip8-test-suite.ch8/64.bin b/tests/screens/chip8-test-suite/IBM.bin
similarity index 100%
rename from tests/screens/chip8-test-suite.ch8/64.bin
rename to tests/screens/chip8-test-suite/IBM.bin
diff --git a/tests/screens/chip8-test-suite.ch8/flags.bin b/tests/screens/chip8-test-suite/flags.bin
similarity index 100%
rename from tests/screens/chip8-test-suite.ch8/flags.bin
rename to tests/screens/chip8-test-suite/flags.bin
diff --git a/tests/screens/chip8-test-suite.ch8/quirks.bin b/tests/screens/chip8-test-suite/quirks.bin
similarity index 100%
rename from tests/screens/chip8-test-suite.ch8/quirks.bin
rename to tests/screens/chip8-test-suite/quirks.bin
diff --git a/tests/screens/chip8-test-suite.ch8/splash.bin b/tests/screens/chip8-test-suite/splash.bin
similarity index 100%
rename from tests/screens/chip8-test-suite.ch8/splash.bin
rename to tests/screens/chip8-test-suite/splash.bin
diff --git a/tests/tests.rs b/tests/tests.rs
deleted file mode 100644
index ef1ca87..0000000
--- a/tests/tests.rs
+++ /dev/null
@@ -1,92 +0,0 @@
-pub use chirp::prelude::*;
-
-fn setup_environment() -> (CPU, Bus) {
-    let mut cpu = CPU::default();
-    cpu.flags = ControlFlags {
-        debug: true,
-        pause: false,
-        monotonic: Some(8),
-        ..Default::default()
-    };
-    (
-        cpu,
-        bus! {
-            // Load the charset into ROM
-            Charset [0x0050..0x00A0] = include_bytes!("../src/mem/charset.bin"),
-            // Load the ROM file into RAM
-            Program [0x0200..0x1000] = include_bytes!("../chip-8/BC_test.ch8"),
-            // Create a screen
-            Screen  [0x0F00..0x1000] = include_bytes!("../chip-8/IBM Logo.ch8"),
-        },
-    )
-}
-
-/// These are a series of interpreter tests using Timendus's incredible test suite
-/// TODO: These are technically integration tests, and should be moved to src/tests
-mod chip8_test_suite {
-    use super::*;
-
-    struct SuiteTest {
-        program: &'static [u8],
-        screen: &'static [u8],
-    }
-
-    fn run_screentest(test: SuiteTest, mut cpu: CPU, mut bus: Bus) {
-        // Load the test program
-        bus = bus.load_region(Program, test.program);
-        // The test suite always initiates a keypause on test completion
-        while !cpu.flags.keypause {
-            cpu.multistep(&mut bus, 8);
-        }
-        // Compare the screen to the reference screen buffer
-        bus.print_screen().unwrap();
-        bus! {crate::bus::Region::Screen [0..256] = test.screen}
-            .print_screen()
-            .unwrap();
-        assert_eq!(bus.get_region(Screen).unwrap(), test.screen);
-    }
-
-    #[test]
-    fn splash_screen() {
-        let (mut c, b) = setup_environment();
-        c.flags.quirks = true.into();
-        run_screentest(
-            SuiteTest {
-                program: include_bytes!("chip8-test-suite/bin/chip8-test-suite.ch8"),
-                screen: include_bytes!("screens/chip8-test-suite.ch8/splash.bin"),
-            },
-            c,
-            b,
-        )
-    }
-
-    #[test]
-    fn flags_test() {
-        let (mut c, mut b) = setup_environment();
-        c.flags.quirks = true.into();
-        b.write(0x1ffu16, 3u8);
-        run_screentest(
-            SuiteTest {
-                program: include_bytes!("chip8-test-suite/bin/chip8-test-suite.ch8"),
-                screen: include_bytes!("screens/chip8-test-suite.ch8/flags.bin"),
-            },
-            c,
-            b,
-        )
-    }
-
-    #[test]
-    fn quirks_test() {
-        let (mut c, mut b) = setup_environment();
-        c.flags.quirks = true.into();
-        b.write(0x1feu16, 0x0104u16);
-        run_screentest(
-            SuiteTest {
-                program: include_bytes!("chip8-test-suite/bin/chip8-test-suite.ch8"),
-                screen: include_bytes!("screens/chip8-test-suite.ch8/quirks.bin"),
-            },
-            c,
-            b,
-        )
-    }
-}