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_test.selenium package

Submodules

galaxy_test.selenium.framework module

Basis for Selenium test framework.

galaxy_test.selenium.framework.managed_history(f)

Ensure a Selenium test has a distinct, named history.

Cleanup the history after the job is complete as well unless GALAXY_TEST_NO_CLEANUP is set in the environment.

galaxy_test.selenium.framework.dump_test_information(self, name_prefix)

galaxy_test.selenium.framework.selenium_test(f)

class galaxy_test.selenium.framework.TestSnapshot(driver, index, description)

Bases: object

__init__(driver, index, description)

write_to_error_directory(write_file_func)

class galaxy_test.selenium.framework.TestWithSeleniumMixin

Bases: galaxy.selenium.navigates_galaxy.NavigatesGalaxy, galaxy_test.driver.api.UsesApiTestCaseMixin

framework_tool_and_types = True

ensure_registered = False

requires_admin = False

setup_selenium()

setup_with_driver()

Override point that allows setting up data using self.driver and Selenium connection.

Overriding this instead of setUp will ensure debug data such as screenshots and stack traces are dumped if there are problems with the setup and it will be re-ran on test retries.

tear_down_selenium()

snapshot(description)

Create a debug snapshot (DOM, screenshot, etc…) that is written out on tool failure.

This information will be automatically written to a per-test directory created for all failed tests.

screenshot(label)

If GALAXY_TEST_SCREENSHOTS_DIRECTORY is set create a screenshot there named <label>.png.

Unlike the above “snapshot” feature, this will be written out regardless and not in a per-test directory. The above method is used for debugging failures within a specific test. This method if more for creating a set of images to augment automated testing with manual human inspection after a test or test suite has executed.

write_screenshot_directory_file(label, content)

reset_driver_and_session()

setup_driver_and_session()

login()

tear_down_driver()

default_web_host = '127.0.0.1'

timeout_multiplier

build_url(url, for_selenium=True)

assert_initial_history_panel_state_correct()

admin_login()

dataset_populator

dataset_collection_populator

workflow_populator

workflow_upload_yaml_with_random_name(content, **kwds)

ensure_visualization_available(hid, visualization_name)

Skip or fail a test if visualization for file doesn’t appear.

Precondition: viz menu has been opened with history_panel_item_click_visualization_menu.

class galaxy_test.selenium.framework.SeleniumTestCase(methodName='runTest')

Bases: galaxy_test.driver.testcase.FunctionalTestCase, galaxy_test.selenium.framework.TestWithSeleniumMixin

setUp()

tearDown()

class galaxy_test.selenium.framework.SharedStateSeleniumTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

This describes a class Selenium tests that setup class state for all tests.

This is a bit hacky because we are simulating class level initialization with instance level methods. The problem is that super.setUp() works at instance level. It might be worth considering having two variants of SeleniumTestCase - one that initializes with the class and the other that initializes with the instance but all the helpers are instance helpers.

shared_state_initialized = False

shared_state_in_error = False

setup_with_driver()

setup_shared_state()

Override this to setup shared data for tests that gets initialized only once.

class galaxy_test.selenium.framework.UsesHistoryItemAssertions

Bases: object

assert_item_peek_includes(hid, expected)

assert_item_info_includes(hid, expected)

assert_item_dbkey_displayed_as(hid, dbkey)

assert_item_summary_includes(hid, expected_text)

assert_item_name(hid, expected_name)

assert_item_hid_text(hid)

galaxy_test.selenium.framework.default_web_host_for_selenium_tests()

galaxy_test.selenium.framework.get_driver()

galaxy_test.selenium.framework.headless_selenium()

galaxy_test.selenium.framework.use_virtual_display()

galaxy_test.selenium.framework.get_local_driver()

galaxy_test.selenium.framework.get_remote_driver()

class galaxy_test.selenium.framework.SeleniumSessionGetPostMixin

Bases: object

Mixin for adapting Galaxy testing populators helpers to Selenium session backed bioblend.

class galaxy_test.selenium.framework.SeleniumSessionDatasetPopulator(selenium_test_case)

Bases: galaxy_test.base.populators.BaseDatasetPopulator, galaxy_test.selenium.framework.SeleniumSessionGetPostMixin

Implementation of BaseDatasetPopulator backed by bioblend.

__init__(selenium_test_case)

Construct a dataset populator from a bioblend GalaxyInstance.

class galaxy_test.selenium.framework.SeleniumSessionDatasetCollectionPopulator(selenium_test_case)

Bases: galaxy_test.base.populators.BaseDatasetCollectionPopulator, galaxy_test.selenium.framework.SeleniumSessionGetPostMixin

