angular-mocks

What is angular-mocks?

The angular-mocks package provides mocking and testing utilities for AngularJS applications. It includes modules, services, and methods to facilitate unit testing and end-to-end testing of AngularJS code.

What are angular-mocks's main functionalities?

Mocking HTTP Requests

This feature allows you to mock HTTP requests in your AngularJS application. The code sample demonstrates how to use $httpBackend to intercept a GET request to '/api/data' and respond with a status code of 200 and a JSON object.

angular.module('myApp', ['ngMockE2E'])
  .run(function($httpBackend) {
    $httpBackend.whenGET('/api/data').respond(200, { key: 'value' });
  });

Injecting and Mocking Services

This feature allows you to inject and mock services in your unit tests. The code sample shows how to inject MyService and $httpBackend, set up an expectation for an HTTP GET request, and verify the response.

describe('MyService', function() {
  var MyService, $httpBackend;

  beforeEach(module('myApp'));
  beforeEach(inject(function(_MyService_, _$httpBackend_) {
    MyService = _MyService_;
    $httpBackend = _$httpBackend_;
  }));

  it('should fetch data', function() {
    $httpBackend.expectGET('/api/data').respond(200, { key: 'value' });
    MyService.getData().then(function(response) {
      expect(response.data.key).toBe('value');
    });
    $httpBackend.flush();
  });
});

Spying on Methods

This feature allows you to spy on methods to check if they have been called and with what arguments. The code sample demonstrates how to spy on the getData method of MyService and verify that it has been called when MyController is instantiated.

describe('MyController', function() {
  var $controller, $rootScope, MyService;

  beforeEach(module('myApp'));
  beforeEach(inject(function(_$controller_, _$rootScope_, _MyService_) {
    $controller = _$controller_;
    $rootScope = _$rootScope_;
    MyService = _MyService_;
  }));

  it('should call MyService.getData', function() {
    spyOn(MyService, 'getData').and.callThrough();
    var $scope = $rootScope.$new();
    $controller('MyController', { $scope: $scope });
    expect(MyService.getData).toHaveBeenCalled();
  });
});

Other packages similar to angular-mocks

jasmine

Jasmine is a behavior-driven development framework for testing JavaScript code. It provides functions to help with structuring tests and making assertions. Unlike angular-mocks, Jasmine is not specific to AngularJS but can be used with any JavaScript code.

karma

Karma is a test runner that allows you to execute JavaScript code in multiple real browsers. It is often used in conjunction with Jasmine and angular-mocks for running AngularJS tests. Karma provides a more comprehensive testing environment compared to angular-mocks alone.

protractor

Protractor is an end-to-end test framework for Angular and AngularJS applications. It is built on top of WebDriverJS and is designed to test Angular applications in a real browser. Protractor offers more advanced end-to-end testing capabilities compared to angular-mocks.

README

packaged angular-mocks

This repo is for distribution on npm and bower. The source for this module is in the main AngularJS repo. Please file issues and pull requests against that repo.

Install

You can install this package either with npm or with bower.

npm

npm install angular-mocks

You can require ngMock modules:

var angular = require('angular');
angular.module('myMod', [
  require('angular-animate'),
  require('angular-mocks/ngMock'),
  require('angular-mocks/ngAnimateMock')
]);

bower

bower install angular-mocks

The mocks are then available at bower_components/angular-mocks/angular-mocks.js.

Documentation

Documentation is available on the AngularJS docs site.

License

The MIT License

Copyright (c) 2010-2015 Google, Inc. http://angularjs.org

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Changelog

1.7.0-rc.0 maximum-overdrive (2018-04-19)

Bug Fixes

