Tests: Verify alerts automagically; report test failure file/line

Author: inexorabletash

tests/alerts.lua

@@ -12,7 +12,7 @@ test.Step(
     a2d.RenamePath("/A2.DESKTOP/READ.ME", "README")
     a2dtest.ExpectNothingHappened(function()
         a2d.OAShortcut("1")
-        test.Snap("verify alert shown")
+        a2dtest.ExpectAlertShowing()
         apple2.EscapeKey()
         a2d.WaitForRepaint()
     end)
@@ -28,7 +28,7 @@ test.Step(
     a2dtest.ExpectNothingHappened(function()
         apple2.Type("1")
         a2d.DialogOK()
-        test.Snap("verify alert shown")
+        a2dtest.ExpectAlertShowing()
         apple2.EscapeKey()
         a2d.WaitForRepaint()
     end)
@@ -57,10 +57,10 @@ test.Step(
     a2d.DialogOK() -- confirm overwrite
     emu.wait(10) -- wait for copy to complete
 
-    test.Snap("verify alert shown")
+    a2dtest.ExpectAlertShowing()
     apple2.EscapeKey()
     a2d.WaitForRepaint()
-    test.Snap("verify alert dismissed")
+    a2dtest.ExpectAlertNotShowing()
 
     a2d.OAShortcut("Q")
     a2d.WaitForRestart()

tests/apple_menu.lua

@@ -55,7 +55,7 @@ test.Step(
     local current = drive.filename
     drive:unload()
     a2d.InvokeMenuItem(a2d.APPLE_MENU, a2d.CALCULATOR)
-    test.Snap("verify alert shown")
+    a2dtest.ExpectAlertShowing()
     drive:load(current)
     a2d.DialogOK()
     test.ExpectEquals(a2dtest.GetFrontWindowTitle(), "Calc", "Calculator should be open")
@@ -69,7 +69,7 @@ test.Step(
     local current = drive.filename
     drive:unload()
     a2d.InvokeMenuItem(a2d.APPLE_MENU, a2d.CONTROL_PANELS)
-    test.Snap("verify alert shown")
+    a2dtest.ExpectAlertShowing()
     drive:load(current)
     a2d.DialogOK()
     test.ExpectEqualsIgnoreCase(a2dtest.GetFrontWindowTitle(), "CONTROL.PANELS", "Control Panels window should be open")

tests/change_type.lua

@@ -14,7 +14,7 @@ test.Step(
     apple2.DeleteKey()
     apple2.Type("06")
     a2d.DialogOK()
-    test.Snap("verify alert shown")
+    a2dtest.ExpectAlertShowing()
     a2d.DialogOK()
 end)
 
@@ -30,7 +30,7 @@ test.Step(
     apple2.DeleteKey()
     apple2.Type("8000")
     a2d.DialogOK()
-    test.Snap("verify no alert shown")
+    a2dtest.ExpectAlertNotShowing()
 end)
 
 test.Step(
@@ -44,7 +44,7 @@ test.Step(
     apple2.DeleteKey()
     apple2.Type("06")
     a2d.DialogOK()
-    test.Snap("verify alert shown")
+    a2dtest.ExpectAlertShowing()
     a2d.DialogOK()
     test.Snap("verify only non-folders are modified")
 end)
@@ -63,7 +63,7 @@ test.Step(
     apple2.DeleteKey()
     apple2.Type("8000")
     a2d.DialogOK()
-    test.Snap("verify no alert shown")
+    a2dtest.ExpectAlertNotShowing()
 end)
 
 test.Step(
@@ -75,7 +75,7 @@ test.Step(
     apple2.DeleteKey()
     apple2.Type("0F")
     a2d.DialogOK()
-    test.Snap("verify alert shown")
+    a2dtest.ExpectAlertShowing()
     a2d.DialogOK()
 end)
 
@@ -88,12 +88,12 @@ test.Step(
     apple2.DeleteKey()
     apple2.Type("0F")
     a2d.DialogOK()
-    test.Snap("verify alert shown")
+    a2dtest.ExpectAlertShowing()
     a2d.DialogOK()
 end)
 
 test.Step(
-  "Single error when modifying folder types",
+  "Single alert when modifying folder types",
   function()
     a2d.OpenPath("/TESTS/FILE.TYPES/FOLDER")
     a2d.SelectAll()
@@ -102,7 +102,7 @@ test.Step(
     apple2.DeleteKey()
     apple2.Type("06")
     a2d.DialogOK()
-    test.Snap("verify alert shown")
+    a2dtest.ExpectAlertShowing()
     a2d.DialogOK()
-    test.Snap("only a single alert was shown")
+    a2dtest.ExpectAlertNotShowing()
 end)

tests/check_all_drives.lua

@@ -10,5 +10,5 @@ test.Step(
   function()
     a2d.InvokeMenuItem(a2d.SPECIAL_MENU, a2d.SPECIAL_CHECK_ALL_DRIVES)
     a2d.WaitForRepaint()
-    test.Snap("verify no alert shown")
+    a2dtest.ExpectAlertNotShowing()
 end)

tests/control_panel.lua

@@ -43,7 +43,7 @@ test.Step(
 
     a2d.CloseWindow()
     a2d.WaitForRepaint()
-    test.Snap("verify no prompt to save")
+    a2dtest.ExpectAlertNotShowing()
 
     drive:load(current)
     a2d.CloseAllWindows()
@@ -61,7 +61,7 @@ test.Step(
 
     a2d.CloseWindow()
     a2d.WaitForRepaint()
-    test.Snap("verify prompt to save")
+    a2dtest.ExpectAlertShowing()
     a2d.DialogCancel()
 
     drive:load(current)

tests/investigations.lua

@@ -39,7 +39,7 @@ test.Step(
     drive:unload()
 
     a2d.OpenPath("/FLOPPY1")
-    test.Snap("verify alert shown")
+    a2dtest.ExpectAlertShown()
     apple2.EscapeKey()
 
     --[[
@@ -53,7 +53,7 @@ test.Step(
       CPU seems to still be chugging along, albeit in $C8xx space
     ]]--
 
-    test.Snap("verify alert dismissed")
+    a2dtest.ExpectAlertNotShown()
     emu.wait(60)
     test.Snap("Waited a long time")
     apple2.Type("TRASH")

tests/lib/a2dtest.lua

@@ -27,7 +27,7 @@ function a2dtest.ExpectNothingHappened(func)
   local bytes = apple2.SnapshotDHR()
   func()
   EraseClock()
-  test.Expect(apple2.CompareDHR(bytes), "nothing should have changed", {snap=true})
+  test.Expect(apple2.CompareDHR(bytes), "nothing should have changed", {snap=true}, 1)
 end
 
 --------------------------------------------------
@@ -45,24 +45,24 @@ local function RepaintFraction()
 end
 
 function a2dtest.ExpectFullRepaint(func)
-  a2dtest.ExpectRepaintFraction(0.9, 1.0, func, "should be full repaint")
+  a2dtest.ExpectRepaintFraction(0.9, 1.0, func, "should be full repaint", 1)
 end
 
 function a2dtest.ExpectMinimalRepaint(func)
-  a2dtest.ExpectRepaintFraction(0, 0.5, func, "should be minimal repaint")
+  a2dtest.ExpectRepaintFraction(0, 0.5, func, "should be minimal repaint", 1)
 end
 
 function a2dtest.ExpectNoRepaint(func)
-  a2dtest.ExpectRepaintFraction(0, 0.01, func, "should not have repainted")
+  a2dtest.ExpectRepaintFraction(0, 0.01, func, "should not have repainted", 1)
 end
 
-function a2dtest.ExpectRepaintFraction(min, max, func, message)
+function a2dtest.ExpectRepaintFraction(min, max, func, message, level)
   apple2.DHRDarkness()
   func()
   local fraction = RepaintFraction()
   test.Expect(min <= fraction and fraction <= max,
               string.format("%s - diff about %d%%", message, math.floor(fraction * 100)),
-              {snap=true})
+              {snap=true}, level and level+1 or 1)
 end
 
 --------------------------------------------------
@@ -119,4 +119,29 @@ end
 
 --------------------------------------------------
 
+-- This scans for the left side of the alert bitmap at expected screen address
+function a2dtest.IsAlertShowing()
+  local bytes = {0x7F,0x7F,0x7F,0x3F,0x00,0x00,0x3F,0x7F,0x0F,0x3F,0x7F,0x0F,0x3F,0x7F,0x0F,0x3F,0x7F,0x0F,0x3F,0x4F,0x0F,0x3F,0x4F,0x0F,0x3F,0x4F,0x0F,0x3F,0x7F,0x0F,0x3F,0x7F,0x0F,0x3F,0x7F,0x0F,0x3F,0x7F,0x0F,0x3F,0x7F,0x0F,0x3F,0x7F,0x0F,0x3F,0x7F,0x0F,0x3F,0x7F,0x0F,0x3F,0x7F,0x0F,0x3F,0x1F,0x00,0x3F,0x7F,0x01,0x3F,0x7F,0x01,0x3F,0x07,0x70,0x3F,0x7F,0x01,0x3F,0x7F,0x01,0x3F,0x00,0x00,0x7F,0x7F,0x7F}
+  local index = 1
+  for row = 75,100 do
+    for col = 12,14 do
+      if bytes[index] ~= apple2.GetDoubleHiresByte(row,col) then
+        return false
+      end
+      index = index + 1
+    end
+  end
+  return true
+end
+
+function a2dtest.ExpectAlertShowing()
+  test.Expect(a2dtest.IsAlertShowing(), "an alert should be showing", nil, 1)
+end
+
+function a2dtest.ExpectAlertNotShowing()
+  test.Expect(not a2dtest.IsAlertShowing(), "an alert should not be showing", nil, 1)
+end
+
+--------------------------------------------------
+
 return a2dtest

tests/lib/test.lua

@@ -80,12 +80,21 @@ end
 -- Expectations
 --------------------------------------------------
 
-function test.Expect(expr, message, options)
+local function inc(level)
+  if level then
+    return level + 1
+  else
+    return 1
+  end
+end
+
+
+function test.Expect(expr, message, options, level)
   if not expr then
     if options and options.snap then
       test.Snap("FAILURE - " .. message)
     end
-    error("Expectation failure: " .. message)
+    error("Expectation failure: " .. message, inc(inc(level)))
   end
 end
 
@@ -99,24 +108,24 @@ local function format(value)
   end
 end
 
-function test.ExpectEquals(actual, expected, message, options)
-  test.Expect(actual == expected, message .. " - actual " .. format(actual) .. " should equal " .. format(expected), options)
+function test.ExpectEquals(actual, expected, message, options, level)
+  test.Expect(actual == expected, message .. " - actual " .. format(actual) .. " should equal " .. format(expected), options, inc(level))
 end
 
-function test.ExpectEqualsIgnoreCase(actual, expected, message, options)
-  test.Expect(actual:lower() == expected:lower(), message .. " - actual " .. format(actual) .. " should equal " .. format(expected), options)
+function test.ExpectEqualsIgnoreCase(actual, expected, message, options, level)
+  test.Expect(actual:lower() == expected:lower(), message .. " - actual " .. format(actual) .. " should equal " .. format(expected), options, inc(level))
 end
 
-function test.ExpectNotEquals(actual, expected, message, options)
-  test.Expect(actual ~= expected, message .. " - actual " .. format(actual) .. " should not equal " .. format(expected), options)
+function test.ExpectNotEquals(actual, expected, message, options, level)
+  test.Expect(actual ~= expected, message .. " - actual " .. format(actual) .. " should not equal " .. format(expected), options, inc(level))
 end
 
-function test.ExpectLessThan(a, b, message, options)
-  test.Expect(a < b, message .. " - actual " .. format(a) .. " should be < " .. format(b), options)
+function test.ExpectLessThan(a, b, message, options, level)
+  test.Expect(a < b, message .. " - actual " .. format(a) .. " should be < " .. format(b), options, inc(level))
 end
 
-function test.ExpectLessThanOrEqual(a, b, message, options)
-  test.Expect(a <= b, message .. " - actual " .. format(a) .. " should be <= " .. format(b), options)
+function test.ExpectLessThanOrEqual(a, b, message, options, level)
+  test.Expect(a <= b, message .. " - actual " .. format(a) .. " should be <= " .. format(b), options, inc(level))
 end
 
 --------------------------------------------------

tests/menus.lua

@@ -284,7 +284,8 @@ end)
 test.Step(
   "Control-Shift-2 doesn't show first menu item without shortcut",
   function()
-    apple2.ControlKey("@")
-    a2d.WaitForRepaint()
-    test.Snap("verify About dialog not showing")
+    a2dtest.ExpectNothingHappened(function()
+        apple2.ControlKey("@")
+        a2d.WaitForRepaint()
+    end)
 end)

tests/screen_savers.lua

@@ -71,7 +71,7 @@ test.Step(
   "Analog Clock shows alert if there is no system clock",
   function()
     a2d.OpenPath("/A2.DESKTOP/APPLE.MENU/SCREEN.SAVERS/ANALOG.CLOCK")
-    test.Snap("verify alert shown")
+    a2dtest.ExpectAlertShowing()
     a2d.DialogOK()
     a2d.CloseAllWindows()
 end)
@@ -80,7 +80,7 @@ test.Step(
   "Digital Clock shows alert if there is no system clock",
   function()
     a2d.OpenPath("/A2.DESKTOP/APPLE.MENU/SCREEN.SAVERS/DIGITAL.CLOCK")
-    test.Snap("verify alert shown")
+    a2dtest.ExpectAlertShowing()
     a2d.DialogOK()
     a2d.CloseAllWindows()
 end)