Tests: Add helpers for ejecting/swapping disks

These directly expose MAME's `device_image_interface` which
gives :load() and :unload() methods, which seems fine. They
do abstract over the various ways hardware produces Disk II
controllers in slot 6, at least.

Author: inexorabletash

notes/testplan.md

@@ -1346,7 +1346,7 @@ Run these tests on a system without a real-time clock:
 * Launch DeskTop. Open a window for a volume that is not the startup disk. Apple Menu > Run Basic Here. Verify that the PREFIX is set correctly.
 * Configure a system with a RAMCard. Launch DeskTop, ensure it copies itself to RAMCard. Ensure `BASIC.SYSTEM` is present on the startup disk. Open a window. Apple Menu > Run Basic Here. Verify that `BASIC.SYSTEM` starts.
 
-## Joystick - coverage in `tests/joystick.lua`
+## Joystick - covered by `tests/joystick.lua`
 
 * Configure a system with only a single joystick (or paddles 0 and 1). Run the DA. Verify that only a single indicator is shown.
 * Configure a system with two joysticks (or paddles 2 and 3). Run the DA. Verify that after the second joystick is moved, a second indicator is shown.

tests/lib/apple2.lua

@@ -37,6 +37,11 @@ local keyboard = {
   ["Reset"] = { port = ":keyb_special", field = "RESET" },
 }
 
+local images = {
+  S6D1 = ":sl6:diskiing:0:525",
+  S6D2 = ":sl6:diskiing:1:525",
+}
+
 function get_device(pattern)
   for name,dev in pairs(machine.devices) do
     if name:match(pattern) then return dev end
@@ -62,6 +67,18 @@ elseif machine.system.name:match("^apple2c") then
     y = { port = ":mse_y",      field = "Mouse Y" },
     b = { port = ":mse_button", field = "Mouse Button" },
   }
+  images = {
+    S6D1 = ":sl6:0:525",
+    S6D2 = ":sl6:1:525",
+  }
+  if machine.system.name:match("^apple2cp") then
+    images = {
+      S6D1 = ":fdc:0:525",
+      S6D2 = ":fdc:1:525",
+      FDC2 = ":fdc:2:35dd",
+      FDC3 = ":fdc:3:35dd",
+    }
+  end
 elseif machine.system.name:match("^las.*128") then
   -- Laser 128
   -- * built-in mouse port
@@ -104,6 +121,13 @@ elseif machine.system.name:match("^apple2gs") then
     -- Other
     ["Reset"] = { port = ":macadb:KEY5", field = "Reset / Power" },
   }
+
+  images = {
+    S6D1 = ":fdc:0:525",
+    S6D2 = ":fdc:1:525",
+    FDC2 = ":fdc:2:35dd",
+    FDC3 = ":fdc:3:35dd",
+  }
 elseif machine.system.name:match("^ace500") then
   -- Franklin ACE 500
   -- * has built-in mouse port
@@ -667,6 +691,66 @@ function apple2.WriteSSW(symbol, value)
   apple2.WriteMemory(ssw[symbol], value)
 end
 
+
+--------------------------------------------------
+-- Disks/Drives
+--------------------------------------------------
+
+-- These return image, objects:
+-- https://docs.mamedev.org/luascript/ref-devices.html#image-device-interface
+-- Useful methods:
+--  image:load(path_to_image_file) -- swap
+--  image:unload() -- eject, for floppies only!
+
+-- SCSI controller devices
+function apple2.GetSCSIHD(slot, id)
+  local image = manager.machine.images[":sl"..slot..":scsi:scsibus:"..id..":harddisk:image"]
+  if not image then
+    error("No SCSI in slot "..slot.." and/or hard disk at ID " .. id)
+  end
+  return image
+end
+function apple2.GetSCSICD(slot, id)
+  local image = manager.machine.images[":sl"..slot..":scsi:scsibus:"..id..":cdrom:image"]
+  if not image then
+    error("No SCSI in slot "..slot.." and/or CD-ROM at ID " .. id)
+  end
+  return image
+end
+
+-- These abstract over the various hardware that looks like S6,Dn to most software
+function apple2.GetDiskIIS6D1()
+  local image = manager.machine.images[images.S6D1]
+  if not image then
+    error("No Disk II in S6,D2")
+  end
+  return image
+end
+
+function apple2.GetDiskIIS6D2()
+  local image = manager.machine.images[images.S6D2]
+  if not image then
+    error("No Disk II in S6,D2")
+  end
+  return image
+end
+
+-- For Apple IIgs and Apple IIc+ only (so far)
+function apple2.Get35Drive1()
+  local image = manager.machine.images[images.FDC2]
+  if not image then
+    error("No 3.5\" drive 1")
+  end
+  return image
+end
+function apple2.Get35Drive2()
+  local image = manager.machine.images[images.FDC3]
+  if not image then
+    error("No 3.5\" drive 1")
+  end
+  return image
+end
+
 --------------------------------------------------
 -- Misc Utilities
 --------------------------------------------------
