summaryrefslogtreecommitdiff
path: root/doc/testing.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/testing.txt')
-rw-r--r--doc/testing.txt32
1 files changed, 5 insertions, 27 deletions
diff --git a/doc/testing.txt b/doc/testing.txt
index 626bae5..ee560a5 100644
--- a/doc/testing.txt
+++ b/doc/testing.txt
@@ -3,8 +3,10 @@ Running regression tests:
Prerequisites: cmake, python, ImageMagick 6.5.9.3 or newer
-First, get a working qmake GUI build. It is used by the tests.
-Next, get MCAD installed by using 'git submodule update --init'
+First, get a working qmake GUI build of the main openscad binary. It is
+used by the tests. Next, get MCAD installed by using
+
+ 'git submodule update --init'
A) Building test environment
@@ -67,44 +69,20 @@ This is almost the same as adding a new regression test:
Migration away from dedicated regression tests:
-----------------------------------------------
-As the main OpenSCAD binary gained the capability to output PNG renderings,
-the necessity for dedicated test binaries went away; for many test, OpenSCAD
-is now directly called, resulting in better test coverage and less code to
-maintain.
-
-So far, the following tests have been fully converted to use the main binary:
-
-* moduledumptest
-* csgtermtest
-* cgalpngtest
-* opencsgtest
-
-Two tests still need an intermediate script that mangles away timestamps and
+This test still needs an intermediate script that mangles away timestamps and
near-zero floating point numbers:
-* dumptest
-* echotest
* cgalstlsanitytest
Some tests are yet to be converted:
* csgtexttest -- verify whether this is not redundant with dumptest
-* throwntogethertest -- should be a .png output mode
These look like tests, but are not actually in use:
* modulecachetest
* cgalcachetest
-In the course of migration, the possibilities of using the OPENSCAD_TESTING
-compile time flag go away; that flag used to strip timestamps out of files,
-to unify float output, and to tweak the file inclusion paths. With that flag
-unused, we get better coverage of the primary code paths, at the cost of
-having to do some normalization in the unit testing process (thus the dumptest
-and echo test scripts). Especially, having a nonstandard MCAD library in the
-user include path can now break things -- but so can having misbehaving
-programs in your PATH.
-
Troubleshooting:
------------------------------
contact: Jan Huwald // Impressum