Директива модульного тестирования AngularJS с templateUrl

У меня есть директива AngularJS с templateUrlопределенным файлом. Я пытаюсь провести модульное тестирование с помощью Jasmine.

Мой жасмин JavaScript выглядит следующим образом , в соответствии с рекомендацией этого :

describe('module: my.module', function () {
    beforeEach(module('my.module'));

    describe('my-directive directive', function () {
        var scope, $compile;
        beforeEach(inject(function (_$rootScope_, _$compile_, $injector) {
            scope = _$rootScope_;
            $compile = _$compile_;
            $httpBackend = $injector.get('$httpBackend');
            $httpBackend.whenGET('path/to/template.html').passThrough();
        }));

        describe('test', function () {
            var element;
            beforeEach(function () {
                element = $compile(
                    '<my-directive></my-directive>')(scope);
                angular.element(document.body).append(element);
            });

            afterEach(function () {
                element.remove();
            });

            it('test', function () {
                expect(element.html()).toBe('asdf');
            });

        });
    });
});

Когда я запускаю это в своей ошибке спецификации Jasmine, я получаю следующую ошибку:

TypeError: Object #<Object> has no method 'passThrough'

Все, что я хочу, - это загружать templateUrl как есть - я не хочу использовать respond. Я считаю, что это может быть связано с использованием ngMock вместо ngMockE2E . Если это виноват, как мне использовать последнее вместо первого?

Заранее спасибо!

Вы правы, что это связано с ngMock. Модуль ngMock автоматически загружается для каждого теста Angular и инициализирует макет $httpBackendдля обработки любого использования $httpслужбы, включая выборку шаблона. Система шаблонов пытается загрузить шаблон, $httpи это становится «неожиданным запросом» к макету.

Вам нужен способ предварительной загрузки шаблонов в, $templateCacheчтобы они уже были доступны, когда Angular их запросит, без использования $http.

Предпочтительное решение: карма

Если вы используете Karma для запуска своих тестов (а вы должны это делать), вы можете настроить его для загрузки шаблонов за вас с помощью препроцессора ng-html2js . Ng-html2js считывает указанные файлы HTML и преобразует их в модуль Angular, который предварительно загружает$templateCache .

Шаг 1. Включите и настройте препроцессор в вашем karma.conf.js

// karma.conf.js

preprocessors: {
    "path/to/templates/**/*.html": ["ng-html2js"]
},

ngHtml2JsPreprocessor: {
    // If your build process changes the path to your templates,
    // use stripPrefix and prependPrefix to adjust it.
    stripPrefix: "source/path/to/templates/.*/",
    prependPrefix: "web/path/to/templates/",

    // the name of the Angular module to create
    moduleName: "my.templates"
},

Если вы используете Yeoman для построения своего приложения, эта конфигурация будет работать

plugins: [ 
  'karma-phantomjs-launcher', 
  'karma-jasmine', 
  'karma-ng-html2js-preprocessor' 
], 

preprocessors: { 
  'app/views/*.html': ['ng-html2js'] 
}, 

ngHtml2JsPreprocessor: { 
  stripPrefix: 'app/', 
  moduleName: 'my.templates' 
},

Шаг 2. Используйте модуль в своих тестах

// my-test.js

beforeEach(module("my.templates"));    // load new module containing templates

Чтобы получить полный пример, посмотрите этот канонический пример от гуру тестирования Angular Войты Джины. . Включает в себя всю настройку: конфиг кармы, шаблоны и тесты.

Решение без кармы

Если вы не используете Karma по какой-либо причине (у меня был негибкий процесс сборки в устаревшем приложении) и вы просто тестируете в браузере, я обнаружил, что вы можете обойти захват ngMock, $httpBackendиспользуя необработанный XHR для получения шаблона для реального и вставьте его в $templateCache. Это решение гораздо менее гибкое, но на данный момент оно выполняет свою работу.

// my-test.js

// Make template available to unit tests without Karma
//
// Disclaimer: Not using Karma may result in bad karma.
beforeEach(inject(function($templateCache) {
    var directiveTemplate = null;
    var req = new XMLHttpRequest();
    req.onload = function() {
        directiveTemplate = this.responseText;
    };
    // Note that the relative path may be different from your unit test HTML file.
    // Using `false` as the third parameter to open() makes the operation synchronous.
    // Gentle reminder that boolean parameters are not the best API choice.
    req.open("get", "../../partials/directiveTemplate.html", false);
    req.send();
    $templateCache.put("partials/directiveTemplate.html", directiveTemplate);
}));

