xunit.ts 1.0.2 → 1.2.0

package/src/Reporters/XMLReporter.ts

@@ -2,10 +2,10 @@
 import TestSuiteResults from "../Framework/TestSuiteResults";
 
 export default abstract class XMLReporter extends FileReporter {
-    async runCompleted(results: Record<string, TestSuiteResults>): Promise<void> {
-        const xmlString = this.xml(results);
-        await this.file_system.save(xmlString, this.path);
-    }
-    
-    abstract xml(results: Record<string, TestSuiteResults>): string;
+	async runCompleted(results: Record<string, TestSuiteResults>): Promise<void> {
+		const xmlString = this.xml(results);
+		await this.file_system.save(xmlString, this.path);
+	}
+
+	abstract xml(results: Record<string, TestSuiteResults>): string;
 }

package/src/Runners/Runner.ts

@@ -1,29 +1,29 @@
-import TestSuiteLoader from './TestSuiteLoader';
-import TestSuiteRunner from './TestSuiteRunner';
+import TestSuiteLoader from "./TestSuiteLoader";
+import TestSuiteRunner from "./TestSuiteRunner";
 import ResultReporter from "../Reporters/ResultReporter";
 import TestSuiteResults from "../Framework/TestSuiteResults";
-import {ResultType} from '../Framework/ResultType';
+import { ResultType } from "../Framework/ResultType";
 
 export default class Runner {
 
-    constructor(private readonly loader: TestSuiteLoader, private readonly runner: TestSuiteRunner, private readonly reporters: ReadonlyArray<ResultReporter>) {
-    }
+	constructor(private readonly loader: TestSuiteLoader, private readonly runner: TestSuiteRunner, private readonly reporters: ReadonlyArray<ResultReporter>) {
+	}
 
-    async runAll(dir: string): Promise<Record<string, TestSuiteResults>> {
-        await Promise.all(this.reporters.map(r => r.runStarted()));
-        const results: Record<string, TestSuiteResults> = {};
-        const suites = await this.loader.loadTestSuites(dir);
-        for (const file of Object.keys(suites)) {
-            const suite = suites[file];
-            results[file] = await this.runner.runSuite(suite);
-        }
-        await Promise.all(this.reporters.map(r => r.runCompleted(results)));
-        return results;
-    }
+	static allTestsPassed(results: Record<string, TestSuiteResults>): boolean {
+		const tests_with_results = Object.values(results).filter(result => result.total() > 0);
+		return tests_with_results.length > 0
+			&& tests_with_results.filter(result => result.count(ResultType.Passed) < result.total()).length === 0;
+	}
 
-    static allTestsPassed(results: Record<string, TestSuiteResults>): boolean {
-        const tests_with_results = Object.values(results).filter(result => result.total() > 0);
-        return tests_with_results.length > 0
-            && tests_with_results.filter(result => result.count(ResultType.Passed) < result.total()).length === 0;
-    }
+	async runAll(dir: string, filters: RegExp[]): Promise<Record<string, TestSuiteResults>> {
+		await Promise.all(this.reporters.map(r => r.runStarted()));
+		const results: Record<string, TestSuiteResults> = {};
+		const suites = await this.loader.loadTestSuites(dir, filters);
+		for (const file of Object.keys(suites)) {
+			const suite = suites[file];
+			results[file] = await this.runner.runSuite(suite, filters);
+		}
+		await Promise.all(this.reporters.map(r => r.runCompleted(results)));
+		return results;
+	}
 }

package/src/Runners/TestRunner.ts

@@ -1,43 +1,44 @@
-import TestInfo from '../Framework/TestInfo';
-import TestSuite from '../Framework/TestSuite';
-import { ResultType } from '../Framework/ResultType';
-import ResultReporter from '../Reporters/ResultReporter';
+import TestInfo from "../Framework/TestInfo";
+import TestSuite from "../Framework/TestSuite";
+import { ResultType } from "../Framework/ResultType";
+import ResultReporter from "../Reporters/ResultReporter";
 import TestResult from "../Framework/TestResult";
