/** @odoo-module */ import { Callbacks, HootError, createReporting, stringify } from "../hoot_utils"; import { Job } from "./job"; /** * @typedef {import("./tag").Tag} Tag * * @typedef {import("./test").Test} Test */ //----------------------------------------------------------------------------- // Global //----------------------------------------------------------------------------- const { Object: { freeze: $freeze }, } = globalThis; //----------------------------------------------------------------------------- // Internal //----------------------------------------------------------------------------- class MinimalCallbacks extends Callbacks { add() {} call() {} callSync() {} clear() {} } const SHARED_CALLBACKS = new MinimalCallbacks(); const SHARED_CURRENT_JOBS = $freeze([]); //----------------------------------------------------------------------------- // Exports //----------------------------------------------------------------------------- /** * @param {Pick} suite * @param {Error | string} message * @returns {HootError} */ export function suiteError({ name, parent }, message) { const parentString = parent ? ` (in parent suite ${stringify(parent.name)})` : ""; const errorOptions = { level: "critical" }; let errorMessage = `error while registering suite ${stringify(name)}${parentString}`; if (message instanceof Error) { errorOptions.cause = message; } else { errorMessage += `: ${message}`; } return new HootError(errorMessage, errorOptions); } export class Suite extends Job { callbacks = new Callbacks(); currentJobIndex = 0; /** @type {(Suite | Test)[]} */ currentJobs = []; /** @type {(Suite | Test)[]} */ jobs = []; reporting = createReporting(); totalSuiteCount = 0; totalTestCount = 0; get weight() { return this.totalTestCount; } addJob(job) { this.jobs.push(job); if (job instanceof Suite) { this.increaseSuiteCount(); } else { this.increaseTestCount(); } } cleanup() { this.parent?.reporting.add({ suites: +1 }); this.minimize(); } minimize() { super.minimize(); this.callbacks.clear(); this.callbacks = SHARED_CALLBACKS; this.currentJobs = SHARED_CURRENT_JOBS; } increaseSuiteCount() { this.totalSuiteCount++; this.parent?.increaseSuiteCount(); } increaseTestCount() { this.totalTestCount++; this.parent?.increaseTestCount(); } reset() { this.currentJobIndex = 0; for (const job of this.jobs) { job.runCount = 0; if (job instanceof Suite) { job.reset(); } } } /** * @param {Job[]} jobs */ setCurrentJobs(jobs) { if (this.isMinimized) { return; } this.currentJobs = jobs; this.currentJobIndex = 0; } }