schrodinger.test.stu.base_executable module

Base class for STU utilities. Each utility should probably implement getParser and _doCommand

@copyright: Schrodinger, Inc. All rights reserved.

class schrodinger.test.stu.base_executable.store_server(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

Bases: argparse.Action

Argparse action to monkeypatch the server address.

__init__(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

Initialize self. See help(type(self)) for accurate signature.

class schrodinger.test.stu.base_executable.TestRunnerParser(present_tense, past_tense, *args, **kwargs)

Bases: argparse.ArgumentParser

Subclass that allows easy adding of options.

__init__(present_tense, past_tense, *args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

addSkipArg()

addTestIDArg()

addExtractArgs()

addDirectories(required=False, noscratch=False)

addExpandArg()

addTestLimitations()

addCPUArg()

addForce()

addExecuteOptions()

addVerbosityArgs()

addServerArg(user_option=True)

addJobControlOptions()

add_argument(dest, ..., name=value, ...)

add_argument(option_string, option_string, …, name=value, …)

add_argument_group(*args, **kwargs)

add_mutually_exclusive_group(**kwargs)

add_subparsers(**kwargs)

convert_arg_line_to_args(arg_line)

error(message: string)

Prints a usage message incorporating the message to stderr and exits.

If you override this in a subclass, it should not return – it should either exit or raise an exception.

exit(status=0, message=None)

format_help()

format_usage()

get_default(dest)

parse_args(args=None, namespace=None)

parse_intermixed_args(args=None, namespace=None)

parse_known_args(args=None, namespace=None)

parse_known_intermixed_args(args=None, namespace=None)

print_help(file=None)

print_usage(file=None)

register(registry_name, value, object)

set_defaults(**kwargs)

class schrodinger.test.stu.base_executable.TestUtility(arguments=None)

Bases: object

present_tense = None

past_tense = None

__init__(arguments=None)

Initialize self. See help(type(self)) for accurate signature.

printHeader()

Print header

printFooter()

getParser(prog=None, description=None)

Return type

argparse.ArgumentParser

getOptions(arguments=None, user_option=True)

getTests()

Get the TestScript objects required based on the mode.

runJobs(inscratch=False)

Parameters

• report – Should results be reported to the DB?

• inscratch – Should the tests be copied to a scratch directory before execution?

Returns

Did test execution complete as expected?

Return type

bool

printRunSummary(runner)

printOnlyFailed(tests)

printTestNumbers(test_ids)

requireApiKey(parser)