taucmdr.tests package

Unit test initializations and utility functions.

class taucmdr.tests.DarwinTestCase(methodName='runTest')

Bases: TestCase

Base class for tests that run in processes which take this host for a Mac.

Each test gets a new user prefix and an empty project directory.

_classSetupFailed = False

_class_cleanups = []

python(code)

Run Python code as on a Mac and return its output, see run_python_as_darwin.

setUp()

Hook method for setting up the test fixture before exercising it.

tau(*args)

Run tau as on a Mac, see run_tau_as_darwin.

taucmdr.tests.REPO_DIR = '/home/runner/work/taucmdr/taucmdr'

Absolute path to the TAU Commander source checkout.

It comes from the environment variable __TAUCMDR_REPO_DIR__, which scripts/run_tests.py defines. Without it, this is the checkout containing this file.

Type:

str

taucmdr.tests.RESULTS_DIR = '/home/runner/work/taucmdr/taucmdr/build/test-results'

Directory for JUnit XML and timings.

It comes from the environment variable __TAUCMDR_TEST_RESULTS_DIR__, which scripts/run_tests.py defines.

Type:

str

taucmdr.tests.TIMING_FILE = '/home/runner/work/taucmdr/taucmdr/build/test-results/test-timings.csv'

CSV file to which each test appends its run time.

Type:

str

class taucmdr.tests.TestCase(methodName='runTest')

Bases: TestCase

Base class for unit tests.

Performs tests in a temporary directory and reconfigures taucmdr.logger to work with unittest.

_classSetupFailed = False

_class_cleanups = []

assertCleanExit(proc)

Check that a process from run_python_subprocess printed no Python traceback.

TAU Commander’s own report of an unexpected exception goes to stdout, so both streams are checked.

assertCommandReturnValue(return_value, cmd, argv)

assertCompiler(role, target_name='targ1')

assertInLastTrialData(value, data_type='tau')

assertManagedBuild(return_value, compiler_role, compiler_args, src)

assertNotCommandReturnValue(return_value, cmd, argv)

assertSucceeded(proc)

Check that a process from run_python_subprocess exited with status 0 and no traceback.

copy_testfile(src, dst=None)

destroy_project_storage()

Delete project storage.

Effectively the same as:

> rm -rf .tau

exec_command(cmd, argv)

Execute a tau command’s main() routine and return the exit code, stdout, and stderr data.

Parameters:

• cmd (type) – A command instance that has a main callable attribute.

• argv (list) – Arguments to pass to cmd.main()

Returns:

(retval, stdout, stderr) results of running the command.

Return type:

tuple

getCompiler(role, target_name='targ1')

reset_project_storage(init_args=None)

Delete and recreate project storage.

Effectively the same as:

> rm -rf .tau
> tau initialize [init_args]

Parameters:

init_args (list) – Command line arguments to tau initialize.

run(result=None)

setUp() → None

Hook method for setting up the test fixture before exercising it.

classmethod setUpClass()

Hook method for setting up class fixture before running tests in the class.

tearDown() → None

Hook method for deconstructing the test fixture after testing it.

classmethod tearDownClass()

Hook method for deconstructing the class fixture after running all tests in the class.

taucmdr.tests._destroy_test_workdir(path)

taucmdr.tests._null_decorator(_)

taucmdr.tests._report_cleanup_error(_, path, exc)

taucmdr.tests.cleanup()

Checks that any files or directories created during testing have been removed.

taucmdr.tests.get_test_workdir()

Return the current unit test’s working directory.

taucmdr.tests.not_implemented(cls)

Decorator for TestCase classes to indicate that the tests have not been written (yet).

taucmdr.tests.pop_test_workdir()

Recursively deletes the most recently created unit test working directory.

Restores the current working directory and tempfile.tempdir to their values before push_test_workdir was called.

taucmdr.tests.push_test_workdir()

Create a new working directory for a unit test.

Sets the current working directory and tempfile.tempdir to the newly created test directory.

Directories created via this method are tracked. If any of them exist when the program exits then an error message is shown for each.

