refactor: schematics cleanup & increase test coverage (#91)

wesleygrimes · web-flow · commit 81bb374137ab · 2019-09-28T19:16:37.000-04:00
* refactor: schematics cleanup

* tests: increase test coverage
diff --git a/.gitignore b/.gitignore
@@ -16,9 +16,11 @@ npm-debug.log
 /.nyc_output
 
 # dist
-dist
-node_modules
+/dist
 
 # schematics
-schematics/**/*.js
-schematics/**/*.d.ts
+/schematics/**/*.js
+/schematics/**/*.d.ts
+
+# jest snapshots
+__snapshots__/
diff --git a/jest.config.js b/jest.config.js
@@ -0,0 +1,23 @@
+module.exports = {
+  moduleFileExtensions: ['js', 'json', 'ts'],
+  rootDir: '.',
+  testEnvironment: 'node',
+  testMatch: ['**/+(*.)+(spec|test).+(ts|js)?(x)'],
+  transform: {
+    '^.+\\.(ts|js|html)$': 'ts-jest',
+  },
+  collectCoverage: true,
+  collectCoverageFrom: [
+    '<rootDir>/lib/**/*.ts',
+    '!<rootDir>/lib/index.ts',
+    '!<rootDir>/schematics/**/*.ts',
+  ],
+  coverageThreshold: {
+    global: {
+      statements: 80,
+      branches: 80,
+      functions: 80,
+      lines: 80,
+    },
+  },
+};
diff --git a/jest.json b/jest.json
diff --git a/lib/common/in-memory-db.decorators.spec.ts b/lib/common/in-memory-db.decorators.spec.ts
@@ -0,0 +1,9 @@
+import { Inject } from '@nestjs/common';
+import { InjectInMemoryDBService } from './in-memory-db.decorators';
+
+describe('InjectInMemoryDBService', () => {
+  // TODO: Implement test of decorator
+  it('should', () => {
+    InjectInMemoryDBService('feature');
+  });
+});
diff --git a/lib/in-memory-db.module.spec.ts b/lib/in-memory-db.module.spec.ts
@@ -0,0 +1,49 @@
+import { Test } from '@nestjs/testing';
+import { InMemoryDBModule } from './in-memory-db.module';
+
+describe('InMemoryDBModule', () => {
+  describe('forRoot', () => {
+    beforeEach(async () => {
+      await Test.createTestingModule({
+        imports: [InMemoryDBModule.forRoot({})],
+      }).compile();
+    });
+
+    it('should create', () => {
+      expect(InMemoryDBModule).toBeDefined();
+    });
+  });
+  describe('forRoot - no object', () => {
+    beforeEach(async () => {
+      await Test.createTestingModule({
+        imports: [InMemoryDBModule.forRoot()],
+      }).compile();
+    });
+
+    it('should create', () => {
+      expect(InMemoryDBModule).toBeDefined();
+    });
+  });
+  describe('forFeature', () => {
+    beforeEach(async () => {
+      await Test.createTestingModule({
+        imports: [InMemoryDBModule.forFeature('feature', {})],
+      }).compile();
+    });
+
+    it('should create', () => {
+      expect(InMemoryDBModule).toBeDefined();
+    });
+  });
+  describe('forFeature - no object', () => {
+    beforeEach(async () => {
+      await Test.createTestingModule({
+        imports: [InMemoryDBModule.forFeature('feature')],
+      }).compile();
+    });
+
+    it('should create', () => {
+      expect(InMemoryDBModule).toBeDefined();
+    });
+  });
+});
diff --git a/lib/providers/in-memory-db-for-feature.providers.ts b/lib/providers/in-memory-db-for-feature.providers.ts
@@ -5,7 +5,7 @@ import { FactoryProvider } from '@nestjs/common/interfaces';
 
 export function createInMemoryDBForFeatureProviders(
   featureName: string,
-  featureConfig: Partial<InMemoryDBConfig> = {},
+  featureConfig: Partial<InMemoryDBConfig>,
 ) {
   const providers: FactoryProvider[] = [
     {
diff --git a/lib/providers/in-memory-db-for-root.providers.ts b/lib/providers/in-memory-db-for-root.providers.ts
@@ -5,7 +5,7 @@ import { getInMemoryDBServiceToken } from '../common';
 import { InMemoryDBConfig } from '../interfaces';
 
 export function createInMemoryDBForRootProviders(
-  featureConfig: Partial<InMemoryDBConfig> = {},
+  featureConfig: Partial<InMemoryDBConfig>,
 ) {
   const providers: FactoryProvider[] = [
     {
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -7,20 +7,22 @@
   "repository": "https://github.com/nestjs-addons/in-memory-db",
   "schematics": "./dist/schematics/collection.json",
   "scripts": {
-    "build": "tsc -p tsconfig.json && npm run build:schematics",
+    "build": "npm run build:lib && npm run build:schematics",
     "build:dev": "tsc-watch -p tsconfig.json",
+    "build:lib": "tsc -p tsconfig.json",
     "build:schematics": "tsc -p tsconfig.schematics.json && npm run copy:files",
     "copy:files": "copyfiles schematics/collection.json schematics/nest-add/schema.json dist",
     "watch:schematics": "npm link && npm run build:schematics -- --watch",
     "format": "prettier lib/**/*.ts --write",
     "format:verify": "prettier lib/**/*.ts --check",
     "lint": "npx tslint -p tsconfig.json -c tslint.json \"lib/**/*.ts\" -e \"*.spec.ts\" --force",
-    "test": "jest --config jest.json",
+    "test": "jest",
     "semantic-release": "semantic-release"
   },
   "devDependencies": {
     "@nestjs/common": "6.7.2",
     "@nestjs/core": "6.7.2",
+    "@nestjs/testing": "6.7.2",
     "rxjs": "6.5.3",
     "@semantic-release/changelog": "3.0.4",
     "@types/jest": "24.0.18",
diff --git a/schematics/collection.json b/schematics/collection.json
@@ -1,10 +1,10 @@
 {
-    "$schema": "../node_modules/@angular-devkit/schematics/collection-schema.json",
-    "schematics": {
-      "nest-add": {
-        "description": "Schematics to add In memory DB module.",
-        "factory": "./nest-add/",
-        "schema": "./nest-add/schema.json"
-      }
+  "$schema": "../node_modules/@angular-devkit/schematics/collection-schema.json",
+  "schematics": {
+    "nest-add": {
+      "description": "Schematics to add In-Memory DB Module.",
+      "factory": "./nest-add",
+      "schema": "./nest-add/schema.json"
     }
   }
+}
diff --git a/schematics/mocks.ts b/schematics/mocks.ts
@@ -0,0 +1,23 @@
+export const mockMain = `
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+  await app.listen(3000);
+}
+bootstrap();
+`;
+
+export const mockAppModule = `
+import { Module } from '@nestjs/common';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+@Module({
+  imports: [],
+  controllers: [AppController],
+  providers: [AppService],
+})
+export class AppModule {}
+`;
diff --git a/schematics/nest-add/add.schema.d.ts b/schematics/nest-add/add.schema.d.ts
diff --git a/schematics/nest-add/index.spec.ts b/schematics/nest-add/index.spec.ts
@@ -1,56 +1,36 @@
-import { normalize } from '@angular-devkit/core';
+import { HostTree } from '@angular-devkit/schematics';
 import {
-    SchematicTestRunner,
-    UnitTestTree,
+  SchematicTestRunner,
+  UnitTestTree,
 } from '@angular-devkit/schematics/testing';
 import * as path from 'path';
-import { HostTree } from '@angular-devkit/schematics';
+import { mockAppModule, mockMain } from '../mocks';
 
 const collectionPath = path.join(__dirname, '../collection.json');
 
-const MAIN_FILE = `
-import { NestFactory } from '@nestjs/core';
-import { AppModule } from './app.module';
-
-async function bootstrap() {
-  const app = await NestFactory.create(AppModule);
-  await app.listen(3000);
-}
-bootstrap();
-`;
-
-const APP_MODULE_CONTENT = `
-import { Module } from '@nestjs/common';
-import { AppController } from './app.controller';
-import { AppService } from './app.service';
-
-@Module({
-  imports: [],
-  controllers: [AppController],
-  providers: [AppService],
-})
-export class AppModule {}
-`;
+describe('nest add function', () => {
+  let tree: UnitTestTree;
+  let runner: SchematicTestRunner;
 
+  beforeEach(() => {
+    tree = new UnitTestTree(new HostTree());
+    tree.create('/package.json', JSON.stringify({}));
+    tree.create(
+      '/nest-cli.json',
+      JSON.stringify({
+        language: 'ts',
+        collection: '@nestjs/schematics',
+        sourceRoot: 'src',
+      }),
+    );
+    tree.create('/src/main.ts', mockMain);
+    tree.create('/src/app.module.ts', mockAppModule);
+    runner = new SchematicTestRunner('schematics', collectionPath);
+  });
 
-describe('nest add function', () => {
-    let tree: UnitTestTree;
-    let runner: SchematicTestRunner;
-    beforeEach(() => {
-        tree = new UnitTestTree(new HostTree());
-        tree.create('/package.json', JSON.stringify({}));
-        tree.create('/nest-cli.json', JSON.stringify({
-            "language": "ts",
-            "collection": "@nestjs/schematics",
-            "sourceRoot": "src"
-        }));
-        tree.create('/src/main.ts', MAIN_FILE);
-        tree.create('/src/app.module.ts', APP_MODULE_CONTENT);
-        runner = new SchematicTestRunner('schematics', collectionPath);
-    })
-    it('should add package to module', () => {
-        const ngAddTree = runner.runSchematic('nest-add', '', tree);
-        const module = ngAddTree.readContent('/src/app.module.ts');
-        expect(module).toMatchSnapshot();
-    });
-})
+  it('should add package to module', () => {
+    const ngAddTree = runner.runSchematic('nest-add', '', tree);
+    const module = ngAddTree.readContent('/src/app.module.ts');
+    expect(module).toMatchSnapshot();
+  });
+});
diff --git a/schematics/nest-add/index.ts b/schematics/nest-add/index.ts
@@ -1,23 +1,16 @@
+import { JsonParseMode, parseJson, Path } from '@angular-devkit/core';
 import {
+  branchAndMerge,
+  chain,
   Rule,
-  SchematicContext,
   SchematicsException,
   Tree,
-  chain,
-  branchAndMerge,
 } from '@angular-devkit/schematics';
-import { JsonParseMode, parseJson, Path } from '@angular-devkit/core';
-import {
-  addPackageJsonDependency,
-  NodeDependency,
-  NodeDependencyType,
-} from 'schematics-utilities';
-import { NgAddOptions } from './add.schema';
-import { ModuleFinder } from '../utils/module.finder';
 import * as ts from 'typescript';
 import { addImportToModule, insertImport } from '../utils/ast-utils';
 import { InsertChange } from '../utils/change';
-
+import { ModuleFinder } from '../utils/module.finder';
+import { NestAddOptions } from './schema';
 
 function getWorkspace(tree: Tree): { path: string; workspace: any } {
   const possibleFiles = ['/nest-cli.json'];
@@ -42,22 +35,23 @@ function getWorkspace(tree: Tree): { path: string; workspace: any } {
   };
 }
 
-function addDeclarationToModule(options: NgAddOptions): Rule {
+function addDeclarationToModule(options: NestAddOptions): Rule {
   return (tree: Tree) => {
-
     if (options.skipImport !== undefined && options.skipImport) {
       return tree;
     }
 
-    const { path, workspace } = getWorkspace(tree);
+    const { workspace } = getWorkspace(tree);
 
     options.module = new ModuleFinder(tree).find({
       name: options.module ? options.module : 'app',
       path: ('./' + workspace.sourceRoot) as Path,
     });
 
     if (!tree.exists(options.module)) {
-      throw new SchematicsException(`Could not find root module, please use --module flag to specify the root module path.`);
+      throw new SchematicsException(
+        `Could not find root module, please use --module flag to specify the root module path.`,
+      );
     }
 
     const content = tree.read(options.module).toString();
@@ -102,10 +96,6 @@ function addDeclarationToModule(options: NgAddOptions): Rule {
   };
 }
 
-export default function (options: NgAddOptions): Rule {
-  return branchAndMerge(
-    chain([
-      addDeclarationToModule(options)
-    ]),
-  );
+export default function(options: NestAddOptions): Rule {
+  return branchAndMerge(chain([addDeclarationToModule(options)]));
 }
diff --git a/schematics/nest-add/schema.ts b/schematics/nest-add/schema.ts
@@ -0,0 +1,11 @@
+export interface NestAddOptions {
+  /**
+   * Skip import parameter
+   */
+  skipImport?: boolean;
+
+  /**
+   * The path to insert the module import.
+   */
+  module?: string;
+}

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import { FactoryProvider } from '@nestjs/common/interfaces';`
`5`	`5`
`6`	`6`	`export function createInMemoryDBForFeatureProviders(`
`7`	`7`	`featureName: string,`
`8`		`- featureConfig: Partial<InMemoryDBConfig> = {},`
	`8`	`+ featureConfig: Partial<InMemoryDBConfig>,`
`9`	`9`	`) {`
`10`	`10`	`const providers: FactoryProvider[] = [`
`11`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import { getInMemoryDBServiceToken } from '../common';`
`5`	`5`	`import { InMemoryDBConfig } from '../interfaces';`
`6`	`6`
`7`	`7`	`export function createInMemoryDBForRootProviders(`
`8`		`- featureConfig: Partial<InMemoryDBConfig> = {},`
	`8`	`+ featureConfig: Partial<InMemoryDBConfig>,`
`9`	`9`	`) {`
`10`	`10`	`const providers: FactoryProvider[] = [`
`11`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`	`1`	`{`
`2`		`- "$schema": "../node_modules/@angular-devkit/schematics/collection-schema.json",`
`3`		`- "schematics": {`
`4`		`- "nest-add": {`
`5`		`- "description": "Schematics to add In memory DB module.",`
`6`		`- "factory": "./nest-add/",`
`7`		`- "schema": "./nest-add/schema.json"`
`8`		`- }`
	`2`	`+ "$schema": "../node_modules/@angular-devkit/schematics/collection-schema.json",`
	`3`	`+ "schematics": {`
	`4`	`+ "nest-add": {`
	`5`	`+ "description": "Schematics to add In-Memory DB Module.",`
	`6`	`+ "factory": "./nest-add",`
	`7`	`+ "schema": "./nest-add/schema.json"`
`9`	`8`	`}`
`10`	`9`	`}`
	`10`	`+}`