@atomic-testing/playwright 0.2.0

package/README.md

@@ -0,0 +1 @@
+# @atomic-testing/playwright

package/dist/PlaywrightInteractor.d.ts

@@ -0,0 +1,19 @@
+import { IClickOption, IInteractor, LocatorChain, Optional } from '@atomic-testing/core';
+import { IEnterTextOption } from '@atomic-testing/core/src/types';
+import { Page } from '@playwright/test';
+export declare class PlaywrightInteractor implements IInteractor {
+    readonly page: Page;
+    constructor(page: Page);
+    selectOptionValue(locator: LocatorChain, values: string[]): Promise<void>;
+    getInputValue(locator: LocatorChain): Promise<Optional<string>>;
+    getSelectValues(locator: LocatorChain): Promise<Optional<readonly string[]>>;
+    enterText(locator: LocatorChain, text: string, option?: Partial<IEnterTextOption> | undefined): Promise<void>;
+    click(locator: LocatorChain, option?: IClickOption): Promise<void>;
+    getAttribute(locator: LocatorChain, name: string, isMultiple: true): Promise<readonly string[]>;
+    getAttribute(locator: LocatorChain, name: string, isMultiple: false): Promise<Optional<string>>;
+    getAttribute(locator: LocatorChain, name: string): Promise<Optional<string>>;
+    getText(locator: LocatorChain): Promise<Optional<string>>;
+    exists(locator: LocatorChain): Promise<boolean>;
+    isChecked(locator: LocatorChain): Promise<boolean>;
+    clone(): IInteractor;
+}

package/dist/PlaywrightInteractor.js

@@ -0,0 +1,106 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaywrightInteractor = void 0;
+const core_1 = require("@atomic-testing/core");
+class PlaywrightInteractor {
+    constructor(page) {
+        this.page = page;
+    }
+    selectOptionValue(locator, values) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cssLocator = core_1.locatorUtil.toCssSelector(locator);
+            yield this.page.locator(cssLocator).selectOption(values);
+        });
+    }
+    getInputValue(locator) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cssLocator = core_1.locatorUtil.toCssSelector(locator);
+            return this.page.locator(cssLocator).inputValue();
+        });
+    }
+    getSelectValues(locator) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const optionLocator = {
+                type: core_1.LocatorType.Css,
+                selector: 'option:checked',
+            };
+            const selectedOptionLocator = core_1.locatorUtil.append(locator, optionLocator);
+            const cssLocator = core_1.locatorUtil.toCssSelector(selectedOptionLocator);
+            const allOptions = yield this.page.locator(cssLocator).all();
+            const values = [];
+            for (const option of allOptions) {
+                const value = yield option.getAttribute('value');
+                if (value != null) {
+                    values.push(value);
+                }
+            }
+            return values;
+        });
+    }
+    enterText(locator, text, option) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cssLocator = core_1.locatorUtil.toCssSelector(locator);
+            yield this.page.locator(cssLocator).type(text);
+        });
+    }
+    click(locator, option) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cssLocator = core_1.locatorUtil.toCssSelector(locator);
+            yield this.page.locator(cssLocator).click();
+        });
+    }
+    getAttribute(locator, name, isMultiple) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cssLocator = core_1.locatorUtil.toCssSelector(locator);
+            const elLocator = this.page.locator(cssLocator);
+            if (isMultiple) {
+                const locators = yield elLocator.all();
+                const values = [];
+                for (const locator of locators) {
+                    const value = yield locator.getAttribute(name);
+                    if (value != null) {
+                        values.push(value);
+                    }
+                }
+                return values;
+            }
+            const value = yield elLocator.getAttribute(name);
+            return value !== null && value !== void 0 ? value : undefined;
+        });
+    }
+    getText(locator) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cssLocator = core_1.locatorUtil.toCssSelector(locator);
+            const text = yield this.page.locator(cssLocator).textContent();
+            return text !== null && text !== void 0 ? text : undefined;
+        });
+    }
+    exists(locator) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cssLocator = core_1.locatorUtil.toCssSelector(locator);
+            const count = yield this.page.locator(cssLocator).count();
+            return count > 0;
+        });
+    }
+    isChecked(locator) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cssLocator = core_1.locatorUtil.toCssSelector(locator);
+            const checked = yield this.page.locator(cssLocator).isChecked();
+            return checked;
+        });
+    }
+    clone() {
+        return new PlaywrightInteractor(this.page);
+    }
+}
+exports.PlaywrightInteractor = PlaywrightInteractor;
+//# sourceMappingURL=PlaywrightInteractor.js.map

