LambdaTest Selenium Driver

Warnings

• gotcha For SmartUI visual testing features, you must install the `@lambdatest/smartui-cli` Node.js package globally and set the `PROJECT_TOKEN` environment variable. This is an external dependency not managed by pip.
  Fix: Run `npm install -g @lambdatest/smartui-cli` and set `export PROJECT_TOKEN="<your_token>"` (or `set` on Windows) before running tests.
• breaking Selenium 4 introduced the W3C WebDriver standard, which changed how capabilities are structured. Ensure your capabilities are W3C compliant or properly vendor-prefixed (e.g., LambdaTest specific options should be nested under `LT:Options`) to avoid session startup failures.
  Fix: Review and update your desired capabilities object to conform to the W3C standard or use the LambdaTest capability generator for `LT:Options`.
• gotcha The `LT_USERNAME` and `LT_ACCESS_KEY` environment variables are crucial for authenticating with the LambdaTest cloud grid. If these are not correctly set, your `webdriver.Remote` connection will fail.
  Fix: Ensure `export LT_USERNAME="YOUR_USERNAME"` and `export LT_ACCESS_KEY="YOUR ACCESS KEY"` (or `set` on Windows) are configured in your environment before running tests.
• gotcha Relying on `time.sleep()` or excessively long implicit waits can lead to flaky tests, especially when dealing with dynamic web elements or network latency on a remote grid. Elements might not be ready when the script tries to interact with them.
  Fix: Implement explicit waits using `WebDriverWait` and `ExpectedConditions` to wait for specific conditions (e.g., element visibility, clickability) before interacting with elements.

Install

• pip install lambdatest-selenium-driver Install library
• npm install -g @lambdatest/smartui-cli Install SmartUI CLI (for visual testing)

Imports

• smartui_snapshot

  from lambdatest_selenium_driver import smartui_snapshot

• webdriver.Remote

  from selenium import webdriver

  Used for connecting to the LambdaTest remote Selenium grid.
• Options

  from selenium.webdriver.chrome.options import Options as ChromeOptions

  Or `FirefoxOptions`, etc., for browser-specific capabilities.

Quickstart

This quickstart demonstrates how to use `lambdatest-selenium-driver` with a remote Selenium WebDriver connected to the LambdaTest grid, including SmartUI snapshot capabilities. Ensure `LT_USERNAME`, `LT_ACCESS_KEY`, and optionally `PROJECT_TOKEN` (for SmartUI) environment variables are set. The `smartui_snapshot` function captures visual snapshots for comparison.

import os
from selenium import webdriver
from selenium.webdriver.chrome.options import Options as ChromeOptions
from selenium.webdriver.common.by import By
from lambdatest_selenium_driver import smartui_snapshot

LT_USERNAME = os.environ.get('LT_USERNAME', '')
LT_ACCESS_KEY = os.environ.get('LT_ACCESS_KEY', '')

if not LT_USERNAME or not LT_ACCESS_KEY:
    print("Please set LT_USERNAME and LT_ACCESS_KEY environment variables.")
    exit(1)

def run_lambdatest_smartui_test():
    options = ChromeOptions()
    options.browser_version = "latest"
    options.platform_name = "Windows 10"
    
    lt_options = {
        "username": LT_USERNAME,
        "accessKey": LT_ACCESS_KEY,
        "build": "Python SmartUI Build",
        "project": "My SmartUI Project",
        "name": "SmartUI Sample Test",
        "w3c": True,
        "plugin": "python-python",
        "smartUI.project": os.environ.get('PROJECT_TOKEN', 'Your_SmartUI_Project_Token_Here') # For SmartUI
    }
    options.set_capability("LT:Options", lt_options)

    driver = None
    try:
        driver = webdriver.Remote(
            command_executor=f"http://{LT_USERNAME}:{LT_ACCESS_KEY}@hub.lambdatest.com/wd/hub",
            options=options,
        )

        driver.implicitly_wait(10)
        driver.get("https://lambdatest.github.io/sample-todo-app/")
        print("Successfully loaded URL: https://lambdatest.github.io/sample-todo-app/")

        # Take a SmartUI snapshot
        smartui_snapshot(driver, "Todo App Homepage")

        driver.find_element(By.NAME, "li1").click()
        smartui_snapshot(driver, "First Item Clicked")

        driver.find_element(By.NAME, "li2").click()
        smartui_snapshot(driver, "Second Item Clicked")

        driver.execute_script("lambda-status=passed")
        print("Test Finished Successfully")

    except Exception as e:
        if driver:
            driver.execute_script("lambda-status=failed")
        print(f"Test Failed: {e}")
    finally:
        if driver:
            driver.quit()

if __name__ == '__main__':
    # Make sure to set PROJECT_TOKEN environment variable if running SmartUI tests
    # For Linux/macOS: export PROJECT_TOKEN="<YOUR_SMARTUI_PROJECT_TOKEN>"
    # For Windows: set PROJECT_TOKEN="<YOUR_SMARTUI_PROJECT_TOKEN>"
    run_lambdatest_smartui_test()