Merge pull request #314 from seleniumbase/several-updates

mdmintz · web-flow · commit c3083891d277 · 2019-04-15T03:18:19.000-04:00
Several minor updates
diff --git a/.gitignore b/.gitignore
@@ -18,6 +18,15 @@ lib
 lib64
 __pycache__
 
+# Python3 pyvenv
+pyvenv.cfg
+.Python
+include
+pip-delete-this-directory.txt
+pip-selfcheck.json
+ipython.1.gz
+nosetests.1
+
 # Installer logs
 pip-log.txt
 .swp
diff --git a/README.md b/README.md
diff --git a/examples/raw_parameter_script.py b/examples/raw_parameter_script.py
@@ -40,6 +40,8 @@
     b.visual_baseline = False
     b.save_screenshot_after_test = False
     b.timeout_multiplier = None
+    b.pytest_html_report = None
+    b.report_on = False
     b.with_db_reporting = False
     b.with_s3_logging = False
     b.js_checking_on = False
diff --git a/examples/tour_examples/ReadMe.md b/examples/tour_examples/ReadMe.md
@@ -1,9 +1,14 @@
 ## SeleniumBase Website Tours
 
-SeleniumBase Tours utilize your choice of 4 different JavaScript libraries for creating & running tours, demos, and walkthroughs on any website: **[Shepherd](https://shipshapecode.github.io/shepherd/docs/welcome/)**, **[Bootstrap Tour](http://bootstraptour.com/)**, **[IntroJS](https://introjs.com/)**, and **[Hopscotch](http://linkedin.github.io/hopscotch/)**. Choose your favorite one to use!
+SeleniumBase Tours utilize your choice of 4 different JavaScript libraries for prototyping tours, demos, walkthroughs, and onboarding experiences on any website: **[Shepherd](https://shipshapecode.github.io/shepherd/docs/welcome/)**, **[Bootstrap Tour](http://bootstraptour.com/)**, **[IntroJS](https://introjs.com/)**, and **[Hopscotch](http://linkedin.github.io/hopscotch/)**. Choose your favorite one to use!
 
 Example tour:
 
+```
+cd examples/tour_examples
+pytest google_tour.py
+```
+
 <img src="https://cdn2.hubspot.net/hubfs/100006/google_tour_3.gif" title="SeleniumBase Tour of Google" height="260"><br>
 
 
diff --git a/help_docs/features_list.md b/help_docs/features_list.md
@@ -12,6 +12,7 @@
 * Backwards-compatible with [WebDriver](http://www.seleniumhq.org/projects/webdriver/). (Use ``self.driver`` anywhere.)
 * Can run tests through a proxy server. (Use ``--proxy=IP_ADDRESS:PORT``)
 * Can use an authenticated proxy server. (``--proxy=USERNAME:PASSWORD@IP_ADDRESS:PORT``)
+* Can change the web browser's user agent string. (Use ``--agent=USER_AGENT_STRING``)
 * Can handle Google Authenticator logins by using the [Python one-time password library](https://pyotp.readthedocs.io/en/latest/).
 * Includes a hybrid-automation solution called **[MasterQA](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/masterqa/ReadMe.md)** to speed up manual testing.
 * Integrates with [MySQL](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/core/testcase_manager.py), [Selenium Grid](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/utilities/selenium_grid), [Azure](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/azure/jenkins/ReadMe.md), [Google Cloud](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/google_cloud/ReadMe.md), [Amazon S3](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/s3_logging_plugin.py), and [Docker](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/docker/ReadMe.md).
diff --git a/help_docs/install_python_pip_git.md b/help_docs/install_python_pip_git.md
@@ -1,4 +1,10 @@
-## Installation instructions for Python, pip, brew, git, virtualenv, and virtualenvwrapper
+## Installation instructions for Git, Python, and Pip
+
+### [Git](http://www.git-scm.com)
+
+You can [download Git from here](http://git-scm.com/downloads).
+
+(You can also download the SeleniumBase repository right from GitHub and skip all the git-related commands.)
 
 ### [Python 2.7 or 3.x](https://www.python.org/downloads/)
 
@@ -42,34 +48,3 @@ curl https://bootstrap.pypa.io/get-pip.py | python
 ```
 
 (If you get SSL errors while trying to install packages with pip, see [this Stackoverflow post](https://stackoverflow.com/questions/49768770/not-able-to-install-python-packages-ssl-tlsv1-alert-protocol-version), which tells you to run the above command.)
-
-### [Homebrew](http://brew.sh/) (macOS-ONLY) (OPTIONAL)
-
-The Homebrew package manager allows you to install things more easily on macOS, such as Git and Chromedriver.
-
-Here's the command line script to install Homebrew (*from [https://brew.sh/](https://brew.sh/)*):
-```bash
-/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-```
-If you haven't updated Homebrew in awhile, you probably should. Here's how:
-```bash
-brew update
-```
-
-### [Git](http://www.git-scm.com)
-
-You can [download Git from here](http://git-scm.com/downloads).
-
-macOS-ONLY shortcut: (This step only works if you installed Homebrew in the previous step)
-```bash
-brew install git
-```
-
-(You can also download the SeleniumBase repository right from GitHub and skip all the git-related commands.)
-
-<a id="virtual_environment"></a>
-### [VirtualEnv](http://virtualenv.readthedocs.org/en/latest/) and [VirtualEnvWrapper](http://virtualenvwrapper.readthedocs.org/en/latest/)
-
-Virtual environments allow each your Python projects to have a unique set of packaged dependencies.
-
-To learn how to create a Python virtual environment, [see this ReadMe](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md).
diff --git a/help_docs/mysql_installation.md b/help_docs/mysql_installation.md
@@ -29,12 +29,6 @@ If you want a visual tool to help make your MySQL life easier, [try MySQL Workbe
 
 You can use the [testcaserepository.sql](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/core/testcaserepository.sql) file to create the necessary tables for storing test data.
 
-If you were able to successfully install MySQL, you can now install the remaining MySQL requirements:
-```bash
-pip install -r requirements.txt
-```
-(NOTE: This install uses Selenium 2.53.6 rather than the usual Selenium 3+ from the standard requirements file due to compatibility issues with running browser tests on headless server machines.)
-
 #### Configure your MySQL DB for SeleniumBase
 
 You'll want to update your [settings.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py) file with your MySQL DB credentials so that tests can write to the database when they run.
@@ -44,7 +38,7 @@ You'll want to update your [settings.py](https://github.com/seleniumbase/Seleniu
 Add the ``--with-db_reporting`` argument on the command line when you want tests to write to your MySQL database.
 Example:
 ```bash
-nosetests my_first_test.py --with-db_reporting
+pytest my_first_test.py --with-db_reporting
 ```
 
 #### Windows mysql-python troubleshooting:
diff --git a/help_docs/virtualenv_instructions.md b/help_docs/virtualenv_instructions.md
@@ -24,15 +24,28 @@ python -m pip install --upgrade virtualenv
 python -m pip install --upgrade virtualenvwrapper-win
 ```
 
-### **Step 2**: Now use VirtualEnv or VirtualEnvWrapper to create a virtual environment:
+### **Step 2**: Now create a virtual environment:
 
 #### macOS / Linux / Windows:
 
+* Using ``mkvirtualenv``:
 ```bash
-mkvirtualenv seleniumbase
+mkvirtualenv seleniumbase_venv
 ```
 (If you have multiple versions of Python installed on your machine, and you want your virtual environment to use a specific Python version, add ``--python=PATH_TO_PYTHON_EXE`` with the Python executable to use.)
 
+* Using ``virtualenv``:
+```bash
+virtualenv seleniumbase_venv
+source seleniumbase_venv/bin/activate
+```
+
+* (Python 3) Using ``mvenv``:
+```bash
+python3 -mvenv seleniumbase_venv
+source seleniumbase_venv/bin/activate
+```
+
 ---
 
 If you ever need to leave your virtual environment, use the following command:
@@ -44,7 +57,7 @@ deactivate
 You can always jump back into your virtual environment later:
 
 ```bash
-workon seleniumbase
+workon seleniumbase_venv
 ```
 
 To list all existing virtual environments:
diff --git a/seleniumbase/fixtures/base_case.py b/seleniumbase/fixtures/base_case.py
@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """
 The BaseCase class is the main gateway for using The SeleniumBase Framework.
 It inherits Python's unittest.TestCase class, and runs with Pytest or Nose.
@@ -31,6 +32,13 @@ def test_anything(self):
 import time
 import unittest
 import uuid
+from selenium.common.exceptions import (StaleElementReferenceException,
+                                        MoveTargetOutOfBoundsException,
+                                        WebDriverException)
+from selenium.common import exceptions as selenium_exceptions
+from selenium.webdriver.common.by import By
+from selenium.webdriver.common.keys import Keys
+from selenium.webdriver.support.ui import Select
 from seleniumbase import config as sb_config
 from seleniumbase.common import decorators
 from seleniumbase.config import settings
@@ -45,19 +53,7 @@ def test_anything(self):
 from seleniumbase.fixtures import page_actions
 from seleniumbase.fixtures import page_utils
 from seleniumbase.fixtures import xpath_to_css
-from selenium.common.exceptions import (StaleElementReferenceException,
-                                        MoveTargetOutOfBoundsException,
-                                        WebDriverException)
-from selenium.common import exceptions as selenium_exceptions
-try:
-    # Selenium 3 (ElementNotInteractableException does not exist in selenium 2)
-    ENI_Exception = selenium_exceptions.ElementNotInteractableException
-except Exception:
-    # Selenium 2 (Keep compatibility with seleneium 2.53.6 if still being used)
-    ENI_Exception = selenium_exceptions.ElementNotSelectableException
-from selenium.webdriver.common.by import By
-from selenium.webdriver.common.keys import Keys
-from selenium.webdriver.support.ui import Select
+ENI_Exception = selenium_exceptions.ElementNotInteractableException
 
 
 class BaseCase(unittest.TestCase):
@@ -74,6 +70,7 @@ def __init__(self, *args, **kwargs):
         self.__last_url_of_delayed_assert = "data:,"
         self.__last_page_load_url = "data:,"
         self.__last_page_screenshot = None
+        self.__last_page_screenshot_png = None
         self.__delayed_assert_count = 0
         self.__delayed_assert_failures = []
         # Requires self._* instead of self.__* for external class use
@@ -3118,6 +3115,10 @@ def setUp(self, masterqa_mode=False):
             self.save_screenshot_after_test = sb_config.save_screenshot
             self.visual_baseline = sb_config.visual_baseline
             self.timeout_multiplier = sb_config.timeout_multiplier
+            self.pytest_html_report = sb_config.pytest_html_report
+            self.report_on = False
+            if self.pytest_html_report:
+                self.report_on = True
             self.use_grid = False
             if self.servername != "localhost":
                 # Use Selenium Grid (Use --server=127.0.0.1 for localhost Grid)
@@ -3188,15 +3189,32 @@ def setUp(self, masterqa_mode=False):
         self._default_driver = self.driver
 
     def __set_last_page_screenshot(self):
-        if not self.__last_page_screenshot:
+        """ self.__last_page_screenshot is only for pytest html report logs
+            self.__last_page_screenshot_png is for all screenshot log files """
+        if not self.__last_page_screenshot and (
+                not self.__last_page_screenshot_png):
             try:
                 element = self.driver.find_element_by_tag_name('body')
-                if self.is_pytest:
+                if self.is_pytest and self.report_on:
+                    self.__last_page_screenshot_png = (
+                        self.driver.get_screenshot_as_png())
                     self.__last_page_screenshot = element.screenshot_as_base64
                 else:
-                    self.__last_page_screenshot = element.screenshot_as_png
+                    self.__last_page_screenshot_png = element.screenshot_as_png
             except Exception:
-                pass
+                if not self.__last_page_screenshot:
+                    if self.is_pytest and self.report_on:
+                        try:
+                            self.__last_page_screenshot = (
+                                self.driver.get_screenshot_as_base64())
+                        except Exception:
+                            pass
+                if not self.__last_page_screenshot_png:
+                    try:
+                        self.__last_page_screenshot_png = (
+                            self.driver.get_screenshot_as_png())
+                    except Exception:
+                        pass
 
     def __insert_test_result(self, state, err):
         data_payload = TestcaseDataPayload()
@@ -3223,20 +3241,21 @@ def __add_pytest_html_extra(self):
             if self.with_selenium:
                 if not self.__last_page_screenshot:
                     self.__set_last_page_screenshot()
-                extra_url = {}
-                extra_url['name'] = 'URL'
-                extra_url['format'] = 'url'
-                extra_url['content'] = self.get_current_url()
-                extra_url['mime_type'] = None
-                extra_url['extension'] = None
-                extra_image = {}
-                extra_image['name'] = 'Screenshot'
-                extra_image['format'] = 'image'
-                extra_image['content'] = self.__last_page_screenshot
-                extra_image['mime_type'] = 'image/png'
-                extra_image['extension'] = 'png'
-                self._html_report_extra.append(extra_url)
-                self._html_report_extra.append(extra_image)
+                if self.report_on:
+                    extra_url = {}
+                    extra_url['name'] = 'URL'
+                    extra_url['format'] = 'url'
+                    extra_url['content'] = self.get_current_url()
+                    extra_url['mime_type'] = None
+                    extra_url['extension'] = None
+                    extra_image = {}
+                    extra_image['name'] = 'Screenshot'
+                    extra_image['format'] = 'image'
+                    extra_image['content'] = self.__last_page_screenshot
+                    extra_image['mime_type'] = 'image/png'
+                    extra_image['extension'] = 'png'
+                    self._html_report_extra.append(extra_url)
+                    self._html_report_extra.append(extra_image)
         except Exception:
             pass
 
@@ -3325,12 +3344,12 @@ def tearDown(self):
                             os.makedirs(test_logpath)
                         except Exception:
                             pass  # Only reachable during multi-threaded runs
-                    if not self.__last_page_screenshot:
+                    if not self.__last_page_screenshot_png:
                         self.__set_last_page_screenshot()
                     log_helper.log_screenshot(
                         test_logpath,
                         self.driver,
-                        self.__last_page_screenshot)
+                        self.__last_page_screenshot_png)
                     self.__add_pytest_html_extra()
                 if self.with_testing_base and has_exception:
                     test_logpath = self.log_path + "/" + test_id
@@ -3343,23 +3362,23 @@ def tearDown(self):
                             not self.with_basic_test_info) and (
                             not self.with_page_source)):
                         # Log everything if nothing specified (if testing_base)
-                        if not self.__last_page_screenshot:
+                        if not self.__last_page_screenshot_png:
                             self.__set_last_page_screenshot()
                         log_helper.log_screenshot(
                             test_logpath,
                             self.driver,
-                            self.__last_page_screenshot)
+                            self.__last_page_screenshot_png)
                         log_helper.log_test_failure_data(
                             self, test_logpath, self.driver, self.browser)
                         log_helper.log_page_source(test_logpath, self.driver)
                     else:
                         if self.with_screen_shots:
-                            if not self.__last_page_screenshot:
+                            if not self.__last_page_screenshot_png:
                                 self.__set_last_page_screenshot()
                             log_helper.log_screenshot(
                                 test_logpath,
                                 self.driver,
-                                self.__last_page_screenshot)
+                                self.__last_page_screenshot_png)
                         if self.with_basic_test_info:
                             log_helper.log_test_failure_data(
                                 self, test_logpath, self.driver, self.browser)
@@ -3420,12 +3439,12 @@ def tearDown(self):
                 log_helper.log_test_failure_data(
                     self, test_logpath, self.driver, self.browser)
                 if len(self._drivers_list) > 0:
-                    if not self.__last_page_screenshot:
+                    if not self.__last_page_screenshot_png:
                         self.__set_last_page_screenshot()
                     log_helper.log_screenshot(
                         test_logpath,
                         self.driver,
-                        self.__last_page_screenshot)
+                        self.__last_page_screenshot_png)
                     log_helper.log_page_source(test_logpath, self.driver)
             elif self.save_screenshot_after_test:
                 test_id = "%s.%s.%s" % (self.__class__.__module__,
@@ -3437,14 +3456,14 @@ def tearDown(self):
                         os.makedirs(test_logpath)
                     except Exception:
                         pass  # Only reachable during multi-threaded runs
-                if not self.__last_page_screenshot:
+                if not self.__last_page_screenshot_png:
                     self.__set_last_page_screenshot()
                 log_helper.log_screenshot(
                     test_logpath,
                     self.driver,
-                    self.__last_page_screenshot)
+                    self.__last_page_screenshot_png)
             if self.report_on:
-                self._last_page_screenshot = self.__last_page_screenshot
+                self._last_page_screenshot = self.__last_page_screenshot_png
                 try:
                     self._last_page_url = self.get_current_url()
                 except Exception:
diff --git a/seleniumbase/plugins/pytest_plugin.py b/seleniumbase/plugins/pytest_plugin.py
@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ This is the pytest configuration file """
 
 import optparse
@@ -221,6 +222,7 @@ def pytest_configure(config):
     sb_config.save_screenshot = config.getoption('save_screenshot')
     sb_config.visual_baseline = config.getoption('visual_baseline')
     sb_config.timeout_multiplier = config.getoption('timeout_multiplier')
+    sb_config.pytest_html_report = config.getoption("htmlpath")  # --html=FILE
 
     if sb_config.with_testing_base:
         log_helper.log_folder_setup(sb_config.log_path, sb_config.archive_logs)
@@ -268,6 +270,7 @@ def pytest_runtest_makereport(item, call):
         try:
             extra_report = item._testcase._html_report_extra
             extra = getattr(report, 'extra', [])
-            report.extra = extra + extra_report
+            if extra_report[1]["content"]:
+                report.extra = extra + extra_report
         except Exception:
             pass
diff --git a/setup.py b/setup.py
@@ -17,7 +17,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.22.9',
+    version='1.23.0',
     description='Reliable Browser Automation & Testing Framework',
     long_description=long_description,
     long_description_content_type='text/markdown',
