Scroll ignore

scroll-viewport	false
scroll-pdf	true
scroll-office	false
scroll-chm	true
scroll-docbook	true
scroll-eclipsehelp	true
scroll-epub	true
scroll-html	false

In addition to the Python functions described in Functions, Exceptions, Types, and Constants, the following functions are available for Unit Tests.

Image Added does not include any native assert functionality, this functionality can be found in the common python libraries. Add the Python Module and use in the unit test.

Note

Note!

To access the Unit Test functions described below from a Python Module you can import the testkit module. This is useful when you write test-related helper functions.

Finalizers

addFinalizer

This function adds a finalizer function to be called at scope exit.

Code Block

language	py

def addFinalizer(func, *args, **kwargs)

Parameter	Description
func	A function
*args	Positional arguments to be passed to the function
**kwargs	Keyword arguments to be passed to the function
Returns	An object with a remove() method

Info

title	Example - addFinalizer

Code Block

language	py

res = createResource()
addFinalizer(res.destroy)

finalizers

A Python context manager that defines an extra finalization scope. There are two pre-defined finalization scopes; one on the module level and one for each test function. These two scopes should be enough for normal use.

Info

title	Example - finalizers

Code Block

language	py

with finalizers:
    res = createResource()
    addFinalizer(res.destroy)
    ...
# res.destroy() is called at 'with scope' exit.

Conditional testing

SkipException

Tests can be skipped by raising the SkipException exception in the test function blocks, or the initialize function block.

Code Block

language	py

class SkipException(message=None)

Parameter	Type
message	str

Info

title	Example - SkipException

Code Block

language	py

def initialize():
    raise SkipException('All tests are skipped')

def test():
    raise SkipException('This test is skipped')

Log functions

logSearch

Searches for entries in the System Log matching the given criteria. Returns an iterator with all matching entries.

Code Block

language	py

def logSearch(fromDate=None, toDate=None, severities=None, areas=None, wfName=None, wfGroupName=None, agentName=None, userName=None, message=None)

Parameter	Type
fromDate	drdate
toDate	drdate
severities	list[str]
areas	list[str]
wfName	str
wfGroupName	str
agentName	str
userName	str
message	str

Info

title	Example - logSearch

Code Block

language	py

def test():
    myit = logSearch(fromDate=drdate('2021-01-26 16:00:00.0 UTC'), toDate=drdate('2021-01-30 23:59:59.0 UTC'))
	for logEntry in myit:
		print(logEntry)

logRemove

Removes the log entry with the specified id.

Code Block

language	py

def logRemove(id)

Parameter	Type
id	str

Workflow functions

These functions are event driven, meaning that an event is fired when the function is called. This means that if you use wfStart and immediately call wfIsRunning after it might return false as the workflow has yet to start. It might be necessary to loop over some of these functions while waiting for the status to changed.

wfAdd

Adds a new workflow to an existing workflow template.

Code Block

language	py

def wfAdd(wfName, parameters=None)

Parameter	Type
wfName	str
parameters	dict[str, any]

Info

title	Example - wfAdd

Code Block

language	py

def test():
     # Add a workflow
     wfAdd('Default.test.workflow_1')

or

Code Block

language	py

def test(): 
    # Add a workflow and specify parameter values
    wfAdd('Default.test.workflow_1', {'Time Unit': 'SECONDS', 'Interval': 4})

wfDelete

Deletes a workflow.

Code Block

language	py

def wfDelete(wfName)

Parameter	Type
wfName	str

Info

title	Example - wfDelete

Code Block

language	py

def test():
	wfDelete('Default.test.workflow_1')

wfExists

Returns True if the workflow exists.

Code Block

language	py

def wfExists(wfName)

Parameter	Type
wfName	str

Info

title	Example - wfExists

Code Block

language	py

def test():
	wfExists('Default.test.workflow_1')

wfStart

Starts the workflow. If successful, the workflow has been started but may not yet be running.

Code Block

language	py

def wfStart(wfName, ec=None)

Parameter	Type
wfName	str
ec	str

Info

title	Example - wfStart

Code Block

language	py

def test():
    # Starts the workflow on the default EC
	wfStart('Default.test.workflow_1')

or

Code Block

language	py

def test():
    # Starts the workflow on ec1
	wfStart('Default.test.workflow_1', ec='ec1')

wfSetDebugMode

Sets the workflow debug mode.

Debug mode can be set before starting the workflow or after it has become running.

