Mini Test is a small, easy to use testing toolkit for LiveCode. It can be used in both GUI scripts and server scripts. Thanks to LiveCode's messaging, it can be used to test GUI applications as well as commands and handlers.
LiveCode Mini Test is no longer being developed or maintained.
Mini Test consists of a set of handlers which you can use to create automated test scripts. There are at least two scripts needed to run a MiniTest test script. The test script itself and MiniTest. Normally you would also include one or more stacks that you wish to test unless you are testing elements of the LiveCode language.
There are two levels of tests in MiniTest. The highest level is a Test Run which may contain individual tests or Test Files. The lower level is a Test File which contains a individual tests. (A Test File cannot be included in a Test File). Actually, MiniTest is quite flexible and is happy with any number of test runs and test files in a single script. It is also happy to process only Test Runs (without Test Files) and only Test Files (without Test Runs).
A Mini Test script is written by simply interspersing Mini Tests commands in your testing code.
At the start of your test script you simply include MiniTest and the stack you wish to test. MiniTest is in a file named MiniTest.LiveCode. The code to include in your testing script is:
start using stack "<insert file path here>/MiniTest.livecode"
An indivdual test consist of four elements:
- The Mini Test start test command
- Testing code
- Mini Test assert and refute commands to check that the test is as expected
- The Mini Test end test command
The testing code and Mini Test assert and refute commands can be freely inter-mingled.
Mini Test consists of the handlers listed below. The name of all the Mini Test the handlers is pre-fixed with "MT." which should practically reduce the chance to nil of a Mini Test handler having the same name as one of your handlers.
###MT.setTestReport pTestReporter This command prepares Mini Test to run in "GUI mode". It requires the name of a LiveCode Field to be supplied for it to use to report the test results. For example, if you want Mini Test to display it's result in a Field called "Mini Test Report", you would use:
MT.setTestReport "Mini Test Report"
This command prepares Mini Test to perform a test run.
MT.startTestRun
This command informs Mini Test that a new test file is starting. You need to provide a name for the test file to Mini Test.
MT.startTestFile "My First Mini Test File"
This command signfies the start of an individual test. A name is required so that Mini Test can report which test fails (if any do).
MT.startTest "Test 1"
This command checks that the supplied actual value is true.
MT.assert "a" = "A"
This command checks that the supplied actual value is equal to the supplied expected value.
MT.assertEqual 2, 1 + 1
###MT.refuteEqual pExpected, pActual This command checks that the supplied actual value is not equal to the supplied expected value.
MT.refuteEqual "z", the first character of "abcdefgh"
This command signifies the end of a test. Mini Tests checks if there were any assert or refute commands which failed. It reports any failures.
MT.endTest
This command siginifies the end of a test file. Mini Test will print totals for the test file.
MT.endTestFile
This command signifies the end of a test run. Mini Test will print totals for the test run.
MT.endTestRun
This command checks that the supplied actual value is false.
MT.refute "a" = "b"