toil.test.src.toilContextManagerTest

Classes

ToilContextManagerTest

A common base class for Toil tests.

HelloWorld

Class represents a unit of work in toil.

FollowOn

Class represents a unit of work in toil.

Functions

childFn(job)

Module Contents

class toil.test.src.toilContextManagerTest.ToilContextManagerTest(methodName='runTest')[source]

Bases: toil.test.ToilTest

A common base class for Toil tests.

Please have every test case directly or indirectly inherit this one.

When running tests you may optionally set the TOIL_TEST_TEMP environment variable to the path of a directory where you want temporary test files be placed. The directory will be created if it doesn’t exist. The path may be relative in which case it will be assumed to be relative to the project root. If TOIL_TEST_TEMP is not defined, temporary files and directories will be created in the system’s default location for such files and any temporary files or directories left over from tests will be removed automatically removed during tear down. Otherwise, left-over files will not be removed.

setUp()[source]

Hook method for setting up the test fixture before exercising it.

tearDown()[source]

Hook method for deconstructing the test fixture after testing it.

testContextManger()[source]
testNoContextManger()[source]
testExportAfterFailedExport()[source]
class toil.test.src.toilContextManagerTest.HelloWorld[source]

Bases: toil.job.Job

Class represents a unit of work in toil.

run(fileStore)[source]

Override this function to perform work and dynamically create successor jobs.

Parameters:

fileStore – Used to create local and globally sharable temporary files and to send log messages to the leader process.

Returns:

The return value of the function can be passed to other jobs by means of toil.job.Job.rv().

toil.test.src.toilContextManagerTest.childFn(job)[source]
class toil.test.src.toilContextManagerTest.FollowOn(fileId)[source]

Bases: toil.job.Job

Class represents a unit of work in toil.

fileId
run(fileStore)[source]

Override this function to perform work and dynamically create successor jobs.

Parameters:

fileStore – Used to create local and globally sharable temporary files and to send log messages to the leader process.

Returns:

The return value of the function can be passed to other jobs by means of toil.job.Job.rv().