Warning

This document is for an old release 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.selenium package

Top-level of library designed to ease use of Selenium targetting Galaxy.

galaxy_selenium is purposes being designed to depend on Python selenium, six, pyyaml, and optional pyvirtualdisplay but not galaxy-lib (or any of Galaxy or Galaxy’s test stuff) currently.

Subpackages

• galaxy.selenium.scripts package
  • Submodules
  • galaxy.selenium.scripts.dump_tour module
• galaxy.selenium.toolbox package
  • Submodules
  • galaxy.selenium.toolbox.filters module

Submodules

galaxy.selenium.cli module

galaxy.selenium.cli.add_selenium_arguments(parser)

Add common selenium arguments for argparse driver utility.

class galaxy.selenium.cli.DriverWrapper(args)

Bases: NavigatesGalaxy

Adapt argparse command-line options to a concrete Selenium driver.

__init__(args)

driver: WebDriver

build_url(url='')

Build URL to the target Galaxy.

property default_timeout

finish()

timeout_multiplier: float

galaxy.selenium.components module

class galaxy.selenium.components.By

Bases: object

Set of supported locator strategies.

ID = 'id'

XPATH = 'xpath'

LINK_TEXT = 'link text'

PARTIAL_LINK_TEXT = 'partial link text'

NAME = 'name'

TAG_NAME = 'tag name'

CLASS_NAME = 'class name'

CSS_SELECTOR = 'css selector'

class galaxy.selenium.components.Target

Bases: object

abstract property description: str

Return a plain-text description of the browser target for logging/messages.

abstract property element_locator: Tuple[By, str]

Return a (by, selector) Selenium elment locator tuple for this selector.

class galaxy.selenium.components.SelectorTemplate(selector: Union[str, List[str]], selector_type: str, children=None, kwds=None, with_classes=None, with_data=None)

Bases: Target

__init__(selector: Union[str, List[str]], selector_type: str, children=None, kwds=None, with_classes=None, with_data=None)

static from_dict(raw_value, children=None)

with_class(class_)

with_data(key, value)

descendant(has_selector)

property description

Return a plain-text description of the browser target for logging/messages.

property selector

property element_locator

Return a (by, selector) Selenium elment locator tuple for this selector.

property as_css_class

resolve_element_locator(path: Optional[str] = None) → Tuple[By, str]

class galaxy.selenium.components.Label(text)

Bases: Target

__init__(text)

property description

Return a plain-text description of the browser target for logging/messages.

property element_locator

Return a (by, selector) Selenium elment locator tuple for this selector.

class galaxy.selenium.components.Text(text)

Bases: Target

__init__(text)

property description

Return a plain-text description of the browser target for logging/messages.

property element_locator

Return a (by, selector) Selenium elment locator tuple for this selector.

class galaxy.selenium.components.Component(name, sub_components, selectors, labels, text)

Bases: object

__init__(name, sub_components, selectors, labels, text)

property selector

resolve_element_locator(path: Optional[str] = None) → Tuple[By, str]

static from_dict(name, raw_value)

galaxy.selenium.context module

class galaxy.selenium.context.GalaxySeleniumContext

Bases: NavigatesGalaxy

url: str

target_url_from_selenium: str

build_url(url: str, for_selenium: bool = True) → str

Build URL to the target Galaxy.

property driver

screenshot(label: str)

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.

screenshot_if(label: Optional[str]) → Optional[str]

class galaxy.selenium.context.GalaxySeleniumContextImpl(from_dict: Optional[dict] = None)

Bases: GalaxySeleniumContext

Minimal, simplified GalaxySeleniumContext useful outside the context of test cases.

A variant of this concept that can also populate content via the API to then interact with via the Selenium is galaxy_test.selenium.framework.GalaxySeleniumContextImpl.

__init__(from_dict: Optional[dict] = None) → None

url: str

target_url_from_selenium: str

timeout_multiplier: float

galaxy.selenium.context.init(config=None, clazz=<class 'galaxy.selenium.context.GalaxySeleniumContextImpl'>) → GalaxySeleniumContext

