@samsara-dev/appwright 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Forge AI Private Limited
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,183 @@
+# Appwright
+
+![NPM Version](https://img.shields.io/npm/v/@samsara-dev/appwright?color=4AC61C)
+
+Appwright is a test framework for e2e testing of mobile apps. Appwright builds on top of [Appium](https://appium.io/docs/en/latest/), and can
+run tests on local devices, emulators, and remote device farms — for both iOS and Android.
+
+Appwright is one integrated package that combines an automation driver, test runner and test
+reporter. To achieve this, Appwright uses the [Playwright](https://github.com/microsoft/playwright) test runner internally, which is
+purpose-built for the e2e testing workflow.
+
+Appwright exposes an ergonomic API to automate user actions. These actions auto-wait and auto-retry
+for UI elements to be ready and interactable, which makes your tests easier to read and maintain.
+
+```ts
+import { test, expect } from "@samsara-dev/appwright";
+
+test("User can login", async ({ device }) => {
+  await device.getByText("Username").fill("admin");
+  await device.getByText("Password").fill("password");
+  await device.getByText("Login").tap();
+});
+```
+
+Links to help you get started.
+
+- [Example project](https://github.com/empirical-run/appwright/tree/main/example)
+- [Launch blog post](https://www.empirical.run/blog/appwright)
+- [Documentation](#docs)
+
+## Usage
+
+### Minimum requirements
+
+- Node 20.19.0 or higher (Appium 3 requirement)
+
+### Install
+
+```sh
+npm i --save-dev @samsara-dev/appwright
+touch appwright.config.ts
+```
+
+### Configure
+
+```ts
+// In appwright.config.ts
+import { defineConfig, Platform } from "@samsara-dev/appwright";
+export default defineConfig({
+  projects: [
+    {
+      name: "android",
+      use: {
+        platform: Platform.ANDROID,
+        device: {
+          provider: "emulator", // or 'local-device' or 'browserstack'
+        },
+        buildPath: "app-release.apk",
+      },
+    },
+    {
+      name: "ios",
+      use: {
+        platform: Platform.IOS,
+        device: {
+          provider: "emulator", // or 'local-device' or 'browserstack'
+        },
+        buildPath: "app-release.app", // Path to your .app file
+      },
+    },
+  ],
+});
+```
+
+### Configuration Options
+
+- `platform`: The platform you want to test on, such as 'android' or 'ios'.
+
+- `provider`: The device provider where you want to run your tests.
+              You can choose between `browserstack`, `lambdatest`, `emulator`, or `local-device`.
+
+- `buildPath`: The path to your build file. For Android, it should be an APK file.
+               For iOS, if you are running tests on real device, it should be an `.ipa` file. For running tests on an emulator, it should be a `.app` file.
+
+### Run tests
+
+To run tests, you need to specify the project name with `--project` flag.
+
+```sh
+npx appwright test --project android
+npx appwright test --project ios
+```
+
+#### Run tests on BrowserStack
+
+Appwright supports BrowserStack out of the box. To run tests on BrowserStack, configure
+the provider in your config.
+
+```ts
+{
+  name: "android",
+  use: {
+    platform: Platform.ANDROID,
+    device: {
+      provider: "browserstack",
+      // Specify device to run the tests on
+      // See supported devices: https://www.browserstack.com/list-of-browsers-and-platforms/app_automate
+      name: "Google Pixel 8",
+      osVersion: "14.0",
+      appiumVersion: "3.1.0", // Override if your BrowserStack account does not yet support Appium 3
+    },
+    buildPath: "app-release.apk",
+  },
+},
+```
+
+#### Run tests on LambdaTest
+
+Appwright supports LambdaTest out of the box. To run tests on LambdaTest, configure
+the provider in your config.
+
+```ts
+{
+  name: "android",
+  use: {
+    platform: Platform.ANDROID,
+    device: {
+      provider: "lambdatest",
+      // Specify device to run the tests on
+      // See supported devices: https://www.lambdatest.com/list-of-real-devices
+      name: "Pixel 8",
+      osVersion: "14",
+      appiumVersion: "3.1.0", // Override if your LambdaTest account does not yet support Appium 3
+    },
+    buildPath: "app-release.apk",
+  },
+},
+```
+
+## Run the sample project
+
+To run the sample project:
+
+- Navigate to the `example` directory.
+
+```sh
+cd example
+```
+
+- Install dependencies.
+
+```sh
+npm install
+```
+
+- Run the tests
+
+Run the following command to execute tests on an Android emulator:
+
+```sh
+npx appwright test --project android
+```
+
+To run the tests on iOS simulator:
+
+- Unzip the `wikipedia.zip` file
+
+```sh
+npm run extract:app
+```
+- Run the following command:
+
+```sh
+npx appwright test --project ios
+```
+
+## Docs
+
+- [Basics](docs/basics.md)
+- [Configuration](docs/config.md)
+- [Locators](docs/locators.md)
+- [Assertions](docs/assertions.md)
+- [API reference](docs/api-reference.md)

package/dist/bin/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/bin/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/bin/index.ts"],"names":[],"mappings":""}

package/dist/bin/index.js

@@ -0,0 +1,53 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const child_process_1 = require("child_process");
+const logger_1 = require("../logger");
+function cmd(command, options) {
+    let errorLogs = [];
+    return new Promise((resolveFunc, rejectFunc) => {
+        let p = (0, child_process_1.spawn)(command[0], command.slice(1), {
+            env: { ...process.env, ...options.env },
+        });
+        p.stdout.on("data", (x) => {
+            const log = x.toString();
+            if (log.includes("Error")) {
+                errorLogs.push(log);
+            }
+            process.stdout.write(log);
+        });
+        p.stderr.on("data", (x) => {
+            const log = x.toString();
+            process.stderr.write(x.toString());
+            errorLogs.push(log);
+        });
+        p.on("exit", (code) => {
+            if (code != 0) {
+                // assuming last log is the error message before exiting
+                rejectFunc(errorLogs.slice(-3).join("\n"));
+            }
+            else {
+                resolveFunc(code);
+            }
+        });
+    });
+}
+async function runPlaywrightCmd(args) {
+    const pwRunCmd = `npx playwright ${args}`;
+    return cmd(pwRunCmd.split(" "), {});
+}
+(async function main() {
+    const defaultConfigFile = `appwright.config.ts`;
+    const pwOptions = process.argv.slice(2);
+    if (!pwOptions.includes("--config")) {
+        pwOptions.push(`--config`);
+        pwOptions.push(defaultConfigFile);
+    }
+    try {
+        await runPlaywrightCmd(pwOptions.join(" "));
+    }
+    catch (error) {
+        logger_1.logger.error(`Error while running playwright test: ${error}`);
+        process.exit(1);
+    }
+})();

package/dist/config.d.ts

@@ -0,0 +1,4 @@
+import { PlaywrightTestConfig } from "@playwright/test";
+import { AppwrightConfig } from "./types";
+export declare function defineConfig(config: PlaywrightTestConfig<AppwrightConfig>): PlaywrightTestConfig<AppwrightConfig, {}>;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,oBAAoB,EAErB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAsC1C,wBAAgB,YAAY,CAAC,MAAM,EAAE,oBAAoB,CAAC,eAAe,CAAC,6CAyBzE"}

package/dist/config.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineConfig = defineConfig;
+const test_1 = require("@playwright/test");
+const path_1 = __importDefault(require("path"));
+const logger_1 = require("./logger");
+const resolveGlobalSetup = () => {
+    const pathToInstalledAppwright = require.resolve(".");
+    const directory = path_1.default.dirname(pathToInstalledAppwright);
+    return path_1.default.join(directory, "global-setup.js");
+};
+const resolveVideoReporter = () => {
+    const pathToInstalledAppwright = require.resolve(".");
+    const directory = path_1.default.dirname(pathToInstalledAppwright);
+    return path_1.default.join(directory, "reporter.js");
+};
+const defaultConfig = {
+    globalSetup: resolveGlobalSetup(),
+    testDir: "./tests",
+    // This is turned off so that a persistent device fixture can be
+    // used across tests in a file where they run sequentially
+    fullyParallel: false,
+    forbidOnly: false,
+    retries: process.env.CI ? 2 : 0,
+    workers: 2,
+    reporter: [["list"], ["html", { open: "always" }]],
+    use: {
+        // TODO: Use this for actions
+        actionTimeout: 20_000,
+        expectTimeout: 20_000,
+    },
+    expect: {
+        // This is not used right now
+        timeout: 20_000,
+    },
+    timeout: 0,
+};
+function defineConfig(config) {
+    const hasGlobalSetup = config.globalSetup !== undefined;
+    if (hasGlobalSetup) {
+        logger_1.logger.warn("The `globalSetup` parameter in config will be ignored. See https://github.com/empirical-run/appwright/issues/57");
+        delete config.globalSetup;
+    }
+    let reporterConfig;
+    if (config.reporter) {
+        reporterConfig = config.reporter;
+    }
+    else {
+        reporterConfig = [["list"], ["html", { open: "always" }]];
+    }
+    return (0, test_1.defineConfig)({
+        ...defaultConfig,
+        ...config,
+        reporter: [[resolveVideoReporter()], ...reporterConfig],
+        use: {
+            ...defaultConfig.use,
+            expectTimeout: config.use?.expectTimeout
+                ? config.use.expectTimeout
+                : defaultConfig.use?.expectTimeout,
+        },
+    });
+}

package/dist/device/index.d.ts

@@ -0,0 +1,171 @@
+import type { Client as WebDriverClient } from "webdriver";
+import { AppwrightLocator, ExtractType, Platform, TimeoutOptions } from "../types";
+import { z } from "zod";
+import { LLMModel } from "@empiricalrun/llm";
+export declare class Device {
+    private webDriverClient;
+    private bundleId;
+    private timeoutOpts;
+    private provider;
+    constructor(webDriverClient: WebDriverClient, bundleId: string | undefined, timeoutOpts: TimeoutOptions, provider: string);
+    locator({ selector, findStrategy, textToMatch, }: {
+        selector: string;
+        findStrategy: string;
+        textToMatch?: string | RegExp;
+    }): AppwrightLocator;
+    private vision;
+    beta: {
+        tap: (prompt: string, options?: {
+            useCache?: boolean;
+            telemetry?: {
+                tags?: string[];
+            };
+        }) => Promise<{
+            x: number;
+            y: number;
+        }>;
+        query: <T extends z.ZodType>(prompt: string, options?: {
+            responseFormat?: T;
+            model?: LLMModel;
+            screenshot?: string;
+            telemetry?: {
+                tags?: string[];
+            };
+        }) => Promise<ExtractType<T>>;
+    };
+    /**
+     * Closes the automation session. This is called automatically after each test.
+     *
+     * **Usage:**
+     * ```js
+     * await device.close();
+     * ```
+     */
+    close(): Promise<void>;
+    /**
+     * Tap on the screen at the given coordinates, specified as x and y. The top left corner
+     * of the screen is { x: 0, y: 0 }.
+     *
+     * **Usage:**
+     * ```js
+     * await device.tap({ x: 100, y: 100 });
+     * ```
+     *
+     * @param coordinates to tap on
+     * @returns
+     */
+    tap({ x, y }: {
+        x: number;
+        y: number;
+    }): Promise<void>;
+    /**
+     * Locate an element on the screen with text content. This method defaults to a
+     * substring match, and this be overridden by setting the `exact` option to `true`.
+     *
+     * **Usage:**
+     * ```js
+     * // with string
+     * const submitButton = device.getByText("Submit");
+     *
+     * // with RegExp
+     * const counter = device.getByText(/^Counter: \d+/);
+     * ```
+     *
+     * @param text string or regular expression to search for
+     * @param options
+     * @returns
+     */
+    getByText(text: string | RegExp, { exact }?: {
+        exact?: boolean;
+    }): AppwrightLocator;
+    /**
+     * Locate an element on the screen with accessibility identifier. This method defaults to
+     * a substring match, and this can be overridden by setting the `exact` option to `true`.
+     *
+     * **Usage:**
+     * ```js
+     * const element = await device.getById("signup_button");
+     * ```
+     *
+     * @param text string to search for
+     * @param options
+     * @returns
+     */
+    getById(text: string, { exact }?: {
+        exact?: boolean;
+    }): AppwrightLocator;
+    /**
+     * Locate an element on the screen with xpath.
+     *
+     * **Usage:**
+     * ```js
+     * const element = await device.getByXpath(`//android.widget.Button[@text="Confirm"]`);
+     * ```
+     *
+     * @param xpath xpath to locate the element
+     * @returns
+     */
+    getByXpath(xpath: string): AppwrightLocator;
+    /**
+     * Helper method to detect the mobile OS running on the device.
+     *
+     * **Usage:**
+     * ```js
+     * const platform = device.getPlatform();
+     * ```
+     *
+     * @returns "android" or "ios"
+     */
+    getPlatform(): Platform;
+    terminateApp(bundleId?: string): Promise<void>;
+    activateApp(bundleId?: string): Promise<void>;
+    /**
+     * Retrieves text content from the clipboard of the mobile device. This is useful
+     * after a "copy to clipboard" action has been performed. This returns base64 encoded string.
+     *
+     * **Usage:**
+     * ```js
+     * const clipboardText = await device.getClipboardText();
+     * ```
+     *
+     * @returns Returns the text content of the clipboard in base64 encoded string.
+     */
+    getClipboardText(): Promise<string>;
+    /**
+     * Sets a mock camera view using the specified image. This injects a mock image into the camera view.
+     * Currently, this functionality is supported only for BrowserStack.
+     *
+     * **Usage:**
+     * ```js
+     * await device.setMockCameraView(`screenshot.png`);
+     * ```
+     *
+     * @param imagePath path to the image file that will be used as the mock camera view.
+     * @returns
+     */
+    setMockCameraView(imagePath: string): Promise<void>;
+    pause(): Promise<void>;
+    waitForTimeout(timeout: number): Promise<void>;
+    /**
+     * Get a screenshot of the current screen as a base64 encoded string.
+     */
+    screenshot(): Promise<string>;
+    /**
+     * [iOS Only]
+     * Scroll the screen from 0.2 to 0.8 of the screen height.
+     * This can be used for controlled scroll, for auto scroll checkout `scroll` method from locator.
+     *
+     * **Usage:**
+     * ```js
+     * await device.scroll();
+     * ```
+     *
+     */
+    scroll(): Promise<void>;
+    /**
+     * Send keys to already focused input field.
+     * To fill input fields using the selectors use `sendKeyStrokes` method from locator
+     */
+    sendKeyStrokes(value: string): Promise<void>;
+}
+//# sourceMappingURL=index.d.ts.map