diff --git a/docs/cypress-cli-commands.md b/docs/cypress-cli-commands.md index dfa990d0a..62993d7eb 100644 --- a/docs/cypress-cli-commands.md +++ b/docs/cypress-cli-commands.md @@ -1,7 +1,7 @@ --- id: cypress-cli-commands title: List of LambdaTest Cypress CLI Commands -hide_title: true +hide_title: false sidebar_label: Cypress CLI Commands description: List of all the commands and arguments supported by LambdaTest-Cypress CLI. keywords: @@ -9,56 +9,72 @@ keywords: - lambdatest cypress cli commands - lambdatest cypress cli flags - lambdatest cypress cli arguments - url: https://www.lambdatest.com/support/docs/cypress-cli-commands/ site_name: LambdaTest slug: cypress-cli-commands/ --- -# List of LambdaTest Cypress CLI Commands ---- - - -Check out the list of all the commands supported by LambdaTest-Cypress CLI. - -Following is the syntax for using the LambdaTest-Cypress CLI commands. - + +The LambdaTest-Cypress CLI provides a set of commands to streamline and enhance your testing workflows on the LambdaTest platform. Below is a comprehensive list of supported commands and their usage. + +## General Syntax +To use any command in the LambdaTest-Cypress CLI, follow this basic syntax: ```bash lambdatest-cypress [options] ``` | Command / Arg | Purpose | | -------------- | ------------------------------------------------------ | -| **--help** | To get information of all the commands that can be run | -| **init** | To create an initial config file | -| **run** | To run tests on LambdaTest | -| **build-info** | To get information about the build | -| **build-stop** | To stop all the tests in the build | -| **generate-report** | To generate the test session report | - -## init command ---- - -The init command to generate a initial lambdatest configuration file. +| `--help` | To get information of all the commands that can be run | +| `init` | To create an initial config file | +| `run` | To run tests on LambdaTest | +| `build-info` | To get information about the build | +| `build-stop` | To stop all the tests in the build | +| `generate-report` | To generate the test session report | +| `--vip, --vi-project` | To set the smart ui project name.
The acceptable data type is `string` | +| `--vib , --vi-build` | To set the smart ui build name.
The acceptable data type is `string` | +| `--vibase , --vi-base` | To set that build as baseline for smart ui.
The acceptable data type is `boolean` | + +## `init` command +The `init` command to generate a initial lambdatest configuration file. ``` lambdatest-cypress init ``` -**Example:** +Image

-Image

+On running the above command, it will generate `base_reporter_config.json`,`custom_support_file.js` and `lambdatest-config.json` files. -On running the above command, it will generate `base_reporter_config.json`,`custom_support_file.js` and `lambdatest-config.json ` files. +- **`base_reporter_config.json`**: This is the configuration file for mochawesome reporter, that LambdaTest uses to generate mochawesome reports which in turn is used to generate the commands section on the LambdaTest dashboard. For Cypress 10, the absence of this file may lead to the commands section not being visible on the dashboard. -1. `base_reporter_config.json` - It is the configuration file for mochawesome reporter, that LambdaTest uses to generate mochawesome reports which in turn is used to generate the commands section on the LambdaTest dashboard. For Cypress 10, the absence of this file may lead to the commands section not being visible on the dashboard. +- **`custom_support_file.js`**: By default, Cypress automatically captures screenshots when a test fails. For Cypress 10, in order to make the screenshot visible with the failed tests on our dashboard, we recommend you move and import this file as recommended. -2. `custom_support_file.js` - By default, Cypress automatically captures screenshots when a test fails. For Cypress 10, in order to make the screenshot visible with the failed tests on our dashboard, we recommend you move and import this file as recommended. +- **`lambdatest-config.json`**: This file contains configurations like LambdaTest credentials, capabilities, run settings etc., that are required to run the test. -3. `lambdatest-config.json` - This file contains configurations like LambdaTest credentials, capabilities, run settings etc., that are required to run the test. - -## Run command ---- +## `run` command :::info Note For detailed examples of each Cypress flag, please visit our guide [Configuring Cypress Test Execution](https://www.lambdatest.com/support/docs/run-settings/). @@ -72,40 +88,38 @@ lambdatest-cypress run Given below are the additional flags available with the `run` command. -| Flag | Purpose | Type | -| ---------------------------------- | ------------------------------------------------------ | -----| -| **--version** | Show version number |Boolean| -| **--help** | Show help |Boolean| -| **--ccf, --cypress-config-file** | Path of the config file |String | -| **--lcf, –lambdatest-config-file** | Path of the LambdaTest config file |String | -| **-s, --specs** | Path of the spec file or directory or pattern |String | -| **--bn, --build-name** | Build name |String | -| **-t, --tags** | Test tags |String | -| **-p, --parallels** | No of parallel sessions |String | -| **--envs, --env-variables** (For Cypress 9) | Set environment variables to configure before your test runs |String | -| **--envs, --environment** ( For Cypress 10) | Set environment variables to configure before your test runs |String | -| **--tun, --tunnel** | Configure LambdaTest tunnel |String | -| **--tname, --tunnel_name** | Set the name of LambdaTest tunnel name |String | -| **--brs, --browsers** | Test will be run on the specified browsers
in the format: `platform:browser:version`