galaxy.selenium.data module

galaxy.selenium.data.load_root_component() → Component

galaxy.selenium.driver_factory module

class galaxy.selenium.driver_factory.ConfiguredDriver(browser='auto', remote=False, remote_host='127.0.0.1', remote_port='4444', headless=False)

Bases: object

__init__(browser='auto', remote=False, remote_host='127.0.0.1', remote_port='4444', headless=False)

driver: WebDriver

to_dict()

static from_dict(as_dict)

galaxy.selenium.driver_factory.get_local_driver(browser='auto', headless=False) → WebDriver

galaxy.selenium.driver_factory.get_remote_driver(host, port, browser='auto') → WebDriver

galaxy.selenium.driver_factory.is_virtual_display_available()

galaxy.selenium.driver_factory.virtual_display_if_enabled(enabled)

galaxy.selenium.has_driver module

A mixin to extend a class that has self.driver with higher-level constructs.

This should be mixed into classes with a self.driver and self.default_timeout attribute.

galaxy.selenium.has_driver.exception_indicates_click_intercepted(exception)

galaxy.selenium.has_driver.exception_indicates_not_clickable(exception)

galaxy.selenium.has_driver.exception_indicates_stale_element(exception)

class galaxy.selenium.has_driver.HasDriver

Bases: object

driver: WebDriver

re_get_with_query_params(params_str: str)

assert_xpath(xpath)

assert_selector(selector)

assert_selector_absent_or_hidden(selector)

assert_absent_or_hidden(selector_template)

selector_is_displayed(selector)

is_displayed(selector_template)

assert_selector_absent(selector)

find_elements(selector_template)

assert_absent(selector_template)

element_absent(selector_template)

wait_for_xpath(xpath, **kwds)

wait_for_xpath_visible(xpath, **kwds)

wait_for_selector(selector, **kwds)

wait_for_present(selector_template, **kwds)

wait_for_visible(selector_template, **kwds)

wait_for_selector_visible(selector, **kwds)

wait_for_selector_clickable(selector, **kwds)

wait_for_clickable(selector_template, **kwds)

wait_for_selector_absent_or_hidden(selector, **kwds)

wait_for_selector_absent(selector, **kwds)

wait_for_element_count_of_at_least(selector_template, n, **kwds)

wait_for_absent(selector_template, **kwds)

wait_for_absent_or_hidden(selector_template, **kwds)

wait_for_id(id, **kwds)

click(selector_template)

action_chains()

send_enter(element)

send_escape(element=None)

send_backspace(element)

timeout_for(**kwds) → float

wait(timeout=<object object>, **kwds)

click_xpath(xpath)

click_label(text)

click_selector(selector)

fill(form, info)

click_submit(form)

prepend_timeout_message(timeout_exception, message)

accept_alert()

galaxy.selenium.has_driver.SeleniumTimeoutException

alias of TimeoutException

galaxy.selenium.jupyter_context module

galaxy.selenium.jupyter_context.init(config=None)

class galaxy.selenium.jupyter_context.JupyterContextImpl(from_dict: Optional[dict] = None)

Bases: GalaxySeleniumContextImpl

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.

url: str

target_url_from_selenium: str

timeout_multiplier: float

galaxy.selenium.navigates_galaxy module

A mixin that extends a HasDriver class with Galaxy-specific utilities.

Implementer must provide a self.build_url method to target Galaxy.

class galaxy.selenium.navigates_galaxy.WaitType(name, default_length)

Bases: tuple

property default_length

Alias for field number 1

property name

Alias for field number 0

class galaxy.selenium.navigates_galaxy.WAIT_TYPES

Bases: object

UX_RENDER = WaitType(name='ux_render', default_length=1)

UX_TRANSITION = WaitType(name='ux_transition', default_length=5)

UX_POPUP = WaitType(name='ux_popup', default_length=15)

DATABASE_OPERATION = WaitType(name='database_operation', default_length=10)

JOB_COMPLETION = WaitType(name='job_completion', default_length=30)

