feat: tags

rocketraccoon · rocketraccoon · commit 82a06d4bc9df · 2025-11-27T12:51:08.000+07:00
diff --git a/src/browser/existing-browser.ts b/src/browser/existing-browser.ts
@@ -91,6 +91,7 @@ export class ExistingBrowser extends Browser {
     protected _calibration?: CalibrationResult;
     protected _clientBridge?: ClientBridge;
     protected _cdp: CDP | null = null;
+    protected _tag: Set<string> = new Set();
 
     constructor(config: Config, opts: BrowserOpts) {
         super(config, opts);
@@ -328,6 +329,14 @@ export class ExistingBrowser extends Browser {
     protected _addMetaAccessCommands(session: WebdriverIO.Browser): void {
         session.addCommand("setMeta", (key, value) => (this._meta[key] = value));
         session.addCommand("getMeta", key => (key ? this._meta[key] : this._meta));
+
+        session.addCommand("addTag", (tag: string | string[]) => {
+            if (Array.isArray(tag)) {
+                tag.forEach(element => this._tag?.add(element));
+            } else {
+                this._tag?.add(tag);
+            }
+        });
     }
 
     protected _decorateUrlMethod(session: WebdriverIO.Browser): void {
@@ -584,6 +593,10 @@ export class ExistingBrowser extends Browser {
         return this._meta;
     }
 
+    get tag(): string[] {
+        return [...this._tag];
+    }
+
     get cdp(): CDP | null {
         return this._cdp;
     }
diff --git a/src/browser/history/index.ts b/src/browser/history/index.ts
@@ -23,7 +23,9 @@ export interface PromiseRef<T = unknown> {
 }
 
 const shouldNotWrapCommand = (commandName: string): boolean =>
-    ["addCommand", "overwriteCommand", "extendOptions", "setMeta", "getMeta", "runStep"].includes(commandName);
+    ["addCommand", "overwriteCommand", "extendOptions", "addTag", "setMeta", "getMeta", "runStep"].includes(
+        commandName,
+    );
 
 export const shouldPropagateFn = (parentNode: TestStep, currentNode: TestStep): boolean =>
     isGroup(parentNode) || isGroup(currentNode);
diff --git a/src/browser/types.ts b/src/browser/types.ts
@@ -75,6 +75,8 @@ declare global {
 
             setMeta(this: WebdriverIO.Browser, key: string, value: unknown): Promise<void>;
 
+            addTag(this: WebdriverIO.Browser, tag: string | string[]): Promise<void>;
+
             extendOptions(this: WebdriverIO.Browser, opts: { [name: string]: unknown }): Promise<void>;
 
             getConfig(this: WebdriverIO.Browser): Promise<BrowserConfig>;
diff --git a/src/cli/commands/list-tests/index.ts b/src/cli/commands/list-tests/index.ts
@@ -30,7 +30,7 @@ export const registerCmd = (cliTool: ListTestsCmd, testplane: Testplane): void =
         .option("--formatter [name]", "return tests in specified format", String, Formatters.LIST)
         .arguments("[paths...]")
         .action(async (paths: string[], options: ListTestsCmdOpts) => {
-            const { grep, browser: browsers, set: sets } = cliTool;
+            const { grep, tag, browser: browsers, set: sets } = cliTool;
             const { ignore, silent, outputFile, formatter } = options;
 
             try {
@@ -40,6 +40,7 @@ export const registerCmd = (cliTool: ListTestsCmd, testplane: Testplane): void =
                     browsers,
                     sets,
                     grep,
+                    tag,
                     ignore,
                     silent,
                     runnableOpts: {
diff --git a/src/cli/index.ts b/src/cli/index.ts
@@ -87,6 +87,7 @@ export const run = async (opts: TestplaneRunOpts = {}): Promise<void> => {
                     browser: browsers,
                     set: sets,
                     grep,
+                    tag,
                     updateRefs,
                     inspect,
                     inspectBrk,
@@ -104,6 +105,7 @@ export const run = async (opts: TestplaneRunOpts = {}): Promise<void> => {
                     browsers,
                     sets,
                     grep,
+                    tag,
                     updateRefs,
                     requireModules,
                     inspectMode: (inspect || inspectBrk) && { inspect, inspectBrk },
diff --git a/src/index.ts b/src/index.ts
@@ -29,6 +29,7 @@ export type {
     TestFunctionCtx,
     ExecutionThreadCtx,
     Cookie,
+    TestTag,
 } from "./types";
 export type { Config } from "./config";
 export { TimeTravelMode } from "./config";
diff --git a/src/runner/test-runner/regular-test-runner.js b/src/runner/test-runner/regular-test-runner.js
@@ -71,7 +71,7 @@ module.exports = class RegularTestRunner extends RunnableEmitter {
         });
     }
 
-    _applyTestResults({ meta, testplaneCtx = {}, history = [] }) {
+    _applyTestResults({ tag, meta, testplaneCtx = {}, history = [] }) {
         testplaneCtx.assertViewResults = AssertViewResults.fromRawObject(testplaneCtx.assertViewResults || []);
         this._test.assertViewResults = testplaneCtx.assertViewResults.get();
 
@@ -80,6 +80,10 @@ module.exports = class RegularTestRunner extends RunnableEmitter {
         this._test.hermioneCtx = testplaneCtx;
         this._test.history = history;
 
+        if (tag) {
+            tag.forEach(tag => this._test.addTag(tag));
+        }
+
         this._test.duration = Date.now() - this._test.startTime;
     }
 
diff --git a/src/test-reader/index.ts b/src/test-reader/index.ts
@@ -29,7 +29,7 @@ export class TestReader extends EventEmitter {
     }
 
     async read(options: TestReaderOpts): Promise<Record<string, Test[]>> {
-        const { paths, browsers, ignore, sets, grep, runnableOpts } = options;
+        const { paths, browsers, ignore, sets, grep, tag, runnableOpts } = options;
 
         const { fileExtensions } = this.#config.system;
         const envSets = env.parseCommaSeparatedValue(["TESTPLANE_SETS", "HERMIONE_SETS"]).value;
@@ -46,7 +46,7 @@ export class TestReader extends EventEmitter {
 
         const filesByBro = setCollection.groupByBrowser();
         const testsByBro = _.mapValues(filesByBro, (files, browserId) =>
-            parser.parse(files, { browserId, config: this.#config.forBrowser(browserId), grep }),
+            parser.parse(files, { browserId, config: this.#config.forBrowser(browserId), grep, tag }),
         );
 
         validateTests(testsByBro, options, this.#config);
diff --git a/src/test-reader/mocha-reader/index.js b/src/test-reader/mocha-reader/index.js
@@ -12,6 +12,46 @@ const { enableSourceMaps } = require("../../utils/typescript");
 
 async function readFiles(files, { esmDecorator, config, eventBus, runnableOpts }) {
     const mocha = new Mocha(config);
+
+    mocha.suite.on("pre-require", context => {
+        const originalDescribe = context.describe;
+        const originalIt = context.it;
+
+        context.describe = context.context = function (title, paramsOrFn, fn) {
+            if (typeof paramsOrFn === "function") {
+                return originalIt.call(this, title, paramsOrFn);
+            } else {
+                const suite = originalDescribe.call(this, title, fn);
+
+                if (paramsOrFn?.tag) {
+                    suite.tag = paramsOrFn.tag.map(title => ({ title, dynamic: false }));
+                }
+
+                return suite;
+            }
+        };
+
+        context.describe.only = originalDescribe.only;
+        context.describe.skip = originalDescribe.skip;
+
+        context.it = context.specify = function (title, paramsOrFn, fn) {
+            if (typeof paramsOrFn === "function") {
+                return originalIt.call(this, title, paramsOrFn);
+            } else {
+                const test = originalIt.call(this, title, fn);
+
+                if (paramsOrFn?.tag) {
+                    test.tag = paramsOrFn.tag.map(title => ({ title, dynamic: false }));
+                }
+
+                return test;
+            }
+        };
+
+        context.it.only = originalIt.only;
+        context.it.skip = originalIt.skip;
+    });
+
     mocha.fullTrace();
 
     initBuildContext(eventBus);
diff --git a/src/test-reader/mocha-reader/tree-builder-decorator.js b/src/test-reader/mocha-reader/tree-builder-decorator.js
@@ -18,12 +18,12 @@ class TreeBuilderDecorator {
     }
 
     addSuite(mochaSuite) {
-        const { id: mochaId } = mochaSuite;
+        const { id: mochaId, tag } = mochaSuite;
         const file = computeFile(mochaSuite) ?? "unknown-file";
 
         const positionInFile = this.#suiteCounter.get(file) || 0;
         const id = mochaSuite.root ? mochaId : crypto.getShortMD5(file) + positionInFile;
-        const suite = this.#mkTestObject(Suite, mochaSuite, { id });
+        const suite = this.#mkTestObject(Suite, mochaSuite, { id, tag });
 
         this.#applyConfig(suite, mochaSuite);
         this.#treeBuilder.addSuite(suite, this.#getParent(mochaSuite, null));
@@ -34,9 +34,9 @@ class TreeBuilderDecorator {
     }
 
     addTest(mochaTest) {
-        const { fn } = mochaTest;
+        const { fn, tag } = mochaTest;
         const id = crypto.getShortMD5(mochaTest.fullTitle());
-        const test = this.#mkTestObject(Test, mochaTest, { id, fn });
+        const test = this.#mkTestObject(Test, mochaTest, { id, fn, tag });
 
         this.#applyConfig(test, mochaTest);
         this.#treeBuilder.addTest(test, this.#getParent(mochaTest));
diff --git a/src/test-reader/test-object/suite.ts b/src/test-reader/test-object/suite.ts
@@ -2,30 +2,51 @@ import _ from "lodash";
 import { ConfigurableTestObject } from "./configurable-test-object";
 import { Hook } from "./hook";
 import { Test } from "./test";
-import type { TestObjectData, ConfigurableTestObjectData, TestFunction, TestFunctionCtx } from "./types";
+import type { TestObjectData, ConfigurableTestObjectData, TestFunction, TestFunctionCtx, TestTag } from "./types";
 
-type SuiteOpts = Pick<ConfigurableTestObjectData, "file" | "id" | "location"> & TestObjectData;
+type SuiteOpts = Pick<ConfigurableTestObjectData, "file" | "id" | "location"> & TestObjectData & { tag: TestTag[] };
 
 export class Suite extends ConfigurableTestObject {
     #suites: this[];
     #tests: Test[];
     #beforeEachHooks: Hook[];
     #afterEachHooks: Hook[];
+    public tag: Map<string, boolean>;
 
     static create<T extends Suite>(this: new (opts: SuiteOpts) => T, opts: SuiteOpts): T {
         return new this(opts);
     }
 
     // used inside test
-    constructor({ title, file, id, location }: SuiteOpts = {} as SuiteOpts) {
+    constructor({ title, file, id, location, tag }: SuiteOpts = {} as SuiteOpts) {
         super({ title, file, id, location });
 
+        this.tag = new Map(tag?.map(({ title, dynamic }) => [title, !!dynamic]) || []);
         this.#suites = [];
         this.#tests = [];
         this.#beforeEachHooks = [];
         this.#afterEachHooks = [];
     }
 
+    addTag(tag: string | string[], dynamic = false): void {
+        if (Array.isArray(tag)) {
+            tag.forEach(element => this.tag.set(element, dynamic));
+        } else {
+            this.tag.set(tag, dynamic);
+        }
+    }
+
+    hasTag(tag: string): boolean {
+        return this.tag.has(tag);
+    }
+
+    getTag(): TestTag[] {
+        return Array.from(this.tag.keys()).map(title => ({
+            title,
+            dynamic: this.tag.get(title),
+        }));
+    }
+
     addSuite(suite: Suite): this {
         return this.#addChild(suite, this.#suites);
     }
diff --git a/src/test-reader/test-object/test.ts b/src/test-reader/test-object/test.ts
@@ -1,28 +1,51 @@
 import { ConfigurableTestObject } from "./configurable-test-object";
-import type { TestObjectData, TestFunction, TestFunctionCtx } from "./types";
+import type { TestObjectData, TestFunction, TestFunctionCtx, TestTag } from "./types";
 
 type TestOpts = TestObjectData &
     Pick<ConfigurableTestObject, "file" | "id" | "location"> & {
         fn: TestFunction<TestFunctionCtx>;
+        tag?: TestTag[];
     };
 
 export class Test extends ConfigurableTestObject {
     public fn: TestFunction<TestFunctionCtx>;
+    public tag: Map<string, boolean>;
     public err?: Error;
 
     static create<T extends Test>(this: new (opts: TestOpts) => T, opts: TestOpts): T {
         return new this(opts);
     }
 
-    constructor({ title, file, id, location, fn }: TestOpts) {
+    constructor({ title, file, id, location, fn, tag }: TestOpts) {
         super({ title, file, id, location });
 
         this.fn = fn;
+        this.tag = new Map(tag?.map(({ title, dynamic }) => [title, !!dynamic]) || []);
+    }
+
+    addTag(tag: string | string[]): void {
+        if (Array.isArray(tag)) {
+            tag.forEach(element => this.tag.set(element, true));
+        } else {
+            this.tag.set(tag, true);
+        }
+    }
+
+    hasTag(tag: string): boolean {
+        return this.tag.has(tag);
+    }
+
+    getTag(): TestTag[] {
+        return Array.from(this.tag.keys()).map(title => ({
+            title,
+            dynamic: this.tag.get(title),
+        }));
     }
 
     clone(): Test {
         return new Test({
             title: this.title,
+            tag: this.getTag(),
             file: this.file,
             id: this.id,
             location: this.location,
diff --git a/src/test-reader/test-object/types.ts b/src/test-reader/test-object/types.ts
@@ -35,8 +35,17 @@ export interface TestHookDefinition {
     <T extends Partial<TestFunctionCtx> = TestFunctionCtx>(fn?: TestFunction<T>): Hook;
 }
 
+export type DefinitionParams = {
+    tag?: string | string[];
+};
+
 export interface TestDefinition {
     <T extends Partial<TestFunctionCtx> = TestFunctionCtx>(title: string, fn?: TestFunction<T>): Test;
+    <T extends Partial<TestFunctionCtx> = TestFunctionCtx>(
+        title: string,
+        params: DefinitionParams,
+        fn?: TestFunction<T>,
+    ): Test;
 
     only: <T extends Partial<TestFunctionCtx> = TestFunctionCtx>(title: string, fn?: TestFunction<T>) => Test;
 
@@ -45,7 +54,14 @@ export interface TestDefinition {
 
 export interface SuiteDefinition {
     (title: string, fn: (this: Suite) => void): Suite;
+    (title: string, params: DefinitionParams, fn: (this: Suite) => void): Suite;
 
     only: (title: string, fn: (this: Suite) => void) => Suite;
+
     skip: (title: string, fn: (this: Suite) => void) => Suite;
 }
+
+export type TestTag = {
+    title: string;
+    dynamic?: boolean;
+};
diff --git a/src/test-reader/test-parser.ts b/src/test-reader/test-parser.ts
@@ -15,14 +15,16 @@ import path from "path";
 import fs from "fs-extra";
 import * as logger from "../utils/logger";
 import { getShortMD5 } from "../utils/crypto";
-import { Test } from "./test-object";
+import { Suite, Test } from "./test-object";
 import { Config } from "../config";
 import { BrowserConfig } from "../config/browser-config";
 import type { ReadTestsOpts } from "../testplane";
+import { TagFilter } from "../utils/cli";
 
 export type TestParserParseOpts = {
     browserId: string;
     grep?: RegExp;
+    tag?: TagFilter;
     config: BrowserConfig;
 };
 
@@ -135,7 +137,7 @@ export class TestParser extends EventEmitter {
         });
     }
 
-    parse(files: string[], { browserId, config, grep }: TestParserParseOpts): Test[] {
+    parse(files: string[], { browserId, config, grep, tag }: TestParserParseOpts): Test[] {
         const treeBuilder = new TreeBuilder();
 
         this.#buildInstructions.exec(files, { treeBuilder, browserId, config });
@@ -144,6 +146,22 @@ export class TestParser extends EventEmitter {
             treeBuilder.addTestFilter((test: Test) => grep.test(test.fullTitle()));
         }
 
+        if (tag) {
+            treeBuilder.addTestFilter((test: Test) => {
+                let current: Test | Suite | null = test;
+
+                while (current) {
+                    if (tag(current.tag)) {
+                        return true;
+                    } else {
+                        current = current.parent;
+                    }
+                }
+
+                return false;
+            });
+        }
+
         if (config.lastFailed?.only) {
             if (!this.#failedTests.size) {
                 return [];
diff --git a/src/testplane.ts b/src/testplane.ts
diff --git a/src/types/index.ts b/src/types/index.ts
diff --git a/src/utils/cli.ts b/src/utils/cli.ts
diff --git a/src/worker/runner/test-runner/index.js b/src/worker/runner/test-runner/index.js
diff --git a/src/worker/runner/test-runner/types.ts b/src/worker/runner/test-runner/types.ts
diff --git a/src/worker/testplane.ts b/src/worker/testplane.ts

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,9 @@ export interface PromiseRef<T = unknown> {`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`const shouldNotWrapCommand = (commandName: string): boolean =>`
`26`		`- ["addCommand", "overwriteCommand", "extendOptions", "setMeta", "getMeta", "runStep"].includes(commandName);`
	`26`	`+ ["addCommand", "overwriteCommand", "extendOptions", "addTag", "setMeta", "getMeta", "runStep"].includes(`
	`27`	`+ commandName,`
	`28`	`+ );`
`27`	`29`
`28`	`30`	`export const shouldPropagateFn = (parentNode: TestStep, currentNode: TestStep): boolean =>`
`29`	`31`	`isGroup(parentNode) \|\| isGroup(currentNode);`