@w-lfpup/jackrabbit 0.1.0 → 0.3.0

package/nodejs/dist/results_str.js

@@ -0,0 +1,147 @@
+const SPACE = "  ";
+export function getResultsAsString(runResults) {
+    const output = [];
+    for (let errorAction of runResults.errorLogs) {
+        if ("run_error" !== errorAction.type)
+            continue;
+        output.push(`${SPACE}[session_error]\n${errorAction.error}`);
+    }
+    // Lots of nested loops because results a nested structure.
+    // I'd rather see composition nested in one function
+    // than have for loops spread across each function.
+    if (!logRunResults(output, runResults))
+        for (const collection of runResults.collections) {
+            if (logCollectionResult(output, collection))
+                continue;
+            if (collection)
+                for (const moduleResult of collection.modules) {
+                    if (logModuleResult(output, moduleResult))
+                        continue;
+                    if (moduleResult)
+                        for (const testResult of moduleResult.testResults) {
+                            logTest(output, testResult);
+                        }
+                }
+        }
+    logSummary(output, runResults);
+    return output.join("\n");
+}
+function logRunResults(output, result) {
+    // When everything goes right :3
+    if (!result.fails &&
+        !result.errors &&
+        result.expectedTests === result.completedTests &&
+        result.expectedModules === result.completedModules &&
+        result.expectedCollections === result.completedCollections) {
+        output.push(`${result.completedTests} tests
+${result.completedModules} modules
+${result.completedCollections} collections`);
+        return true;
+    }
+    for (let errorAction of result.errorLogs) {
+        if ("run_error" !== errorAction.type)
+            continue;
+        output.push(`[run_error] ${errorAction.error}`);
+    }
+    return false;
+}
+function logCollectionResult(output, collection) {
+    if (!collection)
+        return true;
+    let { loggerAction } = collection;
+    if ("start_collection" !== loggerAction.type)
+        return true;
+    output.push(`${SPACE}${loggerAction.collection_url}`);
+    // when everything in the collection goes right
+    if (!collection.fails &&
+        !collection.errors &&
+        collection.expectedTests === collection.completedTests &&
+        collection.expectedModules === collection.completedModules) {
+        output.push(`${collection.expectedTests} tests
+${loggerAction.expected_module_count} modules`);
+        return true;
+    }
+    for (let errorAction of collection.errorLogs) {
+        if ("collection_error" !== errorAction.type)
+            continue;
+        output.push(`[collection_error] ${errorAction.error}`);
+    }
+    return false;
+}
+function logModuleResult(output, module) {
+    if (!module)
+        return true;
+    let { loggerAction } = module;
+    if ("start_module" !== loggerAction.type)
+        return true;
+    output.push(`${SPACE}${loggerAction.module_name}`);
+    // when everything in the module goes right
+    if (!module.fails &&
+        !module.errors &&
+        module.expectedTests === module.completedTests) {
+        output.push(`${SPACE.repeat(2)}${module.expectedTests} tests`);
+        return true;
+    }
+    for (let errorAction of module.errorLogs) {
+        if ("collection_error" !== errorAction.type)
+            continue;
+        output.push(`${SPACE}[module_error] ${errorAction.error}`);
+    }
+    return false;
+}
+function logTest(output, test) {
+    if (!test)
+        return;
+    let { loggerStartAction, loggerEndAction } = test;
+    if ("start_test" !== loggerStartAction.type)
+        return;
+    if ("test_error" === loggerEndAction?.type) {
+        let { test_name } = loggerStartAction;
+        output.push(`${SPACE.repeat(2)}${test_name}
+${SPACE.repeat(3)}[error] ${loggerEndAction.error}`);
+    }
+    if ("end_test" === loggerEndAction?.type) {
+        let { assertions } = loggerEndAction;
+        const isAssertionArray = Array.isArray(assertions) && assertions.length;
+        const isAssertion = !Array.isArray(assertions) &&
+            undefined !== assertions &&
+            null !== assertions;
+        if (isAssertion || isAssertionArray) {
+            let { test_name } = loggerStartAction;
+            output.push(`${SPACE.repeat(2)}${test_name}`);
+        }
+        if (isAssertion) {
+            output.push(`${SPACE.repeat(3)}- ${assertions}`);
+        }
+        if (isAssertionArray) {
+            for (const assertion of assertions) {
+                output.push(`${SPACE.repeat(3)}- ${assertion}`);
+            }
+        }
+    }
+}
+function logSummary(output, runResults) {
+    let status_with_color = runResults.fails
+        ? yellow("\u{2717} failed")
+        : blue("\u{2714} passed");
+    if (runResults.errors) {
+        status_with_color = gray("\u{2717} errored");
+    }
+    let totalTime = runResults.endTime - runResults.startTime;
+    output.push(`
+${status_with_color}
+duration: ${runResults.testTime.toFixed(4)} mS
+total: ${totalTime.toFixed(4)} mS
+`);
+}
+// 39 - default foreground color
+// 49 - default background color
+function blue(text) {
+    return `\x1b[44m\x1b[97m${text}\x1b[0m`;
+}
+function yellow(text) {
+    return `\x1b[43m\x1b[97m${text}\x1b[0m`;
+}
+function gray(text) {
+    return `\x1b[100m\x1b[97m${text}\x1b[0m`;
+}

