lmtest.base package

Submodules

lmtest.base.controller module

Module containing test controller class.

class lmtest.base.controller.Controller(pidfile, log=None)

Bases: lmtest.base.daemon.Daemon

Test controller.

add_tests(new_tests)

Add a new test object to run.

Parameters

new_tests (list of LmTest) – A list of test objects to run.

initialize()

Initialize the test controller.

report()

Report the status of the tests that were ran in the last interval.

report_interval = 86400

rest(sleep_seconds=10)

Sleep before trying to run the next test.

Note: This is abstracted just a bit in case we want to sleep for

“smart” intervals, such as until the next test is scheduled to run.

Parameters

sleep_seconds (int, optional) – The number of seconds to sleep.

run()

Run the test controller until told to stop.

run_test(test_to_run)

Run a test and process the result.

Parameters

test_to_run (LmTest) – The test that should be run.

set_notifier(notifier)

Set the Controller instances notification method.

Parameters

notifier (Notifier) – The notifier to use for this instance.

set_report_interval(interval_seconds)

Set the Controller instances reporting interval.

Parameters

interval_seconds (int) – The number of seconds to wait between reports.

lmtest.base.daemon module

This module contains a base-Daemon class.

class lmtest.base.daemon.Daemon(pidfile, log=None)

Bases: object

A generic daemon class.

Usage: subclass the Daemon class and override the run() method

daemonize()

Do the UNIX double-fork magic.

See:

Stevens’ “Advanced Programming in the UNIX Environment”

(ISBN 0201563177) http://www.erlenstar.demon.co.uk/unix/faq_2.html#SEC16

delpid()

Clean up by removing PID file.

initialize()

Initialize the daemon process.

on_shutdown()

Perform a graceful shutdown operation of the daemon process.

on_update()

Do whatever is necessary to update the daemon.

restart()

Restart the daemon.

run()

Run the daemon process.

start()

Start the daemon.

status()

Check the status of the daemon.

stop()

Stop the daemon.

Raises

Exception – Raised if the PID file cannot be deleted.

update()

Signal a running process to update itself.

Send a signal to the running process to have it update itself. This update is defined by the subclass and could mean re-reading a configuration file, checking the environment, or something else.

class lmtest.base.daemon.DaemonCommands

Bases: object

Class containing command constants.

RESTART = 'restart'

START = 'start'

STOP = 'stop'

lmtest.base.test_base module

Base classes for Lifemapper tests.

class lmtest.base.test_base.LmTest(delay_time=0)

Bases: object

Base class for tests.

add_new_test(test)

Add a new test to run based on the current test status.

Parameters

test (LmTest) – A new test to run based on the result of this test.

get_new_tests()

Get the new tests generated by the current test.

Returns

A list of newly generated tests.

Return type

list of LmTest

static run_test()

Run the test.

Raises

LmTestFailure – Raised if the test fails.

exception lmtest.base.test_base.LmTestFailure

Bases: Exception

Exception class to raise when a test fails.

exception lmtest.base.test_base.LmTestWarning

Bases: Warning

Warning class to raise when a test ends in a warning status.

lmtest.base.test_finder module

Module containing tools for finding and importing tests.

lmtest.base.test_finder.find_tests(test_dir)

Find tests specified in JSON files in test_dir.

Parameters

test_dir (str) – Directory containing JSON test configuration files.

Returns

A list of LmTest testing objects.

Return type

list

Module contents

Package containing base classes for lmtest.