1.1.1.4. rez.tests package

1.1.1.4.1. Submodules

1.1.1.4.2. rez.tests.test_build module

test the build system

class rez.tests.test_build.TestBuild(*nargs, **kwargs)

Bases: rez.tests.util.TestBase, rez.tests.util.TempdirMixin

classmethod setUpClass()

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

classmethod tearDownClass()

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

test_build_cmake()

Test a cmake-based package.

test_build_custom()

Test a make-based package that uses the custom_build attribute.

test_build_whack(shell)

Test that a broken build fails correctly.

test_builds(shell)

Test an interdependent set of builds.

test_builds_anti(shell)

Test we can build packages that contain anti packages

1.1.1.4.3. rez.tests.test_commands module

test package commands

class rez.tests.test_commands.TestCommands(fn)

Bases: rez.tests.util.TestBase

classmethod get_packages_path()

classmethod setUpClass()

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

test_2()

Resolve a package with a dependency, see that their commands are concatenated as expected.

test_new_yaml()

Resolve a yaml-based package with new rex commands.

test_old_yaml()

Resolve a yaml-based package with old-style bash commands.

test_py()

Resolve a new py-based package with rex commands.

1.1.1.4.4. rez.tests.test_context module

test resolved contexts

class rez.tests.test_context.TestContext(*nargs, **kwargs)

Bases: rez.tests.util.TestBase, rez.tests.util.TempdirMixin

classmethod setUpClass()

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

classmethod tearDownClass()

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

test_apply()

Test apply() function.

test_bundled()

Test that a bundled context behaves identically.

test_create_context()

Test creation of context.

test_execute_command()

Test command execution in context.

test_execute_command_environ()

Test that execute_command properly sets environ dict.

test_retarget()

Test that a retargeted context behaves identically.

test_serialize()

Test context serialization.

1.1.1.4.5. rez.tests.test_formatter module

test rex string formatting

class rez.tests.test_formatter.TestFormatter(*nargs, **kwargs)

Bases: rez.tests.util.TestBase

assert_formatter_equal(format, expected, *args, **kwargs)

assert_formatter_raises(format, error, *args, **kwargs)

setUp()

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

test_formatter_recurse()

test_formatter_rex()

test_formatter_stdlib()

string.Formatter.format tests from the Python standard library used to ensure we haven’t broken functionality preset in the standard implementation of the Formatter object.

1.1.1.4.6. rez.tests.test_rex module

test the rex command generator API

class rez.tests.test_rex.TestRex(*nargs, **kwargs)

Bases: rez.tests.util.TestBase

test_1()

Test simple use of every available action.

test_10()

Test env __contains__ and __bool__

test_2()

Test simple setenvs and assignments.

test_3()

Test appending/prepending.

test_4()

Test control flow using internally-set env vars.

test_5()

Test control flow using externally-set env vars.

test_6()

Test variable expansion.

test_7()

Test exceptions.

test_8()

Custom environment variable separators.

test_9()

Test literal and expandable strings.

test_intersects_ephemerals()

Test intersects with ephemerals object

test_intersects_request()

Test intersects with request object

test_intersects_resolve()

Test intersects with resolve object

test_old_style_commands()

Convert old style commands to rex

test_version_binding()

Test the Rex binding of the Version class.

1.1.1.4.7. rez.tests.test_shells module

test shell invocation

class rez.tests.test_shells.TestShells(*nargs, **kwargs)

Bases: rez.tests.util.TestBase, rez.tests.util.TempdirMixin

classmethod setUpClass()

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

classmethod tearDownClass()

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

test_aaa_shell_presence()

Ensure specific shell types are present as loaded plugins.

The env var _REZ_ENSURE_TEST_SHELLS should be set by a CI system (such as github actions) to make sure the shells we expect to be installed, are installed, and are getting tested.

Note ‘aaa’ forces unittest to run this test first.

test_alias_command(shell)

Testing alias can be passed in as command

This is important for Windows CMD shell because the doskey.exe isn’t executed yet when the alias is being passed.

