Skip to content

Commit

Permalink
added code coverage and couple other things.
Browse files Browse the repository at this point in the history
  • Loading branch information
Spencer Alger committed Mar 5, 2014
1 parent 40b3021 commit 94c1458
Show file tree
Hide file tree
Showing 16 changed files with 1,250 additions and 84 deletions.
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
"grunt-contrib-watch": "~0.5.3",
"grunt-contrib-jade": "~0.10.0",
"grunt-contrib-less": "~0.9.0",
"grunt-cli": "~0.1.13"
"grunt-cli": "~0.1.13",
"istanbul": "~0.2.4",
"path-browserify": "0.0.0"
},
"scripts": {
"test": "grunt test",
Expand Down
3 changes: 2 additions & 1 deletion src/kibana/require.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ require.config({
lodash: '../bower_components/lodash/dist/lodash',
moment: '../bower_components/moment/moment',
gridster: '../bower_components/gridster/dist/jquery.gridster',
config: '../config'
configFile: '../config',
bower_components: '../bower_components'
},
shim: {
angular: {
Expand Down
65 changes: 52 additions & 13 deletions tasks/config/connect.js
Original file line number Diff line number Diff line change
@@ -1,20 +1,59 @@
module.exports = function (grunt) {
var instrumentationMiddleware = require('../utils/instrumentation');
var amdWrapMiddleware = require('../utils/amd-wrapper');

return {
dev: {
options: {
base: '<%= src %>'
}
},
test: {
options: {
base: [
'<%= unitTestDir %>',
'<%= testUtilsDir %>',
'<%= src %>',
'<%= root %>/node_modules/mocha',
'<%= root %>/node_modules/expect.js'
],
port: 8001
middleware: function (connect, options, stack) {
stack = stack || [];

var root = grunt.config.get('root');

// when a request for an intrumented file comes in (?instrument=true)
// and it is included in `pattern`, it will be handled
// by this middleware
stack.push(instrumentationMiddleware({
// root that files should be served from
root: root,

// make file names easier to read
displayRoot: grunt.config.get('src'),

// filter the filenames that will be served
filter: function (filename) {
// return true if the filename should be
// included in the coverage report (results are cached)
return grunt.file.isMatch([
'**/src/**/*.js',
'!**/src/bower_components/**/*',
'!**/src/kibana/utils/{event_emitter,next_tick}.js'
], filename);
}
}));

// minimize code duplication (especially in the istanbul reporter)
// by allowing node_modules to be requested in an AMD wrapper
stack.push(amdWrapMiddleware({
root: root
}));

// standard static middleware reading from the root
stack.push(connect.static(root));

// allow browsing directories
stack.push(connect.directory(root));

// redirect requests for '/' to '/src/'
stack.push(function (req, res, next) {
if (req.url !== '/') return next();
res.statusCode = 303;
res.setHeader('Location', '/src/');
res.end();
});

return stack;
}
}
}
};
Expand Down
29 changes: 18 additions & 11 deletions tasks/config/jade.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,13 @@ module.exports = function (grunt) {
var path = require('path');

return {
all: {
src: [
'<%= app %>/partials/**/*.jade',
'<%= app %>/apps/**/*.jade',
'<%= root %>/test/**/*.jade',
'!<%= root %>/**/_*.jade'
],
expand: true,
ext: '.html',
options: {
compileDebug: false
},
test: {
files: {
'<%= unitTestDir %>/index.html': '<%= unitTestDir %>/index.jade'
},
options: {
data: function (src, dest) {
var unitTestDir = grunt.config.get('unitTestDir');
Expand All @@ -26,8 +24,17 @@ module.exports = function (grunt) {
return path.relative(appdir, filename).replace(/\.js$/, '');
})
};
},
client: false
}
}
},
clientside: {
files: {
'<%= testUtilsDir %>/istanbul_reporter/report.jade.js': '<%= testUtilsDir %>/istanbul_reporter/report.clientside-jade'
},
options: {
client: true,
amd: true,
namespace: false // return the template directly in the amd wrapper
}
}
};
Expand Down
3 changes: 1 addition & 2 deletions tasks/config/less.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
module.exports = {
src: {
src: [
'<%= app %>/styles/**/*.less',
'<%= app %>/apps/**/*.less',
'<%= app %>/**/styles/**/*.less',
'!<%= src %>/**/_*.less'
],
expand: true,
Expand Down
20 changes: 13 additions & 7 deletions tasks/config/watch.js
Original file line number Diff line number Diff line change
@@ -1,23 +1,29 @@
module.exports = function (grunt) {
return {
test: {
files: ['<%= unitTestDir %>/**/*.js'],
files: [
'<%= unitTestDir %>/**/*.js'
],
tasks: ['mocha:unit']
},
less: {
files: [
'<%= app %>/**/*.less',
'<%= src %>/courier/**/*.less'
'<%= app %>/**/styles/**/*.less',
'!<%= src %>/**/_*.less'
],
tasks: ['less']
},
jade: {
files: [
'<%= root %>/**/*.jade',
'!<%= root %>/node_modules/**/*',
'!<%= src %>/bower_components/**/*'
'<%= unitTestDir %>/index.jade'
],
tasks: ['jade:test']
},
clientside_jade: {
files: [
'<%= testUtilsDir %>/istanbul_reporter/report.clientside-jade'
],
tasks: ['jade']
tasks: ['jade:clientside']
}
};
};
7 changes: 6 additions & 1 deletion tasks/dev.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
module.exports = function (grunt) {
grunt.registerTask('dev', ['less', 'jade', 'connect:dev', 'watch']);
grunt.registerTask('dev', [
'less',
'jade',
'connect:dev',
'watch'
]);
};
1 change: 0 additions & 1 deletion tasks/server.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
module.exports = function (grunt) {
grunt.registerTask('server', ['connect:dev:keepalive']);
grunt.registerTask('test_server', ['connect:test:keepalive']);
};
12 changes: 9 additions & 3 deletions tasks/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,19 @@ module.exports = function (grunt) {
/* jshint scripturl:true */
grunt.registerTask('test', [
'jshint',
'connect:test',
'jade:test',
'connect:dev',
'jade',
'mocha:unit'
]);

grunt.registerTask('coverage', [
'blanket',
'connect:dev',
'mocha:coverage'
]);

grunt.registerTask('test:watch', [
'connect:test',
'connect:dev',
'watch:test'
]);
};
26 changes: 26 additions & 0 deletions tasks/utils/amd-wrapper.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
module.exports = function amdWrapMiddleware(opts) {
opts = opts || {};

var root = opts.root || '/';
var path = require('path');
var fs = require('fs');
var pathPrefix = opts.pathPrefix || '/amd-wrap/';

return function (req, res, next) {
// only allow prefixed requests
if (req.url.substring(0, pathPrefix.length) !== pathPrefix) return next();

// strip the prefix and form the filename
var filename = path.join(root, req._parsedUrl.pathname.replace('/amd-wrap/', ''));

fs.readFile(filename, 'utf8', function (err, contents) {
// file does not exist
if (err) return next(err.code === 'ENOENT' ? void 0 : err);

// respond with the wrapped code
res.statusCode = 200;
res.setHeader('Content-Type', 'application/javascript');
res.end('define(function (require, exports, module) {\n' + contents + '\n});');
});
};
};
77 changes: 77 additions & 0 deletions tasks/utils/instrumentation.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
var Istanbul = require('istanbul');
var i = new Istanbul.Instrumenter({
embedSource: true,
preserveComments: true,
noAutoWrap: true
});

module.exports = function instrumentationMiddleware(opts) {
var fs = require('fs');
var path = require('path');

// for root directory that files will be served from
var root = opts.root || '/';

// the root directory used to create a relative file path
// for display in coverage reports
var displayRoot = opts.displayRoot || null;

// filter the files in root that can be instrumented
var filter = opts.filter || function (filename) {
// by default only instrument *.js files
return /\.js$/.test(filename);
};

// cache filename resolution
var fileMap = {};

function filenameForReq(req) {
if (!~req.url.indexOf('instrument=true')) return false;

// expected absolute path to the file
var filename = path.join(root, req._parsedUrl.pathname);

// shortcut for dev where we could be reloading on every save
if (fileMap[filename] !== void 0) return fileMap[filename];

var ret = filename;

if (!fs.existsSync(filename) || !opts.filter(filename)) {
ret = false;
}

// cache the return value for next time
fileMap[filename] = ret;
return ret;
}

return function (req, res, next) {
// resolve the request to a readable filename
var filename = filenameForReq(req);
// the file either doesn't exist of it was filtered out by opts.filter
if (!filename) return next();

fs.readFile(filename, 'utf8', function (err, content) {
if (err) {
if (err.code !== 'ENOENT') {
// other issue, report!
return next(err);
}

// file was deleted, clear cache and move on
delete fileMap[filename];
return next();
}

res.statusCode = 200;
res.setHeader('Content-Type', 'application/javascript');
res.end(i.instrumentSync(
content,
// make file names easier to read
displayRoot ? path.relative(displayRoot, filename) : filename
));
});
};


};
59 changes: 40 additions & 19 deletions test/unit/index.html
Original file line number Diff line number Diff line change
@@ -1,21 +1,42 @@
<!DOCTYPE html><html><head><title>Kibana4 Tests</title><link rel="stylesheet" href="mocha.css"></head><body><div id="mocha"></div><script src="expect.js"></script><script src="mocha.js"></script><script>mocha.setup('bdd');
// sauce labs & selenium inject global variables that break this
// mocha.checkLeaks();
// mocha.globals(['mochaRunner', 'angular']);</script><script src="bower_components/requirejs/require.js"></script><script src="kibana/require.config.js"></script><script type="text/javascript">require.config({
paths: {
sinon: '../sinon'
},
shim: {
'sinon/sinon': {
deps: [
'sinon/sinon-timers-1.8.2'
],
exports: 'sinon'
}
}
<!DOCTYPE html><html><head><title>Kibana4 Tests</title><link rel="stylesheet" href="/node_modules/mocha/mocha.css"></head><body><div id="mocha"></div><script src="/node_modules/expect.js/expect.js"></script><script src="/node_modules/mocha/mocha.js"></script><script src="/src/bower_components/requirejs/require.js"></script><script src="/src/kibana/require.config.js"></script><script type="text/javascript">window.COVERAGE = !!(/coverage=true/i.test(location.search));
mocha.setup('bdd');

require.config({
baseUrl: '/src/kibana',
paths: {
sinon: '../../test/utils/sinon',
istanbul_reporter: '../../test/utils/istanbul_reporter'
},
shim: {
'sinon/sinon': {
deps: [
'sinon/sinon-timers-1.8.2'
],
exports: 'sinon'
}
},
// mark all requested files with instrument query param
urlArgs: COVERAGE ? 'instrument=true' : void 0
});
require(["/fixtures/field_mapping.js","/specs/apps/dashboard/index.js","/specs/apps/dashboard/mocks/modules.js","/specs/calculate_indices.js","/specs/courier.js","/specs/data_source.js","/specs/mapper.js"], function () {
window.mochaRunner = mocha.run().on('end', function () {
window.mochaResults = this.stats;

function setupCoverage(done) {
document.title = document.title.replace('Tests', 'Coverage');
require(['istanbul_reporter/reporter'], function (IstanbulReporter) {
mocha.reporter(IstanbulReporter);
done();
});
});</script></body></html>
}

function runTests() {
require(["../../test/unit/specs/apps/dashboard/index","../../test/unit/specs/apps/dashboard/mocks/modules","../../test/unit/specs/calculate_indices","../../test/unit/specs/courier","../../test/unit/specs/data_source","../../test/unit/specs/mapper"], function () {
window.mochaRunner = mocha.run().on('end', function () {
window.mochaResults = this.stats;
});
});
}

if (COVERAGE) {
setupCoverage(runTests);
} else {
runTests();
}</script></body></html>
Loading

0 comments on commit 94c1458

Please sign in to comment.