Improved unit testing support

* added the possibility to filter the unit tests to execute (closes #85)
* converted the test spec-bundle to typescript (closes #86)

Author: dsebastien

README.md

@@ -81,12 +81,10 @@ If the above does not work in your case, then check to make sure that the user a
 * `npm run start:hmr`: start the development server with Hot Module Replacement enabled
 * `npm run build:prod`: build the production version (in /dist)
 * `npm run start:prod`: build and serve the production version
-* `npm run watch`: start the development webpack build in watch mode
-* `npm run watch:prod`: start the production webpack build in watch mode
-* `npm run watch:test`: start the test webpack build in watch mode
-* `npm run watch:testd`: start the test webpack build in watch mode with debugging enabled
 * `npm run profiling`: generate Webpack profiling information under `reports/profiling`. The stats.json file can be uploaded to http://webpack.github.io/analyse/ for analysis
 * `npm test`: run unit tests
+* `npm run test-subset src/?`: run a subset of the unit tests where ? is either a specific file or a folder. Only tests matching the given path will be executed. The given path MUST start with src/. The file name (if any specified) MUST contain the file extension
+  * example: `npm run test-subset src/app/tests/sanity_test_spec.ts`
 * `npm run e2e`: run end to end tests
 * `npm run e2e:live`: run end to end tests in debug mode: https://github.com/angular/protractor/blob/master/docs/debugging.md
 * `npm run ci`: run unit tests and integration tests
@@ -100,6 +98,11 @@ If the above does not work in your case, then check to make sure that the user a
 * `npm run outdated`: check for outdated dependencies
 * `npm run tsc`: run the TypeScript compiler
 * `npm run typings-install`: install TypeScript type definitions using typings
+* `npm run watch`: start the development webpack build in watch mode
+* `npm run watch:prod`: start the production webpack build in watch mode
+* `npm run watch:test`: start the test webpack build in watch mode
+* `npm run watch:test-subset`: start the test webpack build in watch mode and filter the tests to execute (see npm test)
+* `npm run watch:testd`: start the test webpack build in watch mode with debugging enabled
 * `npm run webdriver:start`: start the Webdriver Manager
 * `npm run webdriver:update`: update Webdriver
 

config/helpers.js

@@ -22,8 +22,8 @@ function rootNode(args) {
 function prependExt(extensions, args) {
     args = args || [];
     if (!Array.isArray(args)) { args = [args] }
-    return extensions.reduce(function(memo, val) {
-        return memo.concat(val, args.map(function(prefix) {
+    return extensions.reduce((memo, val) => {
+        return memo.concat(val, args.map((prefix) => {
             return prefix + val;
         }));
     }, [""]);
@@ -57,10 +57,43 @@ function reverse(arr) {
     return arr.reverse();
 }
 
+/**
+ * Method for removing object properties
+ */
+const removeObjectProperties = (obj, props) => {
+    for(let i = 0; i < props.length; i++) {
+        if(obj.hasOwnProperty(props[i])) {
+            delete obj[props[i]];
+        }
+    }
+};
+
+/**
+ * Retrieve the relative path from the config directory to the path argument value (if provided). That path argument can be passed to only execute a subset of the unit tests (see spec-bundle.ts)
+ * @param args the arguments to look into
+ * @returns {*} The relative path from this directory (config) to the location pointed at by the path argument value (if provided), an empty string otherwise
+ */
+function getTestPath(args) {
+    for (let i = 0; i < args.length; ++i) {
+        if (args[i] === "--path--") {
+            let providedPath = args[i+1] || "";
+            if(!providedPath.toLocaleLowerCase().startsWith("src/")){
+                throw new Error("If you want to execute a subset of the unit tests, then the path you provide MUST start with 'src/'");
+            }
+            //return path.relative(__dirname, providedPath);
+            // posix style to get the expected path separator
+            return path.posix.relative(__dirname, providedPath);
+        }
+    }
+    return "";
+}
+
 exports.reverse = reverse;
 exports.hasProcessFlag = hasProcessFlag;
 exports.root = root;
 exports.rootNode = rootNode;
 exports.prependExt = prependExt;
 exports.prepend = prependExt;
 exports.packageSort = packageSort;
+exports.getTestPath = getTestPath;
+exports.removeObjectProperties = removeObjectProperties;

config/karma.conf.js

@@ -20,11 +20,22 @@ module.exports = (config) => {
 
         // list of files to exclude
         exclude: [],
+        
+        client: {
+            // can be used to pass arguments to tests (see spec-bundle.ts)
+            args: [{
+                // path to the subset of the tests to consider (used to filter the unit tests to execute (see spec-bundle.ts)
+                testPath: helpers.getTestPath(process.argv),
+            }],
+            
+            // other client-side config
+            captureConsole: true,
+        },
 
         // list of files / patterns to load in the browser
         files: [
             {
-                pattern: helpers.root("config/spec-bundle.js"),
+                pattern: helpers.root("config/spec-bundle.ts"),
                 watched: false,
             }
         ],
@@ -37,10 +48,10 @@ module.exports = (config) => {
         // preprocess matching files before serving them to the browser
         // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
         preprocessors: {
-            "./config/spec-bundle.js": [
-                "coverage",
+            "./config/spec-bundle.ts": [
                 "webpack",
                 "sourcemap",
+                "coverage",
             ]
         },
 
@@ -96,10 +107,12 @@ module.exports = (config) => {
 
         // enable / disable watching file and executing tests whenever any file changes
         autoWatch: true,
+        
         // Continuous Integration mode
         // if true, Karma captures browsers, runs the tests and exits
         singleRun: false,
 
+        // JUnit reporter configuration
         junitReporter: {
             outputDir: helpers.root("reports/coverage/"),
             outputFile: "tests-unit/unit.xml",

config/spec-bundle.js

@@ -0,0 +1,64 @@
+"use strict";
+
+/*
+ * When testing with webpack and ES6, we have to do some extra
+ * things get testing to work right. Because we are gonna write test
+ * in ES6 to, we have to compile those as well. That's handled in
+ * karma.conf.js with the karma-webpack plugin. This is the entry
+ * file for webpack test. Just like webpack will create a bundle.js
+ * file for our client, when we run test, it well compile and bundle them
+ * all here! Crazy huh. So we need to do some setup
+ */
+// declare const require: any;
+declare const __karma__: any;
+
+/* tslint:disable */
+const args:any = __karma__.config.args;
+const opts:any = args[0];
+/* tslint:enable */
+
+Error.stackTraceLimit = Infinity;
+
+const path:any = require("path");
+// require("phantomjs-polyfill");
+// require("ts-node");
+require("core-js");
+
+// load the RxJS operators
+require("../src/rxjs-operators");
+
+/*
+ Ok, this is kinda crazy. We can use the the context method on
+ require that webpack created in order to tell webpack
+ what files we actually want to require or import.
+ Below, context will be an function/object with file names as keys.
+ using that regex we are saying look in ../src then find
+ any file that ends with spec.ts and get its path. By passing in true
+ we say do this recursively
+ */
+const testsContext:any = require.context("../src", true, /\.spec\.ts/);
+
+// do NOT delete any of the code below, it is necessary to load the unit tests
+
+let modules:any = testsContext.keys();
+
+// check if the user specified a specific test path 
+let testPath:string = opts.testPath;
+
+// if so then we need to filter out test modules that do not match the provided file/folder path
+if (testPath) {
+    testPath = testPath.toLocaleLowerCase();
+    testPath = testPath.slice(7);
+    testPath = path.normalize(testPath);
+    //console.debug("Filtering the tests to execute. Test file paths must start with: ",testPath);
+
+    modules = modules.filter((modulePath:any) => {
+        modulePath = modulePath.toLocaleLowerCase();
+        modulePath = path.normalize(modulePath);
+        const shouldBeIncluded:boolean = modulePath.startsWith(testPath);
+        return shouldBeIncluded;
+    });
+}
+
+// load the tests
+modules.forEach(testsContext);

config/spec-bundle.ts

@@ -55,7 +55,7 @@
         "rxjs": "5.0.0-beta.2"
     },
     "devDependencies": {
-        "awesome-typescript-loader": "^0.16.2",
+        "awesome-typescript-loader": "^0.17.0-rc.5",
         "autoprefixer": "^6.3.5",
         "typescript": "^1.8.9",
         "reflect-metadata": "^0.1.3",
@@ -158,6 +158,7 @@
         "start:dev": "npm run server",
         "start:prod": "npm run server:prod",
         "test": "node --max-old-space-size=4096 ./node_modules/karma/bin/karma start",
+        "test-subset": "npm run test -- --path--",
         "tsc": "tsc",
         "typings": "typings",
         "typings-install": "typings install",
@@ -166,6 +167,7 @@
         "watch:dev:hmr": "npm run watch:dev -- --hot",
         "watch:prod": "npm run build:prod -- --watch",
         "watch:test": "npm run test -- --auto-watch --no-single-run",
+        "watch:test-subset": "npm run watch:test -- --path--",
         "watch:testd": "npm run test -- --auto-watch --no-single-run --browsers=Chrome",
         "webdriver": "webdriver-manager",
         "webdriver:start": "webdriver-manager start",

package.json

@@ -16,7 +16,6 @@
         "pretty": true,
         "sourceMap": true,
         "outDir": "./.tmp",
-        "rootDir": "./src",
         "moduleResolution": "node",
         "listFiles": false
     },