Thingiverse
OpenSCAD Unit Testing and Documentation Tool by runsun
by Thingiverse
Last crawled date: 4 years, 1 month ago
OpenSCAD_DocTest is a library for documentation and unit testing of functions in OpenSCAD. Both doc and tests are written in arrays and processed by doctest() and output to the console. It has different modes like doc only, test only, show tests as examples (i.e., no testing), etc, and capable of commenting on test cases easily, making it a good tool for demonstrating demo of usages.
Whichever mode it operates on, the output (in the console) can be copied and pasted to a doc editor (like LibreOffice Writer), and an api doc can be generated with very minor editing. The file openscad_doctest_api.html servers as a good demo for this feature.
The unit test feature helps to ensure quality, reduces maintenance burden, facilitate re-factoring, and, my favorite, allows for test-first or test-driven programming, i.e., write the expected outcome of a function first, then starts writing the code to see if it behaves as expected.
NOTE: This lib is released as an open source under AGPL3 (that license is missing from Thingiverse's license option list when I created this thing).
Whichever mode it operates on, the output (in the console) can be copied and pasted to a doc editor (like LibreOffice Writer), and an api doc can be generated with very minor editing. The file openscad_doctest_api.html servers as a good demo for this feature.
The unit test feature helps to ensure quality, reduces maintenance burden, facilitate re-factoring, and, my favorite, allows for test-first or test-driven programming, i.e., write the expected outcome of a function first, then starts writing the code to see if it behaves as expected.
NOTE: This lib is released as an open source under AGPL3 (that license is missing from Thingiverse's license option list when I created this thing).