diff options
Diffstat (limited to 'buildscripts/resmokelib/testing/hooks/jsfile.py')
-rw-r--r-- | buildscripts/resmokelib/testing/hooks/jsfile.py | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/buildscripts/resmokelib/testing/hooks/jsfile.py b/buildscripts/resmokelib/testing/hooks/jsfile.py index 76b2de31313..e95d3d6d780 100644 --- a/buildscripts/resmokelib/testing/hooks/jsfile.py +++ b/buildscripts/resmokelib/testing/hooks/jsfile.py @@ -1,7 +1,4 @@ -""" -Interface for customizing the behavior of a test fixture by executing a -JavaScript file. -""" +"""Interface for customizing the behavior of a test fixture by executing a JavaScript file.""" from __future__ import absolute_import @@ -16,19 +13,23 @@ class JSHook(interface.Hook): REGISTERED_NAME = registry.LEAVE_UNREGISTERED - def __init__(self, hook_logger, fixture, js_filename, description, shell_options=None): + def __init__( # pylint: disable=too-many-arguments + 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): # pylint: disable=no-self-use - """ + """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 @@ -49,6 +50,7 @@ class DataConsistencyHook(JSHook): 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: @@ -58,23 +60,29 @@ class DataConsistencyHook(JSHook): class DynamicJSTestCase(interface.DynamicTestCase): """A dynamic TestCase that runs a JavaScript file.""" - def __init__(self, logger, test_name, description, base_test_name, hook, js_filename, - shell_options=None): + def __init__( # pylint: disable=too-many-arguments + self, logger, test_name, description, base_test_name, hook, js_filename, + shell_options=None): + """Initialize DynamicJSTestCase.""" interface.DynamicTestCase.__init__(self, logger, test_name, description, base_test_name, hook) self._js_test = jstest.JSTestCase(logger, js_filename, shell_options=shell_options) def override_logger(self, new_logger): + """Override logger.""" interface.DynamicTestCase.override_logger(self, new_logger) self._js_test.override_logger(new_logger) def reset_logger(self): + """Reset the logger.""" interface.DynamicTestCase.reset_logger(self) self._js_test.reset_logger() def configure(self, fixture, *args, **kwargs): # pylint: disable=unused-argument + """Configure the fixture.""" interface.DynamicTestCase.configure(self, fixture, *args, **kwargs) self._js_test.configure(fixture, *args, **kwargs) def run_test(self): + """Execute the test.""" self._js_test.run_test() |