Skip to content

ThePumpingLemma/meteor-jasmine

 
 

Repository files navigation

jasmine

Easily run Jasmine browser and server tests. Supports client tests that run in the browser with the app context and unit tests that run in a mocked server environment. You can use all Jasmine 2.0 features and the same syntax for your tests.

Installation

meteor add sanjo:jasmine
meteor add velocity:html-reporter@0.3.0-rc.3

Examples and Tutorials

Testing modes

Each testing mode has different characteristics. Each testing mode has an own folder.

Server

Server Unit Test Mode
  • You can unit test server app code in this mode.
  • The tests run isolated from your app.
  • The Meteor API and all packages are stubbed in this mode.
  • Place your server unit tests in the folder tests/jasmine/server/unit/ or a subfolder of it.
Server Integration Test Mode

Not available yet. Will be added in the near future.

Client

Client Unit Test Mode

Still in development. Currently only available in the 0.6.0-rc.1

  • You can test client code.
  • The tests are executed directly inside the browser.
  • Nothing is automatically stubbed.
  • Place your client unit tests in the folder tests/jasmine/client/unit/ or a subfolder of it.
Client Integration Test Mode
  • You can test client code in this mode.
  • The tests are executed directly inside the browser in a copy of your app.
  • Nothing is automatically stubbed.
  • Place your client integration tests in the folder tests/jasmine/client/integration/ or a subfolder of it.

Stubs

Files in tests/jasmine folder (or a subfolder of it) that end with -stubs.js or -stub.js are treated as stubs and are loaded before the app code.

Mocks

Mocking Meteor

This package ships with mocks for the Meteor API. You can mock the Meteor API in your tests with:

beforeEach(function () {
  MeteorStubs.install();
});

afterEach(function () {
  MeteorStubs.uninstall();
});

This is done automatically for server unit tests. You need to do it yourself for your client tests if you want to write unit tests that run in the browser.

Mocking objects

You can mock any object with the global helper function mock. This will avoid unwanted side effects that can affect other tests. Here is an example how to mock the Players collection of the Leaderboard example:

beforeEach(function () {
  mock(window, 'Players');
});

This will mock the Players collection for each test. The original Players collection is automatically restored after each test.

Creating more complex mocks

You can also create mocks manually. I would suggest to use the following pattern:

Create a mock service with a method install and uninstall (example for Meteor)

  • install: Saves the original object and mocks it
  • uninstall: Restores the original object

This pattern allows you to enable mocks only for specific tests and have a clean and independent mock for each test.

For sanjo:jasmine maintainers

Testing

We use spacejamio:munit with the BDD style for testing sanjo:jasmine.

Running package unit tests
cd test-app
meteor test-packages sanjo:jasmine

Publish a new version

  1. Increase the version in package.js (follow Semantic Versioning conventions)
  2. meteor publish
  3. Commit "Bump to version X.X.X"
  4. Create a tag with the version "X.X.X"
  5. Push

Copyright

The code is licensed under the MIT License (see LICENSE file).

The boot.js scripts are based on code that is part of Jasmine 2.0 (LICENSE).

About

Easily and securely use Jasmine within client side Meteor

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%