Merge pull request #849 from seleniumbase/the-big-refactor

Lots of refactoring and efficiency improvements

Author: mdmintz

examples/master_qa/ReadMe.md

@@ -1,8 +1,8 @@
-![](https://cdn2.hubspot.net/hubfs/100006/images/masterqa_logo-11.png "MasterQA")
+![](https://seleniumbase.io/cdn/img/masterqa_logo.png "MasterQA")
 
-### MasterQA combines automation with manual verification steps.
+<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> MasterQA combines automation with manual verification steps.</h3>
 
-![](https://cdn2.hubspot.net/hubfs/100006/images/masterqa6.gif "MasterQA")
+![](https://seleniumbase.io/cdn/gif/masterqa6.gif "MasterQA")
 
 Here's example code from [basic_masterqa_test_0.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/basic_masterqa_test_0.py):
 
@@ -19,16 +19,16 @@ After each automation checkpoint, a pop-up window will ask the user questions fo
 
 When the test run completes, as seen from [this longer example](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/masterqa_test_1.py), you'll reach the results page that appears after answering all the verification questions. (Failed verifications generate links to screenshots and log files.)
 
-![](https://cdn2.hubspot.net/hubfs/100006/images/hybrid_screen.png "MasterQA")
+![](https://seleniumbase.io/cdn/img/mqa_hybrid.png "MasterQA")
 
 You may have noticed the ``Incomplete Test Runs`` row on the results page. If the value for that is not zero, it means that one of the automated steps failed. This could happen if you tell your script to perform an action on an element that doesn't exist. Now that we're mixing automation with manual QA, it's good to tell apart the failures from each. The results_table CSV file contains a spreadsheet with the details of each failure (if any) for both manual and automated steps.
 
 #### How to run the example tests from scratch:
+
 ```bash
 git clone https://github.com/seleniumbase/SeleniumBase.git
 cd SeleniumBase
-pip install -r requirements.txt --upgrade
-python setup.py develop
+pip install .
 cd examples/master_qa
 pytest basic_masterqa_test_0.py
 pytest masterqa_test_1.py
@@ -48,6 +48,6 @@ self.verify()
 self.verify("Can you find the moon?")
 ```
 
----
+--------
 
 MasterQA is powered by [SeleniumBase](https://seleniumbase.com), the most advanced open-source automation framework on the [Planet](https://en.wikipedia.org/wiki/Earth).

examples/test_chromedriver.py

@@ -13,13 +13,13 @@ def test_chromedriver_matches_chrome(self):
             print("\n  This test is only for Chrome!")
             print("  (Run with: '--browser=chrome')")
             self.skip("This test is only for Chrome!")
-        driver_capabilities = self.driver.__dict__["capabilities"]
+        driver_capabilities = self.driver.capabilities
         if "version" in driver_capabilities:
             chrome_version = driver_capabilities["version"]
         else:
             chrome_version = driver_capabilities["browserVersion"]
         major_chrome_version = chrome_version.split('.')[0]
-        chrome_dict = self.driver.__dict__["capabilities"]["chrome"]
+        chrome_dict = self.driver.capabilities["chrome"]
         chromedriver_version = chrome_dict["chromedriverVersion"]
         chromedriver_version = chromedriver_version.split(' ')[0]
         major_chromedriver_version = chromedriver_version.split('.')[0]

examples/tour_examples/ReadMe.md

@@ -1,6 +1,6 @@
 <h3 align="left"><img src="https://seleniumbase.io/cdn/img/sb_logo_b.png" alt="SeleniumBase" width="320" /></h3>
 
-## Interactive Product Tours
+<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Interactive Product Tours</h2>
 
 SeleniumBase Tours utilize 5 JavaScript libraries for creating interactive walkthroughs on any website:<br>**[Shepherd](https://shepherdjs.dev/)**, **[Bootstrap Tour](http://bootstraptour.com/)**, **[IntroJS](https://introjs.com/)**, **[DriverJS](https://kamranahmed.info/driver.js/)**, and **[Hopscotch](https://linkedinattic.github.io/hopscotch/)**.
 

help_docs/desired_capabilities.md

@@ -1,4 +1,4 @@
-<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Using Desired Capabilities</h3>
+<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Using Desired Capabilities</h3>
 
 You can specify browser desired capabilities for webdriver when running SeleniumBase tests on a remote SeleniumGrid server such as [BrowserStack](https://www.browserstack.com/automate/capabilities), [Sauce Labs](https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/), or [TestingBot](https://testingbot.com/support/other/test-options).
 

help_docs/hidden_files_info.md

@@ -1,4 +1,4 @@
-## Info about hidden files on macOS
+<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Info about hidden files on macOS</h2>
 
 Depending on your macOS settings, some files may be hidden from view in your Finder window, such as ``.gitignore``. To view all files, run the following command and then reopen the Finder window:
 

help_docs/how_it_works.md

@@ -3,20 +3,24 @@
 <a id="how_seleniumbase_works"></a>
 <h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> How it works:</h2>
 
-At the core, SeleniumBase works by extending [pytest](https://docs.pytest.org/en/latest/) as a direct plugin. SeleniumBase automatically spins up web browsers for tests, and then gives those tests access to the SeleniumBase libraries through the [BaseCase class](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py). Tests are also given access to [SeleniumBase command-line arguments](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md) and [SeleniumBase methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md), which provide additional functionality.
+At the core, SeleniumBase works by extending [pytest](https://docs.pytest.org/en/latest/) as a direct plugin. SeleniumBase automatically spins up web browsers for tests (using Selenium WebDriver), and then gives those tests access to the SeleniumBase libraries through the [BaseCase class](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py). Tests are also given access to [SeleniumBase command-line arguments](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md) and [SeleniumBase methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md), which provide additional functionality.
 
 (NOTE: pytest uses a feature called test discovery to automatically find and run Python methods that start with "``test_``" from the file that you specified on the command line.)
 
-To use SeleniumBase calls you need the following:
+The most common way of using SeleniumBase is by inheriting BaseCase:
 
 ```python
 from seleniumbase import BaseCase
 ```
 
-And then have your test classes inherit BaseCase:
+Then have your test classes inherit BaseCase:
 
 ```python
 class MyTestClass(BaseCase):
 ```
 
 (See the example test, [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py), for reference.)
+
+--------
+
+For more ways of using SeleniumBase, see: <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md">SyntaxFormats</a>.

help_docs/html_inspector.md

@@ -0,0 +1,36 @@
+<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> The HTML Inspector</h2>
+
+🔵 <b>HTML Inspector</b> provides useful info about a web page.
+
+🔵 (<i>Based on: [github.com/philipwalton/html-inspector](https://github.com/philipwalton/html-inspector)</i>)
+
+🔵 Example: [examples/test_inspect_html.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_inspect_html.py) (Chromium-only)
+
+```python
+from seleniumbase import BaseCase
+
+class HtmlInspectorTests(BaseCase):
+    def test_html_inspector(self):
+        self.open("https://xkcd.com/1144/")
+        self.inspect_html()
+```
+
+--------
+
+```bash
+pytest test_inspect_html.py 
+============== test session starts ==============
+
+* HTML Inspection Results: https://xkcd.com/1144/
+X - https://xkcd.com/1144/ - Access to XMLHttpRequest at 'https://xkcd.com/usBanner' (redirected from 'https://c.xkcd.com/xkcd/news') from origin 'https://xkcd.com' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.
+X - https://xkcd.com/usBanner - Failed to load resource: net::ERR_FAILED
+X - 'property' is not a valid attribute of the <meta> element.
+X - Do not use <div> or <span> elements without any attributes.
+X - The 'alt' attribute is required for <img> elements.
+X - The 'border' attribute is no longer valid on the <img> element and should not be used.
+X - 'srcset' is not a valid attribute of the <img> element.
+X - The <center> element is obsolete and should not be used.
+X - <script> elements should appear right before the closing </body> tag for optimal performance.
+X - The id 'comicLinks' appears more than once in the document.
+* (See the Console output for details!)
+```

help_docs/js_package_manager.md

@@ -1,11 +1,11 @@
 [<img src="https://seleniumbase.io/cdn/img/super_logo_sb.png" title="SeleniumBase" width="290">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
 
-<h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> JS Package Manager</h2>
+<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> JS Package Manager</h2>
 
 <div>SeleniumBase lets you load JavaScript packages from any CDN link into any website.</div>
 <p><div>Here's an example of loading a website-tour library into the browser while visiting Google:</div></p>
 
-<img src="https://cdn2.hubspot.net/hubfs/100006/google_tour_3.gif" title="SeleniumBase Tour of Google" /><br />
+<img src="https://seleniumbase.io/cdn/gif/driverjs_tour.gif" title="SeleniumBase Tour of Google" /><br />
 
 This example, ([google_tour.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/google_tour.py) from the SeleniumBase ``examples/tour_examples/`` folder), can be run with ``pytest`` after you've cloned and installed [SeleniumBase from GitHub](https://github.com/seleniumbase/SeleniumBase):
 
@@ -82,7 +82,7 @@ def add_css_link(driver, css_link):
 <div>Website tours are just one of the many ways of using the SeleniumBase JS Package Manager.</div>
 <p><div>The following example shows the <a href="https://github.com/craftpip/jquery-confirm">JqueryConfirm</a> package loaded into a website for creating fancy dialog boxes:</div></p>
 
-<img src="https://cdn2.hubspot.net/hubfs/100006/images/masterqa6.gif" alt="MasterQA by SeleniumBase" title="MasterQA by SeleniumBase" /><br />
+<img src="https://seleniumbase.io/cdn/gif/masterqa6.gif" alt="MasterQA by SeleniumBase" title="MasterQA by SeleniumBase" /><br />
 
 <p><div>(Example from <a href="https://seleniumbase.io/examples/master_qa/ReadMe/">SeleniumBase's MasterQA ReadMe</a>)</div></p>
 

help_docs/locale_codes.md

@@ -1,12 +1,12 @@
-<h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Language Locale Codes</h2>
+<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="25" /> Language Locale Codes</h2>
 
 You can specify a Language Locale Code to customize web pages on supported websites. With SeleniumBase you can change the web browser's Locale on the command line by adding:
 
 ```bash
 --locale=CODE  # Example: --locale=ru
 ```
 
-<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> List of Language Locale Codes:</h3>
+<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="25" /> List of Language Locale Codes:</h3>
 
 <table>
     <thead><tr><th>Language</th><th>Code</th></tr></thead>

help_docs/mysql_installation.md

@@ -1,4 +1,4 @@
-### MySQL Installation Instructions
+<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="25" /> MySQL Installation Instructions</h3>
 
 
 #### [MySQL](http://www.mysql.com/) (OPTIONAL)