taucmdr.tests.run_python_as_darwin(code, cwd, user_prefix, backend=None)

Run Python code in a new process that TAU Commander will identify as an Apple silicon Mac.

Parameters:

• code (str) – Source to run after the platform is patched and before anything is imported.

• cwd (str) – Working directory of the new process.

• user_prefix (str) – User-level storage prefix.

• backend (str) – Value for __TAUCMDR_DB_BACKEND__, or None to use the current one.

Returns:

The finished process, with text output captured.

Return type:

subprocess.CompletedProcess

taucmdr.tests.run_python_subprocess(args, env=None, cwd=None, isolated=True)

Run this Python interpreter in a new process.

Parameters:

• args (list) – Arguments to the interpreter.

• env (dict) – Changes to the environment. A value of None unsets the variable.

• cwd (str) – Working directory of the new process.

• isolated (bool) – If True, run in isolated mode (-I), as the tau launcher does. Otherwise PYTHONPATH is set to this interpreter’s sys.path, so the new process imports the same taucmdr.

Returns:

The finished process, with text output captured.

Return type:

subprocess.CompletedProcess

taucmdr.tests.run_tau_as_darwin(args, cwd, user_prefix, backend=None)

Run tau in a new process that takes this host for an Apple silicon Mac.

Building TAU is skipped: Experiment.configure does nothing.

taucmdr.tests.run_tau_subprocess(args, backend, cwd, user_prefix, system_prefix=None, env=None)

Run tau in a new process with the given storage.

Parameters:

• args (list) – Arguments to tau.

• backend (str) – Value for __TAUCMDR_DB_BACKEND__, or None to leave it unset.

• cwd (str) – Working directory of the new process.

• user_prefix (str) – User-level storage prefix.

• system_prefix (str) – System-level storage prefix, or None for no system level.

• env (dict) – Further changes to the environment, as for run_python_subprocess.

Returns:

The finished process, with text output captured.

Return type:

subprocess.CompletedProcess

taucmdr.tests.skipUnlessHaveCompiler(role)

Decorator to skip test functions when no compiler fills the given role.

If no installed compiler can fill this role then skip the test and report “<role> compiler not found”.

Parameters:

role (_CompilerRole) – A compiler role.

taucmdr.tests.storage_env(backend, user_prefix, system_prefix=None)

Return environment changes that give a new TAU Commander process the given storage.

Parameters:

• backend (str) – Value for __TAUCMDR_DB_BACKEND__, or None to leave it unset.

• user_prefix (str) – User-level storage prefix. HOME is set to it too, so nothing reaches the real one.

• system_prefix (str) – System-level storage prefix, or None for no system level.

Returns:

Changes for run_python_subprocess’s env.

Return type:

dict

Submodules

• taucmdr.tests.test_cli_reference module
  • CliReferenceTest
    • CliReferenceTest._classSetupFailed
    • CliReferenceTest._class_cleanups
    • CliReferenceTest.setUpClass()
    • CliReferenceTest.test_all_commands()
    • CliReferenceTest.test_fixed_width()
    • CliReferenceTest.test_main_page()
    • CliReferenceTest.test_no_defaults()
    • CliReferenceTest.test_no_escape_sequences()
    • CliReferenceTest.test_no_help_page_placeholder()
    • CliReferenceTest.test_page_content()
    • CliReferenceTest.test_write_pages_removes_stale()
    • CliReferenceTest.test_write_pages_unchanged()
  • _load_extension()
• taucmdr.tests.test_error module
  • ErrorTest
    • ErrorTest._classSetupFailed
    • ErrorTest._class_cleanups
• taucmdr.tests.test_imports module
  • ImportTest
    • ImportTest._classSetupFailed
    • ImportTest._class_cleanups
    • ImportTest.test_import_each_module()
  • _import_alone()
  • _module_names()
