feat(dependency injection): Add dependency injection for plugins (#1313)

This PR adds dependency injection to Stryker, in preparation of removing the side effects from the way we now load plugins. Instead of registering yourself to the correct factory (for example, by calling `ReporterFactory.instance().register`), it relies on plugins exporting a property called `strykerPlugins`. 

Just to be clear: this PR does fix not the issue reported in #667. It only adds the dependency injection mechanism to Stryker. We still need to do PR's for each package (can go relatively fast)

The content of this PR:

1. Add a dependency injection framework called `typed-inject` to the packages folder; A type safe dependency injection framework
1. Add a package `stryker-api/di` which contains dependency injection related interfaces to help plugins know what to (type-safely) inject
1. Add `typed-inject` as a dependency to the core Stryker package and use it. Reporter plugins are loaded via this new mechanism.
1. Alter the `PluginLoader` in order to enable dependency injection in all plugins. It is still backward compatible with the old way of loading plugins.
1. Add a package to contain generic test helpers called `@stryker-mutator/test-helpers`. This package contains a `testInjector` to help inject common stuff into injectables for testability purposes.
1. It updated the `BroadcastReporter` and all build-in reporters to now use the new dependency injection mechanism.

e2e/package.json

@@ -45,6 +45,7 @@
     "@stryker-mutator/util": "../packages/stryker-util",
     "stryker-typescript": "../packages/stryker-typescript",
     "stryker-vue-mutator": "../packages/stryker-vue-mutator",
-    "stryker-webpack-transpiler": "../packages/stryker-webpack-transpiler"
+    "stryker-webpack-transpiler": "../packages/stryker-webpack-transpiler",
+    "typed-inject": "../packages/typed-inject"
   }
 }

e2e/test/angular-project/package.json

@@ -51,6 +51,7 @@
     "stryker": "../../../packages/stryker",
     "stryker-karma-runner": "../../../packages/stryker-karma-runner",
     "stryker-typescript": "../../../packages/stryker-typescript",
-    "@stryker-mutator/util": "../../../packages/stryker-util"
+    "@stryker-mutator/util": "../../../packages/stryker-util",
+    "typed-inject": "../../../packages/typed-inject"
   }
 }

e2e/test/jest-react/package.json

@@ -88,6 +88,7 @@
     "stryker": "../../../packages/stryker",
     "stryker-javascript-mutator": "../../../packages/stryker-javascript-mutator",
     "stryker-jest-runner": "../../../packages/stryker-jest-runner",
-    "@stryker-mutator/util": "../../../packages/stryker-util"
+    "@stryker-mutator/util": "../../../packages/stryker-util",
+    "typed-inject": "../../../packages/typed-inject"
   }
 }

e2e/test/polymer-project/package.json

@@ -29,7 +29,8 @@
     "stryker": "../../../packages/stryker",
     "stryker-wct-runner": "../../../packages/stryker-wct-runner",
     "stryker-javascript-mutator": "../../../packages/stryker-javascript-mutator",
-    "@stryker-mutator/util": "../../../packages/stryker-util"
+    "@stryker-mutator/util": "../../../packages/stryker-util",
+    "typed-inject": "../../../packages/typed-inject"
   },
   "scripts": {
     "prepare": "install-local",

e2e/test/vue-javascript/package.json

@@ -88,7 +88,8 @@
     "stryker-javascript-mutator": "../../../packages/stryker-javascript-mutator",
     "stryker-karma-runner": "../../../packages/stryker-karma-runner",
     "stryker-vue-mutator": "../../../packages/stryker-vue-mutator",
-    "@stryker-mutator/util": "../../../packages/stryker-util"
+    "@stryker-mutator/util": "../../../packages/stryker-util",
+    "typed-inject": "../../../packages/typed-inject"
   },
   "engines": {
     "node": ">= 6.0.0",

packages/stryker-api/package.json

@@ -39,6 +39,7 @@
     "tslib": "~1.9.3"
   },
   "devDependencies": {
-    "surrial": "~0.1.1"
+    "surrial": "~0.1.1",
+    "typed-inject": "0.0.0"
   }
 }

packages/stryker-api/plugin.ts

@@ -0,0 +1,4 @@
+export * from './src/plugin/Contexts';
+export * from './src/plugin/Plugins';
+export * from './src/plugin/PluginKind';
+export * from './src/plugin/tokens';

packages/stryker-api/src/config/Config.ts

@@ -34,7 +34,7 @@ export default class Config implements StrykerOptions {
   };
   public allowConsoleColors: boolean = true;
 