-import {AssertionError} from "assert";
+import { AssertionError } from "assert";
 
 export default class TestRunner {
 
-    constructor(private readonly reporters: ReadonlyArray<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)));
-        if (info.value === undefined) {
-            await Promise.all(this.reporters.map(r => r.testIncomplete(suite, name)));
-            return new TestResult(ResultType.Incomplete, 0);
-        }
+	private static msSince(start: [ number, number ]) {
+		const duration = process.hrtime(start);
+		return duration[0] * 1_000 + duration[1] / 1_000_000;
+	}
 
-        const start = process.hrtime();
-        try {
-            await info.value.call(suite);
-            const duration = TestRunner.msSince(start);
-            await Promise.all(this.reporters.map(r => r.testPassed(suite, name, duration)));
-            return new TestResult(ResultType.Passed, duration);
+	async runTest(name: string, info: TestInfo, suite: TestSuite): Promise<TestResult> {
+		await Promise.all(this.reporters.map(r => r.testStarted(suite, name)));
+		if (info.value === undefined) {
+			await Promise.all(this.reporters.map(r => r.testIncomplete(suite, name)));
+			return new TestResult(ResultType.Incomplete, 0);
+		}
 
-        } catch (error) {
-            const duration = TestRunner.msSince(start);
-            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);
-            }
+		const start = process.hrtime();
+		try {
+			await info.value.call(suite);
+			const duration = TestRunner.msSince(start);
+			await Promise.all(this.reporters.map(r => r.testPassed(suite, name, duration)));
+			return new TestResult(ResultType.Passed, duration);
 
-            await Promise.all(this.reporters.map(r => r.testErrored(suite, name, typedError, duration)));
-            return new TestResult(ResultType.Error, duration, typedError);
-        }
-    }
+		} catch (error) {
+			const duration = TestRunner.msSince(start);
+			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);
+			}
 
-    private static msSince(start: [number, number]) {
-        const duration = process.hrtime(start);
-        return duration[0] * 1_000 + duration[1] / 1_000_000;
-    }
+			await Promise.all(this.reporters.map(r => r.testErrored(suite, name, typedError, duration)));
+			return new TestResult(ResultType.Error, duration, typedError);
+		}
+	}
 }

package/src/Runners/TestSuiteLoader.ts

@@ -1,49 +1,55 @@
-import TestSuite from '../Framework/TestSuite';
-import FileSystem from '../IO/FileSystem';
-import path from 'path';
+import TestSuite from "../Framework/TestSuite";
+import FileSystem from "../IO/FileSystem";
+import path from "path";
 
 export default class TestSuiteLoader {
+	constructor(private readonly file_system: FileSystem) {
+	}
 
-    constructor(private readonly file_system: FileSystem) { }
-
-    async loadTestSuites(dir: string): Promise<Record<string, TestSuite>> {
-        const files = (await this.file_system.getFiles(dir))
-            .filter((file) => FileSystem.extension(file) === FileSystem.extension(__filename));
-        const suites: Record<string, TestSuite> = {};
-        for (const file of files) {
-            const suite = await TestSuiteLoader.loadTestSuite(file);
-            if (suite !== undefined && suite !== null) {
-                suites[file] = suite;
-            }
-        }
-        return suites;
-    }
-
-    static async loadTestSuite(file: string) {
-        const module_path = TestSuiteLoader.getModulePath(__dirname, file);
-        const test_class = await import(module_path);
-        if (!(test_class.default.prototype instanceof TestSuite)) {
-            return null;
-        }
-
-        const tests = test_class.default.prototype.getTests();
-        const suite: TestSuite = new test_class.default();
-        suite.setTests(tests);
-        return suite;
-    }
-
-    static getModulePath(current_dir: string, file: string) {
-        const root = TestSuiteLoader.isFromNodeModules(path.resolve(current_dir))
-            ? `..${path.sep}..${path.sep}..${path.sep}..${path.sep}..`
-            : `..${path.sep}..${path.sep}..`;
-        const extension = FileSystem.extension(file);
-        const module_name = extension.length > 0
-            ? file.substr(0, file.length - extension.length - 1)
-            : file;
-        return `${root}${path.sep}${module_name}`;
-    }
-
-    static isFromNodeModules(dir: string) {
-        return dir.indexOf('node_modules') !== -1;
-    }
+	static async loadTestSuite(file: string, filters: RegExp[]) {
+		const module_path = TestSuiteLoader.getModulePath(__dirname, file);
+		const test_class = await import(module_path);
+		if (!(test_class.default?.prototype instanceof TestSuite)) {
+			return null;
+		}
+
+		const tests = test_class.default?.prototype.getTests(filters);
+		if (tests === undefined || Object.keys(tests).length === 0) {
+			return null;
+		}
+
+		const suite: TestSuite = new test_class.default();
+		suite.setTests(tests);
+		return suite;
+	}
+
+	static getModulePath(current_dir: string, file: string) {
+		const root = TestSuiteLoader.isFromNodeModules(path.resolve(current_dir))
+			? `..${path.sep}..${path.sep}..${path.sep}..${path.sep}..`
+			: `..${path.sep}..${path.sep}..`;
+		const extension = FileSystem.extension(file);
+		const module_name = extension.length > 0
+			? file.substring(0, file.length - extension.length - 1)
+			: file;
+		return `${root}${path.sep}${module_name}`;
+	}
+
+	static isFromNodeModules(dir: string) {
+		return dir.indexOf("node_modules") !== -1;
+	}
+
+	async loadTestSuites(dir: string, filters: RegExp[]): Promise<Record<string, TestSuite>> {
+		const suites: Record<string, TestSuite> = {};
+
+		const files = (await this.file_system.getFiles(dir))
+			.filter((file) => FileSystem.extension(file) === FileSystem.extension(__filename));
+
+		for (const file of files) {
+			const suite = await TestSuiteLoader.loadTestSuite(file, filters);
+			if (suite !== undefined && suite !== null) {
+				suites[file] = suite;
+			}
+		}
+		return suites;
+	}
 }