package/nodejs/dist/runner.js

@@ -0,0 +1,17 @@
+import * as path from "path";
+import { startRun } from "../../core/dist/mod.js";
+export async function run(logger, files) {
+    for (const file of files) {
+        let filepath = path.join(process.cwd(), file);
+        try {
+            const { testModules } = await import(filepath);
+            await startRun(logger, testModules);
+        }
+        catch (e) {
+            logger.log({
+                type: "run_error",
+                error: e?.toString() ?? "wild horses error",
+            });
+        }
+    }
+}

package/nodejs/src/logger.ts

@@ -0,0 +1,193 @@
+import type {
+	LoggerAction,
+	LoggerInterface,
+	EndTest,
+} from "../../core/dist/mod.js";
+import type { RunResults } from "./results_str.js";
+
+import { getResultsAsString } from "./results_str.js";
+
+export class Logger implements LoggerInterface {
+	#results: RunResults = {
+		startTime: 0,
+		fails: 0,
+		errors: 0,
+		expectedTests: 0,
+		endTime: 0,
+		testTime: 0,
+		expectedModules: 0,
+		expectedCollections: 0,
+		completedModules: 0,
+		completedCollections: 0,
+		completedTests: 0,
+		errorLogs: [],
+		collections: [],
+	};
+
+	get failed() {
+		return this.#results.fails !== 0;
+	}
+
+	get errored() {
+		return this.#results.errors !== 0;
+	}
+
+	get results(): string {
+		return getResultsAsString(this.#results);
+	}
+
+	log(action: LoggerAction) {
+		if ("start_run" === action.type) {
+			this.#results.startTime = action.time;
+			this.#results.expectedCollections = action.expected_collection_count;
+		}
+
+		if ("end_run" === action.type) {
+			this.#results.endTime = action.time;
+		}
+
+		if ("run_error" === action.type) {
+			this.#results.errors += 1;
+			this.#results.errorLogs.push(action);
+		}
+
+		if ("start_collection" === action.type) {
+			this.#results.collections[action.collection_id] = {
+				completedModules: 0,
+				completedTests: 0,
+				errorLogs: [],
+				errors: 0,
+				expectedModules: action.expected_module_count,
+				expectedTests: 0,
+				fails: 0,
+				loggerAction: action,
+				modules: [],
+			};
+
+			this.#results.expectedModules += action.expected_module_count;
+		}
+
+		if ("end_collection" === action.type) {
+			let collection = this.#results.collections[action.collection_id];
+			if (!collection) return;
+
+			this.#results.completedCollections += 1;
+		}
+
+		if ("collection_error" === action.type) {
+			let collection = this.#results.collections[action.collection_id];
+			if (!collection) return;
+
+			this.#results.errors += 1;
+			collection.errors += 1;
+
+			collection.errorLogs.push(action);
+		}
+
+		if ("start_module" === action.type) {
+			let collection = this.#results.collections[action.collection_id];
+			if (!collection) return;
+
+			collection.modules[action.module_id] = {
+				completedTests: 0,
+				errorLogs: [],
+				errors: 0,
+				expectedTests: action.expected_test_count,
+				fails: 0,
+				loggerAction: action,
+				testResults: [],
+			};
+
+			collection.expectedTests += action.expected_test_count;
+			this.#results.expectedTests += action.expected_test_count;
+		}
+
+		if ("end_module" === action.type) {
+			let collection = this.#results.collections[action.collection_id];
+			if (!collection) return;
+
+			let module = collection.modules[action.module_id];
+			if (!module) return;
+
+			this.#results.completedModules += 1;
+			collection.completedModules += 1;
+		}
+
+		if ("module_error" === action.type) {
+			let collection = this.#results.collections[action.collection_id];
+			if (!collection) return;
+
+			let module = collection.modules[action.module_id];
+			if (!module) return;
+
+			this.#results.errors += 1;
+			collection.errors += 1;
+			module.errors += 1;
+			module.errorLogs.push(action);
+		}
+
+		if ("start_test" === action.type) {
+			let collection = this.#results.collections[action.collection_id];
+			if (!collection) return;
+
+			let module = collection.modules[action.module_id];
+			if (!module) return;
+
+			module.testResults[action.test_id] = {
+				loggerStartAction: action,
+				loggerEndAction: undefined,
+			};
+		}
+
+		if ("end_test" === action.type) {
+			endTest(this.#results, action);
+		}
+
+		if ("test_error" === action.type) {
+			let collection = this.#results.collections[action.collection_id];
+			if (!collection) return;
+
+			let module = collection.modules[action.module_id];
+			if (!module) return;
+
+			let testResult = module.testResults[action.test_id];
+			if (!testResult) return;
+
+			testResult.loggerEndAction = action;
+			this.#results.errors += 1;
+			collection.errors += 1;
+			module.errors += 1;
+		}
+	}
+}
+
+function endTest(runResults: RunResults, loggerAction: EndTest) {
+	let collection = runResults.collections[loggerAction.collection_id];
+	if (!collection) return;
+
+	let module = collection.modules[loggerAction.module_id];
+	if (!module) return;
+
+	let testResult = module.testResults[loggerAction.test_id];
+	if (!testResult) return;
+
+	testResult.loggerEndAction = loggerAction;
+	runResults.completedTests += 1;
+	collection.completedTests += 1;
+	module.completedTests += 1;
+
+	let { assertions } = loggerAction;
+	const isAssertionArray = Array.isArray(assertions) && assertions.length;
+	// might be worth just sticking with language standard "none" like "" or 0 or false
+	const isAssertion = !Array.isArray(assertions) && undefined !== assertions;
+	if (isAssertion || isAssertionArray) {
+		runResults.fails += 1;
+		collection.fails += 1;
+		module.fails += 1;
+	}
+
+	runResults.testTime += Math.max(
+		0,
+		loggerAction.end_time - loggerAction.start_time,
+	);
+}

