omdl  v1.0
OpenSCAD Mechanical Design Library
validation.scad File Reference

Methods for validating the results of functions. More...

Go to the source code of this file.

Functions and/or Modules

Common
function validate (d, cv, t, ev, p=6, pf=false)
 Compare a computed test value with an known good result. More...
 
module validate_log (t)
 Output text t to the test log. More...
 
module validate_skip (fn)
 Output that function named fn has been skipped to the test log. More...
 
Validation Tables
function table_validate_init (tr, gr)
 Create data structure for related table validation functions. More...
 
function table_validate_fmt (id, td, v1, v2, v3)
 Encode an entry for test table. More...
 
function table_validate_get_ids (db)
 Return a list of test identifiers in db. More...
 
function table_validate_get_ev (db, fn, id)
 Return the expected value. More...
 
function table_validate_get_td (db, id)
 Return the test description. More...
 
function table_validate_get_v1 (db, id)
 Return the test argument value 1. More...
 
function table_validate_get_v2 (db, id)
 Return the test argument value 2. More...
 
function table_validate_get_v3 (db, id)
 Return the test argument value 3. More...
 
module table_validate_start (db, verbose=false)
 Test data structure db and output the start of test to the test log. More...
 
module table_validate (db, id, fn, argc, fr, t="equals", p=6)
 Validate and log a test function return value against its expected value. More...
 
function map_validate_init (m, fn)
 Create data structure for related map validation functions. More...
 
function map_validate_fmt (id, td, ev, v1, v2, v3)
 Encode an entry for test map. More...
 
function map_validate_get_ids (db)
 Return a list of test identifiers in db. More...
 
function map_validate_get_fn (db)
 Return the test function name. More...
 
function map_validate_get_td (db, id)
 Return the test description. More...
 
function map_validate_get_ev (db, id)
 Return the expected value. More...
 
function map_validate_get_v1 (db, id)
 Return the test argument value 1. More...
 
function map_validate_get_v2 (db, id)
 Return the test argument value 2. More...
 
function map_validate_get_v3 (db, id)
 Return the test argument value 3. More...
 
module map_validate_start (db, verbose=false)
 Test data structure db and output the start of test to the test log. More...
 
module map_validate (db, id, argc, fr, t="equals", p=6)
 Validate and log a test function return value against its expected value. More...
 

Variables

 validation_skip = "__skip__"
 Value signature assignment for log-value results table to skip a test.
 

File Details

Methods for validating the results of functions.

Author
Roy Allen Sutton
Date
2015-2024

This file is part of omdl, an OpenSCAD mechanical design library.

The omdl is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

The omdl is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with the omdl; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA; or see http://www.gnu.org/licenses/.

Definition in file validation.scad.