• taucmdr.tests.test_init module
  • GlobalsTest
    • GlobalsTest._classSetupFailed
    • GlobalsTest._class_cleanups
    • GlobalsTest._print_system_prefix()
    • GlobalsTest.test_no_install_tree()
    • GlobalsTest.test_relative_system_prefix()
    • GlobalsTest.test_same_prefix_both_names()
    • GlobalsTest.test_script_name_default()
    • GlobalsTest.test_system_prefix_conflict()
    • GlobalsTest.test_system_prefix_default()
    • GlobalsTest.test_system_prefix_empty()
    • GlobalsTest.test_system_prefix_override()
    • GlobalsTest.test_system_prefix_public_name()
  • InstalledPackageTest
    • InstalledPackageTest._classSetupFailed
    • InstalledPackageTest._class_cleanups
    • InstalledPackageTest.test_tests_use_installed_package()
  • PythonVersionTest
    • PythonVersionTest._classSetupFailed
    • PythonVersionTest._class_cleanups
    • PythonVersionTest.test_matches_requires_python()
    • PythonVersionTest.test_supported_versions()
    • PythonVersionTest.test_unsupported_versions()
  • VersionTest
    • VersionTest._classSetupFailed
    • VersionTest._class_cleanups
    • VersionTest.test_installed_version()
  • _import_with_version()
• taucmdr.tests.test_launcher module
  • LauncherTest
    • LauncherTest._check_children_see_env()
    • LauncherTest._classSetupFailed
    • LauncherTest._class_cleanups
    • LauncherTest._hostile_env()
    • LauncherTest._read_pager_env()
    • LauncherTest._run()
    • LauncherTest.setUp()
    • LauncherTest.setUpClass()
    • LauncherTest.test_backstop_reexecs_isolated()
    • LauncherTest.test_environment_reaches_children()
    • LauncherTest.test_hostile_environment()
    • LauncherTest.test_missing_python()
    • LauncherTest.test_shebang()
    • LauncherTest.test_symlinked_launcher()
  • _write()
• taucmdr.tests.test_logger module
  • TerminalSizeTest
    • TerminalSizeTest._classSetupFailed
    • TerminalSizeTest._class_cleanups
    • TerminalSizeTest._size()
    • TerminalSizeTest.test_columns_alone()
    • TerminalSizeTest.test_columns_and_lines()
    • TerminalSizeTest.test_invalid()
    • TerminalSizeTest.test_lines_alone()
• taucmdr.tests.test_no_system_level module
  • NoSystemLevelTest
    • NoSystemLevelTest._classSetupFailed
    • NoSystemLevelTest._class_cleanups
    • NoSystemLevelTest._tau()
    • NoSystemLevelTest.setUpClass()
    • NoSystemLevelTest.test_packages_in_user_storage()
    • NoSystemLevelTest.test_project_after_removal()
    • NoSystemLevelTest.test_system_commands_refused()
    • NoSystemLevelTest.test_trial_without_system_level()
• taucmdr.tests.test_progress module
  • ProgressIndicatorTest
    • ProgressIndicatorTest._classSetupFailed
    • ProgressIndicatorTest._class_cleanups
    • ProgressIndicatorTest._draw()
    • ProgressIndicatorTest._output()
    • ProgressIndicatorTest.test_disabled_draws_nothing()
    • ProgressIndicatorTest.test_disabled_keeps_no_phases()
    • ProgressIndicatorTest.test_full_without_terminal()
    • ProgressIndicatorTest.test_line_width()
    • ProgressIndicatorTest.test_no_terminal_defaults_to_disabled()
    • ProgressIndicatorTest.test_terminal_defaults_to_full()
• taucmdr.tests.test_pylint module
  • PylintTest
    • PylintTest._classSetupFailed
    • PylintTest._class_cleanups
    • PylintTest._format_pylint_report()
    • PylintTest.run_pylint()
    • PylintTest.test_pylint()
    • PylintTest.test_pylint_version()
• taucmdr.tests.test_requirements module
  • RequirementsTest
    • RequirementsTest._classSetupFailed
    • RequirementsTest._class_cleanups
    • RequirementsTest.test_requirements_match_imports()
  • _imported_packages()
  • _required_packages()
