murex Shell Docs

Command Reference: test

murex's test framework - define tests, run tests and debug shell scripts

Description

test is used to define tests, run tests and debug murex shell scripts.

Usage

Define an inlined test

test: define test-name { json-properties }

Define a state report

test: state name { code block }

Define a unit test

test: unit function|private|open|event test-name { json-properties }

Enable or disable boolean test states (more options available in config)

test: config [ enable|!enable ] [ verbose|!verbose ] [ auto-report|!auto-report ]

Disable test mode

!test

Execute a function with testing enabled

test: run { code-block }

Execute unit test(s)

test: run package/module/test-name|*

Write report

test: report

Examples

Inlined test

function: hello-world {
    test: define example {
        "StdoutRegex": (^Hello World$)
    }

    out: <test_example> "Hello Earth"
}

test: run { hello-world }

Unit test

test: unit function aliases {
    "PreBlock": ({
        alias ALIAS_UNIT_TEST=example param1 param2 param3
    }),
    "StdoutRegex": "([- _0-9a-zA-Z]+ => .*?\n)+",
    "StdoutType": "str",
    "PostBlock": ({
        !alias ALIAS_UNIT_TEST
    })
}

function: aliases {
    # Output the aliases in human readable format
    runtime: --aliases -> formap: name alias {
        $name -> sprintf: "%10s => ${esccli @alias}\n"
    } -> cast: str
}

test: run aliases

Detail

Report

test: report is only needed if config: test auto-report is set false. However test: run automatically enables auto-report.

When the report is generated, be it automatically or manually triggered, it flushes the table of pending reports.

Synonyms

See Also

This site's content is rebuilt automatically from murex's source code after each merge to the master branch. Downloadable murex binaries are also built with the website.

Last built on Wed Jan 12 10:38:51 UTC 2022 against commit 50d6f4550d6f45b79e200b3cbc8e8e2639854a5265c7021.

Current version is 2.4.3010 BETA which has been verified against tests.