Если серьезно. Используйте карму . Настройка требует небольшой работы, но позволяет запускать все тесты одновременно в нескольких браузерах из командной строки. Таким образом, вы можете использовать его как часть вашей системы непрерывной интеграции, и / или вы можете сделать его сочетанием клавиш в редакторе. Намного лучше, чем alt-tab-refresh-ad-infinitum.

В итоге я получил кеш шаблонов и поместил туда представление. У меня нет контроля над тем, чтобы не использовать ngMock, оказывается:

beforeEach(inject(function(_$rootScope_, _$compile_, $templateCache) {
    $scope = _$rootScope_;
    $compile = _$compile_;
    $templateCache.put('path/to/template.html', '<div>Here goes the template</div>');
}));

Эту начальную проблему можно решить, добавив следующее:

beforeEach(angular.mock.module('ngMockE2E'));

Это потому, что он пытается найти $ httpBackend в модуле ngMock по умолчанию, а он не заполнен.

Решение, которое я нашел, требует jasmine-jquery.js и прокси-сервера.

Я выполнил следующие шаги:

1. В karma.conf:

добавьте jasmine-jquery.js в свои файлы

files = [
    JASMINE,
    JASMINE_ADAPTER,
    ...,
    jasmine-jquery-1.3.1,
    ...
]

добавьте прокси-сервер, который будет обслуживать ваши светильники

proxies = {
    '/' : 'http://localhost:3502/'
};

2. В вашей спецификации

   описать ('MySpec', function () {var $ scope, template; jasmine.getFixtures (). fixturesPath = 'public / partials /'; // настраиваемый путь, чтобы вы могли обслуживать реальный шаблон, который используете в приложении beforeEach (function () {шаблон = angular.element ('');

       module('project');
       inject(function($injector, $controller, $rootScope, $compile, $templateCache) {
           $templateCache.put('partials/resources-list.html', jasmine.getFixtures().getFixtureHtml_('resources-list.html')); //loadFixture function doesn't return a string
           $scope = $rootScope.$new();
           $compile(template)($scope);
           $scope.$apply();
       })
   });

   });

3. Запустите сервер в корневом каталоге вашего приложения

   python -m SimpleHTTPServer 3502

4. Запустите карму.

Мне потребовалось время, чтобы понять это, мне пришлось искать много сообщений, я думаю, что документация по этому поводу должна быть более ясной, поскольку это такой важный вопрос.

Мое решение:

test/karma-utils.js:

function httpGetSync(filePath) {
  var xhr = new XMLHttpRequest();
  xhr.open("GET", "/base/app/" + filePath, false);
  xhr.send();
  return xhr.responseText;
}

function preloadTemplate(path) {
  return inject(function ($templateCache) {
    var response = httpGetSync(path);
    $templateCache.put(path, response);
  });
}

karma.config.js:

files: [
  //(...)
  'test/karma-utils.js',
  'test/mock/**/*.js',
  'test/spec/**/*.js'
],

тест:

'use strict';
describe('Directive: gowiliEvent', function () {
  // load the directive's module
  beforeEach(module('frontendSrcApp'));
  var element,
    scope;
  beforeEach(preloadTemplate('views/directives/event.html'));
  beforeEach(inject(function ($rootScope) {
    scope = $rootScope.$new();
  }));
  it('should exist', inject(function ($compile) {
    element = angular.element('<event></-event>');
    element = $compile(element)(scope);
    scope.$digest();
    expect(element.html()).toContain('div');
  }));
});

Если вы используете Grunt, вы можете использовать шаблоны grunt-angular. Он загружает ваши шаблоны в templateCache и прозрачен для вашей конфигурации спецификаций.

Мой образец конфигурации:

module.exports = function(grunt) {

  grunt.initConfig({

    pkg: grunt.file.readJSON('package.json'),

    ngtemplates: {
        myapp: {
          options: {
            base:       'public/partials',
            prepend:    'partials/',
            module:     'project'
          },
          src:          'public/partials/*.html',
          dest:         'spec/javascripts/angular/helpers/templates.js'
        }
    },

    watch: {
        templates: {
            files: ['public/partials/*.html'],
            tasks: ['ngtemplates']
        }
    }

  });

  grunt.loadNpmTasks('grunt-angular-templates');
  grunt.loadNpmTasks('grunt-contrib-watch');

};

