📚 Learn about different ways of writing tests:

📗📝 Here's testsimplelogin.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 testsimplelogin(self):         self.goto("seleniumbase.io/simple/login")         self.type("#username", "demo_user")         self.type("#password", "secret_pass")         self.click('a:contains("Sign in")')         self.assertexacttext("Welcome!", "h1")         self.assert_element("img#image1")         self.highlight("#image1")         self.click_link("Sign out")         self.asserttext("signed out", "#topmessage")

📘📝 Here's rawloginsb.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.assertexacttext("Welcome!", "h1")     sb.assert_element("img#image1")     sb.highlight("#image1")     sb.click_link("Sign out")     sb.asserttext("signed out", "#topmessage")

📙📝 Here's rawlogindriver.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.assertexacttext("Welcome!", "h1")     driver.assert_element("img#image1")     driver.highlight("#image1")     driver.click_link("Sign out")     driver.asserttext("signed out", "#topmessage") finally:     driver.quit()

Set up Python & Git:

🔵 Add Python and Git to your System PATH.

🔵 Using a Python virtual env is recommended.

Install SeleniumBase:

You can install seleniumbase from PyPI or GitHub:

🔵 How to install seleniumbase from PyPI:

pip install seleniumbase

• (Add --upgrade OR -U to upgrade SeleniumBase.)
• (Add --force-reinstall to upgrade indirect packages.)

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: &quot;seleniumbase [COMMAND] [PARAMETERS]&quot;  │ │  *    OR:        &quot;sbase [COMMAND] [PARAMETERS]&quot;  │ │                                                  │ │ 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          [WEBDRIVERUNITTESTFILE.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 =&gt; &quot;sbase get chromedriver stable&quot;    │ │ *  For command info =&gt; &quot;sbase help [COMMAND]&quot;    │ │ *  For info on all commands =&gt; &quot;sbase --help&quot;    │ ╰──────────────────────────────────────────────────╯</code></pre>
<h3>🔵 Downloading webdrivers:</h3>
✅ SeleniumBase automatically downloads webdrivers as needed, such as chromedriver.

<div></div> <details> <summary> ▶️ Here's sample output from a chromedriver download. (<b>click to expand</b>)</summary>
<pre><code class="lang-zsh">* chromedriver to download = 149.0.7827.54 (Latest Stable)
Downloading chromedriver-mac-arm64.zip from: https://storage.googleapis.com/chrome-for-testing-public/149.0.7827.54/mac-arm64/chromedriver-mac-arm64.zip ... Download Complete!
Extracting [&#39;chromedriver&#39;] from chromedriver-mac-arm64.zip ... Unzip Complete!
The file [chromedriver] was saved to: ~/github/SeleniumBase/seleniumbase/drivers/ chromedriver
Making [chromedriver 149.0.7827.54] executable ... [chromedriver 149.0.7827.54] is now ready for use!</code></pre>
</details>
<a id="basicexampleand_usage"></a> <h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Basic Example / Usage:</h2>
🔵 If you've cloned SeleniumBase, you can run tests from the examples/ folder.
<p align="left">Here's <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/myfirsttest.py">myfirsttest.py</a>:</p>
<pre><code class="lang-zsh">cd examples/ pytest myfirsttest.py</code></pre>
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/myfirsttest.py"><img src="https://seleniumbase.github.io/cdn/gif/fastswag2.gif" alt="SeleniumBase Test" width="500" /></a>
<p align="left"><b>Here's the full code for <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/myfirsttest.py">myfirsttest.py</a>:</b></p>
<pre><code class="lang-python">from seleniumbase import BaseCase BaseCase.main(name, file)
class MyTestClass(BaseCase):     def testswaglabs(self):         self.goto(&quot;https://www.saucedemo.com&quot;)         self.type(&quot;#user-name&quot;, &quot;standard_user&quot;)         self.type(&quot;#password&quot;, &quot;secret_sauce\n&quot;)         self.assertelement(&quot;div.inventorylist&quot;)         self.assertexacttext(&quot;Products&quot;, &quot;span.title&quot;)         self.click(&#39;button[name*=&quot;backpack&quot;]&#39;)         self.click(&quot;#shoppingcartcontainer a&quot;)         self.assertexacttext(&quot;Your Cart&quot;, &quot;span.title&quot;)         self.asserttext(&quot;Backpack&quot;, &quot;div.cartitem&quot;)         self.click(&quot;button#checkout&quot;)         self.type(&quot;#first-name&quot;, &quot;SeleniumBase&quot;)         self.type(&quot;#last-name&quot;, &quot;Automation&quot;)         self.type(&quot;#postal-code&quot;, &quot;77123&quot;)         self.click(&quot;input#continue&quot;)         self.assert_text(&quot;Checkout: Overview&quot;)         self.asserttext(&quot;Backpack&quot;, &quot;div.cartitem&quot;)         self.asserttext(&quot;29.99&quot;, &quot;div.inventoryitem_price&quot;)         self.click(&quot;button#finish&quot;)         self.assertexacttext(&quot;Thank you for your order!&quot;, &quot;h2&quot;)         self.assert_element(&#39;img[alt=&quot;Pony Express&quot;]&#39;)         self.jsclick(&quot;a#logoutsidebar_link&quot;)         self.assertelement(&quot;div#loginbutton_container&quot;)</code></pre>
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.

<a id="common_methods"></a> <h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Here are some common SeleniumBase methods:</h3>
<pre><code class="lang-python">self.goto(url)  # Navigate the browser window to the URL. self.open(url)  # Same as self.goto(url) self.activatecdpmode()  # 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.clicklink(linktext)  # Click the link containing text. self.go_back()  # Navigate back to the previous URL. self.selectoptionbytext(dropdownselector, option) self.hoverandclick(hoverselector, clickselector) self.draganddrop(dragselector, dropselector) self.get_text(selector)  # Get the text from the element. self.getcurrenturl()  # Get the URL of the current page. self.getpagesource()  # 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.switchtoframe(frame)  # Switch into the iframe container. self.switchtodefault_content()  # Leave the iframe container. self.opennewwindow()  # Open a new window in the same browser. self.switchtowindow(window)  # Switch to the browser window. self.switchtodefault_window()  # Switch to the original window. self.getnewdriver(OPTIONS)  # Open a new driver with OPTIONS. self.switchtodriver(driver)  # Switch to the browser driver. self.switchtodefault_driver()  # Switch to the original driver. self.waitforelement(selector)  # Wait until element is visible. self.iselementvisible(selector)  # Return element visibility. self.istextvisible(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.assertexacttext(text, selector)  # Verify text is exact. self.assert_title(title)  # Verify the title of the web page. self.assertdownloadedfile(file)  # Verify file was downloaded. self.assertno404_errors()  # Verify there are no broken links. self.assertnojs_errors()  # Verify there are no JS errors.</code></pre>

🔵 For the complete list of SeleniumBase methods, see: <b><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/helpdocs/methodsummary.md">Method Summary</a></b>
<a id="fun_facts"></a> <h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Fun Facts / Learn More:</h2>
<p>✅ SeleniumBase automatically handles common <a href="https://www.selenium.dev/documentation/webdriver/" target="_blank">WebDriver</a> actions such as launching web browsers before tests, saving screenshots during failures, and closing web browsers after tests.</p>
<p>✅ SeleniumBase lets you customize tests via <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/helpdocs/customizingtest_runs.md">command-line options</a>.</p>
<p>✅ SeleniumBase uses simple syntax for commands. Example:</p>
<pre><code class="lang-python">self.type(&quot;input&quot;, &quot;dogs\n&quot;)  # (The &quot;\n&quot; presses ENTER)</code></pre>
Most SeleniumBase scripts can be run with <code translate="no">pytest</code>, <code translate="no">pynose</code>, or pure <code translate="no">python</code>. 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 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/helpdocs/syntaxformats.md">Syntax Formats</a>) There's also a <a href="https://behave.readthedocs.io/en/stable/gherkin.html#features" target="blank">Gherkin</a> test format that runs with <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/behavebdd/ReadMe.md">behave</a>.

<pre><code class="lang-zsh">pytest coffeecarttests.py --rs pytest testsbfixture.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 rawtestscripts.py
behave realworld.feature behave calculator.feature -D rs -D dashboard</code></pre>
<p>✅ <code translate="no">pytest</code> includes automatic test discovery. If you don't specify a specific file or folder to run, <code translate="no">pytest</code> will automatically search through all subdirectories for tests to run based on the following criteria:</p>
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.
<p>✅ You can do a pre-flight check to see which tests would get discovered by <code translate="no">pytest</code> before the actual run:</p>
<pre><code class="lang-zsh">pytest --co -q</code></pre>
<p>✅ You can be more specific when calling <code translate="no">pytest</code> or <code translate="no">pynose</code> on a file:</p>
<pre><code class="lang-zsh">pytest [FILENAME.py]::[CLASSNAME]::[METHOD_NAME]
pynose [FILENAME.py]:[CLASSNAME].[METHOD_NAME]</code></pre>
<p>✅ No More Flaky Tests! SeleniumBase methods automatically wait for page elements to finish loading before interacting with them (<i>up to a timeout limit</i>).</p> <img src="https://img.shields.io/badge/Flaky%20Tests%3F-%20NO%21-11BBDD.svg" alt="NO MORE FLAKY TESTS!" />
✅ SeleniumBase supports all major browsers and operating systems: <p><b>Browsers:</b> Chrome, Edge, Firefox, and Safari.</p> <p><b>Systems:</b> Linux/Ubuntu, macOS, and Windows.</p>
✅ SeleniumBase works on all popular CI/CD platforms: <p><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/github/workflows/ReadMe.md"><img alt="GitHub Actions integration" src="https://img.shields.io/badge/GitHubActions-12B2C2.svg?logo=GitHubActions&logoColor=CFFFC2" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/azure/jenkins/ReadMe.md"><img alt="Jenkins integration" src="https://img.shields.io/badge/Jenkins-32B242.svg?logo=jenkins&logoColor=white" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/azure/azurepipelines/ReadMe.md"><img alt="Azure integration" src="https://img.shields.io/badge/Azure-2288EE.svg?logo=AzurePipelines&logoColor=white" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/googlecloud/ReadMe.md"><img alt="Google Cloud integration" src="https://img.shields.io/badge/GoogleCloud-11CAE8.svg?logo=GoogleCloud&logoColor=EE0066" /></a> <a href="#utilizingadvancedfeatures"><img alt="AWS integration" src="https://img.shields.io/badge/AWS-4488DD.svg?logo=AmazonAWS&logoColor=FFFF44" /></a> <a href="https://en.wikipedia.org/wiki/Personalcomputer" target="blank"><img alt="Your Computer" src="https://img.shields.io/badge/💻YourComputer-44E6E6.svg" /></a></p>
<p>✅ SeleniumBase includes an automated/manual hybrid solution called <b><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md">MasterQA</a></b> to speed up manual testing with automation while manual testers handle validation.</p>
<p>✅ SeleniumBase supports <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/offline_examples">running tests while offline</a> (<i>assuming webdrivers have previously been downloaded when online</i>).</p>
<p>✅ For a full list of SeleniumBase features, <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/helpdocs/featureslist.md">Click Here</a>.</p>
<a id="demomodeand_debugging"></a> <h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Demo Mode / Debugging:</h2>
🔵 <b>Demo Mode</b> helps you see what a test is doing. If a test is moving too fast for your eyes, run it in <b>Demo Mode</b> to pause the browser briefly between actions, highlight page elements being acted on, and display assertions:
<pre><code class="lang-zsh">pytest myfirsttest.py --demo</code></pre>
🔵 time.sleep(seconds) can be used to make a test wait at a specific spot:

<pre><code class="lang-python">import time; time.sleep(3)  # Do nothing for 3 seconds.</code></pre>
🔵 Debug Mode with Python's built-in pdb library helps you debug tests:
<pre><code class="lang-python">breakpoint()  # Shortcut for &quot;import pdb; pdb.set_trace()&quot;</code></pre>
> (pdb commands: 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:

<pre><code class="lang-zsh">pytest test_fail.py --pdb</code></pre>
🔵 To start tests in Debug Mode, add --trace as a pytest option:

<pre><code class="lang-zsh">pytest testcoffeecart.py --trace</code></pre>
<a href="https://github.com/mdmintz/pdbp"><img src="https://seleniumbase.github.io/cdn/gif/coffee_pdbp.gif" alt="SeleniumBase test with the pdbp (Pdb+) debugger" title="SeleniumBase test with the pdbp (Pdb+) debugger" /></a>
<a id="commandlineoptions"></a> <h2>🔵 Command-line Options:</h2>
<a id="pytest_options"></a> ✅ Here are some useful command-line options that come with <code translate="no">pytest</code>:
<pre><code class="lang-zsh">-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&#39;t use with CI!) --trace  # Enter Debug Mode at the beginning of each test. (Don&#39;t use with CI!) -m=MARKER  # Run tests with the specified pytest marker.</code></pre>
<a id="newpytestoptions"></a> ✅ SeleniumBase provides additional <code translate="no">pytest</code> command-line options for tests:
<pre><code class="lang-zsh">--browser=BROWSER  # (The web browser to use. Default: &quot;chrome&quot;.) --chrome  # (Shortcut for &quot;--browser=chrome&quot;. On by default.) --edge  # (Shortcut for &quot;--browser=edge&quot;.) --firefox  # (Shortcut for &quot;--browser=firefox&quot;.) --safari  # (Shortcut for &quot;--browser=safari&quot;.) --opera  # (Shortcut for &quot;--browser=opera&quot;.) --brave  # (Shortcut for &quot;--browser=brave&quot;.) --comet  # (Shortcut for &quot;--browser=comet&quot;.) --atlas  # (Shortcut for &quot;--browser=atlas&quot;.) --chromium  # (Shortcut for using base Chromium) --settings-file=FILE  # (Override default SeleniumBase settings.) --env=ENV  # (Set the test env. Access with &quot;self.env&quot; in tests.) --account=STR  # (Set account. Access with &quot;self.account&quot; in tests.) --data=STRING  # (Extra test data. Access with &quot;self.data&quot; in tests.) --var1=STRING  # (Extra test data. Access with &quot;self.var1&quot; in tests.) --var2=STRING  # (Extra test data. Access with &quot;self.var2&quot; in tests.) --var3=STRING  # (Extra test data. Access with &quot;self.var3&quot; in tests.) --variables=DICT  # (Extra test data. Access with &quot;self.variables&quot;.) --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&#39;s desired capabilities to use.) --cap-string=STRING  # (The web browser&#39;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 # (&quot;;&quot;-separated hosts to bypass, Eg &quot;*.foo.com&quot;) --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&#39;s User-Agent string.) --mobile  # (Use the mobile device emulator while running tests.) --metrics=STRING  # (Set mobile metrics: &quot;CSSWidth,CSSHeight,PixelRatio&quot;.) --chromium-arg=&quot;ARG=N,ARG2&quot;  # (Set Chromium args, &quot;,&quot;-separated, no spaces.) --firefox-arg=&quot;ARG=N,ARG2&quot;  # (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=&quot;F1,F2&quot;  # (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 &quot;complete&quot; or Angular to load.) --wfa  # (Wait for AngularJS to be done loading after specific web actions.) --pls=PLS  # (Set pageLoadStrategy on Chrome: &quot;normal&quot;, &quot;eager&quot;, or &quot;none&quot;.) --headless  # (The default headless mode. Linux uses this mode by default.) --headless1  # (Use Chrome&#39;s old headless mode. Fast, but has limitations.) --headless2  # (Use Chrome&#39;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: &quot;Width,Height&quot;.) --locale=LOCALE_CODE  # (Set the Language Locale Code for the web browser.) --interval=SECONDS  # (The autoplay interval for presentations &amp; 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 &amp; 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&#39;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 &quot;Chrome Sync&quot; on websites.) --uc | --undetected  # (Use undetected-chromedriver to evade bot-detection.) --uc-cdp-events  # (Capture CDP events when running in &quot;--undetected&quot; mode.) --log-cdp  # (&quot;goog:loggingPrefs&quot;, {&quot;performance&quot;: &quot;ALL&quot;, &quot;browser&quot;: &quot;ALL&quot;}) --remote-debug  # (Sync to Chrome Remote Debugger chrome://inspect/#devices) --ftrace | --final-trace  # (Debug Mode after each test. Don&#39;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 &quot;--use-gl=angle&quot; / &quot;--use-angle=swiftshader-webgl&quot;) --incognito  # (Enable Chrome&#39;s Incognito mode.) --guest  # (Enable Chrome&#39;s Guest mode.) --dark  # (Enable Chrome&#39;s Dark mode.) --devtools  # (Open Chrome&#39;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 &quot;beforeunload&quot; event on Chrome.) --window-position=X,Y  # (Set the browser&#39;s starting window position.) --window-size=WIDTH,HEIGHT  # (Set the browser&#39;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 &quot;plugins.alwaysopenpdf_externally&quot;:True.) --timeout-multiplier=MULTIPLIER  # (Multiplies the default timeout values.) --list-fail-page  # (After each failing test, list the URL of the failure.)</code></pre>

(See the full list of command-line option definitions here. For detailed examples of command-line options, see customizingtestruns.md)

🔵 During test failures, logs and screenshots from the most recent test run will get saved to the latestlogs/ folder. Those logs will get moved to archivedlogs/ if you add --archivelogs to command-line options, or have ARCHIVEEXISTINGLOGS 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.

<pre><code class="lang-zsh">cd examples/
pytest test_suite.py --chrome
pytest test_suite.py --firefox</code></pre>
An 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) --settingsfile=customsettings.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.

<a id="directory_configuration"></a> <h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Directory Configuration:</h2>
🔵 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:

<pre><code class="lang-zsh">sbase mkdir ui_tests</code></pre>
> That new folder will have these files:
<pre><code class="lang-zsh">ui_tests/ ├── init.py ├── myfirsttest.py ├── parameterized_test.py ├── pytest.ini ├── requirements.txt ├── setup.cfg ├── testdemosite.py └── boilerplates/     ├── init.py     ├── basetestcase.py     ├── boilerplate_test.py     ├── classicobjtest.py     ├── page_objects.py     ├── sbfixturetest.py     └── samples/         ├── init.py         ├── google_objects.py         ├── google_test.py         ├── sbswagtest.py         └── swaglabstest.py</code></pre>
<b>ProTip™:</b> You can also create a boilerplate folder without any sample tests in it by adding -b or --basic to the sbase mkdir command:

<pre><code class="lang-zsh">sbase mkdir ui_tests --basic</code></pre>
> That new folder will have these files:
<pre><code class="lang-zsh">ui_tests/ ├── init.py ├── pytest.ini ├── requirements.txt └── setup.cfg</code></pre>
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).

<b>ProTip™:</b> Add --gha to include a GitHub Actions .yml file with default settings:

<pre><code class="lang-zsh">ui_tests/ └── .github                         └── workflows/                      └── python-package.yml</code></pre>

<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Log files from failed tests:</h3>
Let's try an example of a test that fails:
<pre><code class="lang-python">&quot;&quot;&quot; test_fail.py &quot;&quot;&quot; from seleniumbase import BaseCase BaseCase.main(name, file)
class MyTestClass(BaseCase):
def testfindarmyofrobotsonxkcddesertisland(self):         self.goto(&quot;https://xkcd.com/731/&quot;)         self.assertelement(&quot;div#ARMYOF_ROBOTS&quot;, timeout=1)  # This should fail</code></pre>
You can run it from the examples/ folder like this:

<pre><code class="lang-zsh">pytest test_fail.py</code></pre>
🔵 You'll notice that a logs folder, ./latestlogs/, was created to hold information (and screenshots) about the failing test. During test runs, past results get moved to the archivedlogs folder if you have ARCHIVEEXISTINGLOGS 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.


<a id="seleniumbase_dashboard"></a> <h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> SeleniumBase Dashboard:</h2>
🔵 The --dashboard option for pytest generates a SeleniumBase Dashboard located at dashboard.html, which updates automatically as tests run and produce results. Example:

<pre><code class="lang-zsh">pytest --dashboard --rs --headless</code></pre>
<img src="https://seleniumbase.github.io/cdn/img/dashboard_1.png" alt="The SeleniumBase Dashboard" title="The SeleniumBase Dashboard" width="380" />
🔵 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:

<pre><code class="lang-zsh">python -m http.server 1948</code></pre>
🔵 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 <kbd>Ctrl+C</kbd> to stop the http server.)

🔵 Here's a full example of what the SeleniumBase Dashboard may look like:
<pre><code class="lang-zsh">pytest testsuite.py testimage_saving.py --dashboard --rs --headless</code></pre>
<img src="https://seleniumbase.github.io/cdn/img/dashboard_2.png" alt="The SeleniumBase Dashboard" title="The SeleniumBase Dashboard" width="520" />

<a id="creatingvisualreports"></a> <h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Generating Test Reports:</h2>
<h3>🔵 <code>pytest</code> HTML Reports:</h3>
✅ Using --html=report.html gives you a fancy report of the name specified after your test suite completes.

<pre><code class="lang-zsh">pytest test_suite.py --html=report.html</code></pre>
<img src="https://seleniumbase.github.io/cdn/img/html_report.png" alt="Example Pytest Report" title="Example Pytest Report" width="520" />
✅ 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:
<pre><code class="lang-zsh">pytest test_suite.py --dashboard --html=report.html</code></pre>
<img src="https://seleniumbase.github.io/cdn/img/dash_report.jpg" alt="Dashboard Pytest HTML Report" title="Dashboard Pytest HTML Report" width="520" />
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.

<pre><code class="lang-zsh">pytest test_suite.py --junit-xml=report.xml</code></pre>
<h3>🔵 <code>pynose</code> Reports:</h3>
The --report option gives you a fancy report after your test suite completes.

<pre><code class="lang-zsh">pynose test_suite.py --report</code></pre>
<img src="https://seleniumbase.github.io/cdn/img/nose_report.png" alt="Example pynose Report" title="Example pynose Report" width="320" />
(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.)

<h3>🔵 <code>behave</code> Dashboard & Reports:</h3>
(The behavebdd/ folder can be found in the examples/ folder.)

<pre><code class="lang-zsh">behave behave_bdd/features/ -D dashboard -D headless</code></pre>
<img src="https://seleniumbase.github.io/cdn/img/sbbehavedashboard.png" title="SeleniumBase" width="520">
You can also use --junit to get .xml reports for each <code translate="no">behave</code> feature. Jenkins can use these files to display better reporting for your tests.

<pre><code class="lang-zsh">behave behave_bdd/features/ --junit -D rs -D headless</code></pre>
<h3>🔵 Allure Reports:</h3>
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:

<pre><code class="lang-zsh">pip install allure-pytest</code></pre>
Now your tests can create Allure results files, which can be processed by Allure Reports.
<pre><code class="lang-zsh">pytest testsuite.py --alluredir=allureresults</code></pre>

<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Using a Proxy Server:</h3>
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.

<pre><code class="lang-zsh">pytest proxytest.py --proxy=IPADDRESS:PORT</code></pre>
If the proxy server that you wish to use requires authentication, you can do the following (Chromium only):
<pre><code class="lang-zsh">pytest proxytest.py --proxy=USERNAME:PASSWORD@IPADDRESS:PORT</code></pre>
SeleniumBase also supports SOCKS4 and SOCKS5 proxies:
<pre><code class="lang-zsh">pytest proxytest.py --proxy=&quot;socks4://IPADDRESS:PORT&quot;
pytest proxytest.py --proxy=&quot;socks5://IPADDRESS:PORT&quot;</code></pre>
To make things easier, you can add your frequently-used proxies to PROXYLIST in proxylist.py, and then use --proxy=KEYFROMPROXYLIST to use the IPADDRESS:PORT of that key.

<pre><code class="lang-zsh">pytest proxy_test.py --proxy=proxy1</code></pre>
<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Changing the User-Agent:</h3>
🔵 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 useragenttest.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.

README truncated. View on GitHub