apama.common

Contains PySys extensions required by IAF and correlator support.

ApamaServerProcess

class apama.common.ApamaServerProcess(parent, name, port=None, host=None)[source]

Bases: object

Abstract parent helper class for Apama server processes.

Variables

  • parent – Reference to the PySys pysys.basetest.BaseTest testcase (or pysys.process.user.ProcessUser) instantiating this instance.

  • port (int) – Port used for starting and interaction with the process. If no port parameter is used in the argument list an available port will be dynamically found from the OS and used for starting the process, and performing all operations against it.

  • host (str) – Hostname for interaction with a remote process. The host parameter is only used to perform operations against a remote process started externally to the PySys framework - the class does not support the starting of a remote process.

  • environ (dict(str,str)) – The environment for running the process

manage(arguments=[], displayName='manage', **xargs)[source]

Execute component_management operations against the process.

Parameters

  • arguments – The arguments to be passed to component_management

  • xargs – Optional startProcess keyword arguments, e.g. timeout, ignoreExitStatus, arguments, workingDir

running()[source]

Returns True if this has a local process that is running, or False if it has stopped, or was not started by this object.

shutdown(message='Shutdown requested by test', timeout=60, **args)[source]

Requests a clean shutdown of the component.

If it was started by this object, also waits for the process to terminate, and silently ignores requests to shutdown if the process was already stopped.

waitForComponentUp(timeout=60, **xargs)[source]

Block until the the component declares itself to be ready for processing.