Warning
This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.
galaxy.tool_util.verify package¶
Module of utilities for verifying test results.
- galaxy.tool_util.verify.verify(item_label, output_content, attributes, filename=None, get_filecontent=None, get_filename=None, keep_outputs_dir=None, verify_extra_files=None, mode='file')[source]¶
Verify the content of a test output using test definitions described by attributes.
Throw an informative assertion error if any of these tests fail.
- galaxy.tool_util.verify.make_temp_fname(fname=None)[source]¶
Safe temp name - preserve the file extension for tools that interpret it.
- galaxy.tool_util.verify.files_delta(file1, file2, attributes=None)[source]¶
Check the contents of 2 files for size differences.
- galaxy.tool_util.verify.files_diff(file1, file2, attributes=None)[source]¶
Check the contents of 2 files for differences.
- galaxy.tool_util.verify.files_re_match(file1, file2, attributes=None)[source]¶
Check the contents of 2 files for differences using re.match.
- galaxy.tool_util.verify.files_re_match_multiline(file1, file2, attributes=None)[source]¶
Check the contents of 2 files for differences using re.match in multiline mode.
- galaxy.tool_util.verify.files_contains(file1, file2, attributes=None)[source]¶
Check the contents of file2 for substrings found in file1, on a per-line basis.
Subpackages¶
Submodules¶
galaxy.tool_util.verify.interactor module¶
- class galaxy.tool_util.verify.interactor.OutputsDict[source]¶
Bases:
dict
Ordered dict that can also be accessed by index.
>>> out = OutputsDict() >>> out['item1'] = 1 >>> out['item2'] = 2 >>> out[1] == 2 == out['item2'] True
- galaxy.tool_util.verify.interactor.stage_data_in_history(galaxy_interactor, tool_id, all_test_data, history=None, force_path_paste=False, maxseconds=86400, tool_version=None)[source]¶
- class galaxy.tool_util.verify.interactor.GalaxyInteractorApi(**kwds)[source]¶
Bases:
object
- property target_galaxy_version¶
- property supports_test_data_download¶
- verify_output_collection(output_collection_def, output_collection_id, history, tool_id, tool_version=None)[source]¶
- verify_output(history_id, jobs, output_data, output_testdef, tool_id, maxseconds, tool_version=None)[source]¶
- galaxy.tool_util.verify.interactor.prepare_request_params(data=None, files=None, as_json: bool = False, params: Optional[dict] = None, headers: Optional[dict] = None, cookies: Optional[RequestsCookieJar] = None)[source]¶
- galaxy.tool_util.verify.interactor.ensure_tool_run_response_okay(submit_response_object, request_desc, inputs=None)[source]¶
- exception galaxy.tool_util.verify.interactor.RunToolException(message, inputs=None, dynamic_param_error=False)[source]¶
Bases:
Exception
- galaxy.tool_util.verify.interactor.verify_hid(filename, hda_id, attributes, test_data_downloader, hid='', dataset_fetcher=None, keep_outputs_dir=False)[source]¶
- galaxy.tool_util.verify.interactor.verify_collection(output_collection_def, data_collection, verify_dataset)[source]¶
- galaxy.tool_util.verify.interactor.verify_tool(tool_id, galaxy_interactor, resource_parameters=None, register_job_data=None, test_index=0, tool_version=None, quiet=False, test_history=None, no_history_cleanup=False, publish_history=False, force_path_paste=False, maxseconds=86400, tool_test_dicts=None, client_test_config=None, skip_with_reference_data=False, skip_on_dynamic_param_errors=False)[source]¶
- exception galaxy.tool_util.verify.interactor.JobOutputsError(output_exceptions, job_stdio)[source]¶
Bases:
AssertionError
- class galaxy.tool_util.verify.interactor.ToolTestDescription(processed_test_dict)[source]¶
Bases:
object
Encapsulates information about a tool test, and allows creation of a dynamic TestCase class (the unittest framework is very class oriented, doing dynamic tests in this way allows better integration)
galaxy.tool_util.verify.script module¶
- class galaxy.tool_util.verify.script.TestReference(tool_id, tool_version, test_index)¶
Bases:
tuple
- property test_index¶
Alias for field number 2
- property tool_id¶
Alias for field number 0
- property tool_version¶
Alias for field number 1
- class galaxy.tool_util.verify.script.TestException(tool_id, exception, was_recorded)¶
Bases:
tuple
- property exception¶
Alias for field number 1
- property tool_id¶
Alias for field number 0
- property was_recorded¶
Alias for field number 2
- class galaxy.tool_util.verify.script.Results(default_suitename, test_json, append=False, galaxy_url=None)[source]¶
Bases:
object
- property success_count¶
- property skip_count¶
- property error_count¶
- property failure_count¶
- galaxy.tool_util.verify.script.test_tools(galaxy_interactor, test_references, results, log=None, parallel_tests=1, history_per_test_case=False, history_name=None, no_history_reuse=False, no_history_cleanup=False, publish_history=False, retries=0, verify_kwds=None)[source]¶
Run through tool tests and write report.
Refactor this into Galaxy in 21.01.
galaxy.tool_util.verify.test_data module¶
- class galaxy.tool_util.verify.test_data.TestDataResolver(file_dirs=None, env_var='GALAXY_TEST_FILE_DIR', environ=environ({'POWERSHELL_DISTRIBUTION_CHANNEL': 'GitHub-Actions-ubuntu20', 'ANDROID_NDK_ROOT': '/usr/local/lib/android/sdk/ndk-bundle', 'GITHUB_EVENT_NAME': 'push', 'GITHUB_ACTION': '__run_8', 'GITHUB_REPOSITORY': 'galaxyproject/galaxy', 'GRADLE_HOME': '/usr/share/gradle-7.4.2', 'GITHUB_WORKFLOW': 'Build docs', 'PERFLOG_LOCATION_SETTING': 'RUNNER_PERFLOG', 'GITHUB_REF_PROTECTED': 'true', 'JOURNAL_STREAM': '8:22677', 'GITHUB_REF_NAME': 'dev', 'LEIN_HOME': '/usr/local/lib/lein', 'GITHUB_GRAPHQL_URL': 'https://api.github.com/graphql', 'GOROOT_1_16_X64': '/opt/hostedtoolcache/go/1.16.15/x64', 'GITHUB_BASE_REF': '', 'GITHUB_ENV': '/home/runner/work/_temp/_runner_file_commands/set_env_e41e163f-4f34-4cb1-a4ed-0e833c26779d', 'RUNNER_ARCH': 'X64', 'STATS_KEEPALIVE': 'false', 'GOROOT_1_17_X64': '/opt/hostedtoolcache/go/1.17.11/x64', '_': '/usr/bin/make', 'ANDROID_NDK_LATEST_HOME': '/usr/local/lib/android/sdk/ndk/24.0.8215888', 'RUNNER_PERFLOG': '/home/runner/perflog', 'RUNNER_TOOL_CACHE': '/opt/hostedtoolcache', 'USER': 'runner', 'DOTNET_MULTILEVEL_LOOKUP': '0', 'DEPLOYMENT_BASEPATH': '/opt/runner', 'DOTNET_SKIP_FIRST_TIME_EXPERIENCE': '1', 'PATH': '/opt/hostedtoolcache/Python/3.7.13/x64/bin:/opt/hostedtoolcache/Python/3.7.13/x64:/home/linuxbrew/.linuxbrew/bin:/home/linuxbrew/.linuxbrew/sbin:/home/runner/.local/bin:/opt/pipx_bin:/home/runner/.cargo/bin:/home/runner/.config/composer/vendor/bin:/usr/local/.ghcup/bin:/home/runner/.dotnet/tools:/snap/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin', 'TARGET_BRANCH': 'upstream/dev', 'ImageOS': 'ubuntu20', 'GITHUB_ACTION_REF': '', 'GRAALVM_11_ROOT': '/usr/local/graalvm/graalvm-ce-java11-22.1.0', 'GITHUB_SERVER_URL': 'https://github.com', 'PIPX_BIN_DIR': '/opt/pipx_bin', 'PIPX_HOME': '/opt/pipx', 'GITHUB_RUN_NUMBER': '11309', 'GOROOT_1_18_X64': '/opt/hostedtoolcache/go/1.18.3/x64', 'INVOCATION_ID': '09698ea2ba13466f9fefde87a88e24ec', 'ANDROID_HOME': '/usr/local/lib/android/sdk', 'GITHUB_ACTOR': 'jmchilton', 'LEIN_JAR': '/usr/local/lib/lein/self-installs/leiningen-2.9.8-standalone.jar', 'AZURE_EXTENSION_DIR': '/opt/az/azcliextensions', 'CONDA': '/usr/share/miniconda', 'JAVA_HOME_8_X64': '/usr/lib/jvm/temurin-8-jdk-amd64', 'HOMEBREW_CELLAR': '/home/linuxbrew/.linuxbrew/Cellar', 'ANT_HOME': '/usr/share/ant', 'ImageVersion': '20220626.1', 'GITHUB_REPOSITORY_OWNER': 'galaxyproject', 'HOME': '/home/runner', 'LD_LIBRARY_PATH': '/opt/hostedtoolcache/Python/3.7.13/x64/lib/python3.7/site-packages/pylibmagic:/opt/hostedtoolcache/Python/3.7.13/x64/lib', 'SGX_AESM_ADDR': '1', 'GECKOWEBDRIVER': '/usr/local/share/gecko_driver', 'RUNNER_TEMP': '/home/runner/work/_temp', 'VCPKG_INSTALLATION_ROOT': '/usr/local/share/vcpkg', 'GITHUB_REF': 'refs/heads/dev', 'GITHUB_PATH': '/home/runner/work/_temp/_runner_file_commands/add_path_e41e163f-4f34-4cb1-a4ed-0e833c26779d', 'ANDROID_NDK_HOME': '/usr/local/lib/android/sdk/ndk-bundle', 'CI': 'true', 'SHLVL': '1', 'HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS': '3650', 'GITHUB_JOB': 'build', 'JAVA_HOME': '/usr/lib/jvm/temurin-11-jdk-amd64', 'GITHUB_REF_TYPE': 'branch', 'GITHUB_ACTION_REPOSITORY': '', 'BOOTSTRAP_HASKELL_NONINTERACTIVE': '1', 'GITHUB_ACTIONS': 'true', 'GITHUB_HEAD_REF': '', 'GITHUB_RUN_ATTEMPT': '1', 'RUNNER_TRACKING_ID': 'github_154d355b-9cea-4b7f-9177-1ebf7ac1e802', 'MAKEFLAGS': 'w', 'MFLAGS': '-w', 'NVM_DIR': '/home/runner/.nvm', 'HOMEBREW_PREFIX': '/home/linuxbrew/.linuxbrew', 'GITHUB_EVENT_PATH': '/home/runner/work/_temp/_github_workflow/event.json', 'AGENT_TOOLSDIRECTORY': '/opt/hostedtoolcache', 'HOMEBREW_REPOSITORY': '/home/linuxbrew/.linuxbrew/Homebrew', 'ACCEPT_EULA': 'Y', 'GITHUB_STEP_SUMMARY': '/home/runner/work/_temp/_runner_file_commands/step_summary_e41e163f-4f34-4cb1-a4ed-0e833c26779d', 'HOMEBREW_NO_AUTO_UPDATE': '1', 'XDG_CONFIG_HOME': '/home/runner/.config', 'RUNNER_USER': 'runner', 'GITHUB_API_URL': 'https://api.github.com', 'ANDROID_SDK_ROOT': '/usr/local/lib/android/sdk', 'PWD': '/home/runner/work/galaxy/galaxy', 'STATS_PFS': 'true', 'GITHUB_RUN_ID': '2612606548', 'SWIFT_PATH': '/usr/share/swift/usr/bin', 'DEBIAN_FRONTEND': 'noninteractive', 'CHROME_BIN': '/usr/bin/google-chrome', 'RUNNER_NAME': 'GitHub Actions 42', 'GITHUB_WORKSPACE': '/home/runner/work/galaxy/galaxy', 'GITHUB_SHA': '1a7934dee46774642a5fbdf94ac4bda688744eff', 'pythonLocation': '/opt/hostedtoolcache/Python/3.7.13/x64', 'RUNNER_WORKSPACE': '/home/runner/work/galaxy', 'CHROMEWEBDRIVER': '/usr/local/share/chrome_driver', 'DOTNET_NOLOGO': '1', 'JAVA_HOME_11_X64': '/usr/lib/jvm/temurin-11-jdk-amd64', 'XDG_RUNTIME_DIR': '/run/user/1001', 'RUNNER_OS': 'Linux', 'GITHUB_RETENTION_DAYS': '90', 'SELENIUM_JAR_PATH': '/usr/share/java/selenium-server.jar', 'JAVA_HOME_17_X64': '/usr/lib/jvm/temurin-17-jdk-amd64', 'LANG': 'C.UTF-8', 'MAKELEVEL': '2', 'DOCUTILSCONFIG': '/home/runner/work/galaxy/galaxy/doc/source/docutils.conf', 'LIBRARY_PATH': '/opt/hostedtoolcache/Python/3.7.13/x64/lib/python3.7/site-packages/pylibmagic:', 'MAGIC': '/opt/hostedtoolcache/Python/3.7.13/x64/lib/python3.7/site-packages/pylibmagic/magic.mgc:'}))[source]¶
Bases:
object
- __init__(file_dirs=None, env_var='GALAXY_TEST_FILE_DIR', environ=environ({'POWERSHELL_DISTRIBUTION_CHANNEL': 'GitHub-Actions-ubuntu20', 'ANDROID_NDK_ROOT': '/usr/local/lib/android/sdk/ndk-bundle', 'GITHUB_EVENT_NAME': 'push', 'GITHUB_ACTION': '__run_8', 'GITHUB_REPOSITORY': 'galaxyproject/galaxy', 'GRADLE_HOME': '/usr/share/gradle-7.4.2', 'GITHUB_WORKFLOW': 'Build docs', 'PERFLOG_LOCATION_SETTING': 'RUNNER_PERFLOG', 'GITHUB_REF_PROTECTED': 'true', 'JOURNAL_STREAM': '8:22677', 'GITHUB_REF_NAME': 'dev', 'LEIN_HOME': '/usr/local/lib/lein', 'GITHUB_GRAPHQL_URL': 'https://api.github.com/graphql', 'GOROOT_1_16_X64': '/opt/hostedtoolcache/go/1.16.15/x64', 'GITHUB_BASE_REF': '', 'GITHUB_ENV': '/home/runner/work/_temp/_runner_file_commands/set_env_e41e163f-4f34-4cb1-a4ed-0e833c26779d', 'RUNNER_ARCH': 'X64', 'STATS_KEEPALIVE': 'false', 'GOROOT_1_17_X64': '/opt/hostedtoolcache/go/1.17.11/x64', '_': '/usr/bin/make', 'ANDROID_NDK_LATEST_HOME': '/usr/local/lib/android/sdk/ndk/24.0.8215888', 'RUNNER_PERFLOG': '/home/runner/perflog', 'RUNNER_TOOL_CACHE': '/opt/hostedtoolcache', 'USER': 'runner', 'DOTNET_MULTILEVEL_LOOKUP': '0', 'DEPLOYMENT_BASEPATH': '/opt/runner', 'DOTNET_SKIP_FIRST_TIME_EXPERIENCE': '1', 'PATH': '/opt/hostedtoolcache/Python/3.7.13/x64/bin:/opt/hostedtoolcache/Python/3.7.13/x64:/home/linuxbrew/.linuxbrew/bin:/home/linuxbrew/.linuxbrew/sbin:/home/runner/.local/bin:/opt/pipx_bin:/home/runner/.cargo/bin:/home/runner/.config/composer/vendor/bin:/usr/local/.ghcup/bin:/home/runner/.dotnet/tools:/snap/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin', 'TARGET_BRANCH': 'upstream/dev', 'ImageOS': 'ubuntu20', 'GITHUB_ACTION_REF': '', 'GRAALVM_11_ROOT': '/usr/local/graalvm/graalvm-ce-java11-22.1.0', 'GITHUB_SERVER_URL': 'https://github.com', 'PIPX_BIN_DIR': '/opt/pipx_bin', 'PIPX_HOME': '/opt/pipx', 'GITHUB_RUN_NUMBER': '11309', 'GOROOT_1_18_X64': '/opt/hostedtoolcache/go/1.18.3/x64', 'INVOCATION_ID': '09698ea2ba13466f9fefde87a88e24ec', 'ANDROID_HOME': '/usr/local/lib/android/sdk', 'GITHUB_ACTOR': 'jmchilton', 'LEIN_JAR': '/usr/local/lib/lein/self-installs/leiningen-2.9.8-standalone.jar', 'AZURE_EXTENSION_DIR': '/opt/az/azcliextensions', 'CONDA': '/usr/share/miniconda', 'JAVA_HOME_8_X64': '/usr/lib/jvm/temurin-8-jdk-amd64', 'HOMEBREW_CELLAR': '/home/linuxbrew/.linuxbrew/Cellar', 'ANT_HOME': '/usr/share/ant', 'ImageVersion': '20220626.1', 'GITHUB_REPOSITORY_OWNER': 'galaxyproject', 'HOME': '/home/runner', 'LD_LIBRARY_PATH': '/opt/hostedtoolcache/Python/3.7.13/x64/lib/python3.7/site-packages/pylibmagic:/opt/hostedtoolcache/Python/3.7.13/x64/lib', 'SGX_AESM_ADDR': '1', 'GECKOWEBDRIVER': '/usr/local/share/gecko_driver', 'RUNNER_TEMP': '/home/runner/work/_temp', 'VCPKG_INSTALLATION_ROOT': '/usr/local/share/vcpkg', 'GITHUB_REF': 'refs/heads/dev', 'GITHUB_PATH': '/home/runner/work/_temp/_runner_file_commands/add_path_e41e163f-4f34-4cb1-a4ed-0e833c26779d', 'ANDROID_NDK_HOME': '/usr/local/lib/android/sdk/ndk-bundle', 'CI': 'true', 'SHLVL': '1', 'HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS': '3650', 'GITHUB_JOB': 'build', 'JAVA_HOME': '/usr/lib/jvm/temurin-11-jdk-amd64', 'GITHUB_REF_TYPE': 'branch', 'GITHUB_ACTION_REPOSITORY': '', 'BOOTSTRAP_HASKELL_NONINTERACTIVE': '1', 'GITHUB_ACTIONS': 'true', 'GITHUB_HEAD_REF': '', 'GITHUB_RUN_ATTEMPT': '1', 'RUNNER_TRACKING_ID': 'github_154d355b-9cea-4b7f-9177-1ebf7ac1e802', 'MAKEFLAGS': 'w', 'MFLAGS': '-w', 'NVM_DIR': '/home/runner/.nvm', 'HOMEBREW_PREFIX': '/home/linuxbrew/.linuxbrew', 'GITHUB_EVENT_PATH': '/home/runner/work/_temp/_github_workflow/event.json', 'AGENT_TOOLSDIRECTORY': '/opt/hostedtoolcache', 'HOMEBREW_REPOSITORY': '/home/linuxbrew/.linuxbrew/Homebrew', 'ACCEPT_EULA': 'Y', 'GITHUB_STEP_SUMMARY': '/home/runner/work/_temp/_runner_file_commands/step_summary_e41e163f-4f34-4cb1-a4ed-0e833c26779d', 'HOMEBREW_NO_AUTO_UPDATE': '1', 'XDG_CONFIG_HOME': '/home/runner/.config', 'RUNNER_USER': 'runner', 'GITHUB_API_URL': 'https://api.github.com', 'ANDROID_SDK_ROOT': '/usr/local/lib/android/sdk', 'PWD': '/home/runner/work/galaxy/galaxy', 'STATS_PFS': 'true', 'GITHUB_RUN_ID': '2612606548', 'SWIFT_PATH': '/usr/share/swift/usr/bin', 'DEBIAN_FRONTEND': 'noninteractive', 'CHROME_BIN': '/usr/bin/google-chrome', 'RUNNER_NAME': 'GitHub Actions 42', 'GITHUB_WORKSPACE': '/home/runner/work/galaxy/galaxy', 'GITHUB_SHA': '1a7934dee46774642a5fbdf94ac4bda688744eff', 'pythonLocation': '/opt/hostedtoolcache/Python/3.7.13/x64', 'RUNNER_WORKSPACE': '/home/runner/work/galaxy', 'CHROMEWEBDRIVER': '/usr/local/share/chrome_driver', 'DOTNET_NOLOGO': '1', 'JAVA_HOME_11_X64': '/usr/lib/jvm/temurin-11-jdk-amd64', 'XDG_RUNTIME_DIR': '/run/user/1001', 'RUNNER_OS': 'Linux', 'GITHUB_RETENTION_DAYS': '90', 'SELENIUM_JAR_PATH': '/usr/share/java/selenium-server.jar', 'JAVA_HOME_17_X64': '/usr/lib/jvm/temurin-17-jdk-amd64', 'LANG': 'C.UTF-8', 'MAKELEVEL': '2', 'DOCUTILSCONFIG': '/home/runner/work/galaxy/galaxy/doc/source/docutils.conf', 'LIBRARY_PATH': '/opt/hostedtoolcache/Python/3.7.13/x64/lib/python3.7/site-packages/pylibmagic:', 'MAGIC': '/opt/hostedtoolcache/Python/3.7.13/x64/lib/python3.7/site-packages/pylibmagic/magic.mgc:'}))[source]¶
galaxy.tool_util.verify.wait module¶
Abstraction for waiting on API conditions to become true.
- galaxy.tool_util.verify.wait.wait_on(function: Callable, desc: str, timeout: Union[int, float], delta: Union[int, float] = 0.25, polling_backoff: Union[int, float] = 0, sleep_: Optional[Callable] = None)[source]¶
Wait for function to return non-None value.
Grow the polling interval (initially
delta
defaulting to 0.25 seconds) incrementally by the suppliedpolling_backoff
(defaulting to 0).Throw a TimeoutAssertionError if the supplied timeout is reached without supplied function ever returning a non-None value.
- exception galaxy.tool_util.verify.wait.TimeoutAssertionError(message)[source]¶
Bases:
AssertionError
Derivative of AssertionError indicating wait_on exceeded max time.