Testium

Testium is a testing platform focused on providing a simple, but effective, platform for testing your code in different browsers (via Selenium) and headlessly (via PhantomJS). It uses webdriver-http-sync in order to communicate (using the WebDriver protocol) with a selenium server.

Keep up to date with changes by checking the releases.

Demo Video

Example

A simple test using assertive and mocha.

injectBrowser = require 'testium/mocha'
assert = require 'assertive' # or whatever assert library you prefer

describe 'browse', ->
  before injectBrowser()

  before ->
    @browser.navigateTo '/my-account'
    @browser.assert.httpStatus 200

  it 'is serving up gzipped content', ->
    assert.equal 'gzip', @browser.getHeader('Content-Encoding')

For help debugging your tests, check out the wiki page.

Getting Started

Install Testium by running npm install --save testium.

Then, you can specify additional configuration, like so!

; .testiumrc
launch = true ; defaults to false, `npm start`s the app

[mocha]
timeout = 10000 ; defaults to 20 seconds
slow = 2500 ; defaults to 2 seconds

Run your tests with mocha: mocha test/integration

Detailed Setup

Testium might require that you install some system-level libraries.

required

libcurl (for sync http)
[Ubuntu] sudo apt-get install libcurl4-openssl-dev
[OS X] brew install curl
Node.js 0.10+
phantomjs 1.9.7+ (only for headless testing)
java 7+ (only when running in browsers)

optional

libpng (for image diffing)
[Ubuntu] sudo apt-get install libpng-dev
[OS X] brew install libpng

Configuration

testium uses rc for configuration. Below are the options and their defaults:

# Root directory of the application.
# All paths will be resolved relative to this directory.
# It's also where testium will look for a `package.json` file
# to figure out how to start the app.
root: process.cwd()
# Automatically launch the app with NODE_ENV=test.
# Set this to true if you want testium to handle this for you
# when you call `getBrowser`.
launch: false

# The browser to use, possible values:
# phantomjs | chrome | firefox | internet explorer
browser: 'phantomjs'
desiredCapabilities: {}

# Directory (relative to `root`) where logs are written by testium
logDirectory: './test/log'
# Directory to store automated screenshosts, e.g. on failing tests
screenshotDirectory: './test/log/failed_screenshots'

app:
  # A port of 0 means "auto-select available port"
  port: process.env.PORT || 0
  # How long to wait for the app to start listening
  timeout: 30000
  # Command to start the app.
  # `null` means testium will simulate `npm start`
  command: null
phantomjs:
  # Command to start phantomjs
  # Change this if you don't have phantomjs in your PATH
  command: 'phantomjs'
  # How long to wait for phantomjs to listen
  timeout: 6000
selenium:
  # How long to wait for selenium to listen
  timeout: 90000
  # Set this if you have a running selenium server
  # and don't want testium to start one.
  serverUrl: null
  # Path to selenium jar.
  # `null` means "use testium built-in".
  # Using the testium built-in binaries requires you to run
  # `testium --download-selenium` before running your tests.
  jar: null
  # Path to chromedriver.
  # `null` means "use testium built-in", see `jar` above.
  chromedriver: null
repl:
  # Module for the testium repl
  # If you want to use coffee-script in the repl, use:
  # * `module: coffee-script/repl` for coffee-script
  # * `module: coffee-script-redux/lib/repl` for redux
  module: 'repl'
mixins:
  # mixin modules allow you to add new methods to the browser
  # Example:
  # ```
  # module.exports = {
  #   // available as `browser.goHome()`
  #   goHome: function() {
  #     this.click('header #home');
  #   }
  # };
  # ```
  # Elements in the array should be node.js module names
  # that can be required relative to `root`.
  browser: []
  # Same as browser, only that it extends `browser.assert`.
  # Use this.browser to access the browser.
  assert: []
mocha:
  # mocha timeout for all tests that are in the suite the
  # browser was injected into.
  timeout: 20000
  # Same, just for `slow`.
  slow: 2000

Testium Command-Line Tool

Downloading Selenium

Testium can handle downloading selenium for you, making sure the version you download was tested with the current version of testium.

$ ./node_modules/.bin/testium --download-selenium
[testium] grabbing selenium standalone server 2.39.0
[testium] grabbing selenium chromedriver 2.8
Up to date!

Alias: testium --update-selenium

Interactive Console

Testium provides an interactive node.js repl as a bin stub. It creates a browser and mixes the methods of that browser into the global scope.

