Сконфигурируйте Karma для загрузки pegjs с requirejs
Попытка протестировать проект, используя PegJS и requirejs. У меня есть несколько исходных файлов, реализованных в виде модуля AMD (определение), который загружается через требуемый API. Ниже структура каталогов:
js/
somefile.js
main.js
parser.js
test/
parser.spec.js
Я написал модуль parser.js для загрузки файла грамматики PegJS и использую PegJS для создания анализатора peg:
define(function() {
'use strict';
var PEG = require('pegjs');
var grammarFile = 'grammar.peg'
return {
parse: function(fs, content, debug) {
var grammar = fs.readFileSync(grammarFile, 'utf8').toString();
// Build parser from grammar
var parser = PEG.buildParser(grammar, { trace: debug });
[...]
Это прекрасно работает с main.js, выполняемым в командной строке с узлом. Теперь я хочу протестировать свой проект, используя карму, жасмин и PhantomJS. У меня есть karma.conf.js, как это:
frameworks: ['jasmine', 'requirejs'],
files: [
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js',
],
Также есть файл начальной загрузки test-main.js, который настроен следующим образом:
'use strict';
var allTestFiles = [];
var TEST_REGEXP = /(spec|test)\.js$/i;
// Get a list of all the test files to include
Object.keys(window.__karma__.files).forEach(function(file) {
console.log(file);
if (TEST_REGEXP.test(file)) {
// Normalize paths to RequireJS module names.
// If you require sub-dependencies of test files to be loaded as-is (requiring file extension)
// then do not normalize the paths
var normalizedTestModule = file.replace(/^\/base\/|\.js$/g, '');
allTestFiles.push(file);
}
});
require.config({
// Karma serves files under /base, which is the basePath from your config file
baseUrl: '/base/js',
// dynamically load all test files
deps: allTestFiles,
// we have to kickoff jasmine, as it is asynchronous
callback: window.__karma__.start
});
Теперь, когда я запускаю свой тест (grunt karma
), Я получил эту ошибку:
PhantomJS 1.9.8 (Linux 0.0.0) ERROR: Error{message: 'Module name "pegjs" has not been loaded yet for context: _. Use require([])
Поэтому я пытаюсь включить pegjs в файлы, загруженные Karma, следующим образом: karma.conf.js:
files: [
{ pattern: 'node_modules/pegjs/lib/**/*.js', included: true },
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js'
],
Когда я делаю это, я все еще получаю ошибку:
Error: Module name "utils/arrays" has not been loaded yet for context: _. Use require([])
Если заглянуть внутрь модуля pegjs, то действительно есть файл arrays.js:
compiler/
compiler.js
grammar-error.js
parser.js
peg.js
utils/
arrays.js
classes.js
objects.js
Так что попробуйте включить массивы тоже:
files: [
{ pattern: 'node_modules/pegjs/lib/utils/arrays.js', included: true },
{ pattern: 'node_modules/pegjs/lib/**/*.js', included: true },
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js'
],
Я получил:
ReferenceError: Can't find variable: module
at /blabla/node_modules/pegjs/lib/utils/arrays.js:108
Потому что:
108 module.exports = arrays;
Итак, вместо загрузки модуля npm я попытался загрузить модуль bower следующим образом:
files: [
{ pattern: 'bower_components/pegjs/peg-0.9.0.js', included: true },
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js'
],
И здесь вы идете снова:
PhantomJS 1.9.8 (Linux 0.0.0) ERROR: Error{message: 'Module name "pegjs" has not been loaded yet for context: _. Use require([])
Также пытался не включать pegjs в веб-страницу, созданную кармой:
files: [
{ pattern: 'bower_components/pegjs/peg-0.9.0.js', included: false },
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js'
],
Но это не так с:
PhantomJS 1.9.8 (Linux 0.0.0) ERROR: 'There is no timestamp for /base/bower_components/pegjs/peg-0.9.0!'
Попытка поместить папку bower_component в папку js, но не повезло.
Так что я не знаю, куда идти отсюда... Не могу найти что-нибудь подходящее в Google или здесь. Кажется, это особая проблема, связанная с потребностью в jj /pegjs с кармой... Любая идея приветствуется.
ОБНОВЛЕНИЕ после ответа Дана:
Поэтому я переключаюсь с синхронного требования на асинхронное требование в файле parser.js:
define(['../bower_components/pegjs/peg-0.9.0'], function(PEG) {
'use strict';
var grammarFile = 'grammar.peg'
return {
parse: function(fs, content, debug) {
var grammar = fs.readFileSync(grammarFile, 'utf8').toString();
// Build parser from grammar
var parser = PEG.buildParser(grammar, { trace: debug });
[...]
Попытался включить компонент pegjs bower в karma.conf.js:
{ pattern: 'bower_components/pegjs/peg-0.9.0.js', included: false },
или не включать его:
{ pattern: 'bower_components/pegjs/peg-0.9.0.js', included: true },
Но всегда получаю одну и ту же ошибку:
Error: Script error for "/blabla/bower_components/pegjs/peg-0.9.0", needed by: /blabla/js/parser.js
http://requirejs.org/docs/errors.html#scripterror
at /blabla/node_modules/requirejs/require.js:140
Да, файл существует:
$ file /home/aa024149/share/logofrjs/bower_components/pegjs/peg-0.9.0.js
/blabla/bower_components/pegjs/peg-0.9.0.js: ASCII text, with very long lines
ОБНОВЛЕНИЕ 2: Наконец-то понял и нашел приемлемое решение.
3 ответа
Таким образом, с помощью различных ответов и комментариев от Дэна и pieceOpiland я наконец нашел способ сделать то, что я хочу.
Итак, во-первых, pegjs, как и многие библиотеки javascript, поставляется в двух форматах: модули npm и модули bower.
Модули Npm используются для сценария, созданного для узла и вызываемого из командной строки. Модули Бауэра используются для скрипта, загруженного в браузер.
Первое недоразумение с моей стороны состояло в том, что 'require' будет работать неявно в узле и в браузере. Это не верно. Кажется, единственный способ потребовать модуль, чтобы он работал в браузере, - это асинхронный вызов, такой как:
require(['module'], function(module) {
...
});
Еще одно недоразумение заключалось в том, что я мог загружать модули npm в браузер. То, что какая-то магия будет действовать для различных файлов npm, загружаемых с моей страницы. Это может быть возможно, но только с помощью специального инструмента, такого как browserify. Без специального преобразования в браузере может быть загружена только версия bower. Кроме того, модуль pegjs bower сделан таким образом, что глобальные переменные определяются следующим образом:
var PEG = {
...
}
module.exports = PEG;
По сути, модуль bower подключает глобальную переменную (фактически несколько глобальных переменных) к области верхнего уровня.
Таким образом, вместо того, чтобы мой клиентский код (тот, который работает в браузере И в узле) загружал модуль, я фактически загружаю модуль либо:
- main.js через синхронный запрос к модулю npm выглядит так:
var PEG = require('pegjs');
- main-browser.js через глобальную переменную, которая становится доступной при загрузке скрипта bower pegjs (через
<script>
тег)
Затем обе эти "магистрали" вводят переменную PEG в мою функцию синтаксического анализа.
Чтобы карма работала, мне просто нужно включить модуль pegjs bower в сгенерированную страницу (извлечениеkarma.conf.js):
files: [
{ pattern: 'bower_components/pegjs/peg-0.9.0.js', included: true },
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js',
],
Похоже, вы загружаете pegjs через requirejs. Если это так, pegjs не должен быть включенным файлом. В вашем karma.conf.js вы пробовали следующее:
files: [
{ pattern: 'bower_components/pegjs/peg-0.9.0.js', included: false },
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js'
],
Значение для включенного указывает, должна ли веб-страница, создаваемая сервером кармы, иметь тег сценария для этого файла или нет (см. http://karma-runner.github.io/0.13/config/files.html). Итак, ваша karma.config из:
files: [
{ pattern: 'bower_components/pegjs/peg-0.9.0.js', included: true },
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js'
],
заставит карму сгенерировать веб-страницу с тегом head, похожим на:
<head>
<script src="/base/bower_components/pegjs/peg-0.9.0.js"></script>
<script src="/base/require.js"></script>
<script src="/base/test/test-main.js"></script>
</head>
По своему опыту, я видел много похожего поведения, которое было вызвано пометкой моих файлов как included: true
, Если есть файл, который вы пытаетесь загрузить с помощью requirejs, убедитесь, что он помечен как included: false
,
Я полагаю, что это знаменует собой задачу предварительной обработки, но я не совсем уверен, почему это так важно.
Насколько я знаю, Karma - это среда тестирования, которая будет запускать ваши тесты в браузере.
Это не подходит для тестирования многих узловых модулей.
Браузер не имеет возможности сделать это синхронно: var PEG = require('pegjs')
, Вот почему он просит вас использовать require([])
который вы передаете обратный вызов, который будет выполнен, когда pegjs заканчивает загрузку.
Использование более низкой версии pegjs и обеспечение ее загрузки перед require('pegjs')
здесь может помочь. Это гарантирует, что pegjs уже загружен для контекста _ (я полагаю, контекст по умолчанию requirejs).
Он также не может загружать файлы из файловой системы с fs.readFileSync(grammarFile, 'utf8')
так что вам придется сделать это по-другому. Вы можете попросить Karma разместить вашу грамматику колышка, поместив ее в массив файлов и затем загрузив ее с помощью текстового плагина requirejs.
Если модуль, который вы тестируете, предназначен для запуска на node.js, а не в браузере, то он может быть более подходящим для использования тестовой среды, которая не запускает код в браузере, но запускает его на узле, поэтому у вас есть все Модули узла доступны для вас. Если вы нацеливаетесь на браузер, я бы переписал его, чтобы более конкретно нацелить браузер.