package/dist/PlaywrightInteractor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightInteractor.js","sourceRoot":"","sources":["../src/PlaywrightInteractor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+CAQ8B;AAI9B,MAAa,oBAAoB;IAC/B,YAA4B,IAAU;QAAV,SAAI,GAAJ,IAAI,CAAM;IAAG,CAAC;IACpC,iBAAiB,CAAC,OAAqB,EAAE,MAAgB;;YAC7D,MAAM,UAAU,GAAG,kBAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACtD,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC;KAAA;IAEK,aAAa,CAAC,OAAqB;;YACvC,MAAM,UAAU,GAAG,kBAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACtD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;QACpD,CAAC;KAAA;IAEK,eAAe,CAAC,OAAqB;;YACzC,MAAM,aAAa,GAAoB;gBACrC,IAAI,EAAE,kBAAW,CAAC,GAAG;gBACrB,QAAQ,EAAE,gBAAgB;aAC3B,CAAC;YACF,MAAM,qBAAqB,GAAG,kBAAW,CAAC,MAAM,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;YACzE,MAAM,UAAU,GAAG,kBAAW,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;YACpE,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,EAAE,CAAC;YAC7D,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE;gBAC/B,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBACjD,IAAI,KAAK,IAAI,IAAI,EAAE;oBACjB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBACpB;aACF;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;IAEK,SAAS,CAAC,OAAqB,EAAE,IAAY,EAAE,MAA8C;;YACjG,MAAM,UAAU,GAAG,kBAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACtD,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjD,CAAC;KAAA;IAEK,KAAK,CAAC,OAAqB,EAAE,MAAqB;;YACtD,MAAM,UAAU,GAAG,kBAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACtD,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;QAC9C,CAAC;KAAA;IAKK,YAAY,CAChB,OAAqB,EACrB,IAAY,EACZ,UAAoB;;YAEpB,MAAM,UAAU,GAAG,kBAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACtD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAChD,IAAI,UAAU,EAAE;gBACd,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,CAAC;gBACvC,MAAM,MAAM,GAAa,EAAE,CAAC;gBAC5B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;oBAC9B,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;oBAC/C,IAAI,KAAK,IAAI,IAAI,EAAE;wBACjB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;qBACpB;iBACF;gBACD,OAAO,MAAM,CAAC;aACf;YACD,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YACjD,OAAO,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,SAAS,CAAC;QAC5B,CAAC;KAAA;IAEK,OAAO,CAAC,OAAqB;;YACjC,MAAM,UAAU,GAAG,kBAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACtD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;YAC/D,OAAO,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,SAAS,CAAC;QAC3B,CAAC;KAAA;IAEK,MAAM,CAAC,OAAqB;;YAChC,MAAM,UAAU,GAAG,kBAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACtD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;YAC1D,OAAO,KAAK,GAAG,CAAC,CAAC;QACnB,CAAC;KAAA;IAEK,SAAS,CAAC,OAAqB;;YACnC,MAAM,UAAU,GAAG,kBAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACtD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,SAAS,EAAE,CAAC;YAChE,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;IAED,KAAK;QACH,OAAO,IAAI,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;CACF;AAtFD,oDAsFC"}

package/dist/createTestEngine.d.ts

@@ -0,0 +1,3 @@
+import { ScenePart, TestEngine } from '@atomic-testing/core';
+import { Page } from '@playwright/test';
+export declare function createTestEngine<T extends ScenePart>(page: Page, partDefinitions: T): TestEngine<T>;

package/dist/createTestEngine.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTestEngine = void 0;
+const core_1 = require("@atomic-testing/core");
+const PlaywrightInteractor_1 = require("./PlaywrightInteractor");
+function createTestEngine(page, partDefinitions) {
+    const engine = new core_1.TestEngine([], new PlaywrightInteractor_1.PlaywrightInteractor(page), {
+        perform: core_1.defaultStep,
+        parts: partDefinitions,
+    });
+    return engine;
+}
+exports.createTestEngine = createTestEngine;
+//# sourceMappingURL=createTestEngine.js.map

package/dist/createTestEngine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createTestEngine.js","sourceRoot":"","sources":["../src/createTestEngine.ts"],"names":[],"mappings":";;;AAAA,+CAA0E;AAG1E,iEAA8D;AAE9D,SAAgB,gBAAgB,CAAsB,IAAU,EAAE,eAAkB;IAClF,MAAM,MAAM,GAAG,IAAI,iBAAU,CAAC,EAAE,EAAE,IAAI,2CAAoB,CAAC,IAAI,CAAC,EAAE;QAChE,OAAO,EAAE,kBAAW;QACpB,KAAK,EAAE,eAAe;KACvB,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAPD,4CAOC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { createTestEngine } from './createTestEngine';
+export { PlaywrightInteractor } from './PlaywrightInteractor';

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaywrightInteractor = exports.createTestEngine = void 0;
+var createTestEngine_1 = require("./createTestEngine");
+Object.defineProperty(exports, "createTestEngine", { enumerable: true, get: function () { return createTestEngine_1.createTestEngine; } });
+var PlaywrightInteractor_1 = require("./PlaywrightInteractor");
+Object.defineProperty(exports, "PlaywrightInteractor", { enumerable: true, get: function () { return PlaywrightInteractor_1.PlaywrightInteractor; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uDAAsD;AAA7C,oHAAA,gBAAgB,OAAA;AACzB,+DAA8D;AAArD,4HAAA,oBAAoB,OAAA"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@atomic-testing/playwright",
+  "version": "0.2.0",
+  "description": "TestZilla Playwright Adapter",
+  "main": "dist/index.js",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "postbuild": "node ../../scripts/postBuild.js"
+  },
+  "author": "Tianzhen Lin <tangent@usa.net>",
+  "keywords": [],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tangentlin/testzilla.git"
+  },
+  "dependencies": {
+    "@atomic-testing/core": "workspace:*"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.31.2",
+    "@types/node": "^16.0.0",
+    "jest": "^29.2.0",
+    "ts-jest": "^29.0.0",
+    "ts-node": "^10.9.0",
+    "typescript": "^4.9.0"
+  },
+  "peerDependencies": {
+    "@playwright/test": ">=1.30.2"
+  }
+}