It respects all configuration options, so if you enabled launch, it will also launch your app.

You can use it like so!

$ ./node_modules/.bin/testium --browser firefox
firefox> navigateTo('http://google.com')
firefox> var element = getElement('input[name="q"]')
firefox> element.type('puppies\n')

And the browser will navigate to google.com, find the search box, and type puppies\n into it. You should now see search results for puppies.

This is useful for testing out your commands before setting up an actual test. You can even use .save test/integration/google.coffee to save the commands you entered into a file. For more info, read the official node repl docs.

Testium API

The complete description can be found at API.md.

getBrowser(config, callback)

Browser

Method	Description
`browser.navigateTo(url, options)`	Navigates the browser to the specificed relative or absolute url with options such as headers.
`browser.refresh()`	Refresh the current page.
`browser.capabilities`	Is an object describing the WebDriver capabilities that the current browser supports.
`browser.getElement(cssSelector)`	Finds an element on the page using the `cssSelector` and returns an Element.
`browser.getElements(cssSelector)`	Finds all elements on the page using the `cssSelector` and returns an array of Elements.
~~`browser.waitForElement(cssSelector, timeout=3000)`~~	Deprecated (synonym for `browser.waitForElementVisible(cssSelector, timeout=3000)`
`browser.waitForElementVisible(cssSelector, timeout=3000)`	Waits for the element at `cssSelector` to exist and be visible, then returns the Element. Times out after `timeout` ms.
`browser.waitForElementExist(cssSelector, timeout=3000)`	Waits for the element at `cssSelector` to exist, then returns the Element. Times out after `timeout` ms. Visibility is not considered.
`browser.getUrl()`	Returns the current url ('http://localhost:1234/some/route') of the page.
`browser.waitForUrl(url, timeout=5000)`	Waits `timeout` ms for the browser to be at the specified `url`.
`browser.waitForUrl(url, query, timeout=5000)`	Waits `timeout` ms for the browser to be at the specified `url` with query parameters per the `query` object.
`browser.getPath()`	Returns the current path ('/some/route') of the page.
`browser.waitForPath(path, timeout=5000)`	Waits `timeout` ms for the browser to be at the specified `path`.
`browser.getPageTitle()`	Returns the current page title.
`browser.getPageSource()`	Returns the current page's html source.
`browser.getPageSize()`	Returns the current window's size.
`browser.setPageSize({height, width})`	Sets the current window's size.
`browser.getScreenshot()`	Returns screenshot as a base64 encoded PNG.
`browser.click(cssSelector)`	Calls Click on the Element found by the given `cssSelector`.
`browser.type(cssSelector, value)`	Sends `value` to the input Element found by the given `cssSelector`.
`browser.setValue(cssSelector, value)`	Set's the Element's value at `cssSelector` to `value`.
`browser.clear(cssSelector)`	Clears the input Element found by the given `cssSelector`.
`browser.clearAndType(cssSelector, value)`	Clears the input Element found by the given `cssSelector`, then sends `value` to it.
`browser.evaluate(javascriptString)`	Executes the given javascript. It must contain a return statement in order to get a value back.
`browser.evaluate(function)`	Returns the result of the given function, invoked on the webdriver side (so you can not bind its `this` object or access context variables via lexical closure).
`browser.evaluate(args..., function(args...))`	Same as above, but marshals the args as JSON and passes them to the function in the given order. E g: `browser.evaluate 'hash', (prop) -> window.location[prop]` would return the current url fragment.
`browser.setCookie(Cookie)`	Sets a cookie on the current page's domain. `Cookie = { name, value, path='/' }`
`browser.setCookies([Cookie])`	Sets all cookies in the array. `Cookie = { name, value, path='/' }`
`browser.getCookie(name)`	Returns the cookie visible to the current page with `name`.
`browser.getCookies()`	Returns all cookies visible to the current page.
`browser.clearCookies()`	Deletes all cookies visible to the current page.
`browser.getStatusCode()`	Returns the response status code for the current page.
`browser.getHeader(name)`	Returns the value of the response header with the provided name.
`browser.getHeaders()`	Returns all response headers for the current page.
`browser.getConsoleLogs(logLevel='all')`	Returns all log events with `logLevel` (log/warn/error/debug) since the last time this method was called. Warning: Each browser implements this differently against the WebDriver spec.
`browser.switchToDefaultFrame()`	Switch focus to the default frame (i.e., the actual page).
`browser.switchToFrame(id)`	Switch focus to the frame with name or id `id`.
`browser.switchToDefaultWindow()`	Switch focus to the window that was most recently referenced by `navigateTo`. Useful when interacting with popup windows.
`browser.switchToWindow(name)`	Switch focus to the window with name `name`.
`browser.close(callback)`	Closes the Testium session.

Alert

Method	Description
`browser.getAlertText()`	Gets the text of a visible alert, prompt, or confirm dialog.
`browser.acceptAlert()`	Accepts a visible alert, prompt, or confirm dialog.
`browser.dismissAlert()`	Dismisses a visible alert, prompt, or confirm dialog.
`browser.typeAlert(value)`	Types into a visible prompt dialog.

Note: Alerts effectively don't work when running with PhantomJS. getAlertText() will throw an error and the others will just silently not work. If you must test with PhantomJS you can work around this by stubbing the alert, confirm, and prompt global methods in your client-side javascript. Below is an example.

# Stub alert
@browser.evaluate 'return window.alert = function() { };'

# Stub confirmation
desiredValue = true
@browser.evaluate "return window.confirm = function() { return #{desiredValue}; };"

# Stub prompt
desiredValue = 'foo'
@browser.evaluate "return window.prompt = function() { return \'#{desiredValue}\'; };"

Assertions

Method	Description
`browser.assert.elementHasText(selector, textOrRegex)`	Throws exceptions if selector doesn't match a single node, or that node does not contain the given `textOrRegex`. Allows an optional extra initial docstring argument, for semantic documentation about the test when the assertion fails. Returns the element.
`browser.assert.elementLacksText(selector, textOrRegex)`	Throws exceptions if selector doesn't match a single node, or that node does contain the given `textOrRegex`. Allows an optional extra initial docstring argument, for semantic documentation about the test when the assertion fails. Returns the element.
`browser.assert.elementHasValue(selector, textOrRegex)`	Throws exceptions if selector doesn't match a single node, or that node's value does not contain the given `textOrRegex`. Allows an optional extra initial docstring argument, for semantic documentation about the test when the assertion fails. Returns the element.
`browser.assert.elementLacksValue(selector, textOrRegex)`	Throws exceptions if selector doesn't match a single node, or that node's value does contain the given `textOrRegex`. Allows an optional extra initial docstring argument, for semantic documentation about the test when the assertion fails. Returns the element.
`browser.assert.elementHasAttributes(selector, attributesObject)`	Throws exceptions if selector doesn't match a single node, or that node does not contain the given `attribute:value` pairs. Allows an optional extra initial docstring argument, for semantic documentation about the test when the assertion fails. Returns the element.
`browser.assert.elementIsVisible(selector)`	Throws exceptions if selector doesn't exist or is not visible. Returns the element.
`browser.assert.elementNotVisible(selector)`	Throws exceptions if selector doesn't exist or is visible. Returns the element.
`browser.assert.elementExists(selector)`	Throws exceptions if selector doesn't exist. Returns the element.
`browser.assert.elementDoesntExist(selector)`	Throws exceptions if selector exists.
`browser.assert.httpStatus(statusCode)`	Throws exceptions if current status code is not equal to the provided statusCode.
`browser.assert.imgLoaded(selector)`	Throws exceptions if selector doesn't match a single `<img>` element that has both loaded and been decoded successfully. Allows an optional extra initial docstring argument, for semantic documentation about the test when the assertion fails.
`browser.assert.imagesMatch(image1, image2, tolerance=0)`	Throws exceptions if the images don't match within the given tolerance. Warning: this method is experimental and slow. You can use `@slow(4000)` in tests to notify mocha of this.

Element

element = browser.getElement(selector)

Note: selector can be anything WebDriver's CSS Selector can accept. Where supported by browsers, this is equivalent to document.querySelectorAll(selector).

Method	Description
`element.get(attribute)`	Returns the element's specified attribute, which can be `text`. Note that WebDriver (and therefore testium) will not return text of hidden elements.
`element.click()`	Calls click on the element.
`element.isVisible()`	Returns `true` if the element is visible.
`element.type(strings...)`	Sends `strings...` to the input element.
`element.clear()`	Clears the input element.

Contributing

If you'd like to help make testium better, please check out:

CONTRIBUTING.md

If you have questions, you can contact the author at:
@endangeredmassa
[email protected]

jeloou / testium Goto Github PK

testium's Introduction