launch_testing package

Subpackages

• launch_testing.actions package
  • Submodules
    • launch_testing.actions.gtest module
      • GTest
    • launch_testing.actions.pytest module
      • PyTest
    • launch_testing.actions.ready module
      • ReadyToTest
    • launch_testing.actions.test module
      • Test
  • Module contents
    • GTest
      • GTest.path
    • PyTest
      • PyTest.path
    • ReadyToTest
      • ReadyToTest.execute()
• launch_testing.asserts package
  • Submodules
    • launch_testing.asserts.assert_exit_codes module
      • assertExitCodes()
    • launch_testing.asserts.assert_output module
      • assertDefaultStream()
      • assertInStderr()
      • assertInStdout()
      • assertInStream()
    • launch_testing.asserts.assert_sequential_output module
      • SequentialTextChecker
      • assertSequentialStdout()
  • Module contents
    • SequentialTextChecker
      • SequentialTextChecker.assertInStdout()
      • SequentialTextChecker.assertInText()
      • SequentialTextChecker.get_nearby_lines()
    • assertDefaultStream()
    • assertExitCodes()
    • assertInStderr()
    • assertInStdout()
    • assertInStream()
    • assertSequentialStdout()
• launch_testing.event_handlers package
  • Submodules
    • launch_testing.event_handlers.stdout_ready_listener module
      • StdoutReadyListener
  • Module contents
    • StdoutReadyListener
      • StdoutReadyListener.describe()
• launch_testing.legacy package
  • Submodules
    • launch_testing.legacy.output module
      • create_output_lines_filter()
      • create_output_lines_test()
      • create_output_regex_test()
      • create_output_test_from_file()
      • get_default_filtered_patterns()
      • get_default_filtered_prefixes()
      • get_rmw_output_filter()
  • Module contents
    • LaunchTestService
      • LaunchTestService.add_fixture_action()
      • LaunchTestService.add_output_test()
      • LaunchTestService.add_test_action()
      • LaunchTestService.run()
• launch_testing.pytest package
  • Submodules
    • launch_testing.pytest.hooks module
    • launch_testing.pytest.hookspecs module
      • pytest_launch_collect_makemodule()
  • Module contents
• launch_testing.tools package
  • Submodules
    • launch_testing.tools.output module
      • basic_output_filter()
      • expect_output()
      • expected_output_from_file()
      • get_default_filtered_patterns()
      • get_default_filtered_prefixes()
    • launch_testing.tools.process module
      • ProcessProxy
      • launch_process()
    • launch_testing.tools.text module
      • build_line_match()
      • build_text_match()
      • normalize_lineseps()
  • Module contents
    • ProcessProxy
      • ProcessProxy.exit_code
      • ProcessProxy.output
      • ProcessProxy.running
      • ProcessProxy.stderr
      • ProcessProxy.stdout
      • ProcessProxy.target_process_action
      • ProcessProxy.terminated
      • ProcessProxy.wait_for_output()
      • ProcessProxy.wait_for_shutdown()
    • basic_output_filter()
    • expect_output()
    • expected_output_from_file()
    • launch_process()
• launch_testing.util package
  • Submodules
    • launch_testing.util.proc_lookup module
      • NoMatchingProcessException
      • resolveProcesses()
  • Module contents
    • KeepAliveProc()
    • NoMatchingProcessException
    • resolveProcesses()

Submodules

• launch_testing.decorator module
  • post_shutdown_test()
• launch_testing.io_handler module
  • ActiveIoHandler
    • ActiveIoHandler.append()
    • ActiveIoHandler.assertWaitFor()
    • ActiveIoHandler.io_event
    • ActiveIoHandler.process_names()
    • ActiveIoHandler.processes()
    • ActiveIoHandler.track()
    • ActiveIoHandler.waitFor()
  • IoHandler
    • IoHandler.append()
    • IoHandler.process_names()
    • IoHandler.processes()
    • IoHandler.track()
• launch_testing.junitxml module
  • unittestCaseToXml()
  • unittestResultToXml()
  • unittestResultsToXml()
• launch_testing.launch_test module
  • add_arguments()
  • main()
  • parse_arguments()
  • run()
• launch_testing.loader module
  • LoadTestsFromPythonModule()
  • PostShutdownTestLoader()
  • PreShutdownTestLoader()
  • TestRun
    • TestRun.all_cases()
    • TestRun.bind()
    • TestRun.get_launch_description()
    • TestRun.markers
  • slim_formatwarning()