e.g. **`--brs="MacOS Catalina:chrome:latest"`**

**`--brs="MacOS Catalina:chrome:112.0,MacOS mojave:firefox:111.0"`** |String | -| **--bi, --build-identifier** | Build identifier or build counter |String | -| **--if, --ignore_files** | Files to ignore in the zip project |String | -| **--sync, --sync-mode** | Wait on terminal to get the status of the tests |String | -| **--autostart, --tat** | LambdaTest Tunnel auto Start |String | -| **--headless, --headless-mode** | Run in Headless mode |Boolean | -| **--net, --network** | To capture Network logs |String | -| **--eof, --exit-on-failure** | Exit with Code 1 on failure |String | -| **--cy, --cypress_settings** | Pass Cypress settings |String | -| **--geo, --geo_location** | Pass Geo country code |String | -| **--sof, --stop_on_failure** | Stop other tests if any test in session gets errored out |String | -| **--ra, --reject_unauthorized** | Default rejects self signed certificates in external requests |String | -| **--bt, --build-tags** | Build tags | String | -| **--sys-envs, --sys-env-variables** | To set system variables during test run time |String | -| **--npm-lpd=true, --legacy-peer-deps=true** | Ignore peer dependencies and proceed with the NPM installation | String | -| **--npm-f=true, --npm-force=true** | Fetch remote resources even if a local copy already exists |String | - -## Build info command ---- - +| Flag | Purpose | Type | +| ----------------------------------------- | ------------------------------------------------------ | -----| +| `--version` | Show version number
e.g. `lambdatest-cypress run -–version` |NA| +| `--help` | Show help
e.g. `lambdatest-cypress run -–help` |NA| +| `--ccf, --cypress-config-file` | Path of the config file
e.g. `lambdatest-cypress run --ccf="base_reporter_config.json"` |String | +| `--lcf, –lambdatest-config-file` | Path of the LambdaTest config file
e.g. `lambdatest-cypress run --lcf="lambdatest-config.json"` |String | +| `-s, --specs` | Path of the spec file or directory or pattern
e.g. `lambdatest-cypress run --s=”path_from_content_root"` |String | +| `--bn, --build-name` | Build name |String | +| `-t, --tags` | Test tags |String | +| `-p, --parallels` | No of parallel sessions |String | +| `--envs, --env-variables` (Cypress 9) | Set environment variables to configure before your test runs |String | +| `--envs, --environment` (Cypress 10) | Set environment variables to configure before your test runs |String | +| `--tun, --tunnel` | Configure LambdaTest tunnel
e.g. `lambdatest-cypress run --tun="true" –tname="v3"` |String | +| `--tname, --tunnel_name` | Set the name of LambdaTest tunnel name
e.g. `lambdatest-cypress run --tun="true" –tname="v3"` |String | +| `--brs, --browsers` | Test will be run on the specified browsers
in the format: `platform:browser:version`

e.g. `--brs="MacOS Catalina:chrome:latest"`