Implementation of BaseDatasetCollectionPopulator backed by bioblend.

__init__(selenium_test_case)

Construct a dataset collection populator from a bioblend GalaxyInstance.

class galaxy_test.selenium.framework.SeleniumSessionWorkflowPopulator(selenium_test_case)

Bases: galaxy_test.base.populators.BaseWorkflowPopulator, galaxy_test.selenium.framework.SeleniumSessionGetPostMixin, gxformat2.interface.ImporterGalaxyInterface

Implementation of BaseWorkflowPopulator backed by bioblend.

__init__(selenium_test_case)

Construct a workflow populator from a bioblend GalaxyInstance.

import_workflow(workflow, **kwds)

upload_yaml_workflow(has_yaml, **kwds)

galaxy_test.selenium.test_admin_app module

class galaxy_test.selenium.test_admin_app.AdminAppTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

requires_admin = True

test_admin_toolshed()

This tests installing a repository, checking for upgrades, and uninstalling.

A repository named a_selenium_test_repo has been created for this test, owned by devteam@galaxyproject.org. The repository contains a tool with two versions, and the oldest version gets installed so that there will be an upgrade available on the ‘Installed Only’ view. Unfortunately, since this test relies on the presence of the toolshed server, in some cases it will fail even if the galaxy code is correct, necessitating the use of the @flakey decorator.

test_admin_server_display()

test_admin_user_display()

test_admin_data_manager()

galaxy_test.selenium.test_anon_history module

class galaxy_test.selenium.test_anon_history.AnonymousHistoriesTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

test_anon_history_landing()

test_anon_history_upload()

test_anon_history_after_registration()

test_clean_anon_history_after_logout()

galaxy_test.selenium.test_change_password module

class galaxy_test.selenium.test_change_password.ChangePasswordTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

test_change_password()

test_new_password_password()

test_no_password_confirmation()

test_currect_password_incorrect()

test_new_password_short()

test_new_password_same_password()

register_and_change_password()

fill_input_fields(current, password, confirm)

galaxy_test.selenium.test_collection_builders module

class galaxy_test.selenium.test_collection_builders.CollectionBuildersTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

ensure_registered = True

test_build_list_simple()

test_build_list_and_hide_items()

test_build_pair_simple()

test_build_paired_list_simple()

test_build_paired_list_hide_original()

test_build_simple_list_via_rules()

galaxy_test.selenium.test_custom_builds module

class galaxy_test.selenium.test_custom_builds.CustomBuildsTestcase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SharedStateSeleniumTestCase

test_build_add()

test_build_delete()

assert_custom_builds_in_grid(expected_builds, present=True)

add_custom_build(build_name, build_key)

delete_custom_build(build_name)

get_custom_builds()

navigate_to_custom_builds_page()

setup_shared_state()

galaxy_test.selenium.test_histories_list module

class galaxy_test.selenium.test_histories_list.SavedHistoriesTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SharedStateSeleniumTestCase

test_histories_list()

test_history_switch()

test_history_view()

test_history_publish()

test_rename_history()

test_delete_and_undelete_history()

test_permanently_delete_history()

test_delete_and_undelete_multiple_histories()

test_sort_by_name()

test_standard_search()

test_advanced_search()

test_tags()

assert_grid_histories_are(expected_histories, sort_matters=True)

assert_histories_in_grid(expected_histories, present=True)

get_histories()

set_filter(selector, value)

unset_filter(filter_key, filter_value)

navigate_to_histories_page()

setup_shared_state()

create_history(name)

select_filter(filter_key, filter_value)

get_history_tags_cell(history_name)

check_histories(histories)

galaxy_test.selenium.test_history_copy_elements module

class galaxy_test.selenium.test_history_copy_elements.HistoryCopyElementsTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

ensure_registered = True

test_copy_hdca()

galaxy_test.selenium.test_history_dataset_state module

class galaxy_test.selenium.test_history_dataset_state.HistoryDatasetStateTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase, galaxy_test.selenium.framework.UsesHistoryItemAssertions

test_dataset_state()

galaxy_test.selenium.test_history_multi_view module

class galaxy_test.selenium.test_history_multi_view.HistoryMultiViewTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

ensure_registered = True

test_create_new_old_slides_next()

test_list_list_display()

test_list_list_list_display()

test_copy_history()

test_delete_history()

test_purge_history()

test_switch_history()

1. Load the multi history view. There should be a selector for the button to create a new history.
2. Create a new history. This should automatically switch to the newly created history.
3. Switch back to the original history. A button should appear on the old, previously created history that allows switching back to that one, and the history ID should now match the ID of the history with which we started.

assert_history(history_id, histories_number=1, should_exist=True)

