Skip to content

WIP: Use Karma instead of custom-built mocha test-runner in the browser #1694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: 4.x
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ module.exports = {
},
parserOptions: {
sourceType: 'module',
ecmaVersion: 6,
ecmaVersion: 2018,
ecmaFeatures: {}
}
};
31 changes: 27 additions & 4 deletions Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,29 @@ module.exports = function(grunt) {
}
}
},
karma: {
options: {
configFile: 'karma.conf.js'
},
saucelabs: {
build: process.env.TRAVIS_JOB_ID || 'non-travis',
configFile: 'karma-setup/default/karma.conf.js',
...require('./karma-setup/shared/saucelabs'),
singleRun: true
},
default: {
browsers: [],
configFile: 'karma-setup/default/karma.conf.js',
singleRun: false,
autoWatch: true
},
amd: {
configFile: 'karma-setup/amd/karma.conf.js',
browsers: [],
singleRun: false,
autoWatch: true
}
},
'saucelabs-mocha': {
all: {
options: {
Expand All @@ -178,8 +201,8 @@ module.exports = function(grunt) {
browsers: [
{ browserName: 'chrome' },
{ browserName: 'firefox', platform: 'Linux' },
// {browserName: 'safari', version: 9, platform: 'OS X 10.11'},
// {browserName: 'safari', version: 8, platform: 'OS X 10.10'},
{ browserName: 'safari', version: 9, platform: 'OS X 10.11' },
{ browserName: 'safari', version: 8, platform: 'OS X 10.10' },
{
browserName: 'internet explorer',
version: 11,
Expand Down Expand Up @@ -238,7 +261,7 @@ module.exports = function(grunt) {
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.loadNpmTasks('grunt-babel');
grunt.loadNpmTasks('grunt-bg-shell');
grunt.loadNpmTasks('@knappi/grunt-saucelabs');
grunt.loadNpmTasks('grunt-karma');
grunt.loadNpmTasks('grunt-webpack');

grunt.task.loadTasks('tasks');
Expand Down Expand Up @@ -268,7 +291,7 @@ module.exports = function(grunt) {
grunt.registerTask('bench', ['metrics']);

if (process.env.SAUCE_ACCESS_KEY) {
grunt.registerTask('sauce', ['concat:tests', 'connect', 'saucelabs-mocha']);
grunt.registerTask('sauce', ['karma:saucelabs']);
} else {
grunt.registerTask('sauce', []);
}
Expand Down
56 changes: 56 additions & 0 deletions karma-setup/.eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
{
"extends": [
"../.eslintrc.js"
],
"overrides": [
{
"extends": [
"plugin:es5/no-es2015",
"prettier"
],
"files": ["**/*.browser.js"],
"plugins": [
"es5"
],
"globals": {
"TODO: clean this up": true,
"CompilerContext": true,
"Handlebars": true,
"handlebarsEnv": true,
"shouldCompileTo": true,
"shouldCompileToWithPartials": true,
"shouldThrow": true,
"expectTemplate": true,
"compileWithPartials": true,
"console": true,
"require": true,
"suite": true,
"equal": true,
"equals": true,
"test": true,
"testBoth": true,
"raises": true,
"deepEqual": true,
"start": true,
"stop": true,
"ok": true,
"sinon": true,
"strictEqual": true,
"define": true,
"expect": true,
"chai": true
},
"env": {
"mocha": true
},
"rules": {
// Disabling for tests, for now.
"no-path-concat": "off",

"no-var": "off",
"dot-notation": "off"
}
},
]

}
19 changes: 19 additions & 0 deletions karma-setup/amd/karma.conf.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
module.exports = function(config) {
config.set({
basePath: '../..',
reporters: ['dots'],
frameworks: ['mocha', 'requirejs'],
browsers: ['Chrome'],
files: [
{ pattern: 'node_modules/sinon/pkg/sinon.js', included: false },
{ pattern: 'node_modules/chai/chai.js', included: false },
{ pattern: 'node_modules/dirty-chai/lib/dirty-chai.js', included: false },
{ pattern: 'dist/handlebars.amd.js', included: false },
'karma-setup/shared/*.browser.js',
'karma-setup/amd/*.browser.js',
'spec/vendor/json2.js',
'spec/env/common.js',
{ pattern: 'spec/*.js', included: false }
]
});
};
38 changes: 38 additions & 0 deletions karma-setup/amd/require-config.browser.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
/* global requirejs */

var tests = Object.keys(window.__karma__.files).filter(function(file) {
return file.match(/^\/base\/spec\/[^/]*\.js/);
});

requirejs.config({
// Karma serves files from '/base'
baseUrl: '/base',

paths: {
handlebars: 'dist/handlebars.amd',
sinon: 'node_modules/sinon/pkg/sinon',
chai: 'node_modules/chai/chai',
dirtyChai: 'node_modules/dirty-chai/lib/dirty-chai'
},

// start test run, once Require.js is done
callback: function() {
require(['handlebars', 'chai', 'dirtyChai', 'sinon'], function(
Handlebars,
chai,
dirtyChai,
sinon
) {
window.Handlebars = Handlebars;

chai.use(dirtyChai);
window.expect = chai.expect;

window.sinon = sinon;

require(tests, function() {
window.__karma__.start();
});
});
}
});
1 change: 1 addition & 0 deletions karma-setup/default/global-expect.browser.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
window.expect = chai.expect;
20 changes: 20 additions & 0 deletions karma-setup/default/karma.conf.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
module.exports = function(config) {
config.set({
basePath: '../..',
reporters: ['dots'],
frameworks: ['mocha'],
browsers: ['Chrome'],
files: [
'node_modules/sinon/pkg/sinon.js',
'node_modules/chai/chai.js',
'node_modules/dirty-chai/lib/dirty-chai.js',
'karma-setup/shared/*.browser.js',
'karma-setup/default/*.browser.js',
'spec/vendor/json2.js',
'spec/env/common.js',

'dist/handlebars.js',
'spec/*.js'
]
});
};
22 changes: 22 additions & 0 deletions karma-setup/shared/global-compiler-context.browser.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
window.CompilerContext = {
compile: function(template, options) {
var templateSpec = handlebarsEnv.precompile(template, options);
return handlebarsEnv.template(safeEval(templateSpec));
},
compileWithPartial: function(template, options) {
return handlebarsEnv.compile(template, options);
}
};

function safeEval(templateSpec) {
try {
var ret;
// eslint-disable-next-line no-eval
eval('ret = ' + templateSpec);
return ret;
} catch (err) {
// eslint-disable-next-line no-console
console.error(templateSpec);
throw err;
}
}
47 changes: 47 additions & 0 deletions karma-setup/shared/saucelabs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
// Example set of browsers to run on Sauce Labs
// Check out https://saucelabs.com/platforms for all browser/platform combos
const customLaunchers = {
sl_chrome: {
base: 'SauceLabs',
browserName: 'chrome'
},
sl_firefox: {
base: 'SauceLabs',
browserName: 'firefox',
platform: 'Linux'
},
sl_safari_9: {
base: 'SauceLabs',
browserName: 'safari',
version: 9,
platform: 'OS X 10.11'
},
sl_safari_8: {
base: 'SauceLabs',
browserName: 'safari',
version: 8,
platform: 'OS X 10.10'
},
sl_ie_10: {
base: 'SauceLabs',
browserName: 'internet explorer',
version: 10,
platform: 'Windows 8'
},
sl_ie_11: {
base: 'SauceLabs',
browserName: 'internet explorer',
platform: 'Windows 8.1',
version: '11'
}
};

const browsers = Object.keys(customLaunchers);

module.exports = {
customLaunchers,
browsers,
sauceLabs: {
testName: 'handlebars-unit-tests'
}
};
Loading