`--brs="MacOS Catalina:chrome:112.0,MacOS mojave:firefox:111.0"` |String | +| `--bi, --build-identifier` | Build identifier or build counter |String | +| `--if, --ignore_files` | Files to ignore in the zip project
e.g. `lambdatest-cypress run --if="cypress/e2e/1-getting-started/actions.cy.js"` |String | +| `--sync, --sync-mode` | Wait on terminal to get the status of the tests
e.g. `lambdatest-cypress run --sync=true` |String | +| `--autostart, --tat` | LambdaTest Tunnel auto Start
e.g. `lambdatest-cypress run --autostart=true` |String | +| `--headless, --headless-mode` | Run in Headless mode
e.g. `lambdatest-cypress run --headless=true` |Boolean | +| `--net, --network` | To capture Network logs
e.g. `lambdatest-cypress run --net="true"` |String | +| `--eof, --exit-on-failure` | Exit with Code 1 on failure
e.g. `lambdatest-cypress run ---exit-on-failure=”true”` |String | +| `--cy, --cypress_settings` | Pass Cypress settings
e.g. `lambdatest-cypress run --cy=viewportWidth=1000;viewportHeight=660;` |String | +| `--geo, --geo_location` | Pass Geo country code
e.g. `lambdatest-cypress run ---geo_location=AU`
Check all the available Geolocations. |String | +| `--sof, --stop_on_failure` | Stop other tests if any test in session gets errored out
e.g. `lambdatest-cypress run --stop_on_failure=true` |String | +| `--ra, --reject_unauthorized` | Default rejects self signed certificates in external requests
e.g. `lambdatest-cypress run --reject_unauthorized=true` |String | +| `--bt, --build-tags` | Build tags
e.g. `lambdatest-cypress run --build-tags=tag1` | String | +| `--sys-envs, --sys-env-variables` | To set system variables during test run time
e.g. `lambdatest-cypress run --sys-envs="BASE_URL=https://lambdatest.com;"` |String | +| `--npm-lpd=true, --legacy-peer-deps=true` | Ignore peer dependencies and proceed with the NPM installation | String | +| `--npm-f=true, --npm-force=true` | Fetch remote resources even if a local copy already exists
e.g. `lambdatest-cypress run --npm-force=true` |String | + +## `build-info` command You can use the `build-info` command to get information on the build. ```bash @@ -116,17 +130,13 @@ Given below are the additional arguments available with the `build-info` command | Flag | Purpose | Type | | --------| -----------| -----| -| **--id, --build-id** | Build Identifier | String, Required | -| **--user, --username** | Your LambdaTest username | String | -| **--ak, --access_key** | Your LambdaTest access key | String | - -**Example:** +| `--id, --build-id` | Build Identifier | String, Required | +| `--user, --username` | Your LambdaTest username | String | +| `--ak, --access_key` | Your LambdaTest access key | String | Image -## Build stop command ---- - +## `build-stop` command You can use the `build-stop` command to stop all the test in the build. ```bash @@ -137,36 +147,13 @@ Given below are the additional arguments available with the `build-stop` command | Flag | Purpose | | -------------------- | --------- | -| **--id, --session_id** | Identifies the session | -| **--sls, --stop_last_session** | Stop the last test session | +| `--id, --session_id` | Identifies the session | +| `--sls, --stop_last_session` | Stop the last test session | -**Example**: `--stop_last_session` +- `--stop_last_session` Image -**Example**: `--session_id` - -Image - - - - +- `--session_id` +Image \ No newline at end of file diff --git a/docs/lambdatest-public-ip.md b/docs/lambdatest-public-ip.md index 54b4e4a02..ef70360f7 100644 --- a/docs/lambdatest-public-ip.md +++ b/docs/lambdatest-public-ip.md @@ -93,12 +93,10 @@ These are the list of the IP ranges that you need to whitelist with respect to t - **23.82.88.184** - **23.106.34.219** - **23.106.54.77** - ->Below are IPs that will be deprecated soon -> - 3.214.241.254 -> - 52.36.84.247 -> - 13.126.37.58 -> - 3.66.78.89 +- **3.214.241.254** +- **52.36.84.247** +- **13.126.37.58** +- **3.66.78.89** ## LambdaTest Integration Tools -- **3.208.126.109** +- **3.208.126.109** \ No newline at end of file diff --git a/docs/smartui-playwright-java-sdk.md b/docs/smartui-playwright-java-sdk.md new file mode 100644 index 000000000..102486518 --- /dev/null +++ b/docs/smartui-playwright-java-sdk.md @@ -0,0 +1,458 @@ +--- +id: smartui-playwright-java-sdk +title: Integrate SmartUI SDK with Playwright - Java +sidebar_label: Java +description: In this documentation, learn how integrate your Playwright Java automated tests with LambdaTest's SmartUI. +keywords: + - Visual Regression + - Visual Regression Testing Guide + - Visual Regression Test Automation + - Visual Regression Automation Testing + - Running Visual Regression Tests + - Visual Regression Testing Online + - Run Visual Regression + - Visual Regression Run Specific Test + - Visual Regression Testing Environment + - How to Run Visual Regression Tests + +url: https://www.lambdatest.com/support/docs/smartui-playwright-java-sdk/ +slug: smartui-playwright-java-sdk/ +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import NewTag from '../src/component/newTag'; +import CodeBlock from '@theme/CodeBlock'; +import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys"; + + +The SmartUI SDK is a powerful tool that simplifies the process of capturing, comparing, and analyzing screenshots across multiple browsers and resolutions. By combining the strengths of Playwright's automation capabilities with SmartUI's visual testing features, you can: + +- Ensure your application's UI is consistent across all supported environments. +- Detect and address visual discrepancies early in the development lifecycle. +- Streamline your testing process with minimal setup and maximum coverage. + +This documentation provides step-by-step instructions for developers and QA engineers to integrate the SmartUI SDK with Playwright-Java, enabling reliable and efficient visual regression testing. + +## Prerequisites + +- Basic understanding of Command Line Interface and Playwright is required. +- Login to [LambdaTest SmartUI](https://smartui.lambdatest.com/) with your credentials. + +## Steps to run your first test +Follow these steps to successfully run your first visual regression test on the LambdaTest platform with the SmartUI Playwright SDK integration. + +### Step 1: Create a SmartUI Project + +The first step is to create a project with the application in which we will combine all your builds run on the project. To create a SmartUI Project, follow these steps: + +1. Go to [Projects page](https://smartui.lambdatest.com/) +2. Click on the `new project` button +3. Select the platform as CLI for executing your `SDK` tests. +4. Add name of the project, approvers for the changes found, tags for any filter or easy navigation. +5. Click on the **Submit**. + +### Step 2: Configure Your Test Suite + +You can use your own project to configure and test it. For demo purposes, we are using the sample repository. + +:::tip Sample repo +Download or Clone the code sample for the Java from the LambdaTest GitHub repository to run the tests on the SmartUI. + +Image View on GitHub +::: + +### Step 3: Install the Dependencies + +Update your dependencies in `pom.xml` file Install required modules for LambdaTest Smart UI SDK in your frontend project. + +```bash +npm i @lambdatest/smartui-cli @lambdatest/playwright-driver playwright +mvn clean compile +``` + +### Step 4: Setup your credentials + + + + + +
+ + {`export LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" +export LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" +export PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`} + +
+ + + + + +
+ + {`set LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" +set LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" +set PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`} + +
+ + + + + +
+ + {`$Env:LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" +$Env:LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" +$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`} + + +
+ + + + + + +cmd + + +### Step 5: Create and Configure SmartUI Config + +You can now configure your project configurations on using various available options to run your tests with the SmartUI integration. To generate the configuration file, please execute the following command: + +```bash +npx smartui config:create smartui-web.json +``` + +Once, the configuration file will be created, you will be seeing the default configuration pre-filled in the configuration file: + +```json title="/smartui-sdk-project/.smartui.json" +{ + "web": { + "browsers": [ + "chrome", + "firefox", + "safari", + "edge" + ], + "viewports": [ + [ + 1920 + ], + [ + 1366 + ], + [ + 1028 + ] + ] // Full Page screenshots are captured by default for web viewports + }, + "mobile": { + "devices": [ + "iPhone 14", //iPhone 14 viewport + "Galaxy S24" //Galaxy S24 viewport + ], + "fullPage": true, //Full Page is true by default for mobile viewports + "orientation": "portrait" //Change to "landscape" for landscape snapshot + }, + "waitForTimeout": 1000, //Optional (Should only be used in case lazy-loading/async components are present) + "waitForPageRender": 50000, //Optional (Should only be used in case of websites which take more than 30s to load) + "enableJavaScript": false, //Enable javascript for all the screenshots of the project + "allowedHostnames": [] //Additional hostnames to capture assets from +} +``` +:::info Advanced options in SmartUI configuration +- For capturing fullpage or viewport screenshots, please refer to this [documentation](/docs/smartui-sdk-config-options/#12-viewports) +- For the list of available mobile viewports, please refer to this [documentation](/docs/smartui-sdk-config-options/#list-of-supported-device-viewports) +- For more information about SmartUI config global options, please refer to this [documentation](/docs/smartui-sdk-config-options/#3-global-options-optional). +::: + +### Step 6: Adding SmartUI function to take screenshot +You can incorporate SmartUI into your custom `Playwright` automation test (any platform) script by adding the `smartuiSnapshot` function in the required segment of Playwright script of which we would like to take the screenshot, as shown below: + +```java reference +https://github.com/LambdaTest/smartui-java-playwright-sample/blob/main/src/test/java/com/lambdatest/SmartUISDKPlaywrightCloud.java +``` + +### Step 6: Execute the Tests on SmartUI Cloud + +Execute visual regression tests on SmartUI using the following commands + +```bash +npx smartui exec -- mvn test -D suite=sdk-playwright-local-java.xml +``` + +:::note +You may use the `npx smartui --help` command in case you are facing issues during the execution of SmartUI commands in the CLI. +::: + +## View SmartUI Results + +You have successfully integrated SmartUI SDK with your Playwright tests. Visit your SmartUI project to view builds and compare snapshots between different test runs. + +You can see the Smart UI dashboard to view the results. This will help you identify the Mismatches from the existing `Baseline` build and do the required visual testing. + + +cmd + +## Arguments supported in the `smartUISnapshot` function + +The following are the different options which are currently supported: + +| Key | Description | +| ------------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| `driver` (instance) | The instance of the web driver used in your tests. | +| `"Screenshot Name"` (string) | Specify a name for the screenshot in your tests to match the same screenshot with the name from your baseline. | +| `options` (object) | Specify one or a combination of selectors in the `ignoreDOM` or `selectDOM` objects. These selectors can be based on `HTML DOM IDs, CSS classes, CSS selectors, or XPaths` used by your webpage. They define elements that should be excluded from or included in the visual comparison.| + + +## Handling Dynamic Data in SmartUI SDK **** + +When conducting visual tests, you may encounter scenarios where certain elements within your application change between test runs. These changes might introduce inconsistencies in your test results.You can ignore / select specific element(s) to be removed from the comparison by parsing the options in the `smartuiSnapshot` function in the following way + + + + + +```java title="This is a sample for your configuration for Java to ignore by ID" +List cssID = Arrays.asList(""); +Map options = new HashMap<>(); +Map> ignore = new HashMap<>(); +ignore.put("id", cssID); +options.put("ignoreDOM", ignore); + +driver.get("Required URL"); +SmartUISnapshot.smartuiSnapshot(driver, "Screenshot Name", options); +``` + + + + +```java title="This is a sample for your configuration for Java to ignore by Class" +List cssclass = Arrays.asList(""); +Map options = new HashMap<>(); +Map> ignore = new HashMap<>(); +ignore.put("class", cssclass); +options.put("ignoreDOM", ignore); + +driver.get("Required URL"); +SmartUISnapshot.smartuiSnapshot(driver, "Screenshot Name", options); +``` + + + + +```java title="This is a sample for your configuration for Java to ignore by XPath" +List path = Arrays.asList(""); +Map options = new HashMap<>(); +Map> ignore = new HashMap<>(); +ignore.put("xpath", path); +options.put("ignoreDOM", ignore); + +driver.get("Required URL"); +SmartUISnapshot.smartuiSnapshot(driver, "Screenshot Name", options); +``` + + + + + +```java title="This is a sample for your configuration for Java to ignore by CSS Selector" +List selector = Arrays.asList(""); +Map options = new HashMap<>(); +Map> ignore = new HashMap<>(); +ignore.put("cssSelector", selector); +options.put("ignoreDOM", ignore); + +driver.get("Required URL"); +SmartUISnapshot.smartuiSnapshot(driver, "Screenshot Name", options); +``` + + + + + + + +```java title="This is a sample for your configuration for Java to select by ID." +List cssID = Arrays.asList(""); +Map options = new HashMap<>(); +Map> select = new HashMap<>(); +select.put("id", cssID); +options.put("selectDOM", select); + +driver.get("Required URL"); +SmartUISnapshot.smartuiSnapshot(driver, "Screenshot Name", options); +``` + + + + +```java title="This is a sample for your configuration for Java to select by Class" +List cssclass = Arrays.asList(""); +Map options = new HashMap<>(); +Map> select = new HashMap<>(); +select.put("class", cssclass); +options.put("selectDOM", select); + +driver.get("Required URL"); +SmartUISnapshot.smartuiSnapshot(driver, "Screenshot Name", options); +``` + + + + +```java title="This is a sample for your configuration for Java to select by XPath" +List path = Arrays.asList(""); +Map options = new HashMap<>(); +Map> select = new HashMap<>(); +select.put("xpath", path); +options.put("selectDOM", select); + +driver.get("Required URL"); +SmartUISnapshot.smartuiSnapshot(driver, "Screenshot Name", options); +``` + + + + + +```java title="This is a sample for your webhook configuration for Java to select by CSS Selector" +List selector = Arrays.asList(""); +Map options = new HashMap<>(); +Map> select = new HashMap<>(); +select.put("cssSelector", selector); +options.put("selectDOM", select); + +driver.get("Required URL"); +SmartUISnapshot.smartuiSnapshot(driver, "Screenshot Name", options); +``` + + + + +## For capturing the screenshot of a specific element + +You can capture screenshots of targeted elements by leveraging various locator mechanisms such as XPath, CSS ID, class, and selectors. This precision-driven approach ensures accurate and specific visual regression testing for your web application's components. + + + + + +```java title="This is a sample for your configuration for Javas to capture an element by ID." +HashMap options = new HashMap<>(); +HashMap locator = new HashMap<>(); +options.put("element", locator); +locator.put("id", "Required ID"); +driver.get("Required URL"); +SmartUISnapshot.smartuiSnapshot(driver, "Screenshot Name", options); +``` + + + + +```java title="This is a sample for your configuration for Java to capture an element by Class" +HashMap options = new HashMap<>(); +HashMap locator = new HashMap<>(); +options.put("element", locator); +locator.put("class", "Required Class"); +driver.get("Required URL"); +SmartUISnapshot.smartuiSnapshot(driver, "Screenshot Name", options); +``` + + + + +```java title="This is a sample for your configuration for Java to capture an element by XPath" +HashMap options = new HashMap<>(); +HashMap locator = new HashMap<>(); +options.put("element", locator); +locator.put("xpath", "Required Xpath"); +driver.get("Required URL"); +SmartUISnapshot.smartuiSnapshot(driver, "Screenshot Name", options); +``` + + + + + +```java title="This is a sample for your configuration for Java to capture an element by CSS Selector" +HashMap options = new HashMap<>(); +HashMap locator = new HashMap<>(); +options.put("element", locator); +locator.put("cssSelector", "Required Selector"); +driver.get("Required URL"); +SmartUISnapshot.smartuiSnapshot(driver, "Screenshot Name", options); +``` + + + + +## For capturing interactive lazy loading elements + +If you encounter difficulties loading interactive elements that appear on scroll in full-page screenshots, consider functionally incorporating a full-page scroll into your script before capturing the screenshot. This approach ensures the elements load first, facilitating the screenshot processing. + +```java Example for scrolling to bottom for lazy elements +//Rest of your code here + +@Test +public void basicTest() throws Exception { + System.out.println("Loading Url"); + driver.get("Required URL"); + quickScrollToBottom(); + + SmartUISnapshot.smartuiSnapshot(driver, "Screenshot Name"); + Thread.sleep(5000); // wait for 5 seconds + System.out.println("Test Finished"); +} + +public void quickScrollToBottom() throws InterruptedException { + long lastHeight = ((Number) ((JavascriptExecutor) driver).executeScript("return document.body.scrollHeight")).longValue(); + while (true) { + ((JavascriptExecutor) driver).executeScript("window.scrollTo(0, document.body.scrollHeight);"); + Thread.sleep(2000); + + long newHeight = ((Number) ((JavascriptExecutor) driver).executeScript("return document.body.scrollHeight")).longValue(); + if (newHeight == lastHeight) { + break; + } + lastHeight = newHeight; + } + ((JavascriptExecutor) driver).executeScript("window.scrollTo(0, 0);"); + Thread.sleep(1000); // wait for 1 second +} + +@AfterMethod +public void tearDown() { + if (driver != null) { + driver.quit(); + } +} +} +``` + +For additional information about SmartUI APIs please explore the documentation [here](https://www.lambdatest.com/support/api-doc/) diff --git a/docs/smartui-playwright-python-sdk.md b/docs/smartui-playwright-python-sdk.md index cbc5d2aa3..3b0a06b64 100644 --- a/docs/smartui-playwright-python-sdk.md +++ b/docs/smartui-playwright-python-sdk.md @@ -15,7 +15,7 @@ keywords: - Visual Regression Testing Environment - How to Run Visual Regression Tests -url: https://www.lambdatest.com/support/docs/smartui-cli/ +url: https://www.lambdatest.com/support/docs/smartui-playwright-python-sdk/ slug: smartui-playwright-python-sdk/ --- @@ -23,8 +23,6 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import NewTag from '../src/component/newTag'; ---- -