3 # Copyright (C) 2022 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 # SPDX-License-Identifier: GPL-2.0-only
8 from types
import FrameType
9 from typing
import Callable
, Iterator
, Optional
, Tuple
, List
, Generator
25 class TemporaryDirectory
:
26 def __init__(self
, prefix
):
28 self
._directory
_path
= tempfile
.mkdtemp(prefix
=prefix
)
31 shutil
.rmtree(self
._directory
_path
, ignore_errors
=True)
35 # type: () -> pathlib.Path
36 return pathlib
.Path(self
._directory
_path
)
39 class _SignalWaitQueue
:
41 Utility class useful to wait for a signal before proceeding.
43 Simply register the `signal` method as the handler for the signal you are
44 interested in and call `wait_for_signal` to wait for its reception.
47 signal.signal(signal.SIGWHATEVER, queue.signal)
49 Waiting for the signal:
50 queue.wait_for_signal()
54 self
._queue
= queue
.Queue() # type: queue.Queue
59 frame
, # type: Optional[FrameType]
61 self
._queue
.put_nowait(signal_number
)
63 def wait_for_signal(self
):
64 self
._queue
.get(block
=True)
66 @contextlib.contextmanager
67 def intercept_signal(self
, signal_number
):
68 # type: (int) -> Generator[None, None, None]
69 original_handler
= signal
.getsignal(signal_number
)
70 signal
.signal(signal_number
, self
.signal
)
74 # Restore the original signal handler and forward the exception.
77 signal
.signal(signal_number
, original_handler
)
80 class _WaitTraceTestApplication
:
82 Create an application that waits before tracing. This allows a test to
83 launch an application, get its PID, and get it to start tracing when it
84 has completed its setup.
89 binary_path
, # type: pathlib.Path
90 event_count
, # type: int
91 environment
, # type: Environment
92 wait_time_between_events_us
=0, # type: int
93 wait_before_exit
=False, # type: bool
94 wait_before_exit_file_path
=None, # type: Optional[pathlib.Path]
96 self
._environment
= environment
# type: Environment
97 self
._iteration
_count
= event_count
98 # File that the application will wait to see before tracing its events.
99 self
._app
_start
_tracing
_file
_path
= pathlib
.Path(
102 suffix
="_start_tracing",
103 dir=self
._compat
_pathlike
(environment
.lttng_home_location
),
106 # File that the application will create when all events have been emitted.
107 self
._app
_tracing
_done
_file
_path
= pathlib
.Path(
110 suffix
="_done_tracing",
111 dir=self
._compat
_pathlike
(environment
.lttng_home_location
),
115 if wait_before_exit
and wait_before_exit_file_path
is None:
116 wait_before_exit_file_path
= pathlib
.Path(
120 dir=self
._compat
_pathlike
(environment
.lttng_home_location
),
124 self
._has
_returned
= False
126 test_app_env
= os
.environ
.copy()
127 test_app_env
["LTTNG_HOME"] = str(environment
.lttng_home_location
)
128 # Make sure the app is blocked until it is properly registered to
129 # the session daemon.
130 test_app_env
["LTTNG_UST_REGISTER_TIMEOUT"] = "-1"
132 # File that the application will create to indicate it has completed its initialization.
133 app_ready_file_path
= tempfile
.mktemp(
136 dir=self
._compat
_pathlike
(environment
.lttng_home_location
),
139 test_app_args
= [str(binary_path
)]
140 test_app_args
.extend(["--iter", str(event_count
)])
141 test_app_args
.extend(
142 ["--sync-application-in-main-touch", str(app_ready_file_path
)]
144 test_app_args
.extend(
145 ["--sync-before-first-event", str(self
._app
_start
_tracing
_file
_path
)]
147 test_app_args
.extend(
148 ["--sync-before-exit-touch", str(self
._app
_tracing
_done
_file
_path
)]
150 if wait_time_between_events_us
!= 0:
151 test_app_args
.extend(["--wait", str(wait_time_between_events_us
)])
153 self
._process
= subprocess
.Popen(
156 stdout
=subprocess
.PIPE
,
157 stderr
=subprocess
.STDOUT
,
158 ) # type: subprocess.Popen
160 # Wait for the application to create the file indicating it has fully
161 # initialized. Make sure the app hasn't crashed in order to not wait
163 self
._wait
_for
_file
_to
_be
_created
(pathlib
.Path(app_ready_file_path
))
165 def _wait_for_file_to_be_created(self
, sync_file_path
):
166 # type: (pathlib.Path) -> None
168 if os
.path
.exists(self
._compat
_pathlike
(sync_file_path
)):
171 if self
._process
.poll() is not None:
172 # Application has unexepectedly returned.
174 "Test application has unexepectedly returned while waiting for synchronization file to be created: sync_file=`{sync_file}`, return_code=`{return_code}`".format(
175 sync_file
=sync_file_path
, return_code
=self
._process
.returncode
183 if self
._process
.poll() is not None:
184 # Application has unexepectedly returned.
186 "Test application has unexepectedly before tracing with return code `{return_code}`".format(
187 return_code
=self
._process
.returncode
190 open(self
._compat
_pathlike
(self
._app
_start
_tracing
_file
_path
), mode
="x")
192 def wait_for_tracing_done(self
):
194 self
._wait
_for
_file
_to
_be
_created
(self
._app
_tracing
_done
_file
_path
)
196 def wait_for_exit(self
):
198 if self
._process
.wait() != 0:
200 "Test application has exit with return code `{return_code}`".format(
201 return_code
=self
._process
.returncode
204 self
._has
_returned
= True
209 return self
._process
.pid
212 def _compat_pathlike(path
):
213 # type: (pathlib.Path) -> pathlib.Path | str
215 The builtin open() and many methods of the 'os' library in Python >= 3.6
216 expect a path-like object while prior versions expect a string or
217 bytes object. Return the correct type based on the presence of the
218 "__fspath__" attribute specified in PEP-519.
220 if hasattr(path
, "__fspath__"):
226 if not self
._has
_returned
:
227 # This is potentially racy if the pid has been recycled. However,
228 # we can't use pidfd_open since it is only available in python >= 3.9.
233 class WaitTraceTestApplicationGroup
:
236 environment
, # type: Environment
237 application_count
, # type: int
238 event_count
, # type: int
239 wait_time_between_events_us
=0, # type: int
240 wait_before_exit
=False, # type: bool
242 self
._wait
_before
_exit
_file
_path
= (
247 dir=_WaitTraceTestApplication
._compat
_pathlike
(
248 environment
.lttng_home_location
258 for i
in range(application_count
):
259 new_app
= environment
.launch_wait_trace_test_application(
261 wait_time_between_events_us
,
263 self
._wait
_before
_exit
_file
_path
,
266 # Attach an output consumer to log the application's error output (if any).
267 if environment
._logging
_function
:
268 app_output_consumer
= ProcessOutputConsumer(
270 "app-{}".format(str(new_app
.vpid
)),
271 environment
._logging
_function
,
272 ) # type: Optional[ProcessOutputConsumer]
273 app_output_consumer
.daemon
= True
274 app_output_consumer
.start()
275 self
._consumers
.append(app_output_consumer
)
277 self
._apps
.append(new_app
)
281 for app
in self
._apps
:
285 self
, wait_for_apps
=False # type: bool
287 if self
._wait
_before
_exit
_file
_path
is None:
289 "Can't call exit on an application group created with `wait_before_exit=False`"
292 # Wait for apps to have produced all of their events so that we can
293 # cause the death of all apps to happen within a short time span.
294 for app
in self
._apps
:
295 app
.wait_for_tracing_done()
298 _WaitTraceTestApplication
._compat
_pathlike
(
299 self
._wait
_before
_exit
_file
_path
303 # Performed in two passes to allow tests to stress the unregistration of many applications.
304 # Waiting for each app to exit turn-by-turn would defeat the purpose here.
306 for app
in self
._apps
:
310 class _TraceTestApplication
:
312 Create an application that emits events as soon as it is launched. In most
313 scenarios, it is preferable to use a WaitTraceTestApplication.
316 def __init__(self
, binary_path
, environment
):
317 # type: (pathlib.Path, Environment)
318 self
._environment
= environment
# type: Environment
319 self
._has
_returned
= False
321 test_app_env
= os
.environ
.copy()
322 test_app_env
["LTTNG_HOME"] = str(environment
.lttng_home_location
)
323 # Make sure the app is blocked until it is properly registered to
324 # the session daemon.
325 test_app_env
["LTTNG_UST_REGISTER_TIMEOUT"] = "-1"
327 test_app_args
= [str(binary_path
)]
329 self
._process
= subprocess
.Popen(
330 test_app_args
, env
=test_app_env
331 ) # type: subprocess.Popen
333 def wait_for_exit(self
):
335 if self
._process
.wait() != 0:
337 "Test application has exit with return code `{return_code}`".format(
338 return_code
=self
._process
.returncode
341 self
._has
_returned
= True
344 if not self
._has
_returned
:
345 # This is potentially racy if the pid has been recycled. However,
346 # we can't use pidfd_open since it is only available in python >= 3.9.
351 class ProcessOutputConsumer(threading
.Thread
, logger
._Logger
):
354 process
, # type: subprocess.Popen
356 log
, # type: Callable[[str], None]
358 threading
.Thread
.__init
__(self
)
360 logger
._Logger
.__init
__(self
, log
)
361 self
._process
= process
365 while self
._process
.poll() is None:
366 assert self
._process
.stdout
367 line
= self
._process
.stdout
.readline().decode("utf-8").replace("\n", "")
369 self
._log
("{prefix}: {line}".format(prefix
=self
._prefix
, line
=line
))
372 # Generate a temporary environment in which to execute a test.
373 class _Environment(logger
._Logger
):
376 with_sessiond
, # type: bool
377 log
=None, # type: Optional[Callable[[str], None]]
379 super().__init
__(log
)
380 signal
.signal(signal
.SIGTERM
, self
._handle
_termination
_signal
)
381 signal
.signal(signal
.SIGINT
, self
._handle
_termination
_signal
)
383 # Assumes the project's hierarchy to this file is:
384 # tests/utils/python/this_file
385 self
._project
_root
= (
386 pathlib
.Path(__file__
).absolute().parents
[3]
387 ) # type: pathlib.Path
388 self
._lttng
_home
= TemporaryDirectory(
389 "lttng_test_env_home"
390 ) # type: Optional[TemporaryDirectory]
393 self
._launch
_lttng
_sessiond
() if with_sessiond
else None
394 ) # type: Optional[subprocess.Popen[bytes]]
397 def lttng_home_location(self
):
398 # type: () -> pathlib.Path
399 if self
._lttng
_home
is None:
400 raise RuntimeError("Attempt to access LTTng home after clean-up")
401 return self
._lttng
_home
.path
404 def lttng_client_path(self
):
405 # type: () -> pathlib.Path
406 return self
._project
_root
/ "src" / "bin" / "lttng" / "lttng"
408 def create_temporary_directory(self
, prefix
=None):
409 # type: (Optional[str]) -> pathlib.Path
410 # Simply return a path that is contained within LTTNG_HOME; it will
411 # be destroyed when the temporary home goes out of scope.
412 assert self
._lttng
_home
415 prefix
="tmp" if prefix
is None else prefix
,
416 dir=str(self
._lttng
_home
.path
),
420 # Unpack a list of environment variables from a string
421 # such as "HELLO=is_it ME='/you/are/looking/for'"
423 def _unpack_env_vars(env_vars_string
):
424 # type: (str) -> List[Tuple[str, str]]
426 for var
in shlex
.split(env_vars_string
):
427 equal_position
= var
.find("=")
428 # Must have an equal sign and not end with an equal sign
429 if equal_position
== -1 or equal_position
== len(var
) - 1:
431 "Invalid sessiond environment variable: `{}`".format(var
)
434 var_name
= var
[0:equal_position
]
435 var_value
= var
[equal_position
+ 1 :]
437 var_value
= var_value
.replace("'", "")
438 var_value
= var_value
.replace('"', "")
439 unpacked_vars
.append((var_name
, var_value
))
443 def _launch_lttng_sessiond(self
):
444 # type: () -> Optional[subprocess.Popen]
445 is_64bits_host
= sys
.maxsize
> 2**32
448 self
._project
_root
/ "src" / "bin" / "lttng-sessiond" / "lttng-sessiond"
450 consumerd_path_option_name
= "--consumerd{bitness}-path".format(
451 bitness
="64" if is_64bits_host
else "32"
454 self
._project
_root
/ "src" / "bin" / "lttng-consumerd" / "lttng-consumerd"
457 no_sessiond_var
= os
.environ
.get("TEST_NO_SESSIOND")
458 if no_sessiond_var
and no_sessiond_var
== "1":
459 # Run test without a session daemon; the user probably
460 # intends to run one under gdb for example.
463 # Setup the session daemon's environment
464 sessiond_env_vars
= os
.environ
.get("LTTNG_SESSIOND_ENV_VARS")
465 sessiond_env
= os
.environ
.copy()
466 if sessiond_env_vars
:
467 self
._log
("Additional lttng-sessiond environment variables:")
468 additional_vars
= self
._unpack
_env
_vars
(sessiond_env_vars
)
469 for var_name
, var_value
in additional_vars
:
470 self
._log
(" {name}={value}".format(name
=var_name
, value
=var_value
))
471 sessiond_env
[var_name
] = var_value
473 sessiond_env
["LTTNG_SESSION_CONFIG_XSD_PATH"] = str(
474 self
._project
_root
/ "src" / "common"
477 assert self
._lttng
_home
is not None
478 sessiond_env
["LTTNG_HOME"] = str(self
._lttng
_home
.path
)
480 wait_queue
= _SignalWaitQueue()
481 with wait_queue
.intercept_signal(signal
.SIGUSR1
):
483 "Launching session daemon with LTTNG_HOME=`{home_dir}`".format(
484 home_dir
=str(self
._lttng
_home
.path
)
487 process
= subprocess
.Popen(
490 consumerd_path_option_name
,
494 stdout
=subprocess
.PIPE
,
495 stderr
=subprocess
.STDOUT
,
499 if self
._logging
_function
:
500 self
._sessiond
_output
_consumer
= ProcessOutputConsumer(
501 process
, "lttng-sessiond", self
._logging
_function
502 ) # type: Optional[ProcessOutputConsumer]
503 self
._sessiond
_output
_consumer
.daemon
= True
504 self
._sessiond
_output
_consumer
.start()
506 # Wait for SIGUSR1, indicating the sessiond is ready to proceed
507 wait_queue
.wait_for_signal()
511 def _handle_termination_signal(self
, signal_number
, frame
):
512 # type: (int, Optional[FrameType]) -> None
514 "Killed by {signal_name} signal, cleaning-up".format(
515 signal_name
=signal
.strsignal(signal_number
)
520 def launch_wait_trace_test_application(
522 event_count
, # type: int
523 wait_time_between_events_us
=0,
524 wait_before_exit
=False,
525 wait_before_exit_file_path
=None,
527 # type: (int, int, bool, Optional[pathlib.Path]) -> _WaitTraceTestApplication
529 Launch an application that will wait before tracing `event_count` events.
531 return _WaitTraceTestApplication(
540 wait_time_between_events_us
,
542 wait_before_exit_file_path
,
545 def launch_trace_test_constructor_application(self
):
546 # type () -> TraceTestApplication
548 Launch an application that will trace from within constructors.
550 return _TraceTestApplication(
555 / "gen-ust-events-constructor"
556 / "gen-ust-events-constructor",
560 # Clean-up managed processes
563 if self
._sessiond
and self
._sessiond
.poll() is None:
564 # The session daemon is alive; kill it.
566 "Killing session daemon (pid = {sessiond_pid})".format(
567 sessiond_pid
=self
._sessiond
.pid
571 self
._sessiond
.terminate()
572 self
._sessiond
.wait()
573 if self
._sessiond
_output
_consumer
:
574 self
._sessiond
_output
_consumer
.join()
575 self
._sessiond
_output
_consumer
= None
577 self
._log
("Session daemon killed")
578 self
._sessiond
= None
580 self
._lttng
_home
= None
586 @contextlib.contextmanager
587 def test_environment(with_sessiond
, log
=None):
588 # type: (bool, Optional[Callable[[str], None]]) -> Iterator[_Environment]
589 env
= _Environment(with_sessiond
, log
)