package/src/Runners/TestSuiteRunner.ts

@@ -1,34 +1,35 @@
-import ResultReporter from '../Reporters/ResultReporter';
-import TestSuite from '../Framework/TestSuite';
-import TestSuiteResults from '../Framework/TestSuiteResults';
-import TestInfo from '../Framework/TestInfo';
-import TestRunner from './TestRunner';
+import ResultReporter from "../Reporters/ResultReporter";
+import TestSuite from "../Framework/TestSuite";
+import TestSuiteResults from "../Framework/TestSuiteResults";
+import TestInfo from "../Framework/TestInfo";
+import TestRunner from "./TestRunner";
 
 export default class TestSuiteRunner {
 
-    constructor(private readonly runner: TestRunner, private readonly reporters: ReadonlyArray<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)));
-        const tests = suite.getTests();
-        const results = await this.runTests(suite, tests);
-        await Promise.all(this.reporters.map(r => r.suiteCompleted(suite, results)));
-        return results;
-    }
+	async runSuite(suite: TestSuite, filters: RegExp[]) {
+		await Promise.all(this.reporters.map(r => r.suiteStarted(suite)));
+		const tests = suite.getTests(filters);
+		const results = await this.runTests(suite, tests);
+		await Promise.all(this.reporters.map(r => r.suiteCompleted(suite, results)));
+		return results;
+	}
 
-    async runTests(suite: TestSuite, tests: Record<string, TestInfo>) {
-        const results = new TestSuiteResults(suite);
-        if (tests === undefined || tests === null || Object.keys(tests).length === 0) {
-            await Promise.all(this.reporters.map(r => r.testIncomplete(suite, '(no tests found)')));
-            return results;
-        }
+	async runTests(suite: TestSuite, tests: Record<string, TestInfo>) {
+		const results = new TestSuiteResults(suite);
+		if (tests === undefined || tests === null || Object.keys(tests).length === 0) {
+			await Promise.all(this.reporters.map(r => r.testIncomplete(suite, "(no tests found)")));
+			return results;
+		}
 
-        const test_names = Object.keys(tests);
-        for (const name of test_names) {
-            const result = await this.runner.runTest(name, tests[name], suite);
-            results.addResult(name, result);
-        }
+		const test_names = Object.keys(tests);
+		for (const name of test_names) {
+			const result = await this.runner.runTest(name, tests[name], suite);
+			results.addResult(name, result);
+		}
 
-        return results;
-    }
+		return results;
+	}
 }

package/tsconfig.json

