Merge pull request #380 from seleniumbase/remove-email-manager

Remove email_manager. Use IMAPClient instead.

Author: mdmintz

README.md

@@ -10,7 +10,7 @@ All-in-one framework for fast & simple browser automation and end-to-end testing
 pytest my_first_test.py --demo_mode
 ```
 
-SeleniumBase uses [pytest](https://github.com/pytest-dev/pytest) for running tests, while using [Selenium WebDriver](https://www.seleniumhq.org/) for controlling web browsers. SeleniumBase includes additional tools for automated email testing, [assisted-QA](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md), and [website tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md).
+SeleniumBase uses [pytest](https://github.com/pytest-dev/pytest) for running tests, while using [Selenium WebDriver](https://www.seleniumhq.org/) for controlling web browsers. SeleniumBase includes additional tools for automated [visual testing](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md), assisted-QA with [MasterQA](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md), and creating [website tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md).
 
 ## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Get Started:
 
@@ -242,7 +242,7 @@ pytest test_suite.py --browser=firefox
 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](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/custom_settings.py))
 ``--settings_file=custom_settings.py``
-(Settings include default timeout values, a two-factor auth key, DB credentials, S3 credentials, Email Testing API credentials, and other important settings used by tests.)
+(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"``.
 Now inside your tests, you can use ``self.data`` to access that.
@@ -677,24 +677,6 @@ pytest --reruns 5 --reruns-delay 1
 
 Additionally, you can use the ``@retry_on_exception()`` decorator to specifically retry failing methods. (First import: ``from seleniumbase import decorators``) To learn more about SeleniumBase decorators, [click here](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/common).
 
-####  Email Testing / Checking Email: 
-Let's say you have a test that sends an email, and now you want to check that the email was received:
-
-```python
-from seleniumbase.fixtures.email_manager import EmailManager, EmailException
-num_email_results = 0
-email_subject = "This is the subject to search for (maybe include a timestamp)"
-email_manager = EmailManager("{YOUR SELENIUM GMAIL ACCOUNT EMAIL ADDRESS}")
-# The password for this would be stored in seleniumbase/config/settings.py
-try:
-    html_text = email_manager.search(SUBJECT="%s" % email_subject, timeout=60)
-    num_email_results = len(html_text)
-except EmailException:
-    num_email_results = 0
-self.assert_true(num_email_results)  # True if not zero
-```
-
-Now you can parse through the email if you're looking for specific text or want to navigate to a link listed there.
 
 ### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Wrap-Up
 

examples/custom_settings.py

@@ -67,17 +67,3 @@
 # Helps identify which strings/passwords have been obfuscated.
 OBFUSCATION_START_TOKEN = "$^*ENCRYPT="
 OBFUSCATION_END_TOKEN = "?&#$"
-
-# Default Email Credentials
-# (If tests send out emails, you can scan and verify them by using IMAP)
-# Here's a list of imap strings for known email providers:
-# - Gmail:         imap.gmail.com
-# - Outlook/Live:  imap-mail.outlook.com
-# - Yahoo Mail:    imap.mail.yahoo.com
-# - AT&T:          imap.mail.att.net
-# - Comcast:       imap.comcast.net
-# - Verizon:       incoming.verizon.net
-EMAIL_USERNAME = "[TEST ACCOUNT GMAIL USERNAME]@gmail.com"
-EMAIL_PASSWORD = "[TEST ACCOUNT GMAIL PASSWORD]"
-EMAIL_IMAP_STRING = "imap.gmail.com"
-EMAIL_IMAP_PORT = 993

examples/visual_testing/ReadMe.md

@@ -1,3 +1,4 @@
+[<img src="https://cdn2.hubspot.net/hubfs/100006/images/SeleniumBaseText_F.png" title="SeleniumBase" align="center" height="38">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
 ### Automated Visual Testing (Layout Change Detection)
 
 Automated visual testing can help you detect when something has changed the layout of a web page. Rather than comparing screenshots, a more effective way is to detect layout differences by comparing HTML tags and properties. If a change is detected, it could mean that something broke on the webpage, or possibly something harmless like a website redesign or dynamic content.

help_docs/customizing_test_runs.md

@@ -61,7 +61,7 @@ You can interchange **pytest** with **nosetests**, but using pytest is strongly
 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](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/custom_settings.py))
 ``--settings_file=custom_settings.py``
-(Settings include default timeout values, a two-factor auth key, DB credentials, S3 credentials, Email Testing API credentials, and other important settings used by tests.)
+(Settings include default timeout values, a two-factor auth key, DB credentials, S3 credentials, and other important settings used by tests.)
 
 #### **Running tests on [BrowserStack](https://www.browserstack.com/automate#)'s Selenium Grid, the [Sauce Labs](https://saucelabs.com/products/open-source-frameworks/selenium) Selenium Grid, the [TestingBot](https://testingbot.com/features) Selenium Grid, (or your own):**
 

help_docs/method_summary.md

@@ -1,5 +1,5 @@
 [<img src="https://cdn2.hubspot.net/hubfs/100006/images/SeleniumBaseText_F.png" title="SeleniumBase" align="center" height="38">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
-## Method Summary
+## Method Summary Overview
 
 Here's a summary of SeleniumBase method definitions, which are defined in [base_case.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py)
 

seleniumbase/config/settings.py

@@ -139,21 +139,3 @@
 # Helps identify which strings/passwords have been obfuscated.
 OBFUSCATION_START_TOKEN = "$^*ENCRYPT="
 OBFUSCATION_END_TOKEN = "?&#$"
-
-
-# #####>>>>>----- OPTIONAL SETTINGS -----<<<<<#####
-# ##### (For reading emails, notifying people via chat apps, etc.)
-
-# Default Email Credentials
-# (If tests send out emails, you can scan and verify them by using IMAP)
-# Here's a list of imap strings for known email providers:
-# - Gmail:         imap.gmail.com
-# - Outlook/Live:  imap-mail.outlook.com
-# - Yahoo Mail:    imap.mail.yahoo.com
-# - AT&T:          imap.mail.att.net
-# - Comcast:       imap.comcast.net
-# - Verizon:       incoming.verizon.net
-EMAIL_USERNAME = "[TEST ACCOUNT GMAIL USERNAME]@gmail.com"
-EMAIL_PASSWORD = "[TEST ACCOUNT GMAIL PASSWORD]"
-EMAIL_IMAP_STRING = "imap.gmail.com"
-EMAIL_IMAP_PORT = 993

seleniumbase/core/settings_parser.py

@@ -144,14 +144,6 @@ def set_settings(settings_file):
             settings.OBFUSCATION_START_TOKEN = override_settings[key]
         elif key == "OBFUSCATION_END_TOKEN":
             settings.OBFUSCATION_END_TOKEN = override_settings[key]
-        elif key == "EMAIL_USERNAME":
-            settings.EMAIL_USERNAME = override_settings[key]
-        elif key == "EMAIL_PASSWORD":
-            settings.EMAIL_PASSWORD = override_settings[key]
-        elif key == "EMAIL_IMAP_STRING":
-            settings.EMAIL_IMAP_STRING = override_settings[key]
-        elif key == "EMAIL_IMAP_PORT":
-            settings.EMAIL_IMAP_PORT = override_settings[key]
         else:
             continue