Skip to content

Latest commit

 

History

History
217 lines (158 loc) · 6.11 KB

README.md

File metadata and controls

217 lines (158 loc) · 6.11 KB
Raw

Cuked

Build Status

Cuked is an automated testing framework combining the power of CucumberJS, PhantomJS, Saucelabs, Webdriver.io and Chai to make writing tests fun and easy.

Cuked is an alternative to monolithic testing frameworks that trap you into proprietary abstractions and API's. Cuked is built from the ground to synergize CucumberJS with the other industry standard micro-libraries you know and love.

Features

  • Write your feature specs and step definitions with CucumberJS
  • Use the powerful Webdriver.io fluent chain-able API for composable test executions
  • Write your assertions beautifully in a human readable format using the power of Chai
  • Leverage the power of PhantomJS, Selenium, SauceLabs for seamless integration between optimized local development and full continuous integration support.

Quick Start

Installation

npm install cuked -g

CLI

Cuked provides just enough native options to better facilitate the synergy between CucumberJS, PhantomJS, Selenium, SauceLabs, and Webdriver.io.

However, in an effort to keep Cuked as flexable as possible all other CLI options are passed through to their respective binaries. This means that all CLI options from CucumberJS, PhantomJS, and Selenium are available to you through Cuked.

Cuked

path remote browser platform version name debug

CucumberJS

grep format require

PhantomJS

cookies webdriver

Selenium

port timeout

path

The path to your local CucumberJS features directory.

  • command: --path
  • default: ./features
  • example usage:
  cuked --path='tests/acceptance/features'
  cuked --path='tests/features'

browser

The browser to use. The available options are phantomjs, any browser on your local machine such as chrome, firefox or any browser available to SauceLabs.

  • command: --browser
  • default: phantomjs
  • example usage:
  cuked --browser=firefox // would use local firefox instance
  cuked --browser=chrome // would use local chrome instance

host

The host domain that points to your Selenium Grid or SauceLabs hub url. Ignore this if your using phantomjs or local selenium.

  • command: --host
  • default: localhost
  • example usage:
cuked --host=ondemand.saucelabs.com

port

The port that used in conjunction with your host. Ignore this if your using phantomjs or local selenium.

  • command: --port
  • default: 4444
  • example usage:
cuked --port=80

user

The user credentials to send to SauceLabs or authenticated grid environment.

  • command: --user
  • default: ``
  • example usage:
cuked --user=eric

key

The accessKey to send to SauceLabs or authenticated grid environment.

  • command: --key
  • default: ``
  • example usage:
cuked --key=112D69BD-5818-42F3-A3E9-493600AEC57D

platform

If your remote URL is a SauceLabs or Selenium Grid endpoint you may wish to request a specific platform to run your tests on. If running tests on your local machine this is ignored.

  • command: --platform
  • default: ANY
  • example usage:
  cuked --platform='Windows 7'
  cuked --platform='OS X 10.8'

Type: String Default: ANY

version

If using a Selenium Grid or Grid providers such as SauceLabs you may wish to request a specific version of a browser.

  • command: --version
  • default: ANY
  • example usage:
cuked --browser='firefox' --version='35' --remote='http://user:[email protected]/wd/hub'
cuked --browser='chrome' --version='35' --remote='http://yourseleniumhub.com:4444/wd/hub'

name

If using a Selenium Grid or Grid providers such as SauceLabs you may wish to assign a test name. In SauceLabs for instance this will appear in your test rules dashboard.

  • command: --name
  • default: unknown
  • example usage:
cuked --name='Acceptance Tests' --browser='firefox' --remote='http://user:[email protected]/wd/hub'

log

Whether or not to display debug information. Namely Webdriver commands.

  • command: --log
  • default: silent
  • options: silent, command
  • example usage:
cuked --log=command

FAQ

Plugins

Grunt

grunt-cuked

Gulp

plugin coming soon

Contributing

Fork the repo and issue a pull request

License

The MIT License

Copyright (c) 2015 Eric Clifford

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.