Tests: Add helpers for qualifying type of repaint

Assuming the screen has been splatted via "DHRDarkness", computing
the amount restored by a subsequent repaint is possible, and this
can remove the burden of manually assessing the change.

Author: inexorabletash

tests/date_and_time.lua

@@ -15,7 +15,8 @@ test.Step(
     a2d.OAShortcut("2") -- 24-hour
     apple2.DHRDarkness()
     a2d.DialogOK()
-    test.Snap("verify full repaint and 24-hour format")
+    test.ExpectEquals(a2d.RepaintType(), "full", "repaint", {snap=true})
+    test.Snap("verify 24-hour format shown")
     a2d.CloseAllWindows()
     a2d.InvokeMenuItem(a2d.STARTUP_MENU, 1) -- slot 7
     a2d.WaitForRestart()
@@ -88,11 +89,12 @@ test.Step(
     test.Snap("verify dialog date matches packaged file dates")
     apple2.DHRDarkness()
     a2d.DialogOK()
-    test.Snap("verify full repaint and dates now Today")
+    test.ExpectEquals(a2d.RepaintType(), "full", "repaint", {snap=true})
+    test.Snap("verify dates now Today")
     a2d.SelectAndOpen("DATE.AND.TIME")
     apple2.DHRDarkness()
     a2d.DialogOK()
-    test.Snap("verify no full repaint")
+    test.ExpectEquals(a2d.RepaintType(), "minimal", "repaint", {snap=true})
     a2d.InvokeMenuItem(a2d.STARTUP_MENU, 1) -- slot 7
     a2d.WaitForRestart()
 end)
@@ -337,5 +339,6 @@ test.Step(
     apple2.UpArrowKey()
     apple2.DHRDarkness()
     a2d.DialogOK()
-    test.Snap("verify full repaint and Today date")
+    test.ExpectEquals(a2d.RepaintType(), "full", "repaint", {snap=true})
+    test.Snap("verify bottom date shows Today")
 end)

tests/desk_accessories.lua

@@ -8,7 +8,7 @@ test.Step(
     a2d.CloseWindow()
 end)
 
-function MoveDoesntRepaintTest(name, path, x, y)
+function MoveDoesntRepaintTest(name, path, x, y, opt_threshold)
   test.Step(
     name .. " doesn't repaint on non-move",
     function()
@@ -21,10 +21,16 @@ function MoveDoesntRepaintTest(name, path, x, y)
           emu.wait(2/60)
           m.ButtonDown()
           emu.wait(10/60)
-          test.Snap("verify drag highlight")
           m.ButtonUp()
       end)
-      test.Snap("verify no repaint")
+
+      if opt_threshold then
+        -- Needed for Joystick, as MouseKeys tickles the buttons
+        -- Needed for Bounce as the animation continues
+        test.ExpectLessThan(a2d.RepaintFraction(), opt_threshold, "repaint")
+      else
+        test.ExpectEquals(a2d.RepaintType(), "none", "repaint", {snap=true})
+      end
       a2d.CloseWindow()
       a2d.CloseAllWindows()
       a2d.InvokeMenuItem(a2d.STARTUP_MENU, 1) -- restart
@@ -36,11 +42,11 @@ MoveDoesntRepaintTest("Calculator", "/A2.DESKTOP/APPLE.MENU/CALCULATOR", 280, 55
 MoveDoesntRepaintTest("Calendar", "/A2.DESKTOP/APPLE.MENU/CALENDAR", 280, 40)
 MoveDoesntRepaintTest("Key Caps", "/A2.DESKTOP/APPLE.MENU/KEY.CAPS", 280, 50)
 MoveDoesntRepaintTest("Control Panel", "/A2.DESKTOP/APPLE.MENU/CONTROL.PANELS/CONTROL.PANEL", 280, 30)
-MoveDoesntRepaintTest("Joystick", "/A2.DESKTOP/APPLE.MENU/CONTROL.PANELS/JOYSTICK", 280, 50)
+MoveDoesntRepaintTest("Joystick", "/A2.DESKTOP/APPLE.MENU/CONTROL.PANELS/JOYSTICK", 280, 50, 0.02)
 MoveDoesntRepaintTest("Map", "/A2.DESKTOP/APPLE.MENU/CONTROL.PANELS/MAP", 280, 40)
 MoveDoesntRepaintTest("Options", "/A2.DESKTOP/APPLE.MENU/CONTROL.PANELS/OPTIONS", 280, 45)
 MoveDoesntRepaintTest("Views", "/A2.DESKTOP/APPLE.MENU/CONTROL.PANELS/VIEWS", 280, 50)
-MoveDoesntRepaintTest("Bounce", "/A2.DESKTOP/APPLE.MENU/TOYS/BOUNCE", 280, 45)
+MoveDoesntRepaintTest("Bounce", "/A2.DESKTOP/APPLE.MENU/TOYS/BOUNCE", 280, 45, 0.05)
 MoveDoesntRepaintTest("Eyes", "/A2.DESKTOP/APPLE.MENU/TOYS/EYES", 280, 60)
 MoveDoesntRepaintTest("Lights Out", "/A2.DESKTOP/APPLE.MENU/TOYS/LIGHTS.OUT", 280, 60)
 MoveDoesntRepaintTest("Neko", "/A2.DESKTOP/APPLE.MENU/TOYS/NEKO", 280, 50)

tests/international.lua

@@ -17,8 +17,8 @@ test.Step(
     a2d.OAShortcut("2") -- D/M/Y
     apple2.DHRDarkness()
     a2d.DialogOK()
-
-    test.Snap("Verify full repaint and D/M/Y format")
+    test.ExpectEquals(a2d.RepaintType(), "full", "repaint", {snap=true})
+    test.Snap("verify D/M/Y format")
 end)
 
 test.Step(
@@ -30,6 +30,5 @@ test.Step(
     -- don't change anything
     apple2.DHRDarkness()
     a2d.DialogOK()
-
-    test.Snap("Verify minimal repaint")
+    test.ExpectEquals(a2d.RepaintType(), "minimal", "repaint", {snap=true})
 end)

tests/lib/a2d.lua

@@ -549,5 +549,31 @@ end
 
 --------------------------------------------------
 
+function a2d.RepaintFraction()
+  local count = 0
+  for row = 0,191 do
+    for col = 0,79 do
+      if not apple2.ValidateDHRDarkness(row, col) then
+        count = count + 1
+      end
+    end
+  end
+  return count / (192*80)
+end
+
+-- Heuristic-based
+function a2d.RepaintType()
+  local fraction = a2d.RepaintFraction()
+  if fraction > 0.90 then
+    return "full"
+  elseif fraction < 0.01 then
+    return "none"
+  else
+    return "minimal"
+  end
+end
+
+--------------------------------------------------
+
 
 return a2d

tests/lib/apple2.lua

@@ -759,16 +759,25 @@ end
 -- Misc Utilities
 --------------------------------------------------
 
-function apple2.GetDoubleHiresByte(row, col)
+function GetDHRByteAddress(row, col)
   local bank = col % 2
   col = col >> 1
   local aa = (row & 0xC0) >> 6
   local bbb = (row & 0x38) >> 3
   local ccc = (row & 0x07)
-  local addr = 0x2000 + (aa * 0x28) + (bbb * 0x80) + (ccc * 0x400) + col
+  return bank, 0x2000 + (aa * 0x28) + (bbb * 0x80) + (ccc * 0x400) + col
+end
+
+function apple2.GetDoubleHiresByte(row, col)
+  local bank, addr = GetDHRByteAddress(row, col)
   return apple2.ReadRAMDevice(addr + 0x10000 * (1-bank))
 end
 
+function apple2.SetDoubleHiresByte(row, col, value)
+  local bank, addr = GetDHRByteAddress(row, col)
+  apple2.WriteRAMDevice(addr + 0x10000 * (1-bank), value)
+end
+
 function apple2.GrabTextScreen()
   local is80 = apple2.ReadSSW("RD80VID") > 127
   local screen = ""
@@ -791,30 +800,28 @@ end
 
 --------------------------------------------------
 
-function apple2.DHRDarkness()
-  function SetDHRByte(col, row, value)
-    local bank = col % 2
-    col = col >> 1
-    local aa = (row & 0xC0) >> 6
-    local bbb = (row & 0x38) >> 3
-    local ccc = (row & 0x07)
-    local addr = 0x2000 + (aa * 0x28) + (bbb * 0x80) + (ccc * 0x400) + col
-    apple2.WriteRAMDevice(addr + 0x10000 * (1-bank), value)
-  end
-
-  local bytes = {
-    {0x00, 0x00, 0x00, 0x00},
-    {0x08, 0x11, 0x22, 0x44},
-    {0x00, 0x00, 0x00, 0x00},
-    {0x22, 0x44, 0x08, 0x11},
-  }
+local darkness_bytes = {
+  {0x00, 0x00, 0x00, 0x00},
+  {0x08, 0x11, 0x22, 0x44},
+  {0x00, 0x00, 0x00, 0x00},
+  {0x22, 0x44, 0x08, 0x11},
+}
 
+function apple2.DHRDarkness()
   for row = 0,191 do
     for col = 0,79 do
-      SetDHRByte(col, row, bytes[row % 4 + 1][col % 4 + 1])
+      local byte = darkness_bytes[row % 4 + 1][col % 4 + 1]
+      apple2.SetDoubleHiresByte(row, col, byte)
     end
   end
 end
+
+-- Expect apple2.DHRDarkness() was previously called
+function apple2.ValidateDHRDarkness(row, col)
+  local expected = darkness_bytes[row % 4 + 1][col % 4 + 1]
+  return apple2.GetDoubleHiresByte(row, col) == expected
+end
+
 --------------------------------------------------
 
 return apple2

tests/lib/test.lua

@@ -61,6 +61,10 @@ function test.Failure(message)
   os.exit(1)
 end
 
+--------------------------------------------------
+-- Snapshots
+--------------------------------------------------
+
 function test.Snap(opt_title)
   snap(opt_title)
 end
@@ -72,26 +76,43 @@ function test.MultiSnap(frames, opt_title)
   end
 end
 
-function test.Expect(expr, message)
+--------------------------------------------------
+-- Expectations
+--------------------------------------------------
+
+function test.Expect(expr, message, options)
   if not expr then
+    if options and options.snap then
+      test.Snap("FAILURE - " .. message)
+    end
     error("Expectation failure: " .. message)
   end
 end
 
-function test.ExpectEquals(actual, expected, message)
-  test.Expect(actual == expected, message .. " - " .. actual .. " should equal " .. expected)
+function format(value)
+  if type(value) == "string" then
+    return string.format("%q", value)
+  elseif type(value) == "boolean" then
+    return value and "true" or "false"
+  else
+    return value
+  end
+end
+
+function test.ExpectEquals(actual, expected, message, options)
+  test.Expect(actual == expected, message .. " - actual " .. format(actual) .. " should equal " .. format(expected), options)
 end
 
-function test.ExpectNotEquals(actual, expected, message)
-  test.Expect(actual ~= expected, message .. " - " .. actual .. " should not equal " .. expected)
+function test.ExpectNotEquals(actual, expected, message, options)
+  test.Expect(actual ~= expected, message .. " - actual " .. format(actual) .. " should not equal " .. format(expected), options)
 end
 
-function test.ExpectLessThan(a, b, message)
-  test.Expect(a < b, message .. " - " .. a .. " should be < " .. b)
+function test.ExpectLessThan(a, b, message, options)
+  test.Expect(a < b, message .. " - actual " .. format(a) .. " should be < " .. format(b), options)
 end
 
-function test.ExpectLessThanOrEqual(a, b, message)
-  test.Expect(a <= b, message .. " - " .. a .. " should be <= " .. b)
+function test.ExpectLessThanOrEqual(a, b, message, options)
+  test.Expect(a <= b, message .. " - actual " .. format(a) .. " should be <= " .. format(b), options)
 end
 
 --------------------------------------------------

tests/text_preview.lua

@@ -153,7 +153,7 @@ test.Step(
         test.Snap("verify thumb highlighted")
         m.ButtonUp()
         a2d.WaitForRepaint()
-        test.Snap("verify no repaint")
+        test.Expect(a2d.RepaintType(), "none", {snap=true})
     end)
     a2d.CloseWindow()
     a2d.InvokeMenuItem(a2d.STARTUP_MENU, 1) -- reboot