Unit testing AngularJS factories that have dependencies

Roy Truelove picture Roy Truelove · May 15, 2013 · Viewed 59.7k times · Source

When unit testing an Angular factory (with Karma + Jasmine), how do I inject a stub dependency into the factory under test?

Here's my factory:

mod = angular.module('myFactoryMod', []);

mod.factory('myFactory', [
  '$log', 'oneOfMyOtherServices', function($log, svc) {
    return makeSomethingThatDoesSomethingWithTheseDependencies($log, svc);
  }
]);

oneOfMyOtherServices is needed when instantiating my factory.

Here's my test:

it('can get an instance of my factory', function() {
  var oneOfMyOtherServicesStub;

  angular.mock.module('myFactoryMod');

  oneOfMyOtherServicesStub = {
    someVariable: 1
  };

  //****How do I get my stub in my target? ****

  angular.mock.inject(['myFactory', function(target) {

      expect(target).toBeDefined();

    }
  ]);
})

N.B. I know that $controller allows this for controllers, but I don't see an equivalent for factories.

Answer

Noah Freitas picture Noah Freitas · May 15, 2013

There are two ways to accomplish something like this that I know of:

  1. Use $provide and an anonymous module to inject the mock.
  2. Inject the service you would like to mock and use jasmine's spying ability to provide mock values.

The second option only works if you know exactly which methods your code under test will be calling on the injected service and you can easily mock them out. As you seem to be accessing a data property on the service (rather than a method) pursuing the first option might be best.

Using $provide would roughly look like this:

describe('myFactory', function () {
  // Load your module.
  beforeEach(module('myFactoryMod'));

  // Setup the mock service in an anonymous module.
  beforeEach(module(function ($provide) {
    $provide.value('oneOfMyOtherServicesStub', {
        someVariable: 1
    });
  }));

  it('can get an instance of my factory', inject(function(myFactory) {
    expect(myFactory).toBeDefined();
  }));
});