Function initialize

Web/Python/vtkmodules/web/testing.py:115–173

This function should be called to initialize the testing module. The first important thing it does is to store the options for later, since the startTestThread function will need them. Then it checks the arguments that were passed into the server to see if a test was actually requ

(opts, reactor=None, cleanupMethod=None)

# Checks whether test script supplied, if so, safely imports needed modules
# =============================================================================
def initialize(opts, reactor=None, cleanupMethod=None):
    """
    This function should be called to initialize the testing module.  The first
    important thing it does is to store the options for later, since the
    startTestThread function will need them.  Then it checks the arguments that
    were passed into the server to see if a test was actually requested, making
    a note of this fact.  Then, if a test was required, this function then
    checks if all the necessary testing modules were safely imported, printing
    a warning if not.  If tests were requested and all modules were present,
    then this function sets "test_module_do_testing" to True and sets up the
    startTestThread function to be called after the reactor is running.

        opts: Parsed arguments from the server

        reactor: This argument is optional, but is used by server.py to
        cause the test thread to be started only after the server itself
        has started.  If it is not provided, the test thread is launched
        immediately.

        cleanupMethod: A callback method you would like the test thread
        to execute when the test has finished.  This is used by server.py
        as a way to have the server terminated after the test has finished,
        but could be used for other cleanup purposes.  This argument is
        also optional.
    """

    global import_warning_info

    global testModuleOptions
    testModuleOptions = Dictionary()

    # Copy the testing options into something we can easily extend
    for arg in vars(opts):
        optValue = getattr(opts, arg)
        testModuleOptions[arg] = optValue

    # If we got one, add the cleanup method to the testing options
    if cleanupMethod:
        testModuleOptions["cleanupMethod"] = cleanupMethod

    # Check if a test was actually requested
    if (
        testModuleOptions.testScriptPath != ""
        and testModuleOptions.testScriptPath is not None
    ):
        # Check if we ran into trouble with any of the testing imports
        if import_warning_info != "":
            print("WARNING: Some tests may have unmet dependencies")
            print(import_warning_info)

        if reactor is not None:
            # Add startTest callback to the reactor callback queue, so that
            # the test thread gets started after the reactor is running.  Of
            # course this should only happen if everything is good for tests.
            reactor.callWhenRunning(_start_test_thread)
        else:
            # Otherwise, our aim is to start the thread from another process
            # so just call the start method.