X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=tests%2Futils%2Flttngtest%2Fenvironment.py;h=73d18874b293f1fa23e7c7e2dd267b33e81dd149;hb=HEAD;hp=60c42f51cb472bb89b3aa1953c9a4a0ba65e3007;hpb=8a5e382450359a884bbe594547dfb810e9196d0e;p=lttng-tools.git diff --git a/tests/utils/lttngtest/environment.py b/tests/utils/lttngtest/environment.py index 60c42f51c..73d18874b 100644 --- a/tests/utils/lttngtest/environment.py +++ b/tests/utils/lttngtest/environment.py @@ -93,6 +93,7 @@ class _WaitTraceTestApplication: wait_before_exit=False, # type: bool wait_before_exit_file_path=None, # type: Optional[pathlib.Path] ): + self._process = None self._environment = environment # type: Environment self._iteration_count = event_count # File that the application will wait to see before tracing its events. @@ -223,7 +224,7 @@ class _WaitTraceTestApplication: return str(path) def __del__(self): - if not self._has_returned: + if self._process is not None and 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() @@ -315,6 +316,7 @@ class _TraceTestApplication: def __init__(self, binary_path, environment): # type: (pathlib.Path, Environment) + self._process = None self._environment = environment # type: Environment self._has_returned = False @@ -341,7 +343,7 @@ class _TraceTestApplication: self._has_returned = True def __del__(self): - if not self._has_returned: + if self._process is not None and 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() @@ -375,6 +377,7 @@ class _Environment(logger._Logger): self, with_sessiond, # type: bool log=None, # type: Optional[Callable[[str], None]] + with_relayd=False, # type: bool ): super().__init__(log) signal.signal(signal.SIGTERM, self._handle_termination_signal) @@ -389,6 +392,11 @@ class _Environment(logger._Logger): "lttng_test_env_home" ) # type: Optional[TemporaryDirectory] + self._relayd = ( + self._launch_lttng_relayd() if with_relayd else None + ) # type: Optional[subprocess.Popen[bytes]] + self._relayd_output_consumer = None + self._sessiond = ( self._launch_lttng_sessiond() if with_sessiond else None ) # type: Optional[subprocess.Popen[bytes]] @@ -405,6 +413,21 @@ class _Environment(logger._Logger): # type: () -> pathlib.Path return self._project_root / "src" / "bin" / "lttng" / "lttng" + @property + def lttng_relayd_control_port(self): + # type: () -> int + return 5400 + + @property + def lttng_relayd_data_port(self): + # type: () -> int + return 5401 + + @property + def lttng_relayd_live_port(self): + # type: () -> int + return 5402 + def create_temporary_directory(self, prefix=None): # type: (Optional[str]) -> pathlib.Path # Simply return a path that is contained within LTTNG_HOME; it will @@ -440,6 +463,53 @@ class _Environment(logger._Logger): return unpacked_vars + def _launch_lttng_relayd(self): + # type: () -> Optional[subprocess.Popen] + relayd_path = ( + self._project_root / "src" / "bin" / "lttng-relayd" / "lttng-relayd" + ) + if os.environ.get("LTTNG_TEST_NO_RELAYD", "0") == "1": + # Run without a relay daemon; the user may be running one + # under gdb, for example. + return None + + relayd_env_vars = os.environ.get("LTTNG_RELAYD_ENV_VARS") + relayd_env = os.environ.copy() + if relayd_env_vars: + self._log("Additional lttng-relayd environment variables:") + for name, value in self._unpack_env_vars(relayd_env_vars): + self._log("{}={}".format(name, value)) + relayd_env[name] = value + + assert self._lttng_home is not None + relayd_env["LTTNG_HOME"] = str(self._lttng_home.path) + self._log( + "Launching relayd with LTTNG_HOME='${}'".format(str(self._lttng_home.path)) + ) + process = subprocess.Popen( + [ + str(relayd_path), + "-C", + "tcp://0.0.0.0:{}".format(self.lttng_relayd_control_port), + "-D", + "tcp://0.0.0.0:{}".format(self.lttng_relayd_data_port), + "-L", + "tcp://localhost:{}".format(self.lttng_relayd_live_port), + ], + stdout=subprocess.PIPE, + stderr=subprocess.STDOUT, + env=relayd_env, + ) + + if self._logging_function: + self._relayd_output_consumer = ProcessOutputConsumer( + process, "lttng-relayd", self._logging_function + ) + self._relayd_output_consumer.daemon = True + self._relayd_output_consumer.start() + + return process + def _launch_lttng_sessiond(self): # type: () -> Optional[subprocess.Popen] is_64bits_host = sys.maxsize > 2**32 @@ -542,21 +612,26 @@ class _Environment(logger._Logger): wait_before_exit_file_path, ) - def launch_trace_test_constructor_application(self): + def launch_test_application(self, subpath): # 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._project_root / "tests" / "utils" / "testapp" / subpath, self, ) + def _terminate_relayd(self): + if self._relayd and self._relayd.poll() is None: + self._relayd.terminate() + self._relayd.wait() + if self._relayd_output_consumer: + self._relayd_output_consumer.join() + self._relayd_output_consumer = None + self._log("Relayd killed") + self._relayd = None + # Clean-up managed processes def _cleanup(self): # type: () -> None @@ -577,6 +652,8 @@ class _Environment(logger._Logger): self._log("Session daemon killed") self._sessiond = None + self._terminate_relayd() + self._lttng_home = None def __del__(self): @@ -584,9 +661,9 @@ class _Environment(logger._Logger): @contextlib.contextmanager -def test_environment(with_sessiond, log=None): - # type: (bool, Optional[Callable[[str], None]]) -> Iterator[_Environment] - env = _Environment(with_sessiond, log) +def test_environment(with_sessiond, log=None, with_relayd=False): + # type: (bool, Optional[Callable[[str], None]], bool) -> Iterator[_Environment] + env = _Environment(with_sessiond, log, with_relayd) try: yield env finally: