From 658f96667b360ed5f7711ecd81a01635f0254837 Mon Sep 17 00:00:00 2001 From: "Kartik K. Agaram" Date: Tue, 11 Apr 2023 21:33:33 -0700 Subject: primitives for writing tests --- app.lua | 2 +- reference.md | 27 +++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 1 deletion(-) diff --git a/app.lua b/app.lua index 53a133f..b41b1ad 100644 --- a/app.lua +++ b/app.lua @@ -145,7 +145,7 @@ function App.run_tests_and_initialize() end function App.initialize_for_test() - App.screen.init({width=100, height=50}) + App.screen.init{width=100, height=50} App.screen.contents = {} -- clear screen App.filesystem = {} App.fake_keys_pressed = {} diff --git a/reference.md b/reference.md index db2ee1c..3234cfa 100644 --- a/reference.md +++ b/reference.md @@ -311,3 +311,30 @@ and [the Lua manual](https://www.lua.org/manual/5.1/manual.html#5.7). There's much more I could include here; check out [the LÖVE manual](https://love2d.org/wiki) and [the Lua manual](https://www.lua.org/manual/5.1/manual.html). + +### writing tests + +* `App.screen.init{width=.., height=..}` -- creates a fake screen for a test + +* `App.screen.check(y, expected_contents, msg)` -- verifies text written to + the fake screen at `y`. This isn't very realistic; `y` must exactly match + what was displayed, and the expected contents show everything printed to + that `y` in chronological order, regardless of `x` coordinate. In spite of + these limitations, you can write lots of useful tests with this. + +* `App.run_after_textinput(t)` -- mimics keystrokes resulting in `t` and then + draws one frame. + +* `App.run_after_keychord(chord)` -- mimics keystrokes resulting in `chord` + and then draws one frame. + +* `App.run_after_mouse_press(x,y, mouse_button)` -- mimics a mouse press down + followed by drawing a frame. + +* `App.run_after_mouse_release(x,y, mouse_button)` -- mimics a mouse release + up followed by drawing a frame. + +* `App.run_after_mouse_click(x,y, mouse_button)` -- mimics a mouse press down + and mouse release up followed by drawing a frame. + +* `App.wait_fake_time(t)` -- simulates the passage of time for `App.getTime()`. -- cgit 1.4.1-2-gfad0