Code Block

language	py

def wfSetDebugMode(wfName, on)

Parameter	Type
wfName	str
on	bool

Info

title	Example - wfSetDebugMode

Code Block

language	py

def test():
    wfSetDebugMode('Default.test.workflow_1', True)
	wfStart('Default.test.workflow_1')

or

Code Block

language	py

def test():
	wfStart('Default.test.workflow_1')
	# Wait until wf is running
    wfSetDebugMode('Default.test.workflow_1', True)

wfIsCompleted

Returns True if the workflow completed.

Code Block

language	py

def wfIsCompleted(wfName)

Parameter	Type
wfName	str

Info

title	Example - wfIsCompleted

Code Block

language	py

def test():
    wfIsCompleted('Default.test.workflow_1') # False
	wfStart('Default.test.workflow_1')
    wfIsCompleted('Default.test.workflow_1') # False
	wfStop('Default.test.workflow_1')
	# Wait a sec for the workflow to actually stop
    wfIsCompleted('Default.test.workflow_1') # True

wfIsRunning

Returns True if the workflow is running.

Code Block

language	py

def wfIsRunning(wfName)

Parameter	Type
wfName	str

Info

title	Example - wfIsRunning

Code Block

language	py

def test():
    wfIsRunning('Default.test.workflow_1') # False
	wfStart('Default.test.workflow_1')
	# Wait for the workflow to actually start
    wfIsRunning('Default.test.workflow_1') # True
	wfStop('Default.test.workflow_1')
    wfIsRunning('Default.test.workflow_1') # False

wfIsAborted

Returns True if the workflow aborted.

Code Block

language	py

def wfIsAborted(wfName)

Parameter	Type
wfName	str

wfAbortMessage

Returns the workflow abort message, if any.

Code Block

language	py

def wfAbortMessage(wfName)

Parameter	Type
wfName	str

Info

title	Example - wfAbortMessage

Code Block

language	py

def test():
    if wfIsAborted('Default.test.workflow_1'):
    	print(wfAbortMessage('Default.test.workflow_1'))
	else:
		pass # do something

Event functions

Below is a general example for all event functions.

Our workflow ('Default.test.workflow_1') used in the example below is a simple workflow with a pulse agent connecting to an analysis agent where we debug the input.

For information on how to format the filter see: Event Types(3.0).

Info

title	Example - Event functions

Code Block

language	py

def test():
    # Create an event buffer for our test workflow
    eventBuffer = eventBufferCreate(filter=dict(eventName='Debug Event', workflowName='Default.test.workflow_1'), ttl=60)
    
    # Make sure we are debugging as the filter is looking for debug events
    wfSetDebugMode('Default.test.workflow_1', True)
    # Start the workflow
    wfStart('Default.test.workflow_1')
    # Wait until some events have been produced
    # and then search the buffer
    events = eventBufferSearch(eventBuffer)
    
    for x in events:
        # Print only the agent message from the event iterator
        print(x.agentMessage)
        
    # Optionally destroy the buffer
    # it will be destroyed at the end of scope otherwise
    eventBufferDestroy(eventBuffer)

eventBufferCreate

Creates an event buffer where events matching filter are stored in memory for later inspection.
Returns the event buffer to be used in calls to other event buffer functions.

Code Block

language	py

def eventBufferCreate(filter=None, ttl=None, maxSize=None)

Parameter	Type
filter	dict[str, any]
ttl	float
maxSize	int

eventBufferDestroy

Destroys the event buffer and releases any resources associated with it.

Code Block

language	py

def eventBufferDestroy(buffer)

Parameter	Type
buffer	object

eventBufferSearch

Searches for events in the event buffer matching filter.
Returns an iterator with all currently matching events, with most recent event first.

Code Block

language	py

def eventBufferSearch(buffer, filter=None)

Parameter	Type
buffer	object
filter	dict[str, any]

Version	Old Version 1	New Version 2
Changes made by	Kevin Wu	Kevin Wu
Saved on	Jun 15, 2023	Jun 15, 2023

Page Comparison

Versions Compared

Key

Finalizers

addFinalizer

finalizers

Conditional testing

SkipException

Log functions

logSearch

logRemove

Workflow functions

wfAdd

wfDelete

wfExists

wfStart

wfSetDebugMode

wfIsCompleted

wfIsRunning

wfIsAborted

wfAbortMessage

Event functions

eventBufferCreate

eventBufferDestroy

eventBufferSearch