Merge pull request #27 from shrinishLT/playwright

Playwright Support for Python

Author: pinanks

playwright/lambdatest_playwright_driver/__init__.py

@@ -0,0 +1,2 @@
+from lambdatest_playwright_driver.version import __version__
+from lambdatest_playwright_driver.smartui import smartui_snapshot

playwright/lambdatest_playwright_driver/smartui.py

@@ -0,0 +1,39 @@
+from lambdatest_sdk_utils import is_smartui_enabled, fetch_dom_serializer, post_snapshot # type: ignore
+from lambdatest_sdk_utils import get_pkg_name, setup_logger, get_logger # type: ignore
+from playwright.async_api import Page # type: ignore
+
+
+def smartui_snapshot(page: Page, name: str, options={}):
+    # setting up logger
+    setup_logger()
+    logger = get_logger('lambdatest-playwright-driver')
+    
+
+    if not page:
+        raise ValueError('A Playwright `page` object is required.')
+    if not name:
+        raise ValueError('The `snapshotName` argument is required.')
+    if is_smartui_enabled() is False: 
+        raise Exception("Cannot find SmartUI server.")
+    
+    try:
+        resp = fetch_dom_serializer()
+        page.evaluate(resp['data']['dom'])
+                
+        dom = dict()
+        dom['name'] = name
+        dom['url'] = page.url        
+        dom['dom'] = page.evaluate("([options]) => SmartUIDOM.serialize(options)",[options])
+        
+        res = post_snapshot(dom, get_pkg_name(), options=options)
+
+        if res and res.get('data') and res['data'].get('warnings') and len(res['data']['warnings']) != 0:
+            for warning in res['data']['warnings']:
+                logger.warning(warning)
+
+        logger.info(f'Snapshot captured {name}')
+    except Exception as e:
+        logger.error(f"SmartUI snapshot failed '{name}'")
+        logger.error(e)
+
+

playwright/lambdatest_playwright_driver/version.py

@@ -0,0 +1 @@
+__version__ = '1.0.0'

playwright/readme.md

