3. Test Code Documentation

3.1. repobuddy.tests – Root package for tests

3.2. repobuddy.tests.arg_parser – Argument Parser tests

class repobuddy.tests.arg_parser.ArgParserTestCase(methodName='runTest')

Bases: repobuddy.tests.common.TestCaseBase

classmethod setUpClass()

classmethod tearDownClass()

__init__(methodName='runTest')

setUp()

test_help()

test_version()

test_init_help()

test_status_help()

test_help_unsupported_command()

test_unsupported_command()

test_handlers()

class repobuddy.tests.arg_parser.ArgParserTestSuite

classmethod get_test_suite()

3.3. repobuddy.tests.client_info – Client Info tests

class repobuddy.tests.client_info.ClientInfoTestCase(methodName='runTest')

Bases: repobuddy.tests.common.TestCaseBase

classmethod setUpClass()

classmethod tearDownClass()

__init__(methodName='runTest')

test_read_nonexistent_file()

test_read_without_permissions()

test_read_malformed_file()

test_read_empty_file()

test_read_without_section_header()

test_read_just_section()

test_read_just_options()

test_read_no_client_spec()

test_read_no_manifest()

test_read_valid()

test_read_valid_writeback()

test_create_new_config()

class repobuddy.tests.client_info.ClientInfoTestSuite

classmethod get_test_suite()

3.4. repobuddy.tests.command_handler – Command Handler tests

class repobuddy.tests.command_handler.CommandHandlerTestCase(methodName='runTest')

Bases: repobuddy.tests.common.TestCaseBase

classmethod setUpClass()

classmethod tearDownClass()

__init__(methodName='runTest')

setUp()

test_verify_handlers()

test_init_client_valid()

class repobuddy.tests.command_handler.CommandHandlerTestSuite

classmethod get_test_suite()

3.5. repobuddy.tests.common – Test Framework

exception repobuddy.tests.common.ShellError(error_str)

Bases: repobuddy.utils.RepoBuddyBaseException

Exception raised by ShellHelper.

__init__(error_str)

Initializer.

Parameters:error_str (str) – The error string to store in the exception.

class repobuddy.tests.common.ShellHelper

Helper for performing shell operations.

classmethod exec_command(command, base_dir, debug_output=True)

Execute a command.

Parameters:

• command (str) – The command to execute.
• base_dir (str) – The base directory path.
• debug_output – If set to False, the output of the command is NOT printed on stdout and stderr.

Returns:

None

Raises:

ShellError if the program’s execution returned a non-zero return or any other errors.

classmethod read_file_as_string(filename)

Read the contents of the file as a string and return it.

Parameters:filename (str) – The name of the file to read. Returns:Contents of the file. Return type:str Raises:ShellError on errors.

classmethod append_text_to_file(text, filename, base_dir)

classmethod remove_file(filename)

classmethod make_dir(dirname, create_parent_dirs=False, only_if_not_exists=False)

classmethod remove_dir(dirname)

class repobuddy.tests.common.TestCommon

classmethod get_string_stream()

classmethod setup_test_repos(base_dir)

class repobuddy.tests.common.TestCaseBase(methodName='runTest')

Bases: unittest.case.TestCase

__init__(methodName='runTest')

setUp()

tearDown()

class repobuddy.tests.common.TestResult

Bases: unittest.result.TestResult

PASSED = 0

ERROR = 1

FAILED = 2

SKIPPED = 3

EXPECTED_FAILURE = 4

UNEXPECTED_SUCCESS = 5

__init__()

classmethod get_result_str(result)

addError(test, err)

addFailure(test, err)

addSuccess(test)

addSkip(test, reason)

addExpectedFailure(test, err)

addUnexpectedSuccess(test)

class repobuddy.tests.common.TestRunner(stream, descriptions=True, verbosity=1)

Bases: unittest.runner.TextTestRunner

__init__(stream, descriptions=True, verbosity=1)

get_test_result()

class repobuddy.tests.common.TestSuiteManager(base_dir)

Bases: object

classmethod get_base_dir()

__init__(base_dir)

add_test_suite(test_suite)

run()

show_results()

was_successful()

3.6. repobuddy.tests.git_wrapper – Git Wrapper tests

class repobuddy.tests.git_wrapper.GitWrapperTestCase(methodName='runTest')

Bases: repobuddy.tests.common.TestCaseBase

classmethod setUpClass()

classmethod tearDownClass()

__init__(methodName='runTest')

test_clone_valid_repo()

test_clone_invalid_url()

test_clone_invalid_branch()

test_clone_no_write_permissions()

test_update_index_valid_repo()

test_update_index_invalid_repo()

test_untracked_no_files()

test_untracked_with_files()

test_unstaged_no_files()

test_unstaged_with_files()

test_uncommitted_no_changes()

test_uncommitted_with_changes()

test_current_branch_valid_repo()

test_current_branch_invalid_repo()

test_current_branch_detached_head()

test_current_tag_lightweight_tag()

test_current_tag_annotated_tag()

test_current_tag_no_tag()

class repobuddy.tests.git_wrapper.GitWrapperTestSuite

classmethod get_test_suite()

3.7. repobuddy.tests.main – Main routine for the tests

repobuddy.tests.main.run_tests()

3.8. repobuddy.tests.manifest_parser – Manifest Parser tests

class repobuddy.tests.manifest_parser.ManifestParserTestCase(methodName='runTest')

Bases: repobuddy.tests.common.TestCaseBase

__init__(methodName='runTest')

test_repo_str_repr()

test_client_spec_str_repr()

test_manifest_str_repr()

test_parse_invalid_file_handle()

test_valid_manifest()

test_malformed()

test_no_client_spec()

test_empty_client_spec()

test_client_spec_no_name()

test_empty_repo()

test_repo_no_url()

test_repo_empty_url()

test_repo_no_branch()

test_repo_empty_branch()

test_repo_no_dest()

test_repo_empty_dest()

test_no_default_client_spec()

test_empty_default_client_spec()

test_nonexistent_default_client_spec()

test_duplicate_client_spec()

class repobuddy.tests.manifest_parser.ManifestParserTestSuite

classmethod get_test_suite()

3.9. repobuddy.tests.utils – Utilities tests

class repobuddy.tests.utils.UtilsTestCase(methodName='runTest')

Bases: repobuddy.tests.common.TestCaseBase

classmethod setUpClass()

classmethod tearDownClass()

__init__(methodName='runTest')

test_file_lock_basic()

test_file_lock_multiple_times()

test_file_lock_multiple_threads()

test_file_lock_delete_with_acquire()

test_file_lock_dir_without_permissions()

class repobuddy.tests.utils.UtilsTestSuite

classmethod get_test_suite()