Home

Testacular Documentation

This is the documentation for the spectacular testacular project.

Content

User Guides

• More about Browsers
• Using CoffeeScript
• Configuration File
• Code Coverage
• Installation
• Jenkins CI Integration
• Travis CI Integration

Developer Guides

• Client - Server protocol
• How to contribute
• Events
• ToDos

API

• Public APIs
• Private APIs

What is it good for?

Mostly for testing code in multiple browsers (desktop, mobile, tablets):

• executing tests locally during development
• executing tests on a continuous integration server

Let’s do it!

Go into your project and create a testacular configuration. Basically you need to specify the source files that you want to execute.

For an example configuration, see test/client/testacular.conf.js which contains most of the options.

# create config file (testacular.conf.js by default)
$ testacular init

# start server
$ testacular start

# open browsers you want to test (if testacular is not configured to do it for you)
$ open http://localhost:8080

# if you want to run tests manually (without auto watching file changes), you can:
$ testacular run

Testing frameworks support

Testacular is not a testing framework, neither an assertion library, so for that you can use pretty much anything you like.

However, we provide an adapter for Jasmine and Mocha. If you wanna write an adapter for your favourite testing framework, that’s great - check out adapter/jasmine.src.js and write your own.

Browsers Supported

Please see Supported Browsers for details on supported Browsers and how to configure non-default paths.

Why am I doing this?

Throughout the development of AngularJS, we’ve been using JSTD for testing. I really think that JSTD is a great idea. Unfortunately, we had many problems with JSTD, so we decided to write our own test runner based on the same idea. We wanted a simple tool just for executing JavaScript tests that is both stable and fast. That’s why we use the awesome SocketIO library and Node.js.

Contact

There is a mailing list and an issuetracker. Also you can follow @TestacularJS as well.

Versions

Testacular uses Semantic Versioning. All even versions (eg. 0.2.x, 0.4.x) are considered to be stable - no breaking changes, only bug fixes.

Stable channel (branch stable)

$ npm install -g testacular

Canary channel (branch master)

$ npm install -g testacular@canary