@@ -0,0 +1,118 @@
+# lambdatest-playwright-driver
+[![SmartUI-Testing](https://smartui.lambdatest.com/static/media/LTBadge.64a05e73.svg)](https://smartui.lambdatest.com)
+
+SmartUI SDK for python playwright
+- [Installation](#installation)
+- [Methods](#methods)
+- [Usage](#usage)
+
+## Installation
+
+Install Smart UI cli
+
+```sh-session
+$ npm install -g @lambdatest/smartui-cli 
+```
+
+Install Python Playwright Package
+
+```sh-session
+$ pip3 install lambdatest-playwright-driver
+```
+
+## Methods
+``` python
+smartui_snapshot(page,"snapshotName")
+```
+
+- `page` (**required**) - A page object instance from playwright is required.
+- `snapshotName` (**required**) - Name of the screenshot
+
+## Usage
+
+Example playwright test using `smartui_snapshot`
+
+``` python
+from playwright.sync_api import sync_playwright, Playwright
+from lambdatest_playwright_driver import smartui_snapshot
+
+def run(playwright: Playwright):
+    webkit = playwright.webkit
+    browser = webkit.launch()
+    context = browser.new_context()
+    page = context.new_page()
+    
+    try:
+        page.goto("https://www.lambdatest.com")
+        smartui_snapshot(page, "example_snapshot", options={})
+    except Exception as e:
+        print(f"Error occurred during SmartUI snapshot: {e}")
+    finally:
+        browser.close()
+
+with sync_playwright() as playwright:
+    run(playwright)
+```
+
+
+Copy the project token from [SmartUI Dashboard](https://smartui.lambdatest.com/) and set on CLI via comman
+<b>For Linux/macOS:</b>
+
+```sh-session
+ export PROJECT_TOKEN="****-****-****-************"
+```
+
+<b>For Windows:</b>
+
+```sh-session
+ set PROJECT_TOKEN="****-****-****-************"
+```
+
+Running test
+```sh-session
+$ npx smartui exec [python test command]
+```
+This will create new build and upload snapshot to Smart UI Project.
+
+Executing above test
+
+```sh-session
+$ npx smartui exec python test.py
+✔ Authenticated with SmartUI
+  → using project token '******#ihcjks'
+✔ SmartUI started
+  → listening on port 8080
+✔ Fetched git information
+  → branch: main, commit: 7e336e6, author: Sushobhit Dua
+✔ SmartUI build created
+  → build id: ee2cb6c5-9541-494a-9c75-a74629396b80
+✔ Execution of 'python3 test.py' completed; exited with code 0
+  → INFO:@lambdatest/python-selenium-driver:Snapshot captured name
+✔ Finalized build
+
+```
+
+## Contribute
+
+#### Reporting bugs
+
+Our GitHub Issue Tracker will help you log bug reports.
+
+Tips for submitting an issue:
+Keep in mind, you don't end up submitting two issues with the same information. Make sure you add a unique input in every issue that you submit. You could also provide a "+1" value in the comments.
+
+Always provide the steps to reproduce before you submit a bug.
+Provide the environment details where you received the issue i.e. Browser Name, Browser Version, Operating System, Screen Resolution and more.
+Describe the situation that led to your encounter with bug.
+Describe the expected output, and the actual output precisely.
+
+#### Pull Requests
+
+We don't want to pull breaks in case you want to customize your LambdaTest experience. Before you proceed with implementing pull requests, keep in mind the following.
+Make sure you stick to coding conventions.
+Once you include tests, ensure that they all pass.
+Make sure to clean up your Git history, prior your submission of a pull-request. You can do so by using the interactive rebase command for committing and squashing, simultaneously with minor changes + fixes into the corresponding commits.
+
+## About LambdaTest
+
+[LambdaTest](https://www.lambdatest.com/) is a cloud based selenium grid infrastructure that can help you run automated cross browser compatibility tests on 2000+ different browser and operating system environments. LambdaTest supports all programming languages and frameworks that are supported with Selenium, and have easy integrations with all popular CI/CD platforms. It's a perfect solution to bring your [selenium automation testing](https://www.lambdatest.com/selenium-automation) to cloud based infrastructure that not only helps you increase your test coverage over multiple desktop and mobile browsers, but also allows you to cut down your test execution time by running tests on parallel.

playwright/requirements.txt

@@ -0,0 +1,3 @@
+playwright==1.30.0  
+aiohttp==3.8.1      
+lambdatest-sdk-utils==1.*

playwright/setup.py

@@ -0,0 +1,31 @@
+from setuptools import setup, find_packages
+from os import path
+
+cwd = path.abspath(path.dirname(__file__))
+with open(path.join(cwd, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
+setup(
+    name="lambdatest-playwright-driver",
+    version="1.0.0",
+    author="LambdaTest <[email protected]>",
+    description="Python Playwright SDK for visual testing with Smart UI",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/LambdaTest/lambdatest-python-sdk",
+    keywords="lambdatest python playwright sdk visual testing",
+    packages=find_packages(),
+    license="MIT",
+    install_requires=[
+        "playwright>=1.12",
+        "lambdatest-sdk-utils",
+    ],
+    python_requires='>=3.7',  # Playwright requires Python 3.7 or newer
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Programming Language :: Python :: 3",
+        "Natural Language :: English",
+        "License :: OSI Approved :: MIT License",
+        "Topic :: Software Development :: Testing",
+    ],
+)

selenium/lambdatest_selenium_driver/smartui.py

@@ -6,7 +6,7 @@
 def smartui_snapshot(driver, name,options={}):
     # setting up logger
     setup_logger()
-    logger = get_logger()
+    logger = get_logger('lambdatest-selenium-driver')
 
     if not name:
         raise Exception('The `snapshotName` argument is required.')

utils/lambdatest_sdk_utils/__init__.py

@@ -1,4 +1,4 @@
-from lambdatest_sdk_utils.constants import get_smart_ui_server_address,get_pkg_name
+from lambdatest_sdk_utils.constants import get_smart_ui_server_address
 from lambdatest_sdk_utils.logger import log_level,setup_logger,get_logger
 from lambdatest_sdk_utils.rest import post_snapshot,is_smartui_enabled,fetch_dom_serializer
 from lambdatest_sdk_utils.version import __version__

utils/lambdatest_sdk_utils/constants.py

@@ -5,5 +5,4 @@ def get_smart_ui_server_address():
         raise Exception('SmartUI server address not found')
     return os.getenv('SMARTUI_SERVER_ADDRESS')
 
-def get_pkg_name():
-    return "@lambdatest/python-selenium-driver"
+

utils/lambdatest_sdk_utils/logger.py

@@ -1,6 +1,5 @@
 import os
 import logging
-from lambdatest_sdk_utils.constants import get_pkg_name
 
 def log_level():
     if os.getenv('LT_SDK_DEBUG') == 'true':
@@ -22,6 +21,6 @@ def log_level():
 def setup_logger():
     logging.basicConfig(level=log_level())
 
-def get_logger():
-    logger = logging.getLogger(get_pkg_name())
+def get_logger(package_name):
+    logger = logging.getLogger(package_name)
     return logger