package/nodejs/src/mod.ts

@@ -0,0 +1,37 @@
+#!/usr/bin/env node
+
+import { Logger } from "./logger.js";
+import * as path from "path";
+import { runCollection } from "../../core/dist/mod.js";
+
+let filepaths = process.argv.slice(2);
+
+const logger = new Logger();
+
+logger.log({
+	type: "start_run",
+	time: performance.now(),
+	expected_collection_count: filepaths.length,
+});
+
+for (const [collection_id, file] of filepaths.entries()) {
+	try {
+		let filepath = path.join(process.cwd(), file);
+		const { testModules } = await import(filepath);
+		await runCollection(logger, testModules, collection_id, filepath);
+	} catch (e: unknown) {
+		logger.log({
+			type: "collection_error",
+			collection_id,
+			error: e?.toString() ?? "wild horses error",
+		});
+	}
+}
+
+logger.log({
+	type: "end_run",
+	time: performance.now(),
+});
+
+console.log(logger.results);
+logger.failed || logger.errored ? process.exit(1) : process.exit(0);

package/nodejs/src/results_str.ts

@@ -0,0 +1,234 @@
+import type { LoggerAction } from "../../core/dist/mod.js";
+
+export interface TestResults {
+	loggerStartAction: LoggerAction;
+	loggerEndAction: LoggerAction | undefined;
+}
+
+export interface ModuleResults {
+	loggerAction: LoggerAction;
+	fails: number;
+	errors: number;
+	expectedTests: number;
+	completedTests: number;
+	errorLogs: LoggerAction[];
+	testResults: (TestResults | undefined)[];
+}
+
+export interface CollectionResults {
+	loggerAction: LoggerAction;
+	fails: number;
+	errors: number;
+	expectedTests: number;
+	completedTests: number;
+	expectedModules: number;
+	completedModules: number;
+	errorLogs: LoggerAction[];
+	modules: (ModuleResults | undefined)[];
+}
+
+export interface RunResults {
+	fails: number;
+	errors: number;
+	startTime: number;
+	endTime: number;
+	testTime: number;
+	expectedTests: number;
+	completedTests: number;
+	expectedModules: number;
+	completedModules: number;
+	expectedCollections: number;
+	completedCollections: number;
+	errorLogs: LoggerAction[];
+	collections: (CollectionResults | undefined)[];
+}
+
+const SPACE = "  ";
+
+export function getResultsAsString(runResults: RunResults): string {
+	const output: string[] = [];
+
+	for (let errorAction of runResults.errorLogs) {
+		if ("run_error" !== errorAction.type) continue;
+		output.push(`${SPACE}[session_error]\n${errorAction.error}`);
+	}
+
+	// Lots of nested loops because results a nested structure.
+	// I'd rather see composition nested in one function
+	// than have for loops spread across each function.
+
+	if (!logRunResults(output, runResults))
+		for (const collection of runResults.collections) {
+			if (logCollectionResult(output, collection)) continue;
+
+			if (collection)
+				for (const moduleResult of collection.modules) {
+					if (logModuleResult(output, moduleResult)) continue;
+
+					if (moduleResult)
+						for (const testResult of moduleResult.testResults) {
+							logTest(output, testResult);
+						}
+				}
+		}
+
+	logSummary(output, runResults);
+
+	return output.join("\n");
+}
+
+function logRunResults(output: string[], result: RunResults): boolean {
+	// When everything goes right :3
+	if (
+		!result.fails &&
+		!result.errors &&
+		result.expectedTests === result.completedTests &&
+		result.expectedModules === result.completedModules &&
+		result.expectedCollections === result.completedCollections
+	) {
+		output.push(`${result.completedTests} tests
+${result.completedModules} modules
+${result.completedCollections} collections`);
+		return true;
+	}
+
+	for (let errorAction of result.errorLogs) {
+		if ("run_error" !== errorAction.type) continue;
+		output.push(`[run_error] ${errorAction.error}`);
+	}
+
+	return false;
+}
+
+function logCollectionResult(
+	output: string[],
+	collection: CollectionResults | undefined,
+): boolean {
+	if (!collection) return true;
+
+	let { loggerAction } = collection;
+	if ("start_collection" !== loggerAction.type) return true;
+
+	output.push(`${SPACE}${loggerAction.collection_url}`);
+
+	// when everything in the collection goes right
+	if (
+		!collection.fails &&
+		!collection.errors &&
+		collection.expectedTests === collection.completedTests &&
+		collection.expectedModules === collection.completedModules
+	) {
+		output.push(
+			`${collection.expectedTests} tests
+${loggerAction.expected_module_count} modules`,
+		);
+
+		return true;
+	}
+
+	for (let errorAction of collection.errorLogs) {
+		if ("collection_error" !== errorAction.type) continue;
+		output.push(`[collection_error] ${errorAction.error}`);
+	}
+
+	return false;
+}
+
+function logModuleResult(
+	output: string[],
+	module: ModuleResults | undefined,
+): boolean {
+	if (!module) return true;
+
+	let { loggerAction } = module;
+	if ("start_module" !== loggerAction.type) return true;
+
+	output.push(`${SPACE}${loggerAction.module_name}`);
+
+	// when everything in the module goes right
+	if (
+		!module.fails &&
+		!module.errors &&
+		module.expectedTests === module.completedTests
+	) {
+		output.push(`${SPACE.repeat(2)}${module.expectedTests} tests`);
+		return true;
+	}
+
+	for (let errorAction of module.errorLogs) {
+		if ("collection_error" !== errorAction.type) continue;
+		output.push(`${SPACE}[module_error] ${errorAction.error}`);
+	}
+
+	return false;
+}
+
+function logTest(output: string[], test: TestResults | undefined) {
+	if (!test) return;
+
+	let { loggerStartAction, loggerEndAction } = test;
+	if ("start_test" !== loggerStartAction.type) return;
+
+	if ("test_error" === loggerEndAction?.type) {
+		let { test_name } = loggerStartAction;
+		output.push(
+			`${SPACE.repeat(2)}${test_name}
+${SPACE.repeat(3)}[error] ${loggerEndAction.error}`,
+		);
+	}
+
+	if ("end_test" === loggerEndAction?.type) {
+		let { assertions } = loggerEndAction;
+		const isAssertionArray = Array.isArray(assertions) && assertions.length;
+		const isAssertion =
+			!Array.isArray(assertions) &&
+			undefined !== assertions &&
+			null !== assertions;
+
+		if (isAssertion || isAssertionArray) {
+			let { test_name } = loggerStartAction;
+			output.push(`${SPACE.repeat(2)}${test_name}`);
+		}
+
+		if (isAssertion) {
+			output.push(`${SPACE.repeat(3)}- ${assertions}`);
+		}
+
+		if (isAssertionArray) {
+			for (const assertion of assertions) {
+				output.push(`${SPACE.repeat(3)}- ${assertion}`);
+			}
+		}
+	}
+}
+
+function logSummary(output: string[], runResults: RunResults) {
+	let status_with_color = runResults.fails
+		? yellow("\u{2717} failed")
+		: blue("\u{2714} passed");
+
+	if (runResults.errors) {
+		status_with_color = gray("\u{2717} errored");
+	}
+
+	let totalTime = runResults.endTime - runResults.startTime;
+	output.push(`
+${status_with_color}
+duration: ${runResults.testTime.toFixed(4)} mS
+total: ${totalTime.toFixed(4)} mS
+`);
+}
+
+// 39 - default foreground color
+// 49 - default background color
+function blue(text: string) {
+	return `\x1b[44m\x1b[97m${text}\x1b[0m`;
+}
+
+function yellow(text: string) {
+	return `\x1b[43m\x1b[97m${text}\x1b[0m`;
+}
+
+function gray(text: string) {
+	return `\x1b[100m\x1b[97m${text}\x1b[0m`;
+}

