refactor(migrator): migrator inherits from umzug, add test cases

closes #4

Author: floydspace

package-lock.json

@@ -59,6 +59,7 @@
     "eslint": "^6.8.0",
     "husky": "^4.2.5",
     "jest": "^25.1.0",
+    "mockdate": "^2.0.5",
     "semantic-release": "^17.0.7",
     "ts-jest": "^25.5.0",
     "typescript": "^3.8.3"

package.json

@@ -4,7 +4,7 @@ import { BaseCliOptions, baseHandler, baseOptions } from '../core/yargs';
 import logger from '../helpers/logger';
 
 interface CliOptions extends BaseCliOptions {
-  to?: string | number;
+  to: string | 0;
 }
 
 export default {

src/commands/migrate-undo-all.ts

@@ -5,8 +5,8 @@ import { BaseCliOptions, baseHandler, baseOptions } from '../core/yargs';
 import logger from '../helpers/logger';
 
 interface CliOptions extends BaseCliOptions {
-  to?: string;
-  from?: string;
+  to: string;
+  from: string;
 }
 
 export default {

src/commands/migrate.ts

@@ -1,5 +1,5 @@
 import { DocumentClient } from 'aws-sdk/clients/dynamodb';
-import nodePlop from 'node-plop/lib/node-plop';
+import nodePlop from 'node-plop';
 import path from 'path';
 import { pick } from 'ramda';
 import Umzug from 'umzug';
@@ -19,8 +19,11 @@ export interface MigratorOptions {
   attributeName?: string;
 }
 
-export class Migrator {
-  private umzug: Umzug.Umzug;
+interface Generator {
+  generate(migrationName: string): Promise<void>;
+}
+
+export class Migrator extends Umzug implements Generator {
   private generator;
 
   /**
@@ -38,7 +41,7 @@ export class Migrator {
     tableName = tableName || 'migrations';
     attributeName = attributeName || 'name';
 
-    this.umzug = new Umzug({
+    super({
       storage: new DynamoDBStorage({ dynamodb, tableName, attributeName }),
       migrations: {
         params: [dynamodb],
@@ -53,26 +56,6 @@ export class Migrator {
   async generate(migrationName: string) {
     await this.generator.runActions({timestamp: getCurrentYYYYMMDDHHmms(), name: migrationName});
   }
-
-  execute(options?: Umzug.ExecuteOptions) {
-    return this.umzug.execute(options);
-  }
-
-  pending() {
-    return this.umzug.pending();
-  }
-
-  executed() {
-    return this.umzug.executed();
-  }
-
-  up(options?) {
-    return this.umzug.up(options);
-  }
-
-  down(options?) {
-    return this.umzug.down(options);
-  }
 }
 
 /**

src/core/migrator.ts

@@ -1,16 +1,40 @@
+const runActions = jest.fn();
+const getGenerator = jest.fn().mockReturnValue({ runActions });
+const nodePlop = jest.fn().mockReturnValue({ getGenerator });
+jest.mock('node-plop', () => ({ __esModule: true, default: nodePlop }));
+
 import * as AWS from 'aws-sdk';
 import * as AWSMock from 'aws-sdk-mock';
+import mockdate from 'mockdate';
 
 import { Migrator } from '../../src/core/migrator';
 
 describe('Migrator tests', () => {
   beforeAll((done) => {
     AWSMock.setSDKInstance(AWS);
+    mockdate.set(Date.UTC(2020, 4, 11));
     done();
   });
 
   it('Should not migrator factory be thrown', async () => {
     const factory = () => new Migrator();
     expect(factory).not.toThrow();
   });
+
+  it('Should run generator action', async () => {
+    const migrator = new Migrator();
+
+    await migrator.generate('test');
+
+    expect(nodePlop).toBeCalled();
+    expect(getGenerator).toBeCalled();
+    expect(getGenerator).toBeCalledWith('migration');
+    expect(runActions).toBeCalledTimes(1);
+    expect(runActions).toBeCalledWith({timestamp: '20200511000000', name: 'test'});
+  });
+
+  afterAll((done) => {
+    mockdate.reset();
+    done();
+  });
 });