CommitStream.Web.Tests

Summary

This repository contains a set of tests and tools related to CommitStream.Web.

Requirements

node.js 4.x.x

Running the npm run tests

Most of the tests to run are executed via npm run <test-suite-name>. To see the list of available tests, just type npm run by itself.

Example: API Tests

To run the API tests, type npm run ca. Note this will execute against https://v1-cs-test.azurewebsites.net.

Configuring the CommitStream instance URL

If you want to run the API tests against your local instance of CommitStream that is running on the default location of http://localhost:6565 instead of the Azure instance, type this:

export CS_ROOT_URL=http://localhost:6565

If for some reason you don't want to export the variable, you can also set it for a one-time execution like this:

CS_ROOT_URL=http://localhost:6565 npm run ca

Expected results

After running the API tests, you should see results like this:

You can copy the selected digest TeamRoom view URL and open it in your browser to see what the digest's commits panel looks like if you'd like to inspect the UI:

Data generation and additional tests setup

Run these commands in order and then you are ready to run the tests:

npm install -g grunt-cli

npm install

grunt babel

The last command will convert the ES6 scripts inside of the \src folder into runnable ES5 scripts using the \lib folder as the output. After making changes in any of the scripts inside of \src you will need to run

grunt babel

to transpile into ES6 once more.

An alternative is to run

grunt watch 

while working on the scripts so the files are transpiled as soon as you save changes.

Tests currently available

• create-demo-data.js: Provides the ability to create data in CommitStream
• create-new-instance-with-digest.js: Self descriptive.
• happy-path-end-to-end.tests.js: Self descriptive.
• instance-support.tests.js:
• smoke.tests.js

---

Usag

create-demo-data.js:

node create-demo-data.js --help

This script allows to quickly create commits in CommitStream with some variations. It has 2 main commands fake and sample. Each command run with default options values that can be overwritten. In order to see those options run:

node create-demo-data.js fake --help

or

node create-demo-data.js sample --help

Fake allows you to rapidly create as many commits as needed but not necessarily related to assets present in VersionOne. It will also create instances, digests and inboxes. The mentions that will be made can be configured in the file:

/config/fakeWorkItemsToMention.json

Sample on the other hand is not that flexible when it comes to deciding how many commits to create but it does allow to create them mentioning existing assets in a given VersionOne instance.

The assets to mention can be set in the file:

/config/sampleWorkItemsToMention.json

Since this script will only create commits you need to specify at least an already existing inbox in the next file:

/config/inboxes.json