Merge pull request #361 from seleniumbase/update-methods-and-mysql

Update methods and mysql

Author: mdmintz

.travis.yml

@@ -17,13 +17,12 @@ before_install:
 install:
   - "pip install --upgrade pip"
   - "pip install -r requirements.txt --upgrade"
-  - "pip install mysqlclient==1.4.2"
   - "python setup.py develop"
   - "sudo rm -f /etc/boto.cfg"
 before_script:
   - "flake8 seleniumbase/*.py && flake8 seleniumbase/*/*.py && flake8 seleniumbase/*/*/*.py && flake8 seleniumbase/*/*/*/*.py"
-  # - "wget https://chromedriver.storage.googleapis.com/2.40/chromedriver_linux64.zip && unzip chromedriver_linux64.zip && sudo cp chromedriver /usr/local/bin/ && sudo chmod +x /usr/local/bin/chromedriver"
-  # - "wget https://github.com/mozilla/geckodriver/releases/download/v0.21.0/geckodriver-v0.21.0-linux64.tar.gz -O /tmp/geckodriver.tar.gz && tar -C /opt -xzf /tmp/geckodriver.tar.gz && sudo chmod 755 /opt/geckodriver && sudo ln -fs /opt/geckodriver /usr/bin/geckodriver && sudo ln -fs /opt/geckodriver /usr/local/bin/geckodriver"
+  # - "wget https://chromedriver.storage.googleapis.com/2.44/chromedriver_linux64.zip && unzip chromedriver_linux64.zip && sudo cp chromedriver /usr/local/bin/ && sudo chmod +x /usr/local/bin/chromedriver"
+  # - "wget https://github.com/mozilla/geckodriver/releases/download/v0.24.0/geckodriver-v0.24.0-linux64.tar.gz -O /tmp/geckodriver.tar.gz && tar -C /opt -xzf /tmp/geckodriver.tar.gz && sudo chmod 755 /opt/geckodriver && sudo ln -fs /opt/geckodriver /usr/bin/geckodriver && sudo ln -fs /opt/geckodriver /usr/local/bin/geckodriver"
   # - "wget https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-2.1.1-linux-x86_64.tar.bz2 && tar -xvf ./phantomjs-2.1.1-linux-x86_64.tar.bz2 && export PATH=$PWD/phantomjs-2.1.1-linux-x86_64/bin:$PATH"
   - "seleniumbase"
   - "seleniumbase install chromedriver"

README.md

@@ -6,6 +6,7 @@ class MyTestClass(BaseCase):
     def test_basic(self):
         self.open("https://xkcd.com/353/")
         self.assert_element('img[alt="Python"]')
+        self.assert_title("xkcd: Python")
         self.click('a[rel="license"]')
         self.assert_text("free to copy and reuse")
         self.go_back()

examples/my_first_test.py

@@ -43,19 +43,26 @@ pytest test_suite.py --reruns 1 --reruns-delay 2
 
 pytest test_suite.py --server=IP_ADDRESS --port=4444
 
+pytest test_fail.py --pdb -s
+
 pytest proxy_test.py --proxy=IP_ADDRESS:PORT
 
 pytest proxy_test.py --proxy=USERNAME:PASSWORD@IP_ADDRESS:PORT
 
 pytest user_agent_test.py --agent="USER-AGENT STRING"
 
-pytest test_fail.py --pdb -s
+pytest my_first_test.py --settings_file=custom_settings.py
 ```
 
 You can interchange **pytest** with **nosetests**, but using pytest is strongly recommended because developers stopped supporting nosetests. Chrome is the default browser if not specified.
 
 (NOTE: If you're using **pytest** for running tests outside of the SeleniumBase repo, **you'll want a copy of [pytest.ini](https://github.com/seleniumbase/SeleniumBase/blob/master/pytest.ini) at the base of the new folder structure**. If using **nosetests**, the same applies for [setup.cfg](https://github.com/seleniumbase/SeleniumBase/blob/master/setup.cfg).)
 
+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.)
+
 #### **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):**
 
 Here's how to connect to a BrowserStack Selenium Grid server for running tests:
@@ -156,16 +163,51 @@ nosetests test_suite.py --report
 
 (NOTE: You can add ``--show_report`` to immediately display Nosetest reports after the test suite completes. Only use ``--show_report`` when running tests locally because it pauses the test run.)
 
-Here are some other useful arguments:
+Here are some other useful command-line options that come with Pytest:
 ```bash
