This node.js module makes the wonderful Pivotal Lab's jasmine spec framework (version 1) available in node.js.
This project is now in maintenance mode. It is recommended to use the
package whenever possible.
1.3.1 of Jasmine is currently included with node-jasmine. This is a forked version from the
Karma project, which allows you to use the
iit functions to run individual suites or specs.
2.0.0 Support in the
Jasmine2.0 branch (with rewrite in CoffeeScript) is now abandoned and no longer supported.
Supported Node.js versions
- 8 (EOL in December 2019)
- 6 (already past EOL)
- 4 (already past EOL)
Older versions of Node.js are no longer supported. It is highly recommended to upgrade to a supported version of Node.js.
- Growl notifications with the
--growlflag (requires Growl to be installed)
- Ability to test specs written in Literate CoffeeScript
- Teamcity Reporter reinstated.
- Ability to specify multiple files to test via list in command line
- Ability to suppress stack trace with
- Async tests now run in the expected context instead of the global one
--configflag that allows you to assign variables to process.env
- Terminal Reporters are now available in the Jasmine Object #184
- Done is now available in all timeout specs #199
afterEachis available in requirejs #179
- Editors that replace instead of changing files should work with autotest #198
- Jasmine Mock Clock now works!
- Autotest now works!
- Using the latest Jasmine!
- Verbose mode tabs
describeblocks much more accurately!
--coffeenow allows specs written in Literate CoffeeScript (
To install the latest official version, use NPM:
npm install jasmine-node -g
To install the latest bleeding edge version, clone this repository and check
Write the specifications for your code in
*.coffee files in the
You can use sub-directories to better organise your specs. In the specs use
it() etc. exactly
as you would in client-side jasmine specs.
Note: your specification files must be named as
which matches the regular expression
otherwise jasmine-node won't find them!
sampleSpecs.js is wrong,
sampleSpec.js is right.
If you have installed the npm package, you can run it with:
If you aren't using npm, you should add
pwd/lib to the
environment variable, then run:
You can supply the following arguments:
--autotest, provides automatic execution of specs after each change
--watch, when used with
--autotest, paths after
--watchwill be watched for changes, allowing to watch for changes outside of specs directory
--coffee, allow execution of
--color, indicates spec output should uses color to indicates passing (green) or failing (red) specs
--noColor, do not use color in the output
-m, --match REGEXP, match only specs containing "REGEXPspec"
--matchall, relax requirement of "spec" in spec file names
--verbose, verbose output as the specs are run
--junitreport, export tests results as junitreport xml format
--output FOLDER, defines the output folder for junitreport files
--teamcity, converts all console output to teamcity custom test runner commands. (Normally auto detected.)
--growl, display test run summary in a growl notification (in addition to other outputs)
--runWithRequireJs, loads all specs using requirejs instead of node's native require method
--requireJsSetup, file run before specs to include and configure RequireJS
--test-dir, the absolute root directory path where tests are located
--nohelpers, does not load helpers
--forceexit, force exit once tests complete
--captureExceptions, listen to global exceptions, report them and exit (interferes with Domains in NodeJs, so do not use if using Domains as well
--config NAME VALUE, set a global variable in
--noStack, suppress the stack trace generated from a test failure
Individual files to test can be added as bare arguments to the end of the args.
jasmine-node --coffee spec/AsyncSpec.coffee spec/CoffeeSpec.coffee spec/SampleSpec.js
jasmine-node includes an alternate syntax for writing asynchronous tests. Accepting
a done callback in the specification will trigger jasmine-node to run the test
asynchronously waiting until the
done() callback is called.
var request = ;;
An asynchronous test will fail after
5000 ms if
done() is not called. This timeout
can be changed by setting
jasmine.getEnv().defaultTimeoutInterval or by passing a timeout
interval in the specification.
var request = ;; // timeout after 250 ms
var request = ;jasminedefaultTimeoutInterval = 500;;
spec/SampleSpecs.js to see how to use it.
There is a sample project in
/spec-requirejs. It is comprised of:
requirejs-setup.js, this pulls in our wrapper template (next)
requirejs-wrapper-template, this builds up requirejs settings
requirejs.sut.js, this is a __SU__bject To __T__est, something required by requirejs
requirejs.spec.js, the actual jasmine spec for testing
To run it:
node lib/jasmine-node/cli.js --runWithRequireJs --requireJsSetup ./spec-requirejs/requirejs-setup.js ./spec-requirejs/
Often you'll want to capture an uncaught exception and log it to the console,
this is accomplished by using the
--captureExceptions flag. Exceptions will
be reported to the console, but jasmine-node will attempt to recover and
continue. It was decided to not change the current functionality until
until then, jasmine-node will still return
0 and continue on without this flag.
You require a module, but it doesn't exist, ie
require('Q') instead of
require('q'). Jasmine-Node reports the error to the console, but carries on
0. This messes up Travis-CI because you need it to return a
non-zero status while doing CI tests.
> jasmine-node --coffee spec> echo $status0
Run jasmine node with the
> jasmine-node --coffee --captureExceptions spec> echo $status1
Jasmine node can display Growl notifications of test
run summaries in addition to other reports.
Growl must be installed separately, see node-growl
for platform-specific instructions. Pass the
--growl flag to enable the notifications.
Install the dependent packages by running:
Run the specs before you send your pull request:
Note: Some tests are designed to fail in the specs.sh. After each of the individual runs completes, there is a line that lists what the expected Pass/Assert/Fail count should be. If you add/remove/edit tests, please be sure to update this with your PR.
jasmine-growl-reporter@~0.2.0(needed by Node.js pre-4.0)
dependencies(may be needed by some really old npm versions)
dependenciesto prevent major package updates
1.15.0Switch to coffeescript package
1.14.6Update dependencies to resolve
^for reporter version (thanks to Maxim-Filimonov)
1.14.4Rolled back jasmine reporter version (thanks to tjmcduffie)
1.14.3Added 'onComplete' callback to TeamCityReporter (thanks to JoergFiedler)
1.14.2Uhhh...not sure what happened here.
1.14.1Default to noColors if not in a TTY
1.14.0Add support for
ddescribe(thanks to mgcrea)
1.13.1Add coffee-script support for 1.7.x (thanks to nathancarter)
1.13.0Added timing to the verbose reporter (thanks to rick-kilgore)
1.12.1Fixed an issue where an undefined variable caused an unhelpful exception in --watch Resolves #278
1.11.0Added Growl notification option
--growl(thanks to AlphaHydrae)
1.10.2Restored stack filter which was accidentally removed (thanks to kevinsawicki)
afterEachnow properly handle the async-timeout function
1.10.0Skipped tests now show in the terminal reporter's output (thanks to kevinsawicki)
1.9.1Timeout now consistent between Async and Non-Async Calls (thanks to codemnky)
1.9.0Now re-throwing the file-not-found error, added info to README.md, printing version with
1.8.1Fixed silent failure due to invalid REGEX (thanks to pimterry)
1.8.0Fixed bug in autotest with multiple paths and added
--watchfeature (thanks to davegb3)
1.7.1Removed unneeded fs dependency (thanks to kevinsawicki) Fixed broken fs call in node
0.6(thanks to abe33)
1.7.0Literate CoffeeScript now testable (thanks to magicmoose)
1.6.0Teamcity Reporter Reinstated (thanks to bhcleek)
1.5.1Missing files and require exceptions will now report instead of failing silently
1.5.0Now takes multiple files for execution. (thanks to abe33)
1.4.0Optional flag to suppress stack trace on test failure (thanks to Lastalas)
1.3.1Fixed context for async tests (thanks to omryn)
--configflag for changeable testing environments
1.2.3Fixed #179, #184, #198, #199. Fixes autotest, afterEach in requirejs, terminal reporter is in jasmine object, done function missing in async tests
1.2.2Revert Exception Capturing to avoid Breaking Domain Tests
1.2.1Emergency fix for path reference missing
1.2.0Fixed #149, #152, #171, #181, #195.
--autotestnow works as expected, jasmine clock now responds to the fake ticking as requested, and removed the path.exists warning
1.1.1Fixed #173, #169 (Blocks were not indented in verbose properly, added more documentation to address #180
1.1.0Updated Jasmine to
1.3.1, fixed fs missing, catching uncaught exceptions, other fixes