Я решил ту же проблему несколько иначе, чем выбранное решение.

1. Сначала я установил и настроил плагин ng-html2js для кармы. В файле karma.conf.js:

   preprocessors: {
     'path/to/templates/**/*.html': 'ng-html2js'
   },
   ngHtml2JsPreprocessor: {
   // you might need to strip the main directory prefix in the URL request
     stripPrefix: 'path/'
   }

2. Затем я загрузил модуль, созданный в beforeEach. В вашем файле Spec.js:

   beforeEach(module('myApp', 'to/templates/myTemplate.html'));

3. Затем я использовал $ templateCache.get, чтобы сохранить его в переменной. В вашем файле Spec.js:

   var element,
       $scope,
       template;
   
   beforeEach(inject(function($rootScope, $compile, $templateCache) {
     $scope = $rootScope.$new();
     element = $compile('<div my-directive></div>')($scope);
     template = $templateCache.get('to/templates/myTemplate.html');
     $scope.$digest();
   }));

4. Наконец, я проверил это таким образом. В вашем файле Spec.js:

   describe('element', function() {
     it('should contain the template', function() {
       expect(element.html()).toMatch(template);
     });
   });

Чтобы загрузить шаблон html динамически в $ templateCache, вы можете просто использовать препроцессор html2js karma, как описано здесь.

это сводится к добавлению шаблонов ' .html' в ваши файлы в файле conf.js, а также preprocessors = {' .html': 'html2js'};

и использовать

beforeEach(module('..'));

beforeEach(module('...html', '...html'));

в ваш файл тестирования js

если вы используете Карму, подумайте об использовании karma-ng-html2js-preprocessor для предварительной компиляции ваших внешних HTML-шаблонов и избегайте того, чтобы Angular пытался HTTP GET во время выполнения теста. Я боролся с этим в течение нескольких наших - в моем случае частичные пути templateUrl разрешались во время обычного выполнения приложения, но не во время тестов - из-за различий в структурах приложений и тестовых каталогов.

Если вы используете jasmine-maven-plugin вместе с RequireJS, вы можете использовать текстовый плагин для загрузки содержимого шаблона в переменную, а затем поместить его в кеш шаблона.

define(['angular', 'text!path/to/template.html', 'angular-route', 'angular-mocks'], function(ng, directiveTemplate) {
    "use strict";

    describe('Directive TestSuite', function () {

        beforeEach(inject(function( $templateCache) {
            $templateCache.put("path/to/template.html", directiveTemplate);
        }));

    });
});

Если вы используете requirejs в своих тестах, вы можете использовать плагин 'text' для извлечения шаблона html и помещения его в $ templateCache.

require(["text!template.html", "module-file"], function (templateHtml){
  describe("Thing", function () {

    var element, scope;

    beforeEach(module('module'));

    beforeEach(inject(function($templateCache, $rootScope, $compile){

      // VOILA!
      $templateCache.put('/path/to/the/template.html', templateHtml);  

      element = angular.element('<my-thing></my-thing>');
      scope = $rootScope;
      $compile(element)(scope);   

      scope.$digest();
    }));
  });
});

Я решил эту проблему, скомпилировав все шаблоны в templatecache. Я использую gulp, вы можете найти подобное решение и для grunt. Мои templateUrls в директивах, модальные окна выглядят как

`templateUrl: '/templates/directives/sidebar/tree.html'`

1. Добавьте новый пакет npm в мой package.json

   "gulp-angular-templatecache": "1.*"

2. В файле gulp добавьте templatecache и новую задачу:

   var templateCache = require('gulp-angular-templatecache'); ... ... gulp.task('compileTemplates', function () { gulp.src([ './app/templates/**/*.html' ]).pipe(templateCache('templates.js', { transformUrl: function (url) { return '/templates/' + url; } })) .pipe(gulp.dest('wwwroot/assets/js')); });

3. Добавьте все js файлы в index.html

   <script src="/assets/js/lib.js"></script> <script src="/assets/js/app.js"></script> <script src="/assets/js/templates.js"></script>

4. Наслаждайтесь!