fix: fixes after review

wix-incubator · Feb 18, 2025 · e7f0bf8 · e7f0bf8
2 parents 3f1691f + b754536
commit e7f0bf8
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 19 deletions.
diff --git a/packages/drivers/appium/examples/example.test.ts b/packages/drivers/appium/examples/example.test.ts
@@ -7,7 +7,7 @@ describe("Example Test Suite", () => {
 
   before(async () => {
     const promptHandler: PromptHandler = new PromptHandler();
-    frameworkDriver = new WebdriverIOAppiumFrameworkDriver();
+    frameworkDriver = new WebdriverIOAppiumFrameworkDriver(() => browser);
 
     pilot.init({
       frameworkDriver,

diff --git a/packages/drivers/appium/wdio.conf.ts → ...ages/drivers/appium/examples/wdio.conf.ts b/packages/drivers/appium/wdio.conf.ts → ...ages/drivers/appium/examples/wdio.conf.ts
@@ -2,7 +2,7 @@ import path from "path";
 
 export const config = {
   runner: "local",
-  specs: ["./examples/**/*.test.ts"],
+  specs: ["./**/*.test.ts"],
   maxInstances: 1,
 
   capabilities: [
@@ -12,7 +12,7 @@ export const config = {
       "appium:automationName": "XCUITest",
       "appium:app": path.resolve(
         __dirname,
-        "../detox/ExampleApp/ios/build/Build/Products/Release-iphonesimulator/ExampleApp.app",
+        "../../detox/ExampleApp/ios/build/Build/Products/Release-iphonesimulator/ExampleApp.app",
       ),
     },
   ],
@@ -35,8 +35,4 @@ export const config = {
     ui: "bdd",
     timeout: 600000,
   },
-
-  before: function () {
-    global.driver = browser;
-  },
 };
diff --git a/packages/drivers/appium/global.d.ts b/packages/drivers/appium/global.d.ts
@@ -1,10 +1,7 @@
-// global.d.ts
-import type { Browser } from "@wdio/types";
+import type { Browser } from "webdriverio";
 
 declare global {
-  // eslint-disable-next-line no-var
-  var driver: Browser;
-  const browser: Browser;
+  const browser: Browser<"async">;
 }
 
 export {};
diff --git a/packages/drivers/appium/index.ts b/packages/drivers/appium/index.ts
@@ -4,10 +4,12 @@ import {
 } from "@wix-pilot/core";
 import * as fs from "fs";
 import * as path from "path";
+import type { Browser } from "webdriverio";
 
 export class WebdriverIOAppiumFrameworkDriver
   implements TestingFrameworkDriver
 {
+  constructor(private getDriver: () => Browser) {}
   /**
    * Attempts to capture the current view hierarchy (source) of the mobile app as XML.
    * If there's no active session or the app isn't running, returns an error message.
@@ -16,7 +18,7 @@ export class WebdriverIOAppiumFrameworkDriver
     try {
       // In WebdriverIO + Appium, you can retrieve the current page source (UI hierarchy) via:
       // https://webdriver.io/docs/api/browser/getPageSource (driver is an alias for browser)
-      const pageSource = await driver.getPageSource();
+      const pageSource = await this.getDriver().getPageSource();
       return pageSource;
     } catch (_error) {
       return "NO ACTIVE APP FOUND, LAUNCH THE APP TO SEE THE VIEW HIERARCHY";
@@ -39,11 +41,12 @@ export class WebdriverIOAppiumFrameworkDriver
     try {
       // In WebdriverIO + Appium, driver.takeScreenshot() returns a base64-encoded PNG
       // https://webdriver.io/docs/api/browser/takeScreenshot
-      const base64Image = await driver.takeScreenshot();
+      const base64Image = await this.getDriver().takeScreenshot();
       const buffer = Buffer.from(base64Image, "base64");
       fs.writeFileSync(filePath, buffer);
       return filePath;
     } catch (_error) {
+      console.log(_error);
       return undefined;
     }
   }
@@ -58,7 +61,7 @@ export class WebdriverIOAppiumFrameworkDriver
       description:
         "WebdriverIO is a browser and mobile automation library; Appium is a cross-platform automation framework for native, hybrid, and mobile web apps.",
       context: {
-        webdriverDriver: driver,
+        driver: this.getDriver(),
       },
       categories: [
         {

diff --git a/packages/drivers/appium/package.json b/packages/drivers/appium/package.json
@@ -17,7 +17,7 @@
   "scripts": {
     "build": "tsc && tsc-alias",
     "test": "echo No tests available for this package",
-    "test:example": "wdio run wdio.conf.ts",
+    "test:example": "wdio run examples/wdio.conf.ts",
     "build:app": "cd ../detox/ExampleApp &&  npm run build:ios",
     "bump-version:patch": "npm version patch && git commit -am 'chore: bump patch version' && git push",
     "release:patch": "npm run test && npm run bump-version:patch && npm run build && npm publish --access public",

diff --git a/packages/drivers/appium/tsconfig.json b/packages/drivers/appium/tsconfig.json
@@ -9,14 +9,13 @@
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
     "rootDir": "./",
-    "types": ["jest", "node"],
+    "types": ["jest", "node", "mocha"],
     "baseUrl": "./",
     "resolveJsonModule": true
   },
   "include": ["./"],
   "exclude": [
     "node_modules",
     "dist",
-    "examples",
-  ]
+    ]
 }
diff --git a/website/docs/pages/supported-frameworks.md b/website/docs/pages/supported-frameworks.md
@@ -20,6 +20,28 @@ it('should update profile', async () => {
 });
 ```
 
+### WebdriverIO with Appium
+
+WebdriverIO integration with Appium. supports both iOS and Android testing
+
+```js
+// 1. Install: npm install --save-dev @wix-pilot/webdriverio-appium
+// 2. Import:
+import { WebdriverIOAppiumFrameworkDriver } from '@wix-pilot/webdriverio-appium';
+// 3. make sure you intalize the the framework driver with your global browser instance:
+frameworkDriver = new WebdriverIOAppiumFrameworkDriver(() => browser);
+
+it('should update profile', async () => {
+  await pilot.perform(
+    'Launch the app',
+    'Navigate to Settings',
+    'Tap on "Edit Profile"',
+    'Update username to "john_doe"',
+    'Verify changes are saved'
+  );
+});
+```
+
 ## Web Testing Support
 
 ### Playwright