copy_history(history_id)

prepare_multi_history_view(collection_populator_method)

galaxy_test.selenium.test_history_options module

class galaxy_test.selenium.test_history_options.HistoryOptionsTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

test_options()

galaxy_test.selenium.test_history_panel module

class galaxy_test.selenium.test_history_panel.HistoryPanelTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

test_history_panel_landing_state()

test_history_panel_rename()

test_history_rename_cancel_with_click()

test_history_rename_cancel_with_escape()

test_history_tags_and_annotations_buttons()

test_refresh_preserves_state()

galaxy_test.selenium.test_history_panel_collections module

class galaxy_test.selenium.test_history_panel_collections.HistoryPanelCollectionsTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

ensure_registered = True

test_mapping_collection_states_terminal()

test_mapping_collection_states_running()

test_output_collection_states_terminal()

test_output_collection_states_running()

test_collection_operations()

test_name_tags_display()

test_paired_display()

test_list_display()

test_list_paired_display()

test_list_list_display()

test_limiting_collection_rendering()

galaxy_test.selenium.test_history_panel_pagination module

class galaxy_test.selenium.test_history_panel_pagination.HistoryPanelPaginationTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

ensure_registered = True

test_pagination()

galaxy_test.selenium.test_history_sharing module

class galaxy_test.selenium.test_history_sharing.HistorySharingTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

test_sharing_valid()

test_sharing_valid_by_id()

test_unsharing()

test_unshared_history_inaccessible()

test_sharing_with_invalid_user()

test_sharing_with_self()

setup_two_users_with_one_shared_history(share_by_id=False)

navigate_to_history_share_page()

navigate_to_history_user_share_page()

share_history_with_user(user_id=None, user_email=None, assert_valid=False, screenshot=False)

Share the current history with a target user by ID or email.

user_email will be used to enter in the share form unless user_id is also specified. The user_email however is always used to check the result if assert_valid is True.

galaxy_test.selenium.test_jupyter module

class galaxy_test.selenium.test_jupyter.JupyterTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

ensure_registered = True

test_jupyter_launch()

test_jupyter_interaction()

galaxy_test.selenium.test_library_contents module

class galaxy_test.selenium.test_library_contents.LibraryContentsTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

requires_admin = True

test_create_folder()

test_import_dataset_from_history()

test_show_details()

galaxy_test.selenium.test_library_landing module

class galaxy_test.selenium.test_library_landing.LibraryLandingTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

requires_admin = True

setup_with_driver()

test_create_new_close()

test_create_new()

test_rename()

test_sorting()

galaxy_test.selenium.test_library_to_collections module

galaxy_test.selenium.test_login module

class galaxy_test.selenium.test_login.LoginTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

test_logging_in()

test_invalid_logins()

test_invalid_passwords()

test_wrong_password()

galaxy_test.selenium.test_navigates_galaxy module

class galaxy_test.selenium.test_navigates_galaxy.NavigatesGalaxySeleniumTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

Test the Selenium test framework itself.

Unlike the others test cases in this module, this test case tests the test framework itself (for when that makes sense, mostly corner cases).

test_click_error()

galaxy_test.selenium.test_pages module

class galaxy_test.selenium.test_pages.PagesTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

ensure_registered = True

test_simple_page_creation_edit_and_view()

navigate_to_pages()

galaxy_test.selenium.test_personal_information module

class galaxy_test.selenium.test_personal_information.ManageInformationTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

test_change_email()

test_public_name()

test_user_address()

navigate_to_user_preferences()

navigate_to_manage_information()

clear_input_field_and_write(element, new_input_text)

get_address_input_field(address_form, input_field_label)

galaxy_test.selenium.test_published_histories_grid module

class galaxy_test.selenium.test_published_histories_grid.HistoryGridTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SharedStateSeleniumTestCase

test_history_grid_histories()

test_history_grid_search_standard()

test_history_grid_search_advanced()

test_history_grid_sort_by_name()

test_history_grid_sort_by_owner()

test_history_grid_tag_click()

get_histories(sleep=False)

assert_grid_histories_sorted_by_owner()

assert_grid_histories_are(expected_histories, sort_matters=True)

assert_histories_in_grid(expected_histories, present=True)

set_filter(selector, value)

unset_filter(filter_key, filter_value)

set_annotation(annotation)

ensure_annotation_area_displayed()

setup_shared_state()

create_history(name)

publish_current_history()

navigate_to_published_histories_page()

galaxy_test.selenium.test_registration module

class galaxy_test.selenium.test_registration.RegistrationTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

test_landing()

test_registration()

test_logout()

test_reregister_email_fails()

test_reregister_username_fails()