package/{cli → nodejs}/tsconfig.json

@@ -2,6 +2,7 @@
 	"extends": "../tsconfig.json",
 	"compilerOptions": {
 		"rootDir": "./src",
-		"outDir": "./dist"
+		"outDir": "./dist",
+		"declaration": false
 	}
 }

package/nodejs/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/logger.ts","./src/mod.ts","./src/results_str.ts"],"version":"5.9.3"}

package/package.json

@@ -1,25 +1,28 @@
 {
 	"name": "@w-lfpup/jackrabbit",
 	"description": "A test runner without dependencies",
+	"version": "0.3.0",
+	"license": "BSD-3-Clause",
 	"workspaces": [
 		"core",
 		"tests",
-		"cli",
-		"nodejs_cli"
+		"nodejs",
+		"browser",
+		"webdriver"
 	],
 	"bin": {
-		"jackrabbit": "nodejs_cli/dist/mod.js"
+		"jackrabbit": "nodejs/dist/mod.js",
+		"jackrabbit_webdriver": "webdriver/dist/mod.js"
 	},
 	"scripts": {
 		"prepare": "npm run build",
 		"build": "npm run --workspaces build",
 		"format": "npx prettier --write ./",
-		"test": "npx jackrabbit --file ./tests/dist/mod.js"
+		"test": "npx jackrabbit ./tests/dist/mod.js"
 	},
-	"version": "0.1.0",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/w-lfpup/jackarabbit-js.git"
+		"url": "git+https://github.com/w-lfpup/jackrabbit-js.git"
 	},
 	"devDependencies": {
 		"@types/node": "^22.5.5",

package/tests/dist/mod.d.ts

@@ -1,9 +1,20 @@
 declare function testsFail(): Promise<"fail tests failed to fail" | undefined>;
 declare function testsPass(): Promise<"passing tests failed to pass" | undefined>;
-export declare const testModules: {
-    tests: (typeof testsFail | typeof testsPass)[];
+declare function testsError(): Promise<"tests failed to error" | "tests should error not fail" | undefined>;
+export declare const testModules: ({
+    tests: (typeof testsFail)[];
     options: {
         title: string;
     };
-}[];
+} | {
+    tests: (typeof testsPass)[];
+    options: {
+        title: string;
+    };
+} | {
+    tests: (typeof testsError)[];
+    options: {
+        title: string;
+    };
+})[];
 export {};