GIE_SPAWN = WaitType(name='gie_spawn', default_length=30)

SHED_SEARCH = WaitType(name='shed_search', default_length=30)

REPO_INSTALL = WaitType(name='repo_install', default_length=60)

HISTORY_POLL = WaitType(name='history_poll', default_length=3)

class galaxy.selenium.navigates_galaxy.NullTourCallback

Bases: object

handle_step(step, step_index)

galaxy.selenium.navigates_galaxy.exception_seems_to_indicate_transition(e)

True if exception seems to indicate the page state is transitioning.

Galaxy features many different transition effects that change the page state over time. These transitions make it slightly more difficult to test Galaxy because atomic input actions take an indeterminate amount of time to be reflected on the screen. This method takes a Selenium assertion and tries to infer if such a transition could be the root cause of the exception. The methods that follow use it to allow retrying actions during transitions.

Currently the two kinds of exceptions that we say may indicate a transition are StaleElement exceptions (a DOM element grabbed at one step is no longer available) and “not clickable” exceptions (so perhaps a popup modal is blocking a click).

galaxy.selenium.navigates_galaxy.retry_call_during_transitions(f, attempts=10, sleep=0.1, exception_check=<function exception_seems_to_indicate_transition>)

galaxy.selenium.navigates_galaxy.retry_during_transitions(f, attempts=10, sleep=0.1, exception_check=<function exception_seems_to_indicate_transition>)

galaxy.selenium.navigates_galaxy.edit_details(f, scope='.history-index')

Open the editor, run the edits, hit the save button

class galaxy.selenium.navigates_galaxy.NavigatesGalaxy

Bases: HasDriver

Class with helpers methods for driving components of the Galaxy interface.

In most cases, methods for interacting with Galaxy components that appear in multiple tests or applications should be refactored into this class for now. Keep in mind that this class is used outside the context of TestCase s as well - so some methods more explicitly related to test data or assertion checking may make more sense in SeleniumTestCase for instance.

Some day this class will likely be split up into smaller mixins for particular components of Galaxy, but until that day the best practice is to prefix methods for driving or querying the interface with the name of the component or page the method operates on. These serve as pseudo-namespaces until we decompose this class. For instance, the method for clicking an option in the workflow editor is workflow_editor_click_option instead of click_workflow_editor_option.

timeout_multiplier: float

driver: WebDriver

abstract build_url(url: str, for_selenium: bool = True) → str

Build URL to the target Galaxy.

default_password = '123456'

wait_types

alias of WAIT_TYPES

get(url: str = '')

Expand supplied relative URL and navigate to page using Selenium driver.

property navigation: Component

property components: SmartComponent

Fetch root component describing the Galaxy DOM.

wait_length(wait_type: WaitType) → float

Return the wait time specified by wait_type after applying timeout_multipler.

timeout_multiplier is used in production CI tests to reduce transient failures in a uniform way across test suites to expand waiting.

sleep_for(wait_type: WaitType) → None

Sleep on the Python client side for the specified wait_type.

This method uses wait_length to apply any timeout_multiplier.

sleep_for_seconds(duration: float) → None

Sleep in the local thread for specified number of seconds.

Ideally, we would be sleeping on the Selenium server instead of in the local client (e.g. test) thread.

timeout_for(wait_type: WaitType = WaitType(name='database_operation', default_length=10), **kwd) → float

home() → None

Return to root Galaxy page and wait for some basic widgets to appear.

go_to_trs_search() → None

go_to_trs_by_id() → None

go_to_workflow_sharing(workflow_id: str) → None

go_to_workflow_export(workflow_id: str) → None

go_to_history_sharing(history_id: str) → None

switch_to_main_panel()

local_storage(key: str, value: Union[float, str])

Method decorator to modify localStorage for the scope of the supplied context.

main_panel()

Decorator to operate within the context of Galaxy’s main frame.

api_get(endpoint, data=None, raw=False)

api_post(endpoint, data=None)

api_delete(endpoint, raw=False)

get_galaxy_session()

