๐ SeleniumBase
One framework for browser automation, web scraping, and testing.
๐ Start |
๐ฐ Features |
๐๏ธ Options |
๐ Examples |
๐ป Scripts |
๐พ Locale
๐ API |
๐ Stealth API |
๐ DesignPatterns |
๐ด Recorder |
๐ Dashboard
๐๏ธ GUI |
๐ฐ TestPage |
๐ค UC Mode |
๐ CDP Mode |
๐ถ Charts |
๐ฅ๏ธ Farm
๐๏ธ How |
๐ Migration |
๐ญ Stealthy Playwright |
๐ MasterQA |
๐ Tours
๐ค MCP |
๐จ JS Mgr |
๐ Translator |
๐๏ธ Presenter |
๐ผ๏ธ Visual |
๐๏ธ CPlans
๐ฅท UC Mode and the newer CDP Mode makes your automation undetectable to anti-bot services. CDP Mode also adds stealth to stock Playwright.
๐ Example scripts that start or end with "test" are specifically designed to be run with pytest. Other scripts run directly with raw python. (Those start with "raw" to avoid confusion.)
๐ Here's a Python script that uses Pure CDP Mode (sb_cdp):
(It performs actions such as typing, clicking, and bypassing a Cloudflare Turnstile)
from seleniumbase import sb_cdp sb = sb_cdp.Chrome(incognito=True) sb.goto("https://www.planetminecraft.com/account") sb.assert_element('input[name="login"]') sb.type('input[name="email"]', "test@example.com") sb.type('input[name="password"]', "Fake_Password") sb.click("input#autologin") # The checkbox if sb.is_element_visible("input[disabled]"): sb.solve_captcha() # Enables the input sb.assert_element_absent("input[disabled]") sb.sleep(1.5) sb.quit()
python raw_cdp_planetmc.py
โ
sb.solve_captcha() handles CAPTCHAs that aren't bypassed automatically.
(If called when there's no CAPTCHA on the page, then nothing happens / no-op.)
โน๏ธ sb.assert_* methods wait up to 7 seconds for the expected condition to occur.
๐ This script scrapes Hacker News listings:
from seleniumbase import sb_cdp sb = sb_cdp.Chrome(fast=True) sb.goto("https://news.ycombinator.com/submitted?id=seleniumbase") elements = sb.find_elements("span.titleline > a") for element in elements: print("* " + element.text)
python raw_cdp_yc_news.py
๐ This script bypasses Cloudflare's challenge page with UC + CDP Mode:
from seleniumbase import SB with SB(uc=True, test=True, locale="en") as sb: sb.activate_cdp_mode() sb.goto("https://gitlab.com/users/sign_in") sb.sleep(2) sb.solve_captcha() sb.highlight('h1:contains("GitLab")') sb.highlight('button:contains("Sign in")')
python raw_gitlab.py
๐งช End-to-End Testing examples are located in ./examples/.
๐ Stealthy CDP Mode examples are located in ./examples/cdp_mode/.
๐ญ Stealthy Playwright examples are located in ./examples/cdp_mode/playwright/.
๐ CLI Options for Supported Chromium Browsers
๐ก You can set which Chromium browser to use via command-line parameters:
python SCRIPT.py --chromium # Use the unbranded Chromium browser python SCRIPT.py --cft # Use Chrome-for-testing python SCRIPT.py --edge # Use Microsoft Edge python SCRIPT.py --brave # Use Brave browser
Google Chrome is the default browser. Only unbranded Chromium and Chrome-for-Testing get downloaded automatically if not already present on the system.
The Chromium browser can also be set via method args, eg: cft=True, use_chromium=True, browser="edge", browser="brave", etc. Eg:
sb = sb_cdp.Chrome(use_chromium=True)
โ๏ธ Stealthy architecture flowchart:
๐งช Comprehensive E2E Testing with pytest:
๐ This script tests an e-commerce site with pytest:
from seleniumbase import BaseCase BaseCase.main(__name__, __file__) # Call pytest class MyTestClass(BaseCase): def test_swag_labs(self): self.goto("https://www.saucedemo.com") self.type("#user-name", "standard_user") self.type("#password", "secret_sauce\n") self.assert_element("div.inventory_list") self.click('button[name*="backpack"]') self.click("#shopping_cart_container a") self.assert_text("Backpack", "div.cart_item") self.click("button#checkout") self.type("input#first-name", "SeleniumBase") self.type("input#last-name", "Automation") self.type("input#postal-code", "77123") self.click("input#continue") self.click("button#finish") self.assert_text("Thank you for your order!")
pytest test_get_swag.py
๐ฅท For stealth with pytest, add --uc as a command-line option.
๐ This script tests a different e-commerce site with pytest:
from seleniumbase import BaseCase BaseCase.main(__name__, __file__) class CoffeeCartTest(BaseCase): def test_coffee_cart(self): self.goto("https://seleniumbase.io/coffee/") self.assert_title("Coffee Cart") self.assert_element('button:contains("Total: $0.00")') self.click('div[data-sb="Cappuccino"]') self.assert_exact_text("cart (1)", 'a[aria-label="Cart page"]') self.click('div[data-sb="Flat-White"]') self.assert_exact_text("cart (2)", 'a[aria-label="Cart page"]') self.click('div[data-sb="Cafe-Latte"]') self.assert_exact_text("cart (3)", 'a[aria-label="Cart page"]') self.click('a[aria-label="Cart page"]') self.assert_exact_text("Total: $53.00", "button.pay") self.click("button.pay") self.type("input#name", "Selenium Coffee") self.type("input#email", "test@test.test") self.click("button#submit-payment") self.assert_text("Thanks for your purchase.", "#app .success")
pytest test_coffee_cart.py --demo
(
--demomode slows down tests and highlights actions)
๐ This script covers multiple actions with pytest:
pytest test_demo_site.py
Easy to type, click, select, toggle, drag & drop, and more.
๐ For more scripts, see the SeleniumBase/examples/ folder.
Explore the README:
โถ๏ธ How is SeleniumBase different from raw Selenium? (click to expand)
๐ก SeleniumBase is a Python framework for browser automation and testing. SeleniumBase uses Selenium/WebDriver APIs and incorporates test-runners such as pytest, pynose, and behave to provide organized structure, test discovery, test execution, test state (eg. passed, failed, or skipped), and command-line options for changing default settings (eg. browser selection). With raw Selenium, you would need to set up your own options-parser for configuring tests from the command-line.
๐ก SeleniumBase's driver manager gives you more control over automatic driver downloads. (Use --driver-version=VER with your pytest run command to specify the version.) By default, SeleniumBase will download a driver version that matches your major browser version if not set.
๐ก SeleniumBase automatically detects between CSS Selectors and XPath, which means you don't need to specify the type of selector in your commands (but optionally you could).
๐ก SeleniumBase methods often perform multiple actions in a single method call. For example, self.type(selector, text) does the following:
1. Waits for the element to be visible.
2. Waits for the element to be interactive.
3. Clears the text field.
4. Types in the new text.
5. Presses Enter/Submit if the text ends in "\n".
With raw Selenium, those actions require multiple method calls.
๐ก SeleniumBase uses default timeout values when not set:
โ
self.click("button")
With raw Selenium, methods would fail instantly (by default) if an element needed more time to load:
โ self.driver.find_element(by="css selector", value="button").click()
(Reliable code is better than unreliable code.)
๐ก SeleniumBase lets you change the explicit timeout values of methods:
โ
self.click("button", timeout=10)
With raw Selenium, that requires more code:
โ WebDriverWait(driver, 10).until(EC.element_to_be_clickable("css selector", "button")).click()
(Simple code is better than complex code.)
๐ก SeleniumBase gives you clean error output when a test fails. With raw Selenium, error messages can get very messy.
๐ก SeleniumBase gives you the option to generate a dashboard and reports for tests. It also saves screenshots from failing tests to the ./latest_logs/ folder. Raw Selenium does not have these options out-of-the-box.
๐ก SeleniumBase includes desktop GUI apps for running tests, such as SeleniumBase Commander for pytest and SeleniumBase Behave GUI for behave.
๐ก SeleniumBase has its own Recorder / Test Generator for creating tests from manual browser actions.
๐ก SeleniumBase comes with test case management software, ("CasePlans"), for organizing tests and step descriptions.
๐ก SeleniumBase includes tools for building data apps, ("ChartMaker"), which can generate JavaScript from Python.
๐ Learn about different ways of writing tests:
๐๐ Here's test_simple_login.py, which uses BaseCase class inheritance, and runs with pytest or pynose. (Use self.driver to access Selenium's raw driver.)
from seleniumbase import BaseCase BaseCase.main(__name__, __file__) class TestSimpleLogin(BaseCase): def test_simple_login(self): self.goto("seleniumbase.io/simple/login") self.type("#username", "demo_user") self.type("#password", "secret_pass") self.click('a:contains("Sign in")') self.assert_exact_text("Welcome!", "h1") self.assert_element("img#image1") self.highlight("#image1") self.click_link("Sign out") self.assert_text("signed out", "#top_message")
๐๐ Here's raw_login_sb.py, which uses the SB Context Manager. Runs with pure python. (Use sb.driver to access Selenium's raw driver.)
from seleniumbase import SB with SB() as sb: sb.goto("seleniumbase.io/simple/login") sb.type("#username", "demo_user") sb.type("#password", "secret_pass") sb.click('a:contains("Sign in")') sb.assert_exact_text("Welcome!", "h1") sb.assert_element("img#image1") sb.highlight("#image1") sb.click_link("Sign out") sb.assert_text("signed out", "#top_message")
๐๐ Here's raw_login_driver.py, which uses the Driver Manager. Runs with pure python. (The driver is an improved version of Selenium's raw driver, with more methods.)
from seleniumbase import Driver driver = Driver() try: driver.goto("seleniumbase.io/simple/login") driver.type("#username", "demo_user") driver.type("#password", "secret_pass") driver.click('a:contains("Sign in")') driver.assert_exact_text("Welcome!", "h1") driver.assert_element("img#image1") driver.highlight("#image1") driver.click_link("Sign out") driver.assert_text("signed out", "#top_message") finally: driver.quit()
Set up Python & Git:
๐ต Add Python and Git to your System PATH.
๐ต Using a Python virtual env is recommended.
Install SeleniumBase:
๐ต How to install seleniumbase from PyPI using pip:
pip install seleniumbase
- (Add
--upgradeOR-Uto upgrade SeleniumBase.) - (Add
--force-reinstallto upgrade indirect packages.)
๐ต How to install seleniumbase from a GitHub clone:
git clone https://github.com/seleniumbase/SeleniumBase.git cd SeleniumBase/ pip install -e .
๐ต How to upgrade an existing install from a GitHub clone:
git pull
pip install -e .๐ต Type seleniumbase or sbase to verify that SeleniumBase was installed successfully:
___ _ _ ___ / __| ___| |___ _ _ (_)_ _ _ __ | _ ) __ _ ______ \__ \/ -_) / -_) ' \| | \| | ' \ | _ \/ _` (_-< -_) |___/\___|_\___|_||_|_|\_,_|_|_|_\|___/\__,_/__|___| ---------------------------------------------------- โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ โ * USAGE: "seleniumbase [COMMAND] [PARAMETERS]" โ โ * OR: "sbase [COMMAND] [PARAMETERS]" โ โ โ โ COMMANDS: PARAMETERS / DESCRIPTIONS: โ โ get / install [DRIVER_NAME] [OPTIONS] โ โ methods (List common Python methods) โ โ options (List common pytest options) โ โ behave-options (List common behave options) โ โ gui / commander [OPTIONAL PATH or TEST FILE] โ โ behave-gui (SBase Commander for Behave) โ โ caseplans [OPTIONAL PATH or TEST FILE] โ โ mkdir [DIRECTORY] [OPTIONS] โ โ mkfile [FILE.py] [OPTIONS] โ โ mkrec / codegen [FILE.py] [OPTIONS] โ โ recorder (Open Recorder Desktop App.) โ โ record (If args: mkrec. Else: App.) โ โ mkpres [FILE.py] [LANG] โ โ mkchart [FILE.py] [LANG] โ โ print [FILE] [OPTIONS] โ โ translate [SB_FILE.py] [LANG] [ACTION] โ โ convert [WEBDRIVER_UNITTEST_FILE.py] โ โ extract-objects [SB_FILE.py] โ โ inject-objects [SB_FILE.py] [OPTIONS] โ โ objectify [SB_FILE.py] [OPTIONS] โ โ revert-objects [SB_FILE.py] [OPTIONS] โ โ encrypt / obfuscate โ โ decrypt / unobfuscate โ โ proxy (Start a basic proxy server) โ โ download server (Get Selenium Grid JAR file) โ โ grid-hub [start|stop] [OPTIONS] โ โ grid-node [start|stop] --hub=[HOST/IP] โ โ โ โ * EXAMPLE => "sbase get chromedriver stable" โ โ * For command info => "sbase help [COMMAND]" โ โ * For info on all commands => "sbase --help" โ โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
๐ต Downloading webdrivers:
โ
SeleniumBase automatically downloads webdrivers as needed, such as chromedriver.
โถ๏ธ Here's sample output from a chromedriver download. (click to expand)
*** Getting chromedriver 154.0.8037.57 (Latest Stable) Downloading chromedriver-mac-arm64.zip from: https://storage.googleapis.com/chrome-for-testing-public/154.0.8037.57/mac-arm64/chromedriver-mac-arm64.zip ... Download Complete! Extracting ['chromedriver'] from chromedriver-mac-arm64.zip ... Unzip Complete! The file [chromedriver] was saved to: ~/github/SeleniumBase/seleniumbase/drivers/ chromedriver [chromedriver 154.0.8037.57] is ready for use!
Basic Example / Usage:
๐ต If you've cloned SeleniumBase, you can run tests from the examples/ folder.
Here's my_first_test.py:
cd examples/
pytest my_first_test.pyHere's the full code for my_first_test.py:
from seleniumbase import BaseCase BaseCase.main(__name__, __file__) class MyTestClass(BaseCase): def test_swag_labs(self): self.goto("https://www.saucedemo.com") self.type("#user-name", "standard_user") self.type("#password", "secret_sauce\n") self.assert_element("div.inventory_list") self.assert_exact_text("Products", "span.title") self.click('button[name*="backpack"]') self.click("#shopping_cart_container a") self.assert_exact_text("Your Cart", "span.title") self.assert_text("Backpack", "div.cart_item") self.click("button#checkout") self.type("#first-name", "SeleniumBase") self.type("#last-name", "Automation") self.type("#postal-code", "77123") self.click("input#continue") self.assert_text("Checkout: Overview") self.assert_text("Backpack", "div.cart_item") self.assert_text("29.99", "div.inventory_item_price") self.click("button#finish") self.assert_exact_text("Thank you for your order!", "h2") self.assert_element('img[alt="Pony Express"]') self.js_click("a#logout_sidebar_link") self.assert_element("div#login_button_container")
- By default, CSS Selectors are used for finding page elements.
- If you're new to CSS Selectors, games like CSS Diner can help you learn.
- For more reading, here's an advanced guide on CSS attribute selectors.
Here are some common SeleniumBase methods:
self.goto(url) # Navigate the browser window to the URL. self.open(url) # Same as `self.goto(url)` self.activate_cdp_mode() # Activate CDP Mode from UC Mode. self.type(selector, text) # Update the field with the text. self.click(selector) # Click the element with the selector. self.click_link(link_text) # Click the link containing text. self.go_back() # Navigate back to the previous URL. self.select_option_by_text(dropdown_selector, option) self.hover_and_click(hover_selector, click_selector) self.drag_and_drop(drag_selector, drop_selector) self.get_text(selector) # Get the text from the element. self.get_current_url() # Get the URL of the current page. self.get_page_source() # Get the HTML of the current page. self.get_attribute(selector, attribute) # Get element attribute. self.get_title() # Get the title of the current page. self.switch_to_frame(frame) # Switch into the iframe container. self.switch_to_default_content() # Leave the iframe container. self.open_new_window() # Open a new window in the same browser. self.switch_to_window(window) # Switch to the browser window. self.switch_to_default_window() # Switch to the original window. self.get_new_driver(OPTIONS) # Open a new driver with OPTIONS. self.switch_to_driver(driver) # Switch to the browser driver. self.switch_to_default_driver() # Switch to the original driver. self.wait_for_element(selector) # Wait until element is visible. self.is_element_visible(selector) # Return element visibility. self.is_text_visible(text, selector) # Return text visibility. self.sleep(seconds) # Do nothing for the given amount of time. self.save_screenshot(name) # Save a screenshot in .png format. self.assert_element(selector) # Verify the element is visible. self.assert_text(text, selector) # Verify text in the element. self.assert_exact_text(text, selector) # Verify text is exact. self.assert_title(title) # Verify the title of the web page. self.assert_downloaded_file(file) # Verify file was downloaded. self.assert_no_404_errors() # Verify there are no broken links. self.assert_no_js_errors() # Verify there are no JS errors.
๐ต For the complete list of SeleniumBase methods, see: Method Summary
Fun Facts / Learn More:
โ SeleniumBase automatically handles common WebDriver actions such as launching web browsers before tests, saving screenshots during failures, and closing web browsers after tests.
โ SeleniumBase lets you customize tests via command-line options.
โ SeleniumBase uses simple syntax for commands. Example:
self.type("input", "dogs\n") # (The "\n" presses ENTER)
Most SeleniumBase scripts can be run with pytest, pynose, or pure python. Not all test runners can run all test formats. For example, tests that use the sb pytest fixture can only be run with pytest. (See Syntax Formats) There's also a Gherkin test format that runs with behave.
pytest coffee_cart_tests.py --rs pytest test_sb_fixture.py --demo pytest test_suite.py --rs --html=report.html --dashboard pynose basic_test.py --mobile pynose test_suite.py --headless --report --show-report python raw_sb.py python raw_test_scripts.py behave realworld.feature behave calculator.feature -D rs -D dashboard
โ
pytest includes automatic test discovery. If you don't specify a specific file or folder to run, pytest will automatically search through all subdirectories for tests to run based on the following criteria:
- Python files that start with
test_or end with_test.py. - Python methods that start with
test_.
With a SeleniumBase pytest.ini file present, you can modify default discovery settings. The Python class name can be anything because seleniumbase.BaseCase inherits unittest.TestCase to trigger autodiscovery.
โ
You can do a pre-flight check to see which tests would get discovered by pytest before the actual run:
pytest --co -q
โ
You can be more specific when calling pytest or pynose on a file:
pytest [FILE_NAME.py]::[CLASS_NAME]::[METHOD_NAME] pynose [FILE_NAME.py]:[CLASS_NAME].[METHOD_NAME]
โ No More Flaky Tests! SeleniumBase methods automatically wait for page elements to finish loading before interacting with them (up to a timeout limit).
โ SeleniumBase supports all major browsers and operating systems:
Browsers: Chrome, Edge, Firefox, and Safari.
Systems: Linux/Ubuntu, macOS, and Windows.
โ SeleniumBase works on all popular CI/CD platforms:
โ SeleniumBase includes an automated/manual hybrid solution called MasterQA to speed up manual testing with automation while manual testers handle validation.
โ SeleniumBase supports running tests while offline (assuming webdrivers have previously been downloaded when online).
โ For a full list of SeleniumBase features, Click Here.
Demo Mode / Debugging:
๐ต Demo Mode helps you see what a test is doing. If a test is moving too fast for your eyes, run it in Demo Mode to pause the browser briefly between actions, highlight page elements being acted on, and display assertions:
pytest my_first_test.py --demo
๐ต time.sleep(seconds) can be used to make a test wait at a specific spot:
import time; time.sleep(3) # Do nothing for 3 seconds.
๐ต Debug Mode with Python's built-in pdb library helps you debug tests:
breakpoint() # Shortcut for "import pdb; pdb.set_trace()"
(
pdbcommands:n,c,s,u,d=>next,continue,step,up,down)
๐ต To pause an active test that throws an exception or error, (and keep the browser window open while Debug Mode begins in the console), add --pdb as a pytest option:
pytest test_fail.py --pdb
๐ต To start tests in Debug Mode, add --trace as a pytest option:
pytest test_coffee_cart.py --trace
๐ต Command-line Options:
โ
Here are some useful command-line options that come with pytest:
-v # Verbose mode. Prints the full name of each test and shows more details. -q # Quiet mode. Print fewer details in the console output when running tests. -x # Stop running the tests after the first failure is reached. --html=report.html # Creates a detailed pytest-html report after tests finish. --co | --collect-only # Show what tests would get run. (Without running them) --co -q # (Both options together!) - Do a dry run with full test names shown. -n=NUM # Multithread the tests using that many threads. (Speed up test runs!) -s # See print statements. (Should be on by default with pytest.ini present.) --junit-xml=report.xml # Creates a junit-xml report after tests finish. --pdb # If a test fails, enter Post Mortem Debug Mode. (Don't use with CI!) --trace # Enter Debug Mode at the beginning of each test. (Don't use with CI!) -m=MARKER # Run tests with the specified pytest marker.
โ
SeleniumBase provides additional pytest command-line options for tests:
--browser=BROWSER # (The web browser to use. Default: "chrome".) --chrome # (Shortcut for "--browser=chrome". On by default.) --edge # (Shortcut for "--browser=edge".) --firefox # (Shortcut for "--browser=firefox".) --safari # (Shortcut for "--browser=safari".) --opera # (Shortcut for "--browser=opera".) --brave # (Shortcut for "--browser=brave".) --comet # (Shortcut for "--browser=comet".) --chromium # (Shortcut for using base `Chromium`) --settings-file=FILE # (Override default SeleniumBase settings.) --env=ENV # (Set the test env. Access with "self.env" in tests.) --account=STR # (Set account. Access with "self.account" in tests.) --data=STRING # (Extra test data. Access with "self.data" in tests.) --var1=STRING # (Extra test data. Access with "self.var1" in tests.) --var2=STRING # (Extra test data. Access with "self.var2" in tests.) --var3=STRING # (Extra test data. Access with "self.var3" in tests.) --variables=DICT # (Extra test data. Access with "self.variables".) --user-data-dir=DIR # (Set the Chrome user data directory to use.) --protocol=PROTOCOL # (The Selenium Grid protocol: http|https.) --server=SERVER # (The Selenium Grid server/IP used for tests.) --port=PORT # (The Selenium Grid port used by the test server.) --cap-file=FILE # (The web browser's desired capabilities to use.) --cap-string=STRING # (The web browser's desired capabilities to use.) --proxy=SERVER:PORT # (Connect to a proxy server:port as tests are running) --proxy=USERNAME:PASSWORD@SERVER:PORT # (Use an authenticated proxy server) --proxy-bypass-list=STRING # (";"-separated hosts to bypass, Eg "*.foo.com") --proxy-pac-url=URL # (Connect to a proxy server using a PAC_URL.pac file.) --proxy-pac-url=USERNAME:PASSWORD@URL # (Authenticated proxy with PAC URL.) --proxy-driver # (If a driver download is needed, will use: --proxy=PROXY.) --multi-proxy # (Allow multiple authenticated proxies when multi-threaded.) --agent=STRING # (Modify the web browser's User-Agent string.) --mobile # (Use the mobile device emulator while running tests.) --metrics=STRING # (Set mobile metrics: "CSSWidth,CSSHeight,PixelRatio".) --chromium-arg="ARG=N,ARG2" # (Set Chromium args, ","-separated, no spaces.) --firefox-arg="ARG=N,ARG2" # (Set Firefox args, comma-separated, no spaces.) --firefox-pref=SET # (Set a Firefox preference:value set, comma-separated.) --extension-zip=ZIP # (Load a Chrome Extension .zip|.crx, comma-separated.) --extension-dir=DIR # (Load a Chrome Extension directory, comma-separated.) --disable-features="F1,F2" # (Disable features, comma-separated, no spaces.) --binary-location=PATH # (Set path of the Chromium browser binary to use.) --driver-version=VER # (Set the chromedriver or uc_driver version to use.) --sjw # (Skip JS Waits for readyState to be "complete" or Angular to load.) --wfa # (Wait for AngularJS to be done loading after specific web actions.) --pls=PLS # (Set pageLoadStrategy on Chrome: "normal", "eager", or "none".) --headless # (The default headless mode. Linux uses this mode by default.) --headless1 # (Use Chrome's old headless mode. Fast, but has limitations.) --headless2 # (Use Chrome's new headless mode, which supports extensions.) --headed # (Run tests in headed/GUI mode on Linux OS, where not default.) --xvfb # (Run tests using the Xvfb virtual display server on Linux OS.) --xvfb-metrics=STRING # (Set Xvfb display size on Linux: "Width,Height".) --locale=LOCALE_CODE # (Set the Language Locale Code for the web browser.) --interval=SECONDS # (The autoplay interval for presentations & tour steps) --start-page=URL # (The starting URL for the web browser when tests begin.) --archive-logs # (Archive existing log files instead of deleting them.) --archive-downloads # (Archive old downloads instead of deleting them.) --time-limit=SECONDS # (Safely fail any test that exceeds the time limit.) --fast # (Run the automation at full speed. May impact stealth.) --slow # (Slow down the automation. Faster than using Demo Mode.) --demo # (Slow down and visually see test actions as they occur.) --demo-sleep=SECONDS # (Set the wait time after Slow & Demo Mode actions.) --highlights=NUM # (Number of highlight animations for Demo Mode actions.) --message-duration=SECONDS # (The time length for Messenger alerts.) --check-js # (Check for JavaScript errors after page loads.) --ad-block # (Block some types of display ads from loading.) --host-resolver-rules=RULES # (Set host-resolver-rules, comma-separated.) --block-images # (Block images from loading during tests.) --do-not-track # (Indicate to websites that you don't want to be tracked.) --verify-delay=SECONDS # (The delay before MasterQA verification checks.) --ee | --esc-end # (Lets the user end the current test via the ESC key.) --recorder # (Enables the Recorder for turning browser actions into code.) --rec-sb-mgr # (A Recorder Mode that generates SB() context manager code.) --rec-sb-cdp # (A Recorder Mode that generates Pure CDP Mode sb_cdp code.) --rec-behave # (Same as Recorder Mode, but also generates behave-gherkin.) --rec-sleep # (If the Recorder is enabled, also records self.sleep calls.) --rec-print # (If the Recorder is enabled, prints output after tests end.) --disable-cookies # (Disable Cookies on websites. Pages might break!) --disable-js # (Disable JavaScript on websites. Pages might break!) --disable-csp # (Disable the Content Security Policy of websites.) --disable-ws # (Disable Web Security on Chromium-based browsers.) --enable-ws # (Enable Web Security on Chromium-based browsers.) --enable-sync # (Enable "Chrome Sync" on websites.) --uc | --undetected # (Use undetected-chromedriver to evade bot-detection.) --uc-cdp-events # (Capture CDP events when running in "--undetected" mode.) --log-cdp # ("goog:loggingPrefs", {"performance": "ALL", "browser": "ALL"}) --remote-debug # (Sync to Chrome Remote Debugger chrome://inspect/#devices) --ftrace | --final-trace # (Debug Mode after each test. Don't use with CI!) --dashboard # (Enable the SeleniumBase Dashboard. Saved at: dashboard.html) --dash-title=STRING # (Set the title shown for the generated dashboard.) --enable-3d-apis # (Enables WebGL and 3D APIs.) --swiftshader # (Chrome "--use-gl=angle" / "--use-angle=swiftshader-webgl") --incognito # (Enable Chrome's Incognito mode.) --guest # (Enable Chrome's Guest mode.) --dark # (Enable Chrome's Dark mode.) --devtools # (Open Chrome's DevTools when the browser opens.) --rs | --reuse-session # (Reuse browser session for all tests.) --rcs | --reuse-class-session # (Reuse session for tests in class.) --crumbs # (Delete all cookies between tests reusing a session.) --disable-beforeunload # (Disable the "beforeunload" event on Chrome.) --window-position=X,Y # (Set the browser's starting window position.) --window-size=WIDTH,HEIGHT # (Set the browser's starting window size.) --maximize # (Start tests with the browser window maximized.) --screenshot # (Save a screenshot at the end of each test.) --no-screenshot # (No screenshots saved unless tests directly ask it.) --visual-baseline # (Set the visual baseline for Visual/Layout tests.) --external-pdf # (Set Chromium "plugins.always_open_pdf_externally":True.) --timeout-multiplier=MULTIPLIER # (Multiplies the default timeout values.) --list-fail-page # (After each failing test, list the URL of the failure.)
(See the full list of command-line option definitions here. For detailed examples of command-line options, see customizing_test_runs.md)
๐ต During test failures, logs and screenshots from the most recent test run will get saved to the latest_logs/ folder. Those logs will get moved to archived_logs/ if you add --archive_logs to command-line options, or have ARCHIVE_EXISTING_LOGS set to True in settings.py, otherwise log files with be cleaned up at the start of the next test run. The test_suite.py collection contains tests that fail on purpose so that you can see how logging works.
cd examples/
pytest test_suite.py --chrome
pytest test_suite.py --firefoxAn easy way to override seleniumbase/config/settings.py is by using a custom settings file.
Here's the command-line option to add to tests: (See examples/custom_settings.py)
--settings_file=custom_settings.py
(Settings include default timeout values, a two-factor auth key, DB credentials, S3 credentials, and other important settings used by tests.)
๐ต To pass additional data from the command-line to tests, add --data="ANY STRING".
Inside your tests, you can use self.data to access that.
Directory Configuration:
๐ต When running tests with pytest, you'll want a copy of pytest.ini in your root folders. When running tests with pynose, you'll want a copy of setup.cfg in your root folders. These files specify default configuration details for tests. Test folders should also include a blank init.py file to allow your test files to import other files from that folder.
๐ต sbase mkdir DIR creates a folder with config files and sample tests:
sbase mkdir ui_tests
That new folder will have these files:
ui_tests/
โโโ __init__.py
โโโ my_first_test.py
โโโ parameterized_test.py
โโโ pytest.ini
โโโ requirements.txt
โโโ setup.cfg
โโโ test_demo_site.py
โโโ boilerplates/
โโโ __init__.py
โโโ base_test_case.py
โโโ boilerplate_test.py
โโโ classic_obj_test.py
โโโ page_objects.py
โโโ sb_fixture_test.py
โโโ samples/
โโโ __init__.py
โโโ google_objects.py
โโโ google_test.py
โโโ sb_swag_test.py
โโโ swag_labs_test.pyProTipโข: You can also create a boilerplate folder without any sample tests in it by adding -b or --basic to the sbase mkdir command:
sbase mkdir ui_tests --basic
That new folder will have these files:
ui_tests/ โโโ __init__.py โโโ pytest.ini โโโ requirements.txt โโโ setup.cfg
Of those files, the pytest.ini config file is the most important, followed by a blank __init__.py file. There's also a setup.cfg file (for pynose). Finally, the requirements.txt file can be used to help you install seleniumbase into your environments (if it's not already installed).
ProTipโข: Add --gha to include a GitHub Actions .yml file with default settings:
ui_tests/
โโโ .github
โโโ workflows/
โโโ python-package.yml Log files from failed tests:
Let's try an example of a test that fails:
""" test_fail.py """ from seleniumbase import BaseCase BaseCase.main(__name__, __file__) class MyTestClass(BaseCase): def test_find_army_of_robots_on_xkcd_desert_island(self): self.goto("https://xkcd.com/731/") self.assert_element("div#ARMY_OF_ROBOTS", timeout=1) # This should fail
You can run it from the examples/ folder like this:
pytest test_fail.py
๐ต You'll notice that a logs folder, ./latest_logs/, was created to hold information (and screenshots) about the failing test. During test runs, past results get moved to the archived_logs folder if you have ARCHIVE_EXISTING_LOGS set to True in settings.py, or if your run tests with --archive-logs. If you choose not to archive existing logs, they will be deleted and replaced by the logs of the latest test run.
SeleniumBase Dashboard:
๐ต The --dashboard option for pytest generates a SeleniumBase Dashboard located at dashboard.html, which updates automatically as tests run and produce results. Example:
pytest --dashboard --rs --headless
๐ต Additionally, you can host your own SeleniumBase Dashboard Server on a port of your choice. Here's an example of that using Python's http.server:
python -m http.server 1948
๐ต Now you can navigate to http://localhost:1948/dashboard.html in order to view the dashboard as a web app. This requires two different terminal windows: one for running the server, and another for running the tests, which should be run from the same directory. (Use Ctrl+C to stop the http server.)
๐ต Here's a full example of what the SeleniumBase Dashboard may look like:
pytest test_suite.py test_image_saving.py --dashboard --rs --headless
Generating Test Reports:
๐ต pytest HTML Reports:
โ
Using --html=report.html gives you a fancy report of the name specified after your test suite completes.
pytest test_suite.py --html=report.html
โ
When combining pytest html reports with SeleniumBase Dashboard usage, the pie chart from the Dashboard will get added to the html report. Additionally, if you set the html report URL to be the same as the Dashboard URL when also using the dashboard, (example: --dashboard --html=dashboard.html), then the Dashboard will become an advanced html report when all the tests complete.
โ Here's an example of an upgraded html report:
pytest test_suite.py --dashboard --html=report.html
If viewing pytest html reports in Jenkins, you may need to configure Jenkins settings for the html to render correctly. This is due to Jenkins CSP changes.
You can also use --junit-xml=report.xml to get an xml report instead. Jenkins can use this file to display better reporting for your tests.
pytest test_suite.py --junit-xml=report.xml
๐ต pynose Reports:
The --report option gives you a fancy report after your test suite completes.
pynose test_suite.py --report
(NOTE: You can add --show-report to immediately display pynose reports after the test suite completes. Only use --show-report when running tests locally because it pauses the test run.)
๐ต behave Dashboard & Reports:
(The behave_bdd/ folder can be found in the examples/ folder.)
behave behave_bdd/features/ -D dashboard -D headless
You can also use --junit to get .xml reports for each behave feature. Jenkins can use these files to display better reporting for your tests.
behave behave_bdd/features/ --junit -D rs -D headless
๐ต Allure Reports:
See: https://allurereport.org/docs/pytest/
SeleniumBase no longer includes allure-pytest as part of installed dependencies. If you want to use it, install it first:
pip install allure-pytest
Now your tests can create Allure results files, which can be processed by Allure Reports.
pytest test_suite.py --alluredir=allure_results
Using a Proxy Server:
If you wish to use a proxy server for your browser tests (Chromium or Firefox), you can add --proxy=IP_ADDRESS:PORT as an argument on the command line.
pytest proxy_test.py --proxy=IP_ADDRESS:PORT
If the proxy server that you wish to use requires authentication, you can do the following (Chromium only):
pytest proxy_test.py --proxy=USERNAME:PASSWORD@IP_ADDRESS:PORT
SeleniumBase also supports SOCKS4 and SOCKS5 proxies:
pytest proxy_test.py --proxy="socks4://IP_ADDRESS:PORT" pytest proxy_test.py --proxy="socks5://IP_ADDRESS:PORT"
To make things easier, you can add your frequently-used proxies to PROXY_LIST in proxy_list.py, and then use --proxy=KEY_FROM_PROXY_LIST to use the IP_ADDRESS:PORT of that key.
pytest proxy_test.py --proxy=proxy1
Changing the User-Agent:
๐ต If you wish to change the User-Agent for your browser tests (Chromium and Firefox only), you can add --agent="USER AGENT STRING" as an argument on the command-line.
pytest user_agent_test.py --agent="Mozilla/5.0 (Nintendo 3DS; U; ; en) Version/1.7412.EU" Handling Pop-Up Alerts:
๐ต self.accept_alert() automatically waits for and accepts alert pop-ups. self.dismiss_alert() automatically waits for and dismisses alert pop-ups. On occasion, some methods like self.click(SELECTOR) might dismiss a pop-up on its own because they call JavaScript to make sure that the readyState of the page is complete before advancing. If you're trying to accept a pop-up that got dismissed this way, use this workaround: Call self.find_element(SELECTOR).click() instead, (which will let the pop-up remain on the screen), and then use self.accept_alert() to accept the pop-up (more on that here). If pop-ups are intermittent, wrap code in a try/except block.
Building Guided Tours for Websites:
๐ต Learn about SeleniumBase Interactive Walkthroughs (in the examples/tour_examples/ folder). It's great for prototyping a website onboarding experience.
Production Environments & Integrations:
โถ๏ธ Here are some things you can do to set up a production environment for your testing. (click to expand)
- You can set up a Jenkins build server for running tests at regular intervals. For a real-world Jenkins example of headless browser automation in action, check out the SeleniumBase Jenkins example on Azure or the SeleniumBase Jenkins example on Google Cloud.
- You can use the Selenium Grid to scale your testing by distributing tests on several machines with parallel execution. To do this, check out the SeleniumBase selenium_grid folder, which should have everything you need, including the Selenium Grid ReadMe to help you get started.
- If you're using the SeleniumBase MySQL feature to save results from tests running on a server machine, you can install MySQL Workbench to help you read & write from your DB more easily.
- If you're using AWS, you can set up an Amazon S3 account for saving log files and screenshots from your tests. To activate this feature, modify settings.py with connection details in the S3 section, and add
--with-s3-loggingon the command-line when running your tests.
Here's an example of running tests with some additional features enabled:
pytest [YOUR_TEST_FILE.py] --with-db-reporting --with-s3-logging
Detailed Method Specifications and Examples:
๐ต Navigating to a web page: (and related commands)
self.goto("https://xkcd.com/378/") # This method opens the specified page. self.go_back() # This method navigates the browser to the previous page. self.go_forward() # This method navigates the browser forward in history. self.refresh_page() # This method reloads the current page. self.get_current_url() # This method returns the current page URL. self.get_page_source() # This method returns the current page source.
ProTipโข: You can use the self.get_page_source() method with Python's find() command to parse through HTML to find something specific. (For more advanced parsing, see the BeautifulSoup example.)
source = self.get_page_source() head_open_tag = source.find('<head>') head_close_tag = source.find('</head>', head_open_tag) everything_inside_head = source[head_open_tag+len('<head>'):head_close_tag]
๐ต Clicking:
To click an element on the page:
self.click("div#my_id")
ProTipโข: In most web browsers, you can right-click on a page and select Inspect Element to see the CSS selector details that you'll need to create your own scripts.
๐ต Typing Text:
self.type(selector, text) # updates the text from the specified element with the specified value. An exception is raised if the element is missing or if the text field is not editable. Example:
self.type("input#id_value", "2012")
You can also use self.add_text() or the WebDriver .send_keys() command, but those won't clear the text box first if there's already text inside.
๐ต Getting the text from an element on a page:
text = self.get_text("header h2")
๐ต Getting the attribute value from an element on a page:
attribute = self.get_attribute("#comic img", "title")
๐ต Asserting existence of an element on a page within some number of seconds:
self.wait_for_element_present("div.my_class", timeout=10)
(NOTE: You can also use: self.assert_element_present(ELEMENT))
๐ต Asserting visibility of an element on a page within some number of seconds:
self.wait_for_element_visible("a.my_class", timeout=5)
(NOTE: The short versions of that are self.find_element(ELEMENT) and self.assert_element(ELEMENT). The find_element() version returns the element.)
Since the line above returns the element, you can combine that with .click() as shown below:
self.find_element("a.my_class", timeout=5).click() # But you're better off using the following statement, which does the same thing: self.click("a.my_class") # DO IT THIS WAY!
ProTipโข: You can use dots to signify class names (Ex: div.class_name) as a simplified version of div[class="class_name"] within a CSS selector.
You can also use *= to search for any partial value in a CSS selector as shown below:
self.click('a[name*="partial_name"]')
๐ต Asserting visibility of text inside an element on a page within some number of seconds:
self.assert_text("Make it so!", "div#trek div.picard div.quotes") self.assert_text("Tea. Earl Grey. Hot.", "div#trek div.picard div.quotes", timeout=3)
(NOTE: self.find_text(TEXT, ELEMENT) and self.wait_for_text(TEXT, ELEMENT) also do this. For backwards compatibility, older method names were kept, but the default timeout may be different.)
๐ต Asserting Anything:
self.assert_true(var1 == var2) self.assert_false(var1 == var2) self.assert_equal(var1, var2)
๐ต Useful Conditional Statements: (with creative examples)
โ is_element_visible(selector): (visible on the page)
if self.is_element_visible('div#warning'): print("Red Alert: Something bad might be happening!")
โ is_element_present(selector): (present in the HTML)
if self.is_element_present('div#top_secret img.tracking_cookie'): self.contact_cookie_monster() # Not a real SeleniumBase method else: current_url = self.get_current_url() self.contact_the_nsa(url=current_url, message="Dark Zone Found") # Not a real SeleniumBase method
def is_there_a_cloaked_klingon_ship_on_this_page(): if self.is_element_present("div.ships div.klingon"): return not self.is_element_visible("div.ships div.klingon") return False
โ is_text_visible(text, selector): (text visible on element)
if self.is_text_visible("You Shall Not Pass!", "h1"): self.goto("https://www.youtube.com/watch?v=3xYXUeSmb-Y")
โถ๏ธ Click for a longer example of is_text_visible():
def get_mirror_universe_captain_picard_superbowl_ad(superbowl_year): selector = "div.superbowl_%s div.commercials div.transcript div.picard" % superbowl_year if self.is_text_visible("Yes, it was I who summoned you all here.", selector): return "Picard Paramount+ Superbowl Ad 2020" elif self.is_text_visible("Commander, signal the following: Our Network is Secure!"): return "Picard Mirror Universe iboss Superbowl Ad 2018" elif self.is_text_visible("For the Love of Marketing and Earl Grey Tea!", selector): return "Picard Mirror Universe HubSpot Superbowl Ad 2015" elif self.is_text_visible("Delivery Drones... Engage", selector): return "Picard Mirror Universe Amazon Superbowl Ad 2015" elif self.is_text_visible("Bing it on Screen!", selector): return "Picard Mirror Universe Microsoft Superbowl Ad 2015" elif self.is_text_visible("OK Glass, Make it So!", selector): return "Picard Mirror Universe Google Superbowl Ad 2015" elif self.is_text_visible("Number One, I've Never Seen Anything Like It.", selector): return "Picard Mirror Universe Tesla Superbowl Ad 2015" elif self.is_text_visible("Let us make sure history never forgets the name ... Facebook", selector): return "Picard Mirror Universe Facebook Superbowl Ad 2015" elif self.is_text_visible("""With the first link, the chain is forged. The first speech censored, the first thought forbidden, the first freedom denied, chains us all irrevocably.""", selector): return "Picard Mirror Universe Wikimedia Superbowl Ad 2015" else: raise Exception("Reports of my assimilation are greatly exaggerated.")
โ is_link_text_visible(link_text):
if self.is_link_text_visible("Stop! Hammer time!"): self.click_link("Stop! Hammer time!")
๐ต Switching Tabs:
If your test opens up a new tab/window, you can switch to it. (SeleniumBase automatically switches to new tabs that don't open to about:blank URLs.)
self.switch_to_window(1) # This switches to the new tab (0 is the first one)
๐ต How to handle iframes:
๐ต iframes follow the same principle as new windows: You must first switch to the iframe if you want to perform actions in there:
self.switch_to_frame("iframe") # ... Now perform actions inside the iframe self.switch_to_parent_frame() # Exit the current iframe
To exit from multiple iframes, use self.switch_to_default_content(). (If inside a single iframe, this has the same effect as self.switch_to_parent_frame().)
self.switch_to_frame('iframe[name="frame1"]') self.switch_to_frame('iframe[name="frame2"]') # ... Now perform actions inside the inner iframe self.switch_to_default_content() # Back to the main page
๐ต You can also use a context manager to act inside iframes:
with self.frame_switch("iframe"): # ... Now perform actions while inside the code block # You have left the iframe
This also works with nested iframes:
with self.frame_switch('iframe[name="frame1"]'): with self.frame_switch('iframe[name="frame2"]'): # ... Now perform actions while inside the code block # You are now back inside the first iframe # You have left all the iframes
๐ต How to execute custom jQuery scripts:
jQuery is a powerful JavaScript library that allows you to perform advanced actions in a web browser. If the web page you're on already has jQuery loaded, you can start executing jQuery scripts immediately. You'd know this because the web page would contain something like the following in the HTML:
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.3/jquery.min.js"></script>
๐ต It's OK if you want to use jQuery on a page that doesn't have it loaded yet. To do so, run the following command first:
self.activate_jquery()
โถ๏ธ Here are some examples of using jQuery in your scripts. (click to expand)
self.execute_script("jQuery, window.scrollTo(0, 600)") # Scrolling the page self.execute_script("jQuery('#annoying-widget').hide()") # Hiding elements on a page self.execute_script("jQuery('#hidden-widget').show(0)") # Showing hidden elements on a page self.execute_script("jQuery('#annoying-button a').remove()") # Removing elements on a page self.execute_script("jQuery('%s').mouseover()" % (mouse_over_item)) # Mouse-over elements on a page self.execute_script("jQuery('input#the_id').val('my_text')") # Fast text input on a page self.execute_script("jQuery('div#dropdown a.link').click()") # Click elements on a page self.execute_script("return jQuery('div#amazing')[0].text") # Returns the css "text" of the element given self.execute_script("return jQuery('textarea')[2].value") # Returns the css "value" of the 3rd textarea element on the page
(Most of the above commands can be done directly with built-in SeleniumBase methods.)
๐ต How to handle a restrictive CSP:
โ Some websites have a restrictive Content Security Policy to prevent users from loading jQuery and other external libraries onto their websites. If you need to use jQuery or another JS library on those websites, add --disable-csp as a pytest command-line option to load a Chromium extension that bypasses the CSP.
๐ต More JavaScript fun:
โถ๏ธ In this example, JavaScript creates a referral button on a page, which is then clicked. (click to expand)
start_page = "https://xkcd.com/465/" destination_page = "https://github.com/seleniumbase/SeleniumBase" self.goto(start_page) referral_link = '''<a class='analytics test' href='%s'>Free-Referral Button!</a>''' % destination_page self.execute_script('''document.body.innerHTML = \"%s\"''' % referral_link) self.click("a.analytics") # Clicks the generated button
(Due to popular demand, this traffic generation example has been included in SeleniumBase with the self.generate_referral(start_page, end_page) and the self.generate_traffic(start_page, end_page, loops) methods.)
๐ต How to use deferred asserts:
Let's say you want to verify multiple different elements on a web page in a single test, but you don't want the test to fail until you verified several elements at once so that you don't have to rerun the test to find more missing elements on the same page. That's where deferred asserts come in. Here's an example:
from seleniumbase import BaseCase BaseCase.main(__name__, __file__) class DeferredAssertTests(BaseCase): def test_deferred_asserts(self): self.goto("https://xkcd.com/993/") self.wait_for_element("#comic") self.deferred_assert_element('img[alt="Brand Identity"]') self.deferred_assert_element('img[alt="Rocket Ship"]') # Will Fail self.deferred_assert_element("#comicmap") self.deferred_assert_text("Fake Item", "ul.comicNav") # Will Fail self.deferred_assert_text("Random", "ul.comicNav") self.deferred_assert_element('a[name="Super Fake !!!"]') # Will Fail self.deferred_assert_exact_text("Brand Identity", "#ctitle") self.deferred_assert_exact_text("Fake Food", "#comic") # Will Fail self.process_deferred_asserts()
deferred_assert_element() and deferred_assert_text() will save any exceptions that would be raised.
To flush out all the failed deferred asserts into a single exception, make sure to call self.process_deferred_asserts() at the end of your test method. If your test hits multiple pages, you can call self.process_deferred_asserts() before navigating to a new page so that the screenshot from your log files matches the URL where the deferred asserts were made.
๐ต How to access raw WebDriver:
If you need access to any commands that come with standard WebDriver, you can call them directly like this:
self.driver.delete_all_cookies() capabilities = self.driver.capabilities self.driver.find_elements("partial link text", "GitHub")
(In general, you'll want to use the SeleniumBase versions of methods when available.)
๐ต How to retry failing tests automatically:
You can use pytest --reruns=NUM to retry failing tests that many times. Add --reruns-delay=SECONDS to wait that many seconds between retries. Example:
pytest --reruns=1 --reruns-delay=1
You can use the @retry_on_exception() decorator to retry failing methods. (First import: from seleniumbase import decorators). To learn more about SeleniumBase decorators, click here.
"Catch bugs in QA before deploying code to Production!"
Wrap-Up