test_bad_emails()

test_short_password()

test_password_confirmation()

test_bad_usernames()

galaxy_test.selenium.test_sign_out module

class galaxy_test.selenium.test_sign_out.SignOutTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

test_sign_out()

galaxy_test.selenium.test_sizzle_loading module

class galaxy_test.selenium.test_sizzle_loading.SizzleLoadingTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

test_sizzle_loads()

galaxy_test.selenium.test_stock_tours module

class galaxy_test.selenium.test_stock_tours.TestStockToursTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

test_core_galaxy_ui()

test_core_scratchbook()

test_core_history()

galaxy_test.selenium.test_tool_describing_tours module

class galaxy_test.selenium.test_tool_describing_tours.ToolDescribingToursTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

setUp()

test_generate_tour_no_data()

Ensure a tour without data is generated and pops up.

test_generate_tour_with_data()

Ensure a tour with data populates history.

galaxy_test.selenium.test_tool_form module

class galaxy_test.selenium.test_tool_form.ToolFormTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase, galaxy_test.selenium.framework.UsesHistoryItemAssertions

test_run_tool_verify_contents_by_peek()

test_run_tool_verify_dataset_details()

test_verify_dataset_details_tables()

test_rerun()

test_run_data()

test_bibtex_rendering()

class galaxy_test.selenium.test_tool_form.LoggedInToolFormTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

ensure_registered = True

test_run_apply_rules_1()

test_run_apply_rules_2()

test_run_apply_rules_3()

test_run_apply_rules_4()

test_run_apply_rules_tutorial()

galaxy_test.selenium.test_uploads module

class galaxy_test.selenium.test_uploads.UploadsTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase, galaxy_test.selenium.framework.UsesHistoryItemAssertions

test_upload_simplest()

test_upload_specify_ext()

test_upload_specify_genome()

test_upload_specify_ext_all()

test_upload_specify_genome_all()

test_upload_list()

test_upload_pair()

test_upload_pair_specify_extension()

test_upload_paired_list()

test_rules_example_1_datasets()

test_rules_example_2_list()

test_rules_example_3_list_pairs()

test_rules_example_4_accessions()

test_rules_example_5_matching_collections()

test_rules_example_6_nested_lists()

galaxy_test.selenium.test_workflow_editor module

class galaxy_test.selenium.test_workflow_editor.WorkflowEditorTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

ensure_registered = True

test_basics()

test_data_input()

test_collection_input()

test_integer_input()

test_non_data_connections()

test_existing_connections()

test_rendering_output_collection_connections()

test_simple_mapping_connections()

test_rendering_simple_nested_workflow()

test_rendering_rules_workflow_1()

test_rendering_rules_workflow_2()

test_save_as()

test_editor_tool_upgrade_message()

test_editor_invalid_tool_state()

test_missing_tools()

test_workflow_bookmarking()

workflow_editor_maximize_center_pane(collapse_left=True, collapse_right=True)

workflow_editor_connect(source, sink, screenshot_partial=None)

assert_connected(source, sink)

assert_not_connected(source, sink)

open_in_workflow_editor(yaml_content)

workflow_editor_source_sink_terminal_ids(source, sink)

workflow_editor_add_input(item_name='data_input')

workflow_editor_destroy_connection(sink)

assert_input_mapped(sink)

assert_input_not_mapped(sink)

workflow_index_open_with_name(name)

workflow_upload_yaml_with_random_name(content)

workflow_create_new(annotation=None, clear_placeholder=False)

assert_modal_has_text(expected_text)

galaxy_test.selenium.test_workflow_management module

class galaxy_test.selenium.test_workflow_management.WorkflowManagementTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase

ensure_registered = True

test_import_from_url()

test_view()

test_rename()

test_download()

test_tagging()

test_index_search()

galaxy_test.selenium.test_workflow_run module

class galaxy_test.selenium.test_workflow_run.WorkflowRunTestCase(methodName='runTest')

Bases: galaxy_test.selenium.framework.SeleniumTestCase, galaxy_test.selenium.framework.UsesHistoryItemAssertions

ensure_registered = True

test_simple_execution()

test_runtime_parameters_simple()

test_subworkflows_simple()

test_subworkflow_runtime_parameters()

test_replacement_parameters()

test_step_parameter_inputs()

test_replacement_parameters_on_subworkflows()

test_execution_with_tool_upgrade()

test_execution_with_multiple_inputs()

test_execution_with_rules()

test_execution_with_custom_invocation_repoprt()

open_in_workflow_run(yaml_content)

workflow_run_setup_inputs(content)

workflow_run_specify_inputs(inputs)

workflow_run_with_name(name)