selenide / selenide

Concise UI Tests with Java!

Selenide = UI Testing Framework powered by Selenium WebDriver

What is Selenide?

Selenide is a framework for writing easy-to-read and easy-to-maintain automated tests in Java. It defines concise fluent API, natural language assertions and does some magic for ajax-based applications to let you focus entirely on the business logic of your tests.

Selenide is based on and is compatible to Selenium WebDriver 4.0+

@Test
public void login() {
  open("/login");
  $(By.name("user.name")).setValue("johny");
  $("#submit").click();
  $("#username").shouldHave(text("Hello, Johny!"));
}

Look for detailed comparison of Selenide and Selenium WebDriver API.

Selenide for mobile apps

You can use Selenide for testing mobile applications. See plugin selenide-appium.

Selenide with Selenoid

You can use Selenide for running tests in Selenoid containers. See plugin selenide-selenoid.

Selenide with Selenium Grid

You can use Selenide for running tests in Selenium Grid. See plugin selenide-grid.

Changelog

Here is CHANGELOG

How to start?

Just put selenide.jar to your project and import the following methods: import static com.codeborne.selenide.Selenide.*;

Look for Quick Start for details.

Resources

• First of all, selenide.org
• For bustlers: How to start writing UI tests in 10 minutes
• For developers: Selenide presentation on Devoxx 2015
• For QA engineers: Selenide presentation on SeleniumConf 2015
• For russians: Selenide presentation on SeleniumCamp 2015

FAQ

See Frequently asked questions

Posts

• Set-up environment with gradle, junit5, allure and selenide -- read a post on medium, grab from GitHub
• Small step do dramatically improve your tests speed -- read a post on medium
• Another way to improve tests speed -- read a post on medium
• Configure Selenide to work with Selenoid

Contributing

Contributions to Selenide are both welcomed and appreciated. See CONTRIBUTING.md for specific guidelines.

Feel free to fork, clone, build, run tests and contribute pull requests for Selenide!

Authors

Selenide was originally designed and developed by Andrei Solntsev in 2011-2021 and is maintained by a group of enthusiast.

Thanks

Many thanks to these incredible tools that help us create open-source software:

License

Selenide is open-source project, and distributed under the MIT license

selenide's Issues

Support for phantomjs?

The API docs list ie, chrome, htmlunit, and firefox as valid browser values. Since WebDriver also supports phantomjs, are there plans to enable this in Selenide? HTMLUnit has so many problems as a headless browser that using Selenide in a headless environment is difficult/impossible.

Add support for all drivers

Currently only IEDriver, FirefoxDriver, ChromeDriver and HtmlUnitDriver are supported.
Other drivers should be added:

• AndroidDriver
• IPhoneDriver
• OperaDriver

what else?

Method $$.get(index) should wait until this element appears

Show concise error message when interacting with disabled element

Now test results in the following exception:

org.openqa.selenium.InvalidElementStateException: Element is disabled and so may not be used for actions
Command duration or timeout: 15 milliseconds

Run Chrome in incognito mode

I am not sure if it should be default or configurable behavior.

Code sample:

ChromeOptions options = new ChromeOptions();
options.addArguments("--incognito");
driver =  new ChromeDriver(options); 

Error message says `Expected: visible` for `shouldNotBe(visible)` check

The following test:

$(".validation-message[data-parameter-name='ssid']").shouldNotBe(visible);

Results in the following error message:

ElementMatches {By.selector: .validation-message[data-parameter-name='ssid']}
Expected: visible
Element: '<div class=validation-message>The WLAN name cannot contain special characters .</div>'
Timeout: 4 s.

It says: Expected: visible, thought shouldNotBe(visible); was requested.

Selenide could log every step in debug mode

It is useful in case of any mysterious behavior.
For example, for line

$(languageDrpdwn).shouldHave(text("Java"))

it should write a log message Element <option>Javascript</option> contains text "Java".

How to run

Option 1: from command line

-Dselenide.debug=true

Option 2: by test annotation

@Test @Debug
public void myTest() {...} 

both JUnit and TestNG could be supported

Implement SoftAssert mechanism for JUnit and TestNG

For a test marked with @SoftAssert anntation:
If a test contains multiple asserts, it should check them all, and fail only after all checks.

assertHidden fails when elemenent does not exist

Snippets page contains examples that do not compile with Selenide 2.+

https://github.com/codeborne/selenide/wiki/Snippets

For example:

waitUntil("#username", hasText("Hello, Johny!"), 8000);

Create CollectionCondition#exactTexts

Create BrowserStrategy for TestNG

It would be convenient to declare one of "browser per test", "browser per class" strategy as an annotation to tests.

Now we have such an annotation only for JUnit. Need the same for TestNG.

Searching with $() returns different element if the initial one has changed

For example, clicking the button will change it's class from 'btn btn-primary btn-save' to 'btn btn-save'.

I'm storing the button as SelenideElement to make checks later:

    SelenideElement bSave = $(".btn-primary.btn-save");

