javascript - 在 AngularJS 单元/集成测试中向 HTTP 服务器发出真实请求

Question

在 Angular 1.x 单元/集成测试中发出未使用 $httpBackend.when 模拟的请求会导致错误:

Error: Unexpected request: GET /real-request

是否可以使用 ngMock 和 Karma+Jasmine 测试平台发出真正的 HTTP 请求？这样做的好做法是什么？

Answer 1

AngularJS 是固执己见的框架，它对单元测试中的 HTTP 请求的看法是所有这些请求都应该被模拟。

不建议在单元测试中进行真正的 HTTP 请求，原因有二。单元测试应该是独立的并且是快速的。发出真正的请求会使测试异步，这会显着降低测试运行速度。发出真正的请求会打破隔离，测试是否通过取决于测试单元和后端。

在设计 AngularJS ngMock 模块时就考虑到了这一点(它由 angular-mocks.js 在单元测试中自动加载)。开发商几乎不会做asynchronous Jasmine 使用 Angular 进行单元测试，因为没有必要这样做。

集成测试不同。它们可能不像 E2E 测试(通常由 Protractor 运行)那么广泛，并且测试多个单元如何协同工作，这可能包括后端(HTTP 服务器)。所以最后还是用了 Karma 和 Jasmine，但是测试速度可能会比较慢，而且是异步的，并且做真正的 HTTP 请求。

这是 ngMockE2E 模块(通常用于 E2E 测试)的作用所在。它与 ngMock 一起包含在 angular-mocks.js 中，但不会被加载默认。

The ngMockE2E is an AngularJS module which contains mocks suitable for end-to-end testing. Currently there is only one mock present in this module - the e2e $httpBackend mock.

ngMockE2E 包含可用于此目的的不同 $httpBackend 实现。它的 API 各不相同。它不应该使用 flush 和 extend 方法。 $rootScope.$digest() 如果有 $q 应执行的 promise 链，则可以使用。

ngMockE2E 无法开箱即用，因为 ngMock 在辅助函数 module< 时对 Angular 服务进行了调整 和 inject 被使用。可以改用用于集成测试的辅助模块:

angular.module('ngMockI9n', []).config(function ($provide) {
  // hack to restore original implementations which were overridden by ngMock
  angular.injector(['ng', function ($httpBackendProvider, $browserProvider) {
    $provide.provider('$httpBackend', $httpBackendProvider);
    $provide.provider('$browserI9n', $browserProvider);
  }]);

  // make ngMockE2E $httpBackend use original $browser
  var httpBackendI9nDecorator = angular.mock.e2e.$httpBackendDecorator
  .map(function (dep) {
    return (dep === '$browser') ? '$browserI9n' : dep;
  });
  $provide.decorator('$httpBackend', httpBackendI9nDecorator);
});

此外，whitelisted real HTTP requests 的食谱可用于简化测试，但最佳做法是显式枚举真实和模拟请求。

beforeEach(module('app'));  
beforeEach(module('ngMockI9n'));

beforeEach(inject(function ($httpBackend) {
  $httpBackend.when('GET', '/mocked-request').respond(200, {});

  // all other requests will be automatically whitelisted and treated as real
  // so make sure that mocked requests are mocked above this point
  angular.forEach(['GET', 'DELETE', 'JSONP', 'HEAD', 'PUT', 'POST', 'PATCH'],
  function (method) {
    $httpBackend.when(method).passThrough();
  });
}));


it('does real async request', function (done) {
  // async tests need extra `done` param
  inject(function () {
    $http.get('real-request').then(function (response) {
      expect(response.data).toEqual(...);
    })
    .then(done, done.fail);

    $rootScope.$digest();
  });
});

it('does mocked sync request', function (done) {
  // tests with mocked requests are async, too
  inject(function () {
    $http.get('mocked-request').then(function (response) {
      expect(response.data).toEqual(...);
    })
    .then(done, done.fail);

    $rootScope.$digest();
  });
});

TL;DR:在真实请求的集成测试中使用 ngMockE2E 中的 $httpBackend，这需要一些额外的工作才能使其与 ngMock 兼容。切勿在单元测试中执行真正的请求，这会导致测试缓慢且无用。