Corespring Components

The default corespring component set.

Requirements

• bower >= 1.2.7
• node/npm >= 0.10.*
• grunt

Running

They are designed to work with a Corespring Container implementation. See corespring-container.

Developing

TODO...

Test Rig

This rig runs the component tests.

• Client side tests are run with PhantomJs, tests are written in jasmine
• Server side tests are run with Mocha, tests are written in jasmine

Env vars

corepringCore

This is the path to the corespring container core.js file that contains the global corespring object. If you are running the components from within the corespring-container you don't need to change this path as it defaults to the right file. If not the path needs to be a relative path to the core.js file.

You can set this on the command line like so:

grunt test --corespringCore=.....

Usage

First ensure that you have all the dependencies installed:

sudo npm install grunt-cli
npm install
bower install

If you want to run the functional tests, then ensure that you have a version of corespring-container running on your local machine at port 9000. Alternatively, you can run the regression tests against a different url by passing the --baseUrl argument.

Testing

Unit

You can use the following test commands:

# Test all components (server side and client side)
grunt test

# Test server side
grunt testserver

# Test clientside
grunt testclient

# Test a single component 
grunt testclient --component="multiple-choice"
grunt testserver --component="multiple-choice"

## Options
--componentPath=path_to_comps (default: ../components) - the path to the components folder
--keepWrapped=true|false (default: false) - keep the generated js files

Regression

# Run regression tests 
grunt regression

## Options
--baseUrl="url-to-container-app" # default: http://localhost:9000
--grep="some string" # only run specs whose description matches this grep 
--bail=true|false # end tests on first failure default: true
--browserName=firefox # passed to webdriverio
--webDriverLogLevel="silent|verbose|command|result|data" # log level for the webdriver runner
--timeout # sets defaultTimeout and waitForTimeout see: http://webdriver.io/guide/getstarted/configuration.html

## Saucelabs Options
--sauceLabs # run via saucelabs (you'll need to specify a user/key) 
--sauceJob="name of job" # label for run on sauce labs
--sauceUser="user" # or set the env var SAUCE_USERNAME
--sauceKey="key" # or set the env var SAUCE_ACCESS_KEY
--sauceRecordVideo # record video
--sauceRecordScreenshots # record screenshots
--platform=windows # passed to webdriverio
--version="10.2" # passed to webdriverio

## Examples

# run via sauce
grunt regression --sauceLabs --baseUrl="http://container-app.com"

Validating an Item

You can validate a item's JSON by using the validate grunt task with the --file option. For example, if you wanted to validate an item in the path ~/Downloads/item.json, then you would run the following:

grunt validate --file=~/Downloads/item.json

This will return warnings if there are components within the item for which a schema has not been defined, and the grunt task will fail for any components which do not validate against their schema.json file.