Documentation for Veritas: PACTA SUNT SERVANDA

assert.scm: Assertion functions

Note: If one desires to delay execution of the #:got argument of the assertions, one can simply quote it and wrap it inside a block with compute as car. You can use compute, computare, or comp as special keywords for lazy evaluation. This works for all assertions, except assert-error and related. See an example here:

;; got will evaluate eagerly
(assert-equal #:expect 1
              #:got (+ 10 (- 0 9)))

;; got will evaluate lazily, inside test context
(assert-equal #:expect 1
              #:got `(comp (begin
                             (sleep 4)
                             (+ 10 (- 0 9)))))

(assert-equal #:expect 144
              #:got `(comp (begin
                             ;; This block is evaluated by Veritas.
                             ;; Useful for setup or complex expressions.
                             (let ((x 12))
                               (* x x))))
              #:name "Complex computation inside an assertion")

Some functionalities, including the runner, are configured via environment variables for ease of use and integration in CI environments. In the Guile Scheme implementation this is done leveraging parameters and. All the variables have sane defaults, but are your entry-point for lots of customisation of the test process.

• VERITAS_ENTRYPOINT defaults to spec and determines which function should be called as entry-point to your tests.
• VERITAS_SCAN_DIR defaults to ./ and determines which directory should be used to look for test directories and files.
• VERITAS_TEST_TYPE defaults to unit and determines which type of test to use, and thus which directory should be used to load files from.
• VERITAS_TEST_TOP_DIR defaults to test and determines which directory to use to look for test hierarchies, typically this means a test directory beside your src directory, at top repository level.
• VERITAS_TEST_MODULE defaults to veritas and determines the test module to load, and also should be equal to the Guile Scheme modules name you use. For example if you have a unit test file a ./test/my-program/unit/my-test.scm then you should change this variable to the value my-program and your module declaration should be (define-module (my-program unit my-test)). If you don't change the defaults, place your tests at for example ./test/veritas/unit/my-test.scm and name them (define-module (veritas unit my-test)).
• VERITAS_SHUFFLE_FILES defaults to true and determines whether to shuffle test file order or not.
• VERITAS_RUN_BENCHMARKS defaults to true and determines whether benchmarks should be run.
• VERITAS_ONLY_TEST is an optional variable you can pass to limit the execution to test cases whose name partially matches this variable.
• VERITAS_ONLY_SUITE is an optional variable you can pass to limit the execution to suites whose name partially matches this variable.
• VERITAS_REPORTER is an optional variable, interpreted as symbol in Lisp, by default emoji-reporter, other choices are monotone-reporter