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/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)

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

@@ -1861,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)