• launch_testing.markers module
  • keep_alive()
  • retry_on_failure()
• launch_testing.parametrize module
  • parametrize()
• launch_testing.parse_arguments module
  • parse_launch_arguments()
• launch_testing.print_arguments module
  • print_arguments_of_launch_description()
• launch_testing.proc_info_handler module
  • ActiveProcInfoHandler
    • ActiveProcInfoHandler.append()
    • ActiveProcInfoHandler.assertWaitForShutdown()
    • ActiveProcInfoHandler.assertWaitForStartup()
    • ActiveProcInfoHandler.proc_event
    • ActiveProcInfoHandler.process_names()
    • ActiveProcInfoHandler.processes()
  • ProcInfoHandler
    • ProcInfoHandler.append()
    • ProcInfoHandler.process_names()
    • ProcInfoHandler.processes()
• launch_testing.ready_aggregator module
  • ReadyAggregator
    • ReadyAggregator.ready_fn()
• launch_testing.ready_to_test_action_timeout module
  • ready_to_test_action_timeout()
• launch_testing.test_result module
  • FailResult
    • FailResult.testCases
    • FailResult.testTimes
    • FailResult.wasSuccessful()
  • SkipResult
    • SkipResult.testCases
    • SkipResult.testTimes
    • SkipResult.wasSuccessful()
  • TestResult
    • TestResult.append()
    • TestResult.startTest()
    • TestResult.stopTest()
    • TestResult.testCases
    • TestResult.testTimes
• launch_testing.test_runner module
  • LaunchTestRunner
    • LaunchTestRunner.generate_preamble()
    • LaunchTestRunner.run()
    • LaunchTestRunner.validate()

Module contents

class launch_testing.ActiveIoHandler

Bases: object

Holds stdout captured from running processes.

The ActiveIoHandler is meant to be used when capturing is still in progress and provides additional synchronization, as well as methods to wait on incoming IO

append(process_io)

assertWaitFor(*args, **kwargs)

property io_event

process_names()

Get the name of all unique processes that generated IO.

Returns [string]:

processes()

Get an iterable of unique launch.events.process.RunningProcessEvent objects.

Returns [launch.actions.ExecuteProcess]:

track(process_name)

waitFor(expected_output, process=None, cmd_args=None, *, strict_proc_matching=True, output_filter=None, timeout=10, strip_ansi_escape_sequences=True, stream='stderr')

class launch_testing.ActiveProcInfoHandler

Bases: object

Allows tests to wait on process termination before proceeding.

append(process_info)

assertWaitForShutdown(process, cmd_args=None, *, timeout=10)

assertWaitForStartup(process, cmd_args=None, *, timeout=10)

property proc_event

process_names()

Get the name of all recorded processes.

Returns [string]:

processes()

Get the ExecuteProcess launch actions of all recorded processes.

Returns [launch.actions.ExecuteProcess]:

class launch_testing.IoHandler

Bases: object

Holds stdout captured from running processes.

This class provides helper methods to enumerate the captured IO by individual processes

append(process_io)

process_names()

Get the name of all unique processes that generated IO.

Returns [string]:

processes()

Get an iterable of unique launch.events.process.RunningProcessEvent objects.

Returns [launch.actions.ExecuteProcess]:

track(process_name)

class launch_testing.ProcInfoHandler

Bases: object

Captures exit codes from processes when they terminate.

append(process_info)

process_names()

Get the name of all recorded processes.

processes()

Get the ExecuteProcess launch actions of all recorded processes.

class launch_testing.ReadyAggregator(ready_fn, num_to_aggregate)

Bases: object

Calls a ready_fn parent function on the nth call to a child function.

ready_fn()

launch_testing.parametrize(argnames, argvalues)

Decorate a test launch description in a way that causes it to run with specified parameters.

This decorator behaves like the @pytest.mark.parametrize decorator.

Param:

argnames A comma separated list of argument names.

Param:

argvalues The values to use for arguments specified in argnames

launch_testing.post_shutdown_test()

Decorate tests that are meant to run after process shutdown.

launch_testing.ready_to_test_action_timeout(timeout)

Decorate a test launch description in a way that it adds ReadyToTest action timeout.

attribute to the function being decorated.

Param:

timeout Duration for which the ReadyToTest action waits for processes to start up