selenium_to_requests_cookies()

history_panel_name_element()

history_panel_name()

history_panel_collection_rename(hid: int, new_name: str, assert_old_name: Optional[str] = None)

history_panel_expand_collection(collection_hid: int) → SmartComponent

history_panel_collection_name_element()

make_accessible_and_publishable()

history_contents(history_id=None, view='summary', datasets_only=True)

current_history()

current_history_id()

latest_history_item()

wait_for_history(assert_ok=True)

history_panel_create_new_with_name(name)

history_panel_create_new()

Click create new and pause a bit for the history to begin to refresh.

history_panel_wait_for_hid_ok(hid, allowed_force_refreshes=0)

history_panel_wait_for_hid_deferred(hid, allowed_force_refreshes=0)

history_panel_item_component(history_item=None, hid=None, multi_history_panel=False)

wait_for_history_to_have_hid(history_id, hid)

history_panel_wait_for_hid_visible(hid, allowed_force_refreshes=0, multi_history_panel=False)

hid_to_history_item(hid, current_history_id=None)

history_item_wait_for(history_item_selector, allowed_force_refreshes)

history_panel_wait_for_history_loaded()

history_panel_wait_for_hid_hidden(hid, multi_history_panel=False)

history_panel_wait_for_hid_state(hid, state, allowed_force_refreshes=0, multi_history_panel=False)

click_grid_popup_option(item_name, option_label)

published_grid_search_for(search_term=None)

get_logged_in_user()

get_api_key(force=False)

get_user_id()

is_logged_in()

submit_login(email, password=None, assert_valid=True, retries=0)

fill_login_and_submit(email, password=None)

register(email=None, password=None, username=None, confirm=None, assert_valid=True)

wait_for_logged_in()

click_center()

perform_upload(test_path, **kwd)

perform_upload_of_pasted_content(paste_data, **kwd)

perform_upload_of_composite_dataset_pasted_data(ext, paste_content)

upload_list(test_paths, name='test', ext=None, genome=None, hide_source_items=True)

upload_pair(test_paths, name='test', ext=None, genome=None, hide_source_items=True)

upload_paired_list(test_paths, name='test', ext=None, genome=None, hide_source_items=True)

upload_tab_click(tab)

upload_start_click()

upload_set_footer_extension(ext, tab_id='regular')

upload_set_footer_genome(genome, tab_id='regular')

upload_set_collection_type(collection_type)

upload_start(tab_id='regular')

upload_build(tab='collection')

upload_queue_local_file(test_path, tab_id='regular')

upload_paste_data(pasted_content, tab_id='regular')

upload_rule_start()

upload_rule_build()

upload_rule_set_data_type(type_description)

upload_rule_set_input_type(input_description)

upload_rule_set_dataset(row=1)

rule_builder_set_collection_name(name)

rule_builder_set_extension(extension)

rule_builder_filter_count(count=1)

rule_builder_sort(column_label, screenshot_name=None)

rule_builder_add_regex_groups(column_label, group_count, regex, screenshot_name)

rule_builder_add_regex_replacement(column_label, regex, replacement, screenshot_name=None)

rule_builder_add_value(value, screenshot_name=None)

rule_builder_remove_columns(column_labels, screenshot_name=None)

rule_builder_concatenate_columns(column_label_1, column_label_2, screenshot_name=None)

rule_builder_split_columns(column_labels_1, column_labels_2, screenshot_name=None)

rule_builder_swap_columns(column_label_1, column_label_2, screenshot_name)

rule_builder_rule_editor(rule_type)

rule_builder_set_mapping(mapping_type, column_label, screenshot_name=None)

rule_builder_set_source(json)

rule_builder_enter_source_text(json)

workflow_editor_click_option(option_label)

workflow_editor_click_options()

workflow_editor_options_menu_element()

workflow_editor_click_run()

workflow_editor_click_save()

navigate_to_histories_page()

navigate_to_user_preferences()

navigate_to_invocations()

navigate_to_pages()

admin_open()

select_dataset_from_lib_import_modal(filenames)

