Introduction to the QorusInterfaceTest Module

The QorusInterfaceTest module provides functionality for automatic testing; it is based on the QUnit module from Qore.

Currently the module provides the following test classes:

QorusInterfaceTest: extension of the Qore QUnit module with functions testing Qorus-specific interfaces (abstract class)
- QorusJobTest: base class for testing jobs
- QorusPassiveWorkflowTest: class for testing workflows without starting execution instances (for example, for testing synchronous workflow orders, etc)
- QorusServiceTest: base class for testing services
- QorusWorkflowTest: base class for testing workflows, will automatically start execution instances if not already running
Action: abstract class representing some action
- CreateFile: abstract class for input file
- CreateFileText: input text file
- CreateFileCsv: input csv file
- InsertDbTableRows: inserts one or more rows into DB table
  - InsertDbTableRow: insert a row into DB table
- DeleteDbTableData: delete data from DB table
- TruncateTable: truncate a DB table (delete all rows)
- AbstractRemoteDbSqlUtilAction: abstract base class for remote sqlutil streaming actions
  - AbstractRemoteDbSelectAction: abstract base class for streaming data from a remote DB
    - RemoteDbSelectAction: streams data from a remote DB and compares to expected row data
  - RemoteDbDeleteAction: deletes data in a remote datasource
  - RemoteDbRowSqlUtilAction: performs sqlutil-based streaming inserts or upserts of data in remote datasources in one or more tables in a single remote transaction
    - InsertRemoteDbTableRows: performs sqlutil-based streaming to insert rows in a single remote table
    - UpsertRemoteDbTableRows: performs sqlutil-based streaming to upsert (or merge) rows in a single remote table
- CallService: call any Qorus service method
- Sleep: wait action
- WaitForWfiid: wait for WFIID to be finished
- CreateOrder: creates order
- CheckFile: check whether some file exists
- CheckFileCsv: check csv file content
- CheckFileNonexisting: check whether some file doesn't exist
- ExecSynchronousOrder: creates and executes a synchronous workflow order
- StartLog: starts log stopwatch (i. e. from this time we will check log files)
- CheckLog: check whether log matches specified pattern
- CheckDbTableRows: check rows in a database
  - CheckDbTableRow: check a row in a database
- RunJob: invokes the given job and retrieves the result
  - RunJobResult: runs the given job and checks the result status and optionally the result job info hash

Additionally, the following helper class is provided:

WorkflowLogHelper: provides an API for displaying workflow logs during a test

To use this module, use "%requires QorusInterfaceTest" in your code.

Examples:

class MyJobTest inherits QorusJobTest {
    constructor() : QorusJobTest("my-job", "1.0", \ARGV) {
        addTestCase("my-test-1, \test1());
    }
 
    test1() {
        exec(new CreateFileText(input_filename, file_content));
        exec(new RunJobResult(OMQ::StatComplete));
    }
}

How to run tests

Make sure your scripts have the executable bit set (on UNIX systems) and an appropriate hash-bang as the first line (ex: "#!/usr/bin/env qr" or "#!/usr/bin/env qore".

If your script's name is test.qtest, then The following command should execute the script:

    test.qtest [OPTIONS]

See QorusInterfaceTest module in Qore for options, output formats and further details.

Release Notes

Version 5.1

aligned version number with Qorus
added constructors useful for Java and Python

Version 1.1

added QorusInterfaceTest::QorusInterfaceTest::setUserPassword() to allow child classes to set the REST username & password for the Qorus server connection before trying to communicate with the server

Version 1.0.1

minor adjustment to FindOrderByKey::run() for an info service key search method fix (a href="https://bugs.qoretechnologies.com/issues/2108">issue 2108)

Version 1.0

initial version of module

Table of Contents