Idris2/tests/templates/simple-test/notes.md

Description

Template for simpler tests where we need to check or compile single modules. For tests that require a package, see the template with-ipkg.

Mandatory steps

• Create a new subdirectory for the tests. Try to adhere to the naming scheme of existing tests.
• Update the tests/Main.idr, adding the new subdirectory to the lists of tests.
• The testutils.sh script defines the idris2 name binding, and some testing utility functions.
• Automate deletion of any temporary files created by your test. This prevents inconsistencies between runs. The build directory is deleted automatically by testutils.sh.
• If the tests open a REPL session, remember to put a quit command, :qin the input file.
• The files named run, expected, output are reserved by the test runner, do not overwrite them by running the test.

Optional steps

• The expected file can be updated for the first time manually, or by running the test, after updating tests/Main.idr, with make test only="testdir/testname000" (substitute the only arguments with the subdirectory of the test).