create_new_library(login=True)

libraries_open()

libraries_open_with_name(name)

libraries_index_table_elements()

libraries_index_create(name)

libraries_index_click_search()

libraries_index_sort_selector()

libraries_index_sort_click()

libraries_index_search_for(text)

libraries_folder_create(name)

libraries_click_dataset_import()

libraries_dataset_import(btn)

libraries_dataset_import_from_history_select(to_select_items)

libraries_dataset_import_from_history_click_ok(wait=True)

libraries_table_elements()

populate_library_folder_from_import_dir(library_name, filenames)

navigate_to_new_library(login=True)

wait_for_overlays_cleared()

Wait for modals and Toast notifications to disappear.

clear_tooltips()

workflow_index_open()

workflow_index_table_elements()

workflow_index_table_row(workflow_index=0)

workflow_index_column_text(column_index, workflow_index=0)

workflow_index_click_search()

workflow_index_search_for(search_term=None)

workflow_index_click_import()

workflow_index_rename(new_name, workflow_index=0)

workflow_index_name(workflow_index=0)

Get workflow name for workflow_index’th row.

workflow_click_option(workflow_selector, workflow_index=0)

select_dropdown_item(option_title)

workflow_index_click_option(option_title, workflow_index=0)

workflow_index_click_tag_display(workflow_index=0)

workflow_index_add_tag(tag: str, workflow_index: int = 0)

workflow_index_tags(workflow_index=0)

workflow_index_tag_elements(workflow_index=0)

workflow_index_click_tag(tag, workflow_index=0)

workflow_import_submit_url(url)

workflow_sharing_click_publish()

tagging_add(tags, auto_closes=True, parent_selector='')

workflow_run_with_name(name: str)

workflow_run_specify_inputs(inputs: Dict[str, Any])

workflow_run_submit()

workflow_run_ensure_expanded()

workflow_create_new(annotation=None, clear_placeholder=False)

invocation_index_table_elements()

tool_open(tool_id, outer=False)

datasource_tool_open(tool_id)

create_page_and_edit(name=None, slug=None, content_format=None, screenshot_name=None)

create_page(name=None, slug=None, content_format=None, screenshot_name=None)

tool_parameter_div(expanded_parameter_id)

tool_parameter_edit_rules()

tool_set_value(expanded_parameter_id, value, expected_type=None)

tool_form_generate_tour()

tool_form_execute()

click_masthead_user()

click_masthead_shared_data()

click_masthead_workflow()

click_button_new_workflow()

wait_for_sizzle_selector_clickable(selector)

click_history_options()

click_history_option_export_to_file()

click_history_option_sharing()

click_history_option(option_label_or_component)

use_beta_history()

is_beta_history()

beta_history_element(attribute_value, attribute_name='data-description', scope='.history-index')

content_item_by_attributes(**attrs)

history_click_create_new()

history_click_editor_save()

history_panel_click_copy_elements()

use_bootstrap_dropdown(option=None, menu=None)

uses bootstrap dropdown by data-description attributes

histories_click_advanced_search()

histories_get_history_names()

history_panel_add_tags(tags)

history_panel_rename(new_name)

history_panel_name_input()

history_panel_click_to_rename()

history_panel_refresh_click()

history_panel_multi_operations_show()

history_panel_muli_operation_select_hid(hid)

history_panel_multi_operation_action_click(action)

open_history_multi_view()

history_panel_show_structure()

history_multi_view_display_collection_contents(collection_hid, collection_type='list')

history_panel_item_view_dataset_details(hid)

history_panel_item_click_visualization_menu(hid)

history_panel_item_available_visualizations_elements(hid)

history_panel_item_get_tags(hid)

history_panel_item_available_visualizations(hid)

history_panel_item_click_visualization(hid, visualization_name)

history_panel_item_selector(hid, wait=False)

modal_body_selector()

history_panel_item_body_component(hid, wait=False)

hda_click_primary_action_button(hid: int, button_key: str)

hda_click_details(hid: int)

history_panel_click_item_title(hid, **kwds)

