aboutsummaryrefslogtreecommitdiffstats
path: root/lib/wx/test/Readme
diff options
context:
space:
mode:
Diffstat (limited to 'lib/wx/test/Readme')
-rw-r--r--lib/wx/test/Readme30
1 files changed, 30 insertions, 0 deletions
diff --git a/lib/wx/test/Readme b/lib/wx/test/Readme
new file mode 100644
index 0000000000..09e9604491
--- /dev/null
+++ b/lib/wx/test/Readme
@@ -0,0 +1,30 @@
+
+Testing and running wxerlang tests.
+
+Testing gui api/applications can be hard, but we can at least
+test that wxerlang behaves as we expected, i.e. that the api
+is consistent and that it don't crash.
+
+The tests are structured as they are because we want you to
+be able to run them in three different ways.
+ - direct via an erlang shell
+ - via common_test application
+ - via erlang/OTP inhouse ts tool.
+
+To run all the tests compile them and on unix
+run ./wxt to create an erlang terminal.
+
+Invoke wxt:t(). in the erlang shell to run all regression tests.
+If you want to specific tests invoke wxt:t(Module)
+or wxt:t(Module, TestCase).
+
+To run all tests including the ones that require manual intervention run.
+wxt:t(all, [{user,true}]).
+
+To see every test_case window use
+wxt:t(all, [{user,step}]).
+This requires that you manually close each window to step to the
+next test_case.
+
+If you want to run specific test_cases use:
+wxt:t({Module,TestCase}, [{user,step}]).