Now, following code

    SelenideElement bSave = $(".btn-primary.btn-save");
    System.out.println(bSave.getLocation());

    bSave.click();
    System.out.println(bSave.getLocation());

    Thread.sleep(5000);

    System.out.println(bSave.getLocation());

will return

    (1373, 365)
    (1373, 365)
    (1373, 549)

So "bSave" appears to be another button now. And the final check will fail:

    bSave.should(hasNotClass("btn-primary"));

PS: I was able to write the same without using $() in pure Selenium and WebElement and it worked.

Bug in documentation: byText vs withText

1. http://ru.selenide.org/documentation.html says:
   byText - поиск элемента по тексту (подстроке)
   withText - поиск элемента по точному тексту
2. javadoc says:
   withText - CONTAINING,
   byText - HAVING

2 Selenide tests fail on Internet Explorer

Failing tests:

1. AlertTest
2. ConfirmTest
   Both operating with modal windows ("alert" and "confirm").

Provide method for testing file download dialog

As described here:
http://ardesco.lazerycode.com/index.php/2012/07/how-to-download-files-with-selenium-and-why-you-shouldnt/

Add screenshots to TestNG report with ReportNG

Add support for PageObject concept

Not sure we really need it, but why not.

If somebody wants to use PageObject, we could allow it by using
"return org.openqa.selenium.support.PageFactory.initElements(driver, MyPageObject.class)"

Method WebDriverRunner.closeWebDriver should use driver.quit() instead if driver.close()

Method driver.close() closes the window, but leaves IE or CHROME process alive.

I would like to be able to write $$(".smth").shouldBe(visible)

To check that all returned elements are visible

Create readable error message for element initialized by PageFactory

Having an element:

@FindBy(id  = "invalid_id")
private WebElement categoryDropdown;

1. Trying to select an option: $(categoryDropdown).selectOption("SomeOption");
   produces the following error message: ElementNotFound {By.selector: option, in: NoSuchElementException: Unable to locate element: {"method":"id","selector":"invalid_id"}}
2. Trying to click the element: $(categoryDropdown).click() produces the following error message: org.openqa.selenium.NoSuchElementException: Unable to locate element: {"method":"id","selector":"invalid_id"}

Make method DOM.selectRadio more generic

Currently it's tuned for Struts2-like selectbox that contain elements.
Try to make it more generic.

should* methods can return the same element to allow chaining

New assert methods

assertURL()

Selectors.byText searchs for element GLOBALLY, not inside current context

For example, this line: $("#progress tr", 3).find(byText("Edit")) returns FIRST, not the 3rd "Edit" button.

$.shouldHave(text("John McClain")) should ignore whitespaces

Different browsers treat spaces differently. For this row JohnMcClain some browsers think that text is "JohnMcClain", but others think that text is "John McClain".

It would be universal approach if text() condition would ignore whitespaces.

CollectionCondition#texts should match substrings

Currently $$().shouldHave(texts("A", "B", "C"))
matches exact texts, but shuld match substrings.

getElement() and shouldXXX() methods should wait for a few seconds

Many events happen after few seconds (because of heavy usage of Ajax in modern web applications).
Currently it's possible to implicitly call waitUntil("#messages div", hasText("John")), but in most cases user does not even know about Ajax, so Selenide should wait automatically - as naturally as user does wait.

For example, method
$("#messages div").shouldHave(text("John")) should wait for few seconds until the "div" actually gets text "John" loaded.

Add method $.scrollTo

Selenide has method scrollTo, but it uses jQuery plugin "scroll".
The same effect could be achieved without using jQuery:

public static void scrollTo(WebElement element) {
        int elementPosition = element.getLocation().getY();
        String js = String.format("window.scrollTo(0, %s)", elementPosition);
        JavascriptExecutor jsx = (JavascriptExecutor) getWebDriver();
        jsx.executeScript(js, "");
}

Add support for TestNG

Create a'la "TestWatcher" that could take screenshots of failed tests.

Added method $.selectOption(String byText)

This method should wait until all options are loaded into the selectbox.

Fix byText() and withText() xpaths

By.xpath(".//*[contains(normalize-space(text()), "" + elementText + "")]")

По спецификации: http://www.w3.org/TR/xpath/#node-tests. text() - в действительности это не текст элемента, а функция, которая возвращает все текстовые ноды данного элемента. Т.е. в случае

div_text

имеется две текстовых ноды: //div/text()[1] == ' ', //div/text()[2] == ' div_text '; а //div[contains(text(),'div_text')] ==//div[contains(text()[1],' div_text ')] == NoSuchElement

Provide method for adding custom WebDriverEventListeners

EventFiringWebDriver efwd = new EventFiringWebDriver(webdriver);
efwd.register(new AbstractWebDriverEventListener(){...});

$.waitUntil: User can accidentally pass timeout in seconds, not milliseconds.

Error message should clearly indicate that timeout is too short.

Implement ScreenShots for RemoteWebDriver

For RemoteWebDriver, screenshots should be taken differently from usual webdriver:

