xray

xray is a framework for writing XQuery unit tests on MarkLogic Server. Test cases are written as standard XQuery functions like this:

declare function string-equality-example()
{
  let $foo := "foo"
  return assert:equal($foo, "foo")
};

Getting Started

• Clone/copy/symlink xray into the root directory of your project e.g.
  git clone git://github.com/robwhitby/xray.git
  or
  git submodule add git://github.com/robwhitby/xray.git
• Create an HTTP app server pointing to the root directory of your project.
• Check all is well at http://server:port/xray/
• Write some tests..

Writing Tests

Tests are grouped into library modules in the xray test namespace. Import the xray assertions module along with the modules to be tested.

xquery version "1.0-ml";
module namespace test = "http://github.com/robwhitby/xray/test";
import module namespace assert = "http://github.com/robwhitby/xray/assertions" at "/xray/src/assertions.xqy";

import module namespace some-module = "http://some-module-to-test" at "/some-module-to-test.xqy";

declare function string-equality-example()
{
  let $foo := some-module:foo()
  return assert:equal($foo, "foo")
};

declare function multiple-assert-example()
{
  let $foo := some-module:foo()
  let $bar := "bar"
  return (
    assert:not-empty($foo),
    assert:equal($foo, "foo"),
    assert:not-equal($foo, $bar)
  )
};

(: more tests :)

Invoking Tests

xray will find and execute all the test cases defined in a directory (including sub-directories), and can be told to execute a subset by specifying regex patterns to match tests by module name or test name.

• browser - http://server:port/xray/
• command line - test-runner.sh is a sample shell script, edit the default vars (tested on OSX only).
• invoke from xquery - import src/xray.xqy and call xray:run-tests(). See index.xqy for example.

Parameters

dir - test directory path relative from the app server modules root. Optional, defaults to "test".

modules - regex match on module name. Optional, default to match all.

tests - regex match on test name. Optional, defaults to match all.

format - set output format to html, xml or text. Optional, defaults to html.

Assertions

assert:equal($actual as item()*, $expected as item()*)

assert:not-equal($actual as item()*, $expected as item()*)

assert:empty($actual as item()*)

assert:not-empty($actual as item()*)

assert:error($actual as item()*, $expected-error-name as xs:string)

assert:true($actual as item()*)

assert:false($actual as item()*)

See src/assertions.xqy for the assertion definitions.

Setup and teardown functions

setup() and teardown() are special function signatures. If defined, setup() is invoked before any tests, and in a different transaction so any database updates are visible to the tests. teardown() is executed after all tests in that module have finished.

See test/tests.xqy for an example.

Ignoring Tests

Tests can be ignored by addding the prefix IGNORE to the test function name.

declare function IGNORE-this-test-will-be-ignored()

MarkLogic Configuration

The app server user must belong to a role with the following execute privileges: xdmp:eval, xdmp:filesystem-directory, xdmp:filesystem-file, xdmp:invoke, xdmp:xslt-invoke

To work with modules stored in a modules database, the additional privileges are required: xdmp:eval-in And the user must have read rights to files in the modules db.

Test modules must be written in XQuery version "1.0-ml" to be parsed correctly.

Acknowledgements

Thanks to Gunther Rademacher's REx Parser Generator and John Snelson for the XQuery 1.0-ml parser.

 

Screenshots