--v  # Prints the full test name rather than a dot for each test.
+-v  # Prints the full test name for each test.
+-q  # Prints fewer details in the console output when running tests.
 -x  # Stop running the tests after the first failure is reached.
-```
-
-Here's a **nosetests**-specific argument:
-```bash
---logging-level=INFO  # Hide DEBUG messages, which can be overwhelming.
-```
+--html=report.html  # Creates a detailed test report after tests complete. (Using the pytest-html plugin)
+--collect-only  # Show what tests would get run without actually running them.
+-s  # See print statements. (Should be on by default with pytest.ini present.)
+-n=NUM  # Multithread the tests using that many threads. (Speed up test runs!)
+```
+
+SeleniumBase provides additional Pytest command-line options for tests:
+```bash
+--browser=BROWSER  # (The web browser to use.)
+--cap_file=FILE  # (The web browser's desired capabilities to use.)
+--settings_file=FILE  # (Overrides SeleniumBase settings.py values.)
+--env=ENV  # (Set a test environment. Use "self.env" to use this in tests.)
+--data=DATA  # (Extra data to pass to tests. Use "self.data" in tests.)
+--user_data_dir=DIR  # (Set the Chrome user data directory to use.)
+--server=SERVER  # (The server / IP address used by the tests.)
+--port=PORT  # (The port that's used by the test server.)
+--proxy=SERVER:PORT  # (This is the proxy server:port combo used by tests.)
+--agent=STRING  # (This designates the web browser's User Agent to use.)
+--extension_zip=ZIP  # (Load a Chrome Extension .zip file, comma-separated.)
+--extension_dir=DIR  # (Load a Chrome Extension directory, comma-separated.)
+--headless  # (The option to run tests headlessly. The default on Linux OS.)
+--headed  # (The option to run tests with a GUI on Linux OS.)
+--start_page=URL  # (The starting URL for the web browser when tests begin.)
+--log_path=LOG_PATH  # (The directory where log files get saved to.)
+--archive_logs  # (Archive old log files instead of deleting them.)
+--demo_mode  # (The option to visually see test actions as they occur.)
+--demo_sleep=SECONDS  # (The option to wait longer after Demo Mode actions.)
+--highlights=NUM  # (Number of highlight animations for Demo Mode actions.)
+--message_duration=SECONDS  # (The time length for Messenger alerts.)
+--check_js  # (The option to check for JavaScript errors after page loads.)
+--ad_block  # (The option to block some display ads after page loads.)
+--verify_delay=SECONDS  # (The delay before MasterQA verification checks.)
+--disable_csp  # (This disables the Content Security Policy of websites.)
+--enable_sync  # (The option to enable "Chrome Sync".)
+--maximize_window  # (The option to start with the web browser maximized.)
+--save_screenshot  # (The option to save a screenshot after each test.)
+--visual_baseline  # (Set the visual baseline for Visual/Layout tests.)
+--timeout_multiplier=MULTIPLIER  # (Multiplies the default timeout values.)
+```
+(For more details, see the full list of command-line options **[here](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/pytest_plugin.py)**.)
 
 #### **Using a Proxy Server:**
 

help_docs/customizing_test_runs.md

@@ -209,6 +209,8 @@ self.assert_equal(first, second, msg=None)
 
 self.assert_not_equal(first, second, msg=None)
 
+self.assert_title(title)
+
 self.assert_no_js_errors()
 
 self.get_google_auth_password(totp_key=None)

help_docs/method_summary.md

