Package: seleniumbase
SeleniumBaseAll-in-one Browser Automation Framework:Web Crawling / Scraping / Testing / Reporting🚀 Start|🏰 Features|📚 Examples|🎛️ Options|🌠 Scripts|📱 Mobile📘 APIs|🔡 Formats|📊 Dashboard|🔴 Recorder|🗾 Locales|🌐 Grid🎖️ GUI|📰 TestPage|🗂️ CasePlans|👤 UC Mode|🧬 Hybrid|💻 Farm👁️ How|🚝 Migrate|♻️ Templates|🚉 NodeGUI|📶 Charts|🚎 Tours🤖 CI/CD|🕹️ JSMgr|🌏 Translator|🎞️ Presenter|🛂 Dialog|🖼️ Visual📚 Learn fromover 100 examplesin theSeleniumBase/examples/folder.📗 Here'smy_first_test.py, which covers login, shopping, and checkout:pytestmy_first_test.pypytestuses--chromeby default unless set differently.📗 Here'stest_coffee_cart.py, which verifies an e-commerce site:pytesttest_coffee_cart.py--demo(--demomode slows down tests and highlights actions)📗 Here'stest_demo_site.py, which covers several actions:pytesttest_demo_site.pyEasy to type, click, select, toggle, drag & drop, and more.(For more examples, see theSeleniumBase/examples/folder.)Explore the README:Get Started / InstallationBasic Example / UsageCommon Test MethodsFun Facts / Learn MoreDemo Mode / DebuggingCommand-line OptionsDirectory ConfigurationSeleniumBase DashboardGenerating Test Reports▶️ How isSeleniumBasedifferent from raw Selenium? (click to expand)💡 SeleniumBase is a Python framework for browser automation and testing. SeleniumBase usesSelenium/WebDriverAPIs and incorporates test-runners such aspytest,pynose, andbehaveto 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=VERwith yourpytestrun 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. RawSeleniumdoes not have these options out-of-the-box.💡 SeleniumBase includes desktop GUI apps for running tests, such asSeleniumBase CommanderforpytestandSeleniumBase Behave GUIforbehave.💡 SeleniumBase has its ownRecorder / Test Generatorfor creating tests from manual browser actions.💡 SeleniumBase comes withtest case management software, ("CasePlans"), for organizing tests and step descriptions.💡 SeleniumBase includes tools forbuilding data apps, ("ChartMaker"), which can generate JavaScript from Python.📚Learn about different ways of writing tests:📘📝 Here'stest_simple_login.py, which usesBaseCaseclass inheritance, and runs withpytestorpynose. (Useself.driverto access Selenium's rawdriver.)fromseleniumbaseimportBaseCaseBaseCase.main(__name__,__file__)classTestSimpleLogin(BaseCase):deftest_simple_login(self):self.open("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 a test fromsb_fixture_tests.py, which uses thesbpytestfixture. Runs withpytest. (Usesb.driverto access Selenium's rawdriver.)deftest_sb_fixture_with_no_class(sb):sb.open("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'sraw_login_sb.py, which uses theSBContext Manager. Runs with purepython. (Usesb.driverto access Selenium's rawdriver.)fromseleniumbaseimportSBwithSB()assb:sb.open("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'sraw_login_context.py, which uses theDriverContextManager. Runs with purepython. (Thedriveris an improved version of Selenium's rawdriver, with more methods.)fromseleniumbaseimportDriverContextwithDriverContext()asdriver:driver.open("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")📔📝 Here'sraw_login_driver.py, which uses theDriverManager. Runs with purepython. (Thedriveris an improved version of Selenium's rawdriver, with more methods.)fromseleniumbaseimportDriverdriver=Driver()try:driver.open("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()📕📝 Here'slogin_app.feature, which usesbehave-BDD Gherkinsyntax. Runs withbehave. (Learn about theSeleniumBase behave-BDDintegration)Feature:SeleniumBase scenarios for the Simple AppScenario:Verify the Simple App (Login / Logout)GivenOpen "seleniumbase.io/simple/login"AndType "demo_user" into "#username"AndType "secret_pass" into "#password"AndClick 'a:contains("Sign in")'AndAssert exact text "Welcome!" in "h1"AndAssert element "img#image1"AndHighlight "#image1"AndClick link "Sign out"AndAssert text "signed out" in "#top_message"Set up Python & Git:🔵 AddPythonandGitto your System PATH.🔵 Using aPython virtual envis recommended.Install SeleniumBase:You can installseleniumbasefromPyPIorGitHub:🔵How to installseleniumbasefrom PyPI:pipinstallseleniumbase(Add--upgradeOR-Uto upgrade SeleniumBase.)(Add--force-reinstallto upgrade indirect packages.)(Usepip3if multiple versions of Python are present.)🔵How to installseleniumbasefrom a GitHub clone:gitclonehttps://github.com/seleniumbase/SeleniumBase.gitcdSeleniumBase/
pipinstall-e.🔵How to upgrade an existing install from a GitHub clone:gitpull
pipinstall-e.🔵Typeseleniumbaseorsbaseto verify that SeleniumBase was installed successfully:_____________/____/__//______(_)__________/_\____________\__\/_\//_\/__\/////__`__\//_)/__\/___/_\___//__//__//////_/////////_)/(_//__/__/
/____/\___/_/\___/_//_/_/\__,_/_//_//_//_____/\__,_/____/\___/------------------------------------------------------------------*USAGE:"seleniumbase [COMMAND] [PARAMETERS]"*OR:"sbase [COMMAND] [PARAMETERS]"COMMANDS:get/install[DRIVER][OPTIONS]methods(ListcommonPythonmethods)options(Listcommonpytestoptions)behave-options(Listcommonbehaveoptions)gui/commander[OPTIONALPATHorTESTFILE]behave-gui(SBaseCommanderforBehave)caseplans[OPTIONALPATHorTESTFILE]mkdir[DIRECTORY][OPTIONS]mkfile[FILE.py][OPTIONS]mkrec/codegen[FILE.py][OPTIONS]recorder(OpenRecorderDesktopApp.)record(Ifargs: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/obfuscatedecrypt/unobfuscatedownloadserver(GetSeleniumGridJARfile)grid-hub[start|stop][OPTIONS]grid-node[start|stop]--hub=[HOST/IP]*(EXAMPLE:"sbase get chromedriver latest")*Type"sbase help [COMMAND]"forspecificcommandinfo.Forinfoonallcommands,type:"seleniumbase --help".Use"pytest"forrunningtests.🔵 Downloading webdrivers:✅ SeleniumBase automatically downloads webdrivers as needed, such aschromedriver.▶️ Here's sample output from a chromedriver download. (click to expand)***chromedrivertodownload=121.0.6167.85(LatestStable)Downloadingchromedriver-mac-arm64.zipfrom:
https://storage.googleapis.com/chrome-for-testing-public/121.0.6167.85/mac-arm64/chromedriver-mac-arm64.zip...
DownloadComplete!

Extracting['chromedriver']fromchromedriver-mac-arm64.zip...
UnzipComplete!

Thefile[chromedriver]wassavedto:
/Users/michael/github/SeleniumBase/seleniumbase/drivers/chromedriver

Making[chromedriver121.0.6167.85]executable...[chromedriver121.0.6167.85]isnowreadyforuse!Basic Example / Usage:🔵 If you've cloned SeleniumBase, you can run tests from theexamples/folder.Here'smy_first_test.py:cdexamples/
pytestmy_first_test.pyHere's the code formy_first_test.py:fromseleniumbaseimportBaseCaseBaseCase.main(__name__,__file__)classMyTestClass(BaseCase):deftest_swag_labs(self):self.open("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 Selectorsare used for finding page elements.If you're new to CSS Selectors, games likeCSS Dinercan help you learn.For more reading,here's an advanced guide on CSS attribute selectors.Here are some common SeleniumBase methods:self.open(url)# Navigate the browser window to the URL.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 SummaryFun Facts / Learn More:✅ SeleniumBase automatically handles commonWebDriveractions such as launching web browsers before tests, saving screenshots during failures, and closing web browsers after tests.✅ SeleniumBase lets you customize tests viacommand-line options.✅ SeleniumBase uses simple syntax for commands. Example:self.type("input","dogs\n")# (The "\n" presses ENTER)Most SeleniumBase scripts can be run withpytest,pynose, or purepython. Not all test runners can run all test formats. For example, tests that use thesbpytest fixture can only be run withpytest. (SeeSyntax Formats) There's also aGherkintest format that runs withbehave.pytestcoffee_cart_tests.py--rs
pytesttest_sb_fixture.py--demo
pytesttest_suite.py--rs--html=report.html--dashboard

pynosebasic_test.py--mobile
pynosetest_suite.py--headless--report--show-report

pythonraw_sb.py
pythonraw_test_scripts.py

behaverealworld.feature
behavecalculator.feature-Drs-Ddashboard✅pytestincludes automatic test discovery. If you don't specify a specific file or folder to run,pytestwill automatically search through all subdirectories for tests to run based on the following criteria:Python files that start withtest_or end with_test.py.Python methods that start withtest_.With a SeleniumBasepytest.inifile present, you can modify default discovery settings. The Python class name can be anything becauseseleniumbase.BaseCaseinheritsunittest.TestCaseto trigger autodiscovery.✅ You can do a pre-flight check to see which tests would get discovered bypytestbefore the actual run:pytest--co-q✅ You can be more specific when callingpytestorpynoseon 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). This meansyou no longer need randomtime.sleep()statementsin your scripts.✅ 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 calledMasterQAto speed up manual testing with automation while manual testers handle validation.✅ SeleniumBase supportsrunning tests while offline(assuming webdrivers have previously been downloaded when online).✅ For a full list of SeleniumBase features,Click Here.Demo Mode / Debugging:🔵Demo Modehelps you see what a test is doing. If a test is moving too fast for your eyes, run it inDemo Modeto pause the browser briefly between actions, highlight page elements being acted on, and display assertions:pytestmy_first_test.py--demo🔵time.sleep(seconds)can be used to make a test wait at a specific spot:importtime;time.sleep(3)# Do nothing for 3 seconds.🔵Debug Modewith Python's built-inpdblibrary helps you debug tests:importpdb;pdb.set_trace()importpytest;pytest.set_trace()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 whileDebug Modebegins in the console), add--pdbas apytestoption:pytesttest_fail.py--pdb🔵 To start tests in Debug Mode, add--traceas apytestoption:pytesttest_coffee_cart.py--trace🔵 Command-line Options:✅ Here are some useful command-line options that come withpytest:-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 additionalpytestcommand-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".)--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.)--pls=PLS# (Set pageLoadStrategy on Chrome: "normal", "eager", or "none".)--headless# (Run tests in headless mode. The default arg on Linux OS.)--headless2# (Use the 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.)--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.)--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.)--recorder# (Enables the Recorder for turning browser actions into 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-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-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.)--wire# (Use selenium-wire's webdriver for replacing selenium webdriver.)--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 definitionshere. For detailed examples of command-line options, seecustomizing_test_runs.md)🔵 During test failures, logs and screenshots from the most recent test run will get saved to thelatest_logs/folder. Those logs will get moved toarchived_logs/if you add --archive_logs to command-line options, or haveARCHIVE_EXISTING_LOGSset to True insettings.py, otherwise log files with be cleaned up at the start of the next test run. Thetest_suite.pycollection contains tests that fail on purpose so that you can see how logging works.cdexamples/

