feat: add tags

Author: rocketraccoon

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;
     }

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);

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>;

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: {

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 },

src/index.ts

@@ -29,6 +29,7 @@ export type {
     TestFunctionCtx,
     ExecutionThreadCtx,
     Cookie,
+    TestTag,
 } from "./types";
 export type { Config } from "./config";
 export { TimeTravelMode } from "./config";

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;
     }
 

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);

src/test-reader/mocha-reader/index.js

@@ -10,8 +10,44 @@ const { MasterEvents } = require("../../events");
 const { getMethodsByInterface } = require("./utils");
 const { enableSourceMaps } = require("../../utils/typescript");
 
+function getTagParser(original) {
+    return function (title, paramsOrFn, fn) {
+        if (typeof paramsOrFn === "function") {
+            return original.call(this, title, paramsOrFn);
+        } else {
+            const test = original.call(this, title, fn);
+
+            if (paramsOrFn?.tag) {
+                if (Array.isArray(paramsOrFn.tag)) {
+                    test.tag = paramsOrFn.tag.map(title => ({ title, dynamic: false }));
+                } else {
+                    test.tag = [{ title: paramsOrFn.tag, dynamic: false }];
+                }
+            }
+
+            return test;
+        }
+    };
+}
+
 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 = getTagParser(originalDescribe);
+
+        context.describe.only = originalDescribe.only;
+        context.describe.skip = originalDescribe.skip;
+
+        context.it = context.specify = getTagParser(originalIt);
+
+        context.it.only = originalIt.only;
+        context.it.skip = originalIt.skip;
+    });
+
     mocha.fullTrace();
 
     initBuildContext(eventBus);

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));