toil.test.src.helloWorldTest

Module Contents

Classes

HelloWorldTest	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)

class toil.test.src.helloWorldTest.HelloWorldTest(methodName='runTest')

Bases: toil.test.ToilTest

digraph inheritancea8fc5ead9c { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "HelloWorldTest" [URL="#toil.test.src.helloWorldTest.HelloWorldTest",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ToilTest" -> "HelloWorldTest" [arrowsize=0.5,style="setlinewidth(0.5)"]; "TestCase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A class whose instances are single test cases."]; "ToilTest" [URL="../../index.html#toil.test.ToilTest",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A common base class for Toil tests."]; "TestCase" -> "ToilTest" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

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.

testHelloWorld()

class toil.test.src.helloWorldTest.HelloWorld

Bases: toil.job.Job

digraph inheritancee0e274626d { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "HelloWorld" [URL="#toil.test.src.helloWorldTest.HelloWorld",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Job" -> "HelloWorld" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Job" [URL="../../../job/index.html#toil.job.Job",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class represents a unit of work in toil."]; }

Class represents a unit of work in toil.

run(fileStore)

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.helloWorldTest.childFn(job)

class toil.test.src.helloWorldTest.FollowOn(fileId)

Bases: toil.job.Job

digraph inheritance983ce7c664 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "FollowOn" [URL="#toil.test.src.helloWorldTest.FollowOn",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Job" -> "FollowOn" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Job" [URL="../../../job/index.html#toil.job.Job",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class represents a unit of work in toil."]; }

Class represents a unit of work in toil.

run(fileStore)

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().