pytesttest_suite.py--chrome

pytesttest_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: (Seeexamples/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 useself.datato access that.Directory Configuration:🔵 When running tests withpytest, you'll want a copy ofpytest.iniin your root folders. When running tests withpynose, you'll want a copy ofsetup.cfgin your root folders. These files specify default configuration details for tests. Test folders should also include a blankinit.pyfile to allow your test files to import other files from that folder.🔵sbase mkdir DIRcreates a folder with config files and sample tests:sbasemkdirui_testsThat 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-bor--basicto thesbase mkdircommand:sbasemkdirui_tests--basicThat new folder will have these files:ui_tests/
├──__init__.py
├──pytest.ini
├──requirements.txt
└──setup.cfgOf those files, thepytest.iniconfig file is the most important, followed by a blank__init__.pyfile. There's also asetup.cfgfile (for pynose). Finally, therequirements.txtfile can be used to help you install seleniumbase into your environments (if it's not already installed).Log files from failed tests:Let's try an example of a test that fails:""" test_fail.py """fromseleniumbaseimportBaseCaseBaseCase.main(__name__,__file__)classMyTestClass(BaseCase):deftest_find_army_of_robots_on_xkcd_desert_island(self):self.open("https://xkcd.com/731/")self.assert_element("div#ARMY_OF_ROBOTS",timeout=1)# This should failYou can run it from theexamples/folder like this:pytesttest_fail.py🔵 You'll notice that a logs folder, "latest_logs", was created to hold information about the failing test, and screenshots. During test runs, past results get moved to the archived_logs folder if you have ARCHIVE_EXISTING_LOGS set to True insettings.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--dashboardoption for pytest generates a SeleniumBase Dashboard located atdashboard.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'shttp.server:python-mhttp.server1948🔵 Now you can navigate tohttp://localhost:1948/dashboard.htmlin 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. (UseCtrl+Cto stop the http server.)🔵 Here's a full example of what the SeleniumBase Dashboard may look like:pytesttest_suite.pytest_image_saving.py--dashboard--rs--headlessGenerating Test Reports:🔵 Pytest Reports:✅ Using--html=report.htmlgives you a fancy report of the name specified after your test suite completes.pytesttest_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:pytesttest_suite.py--dashboard--html=report.htmlIf viewing pytest html reports inJenkins, you may need toconfigure Jenkins settingsfor the html to render correctly. This is due toJenkins CSP changes.You can also use--junit-xml=report.xmlto get an xml report instead. Jenkins can use this file to display better reporting for your tests.pytesttest_suite.py--junit-xml=report.xml🔵 pynose Reports:The--reportoption gives you a fancy report after your test suite completes.pynosetest_suite.py--report(NOTE: You can add--show-reportto immediately display pynose reports after the test suite completes. Only use--show-reportwhen running tests locally because it pauses the test run.)🔵 Behave Dashboard & Reports:(Thebehave_bdd/folder can be found in theexamples/folder.)behavebehave_bdd/features/-Ddashboard-DheadlessYou can also use--junitto get.xmlreports for eachbehavefeature. Jenkins can use these files to display better reporting for your tests.behavebehave_bdd/features/--junit-Drs-Dheadless🔵 Allure Reports:See:https://allurereport.org/docs/pytest/SeleniumBase no longer includesallure-pytestas part of installed dependencies. If you want to use it, install it first:pipinstallallure-pytestNow your tests can create Allure results files, which can be processed by Allure Reports.pytesttest_suite.py--alluredir=allure_resultsUsing a Proxy Server:If you wish to use a proxy server for your browser tests (Chromium or Firefox), you can add--proxy=IP_ADDRESS:PORTas an argument on the command line.pytestproxy_test.py--proxy=IP_ADDRESS:PORTIf the proxy server that you wish to use requires authentication, you can do the following (Chromium only):pytestproxy_test.py--proxy=USERNAME:PASSWORD@IP_ADDRESS:PORTSeleniumBase also supports SOCKS4 and SOCKS5 proxies:pytestproxy_test.py--proxy="socks4://IP_ADDRESS:PORT"pytestproxy_test.py--proxy="socks5://IP_ADDRESS:PORT"To make things easier, you can add your frequently-used proxies to PROXY_LIST inproxy_list.py, and then use--proxy=KEY_FROM_PROXY_LISTto use the IP_ADDRESS:PORT of that key.pytestproxy_test.py--proxy=proxy1Changing 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.pytestuser_agent_test.py--agent="Mozilla/5.0 (Nintendo 3DS; U; ; en) Version/1.7412.EU"Handling Pop-Up / 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 likeself.click(SELECTOR)might dismiss a pop-up on its own because they call JavaScript to make sure that thereadyStateof the page iscompletebefore advancing. If you're trying to accept a pop-up that got dismissed this way, use this workaround: Callself.find_element(SELECTOR).click()instead, (which will let the pop-up remain on the screen), and then useself.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 aboutSeleniumBase Interactive Walkthroughs(in theexamples/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 aJenkinsbuild server for running tests at regular intervals. For a real-world Jenkins example of headless browser automation in action, check out theSeleniumBase Jenkins example on Azureor theSeleniumBase Jenkins example on Google Cloud.You can usethe Selenium Gridto scale your testing by distributing tests on several machines with parallel execution. To do this, check out theSeleniumBase selenium_grid folder, which should have everything you need, including theSelenium Grid ReadMeto help you get started.If you're using theSeleniumBase MySQL featureto save results from tests running on a server machine, you can installMySQL Workbenchto help you read & write from your DB more easily.If you're using AWS, you can set up anAmazon S3account for saving log files and screenshots from your tests. To activate this feature, modifysettings.pywith 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-loggingDetailed Method Specifications and Examples:🔵Navigating to a web page: (and related commands)self.open("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 theself.get_page_source()method with Python'sfind()command to parse through HTML to find something specific. (For more advanced parsing, see theBeautifulSoup 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 selectInspect Elementto 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 useself.add_text()or theWebDriver.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 areself.find_element(ELEMENT)andself.assert_element(ELEMENT). Thefind_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 ofdiv[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)andself.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)ifself.is_element_visible('div#warning'):print("Red Alert: Something bad might be happening!")❓is_element_present(selector):(present in the HTML)ifself.is_element_present('div#top_secret img.tracking_cookie'):self.contact_cookie_monster()# Not a real SeleniumBase methodelse:current_url=self.get_current_url()self.contact_the_nsa(url=current_url,message="Dark Zone Found")# Not a real SeleniumBase methoddefis_there_a_cloaked_klingon_ship_on_this_page():ifself.is_element_present("div.ships div.klingon"):returnnotself.is_element_visible("div.ships div.klingon")returnFalse❓is_text_visible(text, selector):(text visible on element)ifself.is_text_visible("You Shall Not Pass!","h1"):self.open("https://www.youtube.com/watch?v=3xYXUeSmb-Y")▶️ Click for a longer example ofis_text_visible():defget_mirror_universe_captain_picard_superbowl_ad(superbowl_year):selector="div.superbowl_%sdiv.commercials div.transcript div.picard"%superbowl_yearifself.is_text_visible("Yes, it was I who summoned you all here.",selector):return"Picard Paramount+ Superbowl Ad 2020"elifself.is_text_visible("Commander, signal the following: Our Network is Secure!"):return"Picard Mirror Universe iboss Superbowl Ad 2018"elifself.is_text_visible("For the Love of Marketing and Earl Grey Tea!",selector):return"Picard Mirror Universe HubSpot Superbowl Ad 2015"elifself.is_text_visible("Delivery Drones... Engage",selector):return"Picard Mirror Universe Amazon Superbowl Ad 2015"elifself.is_text_visible("Bing it on Screen!",selector):return"Picard Mirror Universe Microsoft Superbowl Ad 2015"elifself.is_text_visible("OK Glass, Make it So!",selector):return"Picard Mirror Universe Google Superbowl Ad 2015"elifself.is_text_visible("Number One, I've Never Seen Anything Like It.",selector):return"Picard Mirror Universe Tesla Superbowl Ad 2015"elifself.is_text_visible("Let us make sure history never forgets the name ... Facebook",selector):return"Picard Mirror Universe Facebook Superbowl Ad 2015"elifself.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:raiseException("Reports of my assimilation are greatly exaggerated.")❓is_link_text_visible(link_text):ifself.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 toabout:blankURLs.)self.switch_to_window(1)# This switches to the new tab (0 is the first one)🔵 How to handle iframes:🔵iframesfollow 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 iframeself.switch_to_parent_frame()# Exit the current iframeTo exit from multiple iframes, useself.switch_to_default_content(). (If inside a single iframe, this has the same effect asself.switch_to_parent_frame().)self.switch_to_frame('iframe[name="frame1"]')self.switch_to_frame('iframe[name="frame2"]')# ... Now perform actions inside the inner iframeself.switch_to_default_content()# Back to the main page🔵 You can also use a context manager to act inside iframes:withself.frame_switch("iframe"):# ... Now perform actions while inside the code block# You have left the iframeThis also works with nested iframes:withself.frame_switch('iframe[name="frame1"]'):withself.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:<scriptsrc="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 pageself.execute_script("jQuery('#annoying-widget').hide()")# Hiding elements on a pageself.execute_script("jQuery('#hidden-widget').show(0)")# Showing hidden elements on a pageself.execute_script("jQuery('#annoying-button a').remove()")# Removing elements on a pageself.execute_script("jQuery('%s').mouseover()"%(mouse_over_item))# Mouse-over elements on a pageself.execute_script("jQuery('input#the_id').val('my_text')")# Fast text input on a pageself.execute_script("jQuery('div#dropdown a.link').click()")# Click elements on a pageself.execute_script("return jQuery('div#amazing')[0].text")# Returns the css "text" of the element givenself.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 restrictiveContent Security Policyto 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-cspas apytestcommand-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.open(start_page)referral_link='''<a class='analytics test' href='%s'>Free-Referral Button!</a>'''%destination_pageself.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 theself.generate_referral(start_page, end_page)and theself.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:fromseleniumbaseimportBaseCaseBaseCase.main(__name__,__file__)classDeferredAssertTests(BaseCase):deftest_deferred_asserts(self):self.open("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 Failself.deferred_assert_element("#comicmap")self.deferred_assert_text("Fake Item","ul.comicNav")# Will Failself.deferred_assert_text("Random","ul.comicNav")self.deferred_assert_element('a[name="Super Fake !!!"]')# Will Failself.deferred_assert_exact_text("Brand Identity","#ctitle")self.deferred_assert_exact_text("Fake Food","#comic")# Will Failself.process_deferred_asserts()deferred_assert_element()anddeferred_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 callself.process_deferred_asserts()at the end of your test method. If your test hits multiple pages, you can callself.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 rawWebDriver:If you need access to any commands that come with standardWebDriver, you can call them directly like this:self.driver.delete_all_cookies()capabilities=self.driver.capabilitiesself.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 usepytest --reruns=NUMto retry failing tests that many times. Add--reruns-delay=SECONDSto wait that many seconds between retries. Example:pytest--reruns=1--reruns-delay=1You 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-UpIf you see something, say something!https://github.com/mdmintz