@@ -727,7 +811,6 @@ function apple2.DHRDarkness()
     end
   end
 end
-
 --------------------------------------------------
 
 return apple2

tests/playground.lua

@@ -1,8 +1,8 @@
 --[[ BEGINCONFIG ========================================
 
 MODEL="apple2ee"
-MODELARGS="-sl2 mouse -sl7 cffa2 -aux ext80"
-DISKARGS="-hard1 $HARDIMG"
+MODELARGS="-sl2 mouse -sl7 scsi -aux ext80"
+DISKARGS="-hard1 $HARDIMG -flop1 $FLOP1IMG"
 
 ======================================== ENDCONFIG ]]--
 
@@ -13,32 +13,6 @@ DISKARGS="-hard1 $HARDIMG"
 
   ============================================================]]--
 
-test.Step(
-  "Sample Media",
-  function()
-    a2d.SelectAndOpen("A2.DESKTOP")
-    a2d.SelectAndOpen("SAMPLE.MEDIA")
-    test.Snap("Sample Media")
-
-    -- Change window size
-    a2d.OAShortcut("G")
-    apple2.RightArrowKey()
-    apple2.RightArrowKey()
-    apple2.RightArrowKey()
-    apple2.RightArrowKey()
-    apple2.ReturnKey()
-    a2d.WaitForRepaint()
-    test.Snap("Changed window size")
-
-    -- Open MONARCH (image preview)
-    a2d.SelectAndOpen("MONARCH")
-    emu.wait(5) -- load big file
-    test.Snap("Image preview")
-    apple2.EscapeKey()
-    a2d.WaitForRepaint()
-    test.Snap("Back to desktop")
-end)
-
 test.Step(
   "Move Mouse",
   function()
@@ -51,29 +25,22 @@ test.Step(
     test.Snap("Mouse to 0,0")
 end)
 
-function IsHi(ident)
-  if apple2.ReadSSW(ident) > 127 then
-    return "true"
-  else
-    return "false"
-  end
-end
+test.Step(
+  "swap images",
+  function()
 
-print("text?   " .. IsHi("RDTEXT"))
-print("mixed?  " .. IsHi("RDMIXED"))
-print("page2?  " .. IsHi("RDPAGE2"))
-print("hires?  " .. IsHi("RDHIRES"))
-print("altchr? " .. IsHi("RDALTCHR"))
-print("80vid?  " .. IsHi("RD80VID"))
+    apple2.GetSCSIHD(7, 6):load("/Users/josh/dev/a2d/res/tests.hdv")
+    a2d.InvokeMenuItem(a2d.SPECIAL_MENU, a2d.SPECIAL_CHECK_ALL_DRIVES)
+    a2d.WaitForRepaint()
+    test.Snap("swapped hard1")
 
---[[
-  local last = apple2.ReadMemory(0x2000)
-  while true do
-  emu.wait(5/60)
-  local cur = apple2.ReadMemory(0x2000)
-  if cur ~= last then
-  print("Now is " .. cur)
-  last = cur
-  end
-  end
-]]--
+    apple2.GetDiskIIS6D1():unload()
+    a2d.InvokeMenuItem(a2d.SPECIAL_MENU, a2d.SPECIAL_CHECK_ALL_DRIVES)
+    a2d.WaitForRepaint()
+    test.Snap("flop1 ejected")
+
+    apple2.GetDiskIIS6D2():unload() -- harmless if already empty
+    a2d.InvokeMenuItem(a2d.SPECIAL_MENU, a2d.SPECIAL_CHECK_ALL_DRIVES)
+    a2d.WaitForRepaint()
+    test.Snap("flop2 ejected")
+end)