• taucmdr.tests.test_run_tests module
  • RunTestsTest
    • RunTestsTest._classSetupFailed
    • RunTestsTest._class_cleanups
    • RunTestsTest._make_modules()
    • RunTestsTest._probe_system_prefix()
    • RunTestsTest._run()
    • RunTestsTest.test_deprecation_warnings()
    • RunTestsTest.test_import_error_traceback()
    • RunTestsTest.test_list_unloadable_name()
    • RunTestsTest.test_name_without_tests()
    • RunTestsTest.test_namespace_package()
    • RunTestsTest.test_nested_run_results_dir()
    • RunTestsTest.test_no_implicit_tempdir_cleanup()
    • RunTestsTest.test_package_name()
    • RunTestsTest.test_prints_tested_package()
    • RunTestsTest.test_repo_dir()
    • RunTestsTest.test_results_dir_replaced()
    • RunTestsTest.test_sandbox_cleanup_failure()
    • RunTestsTest.test_script_name()
    • RunTestsTest.test_system_prefix_absolute()
    • RunTestsTest.test_system_prefix_created()
    • RunTestsTest.test_system_prefix_default()
    • RunTestsTest.test_system_prefix_public_name()
• taucmdr.tests.test_util module
  • CamelCaseTest
    • CamelCaseTest._classSetupFailed
    • CamelCaseTest._class_cleanups
    • CamelCaseTest.test_camelcase()
  • ExtractArchiveTest
    • ExtractArchiveTest._classSetupFailed
    • ExtractArchiveTest._class_cleanups
    • ExtractArchiveTest.test_extract_archive()
    • ExtractArchiveTest.test_extract_archive_truncated()
    • ExtractArchiveTest.test_extract_archive_unsafe_link()
  • HumanSizeTest
    • HumanSizeTest._classSetupFailed
    • HumanSizeTest._class_cleanups
    • HumanSizeTest.test_humansize()
  • IsCleanContainerTest
    • IsCleanContainerTest._classSetupFailed
    • IsCleanContainerTest._class_cleanups
    • IsCleanContainerTest.test_false()
    • IsCleanContainerTest.test_true()
  • IsUrlTest
    • IsUrlTest._classSetupFailed
    • IsUrlTest._class_cleanups
    • IsUrlTest.test_false()
    • IsUrlTest.test_true()
  • PageOutputTest
    • PageOutputTest._classSetupFailed
    • PageOutputTest._class_cleanups
    • PageOutputTest.test_page_output_uses_pager()
  • ParseBoolTest
    • ParseBoolTest._classSetupFailed
    • ParseBoolTest._class_cleanups
    • ParseBoolTest.test_extendfalse()
    • ParseBoolTest.test_extendtrue()
    • ParseBoolTest.test_false()
    • ParseBoolTest.test_true()
  • RmtreeTest
    • RmtreeTest._classSetupFailed
    • RmtreeTest._class_cleanups
    • RmtreeTest.test_onexc()
  • TemporaryDirectoryTest
    • TemporaryDirectoryTest._classSetupFailed
    • TemporaryDirectoryTest._class_cleanups
    • TemporaryDirectoryTest._record_mkdtemp()
    • TemporaryDirectoryTest._run_python()
    • TemporaryDirectoryTest.test_cleanup_dtemp()
    • TemporaryDirectoryTest.test_dtemp_error_warning_names_paths()
    • TemporaryDirectoryTest.test_error_dir_copy_failure_at_exit()
    • TemporaryDirectoryTest.test_error_dir_kept_at_exit()
    • TemporaryDirectoryTest.test_error_dirs_same_name_kept_at_exit()
    • TemporaryDirectoryTest.test_leftover_dtemp_cleaned_at_exit()
    • TemporaryDirectoryTest.test_tmpfs_prefix_fallback_kept()
    • TemporaryDirectoryTest.test_tmpfs_prefix_rejected_candidate_removed()
  • VerifyArchiveTest
    • VerifyArchiveTest._classSetupFailed
    • VerifyArchiveTest._class_cleanups
    • VerifyArchiveTest.test_verify_archive_truncated()
  • _make_archive()