SERVER-75596 Invoke $telemetry in the background of telemetry suite.

4 files changed, 89 insertions, 58 deletions

diff --git a/buildscripts/resmokelib/testing/hooks/aggregate_metrics_background.py b/buildscripts/resmokelib/testing/hooks/aggregate_metrics_background.py
index d392c6ae0b8..b49030ff0f4 100644
--- a/buildscripts/resmokelib/testing/hooks/aggregate_metrics_background.py
+++ b/buildscripts/resmokelib/testing/hooks/aggregate_metrics_background.py
@@ -6,68 +6,17 @@ internally sleep for 1 second between runs.
 
 import os.path
 
-from buildscripts.resmokelib import errors
-from buildscripts.resmokelib.testing.hooks import jsfile
-from buildscripts.resmokelib.testing.hooks.background_job import _BackgroundJob, _ContinuousDynamicJSTestCase
+from buildscripts.resmokelib.testing.hooks.background_job import BackgroundRepeatedJsHook
 
 
-class AggregateResourceConsumptionMetricsInBackground(jsfile.JSHook):
+class AggregateResourceConsumptionMetricsInBackground(BackgroundRepeatedJsHook):
     """A hook to run $operationMetrics stage in the background."""
 
-    IS_BACKGROUND = True
-
     def __init__(self, hook_logger, fixture, shell_options=None):
         """Initialize AggregateResourceConsumptionMetricsInBackground."""
+
         description = "Run background $operationMetrics on all mongods while a test is running"
         js_filename = os.path.join("jstests", "hooks", "run_aggregate_metrics_background.js")
-        jsfile.JSHook.__init__(self, hook_logger, fixture, js_filename, description,
-                               shell_options=shell_options)
-        self._background_job = None
-
-    def before_suite(self, test_report):
-        """Start the background thread."""
-        self._background_job = _BackgroundJob("AggregateResourceConsumptionMetricsInBackground")
-        self.logger.info("Starting the background aggregate metrics thread.")
-        self._background_job.start()
-
-    def after_suite(self, test_report, teardown_flag=None):
-        """Signal the background aggregate metrics thread to exit, and wait until it does."""
-        if self._background_job is None:
-            return
-
-        self.logger.info("Stopping the background aggregate metrics thread.")
-        self._background_job.stop()
-
-    def before_test(self, test, test_report):
-        """Instruct the background aggregate metrics thread to run while 'test' is also running."""
-        if self._background_job is None:
-            return
-
-        hook_test_case = _ContinuousDynamicJSTestCase.create_before_test(
-            test.logger, test, self, self._js_filename, self._shell_options)
-        hook_test_case.configure(self.fixture)
-
-        self.logger.info("Resuming the background aggregate metrics thread.")
-        self._background_job.resume(hook_test_case, test_report)
-
-    def after_test(self, test, test_report):  # noqa: D205,D400
-        """Instruct the background aggregate metrics thread to stop running now that 'test' has
-        finished running.
-        """
-        if self._background_job is None:
-            return
-
-        self.logger.info("Pausing the background aggregate metrics thread.")
-        self._background_job.pause()
-
-        if self._background_job.exc_info is not None:
-            if isinstance(self._background_job.exc_info[1], errors.TestFailure):
-                # If the mongo shell process running the JavaScript file exited with a non-zero
-                # return code, then we raise an errors.ServerFailure exception to cause resmoke.py's
-                # test execution to stop.
-                raise errors.ServerFailure(self._background_job.exc_info[1].args[0])
-            else:
-                self.logger.error(
-                    "Encountered an error inside the background aggregate metrics thread.",
-                    exc_info=self._background_job.exc_info)
-                raise self._background_job.exc_info[1]
+        super().__init__(hook_logger, fixture, js_filename, description,
+                         "AggregateResourceConsumptionMetricsInBackground",
+                         shell_options=shell_options)
diff --git a/buildscripts/resmokelib/testing/hooks/background_job.py b/buildscripts/resmokelib/testing/hooks/background_job.py
index b01196ba462..d239df4f6eb 100644
--- a/buildscripts/resmokelib/testing/hooks/background_job.py
+++ b/buildscripts/resmokelib/testing/hooks/background_job.py
@@ -3,6 +3,7 @@
 import sys
 import threading
 
+from buildscripts.resmokelib import errors
 from buildscripts.resmokelib.testing.hooks import jsfile
 
 
