xunit.ts 0.12.0 → 1.0.1

package/src/Framework/Test.ts

@@ -2,6 +2,20 @@ import TestSuite from "./TestSuite";
 import TestInfo from "./TestInfo";
 import TestName from "./TestName";
 
+/**
+ * Annotates a test method within a {@link TestSuite}
+ * 
+ * @remarks
+ * This instructs `xunit.ts` to run this method as part of its {@link TestSuite}
+ *   
+ * @param test_name (optional) the test's display name; if not set, a sentence case version of the method name will be used
+ * 
+ * @example
+ * ```
+ * @Test()
+ * async UnitTestName() { ... }
+ * ```
+ */
 export default function Test(test_name?: string) {
     return function (suite: TestSuite, method_name: string, info: TestInfo) {
         suite.addTest(test_name || TestName.toSentenceCase(method_name), info);

package/src/Framework/TestSuite.ts

@@ -1,6 +1,15 @@
 import TestInfo from './TestInfo';
 import AssertionLibrary from '../Assertions';
 
+/**
+ * Defines a container of tests
+ * 
+ * @remarks
+ * Extend this class for `xunit.ts` load its tests
+ * 
+ * @example
+ * export default class CustomClassTests extends TestSuite { ... }
+ */
 export default abstract class TestSuite {
     assert = AssertionLibrary;
 

package/src/Reporters/SonarReporter.ts

@@ -3,6 +3,7 @@ import xml from 'xml';
 import {ResultType} from "../Framework/ResultType";
 import TestResult from "../Framework/TestResult";
 import XMLReporter from "./XMLReporter";
+import path from "path";
 
 export default class SonarReporter extends XMLReporter {
     static readonly defaultFileName: string = 'sonar.xml';
@@ -27,7 +28,7 @@ export default class SonarReporter extends XMLReporter {
             file: [
                 {
                     _attr: {
-                        path: file.replace(/^dist\//, '').replace(/\.js$/, '.ts'),
+                        path: file.substr(file.split(path.sep)[0].length + 1).replace(/\.js$/, '.ts'),
                     }
                 },
                 ...Object.keys(results.results)

package/src/Runners/Runner.ts

@@ -6,7 +6,7 @@ import {ResultType} from '../Framework/ResultType';
 
 export default class Runner {
 
-    constructor(private readonly loader: TestSuiteLoader, private readonly runner: TestSuiteRunner, private readonly reporters: ResultReporter[]) {
+    constructor(private readonly loader: TestSuiteLoader, private readonly runner: TestSuiteRunner, private readonly reporters: ReadonlyArray<ResultReporter>) {
     }
 
     async runAll(dir: string): Promise<Record<string, TestSuiteResults>> {

package/src/Runners/TestRunner.ts

@@ -7,7 +7,7 @@ import {AssertionError} from "assert";
 
 export default class TestRunner {
 
-    constructor(private readonly reporters: ResultReporter[]) { }
+    constructor(private readonly reporters: ReadonlyArray<ResultReporter>) { }
 
     async runTest(name: string, info: TestInfo, suite: TestSuite): Promise<TestResult> {
         await Promise.all(this.reporters.map(r => r.testStarted(suite, name)));
@@ -25,13 +25,14 @@ export default class TestRunner {
 
         } catch (error) {
             const duration = TestRunner.msSince(start);
-            if (error instanceof AssertionError) {
-                await Promise.all(this.reporters.map(r => r.testFailed(suite, name, error, duration)));
-                return new TestResult(ResultType.Failed, duration, error);
+            const typedError = error as Error;
+            if (typedError instanceof AssertionError) {
+                await Promise.all(this.reporters.map(r => r.testFailed(suite, name, typedError, duration)));
+                return new TestResult(ResultType.Failed, duration, typedError);
             }
 
-            await Promise.all(this.reporters.map(r => r.testErrored(suite, name, error, duration)));
-            return new TestResult(ResultType.Error, duration, error);
+            await Promise.all(this.reporters.map(r => r.testErrored(suite, name, typedError, duration)));
+            return new TestResult(ResultType.Error, duration, typedError);
         }
     }
 

package/src/Runners/TestSuiteRunner.ts

@@ -6,7 +6,7 @@ import TestRunner from './TestRunner';
 
 export default class TestSuiteRunner {
 
-    constructor(private readonly runner: TestRunner, private readonly reporters: ResultReporter[]) { }
+    constructor(private readonly runner: TestRunner, private readonly reporters: ReadonlyArray<ResultReporter>) { }
 
     async runSuite(suite: TestSuite) {
         await Promise.all(this.reporters.map(r => r.suiteStarted(suite)));

package/tsconfig.json

@@ -13,11 +13,13 @@
   },
   "files": [
     "xunit.ts",
-    "cli.ts"
+    "cli.ts",
+    "tsdoc.ts"
   ],
   "include": [
     "src/**/*.ts",
-    "tests/**/*.ts"
+    "tests/**/*.ts",
+    "TSDoc/**/*.ts"
   ],
   "exclude": [
     "node_modules",

package/dist/src/Assertions/NotContains.d.ts

@@ -1,2 +0,0 @@
-export default function NotContains<T>(needle: T, haystack: T[], message?: string): void;
-//# sourceMappingURL=NotContains.d.ts.map

package/dist/src/Assertions/NotContains.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NotContains.d.ts","sourceRoot":"","sources":["../../../src/Assertions/NotContains.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,QAUhF"}

package/dist/src/Assertions/NotContains.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const assert_1 = require("assert");
-function NotContains(needle, haystack, message) {
-    if (!haystack.includes(needle)) {
-        return;
-    }
-    throw new assert_1.AssertionError({
-        message: message || 'Expected array not containing expression, but array contained expression',
-        expected: needle,
-        actual: haystack
-    });
-}
-exports.default = NotContains;
-//# sourceMappingURL=NotContains.js.map

package/dist/src/Assertions/NotContains.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"NotContains.js","sourceRoot":"","sources":["../../../src/Assertions/NotContains.ts"],"names":[],"mappings":";;AAAA,mCAAwC;AAExC,SAAwB,WAAW,CAAI,MAAS,EAAE,QAAa,EAAE,OAAgB;IAC7E,IAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QAC3B,OAAO;KACV;IAED,MAAM,IAAI,uBAAc,CAAC;QACrB,OAAO,EAAE,OAAO,IAAI,0EAA0E;QAC9F,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE,QAAQ;KACnB,CAAC,CAAC;AACP,CAAC;AAVD,8BAUC"}

package/dist/src/Assertions/StringNotContains.d.ts

@@ -1,2 +0,0 @@
-export default function StringNotContains(needle: string, haystack: string | null, message?: string): void;
-//# sourceMappingURL=StringNotContains.d.ts.map

package/dist/src/Assertions/StringNotContains.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StringNotContains.d.ts","sourceRoot":"","sources":["../../../src/Assertions/StringNotContains.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAC,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,QAUhG"}

package/dist/src/Assertions/StringNotContains.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const assert_1 = require("assert");
-function StringNotContains(needle, haystack, message) {
-    if (haystack === undefined || haystack === null || haystack.indexOf(needle) === -1) {
-        return;
-    }
-    throw new assert_1.AssertionError({
-        message: message || 'Expected string not containing expression, but string did contain expression',
-        expected: needle,
-        actual: haystack
-    });
-}
-exports.default = StringNotContains;
-//# sourceMappingURL=StringNotContains.js.map

package/dist/src/Assertions/StringNotContains.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"StringNotContains.js","sourceRoot":"","sources":["../../../src/Assertions/StringNotContains.ts"],"names":[],"mappings":";;AAAA,mCAAwC;AAExC,SAAwB,iBAAiB,CAAC,MAAc,EAAE,QAAqB,EAAE,OAAgB;IAC7F,IAAG,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE;QAC/E,OAAO;KACV;IAED,MAAM,IAAI,uBAAc,CAAC;QACrB,OAAO,EAAE,OAAO,IAAI,8EAA8E;QAClG,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE,QAAQ;KACnB,CAAC,CAAC;AACP,CAAC;AAVD,oCAUC"}

package/dist/src/Assertions/StringNotEndsWith.d.ts

@@ -1,2 +0,0 @@
-export default function StringNotEndsWith(needle: string, haystack: string | null, message?: string): void;
-//# sourceMappingURL=StringNotEndsWith.d.ts.map

package/dist/src/Assertions/StringNotEndsWith.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StringNotEndsWith.d.ts","sourceRoot":"","sources":["../../../src/Assertions/StringNotEndsWith.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAC,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,QAUhG"}

package/dist/src/Assertions/StringNotEndsWith.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const assert_1 = require("assert");
-function StringNotEndsWith(needle, haystack, message) {
-    if (haystack === undefined || haystack === null || haystack.indexOf(needle) !== haystack.length - needle.length) {
-        return;
-    }
-    throw new assert_1.AssertionError({
-        message: message || 'Expected string containing expression, but string did not contain expression',
-        expected: needle,
-        actual: haystack
-    });
-}
-exports.default = StringNotEndsWith;
-//# sourceMappingURL=StringNotEndsWith.js.map

package/dist/src/Assertions/StringNotEndsWith.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"StringNotEndsWith.js","sourceRoot":"","sources":["../../../src/Assertions/StringNotEndsWith.ts"],"names":[],"mappings":";;AAAA,mCAAwC;AAExC,SAAwB,iBAAiB,CAAC,MAAc,EAAE,QAAqB,EAAE,OAAgB;IAC7F,IAAG,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE;QAC5G,OAAO;KACV;IAED,MAAM,IAAI,uBAAc,CAAC;QACrB,OAAO,EAAE,OAAO,IAAI,8EAA8E;QAClG,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE,QAAQ;KACnB,CAAC,CAAC;AACP,CAAC;AAVD,oCAUC"}

package/dist/src/Assertions/StringNotStartsWith.d.ts

@@ -1,2 +0,0 @@
-export default function StringNotStartsWith(needle: string, haystack: string | null, message?: string): void;
-//# sourceMappingURL=StringNotStartsWith.d.ts.map

package/dist/src/Assertions/StringNotStartsWith.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StringNotStartsWith.d.ts","sourceRoot":"","sources":["../../../src/Assertions/StringNotStartsWith.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAC,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,QAUlG"}

package/dist/src/Assertions/StringNotStartsWith.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const assert_1 = require("assert");
-function StringNotStartsWith(needle, haystack, message) {
-    if (haystack === undefined || haystack === null || haystack.indexOf(needle) !== 0) {
-        return;
-    }
-    throw new assert_1.AssertionError({
-        message: message || 'Expected string containing expression, but string did not contain expression',
-        expected: needle,
-        actual: haystack
-    });
-}
-exports.default = StringNotStartsWith;
-//# sourceMappingURL=StringNotStartsWith.js.map

package/dist/src/Assertions/StringNotStartsWith.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"StringNotStartsWith.js","sourceRoot":"","sources":["../../../src/Assertions/StringNotStartsWith.ts"],"names":[],"mappings":";;AAAA,mCAAwC;AAExC,SAAwB,mBAAmB,CAAC,MAAc,EAAE,QAAqB,EAAE,OAAgB;IAC/F,IAAG,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;QAC9E,OAAO;KACV;IAED,MAAM,IAAI,uBAAc,CAAC;QACrB,OAAO,EAAE,OAAO,IAAI,8EAA8E;QAClG,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE,QAAQ;KACnB,CAAC,CAAC;AACP,CAAC;AAVD,sCAUC"}

package/src/Assertions/NotContains.ts

@@ -1,13 +0,0 @@
-import { AssertionError } from "assert";
-
-export default function NotContains<T>(needle: T, haystack: T[], message?: string) {
-    if(!haystack.includes(needle)) {
-        return;
-    }
-
-    throw new AssertionError({
-        message: message || 'Expected array not containing expression, but array contained expression',
-        expected: needle,
-        actual: haystack
-    });
-}

package/src/Assertions/StringNotContains.ts

@@ -1,13 +0,0 @@
-import { AssertionError } from "assert";
-
-export default function StringNotContains(needle: string, haystack: string|null, message?: string) {
-    if(haystack === undefined || haystack === null || haystack.indexOf(needle) === -1) {
-        return;
-    }
-
-    throw new AssertionError({
-        message: message || 'Expected string not containing expression, but string did contain expression',
-        expected: needle,
-        actual: haystack
-    });
-}

package/src/Assertions/StringNotEndsWith.ts

@@ -1,13 +0,0 @@
-import { AssertionError } from "assert";
-
-export default function StringNotEndsWith(needle: string, haystack: string|null, message?: string) {
-    if(haystack === undefined || haystack === null || haystack.indexOf(needle) !== haystack.length - needle.length) {
-        return;
-    }
-
-    throw new AssertionError({
-        message: message || 'Expected string containing expression, but string did not contain expression',
-        expected: needle,
-        actual: haystack
-    });
-}

package/src/Assertions/StringNotStartsWith.ts

@@ -1,13 +0,0 @@
-import { AssertionError } from "assert";
-
-export default function StringNotStartsWith(needle: string, haystack: string|null, message?: string) {
-    if(haystack === undefined || haystack === null || haystack.indexOf(needle) !== 0) {
-        return;
-    }
-
-    throw new AssertionError({
-        message: message || 'Expected string containing expression, but string did not contain expression',
-        expected: needle,
-        actual: haystack
-    });
-}