test_alias_command_with_args(shell)

Testing alias can be passed in as command with args

This is important for Windows CMD shell because the doskey.exe isn’t executed yet when the alias is being passed.

test_command(shell)

test_command_returncode(shell)

test_create_executable_script()

test_no_output(shell)

test_norc(shell)

test_rcfile(shell)

test_rex_code(shell)

Test that Rex code run in the shell creates the environment variable values that we expect.

test_rex_code_alias(shell)

Ensure PATH changes do not influence the alias command.

This is important for Windows because the doskey.exe might not be on the PATH anymore at the time it’s executed. That’s why we figure out the absolute path to doskey.exe before we modify PATH and continue to use the absolute path after the modifications.

test_rez_command(shell)

test_rez_env_output(shell)

test_stdin(shell)

1.1.1.4.8. rez.tests.test_solver module

test dependency resolving algorithm

class rez.tests.test_solver.TestSolver(*nargs, **kwargs)

Bases: rez.tests.util.TestBase

classmethod setUpClass()

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

test_01()

Extremely basic solves involving a single package.

test_02()

Basic solves involving a single package.

test_03()

Failures in the initial request.

test_04()

Basic failures.

test_05()

More complex failures.

test_06()

Basic solves involving multiple packages.

test_07()

More complex solves.

test_08()

Cyclic failures.

test_09_version_priority_mode()

test_10_intersection_priority_mode()

test_11_variant_splitting()

1.1.1.4.9. rez.tests.util module

class rez.tests.util.TempdirMixin

Bases: object

Mixin that adds tmpdir create/delete.

classmethod setUpClass()

classmethod tearDownClass()

class rez.tests.util.TestBase(*nargs, **kwargs)

Bases: unittest.case.TestCase

Unit test base class.

classmethod data_path(*dirs)

Get path to test data.

get_settings_env()

Get an environ dict that applies the current settings.

This is required for cases where a subproc has to pick up the same config settings that the test case has set.

setUp()

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.

setup_config()

setup_once()

tearDown()

Hook method for deconstructing the test fixture after testing it.

teardown_config()

update_settings(new_settings, override=False)

Can be called within test methods to modify settings on a per-test basis (as opposed cls.settings, which modifies it for all tests on the class)

Note that multiple calls will not “accumulate” updates, but will instead patch the class’s settings with the new_settings each time.

new_settingsdict

the updated settings to override the config with

overridebool

normally, the resulting config will be the result of merging the base cls.settings with the new_settings - ie, like doing cls.settings.update(new_settings). If this is True, however, then the cls.settings will be ignored entirely, and the new_settings will be the only configuration settings applied

rez.tests.util.find_file_in_path(to_find, path_str, pathsep=None, reverse=True)

Attempts to find the given relative path to_find in the given path

rez.tests.util.install_dependent()

Function decorator that skips tests if not run via ‘rez-selftest’ tool, from a production install

rez.tests.util.per_available_shell(exclude=None)

Function decorator that runs the function over all available shell types.

rez.tests.util.program_dependent(program_name, *program_names)

Function decorator that skips the function if not all given programs are visible.

rez.tests.util.restore_os_environ()

Encapsulate changes to os.environ and return to the original state.

This context manager lets you wrap modifications of os.environ and not worry about reverting back to the original.

Examples

>>> key = 'ARBITRARY_KEY'
>>> value = 'arbitrary_value'
>>> with os_environ():
>>>     os.environ[key] = value
>>>     assert key in os.environ
True

>>> assert key in os.environ
False

Yields

dict – The original os.environ.

rez.tests.util.restore_sys_path()

Encapsulate changes to sys.path and return to the original state.

This context manager lets you wrap modifications of sys.path and not worry about reverting back to the original.

Examples

>>> path = '/arbitrary/path'
>>> with sys_path():
>>>     sys.path.insert(0, '/arbitrary/path')
>>>     assert path in sys.path
True

>>> assert path in sys.path
False

Yields

list – The original sys.path.

1.1.1.4.10. Module contents