Merge pull request #59 from stbestichhh/feature/timeout

Feature/timeout

Author: stbestichhh

bin/runner/test.runner.ts

@@ -14,6 +14,7 @@ import { Cli } from '../cli';
 import { Config } from '../config';
 import { MockRegistry } from '../../lib';
 import { isTable } from '../../utils';
+import { TimeoutException } from '../../lib/exceptions';
 
 export class TestRunner {
   private static isAllPassed: boolean = true;
@@ -25,10 +26,14 @@ export class TestRunner {
         await this.runTestSuite(testName, target);
       }
     } finally {
-      if (!this.isAllPassed && !Cli.getOptions('watch')) {
-        exit(1);
-      }
       TestRegistry.clear();
+      process.nextTick(() => {
+        if (!this.isAllPassed && !Cli.getOptions('watch')) {
+          exit(1);
+        } else {
+          exit(0);
+        }
+      });
     }
   }
 
@@ -51,14 +56,15 @@ export class TestRunner {
 
     await this.runLifecycleMethods(testSuite, beforeAll, 'beforeAll');
 
-    for (const { methodName, caseDescription } of testCases) {
+    for (const { methodName, caseDescription, timeout } of testCases) {
       await this.runLifecycleMethods(testSuite, beforeEach, 'beforeEach');
       await this.runTestCase(
         testSuite,
         methodName,
         caseDescription,
         dataSetsArray,
         dataTableArray,
+        timeout,
       );
       await this.runLifecycleMethods(testSuite, afterEach, 'afterEach');
       this.clearMocks('afterEach');
@@ -100,6 +106,7 @@ export class TestRunner {
     caseDescription: string,
     dataSetsArray: IDataSet[],
     dataTableArray: IDataTableArray[],
+    timeout: number,
   ) {
     try {
       const { dataTable, dataSets } = this.getCaseData(
@@ -113,9 +120,15 @@ export class TestRunner {
           testSuiteInstance,
           methodName,
           dataTable,
+          timeout,
         );
       } else {
-        await this.runTestCaseWithData(testSuiteInstance, methodName, dataSets);
+        await this.runTestCaseWithData(
+          testSuiteInstance,
+          methodName,
+          dataSets,
+          timeout,
+        );
       }
 
       this.logTestResult(caseDescription || methodName, 'PASSED', 'grey');
@@ -129,28 +142,49 @@ export class TestRunner {
     testSuiteInstance: any,
     methodName: string,
     dataArray: IDataSet[][] | IDataTable[],
+    timeout: number,
   ) {
     if (dataArray.length <= 0) {
-      return await this.getTestResult(testSuiteInstance, methodName, []);
+      return await this.getTestResult(
+        testSuiteInstance,
+        methodName,
+        [],
+        timeout,
+      );
     }
 
     for (const data of dataArray) {
-      await this.getTestResult(testSuiteInstance, methodName, data);
+      await this.getTestResult(testSuiteInstance, methodName, data, timeout);
     }
   }
 
   private static async getTestResult(
     testSuiteInstance: any,
     methodName: string,
     data: IDataSet[] | IDataTable,
+    timeout: number = 5000,
   ) {
-    const result = isTable(data)
-      ? testSuiteInstance[methodName](...data.inputs, data.expected)
-      : testSuiteInstance[methodName](...data);
+    const testPromise = new Promise<void>((resolve, reject) => {
+      const result = isTable(data)
+        ? testSuiteInstance[methodName](...data.inputs, data.expected)
+        : testSuiteInstance[methodName](...data);
 
-    if (result instanceof Promise) {
-      await result;
-    }
+      if (result instanceof Promise) {
+        result.then(resolve).catch(reject);
+      } else {
+        resolve();
+      }
+    });
+
+    const timeoutPromise = new Promise((_, reject) => {
+      setTimeout(
+        reject,
+        timeout,
+        new TimeoutException(`Test timed out in ${timeout}ms`),
+      );
+    });
+
+    await Promise.race([testPromise, timeoutPromise]);
   }
 
   private static getCaseData(

lib/decorators/case.decorator.ts

@@ -1,4 +1,6 @@
-export function Case(caseDescription?: string): MethodDecorator {
+export function Case(
+  options?: string | { description?: string; timeout?: number },
+): MethodDecorator {
   return function (
     target: object,
     key: string | symbol,
@@ -10,9 +12,14 @@ export function Case(caseDescription?: string): MethodDecorator {
       constructor.testCases = [];
     }
 
+    const caseDescription =
+      typeof options === 'string' ? options : options?.description;
+    const timeout = typeof options !== 'string' ? options?.timeout : undefined;
+
     constructor.testCases.push({
       methodName: key,
       caseDescription,
+      timeout,
     });
 
     return descriptor;

lib/exceptions/index.ts

@@ -2,3 +2,4 @@ export * from './assertionException';
 export * from './loadFileException';
 export * from './mockingException';
 export * from './configExceptions';
+export * from './timeoutException';

lib/exceptions/timeoutException.ts

@@ -0,0 +1,6 @@
+export class TimeoutException extends Error {
+  constructor(public readonly message: string) {
+    super(message);
+    this.name = 'TimeoutError';
+  }
+}

lib/interfaces/ITestCase.ts

@@ -1,4 +1,5 @@
 export interface ITestCase {
   readonly methodName: string;
   readonly caseDescription: string;
+  readonly timeout: number;
 }