package/src/PlaywrightInteractor.ts

@@ -0,0 +1,99 @@
+import {
+  IClickOption,
+  IInteractor,
+  LocatorChain,
+  LocatorType,
+  locatorUtil,
+  Optional,
+  PartLocatorType,
+} from '@atomic-testing/core';
+import { IEnterTextOption } from '@atomic-testing/core/src/types';
+import { Page } from '@playwright/test';
+
+export class PlaywrightInteractor implements IInteractor {
+  constructor(public readonly page: Page) {}
+  async selectOptionValue(locator: LocatorChain, values: string[]): Promise<void> {
+    const cssLocator = locatorUtil.toCssSelector(locator);
+    await this.page.locator(cssLocator).selectOption(values);
+  }
+
+  async getInputValue(locator: LocatorChain): Promise<Optional<string>> {
+    const cssLocator = locatorUtil.toCssSelector(locator);
+    return this.page.locator(cssLocator).inputValue();
+  }
+
+  async getSelectValues(locator: LocatorChain): Promise<Optional<readonly string[]>> {
+    const optionLocator: PartLocatorType = {
+      type: LocatorType.Css,
+      selector: 'option:checked',
+    };
+    const selectedOptionLocator = locatorUtil.append(locator, optionLocator);
+    const cssLocator = locatorUtil.toCssSelector(selectedOptionLocator);
+    const allOptions = await this.page.locator(cssLocator).all();
+    const values: string[] = [];
+    for (const option of allOptions) {
+      const value = await option.getAttribute('value');
+      if (value != null) {
+        values.push(value);
+      }
+    }
+    return values;
+  }
+
+  async enterText(locator: LocatorChain, text: string, option?: Partial<IEnterTextOption> | undefined): Promise<void> {
+    const cssLocator = locatorUtil.toCssSelector(locator);
+    await this.page.locator(cssLocator).type(text);
+  }
+
+  async click(locator: LocatorChain, option?: IClickOption): Promise<void> {
+    const cssLocator = locatorUtil.toCssSelector(locator);
+    await this.page.locator(cssLocator).click();
+  }
+
+  async getAttribute(locator: LocatorChain, name: string, isMultiple: true): Promise<readonly string[]>;
+  async getAttribute(locator: LocatorChain, name: string, isMultiple: false): Promise<Optional<string>>;
+  async getAttribute(locator: LocatorChain, name: string): Promise<Optional<string>>;
+  async getAttribute(
+    locator: LocatorChain,
+    name: string,
+    isMultiple?: boolean,
+  ): Promise<Optional<string> | readonly string[]> {
+    const cssLocator = locatorUtil.toCssSelector(locator);
+    const elLocator = this.page.locator(cssLocator);
+    if (isMultiple) {
+      const locators = await elLocator.all();
+      const values: string[] = [];
+      for (const locator of locators) {
+        const value = await locator.getAttribute(name);
+        if (value != null) {
+          values.push(value);
+        }
+      }
+      return values;
+    }
+    const value = await elLocator.getAttribute(name);
+    return value ?? undefined;
+  }
+
+  async getText(locator: LocatorChain): Promise<Optional<string>> {
+    const cssLocator = locatorUtil.toCssSelector(locator);
+    const text = await this.page.locator(cssLocator).textContent();
+    return text ?? undefined;
+  }
+
+  async exists(locator: LocatorChain): Promise<boolean> {
+    const cssLocator = locatorUtil.toCssSelector(locator);
+    const count = await this.page.locator(cssLocator).count();
+    return count > 0;
+  }
+
+  async isChecked(locator: LocatorChain): Promise<boolean> {
+    const cssLocator = locatorUtil.toCssSelector(locator);
+    const checked = await this.page.locator(cssLocator).isChecked();
+    return checked;
+  }
+
+  clone(): IInteractor {
+    return new PlaywrightInteractor(this.page);
+  }
+}

package/src/createTestEngine.ts

@@ -0,0 +1,13 @@
+import { defaultStep, ScenePart, TestEngine } from '@atomic-testing/core';
+import { Page } from '@playwright/test';
+
+import { PlaywrightInteractor } from './PlaywrightInteractor';
+
+export function createTestEngine<T extends ScenePart>(page: Page, partDefinitions: T): TestEngine<T> {
+  const engine = new TestEngine([], new PlaywrightInteractor(page), {
+    perform: defaultStep,
+    parts: partDefinitions,
+  });
+
+  return engine;
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export { createTestEngine } from './createTestEngine';
+export { PlaywrightInteractor } from './PlaywrightInteractor';