Unit testing AngularJS factories that have dependencies

Question

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.

Noah Freitas · Accepted Answer · 2013-05-15 14:53:58Z

94

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

Use $provide and an anonymous module to inject the mock.
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();
  }));
});

edited May 15, 2013 at 14:53

answered May 15, 2013 at 14:30

Noah Freitas

17.5k11 gold badges53 silver badges67 bronze badges

Sign up to request clarification or add additional context in comments.

9 Comments

Roy Truelove Over a year ago

Yeah I think choice 1 is the way to go. Thanks!

Bennett McElwee Over a year ago

I'd like to inject the myFactory into all tests. Can it be done in a beforeEach? I tried but it didn't work...

klode Over a year ago

Thanks for this answer +1. It would be nice to add a code example also for option #2, for completeness.

bentsai Over a year ago

@BennettMcElwee Yes, you can. Like this: var theFactory; beforeEach(inject(function(myFactory) { theFactory = myFactory; } ))); Then use theFactory in your test.

AMRESH PANDEY Over a year ago

How can I test this factory method getItemList using Jasmine and karma. I am getting error: [$injector:unpr] errors.angularjs (function() { angular.module('riskCanvasApp').factory('itemsService', itemsService); itemsService.$inject = [ '$http', '$q','$compile', 'UrlService', 'accountDetailsMainService', 'sharedService', 'authenticationSvc' ]; function itemsService($http, $q, $compile, urlService, accountDetailsMainService, sharedService, authenticationSvc) {

|

AJ. · Accepted Answer · 2014-11-26 07:53:45Z

12

The comment by @bentsai is actually very helpful for testing services; for completeness I am adding an example.

Here is a test for jasmine which does approximately what you're looking for. Note: this requires you to have angular-mocks included (this is what provides functions like module and inject).

describe('app: myApp', function() {
  beforeEach(module('myApp'));
  var $controller;
  beforeEach(inject(function(_$controller_) {
    $controller = _$controller_;
  }));
  // Factory of interest is called MyFactory
  describe('factory: MyFactory', function() {
    var factory = null;
    beforeEach(inject(function(MyFactory) {
      factory = MyFactory;
    }))
    it('Should define methods', function() {
      expect(factory.beAwesome).toBeDefined()
      expect(factory.beAwesome).toEqual(jasmine.any(Function))
    });
  });
});

This is a stub for what the module and associated factory definition could look like:

var app = angular.module('myApp', []);
app.factory('MyFactory', function() {
  var factory = {};
  factory.beAwesome = function() {
    return 'Awesome!';
  }
  return factory;
});

In this case, it is clear the use of inject() allows you to pull in dependencies, just as you would expect in your normal angular application - and as such you can build up requirements to support testing things which rely on them.

answered Nov 26, 2014 at 7:53

AJ.

3,1122 gold badges26 silver badges32 bronze badges

2 Comments

skolsuper Over a year ago

You have missed the part where you inject a stub dependency to MyFactory in testing.

Choco Over a year ago

where's the second dependency?

Collectives™ on Stack Overflow

Unit testing AngularJS factories that have dependencies

2 Answers 2

9 Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

9 Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related