selectelement.py

Go to the documentation of this file.

# Copyright 2008-2011 Nokia Networks
# Copyright 2011-2016 Ryan Tomac, Ed Manlove and contributors
# Copyright 2016-     Robot Framework Foundation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
 
from selenium.common.exceptions import NoSuchElementException
from selenium.webdriver.support.ui import Select
 
from SeleniumLibrary.base import LibraryComponent, keyword
from SeleniumLibrary.utils import is_truthy, plural_or_not as s
 
 
class SelectElementKeywords(LibraryComponent):
 
    @keyword
    
    def get_list_items(self, locator, values=False):
        options = self._get_options_get_options(locator)
        if is_truthy(values):
            return self._get_values_get_values(options)
        else:
            return self._get_labels_get_labels(options)
 
    @keyword
    
    def get_selected_list_label(self, locator):
        select = self._get_select_list_get_select_list(locator)
        return select.first_selected_option.text
 
    @keyword
    
    def get_selected_list_labels(self, locator):
        options = self._get_selected_options_get_selected_options(locator)
        return self._get_labels_get_labels(options)
 
    @keyword
    
    def get_selected_list_value(self, locator):
        select = self._get_select_list_get_select_list(locator)
        return select.first_selected_option.get_attribute('value')
 
    @keyword
    
    def get_selected_list_values(self, locator):
        options = self._get_selected_options_get_selected_options(locator)
        return self._get_values_get_values(options)
 
    @keyword
    
    def list_selection_should_be(self, locator, *expected):
        self.infoinfo("Verifying list '%s' has option%s [ %s ] selected."
                  % (locator, s(expected), ' | '.join(expected)))
        self.page_should_contain_listpage_should_contain_list(locator)
        options = self._get_selected_options_get_selected_options(locator)
        labels = self._get_labels_get_labels(options)
        values = self._get_values_get_values(options)
        if sorted(expected) not in [sorted(labels), sorted(values)]:
            raise AssertionError("List '%s' should have had selection [ %s ] "
                                 "but selection was [ %s ]."
                                 % (locator, ' | '.join(expected),
                                    self._format_selection_format_selection(labels, values)))
 
    def _format_selection(self, labels, values):
        return ' | '.join('%s (%s)' % (label, value)
                          for label, value in zip(labels, values))
 
    @keyword
    
    def list_should_have_no_selections(self, locator):
        self.infoinfo("Verifying list '%s' has no selections." % locator)
        options = self._get_selected_options_get_selected_options(locator)
        if options:
            selection = self._format_selection_format_selection(self._get_labels_get_labels(options),
                                               self._get_values_get_values(options))
            raise AssertionError("List '%s' should have had no selection "
                                 "but selection was [ %s ]."
                                 % (locator, selection))
 
    @keyword
    
    def page_should_contain_list(self, locator, message=None, loglevel='TRACE'):
        self.assert_page_containsassert_page_contains(locator, 'list', message, loglevel)
 
    @keyword
    
    def page_should_not_contain_list(self, locator, message=None, loglevel='TRACE'):
        self.assert_page_not_containsassert_page_not_contains(locator, 'list', message, loglevel)
 
    @keyword
    
    def select_all_from_list(self, locator):
        self.infoinfo("Selecting all options from list '%s'." % locator)
        select = self._get_select_list_get_select_list(locator)
        if not select.is_multiple:
            raise RuntimeError("'Select All From List' works only with "
                               "multi-selection lists.")
        for i in range(len(select.options)):
            select.select_by_index(i)
 
    @keyword
    
    def select_from_list_by_index(self, locator, *indexes):
        if not indexes:
            raise ValueError("No indexes given.")
        self.infoinfo("Selecting options from selection list '%s' by index%s %s."
                  % (locator, '' if len(indexes) == 1 else 'es',
                     ', '.join(indexes)))
        select = self._get_select_list_get_select_list(locator)
        for index in indexes:
            select.select_by_index(int(index))
 
    @keyword
    
    def select_from_list_by_value(self, locator, *values):
        if not values:
            raise ValueError("No values given.")
        self.infoinfo("Selecting options from selection list '%s' by value%s %s."
                  % (locator, s(values), ', '.join(values)))
        select = self._get_select_list_get_select_list(locator)
        for value in values:
            select.select_by_value(value)
 
    @keyword
    
    def select_from_list_by_label(self, locator, *labels):
        if not labels:
            raise ValueError("No labels given.")
        self.infoinfo("Selecting options from selection list '%s' by label%s %s."
                  % (locator, s(labels), ', '.join(labels)))
        select = self._get_select_list_get_select_list(locator)
        for label in labels:
            select.select_by_visible_text(label)
 
    @keyword
    
    def unselect_all_from_list(self, locator):
        self.infoinfo("Unselecting all options from list '%s'." % locator)
        select = self._get_select_list_get_select_list(locator)
        if not select.is_multiple:
            raise RuntimeError("Un-selecting options works only with "
                               "multi-selection lists.")
        select.deselect_all()
 
    @keyword
    
    def unselect_from_list_by_index(self, locator, *indexes):
        if not indexes:
            raise ValueError("No indexes given.")
        self.infoinfo("Un-selecting options from selection list '%s' by index%s "
                  "%s." % (locator, '' if len(indexes) == 1 else 'es',
                           ', '.join(indexes)))
        select = self._get_select_list_get_select_list(locator)
        if not select.is_multiple:
            raise RuntimeError("Un-selecting options works only with "
                               "multi-selection lists.")
        for index in indexes:
            select.deselect_by_index(int(index))
 
    @keyword
    
    def unselect_from_list_by_value(self, locator, *values):
        if not values:
            raise ValueError("No values given.")
        self.infoinfo("Un-selecting options from selection list '%s' by value%s "
                  "%s." % (locator, s(values), ', '.join(values)))
        select = self._get_select_list_get_select_list(locator)
        if not select.is_multiple:
            raise RuntimeError("Un-selecting options works only with "
                               "multi-selection lists.")
        for value in values:
            select.deselect_by_value(value)
 
    @keyword
    
    def unselect_from_list_by_label(self, locator, *labels):
        if not labels:
            raise ValueError("No labels given.")
        self.infoinfo("Un-selecting options from selection list '%s' by label%s "
                  "%s." % (locator, s(labels), ', '.join(labels)))
        select = self._get_select_list_get_select_list(locator)
        if not select.is_multiple:
            raise RuntimeError("Un-selecting options works only with "
                               "multi-selection lists.")
        for label in labels:
            select.deselect_by_visible_text(label)
 
    def _get_select_list(self, locator):
        el = self.find_elementfind_element(locator, tag='list')
        return Select(el)
 
    def _get_options(self, locator):
        return self._get_select_list_get_select_list(locator).options
 
    def _get_selected_options(self, locator):
        return self._get_select_list_get_select_list(locator).all_selected_options
 
    def _get_labels(self, options):
        return [opt.text for opt in options]
 
    def _get_values(self, options):
        return [opt.get_attribute('value') for opt in options]