feat(html-reporter): Score result as single source of truth (#341)

* feat(html-reporter): Score result as single source of truth

Previously we've introduced a reporter event that should function as a single source of truth for all stryker score calculations. Now it is also used in the HTML reporter.

* Add properties `representsFile` and `path` to the `ScoreResult` interface, they are used in the html reporter
* Remove all calculations from the html reporter
* Replace dependency on `handlebarsjs` with `typed-html`
* Migrate all handlebarsjs templates to `typed-html` templates
* Refactor the tests, much cleaner now.
* Update protractor tests for new report
* fix(html-reporter): Use correct relative path. Fixes #335.
* test(HtmlReporter): Add unit tests and update the integration tests

integrationTest/test/mocha-mocha/stryker.conf.js

@@ -4,8 +4,8 @@ module.exports = function (config) {
     mutate: ['src/*.js'],
     testFramework: 'mocha',
     testRunner: 'mocha',
-    reporter: ['clear-text', 'html'],
+    reporter: ['clear-text', 'html', 'event-recorder'],
     maxConcurrentTestRunners: 2,
     port: 9264
   });
-};
+};

package.json

@@ -29,7 +29,7 @@
     "link-parent-bin": "^0.1.1",
     "mocha": "^3.2.0",
     "nyc": "^10.2.0",
-    "protractor": "^5.1.1",
+    "protractor": "^5.1.2",
     "rimraf": "^2.6.1",
     "sinon": "^2.2.0",
     "sinon-chai": "^2.10.0",
@@ -50,4 +50,4 @@
     "test:stryker-api": "lerna run test --scope stryker",
     "lerna-publish": "lerna publish --conventional-commits --yes --git-remote gh-publish"
   }
-}
+}

packages/stryker-api/src/report/ScoreResult.ts

@@ -7,7 +7,17 @@ interface ScoreResult {
    * The file or directory name of this score result node
    */
   readonly name: string;
-
+
+  /**
+   * Full path to file or directory of this score result node
+   */
+  readonly path: string;
+
+  /**
+   * True if this score result represents a file, false if it represents a directory
+   */
+  readonly representsFile: boolean;
+
   /**
    * Any child directory/file score result nodes
    * If this score result represents a file, the length will be 0

packages/stryker-html-reporter/.vscode/launch.json

@@ -5,15 +5,13 @@
       "type": "node",
       "request": "launch",
       "name": "Run ui tests",
-      "runtimeExecutable": "npm",
-      "windows": {
-        "runtimeExecutable": "npm.cmd"
-      },
-      "runtimeArgs": [
-        "run-script",
-        "uiTest"
+      "program": "${workspaceRoot}/../../node_modules/protractor/bin/protractor",
+      "args": [
+        "${workspaceRoot}/protractor.conf.js"
       ],
-      "port": 5858
+      "stopOnEntry": false,
+      "port": 5858,
+      "sourceMaps": true
     },
     {
       "type": "node",

packages/stryker-html-reporter/.vscode/settings.json

@@ -6,6 +6,9 @@
       "**/*.js": {
         "when": "$(basename).ts"
       },
+      "**/**.js": {
+        "when": "$(basename).tsx"
+      },
       "**/*.d.ts": true,
       "**/*.map": {
         "when": "$(basename)"

packages/stryker-html-reporter/.vscode/tasks.json

@@ -0,0 +1,11 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "0.1.0",
+    "command": "npm",
+    "isShellCommand": true,
+    "args": ["start"],
+    "showOutput": "silent",
+    "isBackground": true,
+    "problemMatcher": "$tsc-watch"
+}

packages/stryker-html-reporter/package.json

@@ -6,10 +6,11 @@
   "typings": "src/index.d.ts",
   "scripts": {
     "clean": "rimraf \"+(test|src)/!(resources)/**/*+(.d.ts|.js|.map)\" coverage",
+    "prebuild": "npm run clean",
     "build": "tsc -p . && node tasks/clientResources.js && browserify src/resources/stryker.js -o resources/stryker.js",
     "postbuild": "tslint -p tsconfig.json",
     "start": "tsc -w -p .",
-    "test": "nyc --check-coverage --lines 95 --functions 95 --branches 95 mocha \"test/helpers/*.js\" \"test/unit/*.js\" \"test/integration/*.js\""
+    "test": "nyc --check-coverage --lines 95 --functions 95 --branches 94 mocha \"test/helpers/*.js\" \"test/unit/*.js\" \"test/integration/*.js\""
   },
   "repository": {
     "type": "git",
@@ -32,18 +33,19 @@
   "homepage": "https://github.com/stryker-mutator/stryker/tree/master/packages/stryker-html-reporter#readme",
   "dependencies": {
     "file-url": "^2.0.0",
-    "handlebars": "^4.0.5",
     "lodash": "^4.13.1",
     "log4js": "^1.0.1",
     "mkdirp": "^0.5.1",
-    "mz": "^2.5.0"
+    "mz": "^2.5.0",
+    "rimraf": "^2.6.1",
+    "typed-html": "^0.3.3"
   },
   "peerDependencies": {
     "stryker-api": "^0.5.6"
   },
   "devDependencies": {
     "@types/file-url": "^1.0.28",
-    "@types/handlebars": "^4.0.32",
+    "@types/rimraf": "0.0.28",
     "@types/selenium-webdriver": "^3.0.3",
     "bootstrap": "3.3.7",
     "highlight.js": "^9.4.0",

packages/stryker-html-reporter/protractor.conf.js

@@ -17,13 +17,4 @@ var config = {
   }
 };
 
-if (process.env.TRAVIS) {
-  // Use the travis selenium server spawned in the container, only firefox is working atm
-  config.capabilities = {
-    browserName: 'firefox'
-  };
-  config.seleniumAddress = 'http://localhost:4444/wd/hub';
-  config.directConnect = false;
-}
-
 exports.config = config;