sui-test

> Zero config testing tool

Motivation

(1) Setup properly a testing environment in JavaScript is hard. There is a lot deps and it would be easy to install different setups in different projects. To avoid that, you could run this test suit over your code to install only one tool.

Folder Structure

Your tests must be in a test folder in your project root. Each test file should follow the patter: *Spec.js.

``
.
├── package.json <- Project package.json
└── src
│ ├── detail.js
│ └── user.js
└── test
├── detail
│ └── detailSpec.js
└── user
└── userSpec.js
`

Installation

`sh
npm install @s-ui/test --save-dev
`

Config Options

Client (Karma) options

- alias You can define the custom aliases you need to resolve in your client-side tests executions, see the following example:

`json
{
"config": {
"sui-test": {
"client": {
"alias": {
"my-package": "path/to/my-package"
}
}
}
}
}
`

CLI Options

`sh
Usage: sui-test [options] [command]


Options:

--version output the version number
-h, --help output usage information


Commands:

browser|b Run tests in the browser
server|s Run tests in node
help [cmd] display help for [cmd]
`

Browser options

`sh
Usage: sui-test browser [options]


Options:

-H, --headless Run in headless mode
-W, --watch Run in watch mode
-C, --ci Run a Firefox headless for CI testing (deprecated, use --headless instead)
-P, --pattern Path pattern to include (default: test/*/Spec.js)
-I, --ignore-pattern Path pattern to ignore for testing (default: false)
--src-pattern Define the source directory (default: src/*/.js)
-h, --help output usage information
Description:

Run tests in a browser

Examples:

$ sui-test browser
`

Server options

`sh
Usage: sui-test server [options]


Options:

-I, --inspect Inspect node process
-W, --watch Run in watch mode
-T, --timeout Customize test timeout
-P, --pattern Path pattern to include (default: test)
-h, --help output usage information
Description:

Run tests in node

Examples:

$ sui-test server -W
`

Tools

Describers

describeOnLocal: It will only run wrapped tests on local environment and won't be executed in CI.

`javascript
import {describeOnLocal} from '@s-ui/test/lib/describers'

describeOnLocal(() => {
describe('Some test', () => {
it('should do something', () => {
expect(true).toBe(true)
})
})
})
`

Descriptor by environment patcher

The descriptor by environment is a patch with the purpose of add some extra functionality to our mocha describe and it methods.

$3

First of all, the patcher MUST BE APPLIED on each test that we want to have the extra methods so at the top of ourExampleSpec.js we will add the next code:

`javascript
import {descriptorsByEnvironmentPatcher} from '@s-ui/test/lib/descriptor-environment-patcher'
descriptorsByEnvironmentPatcher()
`

And that's it, from that line you will have the next methods added to the base of the mocha lib:

- describe.client
- describe.server
- describe.client.only
- describe.server.only
- it.client
- it.server
- it.client.only
- it.server.only

$3

Just in the same way as you have been using the describe or it functions earlier:

`javascript
describe.client('Users use case', () => {
it('should....', () => {
// ...
})
})

describe.server('Users use case', () => {
it('should....', () => {
// ...
})
})
`

You can also have it() by environment:

`javascript
describe('Another use case', () => {
it.client('should....', () => {
// ...
})

it.server('should....', () => {
// ...
})
})
`

What about if you want to run only one describe but only for client? You can use the .only function in the same way as you've been using earlier.

`javascript
describe.client.only('Another use case', () => {
it('should....', () => {
// ...
})
})
``

Contributing

Please refer to the main repo contributing info.