File scrFile;

        if (driver.getClass().equals(RemoteWebDriver.class)) {
            scrFile = ((TakesScreenshot) new Augmenter().augment(driver)).getScreenshotAs(OutputType.FILE);
        } else {
            scrFile = ((TakesScreenshot) driver).getScreenshotAs(OutputType.FILE);
        }

Selenide does not clearly say if invalid XPath is used

This line of code:

$(By.xpath("##[id")).shouldNot(exist);

should throw exception that clearly says that XPath is invalid. Now Selenide just swallows this error.

Add selector By.text

Currently Selenium API doesn't provide method to find element by text. But we believe that Acceptance Tests must use visible text where possible. So, we should add several selectors:

• By.text
• By.partialText
• By.regex

ElementsCollection#size() causes NoClassDefFoundError

I assume that issue is caused by incorrect import statement in FilteringCollection.

java.lang.NoClassDefFoundError: com/beust/jcommander/internal/Lists
at com.codeborne.selenide.impl.FilteringCollection.getActualElements(FilteringCollection.java:21)
at com.codeborne.selenide.ElementsCollection.getActualElements(ElementsCollection.java:79)
at com.codeborne.selenide.ElementsCollection.size(ElementsCollection.java:104)

I have added jcommander to dependencies of my project as a temporary workaround.

Add option not to add timestamp to URLs

Or maybe add only for IE?
Need to investigate why it is needed at all.

Method $$().shouldHave() should accept multiple conditions

Like this:
$$().shouldHave(size(2), texts("A", "B"));

Remove INTRODUCE_FLAKINESS_BY_IGNORING_SECURITY_DOMAINS IE capability

It's treated as a bad practice:
http://jimevansmusic.blogspot.com/2012/08/youre-doing-it-wrong-protected-mode-and.html

Add option to leave browser window open

Selenide closes the browser window when all tests are finished.
But it's often useful to leave browser window open during development.

Readable error message

Make error messages easily readable

Chaining of ElementsCollection methods

Some ElementsCollection methods (shouldHaveSize, shouldBe and shouldHave) do not support chaining, i.e. not possible to write such expressions:
$$("table tr").shouldHaveSize(10).filterBy(text("aaa"));

It would be nice if those can be chained the same way as other methods.

Bug in documentation for Condition

1. "You can easily add your own conditions by implementing interface com.codeborne.selenide.Condition" - actually Condition is abstract class.
2. Add an example of custom Condition into documentation.

    @Override
    public String actualValue(WebElement element) {
        return element.getCssValue(propName);
    }

    @Override
    public String toString(){
        return String.format("'%s' css property of '%s' value", propName, propValue);
    }
};

Add support for TestNG

Create a'la "TestWatcher" that could take screenshots of failed tests.

$.selectOption("smth") should wait until this option appears

This is actual when options in selectbox are generated dynamically by javascript

Exception should contain URL if browser failed to open page

Currently trying to execute open("www.yandex.ru"); causes quite unreadable error message:

org.openqa.selenium.WebDriverException: Component returned failure
code: 0x804b000a (NS_ERROR_MALFORMED_URI) [nsIIOService.newURI]
Command duration or timeout: 44 milliseconds
Build info: version: '2.31.0', revision:
'1bd294d185a80fa4206dfeab80ba773c04ac33c0', time: '2013-02-27
13:51:26'
System info: os.name: 'Windows 7', os.arch: 'x86', os.version: '6.1',
java.version: '1.7.0_07'
Session ID: e697e9e5-1d3e-4f15-8855-196d02670da8
Driver info: org.openqa.selenium.firefox.FirefoxDriver
Capabilities [{platform=XP, databaseEnabled=true,
cssSelectorsEnabled=true, javascriptEnabled=true, acceptSslCerts=true,
handlesAlerts=true, browserName=firefox,
browserConnectionEnabled=true, nativeEvents=true,
webStorageEnabled=true, rotatable=false, locationContextEnabled=true,
applicationCacheEnabled=true, takesScreenshot=true, version=23.0.1}]
        at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)

Unclear error message in case of mismatching text

Code:
$(".alert-success").shouldHave(text(message));

Result:
junit.framework.AssertionFailedError: {By.selector: .alert-success}
Expected: got text 'Deposit has been created. The amount will be transferred to it in a few moments. You can check the status of transfer in payment history.'
Timeout: 4 s.

Enable using multiple WebDriver instances in the same process

It can be useful for running tests in multiple parallel threads (for example, TestNG allows it).

An example of TestNG configuration provided by Sergey Kuts:

<test name="IE 10 Test">
    <parameter name="browser"  value="internet explorer"/>
    <parameter name="version"  value="10"/>
    <parameter name="platform"  value="WINDOWS"/>

    <classes>
        <class name="class1">
            <methods>
                <include name = "method1"/>
                <include name = "method2"/>
            </methods>
        </class>
    </classes>
</test>

 <test name="FF 10 Test">
     <parameter name="browser"  value="firefox"/>
     <parameter name="version"  value="10"/>
     <parameter name="platform"  value="WINDOWS"/>

     <classes>
         <class name="class1">
             <methods>
                 <include name="method1" />
                 <include name="method2" />
             </methods>
         </class>
     </classes>
 </test>