mongo/buildscripts/resmokelib/testing/hooks/jsfile.py

128 lines
4.3 KiB
Python

"""Interface for customizing the behavior of a test fixture by executing a JavaScript file."""
from buildscripts.resmokelib import errors, logging
from buildscripts.resmokelib.testing.hooks import interface
from buildscripts.resmokelib.testing.testcases import jstest
from buildscripts.resmokelib.utils import registry
class JSHook(interface.Hook):
"""A hook with a static JavaScript file to execute."""
REGISTERED_NAME = registry.LEAVE_UNREGISTERED
def __init__(self, hook_logger, fixture, js_filename, description, shell_options=None):
"""Initialize JSHook."""
interface.Hook.__init__(self, hook_logger, fixture, description)
self._js_filename = js_filename
self._shell_options = shell_options
def _should_run_after_test(self):
"""Provide base callback.
Callback that can be overrided by subclasses to indicate if the JavaScript file should be
executed after the current test.
"""
return True
def after_test(self, test, test_report):
"""After test execution."""
if not self._should_run_after_test():
return
hook_test_case = DynamicJSTestCase.create_after_test(
test.logger, test, self, self._js_filename, self._shell_options
)
hook_test_case.configure(self.fixture)
hook_test_case.run_dynamic_test(test_report)
class DataConsistencyHook(JSHook):
"""
A hook for running a static JavaScript file that checks data consistency of the server.
If the mongo shell process running the JavaScript file exits with a non-zero return code, then
an errors.ServerFailure exception is raised to cause resmoke.py's test execution to stop.
"""
REGISTERED_NAME = registry.LEAVE_UNREGISTERED
def after_test(self, test, test_report):
"""After test execution."""
try:
JSHook.after_test(self, test, test_report)
except errors.TestFailure as err:
raise errors.ServerFailure(err.args[0])
class PerClusterDataConsistencyHook(DataConsistencyHook):
"""
A hook that runs on each independent cluster of the fixture.
The independent cluster itself may be another fixture.
"""
REGISTERED_NAME = registry.LEAVE_UNREGISTERED
def after_test(self, test, test_report):
"""After test execution."""
for cluster in self.fixture.get_independent_clusters():
self.logger.info(
"Running jsfile '%s' on '%s' with driver URL '%s'",
self._js_filename,
cluster,
cluster.get_driver_connection_url(),
)
hook_test_case = DynamicJSTestCase.create_after_test(
test.logger, test, self, self._js_filename, self._shell_options
)
hook_test_case.configure(cluster)
hook_test_case.run_dynamic_test(test_report)
class DynamicJSTestCase(interface.DynamicTestCase):
"""A dynamic TestCase that runs a JavaScript file."""
def __init__(
self,
logger: logging.Logger,
test_name: str,
description: str,
base_test_name: str,
hook,
js_filename: str,
shell_options=None,
):
"""Initialize DynamicJSTestCase."""
interface.DynamicTestCase.__init__(
self, logger, test_name, description, base_test_name, hook
)
self._js_test_builder = jstest.JSTestCaseBuilder(
logger,
[js_filename],
test_name=js_filename,
test_id=self.id(),
shell_options=shell_options,
)
self._js_test_case = None
def override_logger(self, new_logger: logging.Logger):
"""Override logger."""
interface.DynamicTestCase.override_logger(self, new_logger)
self._js_test_case.override_logger(new_logger)
def reset_logger(self):
"""Reset the logger."""
interface.DynamicTestCase.reset_logger(self)
self._js_test_case.reset_logger()
def configure(self, fixture, *args, **kwargs):
"""Configure the fixture."""
super().configure(fixture, *args, **kwargs)
self._js_test_builder.configure(fixture, *args, **kwargs)
self._js_test_case = self._js_test_builder.create_test_case_for_thread(self.logger)
def run_test(self):
"""Execute the test."""
self._js_test_case.run_test()