Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package com.github.markusbernhardt.selenium2library.keywords;
import java.util.ArrayList;
import java.util.List;
import org.openqa.selenium.NoSuchElementException;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.ui.Select;
import org.robotframework.javalib.annotation.ArgumentNames;
import org.robotframework.javalib.annotation.Autowired;
import org.robotframework.javalib.annotation.RobotKeyword;
import org.robotframework.javalib.annotation.RobotKeywordOverload;
import org.robotframework.javalib.annotation.RobotKeywords;
import com.github.markusbernhardt.selenium2library.RunOnFailureKeywordsAdapter;
import com.github.markusbernhardt.selenium2library.Selenium2LibraryNonFatalException;
import com.github.markusbernhardt.selenium2library.utils.Python;
@RobotKeywords
public class SelectElement extends RunOnFailureKeywordsAdapter {
/**
* Instantiated Element keyword bean
*/
@Autowired
protected Element element;
/**
* Instantiated Logging keyword bean
*/
@Autowired
protected Logging logging;
// ##############################
// Keywords
// ##############################
/**
* Returns the values in the select list identified by locator.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the select list.
* @return The select list values
*/
@RobotKeyword
@ArgumentNames({ "locator" })
public List getListItems(String locator) {
List options = getSelectListOptions(locator);
return getLabelsForOptions(options);
}
/**
* Returns the visible label of the first selected element from the select
* list identified by locator.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the select list.
* @return The first visible select list label
*/
@RobotKeyword
@ArgumentNames({ "locator" })
public String getSelectedListLabel(String locator) {
Select select = getSelectList(locator);
return select.getFirstSelectedOption().getText();
}
/**
* Returns the visible labels of the first selected elements as a list from
* the select list identified by locator.
*
* Fails if there is no selection.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the select list.
* @return The list of visible select list labels
*/
@RobotKeyword
@ArgumentNames({ "locator" })
public List getSelectedListLabels(String locator) {
List options = getSelectListOptionsSelected(locator);
if (options.size() == 0) {
throw new Selenium2LibraryNonFatalException(String.format(
"Select list with locator '%s' does not have any selected values.", locator));
}
return getLabelsForOptions(options);
}
/**
* Returns the value of the first selected element from the select list
* identified by locator.
*
* The return value is read from the value attribute of the selected
* element.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the select list.
* @return The first select list value
*/
@RobotKeyword
@ArgumentNames({ "locator" })
public String getSelectedListValue(String locator) {
Select select = getSelectList(locator);
return select.getFirstSelectedOption().getAttribute("value");
}
/**
* Returns the values of the first selected elements as a list from the
* select list identified by locator.
*
* Fails if there is no selection. The return values are read from the value
* attribute of the selected element.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the select list.
* @return The list of select list values
*/
@RobotKeyword
@ArgumentNames({ "locator" })
public List getSelectedListValues(String locator) {
List options = getSelectListOptionsSelected(locator);
if (options.size() == 0) {
throw new Selenium2LibraryNonFatalException(String.format(
"Select list with locator '%s' does not have any selected values.", locator));
}
return getValuesForOptions(options);
}
/**
* Verify the selection of the select list identified by locatoris
* exactly *items.
*
* If you want to verify no option is selected, simply give no items.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the select list.
* @param items
* The list of items to verify
*/
@RobotKeyword
@ArgumentNames({ "locator", "*items" })
public void listSelectionShouldBe(String locator, String... items) {
String itemList = items.length != 0 ? String.format("option(s) [ %s ]", Python.join(" | ", items))
: "no options";
logging.info(String.format("Verifying list '%s' has %s selected.", locator, itemList));
pageShouldContainList(locator);
List options = getSelectListOptionsSelected(locator);
List selectedLabels = getLabelsForOptions(options);
String message = String.format("List '%s' should have had selection [ %s ] but it was [ %s ].", locator,
Python.join(" | ", items), Python.join(" | ", selectedLabels));
if (items.length != options.size()) {
throw new Selenium2LibraryNonFatalException(message);
} else {
List selectedValues = getValuesForOptions(options);
for (String item : items) {
if (!selectedValues.contains(item) && !selectedLabels.contains(item)) {
throw new Selenium2LibraryNonFatalException(message);
}
}
}
}
/**
* Verify the select list identified by locatorhas no selections.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the select list.
*/
@RobotKeyword
@ArgumentNames({ "locator" })
public void listShouldHaveNoSelections(String locator) {
logging.info(String.format("Verifying list '%s' has no selection.", locator));
List options = getSelectListOptionsSelected(locator);
if (!options.equals(null)) {
List selectedLabels = getLabelsForOptions(options);
String items = Python.join(" | ", selectedLabels);
throw new Selenium2LibraryNonFatalException(String.format(
"List '%s' should have had no selection (selection was [ %s ]).", locator, items.toString()));
}
}
@RobotKeywordOverload
public void pageShouldContainList(String locator) {
pageShouldContainList(locator, "");
}
@RobotKeywordOverload
public void pageShouldContainList(String locator, String message) {
pageShouldContainList(locator, message, "INFO");
}
/**
* Verify the select list identified by locator is found on the
* current page.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators and log levels.
*
* @param locator
* The locator to locate the select list.
* @param message
* Default=NONE. Optional custom error message.
* @param logLevel
* Default=INFO. Optional log level.
*/
@RobotKeyword
@ArgumentNames({ "locator", "message=NONE", "logLevel=INFO" })
public void pageShouldContainList(String locator, String message, String logLevel) {
element.pageShouldContainElement(locator, "list", message, logLevel);
}
@RobotKeywordOverload
public void pageShouldNotContainList(String locator) {
pageShouldNotContainList(locator, "");
}
@RobotKeywordOverload
public void pageShouldNotContainList(String locator, String message) {
pageShouldNotContainList(locator, message, "INFO");
}
/**
* Verify the select list identified by locator is not found on the
* current page.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators and log levels.
*
* @param locator
* The locator to locate the select list.
* @param message
* Default=NONE. Optional custom error message.
* @param logLevel
* Default=INFO. Optional log level.
*/
@RobotKeyword
@ArgumentNames({ "locator", "message=NONE", "logLevel=INFO" })
public void pageShouldNotContainList(String locator, String message, String logLevel) {
element.pageShouldNotContainElement(locator, "list", message, logLevel);
}
/**
* Select all values of the multi-select list identified by locator.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the multi-select list.
*/
@RobotKeyword
@ArgumentNames({ "locator" })
public void selectAllFromList(String locator) {
logging.info(String.format("Selecting all options from list '%s'.", locator));
Select select = getSelectList(locator);
if (!isMultiselectList(select)) {
throw new Selenium2LibraryNonFatalException(
"Keyword 'Select all from list' works only for multiselect lists.");
}
for (int i = 0; i < select.getOptions().size(); i++) {
select.selectByIndex(i);
}
}
/**
* Select the given *items of the multi-select list identified by
* locator.
*
* An exception is raised for a single-selection list if the last value does
* not exist in the list and a warning for all other non-existing items. For
* a multi-selection list, an exception is raised for any and all
* non-existing values.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the multi-select list.
* @param items
* The list of items to select
*/
@RobotKeyword
@ArgumentNames({ "locator", "*items" })
public void selectFromList(String locator, String... items) {
String itemList = items.length != 0 ? String.format("option(s) [ %s ]", Python.join(" | ", items))
: "all options";
logging.info(String.format("Selecting %s from list '%s'.", itemList, locator));
Select select = getSelectList(locator);
// If no items given, select all values (of in case of single select
// list, go through all values)
if (items.length == 0) {
for (int i = 0; i < select.getOptions().size(); i++) {
select.selectByIndex(i);
}
return;
}
boolean lastItemFound = false;
List nonExistingItems = new ArrayList<>();
for (String item : items) {
lastItemFound = true;
try {
select.selectByValue(item);
} catch (NoSuchElementException e1) {
try {
select.selectByVisibleText(item);
} catch (NoSuchElementException e2) {
nonExistingItems.add(item);
lastItemFound = false;
continue;
}
}
}
if (nonExistingItems.size() != 0) {
// multi-selection list => throw immediately
if (select.isMultiple()) {
throw new Selenium2LibraryNonFatalException(String.format("Options '%s' not in list '%s'.",
Python.join(", ", nonExistingItems), locator));
}
// single-selection list => log warning with not found items
logging.warn(String.format("Option%s '%s' not found within list '%s'.", nonExistingItems.size() == 0 ? ""
: "s", Python.join(", ", nonExistingItems), locator));
// single-selection list => throw if last item was not found
if (!lastItemFound) {
throw new Selenium2LibraryNonFatalException(String.format("Option '%s' not in list '%s'.",
nonExistingItems.get(nonExistingItems.size() - 1), locator));
}
}
}
/**
* Select the given *indexes of the multi-select list identified by
* locator.
*
* Tries to select by value AND by label. It's generally faster to use 'by
* index/value/label' keywords.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the multi-select list.
* @param indexes
* The list of indexes to select
*/
@RobotKeyword
@ArgumentNames({ "locator", "*indexes" })
public void selectFromListByIndex(String locator, String... indexes) {
if (indexes.length == 0) {
throw new Selenium2LibraryNonFatalException("No index given.");
}
List tmp = new ArrayList();
for (String index : indexes) {
tmp.add(index);
}
String items = String.format("index(es) '%s'", Python.join(", ", tmp));
logging.info(String.format("Selecting %s from list '%s'.", items, locator));
Select select = getSelectList(locator);
for (String index : indexes) {
select.selectByIndex(Integer.parseInt(index));
}
}
/**
* Select the given *values of the multi-select list identified by
* locator.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the multi-select list.
* @param values
* The list of values to select
*/
@RobotKeyword
@ArgumentNames({ "locator", "*values" })
public void selectFromListByValue(String locator, String... values) {
if (values.length == 0) {
throw new Selenium2LibraryNonFatalException("No value given.");
}
String items = String.format("value(s) '%s'", Python.join(", ", values));
logging.info(String.format("Selecting %s from list '%s'.", items, locator));
Select select = getSelectList(locator);
for (String value : values) {
select.selectByValue(value);
}
}
/**
* Select the given *labels of the multi-select list identified by
* locator.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the multi-select list.
* @param labels
* The list of labels to select
*/
@RobotKeyword
@ArgumentNames({ "locator", "*labels" })
public void selectFromListByLabel(String locator, String... labels) {
if (labels.length == 0) {
throw new Selenium2LibraryNonFatalException("No value given.");
}
String items = String.format("label(s) '%s'", Python.join(", ", labels));
logging.info(String.format("Selecting %s from list '%s'.", items, locator));
Select select = getSelectList(locator);
for (String label : labels) {
select.selectByVisibleText(label);
}
}
/**
* Unselect the given *items of the multi-select list identified by
* locator.
*
* As a special case, giving an empty *items list will remove all
* selections.
*
* Tries to unselect by value AND by label. It's generally faster to use 'by
* index/value/label' keywords.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the multi-select list.
* @param items
* The list of items to select
*/
@RobotKeyword
@ArgumentNames({ "locator", "*items" })
public void unselectFromList(String locator, String... items) {
String itemList = items.length != 0 ? String.format("option(s) [ %s ]", Python.join(" | ", items))
: "all options";
logging.info(String.format("Unselecting %s from list '%s'.", itemList, locator));
Select select = getSelectList(locator);
if (!isMultiselectList(select)) {
throw new Selenium2LibraryNonFatalException(
"Keyword 'Unselect from list' works only for multiselect lists.");
}
if (items.length == 0) {
select.deselectAll();
return;
}
for (String item : items) {
select.deselectByValue(item);
select.deselectByVisibleText(item);
}
}
/**
* Unselect the given *indexes of the multi-select list identified by
* locator.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the multi-select list.
* @param indexes
* The list of indexes to select
*/
@RobotKeyword
@ArgumentNames({ "locator", "*indexes" })
public void unselectFromListByIndex(String locator, Integer... indexes) {
if (indexes.equals(null)) {
throw new Selenium2LibraryNonFatalException("No index given.");
}
List tmp = new ArrayList();
for (Integer index : indexes) {
tmp.add(index.toString());
}
String items = String.format("index(es) '%s'", Python.join(", ", tmp));
logging.info(String.format("Unselecting %s from list '%s'.", items, locator));
Select select = getSelectList(locator);
if (!isMultiselectList(select)) {
throw new Selenium2LibraryNonFatalException(
"Keyword 'Unselect from list' works only for multiselect lists.");
}
for (int index : indexes) {
select.deselectByIndex(index);
}
}
/**
* Unselect the given *values of the multi-select list identified by
* locator.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the multi-select list.
* @param values
* The list of values to select
*/
@RobotKeyword
@ArgumentNames({ "locator", "*values" })
public void unselectFromListByValue(String locator, String... values) {
if (values.equals(null)) {
throw new Selenium2LibraryNonFatalException("No value given.");
}
String items = String.format("value(s) '%s'", Python.join(", ", values));
logging.info(String.format("Unselecting %s from list '%s'.", items, locator));
Select select = getSelectList(locator);
if (!isMultiselectList(select)) {
throw new Selenium2LibraryNonFatalException(
"Keyword 'Unselect from list' works only for multiselect lists.");
}
for (String value : values) {
select.deselectByValue(value);
}
}
/**
* Unselect the given *labels of the multi-select list identified by
* locator.
*
* Select list keywords work on both lists and combo boxes. Key attributes
* for select lists are id and name. See `Introduction` for details about
* locators.
*
* @param locator
* The locator to locate the multi-select list.
* @param labels
* The list of labels to select
*/
@RobotKeyword
@ArgumentNames({ "locator", "*labels" })
public void unselectFromListByLabel(String locator, String... labels) {
if (labels.equals(null)) {
throw new Selenium2LibraryNonFatalException("No value given.");
}
String items = String.format("label(s) '%s'", Python.join(", ", labels));
logging.info(String.format("Unselecting %s from list '%s'.", items, locator));
Select select = getSelectList(locator);
if (!isMultiselectList(select)) {
throw new Selenium2LibraryNonFatalException(
"Keyword 'Unselect from list' works only for multiselect lists.");
}
for (String label : labels) {
select.deselectByVisibleText(label);
}
}
// ##############################
// Internal Methods
// ##############################
protected List getLabelsForOptions(List options) {
List labels = new ArrayList();
for (WebElement option : options) {
labels.add(option.getText());
}
return labels;
}
protected Select getSelectList(String locator) {
List webElements = element.elementFind(locator, true, true, "select");
return new Select(webElements.get(0));
}
protected List getSelectListOptions(Select select) {
return new ArrayList(select.getOptions());
}
protected List getSelectListOptions(String locator) {
Select select = getSelectList(locator);
return getSelectListOptions(select);
}
protected List getSelectListOptionsSelected(String locator) {
Select select = getSelectList(locator);
return new ArrayList(select.getAllSelectedOptions());
}
protected List getValuesForOptions(List options) {
ArrayList labels = new ArrayList();
for (WebElement option : options) {
labels.add(option.getAttribute("value"));
}
return labels;
}
protected boolean isMultiselectList(Select select) {
return select.isMultiple();
}
}