@@ -98,3 +99,63 @@ class _ContinuousDynamicJSTestCase(jsfile.DynamicJSTestCase):
         last one. This method returns without waiting for the current execution to finish.
         """
         self._should_stop.set()
+
+
+class BackgroundRepeatedJsHook(jsfile.JSHook):
+    """A hook to run a js file on repeat in the background."""
+
+    IS_BACKGROUND = True
+
+    def __init__(self, hook_logger, fixture, js_filename, description, thread_name,
+                 shell_options=None):
+        """Initialize BackgroundRepeatedJsHook."""
+        super().__init__(hook_logger, fixture, js_filename, description,
+                         shell_options=shell_options)
+        self._background_job = None
+        self._thread_name = thread_name
+
+    def before_suite(self, test_report):
+        """Start the background thread."""
+        self._background_job = _BackgroundJob(self._thread_name)
+        self.logger.info("Starting background thread: {}.".format(self._thread_name))
+        self._background_job.start()
+
+    def after_suite(self, test_report, teardown_flag=None):
+        """Signal the background thread to exit, and wait until it does."""
+        if self._background_job is None:
+            return
+
+        self.logger.info("Stopping background thread: {}.".format(self._thread_name))
+        self._background_job.stop()
+
+    def before_test(self, test, test_report):
+        """Instruct the background thread to run while 'test' is also running."""
+        if self._background_job is None:
+            return
+
+        hook_test_case = _ContinuousDynamicJSTestCase.create_before_test(
+            test.logger, test, self, self._js_filename, self._shell_options)
+        hook_test_case.configure(self.fixture)
+
+        self.logger.info("Resuming background thread: {}.".format(self._thread_name))
+        self._background_job.resume(hook_test_case, test_report)
+
+    def after_test(self, test, test_report):  # noqa: D205,D400
+        """Instruct the background thread to stop running now that 'test' has finished running."""
+        if self._background_job is None:
+            return
+
+        self.logger.info("Pausing background thread: {}.".format(self._thread_name))
+        self._background_job.pause()
+
+        if self._background_job.exc_info is not None:
+            if isinstance(self._background_job.exc_info[1], errors.TestFailure):
+                # If the mongo shell process running the JavaScript file exited with a non-zero
+                # return code, then we raise an errors.ServerFailure exception to cause resmoke.py's
+                # test execution to stop.
+                raise errors.ServerFailure(self._background_job.exc_info[1].args[0])
+            else:
+                self.logger.error(
+                    "Encountered an error inside background thread {}.".format(self._thread_name),
+                    exc_info=self._background_job.exc_info)
+                raise self._background_job.exc_info[1]
diff --git a/buildscripts/resmokelib/testing/hooks/jsfile.py b/buildscripts/resmokelib/testing/hooks/jsfile.py
index 7489968d834..9a27f5298c1 100644
--- a/buildscripts/resmokelib/testing/hooks/jsfile.py
+++ b/buildscripts/resmokelib/testing/hooks/jsfile.py
@@ -1,8 +1,8 @@
 """Interface for customizing the behavior of a test fixture by executing a JavaScript file."""
 
 from buildscripts.resmokelib import errors
-from buildscripts.resmokelib.testing.hooks import interface
 from buildscripts.resmokelib.testing.fixtures.interface import MultiClusterFixture
+from buildscripts.resmokelib.testing.hooks import interface
 from buildscripts.resmokelib.testing.testcases import jstest
 from buildscripts.resmokelib.utils import registry
 
diff --git a/buildscripts/resmokelib/testing/hooks/run_telemetry.py b/buildscripts/resmokelib/testing/hooks/run_telemetry.py
new file mode 100644
index 00000000000..ac008180339
--- /dev/null
+++ b/buildscripts/resmokelib/testing/hooks/run_telemetry.py
@@ -0,0 +1,21 @@
+"""
+Test hook for verifying $telemetry collects expected metrics and can redact query shapes.
+
+This runs in the background as other tests are ongoing.
+"""
+import os.path
+
+from buildscripts.resmokelib.testing.hooks.background_job import BackgroundRepeatedJsHook
+
+
+# Running in the background will better stress concurrency control with other operations.
+class RunTelemetry(BackgroundRepeatedJsHook):
+    """Periodically runs $telemetry."""
+
+    def __init__(self, hook_logger, fixture, shell_options=None):
+        """Initialize RunTelemetry."""
+
+        description = "Read telemetry data concurrently with ongoing tests"
+        js_filename = os.path.join("jstests", "hooks", "run_telemetry.js")
+        super().__init__(hook_logger, fixture, js_filename, description, "Telemetry",
+                         shell_options=shell_options)