-  public set(newConfig: StrykerOptions) {
+  public set(newConfig: Partial<StrykerOptions>) {
     if (newConfig) {
       Object.keys(newConfig).forEach(key => {
         if (typeof newConfig[key] !== 'undefined') {

packages/stryker-api/src/core/StrykerOptions.ts

@@ -9,7 +9,7 @@ interface StrykerOptions {
   /**
    * A list of globbing expression used for selecting the files that should be mutated.
    */
-  mutate?: string[];
+  mutate: string[];
 
   /**
    * With `files` you can choose which files should be included in your test runner sandbox.
@@ -32,7 +32,7 @@ interface StrykerOptions {
    * all the CPU cores of your machine. Default: infinity, Stryker will decide for you and tries to use
    * all CPUs in your machine optimally.
    */
-  maxConcurrentTestRunners?: number;
+  maxConcurrentTestRunners: number;
 
   /**
    * A location to a config file. That file should export a function which accepts a "config" object which it uses to configure stryker
@@ -45,9 +45,9 @@ interface StrykerOptions {
   testFramework?: string;
 
   /**
-   * The name of the test runner to use (default is the same name as the testFramework)
+   * The name of the test runner to use (default is 'command')
    */
-  testRunner?: string;
+  testRunner: string;
 
   /**
    * The mutant generator to use to generate mutants based on your input file.
@@ -61,7 +61,7 @@ interface StrykerOptions {
    *    * The `excludedMutations` property is mandatory and contains the names of the specific mutation types to exclude from testing.
    *    * The values must match the given names of the mutations. For example: 'BinaryExpression', 'BooleanSubstitution', etc.
    */
-  mutator?: string | MutatorDescriptor;
+  mutator: string | MutatorDescriptor;
 
   /**
    * The names of the transpilers to use (in order). Default: [].
@@ -80,12 +80,12 @@ interface StrykerOptions {
    *
    * Transpilers should ignore files marked with `transpiled = false`. See `files` array.
    */
-  transpilers?: string[];
+  transpilers: string[];
 
   /**
    * Thresholds for mutation score.
    */
-  thresholds?: Partial<MutationScoreThresholds>;
+  thresholds: MutationScoreThresholds;
 
   /**
    * Indicates which coverage analysis strategy to use.
@@ -95,7 +95,7 @@ interface StrykerOptions {
    * 'all': Analyse the coverage for the entire test suite.
    * 'off': Don't use coverage analysis
    */
-  coverageAnalysis?: 'perTest' | 'all' | 'off';
+  coverageAnalysis: 'perTest' | 'all' | 'off';
 
   /**
    * DEPRECATED PROPERTY. Please use the `reporters` property
@@ -106,24 +106,24 @@ interface StrykerOptions {
    * Possible values: 'clear-text', 'progress'.
    * Load more plugins to be able to use more reporters
    */
-  reporters?: string[];
+  reporters: string[];
 
   /**
    * The log level for logging to a file. If defined, stryker will output a log file called "stryker.log".
    * Default: "off"
    */
-  fileLogLevel?: LogLevel;
+  fileLogLevel: LogLevel;
 
   /**
    * The log level for logging to the console. Default: "info".
    */
-  logLevel?: LogLevel;
+  logLevel: LogLevel;
 
   /**
    * Indicates whether or not to symlink the node_modules folder inside the sandbox folder(s).
    * Default: true
    */
-  symlinkNodeModules?: boolean;
+  symlinkNodeModules: boolean;
 
   /**
    * DEPRECATED PROPERTY. Please use the `timeoutMS` property
@@ -132,17 +132,17 @@ interface StrykerOptions {
   /**
    * Amount of additional time, in milliseconds, the mutation test is allowed to run
    */
-  timeoutMS?: number;
+  timeoutMS: number;
 
   /**
    * The factor is applied on top of the other timeouts when during mutation testing
    */
-  timeoutFactor?: number;
+  timeoutFactor: number;
 
   /**
    * A list of plugins. These plugins will be imported ('required') by Stryker upon loading.
    */
-  plugins?: string[];
+  plugins: string[];
 
   /**
    * DEPRECATED
@@ -154,7 +154,7 @@ interface StrykerOptions {
    * Indicates whether or not to use colors in console.
    * Default: true
    */
-  allowConsoleColors?: boolean;
+  allowConsoleColors: boolean;
 }
 
 export default StrykerOptions;

packages/stryker-api/src/plugin/Contexts.ts

@@ -0,0 +1,53 @@
+import { LoggerFactoryMethod, Logger } from '../../logging';
+import { StrykerOptions } from '../../core';
+import { PluginResolver } from './Plugins';
+import { Config } from '../../config';
+import { PluginKind } from './PluginKind';
+import { commonTokens } from './tokens';
+
+/**
+ * The basic dependency injection context within Stryker
+ */
+export interface BaseContext {
+  [commonTokens.getLogger]: LoggerFactoryMethod;
+  [commonTokens.logger]: Logger;
+  [commonTokens.pluginResolver]: PluginResolver;
+}
+
+/**
+ * The dependency injection context for most of Stryker's plugins.
+ * Can inject basic stuff as well as the Stryker options
+ */
+export interface OptionsContext extends BaseContext {
+  [commonTokens.options]: StrykerOptions;
+  /**
+   * @deprecated This is just here to migrate between old and new plugins. Don't use this! Use `options` instead
+   */
+  [commonTokens.config]: Config;
+}
+
+/**
+ * The dependency injection context for a `TranspilerPlugin`
+ */
+export interface TranspilerPluginContext extends OptionsContext {
+  [commonTokens.produceSourceMaps]: boolean;
+}
+
+/**
+ * The dependency injection context for a `TestRunnerPlugin`
+ */
+export interface TestRunnerPluginContext extends OptionsContext {
+  [commonTokens.sandboxFileNames]: ReadonlyArray<string>;
+}
+
+/**
+ * Lookup type for plugin contexts by kind.
+ */
+export interface PluginContexts {
+  [PluginKind.ConfigEditor]: BaseContext;
+  [PluginKind.Mutator]: OptionsContext;
+  [PluginKind.Reporter]: OptionsContext;
+  [PluginKind.TestFramework]: OptionsContext;
+  [PluginKind.TestRunner]: TestRunnerPluginContext;
+  [PluginKind.Transpiler]: TranspilerPluginContext;
+}

packages/stryker-api/src/plugin/PluginKind.ts

@@ -0,0 +1,11 @@
+/**
+ * The plugin kinds supported by Stryker
+ */
+export enum PluginKind {
+  ConfigEditor = 'ConfigEditor',
+  TestRunner = 'TestRunner',
+  TestFramework = 'TestFramework',
+  Transpiler = 'Transpiler',
+  Mutator = 'Mutator',
+  Reporter = 'Reporter'
+}