mirror of https://github.com/vitalif/openscad
fix the documentation (merge errors)
parent
ae307df8f3
commit
36d8f895b4
110
doc/testing.txt
110
doc/testing.txt
|
@ -1,75 +1,50 @@
|
|||
Running regression tests:
|
||||
-------------------------
|
||||
|
||||
First, install the prerequisite helper programs on your system:
|
||||
0) Prerequisites
|
||||
|
||||
<<<<<<< HEAD
|
||||
cmake, python, ImageMagick 6.5.9.3 or newer, diff
|
||||
Install the prerequisite helper programs on your system:
|
||||
|
||||
cmake, python2 (not 3), ImageMagick 6.5.9.3 or newer, diff
|
||||
|
||||
There are binary installer packages of these tools available for Mac,
|
||||
Win, Linux, BSD, and other systems. (except maybe diff for Win)
|
||||
|
||||
Next, get a working qmake GUI build of the main openscad binary working.
|
||||
For Windows(TM) it is easiest to get a cross-build working. See
|
||||
README.md for how to do this. Lastly, install MCAD under
|
||||
openscad/libraries.
|
||||
=======
|
||||
First, install MCAD.
|
||||
For Windows(TM) this means get a cross-build working from within linux.
|
||||
See README.md for how to do this.
|
||||
|
||||
Then, install MCAD under openscad/libraries.
|
||||
|
||||
$ cd openscad
|
||||
$ git submodule update --init
|
||||
>>>>>>> 0d9b20dc143b2acca68496d2ce5e4fd02798289e
|
||||
|
||||
A) Building test environment
|
||||
|
||||
Linux, Mac:
|
||||
|
||||
<<<<<<< HEAD
|
||||
$ cd tests
|
||||
$ cmake .
|
||||
$ make
|
||||
|
||||
Windows(TM):
|
||||
|
||||
The Windows tests are cross-compiled from within linux, like so:
|
||||
Cross-build from within linux:
|
||||
|
||||
$ source ./scripts/setenv-mingw-xbuild.sh 64 # (32 for 32-bit system)
|
||||
$ ./scripts/release-common.sh mingw64 tests # (mingw32 for 32-bit)
|
||||
64-bit:
|
||||
$ source ./scripts/setenv-mingw-xbuild.sh 64
|
||||
$ ./scripts/release-common.sh mingw64 tests
|
||||
$ # result is .zip file under ./mingw64/
|
||||
|
||||
Once the package is built, install it into Windows as you would any
|
||||
other program. Then start up a command prompt, and run this:
|
||||
32-bit:
|
||||
$ source ./scripts/setenv-mingw-xbuild.sh 32
|
||||
$ ./scripts/release-common.sh mingw32 tests
|
||||
$ # result is .zip file under ./mingw32/
|
||||
|
||||
cd c:\Program Files\OpenSCAD_Tests\openscad\tests\bin
|
||||
c:\python27\python.exe mingw_x_testfile.py
|
||||
=======
|
||||
Windows + MSVC:
|
||||
|
||||
The MSVC build hasn't been tested in years. See the README for pointers.
|
||||
First, gett the main GUI to build. Then, to build the tests:
|
||||
>>>>>>> 0d9b20dc143b2acca68496d2ce5e4fd02798289e
|
||||
|
||||
This will modify paths in CTestTestfile.cmake for your Win system.
|
||||
|
||||
Windows + MSVC:
|
||||
(This hasn't been tested since circa 2012)
|
||||
From the QT command prompt:
|
||||
|
||||
> cd tests
|
||||
> cmake . -DCMAKE_BUILD_TYPE=Release
|
||||
> sed -i s/\/MD/\/MT/ CMakeCache.txt
|
||||
> cmake .
|
||||
> nmake -f Makefile
|
||||
|
||||
<<<<<<< HEAD
|
||||
=======
|
||||
Cross compiling Linux->Win32 and testing under Wine:
|
||||
|
||||
Experimental. Please see openscad/tests/CMingw-cross-env.cmake for instructions
|
||||
on attempting to get it to work.
|
||||
|
||||
>>>>>>> 0d9b20dc143b2acca68496d2ce5e4fd02798289e
|
||||
B) Running tests
|
||||
|
||||
Linux, Mac:
|
||||
|
||||
$ ctest Runs tests enabled by default
|
||||
$ ctest -R <regex> Runs only matching tests, e.g. ctest -R dxf
|
||||
$ ctest -C <configs> Adds extended tests belonging to configs.
|
||||
|
@ -80,6 +55,12 @@ $ ctest -C <configs> Adds extended tests belonging to configs.
|
|||
Bugs - test known bugs (tests will fail)
|
||||
All - test everything
|
||||
|
||||
Win:
|
||||
|
||||
Unzip the OpenSCAD-Tests-YYYY.MM.DD file onto a Windows(TM) machine.
|
||||
There will be a script called OpenSCAD-Test-Console.py in the parent folder.
|
||||
Double-click it, and it will open a console, from which you can type the ctest
|
||||
commands listed above.
|
||||
|
||||
C) Automatically upload test results (experimental)
|
||||
|
||||
|
@ -87,8 +68,8 @@ It's possible to automatically upload tests results to an external
|
|||
server. This is good for CI, as well as being able to easily report
|
||||
bugs.
|
||||
|
||||
To enable this feature, add '-DOPENSCAD_UPLOAD_TESTS=1' to the cmake cmd-line, e.g.:
|
||||
cmake -DOPENSCAD_UPLOAD_TESTS=1 .
|
||||
To enable this feature, add '-DOPENSCAD_UPLOAD_TESTS=1' to the cmake
|
||||
cmd-line, e.g.: cmake -DOPENSCAD_UPLOAD_TESTS=1 .
|
||||
|
||||
Adding a new test:
|
||||
------------------
|
||||
|
@ -181,9 +162,6 @@ Is a boost/libstdc++ bug. Fix like so before running:
|
|||
|
||||
$ export LC_MESSAGES=
|
||||
|
||||
<<<<<<< HEAD
|
||||
6. Proprietary GL driver issues
|
||||
=======
|
||||
6. I want to build without OpenGL
|
||||
|
||||
There is an unsupported way to do this, by defining NULLGL to Cmake:
|
||||
|
@ -195,34 +173,43 @@ Is a boost/libstdc++ bug. Fix like so before running:
|
|||
useful for debugging and outputting 3d-formats like STL on systems without GL.
|
||||
This option may break in the future and require tweaking to get working again.
|
||||
|
||||
7. Other issues
|
||||
>>>>>>> 0d9b20dc143b2acca68496d2ce5e4fd02798289e
|
||||
7. Proprietary GL driver issues
|
||||
|
||||
There are sporadic reports of problems running on remote machines with
|
||||
proprietary GL drivers. Try doing a web search for your exact error
|
||||
message to see solutions others have found.
|
||||
message to see solutions and workarounds that others have found.
|
||||
|
||||
7. Other issues
|
||||
8. Windows + MSVC:
|
||||
|
||||
The MSVC build was last tested circa 2012. The last time it worked,
|
||||
these were the necessary commands to run.
|
||||
|
||||
> Start the 'QT command prompt'
|
||||
> cd \where\you\installed\openscad
|
||||
> cd tests
|
||||
> cmake . -DCMAKE_BUILD_TYPE=Release
|
||||
> sed -i s/\/MD/\/MT/ CMakeCache.txt
|
||||
> cmake .
|
||||
> nmake -f Makefile
|
||||
|
||||
9. Other issues
|
||||
|
||||
The OpenSCAD User Manual Wiki has a section on buildling. Please check
|
||||
there for possible updates and workarounds:
|
||||
|
||||
http://en.wikibooks.org/wiki/OpenSCAD_User_Manual
|
||||
|
||||
<<<<<<< HEAD
|
||||
Please report build errors (after double checking the instructions) in
|
||||
the github issue tracker
|
||||
|
||||
http://github.com/openscad/openscad/issues
|
||||
=======
|
||||
|
||||
10. Migration away from dedicated regression tests:
|
||||
|
||||
Migration away from dedicated regression tests:
|
||||
-----------------------------------------------
|
||||
In 2013 the test programs underwent a major change. The following notes
|
||||
are leftover.
|
||||
|
||||
In 2013 the test programs underwent a major change. These notes are leftover.
|
||||
|
||||
This test still needs 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:
|
||||
|
||||
* cgalstlsanitytest
|
||||
|
@ -235,5 +222,4 @@ These look like tests, but are not actually in use:
|
|||
|
||||
* modulecachetest
|
||||
* cgalcachetest
|
||||
>>>>>>> 0d9b20dc143b2acca68496d2ce5e4fd02798289e
|
||||
|
||||
"
|
||||
|
|
Loading…
Reference in New Issue