Merge pull request #18 from spenceralger/master

Implemented code coverage

package.json

@@ -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",

src/courier/courier.js

@@ -286,5 +286,17 @@ define(function (require) {
     this.fetch('doc');
   };
 
+  // get the list of open data source objects
+  // primarily for testing purposes
+  Courier.prototype._openSources = function (type) {
+    if (!type) {
+      return _.transform(this._refs, function (open, refs) {
+        [].push.apply(open, refs);
+      }, []);
+    }
+
+    return this._refs[type] || [];
+  };
+
   return Courier;
 });

src/kibana/require.config.js

@@ -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: {

tasks/config/connect.js

@@ -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;
+        }
       }
     }
   };

tasks/config/jade.js

@@ -1,24 +1,41 @@
 module.exports = function (grunt) {
+  var path = require('path');
+
   return {
+    options: {
+      compileDebug: false
+    },
     test: {
-      src: [
-        '<%= unitTestDir %>/**/*.jade',
-        '<%= app %>/partials/**/*.jade',
-        '<%= app %>/apps/**/*.jade'
-      ],
-      expand: true,
-      ext: '.html',
+      files: {
+        '<%= unitTestDir %>/index.html': '<%= unitTestDir %>/index.jade'
+      },
       options: {
         data: function (src, dest) {
-          var pattern = grunt.config.process('<%= unitTestDir %>/**/*.js');
-          var tests = grunt.file.expand({}, pattern).map(function (filename) {
-            return filename.replace(grunt.config.get('unitTestDir'), '');
-          });
-          return { tests: JSON.stringify(tests) };
-        },
-        client: false
+          var unitTestDir = grunt.config.get('unitTestDir');
+
+          // filter for non unit test related files
+          if (!~path.dirname(src).indexOf(unitTestDir)) return;
+
+          var pattern = unitTestDir + '/specs/**/*.js';
+          var appdir = grunt.config.get('app');
+
+          return {
+            tests: grunt.file.expand({}, pattern).map(function (filename) {
+              return path.relative(appdir, filename).replace(/\.js$/, '');
+            })
+          };
+        }
+      }
+    },
+    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
       }
     }
   };
-};
-
+};

tasks/config/jshint.js

@@ -3,7 +3,12 @@ module.exports = function (config) {
     // just lint the source dir
     source: {
       files: {
-        src: ['Gruntfile.js', '<%= src %>/**/*.js', '<%= unitTestDir %>/**/*.js', '<%= root %>/tasks/**/*.js']
+        src: [
+          'Gruntfile.js',
+          '<%= src %>/**/*.js',
+          '<%= unitTestDir %>/**/*.js',
+          '<%= root %>/tasks/**/*.js'
+        ]
       }
     },
     options: {

tasks/config/less.js

@@ -1,8 +1,7 @@
 module.exports = {
   src: {
     src: [
-      '<%= app %>/styles/**/*.less',
-      '<%= app %>/apps/**/*.less',
+      '<%= app %>/**/styles/**/*.less',
       '!<%= src %>/**/_*.less'
     ],
     expand: true,

tasks/config/mocha.js

@@ -1,12 +1,14 @@
 module.exports = {
+  options: {
+    log: true,
+    logErrors: true,
+    run: false
+  },
   unit: {
     options: {
-      log: true,
-      logErrors: true,
       urls: [
-        'http://localhost:8001/'
-      ],
-      run: false
+        'http://localhost:8000/test/unit/'
+      ]
     }
   }
 };

tasks/config/watch.js

@@ -1,23 +1,29 @@
 module.exports = function (grunt) {
   return {
     test: {
-      files: ['<%= unitTestDir %>/*.jade', '<%= unitTestDir %>/**/*.js'],
-      tasks: ['jade:test', 'mocha:unit']
+      files: [
+        '<%= unitTestDir %>/**/*.js'
+      ],
+      tasks: ['mocha:unit']
     },
     less: {
       files: [
-        '<%= app %>/**/*.less',
-        '<%= src %>/courier/**/*.less'
+        '<%= app %>/**/styles/**/*.less',
+        '!<%= src %>/**/_*.less'
       ],
       tasks: ['less']
     },
     jade: {
       files: [
-        '<%= app %>/**/*.jade',
-        '<%= src %>/courier/**/*.jade',
-        '!<%= unitTestDir %>/**/*.jade'
+        '<%= unitTestDir %>/index.jade'
+      ],
+      tasks: ['jade:test']
+    },
+    clientside_jade: {
+      files: [
+        '<%= testUtilsDir %>/istanbul_reporter/report.clientside-jade'
       ],
-      tasks: ['jade']
+      tasks: ['jade:clientside']
     }
   };
 };

tasks/dev.js

@@ -1,3 +1,8 @@
 module.exports = function (grunt) {
-  grunt.registerTask('dev', ['less', 'jade', 'connect:dev', 'watch']);
+  grunt.registerTask('dev', [
+    'less',
+    'jade',
+    'connect:dev',
+    'watch'
+  ]);
 };

tasks/server.js

@@ -1,4 +1,3 @@
 module.exports = function (grunt) {
   grunt.registerTask('server', ['connect:dev:keepalive']);
-  grunt.registerTask('test_server', ['connect:test:keepalive']);
 };

tasks/test.js

@@ -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'
   ]);
 };

tasks/utils/amd-wrapper.js

@@ -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});');
+    });
+  };
+};