Selenium Executor

Selenium is virtual executor provided you ability to run functional tests locally with Selenium WebDriver by choosing appropriate executor. Currently supported executors are:

• JUnit (Java)
• TestNG (Java)
• Nose (Python)
• RSpec (Ruby)
• Mocha (JavaScript)
• NUnit (C#)

Selenium Grid isn't supported for tests described with Taurus language, but if you have your own test suite that uses Selenium Grid to manage browser instances - Taurus will run these tests just fine.

Selenium executor uses multiple test runners (JUnit, TestNG, Mocha, etc), test type is detected automatically. If automatic detection fails - you can use runner option described below.

Taurus can loop test suite execution in a loop until desired number of iterations will complete or hold-for time will be exceeded.

Supported file types:

Test scenario may be presented not only as single file but as a folder (or, in case of Java-based tests, as a jar).

• .java/single file
• .java/folder (flat structure, no package)
• .java/folders (package)
• .jar/single file
• .jar/folder
• .py/single file
• .py/folder
• .rb/single file
• .rb/folder
• .js/single file
• .js/folder
• .dll/single file
• .dll/folder

Specifying Test Runner Explicitly

By default, Taurus tries to automatically detect the language your tests are written in. If, for some reason, the autodetection fails - you can specify test runner explicitly with runner execution-level option.

Supported values:

• junit: JUnit-based Java tests
• testng: TestNG-based Java tests
• nose: Nose-based Python tests
• rspec: RSpec-based Ruby tests
• mocha: Mocha-based JavaScript tests
• nunit: NUnit-based C# tests

Usage:

execution:
- executor: selenium
  runner: nose
  scenario:
    script: tests/

{
    "execution": [
        {
            "executor": "selenium",
            "runner": "nose",
            "scenario": {
                "script": "tests\/"
            }
        }
    ]
}

Scenario Examples

JUnit-based test with single .java file:

execution:
- executor: selenium
  scenario: simple

scenarios:
  simple:
    script: /home/user/selenium_tests.java

{
    "execution": [
        {
            "executor": "selenium",
            "scenario": "simple"
        }
    ],
    "scenarios": {
        "simple": {
            "script": "\/home\/user\/selenium_tests.java"
        }
    }
}

Running folder of test scripts with automatic runner detection:

execution:
- executor: selenium
  scenario: simple
  
scenarios: 
  simple:
    script: /home/user/folder/

{
    "execution": [
        {
            "executor": "selenium",
            "scenario": "simple"
        }
    ],
    "scenarios": {
        "simple": {
            "script": "\/home\/user\/folder\/"
        }
    }
}

Extended scenario with runner options:

execution:
- executor: selenium
  iterations: 5  # loop over test suite for 5 times
  runner: junit
  scenario: complex
  
scenarios:
  complex:
    script: /home/user/tests/my_test.java
    additional-classpath:  # optional, following libs will be added to java classpath
    - /home/user/lib_one.jar
    - /home/user/lib_two.jar    
    
modules:
  junit:
    jar-name: compiled_jar_from_provided_sources.jar
        
reporting:
- module: junit-xml

{
    "execution": [
        {
            "executor": "selenium",
            "iterations": 5,
            "runner": "junit",
            "scenario": "complex"
        }
    ],
    "scenarios": {
        "complex": {
            "script": "\/home\/user\/tests\/my_test.java",
            "additional-classpath": [
                "\/home\/user\/lib_one.jar",
                "\/home\/user\/lib_two.jar"
            ]
        }
    },
    "modules": {
        "junit": {
            "jar-name": "compiled_jar_from_provided_sources.jar"
        }
    },
    "reporting": [
        {
            "module": "junit-xml"
        }
    ]
}

Requests Scenario

Selenium executor supports building test script from the requests option of scenario. Look at Nose executor manual page for more information.

Automatic Installation of Web Driver

By default, Taurus will download ChromeDriver and GeckoDriver and put them in PATH when running tests.

You can configure this behaviour with the following options:

execution:
- executor: selenium
  iterations: 1
  scenario: simple
  
scenarios:
  simple:
    requests:
    - http://blazedemo.com/

modules:
  selenium:
    chromedriver:
      version: 2.30
      download-link: https://chromedriver.storage.googleapis.com/{version}/chromedriver_{arch}.zip
    geckodriver:
      version: 0.17.0
      download-link: https://github.com/mozilla/geckodriver/releases/download/v{version}/geckodriver-v{version}-{arch}.{ext}

{
    "execution": [
        {
            "executor": "selenium",
            "iterations": 1,
            "scenario": "simple"
        }
    ],
    "scenarios": {
        "simple": {
            "requests": [
                "http:\/\/blazedemo.com\/"
            ]
        }
    },
    "modules": {
        "selenium": {
            "chromedriver": {
                "version": 2.3,
                "download-link": "https:\/\/chromedriver.storage.googleapis.com\/{version}\/chromedriver_{arch}.zip"
            },
            "geckodriver": {
                "version": "0.17.0",
                "download-link": "https:\/\/github.com\/mozilla\/geckodriver\/releases\/download\/v{version}\/geckodriver-v{version}-{arch}.{ext}"
            }
        }
    }
}

Using Virtual Display on Linux

If you want to run headless tests on Linux using virtual framebuffer (Xvfb), you can tell Taurus to run virtual display by using following config piece:

services:
- module: virtual-display
  width: 1024
  height: 768

{
    "services": [
        {
            "module": "virtual-display",
            "width": 1024,
            "height": 768
        }
    ]
}

Note: SeleniumExecutor uses shared virtual display for all executions.

Deprecation Note: using virtual-display in selenium module settings is deprecated and will be removed in the future, you should use Virtual Display Service.

Appium

Appium is a tool for testing naitive mobile applications. Taurus supports only python scripts for appium in Selenium executor. Additionally, you can use taurus services to run Appium server and Android emulator. There is typical example of usage:

execution:
- executor: selenium
  scenario: ap_scen

scenarios:
  ap_scen:
    script: test_appium_script.py

services:
- appium
- android-emulator

modules:
  android-emulator:
    avd: android10_arm128

{
    "execution": [
        {
            "executor": "selenium",
            "scenario": "ap_scen"
        }
    ],
    "scenarios": {
        "ap_scen": {
            "script": "test_appium_script.py"
        }
    },
    "services": [
        "appium",
        "android-emulator"
    ],
    "modules": {
        "android-emulator": {
            "avd": "android10_arm128"
        }
    }
}

Conversion of Tests into JMeter format

You can convert your Selenium tests into JMX files by using a Proxy2JMX Converter module, as described here.