Selenium Python SDK

VisualTest is set to the detailed comparison mode by default (see the Comparison Mode section for more information). You can change this setting to layout mode by going to Settings.

If your tests need a combination of detailed and layout modes, you can code a given screen capture to override what you have in Settings. Below is an example. Choose from the following options:

# Detailed Mode
visualTest.capture('Home Page', {'comparisonMode': 'detailed'})

# Layout Mode with sensitivity (low, medium, high)
visualTest.capture('Home Page', {'comparisonMode': 'layout', 'sensitivity': 'medium'})

To organize your captures, assign them the same test group name by including testGroupName as a setting in the VisualTest constructor:

visualTest = VisualTest(driver, {
  'testGroupName': 'YourTestGroupName',
  'projectToken': "PROJECT_TOKEN",
})

Explore and manage your grouped test runs effortlessly by clicking the list view icon . Easily review and navigate through the organized test runs, all while retaining access to the detailed specifics of each individual test run.

The below runs fullpage regression tests for lazy-loaded websites, setting time to elapse between scrolls. Note that the value (1000) is the number of milliseconds to wait between scrolls:

visualTest.capture('Home Page', {'lazyload': 1000}) # number is milliseconds between scrolls

For code examples that handle dynamic, moving content, see Screenshot Consistency.

VisualTest can print a summary of the test run results to the console, along with a link to review the results in the VisualTest app.

For this, add the following code at the end of the test:

visualTest.printReport() 

It produces results in this format:

You can aggregate all passed and failed VisualTest comparisons with the following assert:

result = visualTest.getTestRunResult()
assertEqual(result['failed'], 0)  

The structure returned in Python is as follows:

{'passed': 1, 'failed': 0} 

Integrating Appium for screenshot capture enhances your visual testing and documentation endeavors by providing powerful functionality to capture screenshots of mobile applications. This capability enables you to visually verify the behavior and appearance of your mobile applications across diverse devices and platforms.

Below is a demonstration of how to integrate screenshot capture functionality into your Appium Python scripts:

import os
import unittest
from appium import webdriver
from appium.options.android import UiAutomator2Options
from sbvt import VisualTest

# Define capabilities for the Appium driver
capabilities = {
    'platformName': 'Android',
    'appium:automationName': 'uiautomator2',
    'deviceName':'Android',
    'autoGrantPermissions': 'true',
    'bitbar:options': {
        'app': '<YOUR_APP_ID_ON_BITBAR>',
        'project': '<YOUR_PROJECT_NAME>',
        'testrun': '<YOUR_TESTRUN_NAME>',
        'apiKey': '<YOUR_BITBAR_API_KEY>',
        'device': '<SELECTED_DEVICE>',
        'appiumVersion': '2.1',
    }
}

class TestAppium(unittest.TestCase):
    def setUp(self) -> None:
        # Initialize the Appium driver with defined capabilities
        self.driver = webdriver.Remote('https://eu-mobile-hub.bitbar.com/wd/hub', options=UiAutomator2Options().load_capabilities(capabilities))

    def tearDown(self) -> None:
        if self.driver:
            self.driver.quit()

    def test_simple(self) -> None:
        # Initialize VisualTest with the Appium driver and settings
        vt = VisualTest(self.driver, settings={
            'projectToken': os.environ["PROJECT_TOKEN"],
            'testRunName': f'Viewport Test: Appium',
        })
        # Capture screenshot of homepage
        vt.capture('homepage', {'viewport': True})

if __name__ == '__main__':
    unittest.main()

By incorporating Appium's screenshot capture functionality into your automation scripts, you can enhance the effectiveness of your mobile testing efforts and ensure the visual integrity of your applications across various devices and platforms.