Testing routers in backbone.js properly?

Question

So I've just started to write tests for my in-progress javascript app, using sinon.js & jasmine.js. Works pretty well overall, but I need to also be able to test my routers.

The routers, in their current state, will trigger an number of views and other stuff, terminating the current jasmine.js test by invoking Backbone.navigate dependent on application state and UI itneraction.

So how could I test that routing to different locations would work, while keeping the routers "sandboxed" and not allowing them to change route?

Can I set up some sort of mock function that will monitor pushState changes or similar?

Answer 1

Here's a low-levelish way of doing it with jasmine, testing that pushState works as expected and that your router sets up things properly... I assume a router that has been initialized and has a home route mapped to ''. You can adapt this for your other routes. I also assume you've done in your app initialization a Backbone.history.start({ pushState: true });

    describe('app.Router', function () {          var router = app.router, pushStateSpy;          it('has a "home" route', function () {             expect(router.routes['']).toEqual('home');         });          it('triggers the "home" route', function () {             var home = spyOn(router, 'home').andCallThrough();             pushStateSpy = spyOn(window.history, 'pushState').andCallFake(function (data, title, url) {                 expect(url).toEqual('/');                 router.home();             });             router.navigate('');             expect(pushStateSpy).toHaveBeenCalled();             expect(home).toHaveBeenCalled();             ...         });     });   

You can effectively achieve similar things by doing Backbone.history.stop(); it's meant for this reason.

UPDATE: Browsers with no pushState:

This of course will work fine if your browser you test on has support for pushState. If you test against browsers that don't, you can conditionally test as follows:

it('triggers the "home" route', function () {     var home = spyOn(router, 'home').andCallThrough();      if (Backbone.history._hasPushState) {         pushStateSpy = spyOn(window.history, 'pushState').andCallFake(function (data, title, url) {             expect(url).toEqual('/');             router.home();         });         router.navigate('', {trigger: true});         expect(pushStateSpy).toHaveBeenCalled();         expect(home).toHaveBeenCalled();      } else if (Backbone.history._wantsHashChange) {         var updateHashSpy = spyOn(Backbone.history, '_updateHash').andCallFake(function (loc, frag) {             expect(frag).toEqual('');             router.home();         });         router.navigate('', {trigger: true});         expect(updateHashSpy).toHaveBeenCalled();         expect(home).toHaveBeenCalled();     } }); 

If you are on IE6, good luck.