• input:
  • listen on "change" instead of "click" for radio/checkbox ngModels (656c8f, #4516, #14667, #14685)
• input[number]: validate min/max against viewValue (aa3f95, #12761, #16325)
• jqLite: make removeData() not remove event handlers (b7d396, #15869, #16512)
• $compile:
  • remove the preAssignBindingsEnabled flag (38f8c9, #15782)
  • add base[href] to the list of RESOURCE_URL context attributes (1cf728, #15597)
• $interval: throw when trying to cancel non-$interval promise (a8bef9, #16424, #16476)
• $timeout: throw when trying to cancel non-$timeout promise (336525, #16424, #16476)
• $cookies: remove the deprecated $cookieStore factory (73c646, #16465)
• $resource: fix interceptors and success/error callbacks (ea0585, #6731, #9334, #6865, #16446)
• $templateRequest:
  • give tpload error the correct namespace (c617d6)
  • always return the template that is stored in the cache (fb0099, #16225)
• $animate: let cancel() reject the runner promise (16b82c, #14204, #16373)
• ngTouch:
  • deprecate the module and its contents (67f54b, #16427, #16431)
  • remove ngClick override, $touchProvider, and $touch (11d9ad, #15761, #15755)
• ngScenario: completely remove the angular scenario runner (0cd392, #9405)
• form: set $submitted to true on child forms when parent is submitted (223de5, #10071)
• $rootScope:
  • provide correct value of one-time bindings in watchGroup (c2b8fa)
• ngAria: do not set aria attributes on input[type="hidden"] (6d5ef3, #15113, #16367)
• ngModel, input: improve handling of built-in named parsers (74b04c, #14292, #10076, #16347)
• $httpParamSerializerJQLike:
  • call functions as jQuery does (a784fa, #16138, #16139)
  • follow jQuery for null and undefined (301fdd)
• $parse:
  • do not pass scope/locals to interceptors of one-time bindings (87a586)
  • always pass the intercepted value to watchers (2ee503, #16021)
  • respect the interceptor.$stateful flag (de7403)
• Angular: remove angular.lowercase and angular.uppercase (1daa4f, #15445)
• $controller: remove instantiating controllers defined on window (e269c1, #15349, #15762)

New Features

• angular.isArray: support Array subclasses in angular.isArray() (e3ece2, #15533, #15541)
• $sce: handle URL sanitization through the $sce service (1e9ead)
• orderBy: consider null and undefined greater than other values (1d8046, #15294, #16376)
• $resource: add support for request and requestError interceptors (#15674) (240a3d, #5146)
• ngModelOptions: add debounce catch-all + allow debouncing 'default' only (55ba44, #15411, #16335)
• $compile: lower the xlink:href security context for SVG's a and image elements (6ccbfa, #15736)

Performance Improvements

• $rootScope: allow $watchCollection use of expression input watching (97b00c)
• ngStyle: use $watchCollection (15bbd3, #15947)
• $compile: do not use deepWatch in literal one-way bindings (fd4f01, #15301)

Breaking Changes

jqLite due to:

• b7d396: make removeData() not remove event handlers

Before this commit removeData() invoked on an element removed its event handlers as well. If you want to trigger a full cleanup of an element, change:

elem.removeData();

to:

angular.element.cleanData(elem);

In most cases, though, cleaning up after an element is supposed to be done only when it's removed from the DOM as well; in such cases the following:

elem.remove();

will remove event handlers as well.

$cookies due to:

• 73c646: remove the deprecated $cookieStore factory

The $cookieStore has been removed. Migrate to the $cookies service. Note that for object values you need to use the putObject & getObject methods as get/put will not correctly save/retrieve them.

Before:

$cookieStore.put('name', {key: 'value'});
$cookieStore.get('name'); // {key: 'value'}
$cookieStore.remove('name');

After:

$cookies.putObject('name', {key: 'value'});
$cookies.getObject('name'); // {key: 'value'}
$cookies.remove('name');

$resource due to:

• ea0585: fix interceptors and success/error callbacks

If you are not using success or error callbacks with $resource, your app should not be affected by this change.

If you are using success or error callbacks (with or without response interceptors), one (subtle) difference is that throwing an error inside the callbacks will not propagate to the returned $promise. Therefore, you should try to use the promises whenever possible. E.g.:

// Avoid
User.query(function onSuccess(users) { throw new Error(); }).
  $promise.
  catch(function onError() { /* Will not be called. */ });

// Prefer
User.query().
  $promise.
  then(function onSuccess(users) { throw new Error(); }).
  catch(function onError() { /* Will be called. */ });

Finally, if you are using success or error callbacks with response interceptors, the callbacks will now always run after the interceptors (and wait for them to resolve in case they return a promise). Previously, the error callback was called before the responseError interceptor and the success callback was synchronously called after the response interceptor. E.g.:

var User = $resource('/api/users/:id', {id: '@id'}, {
  get: {
    method: 'get',
    interceptor: {
      response: function(response) {
        console.log('responseInterceptor-1');
        return $timeout(1000).then(function() {
          console.log('responseInterceptor-2');
          return response.resource;
        });
      },
      responseError: function(response) {
        console.log('responseErrorInterceptor-1');
        return $timeout(1000).then(function() {
          console.log('responseErrorInterceptor-2');
          return $q.reject('Ooops!');
        });
      }
    }
  }
});
var onSuccess = function(value) { console.log('successCallback', value); };
var onError = function(error) { console.log('errorCallback', error); };

// Assuming the following call is successful...
User.get({id: 1}, onSuccess, onError);
  // Old behavior:
  //   responseInterceptor-1
  //   successCallback, {/* Promise object */}
  //   responseInterceptor-2
  // New behavior:
  //   responseInterceptor-1
  //   responseInterceptor-2
  //   successCallback, {/* User object */}

// Assuming the following call returns an error...
User.get({id: 2}, onSuccess, onError);
  // Old behavior:
  //   errorCallback, {/* Response object */}
  //   responseErrorInterceptor-1
  //   responseErrorInterceptor-2
  // New behavior:
  //   responseErrorInterceptor-1
  //   responseErrorInterceptor-2
  //   errorCallback, Ooops!

• 240a3d: add support for request and requestError interceptors (#15674)

Previously, calling a $resource method would synchronously call $http. Now, it will be called asynchronously (regardless if a request/requestError interceptor has been defined.

This is not expected to affect applications at runtime, since the overall operation is asynchronous already, but may affect assertions in tests. For example, if you want to assert that $http has been called with specific arguments as a result of a $resource call, you now need to run a $digest first, to ensure the (possibly empty) request interceptor promise has been resolved.

Before:

it('...', function() {
  $httpBackend.expectGET('/api/things').respond(...);
  var Things = $resource('/api/things');
  Things.query();

  expect($http).toHaveBeenCalledWith(...);
});

After:

it('...', function() {
  $httpBackend.expectGET('/api/things').respond(...);
  var Things = $resource('/api/things');
  Things.query();
  $rootScope.$digest();

  expect($http).toHaveBeenCalledWith(...);
});

$templateRequest:

• due to c617d6: give tpload error the correct namespace

Previously the tpload error was namespaced to $compile. If you have code that matches errors of the form [$compile:tpload] it will no longer run. You should change the code to match [$templateRequest:tpload].

• due to (fb0099: always return the template that is stored in the cache

The service now returns the result of $templateCache.put() when making a server request to the template. Previously it would return the content of the response directly. This now means if you are decorating $templateCache.put() to manipulate the template, you will now get this manipulated result also on the first $templateRequest rather than only on subsequent calls (when the template is retrived from the cache). In practice this should not affect any apps, as it is unlikely that they rely on the template being different in the first and subsequent calls.

$animate due to:

• 16b82c: let cancel() reject the runner promise

$animate.cancel(runner) now rejects the underlying promise and calls the catch() handler on the runner returned by $animate functions (enter, leave, move, addClass, removeClass, setClass, animate). Previously it would resolve the promise as if the animation had ended successfully.

Example:

var runner = $animate.addClass('red');
runner.then(function() { console.log('success')});
runner.catch(function() { console.log('cancelled')});

runner.cancel();

Pre-1.7.0, this logs 'success', 1.7.0 and later it logs 'cancelled'. To migrate, add a catch() handler to your animation runners.