pyworkflow.tests.tests module

class pyworkflow.tests.tests.BaseTest(methodName='runTest')

Bases: TestCase

Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

assertIsNotEmpty(setObject, msg=None)

Check if the pyworkflow object is not None nor is empty

assertSetSize(setObject, size=None, msg=None, diffDelta=None)

Check if a pyworkflow Set is not None nor is empty, or of a determined size or of a determined size with a percentage (base 1) of difference

compareSetProperties(set1: Set, set2: Set, ignore=['_size', '_mapperPath'])

Compares 2 sets’ properties

classmethod compareSets(test, set1, set2)

Iterate the elements of both sets and check that all elements have equal attributes.

classmethod getOutputPath(*filenames)

Return the path to the SCIPION_HOME/tests/output dir joined with filename

classmethod getRelPath(basedir, filename)

Return the path relative to SCIPION_HOME/tests

classmethod launchProtocol(prot, **kwargs)

Launch a given protocol using cls.proj.

Parameters

• wait – if True the function will return after the protocol runs. If not specified, then if waitForOutput is passed, wait is false.

• waitForOutputs – a list of expected outputs, ignored if wait=True

classmethod newProtocol(protocolClass: T, **kwargs) → T

Create new protocols instances through the project and return a newly created protocol of the given class

static printLastLogLines(prot)

Prints the last log lines (50 or ‘PROT_LOGS_LAST_LINES’ env variable) from stdout and stderr log files

Parameters

prot – Protocol to take the logs from

classmethod saveProtocol(prot)

Saves a protocol using cls.proj

classmethod setupTestOutput()

class pyworkflow.tests.tests.DataSet(name, folder, files, url=None)

Bases: object

Params:

#filesDict is dict with key, value pairs for each file

classmethod getDataSet(name)

This method is called every time the dataset want to be retrieved

getFile(key)

getPath()

class pyworkflow.tests.tests.GTestResult

Bases: TestResult

Subclass TestResult to output tests results with colors (green for success and red for failure) and write a report on an .xml file.

addError(test, err)

Called when an error has occurred. ‘err’ is a tuple of values as returned by sys.exc_info().

addFailure(test, err)

Called when an error has occurred. ‘err’ is a tuple of values as returned by sys.exc_info().

addSuccess(test)

Called when a test has completed successfully

doReport()

static getTestName(test)

numberTests = 0

openXmlReport(classname, filename)

reportError(test, err)

startTest(test)

Called when the given test is about to be run

testFailed = 0

tic()

toc()

xml = None

pyworkflow.tests.tests.hasLabel(TestClass, labels)

pyworkflow.tests.tests.setupTestOutput(cls)

Create the output folder for a give Test class.

pyworkflow.tests.tests.setupTestProject(cls, writeLocalConfig=False)

Create and setup a Project for a give Test class.