@@ -1,28 +1,25 @@
 {
-  "compilerOptions": {
-    "target": "ES2015",
-    "module": "CommonJS",
-    "outDir": "./dist/",
-    "strict": true,
-    "sourceMap": true,
-    "declaration": true,
-    "declarationMap": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true
-  },
-  "files": [
-    "xunit.ts",
-    "cli.ts",
-    "tsdoc.ts"
-  ],
-  "include": [
-    "src/**/*.ts",
-    "tests/**/*.ts",
-    "TSDoc/**/*.ts"
-  ],
-  "exclude": [
-    "node_modules",
-    "dist"
-  ]
+	"compilerOptions": {
+		"target": "ES2015",
+		"module": "CommonJS",
+		"outDir": "dist/",
+		"strict": true,
+		"sourceMap": true,
+		"declaration": true,
+		"declarationMap": true,
+		"esModuleInterop": true,
+		"experimentalDecorators": true,
+		"emitDecoratorMetadata": true
+	},
+	"files": [
+		"xunit.ts",
+		"cli.ts"
+	],
+	"include": [
+		"**/*.ts"
+	],
+	"exclude": [
+		"dist",
+		"node_modules"
+	]
 }

package/xunit.ts

@@ -1,9 +1,9 @@
-import Test from './src/Framework/Test';
-import TestSuite from './src/Framework/TestSuite';
-import Assert from './src/Assertions';
+import Test from "./src/Framework/Test";
+import TestSuite from "./src/Framework/TestSuite";
+import Assert from "./src/Assertions";
 
 export {
-    Test,
-    TestSuite,
-    Assert
+	Test,
+	TestSuite,
+	Assert
 };

package/.editorconfig

@@ -1,24 +0,0 @@
-root = true
-
-[*]
-charset = utf-8
-indent_style = tab
-trim_trailing_whitespace = true
-insert_final_newline = false
-max_line_length = off
-
-[{*.yml,*.yaml}]
-indent_style = space
-indent_size = 2
-
-[*.cs]
-csharp_style_expression_bodied_methods = true
-csharp_style_expression_bodied_constructors = true
-csharp_style_expression_bodied_operators = true
-csharp_style_expression_bodied_properties = true
-csharp_style_expression_bodied_indexers = true
-csharp_style_expression_bodied_accessors = true
-csharp_style_expression_bodied_lambdas = true
-csharp_style_expression_bodied_local_functions = true
-csharp_style_namespace_declarations = file_scoped:warning
-dotnet_diagnostic.S101.severity = suggestion

package/CODE_OF_CONDUCT.md

@@ -1,128 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-Steve@ecoAPM.com.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -1,26 +0,0 @@
-# ecoAPM Contribution Guidelines
-
-First of all, thank you for your interest in contributing!
-
-This document represents a general set of guidelines to help make the process of community contributions as smooth as possible for all parties involved.
-
-#### Please read the [Code of Conduct](CODE_OF_CONDUCT.md) prior to participating
-   - This is the standard "Contributor Covenant" used throughout all ecoAPM codebases, and widely across the OSS landscape
-   - Building a strong, professional, caring, and empathetic community is paramount in our goal as an OSS company
-
-#### Discussions about changes should happen in an issue before creating a pull request
-   - While a change may make sense for a specific use case, it may not match the larger goals of the project as initially formulated by the original contributor
-   - Prior discussion can help give direction to how a feature or bug fix could best be implemented to meet everyone's needs
-
-#### Follow the standard issue template formats for reporting bugs and requesting new features
-   - These make reading, understanding, and triaging issues much easier 
-
-#### Commit quality code with detailed documentation to help maximize PR review effectiveness
-   - All new or modified functionality should have unit tests covering the logic involved
-   - All PR checks (e.g. automated tests, code quality analysis, etc.) should be passing before a PR is reviewed
-   - Commit messages should be English (Canadian/UK/US are all acceptable) in the present tense using an imperative form (see existing commits for examples)
-   - Please do not reference GitHub issue numbers or PR numbers in git commit messages
-
-#### Multiple smaller, atomic PRs are preferable to single larger monolithic PRs
-   - This may take longer to get the full changeset merged, but will provide for a much smoother feedback process
-   - Please reference any related issue numbers in the body of all PR descriptions so that GitHub links them together

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 ecoAPM
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.