Merge pull request #211 from seleniumbase/multi-factor-auth

Add ability to handle time-based Google Authenticator logins

Author: mdmintz

help_docs/features_list.md

@@ -11,6 +11,7 @@
 * Uses a [global config file](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py) for configuring SeleniumBase to your specific needs.
 * 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 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.
 * Includes integrations 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), [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 [NodeJS](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js).
 * Includes a [tool to convert Selenium IDE recordings](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/utilities/selenium_ide) into clean, robust SeleniumBase scripts.

help_docs/install_python_pip_git.md

@@ -32,6 +32,13 @@ If you're having any trouble getting pip, you can [GET PIP HERE](https://pip.pyp
 
 When done, make sure the location of pip is on your path, which is `$PATH` for Mac/Linux. (On Windows, it's the System Variables `Path` within System Environment Variables. Ex: Add "C:/Python27/Scripts/" to the end of the `Path` variable.)
 
+You can also get pip (or fix pip) by using:
+```bash
+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/) (MAC-ONLY) (OPTIONAL)
 
 The Homebrew package manager allows you to install things more easily on MacOS, such as Git and Chromedriver.

help_docs/method_summary.md

@@ -162,6 +162,8 @@ self.is_downloaded_file_present(file)
 
 self.assert_downloaded_file(file)
 
+self.get_google_auth_password(totp_key=None)
+
 self.convert_xpath_to_css(xpath)
 
 self.convert_to_css_selector(selector, by)

requirements.txt

@@ -1,14 +1,15 @@
 pip
+ipython
 setuptools
 selenium==3.14.1
-ipython==5.6.0
 pytest>=3.8.1
-pytest-html>=1.19.0
-pytest-xdist>=1.23.0
 pytest-cov>=2.6.0
+pytest-html>=1.19.0
 pytest-rerunfailures>=4.1
+pytest-xdist>=1.23.0
 parameterized==0.6.1
 six>=1.11.0
+pyotp>=2.2.6
 requests>=2.19.1
 beautifulsoup4==4.6.3
 unittest2==1.1.0

seleniumbase/config/settings.py

@@ -88,7 +88,14 @@
 
 
 # #####>>>>>----- RECOMMENDED SETTINGS -----<<<<<#####
-# ##### (For database reporting, saving test logs, and password encryption)
+# ##### (For multi-factor auth, DB/cloud logging, and password encryption)
+
+# Google Authenticator
+# (For 2-factor authentication using a time-based one-time password algorithm)
+# (See https://github.com/pyotp/pyotp and https://pypi.org/project/pyotp/ )
+# (Also works with Authy and other compatible apps.)
+TOTP_KEY = "base32secretABCD"
+
 
 # MySQL DB Credentials
 # (For saving data from tests)

seleniumbase/fixtures/base_case.py

@@ -21,7 +21,6 @@ def test_anything(self):
 Code becomes greatly simplified and easier to maintain.
 """
 
-import getpass
 import logging
 import math
 import os
@@ -30,7 +29,6 @@ def test_anything(self):
 import requests
 import sys
 import time
-import traceback
 import unittest
 import uuid
 from bs4 import BeautifulSoup
@@ -1863,6 +1861,18 @@ def assert_downloaded_file(self, file):
         """ Asserts that the file exists in the Downloads Folder. """
         assert os.path.exists(self.get_path_of_downloaded_file(file))
 
+    def get_google_auth_password(self, totp_key=None):
+        """ Returns a time-based one-time password based on the
+            Google Authenticator password algorithm. Works with Authy.
+            If "totp_key" is not specified, will default to using
+            the one provided in seleniumbase/config/settings.py
+            (See https://pyotp.readthedocs.io/en/latest/ for details.) """
+        import pyotp
+        if not totp_key:
+            totp_key = settings.TOTP_KEY
+        totp = pyotp.TOTP(totp_key)
+        return str(totp.now())
+
     def convert_xpath_to_css(self, xpath):
         return xpath_to_css.convert_xpath_to_css(xpath)
 
@@ -3033,6 +3043,7 @@ def setUp(self):
                 # Use Selenium Grid (Use --server=127.0.0.1 for localhost Grid)
                 self.use_grid = True
             if self.with_db_reporting:
+                import getpass
                 self.execution_guid = str(uuid.uuid4())
                 self.testcase_guid = None
                 self.execution_start_time = 0
@@ -3096,6 +3107,7 @@ def __insert_test_result(self, state, err):
         data_payload.execution_guid = self.execution_guid
         data_payload.state = state
         if err:
+            import traceback
             tb_string = traceback.format_exc()
             if "Message: " in tb_string:
                 data_payload.message = "Message: " + tb_string.split(

setup.py

@@ -17,7 +17,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.15.11',
+    version='1.15.12',
     description='All-In-One Test Automation Framework',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -33,6 +33,11 @@
         "Topic :: Internet",
         "Topic :: Scientific/Engineering",
         "Topic :: Software Development",
+        "Topic :: Software Development :: Quality Assurance",
+        "Topic :: Software Development :: Testing",
+        "Topic :: Software Development :: Testing :: Acceptance",
+        "Topic :: Software Development :: Testing :: Traffic Generation",
+        "Topic :: Utilities",
         "Operating System :: Microsoft :: Windows",
         "Operating System :: Unix",
         "Operating System :: MacOS",
@@ -46,16 +51,17 @@
     ],
     install_requires=[
         'pip',
+        'ipython',
         'setuptools',
         'selenium==3.14.1',
-        'ipython==5.6.0',
         'pytest>=3.8.1',
-        'pytest-html>=1.19.0',
-        'pytest-xdist>=1.23.0',
         'pytest-cov>=2.6.0',
+        'pytest-html>=1.19.0',
         'pytest-rerunfailures>=4.1',
+        'pytest-xdist>=1.23.0',
         'parameterized==0.6.1',
         'six>=1.11.0',
+        'pyotp>=2.2.6',
         'requests>=2.19.1',
         'beautifulsoup4==4.6.3',
         'unittest2==1.1.0',