history_panel_ensure_showing_item_details(hid)

history_panel_item_showing_details(hid)

collection_builder_set_name(name)

collection_builder_hide_originals()

collection_builder_create()

collection_builder_clear_filters()

collection_builder_click_paired_item(forward_or_reverse, item)

logout_if_needed()

logout()

run_tour(path, skip_steps=None, sleep_on_steps=None, tour_callback=None)

tour_wait_for_clickable_element(selector)

tour_wait_for_element_present(selector)

get_tooltip_text(element, sleep=0, click_away=True)

assert_selector_absent_or_hidden_after_transitions(selector)

Variant of assert_selector_absent_or_hidden that retries during transitions.

In the parent method - the element is found and then it is checked to see if it is visible. It may disappear from the page in the middle there and cause a StaleElement error. For checks where we care about the final resting state after transitions - this method can be used to retry during those transitions.

assert_absent_or_hidden_after_transitions(selector)

Variant of assert_absent_or_hidden that retries during transitions.

See details above for more information about this.

assert_tooltip_text(element, expected: Union[str, Label, Text], sleep: int = 0, click_away: bool = True)

assert_tooltip_text_contains(element, expected: Union[str, Label, Text], sleep: int = 0, click_away: bool = True)

assert_error_message(contains=None)

assert_warning_message(contains=None)

assert_message(element, contains=None)

assert_no_error_message()

run_tour_step(step, step_index, tour_callback)

wait_for_and_click_selector(selector)

wait_for_and_click(selector_template)

set_history_annotation(annotation, clear_text=False)

ensure_history_annotation_area_displayed()

select2_set_value(container_selector_or_elem, value, with_click=True, clear_value=False)

snapshot(description)

Test case subclass overrides this to provide detailed logging.

open_history_editor(scope='.history-index')

close_history_editor(scope='.history-index')

share_ensure_by_user_available(sharing_component)

share_unshare_with_user(sharing_component, email)

share_with_user(sharing_component, user_id=None, user_email=None, screenshot_before_submit=None, screenshot_after_submit=None, assert_valid=False)

exception galaxy.selenium.navigates_galaxy.NotLoggedInException(timeout_exception, user_info, dom_message)

Bases: TimeoutException

__init__(timeout_exception, user_info, dom_message)

galaxy.selenium.sizzle module

Utilities for using sizzle (jQuery-style) selectors with Selenium.

galaxy.selenium.sizzle.find_element_by_sizzle(driver, sizzle_selector: str)

Finds an element by sizzle selector.

Parameters

sizzle_selector – The sizzle selector to use when finding element.

galaxy.selenium.sizzle.find_elements_by_sizzle(driver, sizzle_selector: str)

Finds elements by sizzle selector.

Parameters

sizzle_selector – The sizzle selector to use when finding elements.

galaxy.selenium.sizzle.sizzle_selector_clickable(selector)

galaxy.selenium.sizzle.sizzle_presence_of_selector(selector)

galaxy.selenium.smart_components module

class galaxy.selenium.smart_components.SmartComponent(component, has_driver)

Bases: object

Wrap a Component with driver aware methods.

Allows smarter selectors that know how to wait for themselves, test themselves, click themselves, etc…. More “magic”, but much cleaner usage.

__init__(component, has_driver)

class galaxy.selenium.smart_components.SmartTarget(target, has_driver)

Bases: object

Wrap a Target with driver aware methods.

__init__(target, has_driver)

all()

wait_for_element_count_of_at_least(n: int, **kwds)

wait_for_and_click(**kwds)

wait_for_visible(**kwds)

wait_for_clickable(**kwds)

wait_for_text(**kwds)

wait_for_value(**kwds)

property is_displayed

property is_absent

wait_for_absent_or_hidden(**kwds)

wait_for_absent(**kwds)

wait_for_present(**kwds)

assert_absent(**kwds)

assert_absent_or_hidden(**kwds)

assert_absent_or_hidden_after_transitions(**kwds)

has_class(class_name)

wait_for_and_send_keys(*text)