Function launch_web_test

Web/Python/vtkmodules/web/testing.py:644–751

This function loads a python file as a module (with no package), and then instantiates the class it must contain, and finally executes the run_test() method of the class (which the class may override, but which is defined in both of the testing base classes, WebTest and ImageCompara

(*args, **kwargs)

# paraview or vtk web application service.
# =============================================================================
def launch_web_test(*args, **kwargs):
    """
    This function loads a python file as a module (with no package), and then
    instantiates the class it must contain, and finally executes the run_test()
    method of the class (which the class may override, but which is defined in
    both of the testing base classes, WebTest and ImageComparatorBaseClass).
    After the run_test() method finishes, this function will stop the web
    server if required.  This function expects some keyword arguments will be
    present in order for it to complete it's task:

        kwargs['serverOpts']: An object containing all the parameters used
        to start the web service.  Some of them will be used in the test script
        in order perform the test.  For example, the port on which the server
        was started will be required in order to connect to the server.

        kwargs['testScript']: The full path to the python file containing the
        testing subclass.
    """

    serverOpts = None
    testScriptFile = None

    # This is really the thing all test scripts will need: access to all
    # the options used to start the server process.
    if "serverOpts" in kwargs:
        serverOpts = kwargs["serverOpts"]
        # print 'These are the serverOpts we got: '
        # print serverOpts

    # Get the full path to the test script
    if "testScript" in kwargs:
        testScriptFile = kwargs["testScript"]

    testName = "unknown"

    # Check for a test file (python file)
    if testScriptFile is None:
        print("No test script file found, no test script will be run.")
        test_fail(testName)

    # The test name will be generated from the python script name, so
    # match and capture a bunch of contiguous characters which are
    # not '.', '\', or '/', followed immediately by the string '.py'.
    fnamePattern = re.compile("([^\.\/\\\]+)\.py")
    fmatch = re.search(fnamePattern, testScriptFile)
    if fmatch:
        testName = fmatch.group(1)
    else:
        print(
            "Unable to parse testScriptFile ("
            + str(testScriptfile)
            + "), no test will be run"
        )
        test_fail(testName)

    # If we successfully got a test name, we are ready to try and run the test
    if testName != "unknown":