test: increase test coverage and extract test-util library (#22)

* test: add coverage to log drivers and log levels

* test: increase coverage for log types

* chore: git ignore debug.log files

* test: use resolveDependency

* test: extract test-util library

* test: refactor test util library

.gitignore

@@ -40,6 +40,7 @@ npm-debug.log
 yarn-error.log
 testem.log
 /typings
+debug.log
 
 # System Files
 .DS_Store

angular.json

@@ -140,6 +140,32 @@
           }
         }
       }
+    },
+    "test-util": {
+      "projectType": "library",
+      "root": "projects/internal/test-util",
+      "sourceRoot": "projects/internal/test-util/src",
+      "prefix": "lib",
+      "architect": {
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "main": "projects/internal/test-util/src/test.ts",
+            "tsConfig": "projects/internal/test-util/tsconfig.spec.json",
+            "karmaConfig": "projects/internal/test-util/karma.conf.js"
+          }
+        },
+        "lint": {
+          "builder": "@angular-devkit/build-angular:tslint",
+          "options": {
+            "tsConfig": [
+              "projects/internal/test-util/tsconfig.lib.json",
+              "projects/internal/test-util/tsconfig.spec.json"
+            ],
+            "exclude": ["**/node_modules/**"]
+          }
+        }
+      }
     }
   },
   "defaultProject": "lumberjack"

projects/internal/test-util/README.md

@@ -0,0 +1,5 @@
+# Test utilities
+
+## Running unit tests
+
+Run `ng test test-util` to execute the unit tests.

projects/internal/test-util/karma.conf.js

@@ -0,0 +1,32 @@
+// Karma configuration file, see link for more information
+// https://karma-runner.github.io/1.0/config/configuration-file.html
+
+module.exports = function (config) {
+  config.set({
+    basePath: '',
+    frameworks: ['jasmine', '@angular-devkit/build-angular'],
+    plugins: [
+      require('karma-jasmine'),
+      require('karma-chrome-launcher'),
+      require('karma-jasmine-html-reporter'),
+      require('karma-coverage-istanbul-reporter'),
+      require('@angular-devkit/build-angular/plugins/karma'),
+    ],
+    client: {
+      clearContext: false, // leave Jasmine Spec Runner output visible in browser
+    },
+    coverageIstanbulReporter: {
+      dir: require('path').join(__dirname, '../../../coverage/test-util'),
+      reports: ['html', 'lcovonly', 'text-summary'],
+      fixWebpackSourcePaths: true,
+    },
+    reporters: ['progress', 'kjhtml'],
+    port: 9876,
+    colors: true,
+    logLevel: config.LOG_INFO,
+    autoWatch: true,
+    browsers: ['Chrome'],
+    singleRun: false,
+    restartOnFileChange: true,
+  });
+};

projects/ngworker/lumberjack/tests/expect-ng-module-to-be-guarded.ts → projects/internal/test-util/src/lib/expect-ng-module-to-be-guarded.ts

@@ -3,6 +3,9 @@ import { TestBed } from '@angular/core/testing';
 
 import { resolveDependency } from './resolve-dependency';
 
