The effortless way to test WebRTC compliance, prevent Karoshi with KITE!

See LICENSE for licensing.

• Install the browsers you would like to test, available for your machine. Chrome, Edge, Firefox and Safari are supported at this stage. Attention: WebDriver for Firefox on Windows has some limitations (not supporting testing involving using media, or Firefox profile with fake media stream).
• Make sure you have a recent Java SDK installed (or get e.g. JDK 8.1)

• Create a new working directory and move in there.

• Download the corresponding webdrivers on the root of a new working directory:

  • Download the latest chrome webdriver,
  • Download the latest firefox webdriver,
  • On Windows, download the latest edge webdriver,

• Download Selenium Server Standalone 3.5.3 in the same folder

Enable the 'Allow Remote Automation' option in Safari's Develop menu to control Safari via WebDriver.

Run this command , don't stop it until testing session has finished

On Linux and Mac run:

java -Dwebdriver.chrome.driver=./chromedriver -Dwebdriver.gecko.driver=./geckodriver -jar selenium-server-standalone-3.5.3.jar

On Windows run:

java -Dwebdriver.chrome.driver=./chromedriver.exe -Dwebdriver.gecko.driver=./geckodriver.exe -Dwebdriver.edge.driver=./MicrosoftWebDriver.exe -jar selenium-server-standalone-3.5.3.jar

• -Dwebdriver.xxxx.driver specifies the path to the webdriver executable matching the browser xxxx (possible values of xxxx are: gecko, chrome, edge, ...).
• Depending on platform and the testing needs, command line can include one, two or the three drivers

1. Build and install running the command

mvn clean install

• If selenium is not running, build will fail, as KITE-AppRTC-Test includes a Junit test that requires local selenium. You can skip this (not recommended) running maven with -DskipTests

mvn clean install -DskipTests

1. Download compressed tomcat distribution, (version 8.5.20 at time of this writing) [http://tomcat.apache.org/download-80.cgi#8.5.20]

2. Unzip/extract anywhere.

3. Copy KITE-Dashboard/target/kiteweb.war file to apache-tomcat-8.5.20/webapps

• If the file KITE-Dashboard/target/kiteweb.war doesn't exist, rerun the build (previous step)

4. Start tomcat:

5. Now open a browser and access the following URL http://localhost:8080/kiteweb

6. When test session finishes, stop tomcat:

You can use example configuration file ./KITE-AppRTC-Test/configs/local.config.json as starting point.

Read below about the configuration file, check that the desired browsers listed in your configuration file are available in your system.

The example local.config.json file is almost the simplest config file you can get:

{
  "name": "local selenium example",
  "callback": "http://localhost:8080/kiteweb/datacenter",
  "remotes": [
    {
      "type": "local",
      "remoteAddress": "http://localhost:4444/wd/hub"
    }
  ],
  "tests": [
    {
      "name": "IceConnectionTest",
      "tupleSize": 2,
      "testImpl": "org.webrtc.kite.IceConnectionTest"
    }
  ],
  "browsers": [
    {
      "browserName": "firefox"
    },
    {
      "browserName": "chrome"
    }
  ]
}

It assumes that the dashboard runs on the same machine:

"callback": "http://localhost:8080/kiteweb/datacenter"

It registers only selenium server in the local machine:

  "remotes": [
    {
      "type": "local",
      "remoteAddress": "http://localhost:4444/wd/hub"
    }
  ],

It registers IceConnectionTest class as a test (this class is implemented in KITE-AppRTC-Test)

  "tests": [
    {
      "name": "IceConnectionTest",
      "tupleSize": 2,
      "testImpl": "org.webrtc.kite.IceConnectionTest"
    }
  ],

It requests for firefox and chrome, but without specifying a platform or a version, so it should run on any computer with those browsers installed. The version and platform actually used will be reported in the result, will appear in the dashboard.

Sample config files in KITE-AppRTC-Test/configs contain different examples for explicit version and platform configuration, take a look

Attention: WebDriver for Firefox on Windows has some limitations (not supporting testing involving using media, or Firefox profile with fake media stream).

  "browsers": [
    {
      "browserName": "firefox"
    },
    {
      "browserName": "chrome"
    }
  ]

Execute the following command in the working directory, the last argument specifies the configuration file specifying the tests:

On Linux and Mac run:

java -cp KITE-Engine/target/kite-jar-with-dependencies.jar:KITE-AppRTC-Test/target/apprtc-test-1.0.jar org.webrtc.kite.Engine ./KITE-AppRTC-Test/configs/local.config.json

On Windows run:

java -cp KITE-Engine/target/kite-jar-with-dependencies.jar;KITE-AppRTC-Test/target/apprtc-test-1.0.jar org.webrtc.kite.Engine ./KITE-AppRTC-Test/configs/local.config.json

Check the dashboard for the results and reports.

If you have followed steps above, that's http://localhost:8080/kiteweb.

KITE-Dashboard can be setup on any machine as described in previous section, you will need to change the callback url in your config file accordingly.

SauceLabs, BrowserStack and TestingBot have been tested and are supported.

See example files in KITE-AppRTC-Test/configs mixing different hosted test services.

Complete the fields username and accesskey appropriately.

• Don't forget to modify the example browsers, versions and platforms to suit your needs.