@@ -5,22 +5,40 @@
 
 (NOTE: If you're using this test framework from a local development machine and don't plan on writing to a MySQL DB from your local test runs, you can skip this step.)
 
-##### macOS:
+##### Linux (Ubuntu):
 ```bash
-brew install MySQL
+sudo apt update
+sudo apt install mysql-server
+sudo mysql_secure_installation
+sudo mysql -e 'CREATE DATABASE IF NOT EXISTS test_db;'
+sudo mysql -h 127.0.0.1 -u root test_db < seleniumbase/core/create_db_tables.sql
+sudo service mysql restart
 ```
 
-##### Windows:
-[Download MySQL here](http://dev.mysql.com/downloads/windows/)
-
-That installs the MySQL library so that you can use database commands in your code. To make that useful, you'll want to have a MySQL DB that you can connect to.
+To change the password:
+```bash
+mysqladmin -u root -p'OLD_PASSWORD' password NEW_PASSWORD
+sudo service mysql restart
+```
 
-#### Install the MySQL-Python connector
+##### MacOS:
+```bash
+brew install mysql
+```
 
+Then you'll need to start the MySQL service:
 ```bash
-pip install MySQL-python==1.2.5
+brew services start mysql
 ```
 
+Continue with additional steps below to setup your DB.
+
+##### Windows:
+[Download MySQL here](http://dev.mysql.com/downloads/windows/)
+Follow the steps from the MySQL Downloads page.
+
+Continue with additional steps below to setup your DB.
+
 #### Access your MySQL DB
 
 If you want a visual tool to help make your MySQL life easier, [try MySQL Workbench](http://dev.mysql.com/downloads/workbench/).
@@ -40,15 +58,3 @@ Example:
 ```bash
 pytest my_first_test.py --with-db_reporting
 ```
-
-#### Windows mysql-python troubleshooting:
-
-If you're having trouble with Windows mysql-python installation using pip, you can also try the following steps to install from an alternative source:
-
-* Download the unofficial ``.whl`` format of MySQL-Python and Mysqlclient from [here](http://www.lfd.uci.edu/~gohlke/pythonlibs/#mysql-python).
-
-* Open a console and then cd to where you've downloaded the MySQL-Python .whl file.
-
-* Run the command ``pip install FILENAME.whl``
-
-* If pip.exe is not recognized, you may find it in the "Scripts" directory from where python has been installed.

help_docs/mysql_installation.md

@@ -6,6 +6,7 @@ class MyTestClass(BaseCase):
     def test_basic(self):
         self.open("https://xkcd.com/353/")
         self.assert_element('img[alt="Python"]')
+        self.assert_title("xkcd: Python")
         self.click('a[rel="license"]')
         self.assert_text("free to copy and reuse")
         self.go_back()

integrations/node_js/my_first_test.py

@@ -24,6 +24,7 @@ parameterized>=0.7.0
 beautifulsoup4>=4.6.0
 pyopenssl>=19.0.0
 colorama>=0.4.1
+pymysql>=0.9.3
 pyotp>=2.3.0
 boto>=2.49.0
 flake8>=3.7.8

requirements.txt

@@ -91,7 +91,7 @@ def main():
             print('\nLocating the latest version of Chromedriver...')
             latest_version = requests.get(last).text
             if not requests.get(download_url).ok:
-                fallback_version = "2.40"
+                fallback_version = "2.44"
                 download_url = ("http://chromedriver.storage.googleapis.com/"
                                 "%s/%s" % (fallback_version, file_name))
             else:

seleniumbase/console_scripts/sb_install.py

@@ -81,6 +81,7 @@ def main():
         data.append("    def test_basic(self):")
         data.append('        self.open("https://xkcd.com/353/")')
         data.append("        self.assert_element('img[alt=\"Python\"]')")
+        data.append('        self.assert_title("xkcd: Python")')
         data.append("        self.click('a[rel=\"license\"]')")
         data.append('        self.assert_text("free to copy and reuse")')
         data.append('        self.go_back()')