+/**
+ * Assert that an NgModule is guarded against direct import.
+ */
 export const expectNgModuleToBeGuarded = <TModule>(ngModuleType: Type<TModule>) => {
   let ngModule: TModule | undefined;
 

projects/internal/test-util/src/lib/noop-driver/noop-driver-root.module.ts

@@ -0,0 +1,28 @@
+import { NgModule, Optional, SkipSelf } from '@angular/core';
+
+import { defaultLogDriverConfig, LogDriverConfigToken, LogDriverToken } from '@ngworker/lumberjack';
+
+import { NoopDriver } from './noop-driver.service';
+
+@NgModule({
+  providers: [
+    {
+      provide: LogDriverConfigToken,
+      useValue: defaultLogDriverConfig,
+    },
+    {
+      provide: LogDriverToken,
+      useClass: NoopDriver,
+      multi: true,
+    },
+  ],
+})
+export class NoopDriverRootModule {
+  constructor(@Optional() @SkipSelf() maybeNgModuleFromParentInjector?: NoopDriverRootModule) {
+    if (maybeNgModuleFromParentInjector) {
+      throw new Error(
+        'ConsoleDriverModule.forRoot registered in multiple injectors. Only call it from your root injector such as in AppModule.'
+      );
+    }
+  }
+}

projects/internal/test-util/src/lib/noop-driver/noop-driver.module.spec.ts

@@ -0,0 +1,9 @@
+import { expectNgModuleToBeGuarded } from '../expect-ng-module-to-be-guarded';
+
+import { NoopDriverModule } from './noop-driver.module';
+
+describe(NoopDriverModule.name, () => {
+  it('is guarded against direct import', () => {
+    expectNgModuleToBeGuarded(NoopDriverModule);
+  });
+});

projects/internal/test-util/src/lib/noop-driver/noop-driver.module.ts

@@ -0,0 +1,21 @@
+import { ModuleWithProviders, NgModule } from '@angular/core';
+
+import { NoopDriverRootModule } from './noop-driver-root.module';
+
+/**
+ * Service module for `NoopDriver`.
+ *
+ * Use `NoopDriverModule.forRoot` to import.
+ */
+@NgModule()
+export class NoopDriverModule {
+  static forRoot(): ModuleWithProviders<NoopDriverRootModule> {
+    return {
+      ngModule: NoopDriverRootModule,
+    };
+  }
+
+  constructor() {
+    throw new Error('Do not import NoopDriverModule directly. Use NoopDriverModule.forRoot.');
+  }
+}

projects/internal/test-util/src/lib/noop-driver/noop-driver.service.ts

@@ -0,0 +1,21 @@
+import { Inject, Injectable, ModuleWithProviders, NgModule, Optional, SkipSelf } from '@angular/core';
+
+import {
+  defaultLogDriverConfig,
+  LogDriver,
+  LogDriverConfig,
+  LogDriverConfigToken,
+  LogDriverToken,
+} from '@ngworker/lumberjack';
+
+/**
+ * No-op log driver.
+ */
+@Injectable()
+export class NoopDriver implements LogDriver {
+  constructor(@Inject(LogDriverConfigToken) public config: LogDriverConfig) {}
+  logInfo(logEntry: string): void {}
+  logDebug(logEntry: string): void {}
+  logError(logEntry: string): void {}
+  logWarning(logEntry: string): void {}
+}

projects/ngworker/lumberjack/tests/resolve-dependency.ts → projects/internal/test-util/src/lib/resolve-dependency.ts

@@ -3,6 +3,12 @@ import { TestBed } from '@angular/core/testing';
 
 const inject: Function = (TestBed as any).inject || (TestBed as any).get;
 
+/**
+ * Resolve dependency from `TestBed`.
+ *
+ * Wrapper that prefers `TestBed.inject` over `TestBed.get`. Enables support for
+ * Angular versions 8 and earlier.
+ */
 export function resolveDependency<T>(
   token: Type<T> | InjectionToken<T> | AbstractType<T>,
   notFoundValue?: T,

projects/internal/test-util/src/public_api.ts

@@ -0,0 +1,8 @@
+/*
+ * Public API Surface of test-util
+ */
+
+export * from './lib/expect-ng-module-to-be-guarded';
+export * from './lib/noop-driver/noop-driver.module';
+export * from './lib/noop-driver/noop-driver.service';
+export * from './lib/resolve-dependency';

projects/internal/test-util/src/test.ts

@@ -0,0 +1,24 @@
+// This file is required by karma.conf.js and loads recursively all the .spec and framework files
+
+import { getTestBed } from '@angular/core/testing';
+import { BrowserDynamicTestingModule, platformBrowserDynamicTesting } from '@angular/platform-browser-dynamic/testing';
+import 'zone.js/dist/zone';
+import 'zone.js/dist/zone-testing';
+
+declare const require: {
+  context(
+    path: string,
+    deep?: boolean,
+    filter?: RegExp
+  ): {
+    keys(): string[];
+    <T>(id: string): T;
+  };
+};
+
+// First, initialize the Angular testing environment.
+getTestBed().initTestEnvironment(BrowserDynamicTestingModule, platformBrowserDynamicTesting());
+// Then we find all the tests.
+const context = require.context('./', true, /\.spec\.ts$/);
+// And load the modules.
+context.keys().map(context);

projects/internal/test-util/tsconfig.lib.json

@@ -0,0 +1,18 @@
+/* To learn more about this file see: https://angular.io/config/tsconfig. */
+{
+  "extends": "../../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../out-tsc/lib",
+    "target": "es2015",
+    "declaration": true,
+    "inlineSources": true,
+    "types": [],
+    "lib": ["dom", "es2018"]
+  },
+  "angularCompilerOptions": {
+    "skipTemplateCodegen": true,
+    "strictMetadataEmit": true,
+    "enableResourceInlining": true
+  },
+  "exclude": ["src/test.ts", "**/*.spec.ts"]
+}

projects/internal/test-util/tsconfig.spec.json

@@ -0,0 +1,10 @@
+/* To learn more about this file see: https://angular.io/config/tsconfig. */
+{
+  "extends": "../../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../out-tsc/spec",
+    "types": ["jasmine"]
+  },
+  "files": ["src/test.ts"],
+  "include": ["**/*.spec.ts", "**/*.d.ts"]
+}

projects/internal/test-util/tslint.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../../tslint.json",
+  "rules": {
+    "directive-selector": [true, "attribute", "lib", "camelCase"],
+    "component-selector": [true, "element", "lib", "kebab-case"]
+  }
+}

projects/ngworker/lumberjack/console-driver/src/console-driver.module.spec.ts

@@ -1,5 +1,6 @@
 import { TestBed } from '@angular/core/testing';
 
+import { expectNgModuleToBeGuarded, resolveDependency } from '@internal/test-util';
 import {
   defaultLogDriverConfig,
   LogDriver,
@@ -9,8 +10,6 @@ import {
   LumberjackModule,
 } from '@ngworker/lumberjack';
 
-import { expectNgModuleToBeGuarded, resolveDependency } from '../../tests';
-
 import { ConsoleDriverModule } from './console-driver.module';
 import { ConsoleDriver } from './console.driver';
 

projects/ngworker/lumberjack/http-driver/src/http-driver.module.spec.ts

@@ -1,5 +1,6 @@
 import { TestBed } from '@angular/core/testing';
 
+import { expectNgModuleToBeGuarded, resolveDependency } from '@internal/test-util';
 import {
   defaultLogDriverConfig,
   LogDriver,
@@ -8,8 +9,6 @@ import {
   LumberjackModule,
 } from '@ngworker/lumberjack';
 
-import { expectNgModuleToBeGuarded, resolveDependency } from '../../tests';
-
 import { HttpDriverConfig } from './http-driver.config';
 import { HttpDriverModule } from './http-driver.module';
 import { HttpDriver } from './http.driver';

projects/ngworker/lumberjack/src/lib/lumberjack.module.spec.ts

@@ -1,6 +1,6 @@
 import { TestBed } from '@angular/core/testing';
 
-import { expectNgModuleToBeGuarded, resolveDependency } from '../../tests';
+import { expectNgModuleToBeGuarded, resolveDependency } from '@internal/test-util';
 
 import {
   defaultLogConfig,