X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=tests%2Futils%2Flttngtest%2Fenvironment.py;h=60c42f51cb472bb89b3aa1953c9a4a0ba65e3007;hb=4bd882052fefabc67c7390e659929d54283ac9b9;hp=e71e588df80dfdfcfd14290547cf73cad77c2716;hpb=ce8470c9d039c563167d4fd061803e9eacf69ec3;p=lttng-tools.git diff --git a/tests/utils/lttngtest/environment.py b/tests/utils/lttngtest/environment.py index e71e588df..60c42f51c 100644 --- a/tests/utils/lttngtest/environment.py +++ b/tests/utils/lttngtest/environment.py @@ -6,7 +6,7 @@ # from types import FrameType -from typing import Callable, Iterator, Optional, Tuple, List +from typing import Callable, Iterator, Optional, Tuple, List, Generator import sys import pathlib import signal @@ -63,8 +63,21 @@ class _SignalWaitQueue: def wait_for_signal(self): self._queue.get(block=True) - -class WaitTraceTestApplication: + @contextlib.contextmanager + def intercept_signal(self, signal_number): + # type: (int) -> Generator[None, None, None] + original_handler = signal.getsignal(signal_number) + signal.signal(signal_number, self.signal) + try: + yield + except: + # Restore the original signal handler and forward the exception. + raise + finally: + signal.signal(signal_number, original_handler) + + +class _WaitTraceTestApplication: """ Create an application that waits before tracing. This allows a test to launch an application, get its PID, and get it to start tracing when it @@ -77,20 +90,37 @@ class WaitTraceTestApplication: event_count, # type: int environment, # type: Environment wait_time_between_events_us=0, # type: int + wait_before_exit=False, # type: bool + wait_before_exit_file_path=None, # type: Optional[pathlib.Path] ): self._environment = environment # type: Environment - if event_count % 5: - # The test application currently produces 5 different events per iteration. - raise ValueError("event count must be a multiple of 5") - self._iteration_count = int(event_count / 5) # type: int + self._iteration_count = event_count # File that the application will wait to see before tracing its events. self._app_start_tracing_file_path = pathlib.Path( tempfile.mktemp( prefix="app_", suffix="_start_tracing", - dir=self._compat_open_path(environment.lttng_home_location), + dir=self._compat_pathlike(environment.lttng_home_location), ) ) + # File that the application will create when all events have been emitted. + self._app_tracing_done_file_path = pathlib.Path( + tempfile.mktemp( + prefix="app_", + suffix="_done_tracing", + dir=self._compat_pathlike(environment.lttng_home_location), + ) + ) + + if wait_before_exit and wait_before_exit_file_path is None: + wait_before_exit_file_path = pathlib.Path( + tempfile.mktemp( + prefix="app_", + suffix="_exit", + dir=self._compat_pathlike(environment.lttng_home_location), + ) + ) + self._has_returned = False test_app_env = os.environ.copy() @@ -100,45 +130,53 @@ class WaitTraceTestApplication: test_app_env["LTTNG_UST_REGISTER_TIMEOUT"] = "-1" # File that the application will create to indicate it has completed its initialization. - app_ready_file_path: str = tempfile.mktemp( + app_ready_file_path = tempfile.mktemp( prefix="app_", suffix="_ready", - dir=self._compat_open_path(environment.lttng_home_location), + dir=self._compat_pathlike(environment.lttng_home_location), ) # type: str test_app_args = [str(binary_path)] + test_app_args.extend(["--iter", str(event_count)]) test_app_args.extend( - shlex.split( - "--iter {iteration_count} --create-in-main {app_ready_file_path} --wait-before-first-event {app_start_tracing_file_path} --wait {wait_time_between_events_us}".format( - iteration_count=self._iteration_count, - app_ready_file_path=app_ready_file_path, - app_start_tracing_file_path=self._app_start_tracing_file_path, - wait_time_between_events_us=wait_time_between_events_us, - ) - ) + ["--sync-application-in-main-touch", str(app_ready_file_path)] + ) + test_app_args.extend( + ["--sync-before-first-event", str(self._app_start_tracing_file_path)] ) + test_app_args.extend( + ["--sync-before-exit-touch", str(self._app_tracing_done_file_path)] + ) + if wait_time_between_events_us != 0: + test_app_args.extend(["--wait", str(wait_time_between_events_us)]) self._process = subprocess.Popen( test_app_args, env=test_app_env, + stdout=subprocess.PIPE, + stderr=subprocess.STDOUT, ) # type: subprocess.Popen # Wait for the application to create the file indicating it has fully # initialized. Make sure the app hasn't crashed in order to not wait # forever. + self._wait_for_file_to_be_created(pathlib.Path(app_ready_file_path)) + + def _wait_for_file_to_be_created(self, sync_file_path): + # type: (pathlib.Path) -> None while True: - if os.path.exists(app_ready_file_path): + if os.path.exists(self._compat_pathlike(sync_file_path)): break if self._process.poll() is not None: # Application has unexepectedly returned. raise RuntimeError( - "Test application has unexepectedly returned during its initialization with return code `{return_code}`".format( - return_code=self._process.returncode + "Test application has unexepectedly returned while waiting for synchronization file to be created: sync_file=`{sync_file}`, return_code=`{return_code}`".format( + sync_file=sync_file_path, return_code=self._process.returncode ) ) - time.sleep(0.1) + time.sleep(0.001) def trace(self): # type: () -> None @@ -149,7 +187,11 @@ class WaitTraceTestApplication: return_code=self._process.returncode ) ) - open(self._compat_open_path(self._app_start_tracing_file_path), mode="x") + open(self._compat_pathlike(self._app_start_tracing_file_path), mode="x") + + def wait_for_tracing_done(self): + # type: () -> None + self._wait_for_file_to_be_created(self._app_tracing_done_file_path) def wait_for_exit(self): # type: () -> None @@ -167,12 +209,13 @@ class WaitTraceTestApplication: return self._process.pid @staticmethod - def _compat_open_path(path): + def _compat_pathlike(path): # type: (pathlib.Path) -> pathlib.Path | str """ - The builtin open() in python >= 3.6 expects a path-like object while - prior versions expect a string or bytes object. Return the correct type - based on the presence of the "__fspath__" attribute specified in PEP-519. + The builtin open() and many methods of the 'os' library in Python >= 3.6 + expect a path-like object while prior versions expect a string or + bytes object. Return the correct type based on the presence of the + "__fspath__" attribute specified in PEP-519. """ if hasattr(path, "__fspath__"): return path @@ -187,6 +230,124 @@ class WaitTraceTestApplication: self._process.wait() +class WaitTraceTestApplicationGroup: + def __init__( + self, + environment, # type: Environment + application_count, # type: int + event_count, # type: int + wait_time_between_events_us=0, # type: int + wait_before_exit=False, # type: bool + ): + self._wait_before_exit_file_path = ( + pathlib.Path( + tempfile.mktemp( + prefix="app_group_", + suffix="_exit", + dir=_WaitTraceTestApplication._compat_pathlike( + environment.lttng_home_location + ), + ) + ) + if wait_before_exit + else None + ) + + self._apps = [] + self._consumers = [] + for i in range(application_count): + new_app = environment.launch_wait_trace_test_application( + event_count, + wait_time_between_events_us, + wait_before_exit, + self._wait_before_exit_file_path, + ) + + # Attach an output consumer to log the application's error output (if any). + if environment._logging_function: + app_output_consumer = ProcessOutputConsumer( + new_app._process, + "app-{}".format(str(new_app.vpid)), + environment._logging_function, + ) # type: Optional[ProcessOutputConsumer] + app_output_consumer.daemon = True + app_output_consumer.start() + self._consumers.append(app_output_consumer) + + self._apps.append(new_app) + + def trace(self): + # type: () -> None + for app in self._apps: + app.trace() + + def exit( + self, wait_for_apps=False # type: bool + ): + if self._wait_before_exit_file_path is None: + raise RuntimeError( + "Can't call exit on an application group created with `wait_before_exit=False`" + ) + + # Wait for apps to have produced all of their events so that we can + # cause the death of all apps to happen within a short time span. + for app in self._apps: + app.wait_for_tracing_done() + + open( + _WaitTraceTestApplication._compat_pathlike( + self._wait_before_exit_file_path + ), + mode="x", + ) + # Performed in two passes to allow tests to stress the unregistration of many applications. + # Waiting for each app to exit turn-by-turn would defeat the purpose here. + if wait_for_apps: + for app in self._apps: + app.wait_for_exit() + + +class _TraceTestApplication: + """ + Create an application that emits events as soon as it is launched. In most + scenarios, it is preferable to use a WaitTraceTestApplication. + """ + + def __init__(self, binary_path, environment): + # type: (pathlib.Path, Environment) + self._environment = environment # type: Environment + self._has_returned = False + + test_app_env = os.environ.copy() + test_app_env["LTTNG_HOME"] = str(environment.lttng_home_location) + # Make sure the app is blocked until it is properly registered to + # the session daemon. + test_app_env["LTTNG_UST_REGISTER_TIMEOUT"] = "-1" + + test_app_args = [str(binary_path)] + + self._process = subprocess.Popen( + test_app_args, env=test_app_env + ) # type: subprocess.Popen + + def wait_for_exit(self): + # type: () -> None + if self._process.wait() != 0: + raise RuntimeError( + "Test application has exit with return code `{return_code}`".format( + return_code=self._process.returncode + ) + ) + self._has_returned = True + + def __del__(self): + if not self._has_returned: + # This is potentially racy if the pid has been recycled. However, + # we can't use pidfd_open since it is only available in python >= 3.9. + self._process.kill() + self._process.wait() + + class ProcessOutputConsumer(threading.Thread, logger._Logger): def __init__( self, @@ -317,35 +478,33 @@ class _Environment(logger._Logger): sessiond_env["LTTNG_HOME"] = str(self._lttng_home.path) wait_queue = _SignalWaitQueue() - signal.signal(signal.SIGUSR1, wait_queue.signal) - - self._log( - "Launching session daemon with LTTNG_HOME=`{home_dir}`".format( - home_dir=str(self._lttng_home.path) + with wait_queue.intercept_signal(signal.SIGUSR1): + self._log( + "Launching session daemon with LTTNG_HOME=`{home_dir}`".format( + home_dir=str(self._lttng_home.path) + ) + ) + process = subprocess.Popen( + [ + str(sessiond_path), + consumerd_path_option_name, + str(consumerd_path), + "--sig-parent", + ], + stdout=subprocess.PIPE, + stderr=subprocess.STDOUT, + env=sessiond_env, ) - ) - process = subprocess.Popen( - [ - str(sessiond_path), - consumerd_path_option_name, - str(consumerd_path), - "--sig-parent", - ], - stdout=subprocess.PIPE, - stderr=subprocess.STDOUT, - env=sessiond_env, - ) - if self._logging_function: - self._sessiond_output_consumer = ProcessOutputConsumer( - process, "lttng-sessiond", self._logging_function - ) # type: Optional[ProcessOutputConsumer] - self._sessiond_output_consumer.daemon = True - self._sessiond_output_consumer.start() + if self._logging_function: + self._sessiond_output_consumer = ProcessOutputConsumer( + process, "lttng-sessiond", self._logging_function + ) # type: Optional[ProcessOutputConsumer] + self._sessiond_output_consumer.daemon = True + self._sessiond_output_consumer.start() - # Wait for SIGUSR1, indicating the sessiond is ready to proceed - wait_queue.wait_for_signal() - signal.signal(signal.SIGUSR1, wait_queue.signal) + # Wait for SIGUSR1, indicating the sessiond is ready to proceed + wait_queue.wait_for_signal() return process @@ -358,20 +517,44 @@ class _Environment(logger._Logger): ) self._cleanup() - def launch_wait_trace_test_application(self, event_count): - # type: (int) -> WaitTraceTestApplication + def launch_wait_trace_test_application( + self, + event_count, # type: int + wait_time_between_events_us=0, + wait_before_exit=False, + wait_before_exit_file_path=None, + ): + # type: (int, int, bool, Optional[pathlib.Path]) -> _WaitTraceTestApplication """ Launch an application that will wait before tracing `event_count` events. """ - return WaitTraceTestApplication( + return _WaitTraceTestApplication( self._project_root / "tests" / "utils" / "testapp" - / "gen-ust-nevents" - / "gen-ust-nevents", + / "gen-ust-events" + / "gen-ust-events", event_count, self, + wait_time_between_events_us, + wait_before_exit, + wait_before_exit_file_path, + ) + + def launch_trace_test_constructor_application(self): + # type () -> TraceTestApplication + """ + Launch an application that will trace from within constructors. + """ + return _TraceTestApplication( + self._project_root + / "tests" + / "utils" + / "testapp" + / "gen-ust-events-constructor" + / "gen-ust-events-constructor", + self, ) # Clean-up managed processes