Merge pull request #180 from seleniumbase/driver-script-updates

Console script updates and driver updates

Author: mdmintz

.gitignore

@@ -1,3 +1,4 @@
+# Compiled Python Bytecode
 *.py[cod]
 
 # Packages
@@ -35,23 +36,34 @@ nosetests.xml
 .project
 .pydevproject
 
-# Other
-selenium-server-standalone.jar
-verbose_hub_server.dat
-verbose_node_server.dat
-ip_of_grid_hub.dat
-geckodriver.log
-downloaded_files
-archived_files
+# Web Drivers
+chromedriver
+geckodriver
+MicrosoftWebDriver.exe
+chromedriver.exe
+geckodriver.exe
+
+# Logs
 logs
 latest_logs
 log_archives
 archived_logs
+geckodriver.log
+
+# Reports
 latest_report
 report_archives
 archived_reports
 html_report.html
 report.html
+
+# Other
+selenium-server-standalone.jar
+verbose_hub_server.dat
+verbose_node_server.dat
+ip_of_grid_hub.dat
+downloaded_files
+archived_files
 assets
 temp
 temp*

.travis.yml

@@ -20,9 +20,11 @@ install:
   - "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.37/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.20.0/geckodriver-v0.20.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.41/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://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 install chromedriver"
+  - "seleniumbase install geckodriver"
 script:
   - "pytest examples/my_first_test.py --browser=chrome -s --headless --with-db_reporting"
   - "nosetests examples/boilerplates/boilerplate_test.py --browser=chrome --headless"

README.md

@@ -63,7 +63,7 @@ SeleniumBase was originally built for [testing HubSpot's platform](https://produ
 
 ## Get Started:
 
-Before installation, **[install Python](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/install_python_pip_git.md)** and **[get a WebDriver](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/webdriver_installation.md)** on your system PATH.
+Before installation, **[install Python](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/install_python_pip_git.md)** and **[install a web driver](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/webdriver_installation.md)**.
 
 
 ### ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") **Step 1:** Clone SeleniumBase
@@ -151,32 +151,23 @@ If the example test is moving too fast for your eyes to see what's going on, you
 pytest my_first_test.py --demo_mode
 ```
 
-You can override the default wait time by either updating [settings.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py) or by using ``--demo_sleep={NUM}`` when using Demo Mode. (NOTE: If you use ``--demo_sleep={NUM}`` without using ``--demo_mode``, nothing will happen.)
-
-```bash
-pytest my_first_test.py --demo_mode --demo_sleep=1.2
-```
-
-You can also use the following in your scripts to slow down the tests:
+You can use the following in your scripts to help you debug issues::
 
 ```python
 import time; time.sleep(5)  # sleep for 5 seconds (add this after the line you want to pause on)
 import ipdb; ipdb.set_trace()  # waits for your command. n = next line of current method, c = continue, s = step / next executed line (will jump)
+import pytest; pytest.set_trace()  # similar to ipdb, but specific to pytest
 ```
 
-(NOTE: If you're using pytest instead of nosetests and you want to use ipdb in your script for debugging purposes, you'll need to add ``--capture=no`` (or ``-s``) on the command line, or use ``import pytest; pytest.set_trace()`` instead of using ipdb. More info on that [here](http://stackoverflow.com/questions/2678792/can-i-debug-with-python-debugger-when-using-py-test-somehow).)
-
-You may also want to have your test sleep in other situations where you need to have your test wait for something. If you know what you're waiting for, you should be specific by using a command that waits for something specific to happen.
-
-If you need to debug things on the fly (in case of errors), use this:
+**To pause an active test that throws an exception or error, add ``--pdb --pdb-failures -s``:**
 
 ```bash
 pytest my_first_test.py --browser=chrome --pdb --pdb-failures -s
 ```
 
-The above code (with --pdb) will leave your browser window open in case there's a failure, which is possible if the web pages from the example change the data that's displayed on the page. (ipdb commands: 'c', 's', 'n' => continue, step, next). You may need the ``-s`` in order to see all console output.
+The code above will leave your browser window open in case there's a failure. (ipdb commands: 'c', 's', 'n' => continue, step, next).
 
-Here are some other useful nosetest arguments for appending to your run commands:
+Here are some other useful **nosetest**-specific arguments:
 
 ```bash
 --logging-level=INFO  # Hide DEBUG messages, which can be overwhelming.
@@ -185,7 +176,7 @@ Here are some other useful nosetest arguments for appending to your run commands
 --with-id  # If -v is also used, will number the tests for easy counting.
 ```
 
-During test failures you'll get detailed log files, which include screenshots, page source, and basic test info, which will get added to the logs folder at ``latest_logs/``. (Unless you have ARCHIVE_EXISTING_LOGS set to True in [settings.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py), log files with be cleaned up at the start of the next test run. If the archive feature is enabled, those logs will get saved to the ``archived_logs/`` folder.) The ``my_test_suite.py`` collection contains tests that fail on purpose so that you can see how logging works.
+During test failures, logs and screenshots from the most recent test run will get saved to the ``latest_logs/`` folder. Those logs will get moved to ``archived_logs/`` if you have ARCHIVE_EXISTING_LOGS set to True in [settings.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py), otherwise log files with be cleaned up at the start of the next test run. The ``my_test_suite.py`` collection contains tests that fail on purpose so that you can see how logging works.
 
 ```bash
 cd examples/
@@ -210,7 +201,7 @@ To run Pytest multithreaded on multiple CPUs at the same time, add ``-n=NUM`` or
 <a id="creating_visual_reports"></a>
 ### ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") **Creating Visual Test Suite Reports:**
 
-(NOTE: The command line args are different for Pytest vs Nosetests)
+(NOTE: Several command line args are different for Pytest vs Nosetests)
 
 #### **Pytest Reports:**
 

console_scripts/ReadMe.md

@@ -1,10 +1,32 @@
 ## Console Scripts
 
+SeleniumBase console scripts help you get things done more easily, such as installing web drivers, creating a test directory with necessary configuration files, converting old Webdriver unittest scripts into SeleniumBase code, and using the Selenium Grid.
+
+For running tests from the command line, [use **pytest** with SeleniumBase](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md).
+
+### install
+
+* Usage:
+``seleniumbase install [DRIVER_NAME]``
+        (Drivers: chromedriver, geckodriver, edgedriver)
+
+* Example:
+``seleniumbase install chromedriver``
+
+* Output:
+Installs the specified webdriver.
+(chromedriver is required for Google Chrome automation)
+(geckodriver is required for Mozilla Firefox automation)
+(edgedriver is required for Microsoft Edge automation)
+
 ### mkdir
 
 * Usage:
 ``seleniumbase mkdir [DIRECTORY_NAME]``
 
+* Example:
+``seleniumbase mkdir gui_tests``
+
 * Output:
 Creates a new folder for running SeleniumBase scripts.
 The new folder contains default config files,
@@ -15,7 +37,7 @@ test frameworks.
 ### convert
 
 * Usage:
-``seleniumbase convert [MY_TEST.py]``
+``seleniumbase convert [PYTHON_WEBDRIVER_UNITTEST_FILE]``
 
 * Output:
 Converts a Selenium IDE exported WebDriver unittest

console_scripts/run.py

@@ -5,14 +5,16 @@
 seleniumbase [COMMAND] [PARAMETERS]
 
 Examples:
-seleniumbase mkdir [DIRECTORY_NAME]
-seleniumbase convert [PYTHON_WEBDRIVER_UNITTEST_FILE]
+seleniumbase install chromedriver
+seleniumbase mkdir gui_tests
+seleniumbase convert my_old_webdriver_unittest.py
 seleniumbase grid-hub start
 seleniumbase grid-node start --hub=127.0.0.1
 """
 
 import sys
 from console_scripts import sb_mkdir
+from console_scripts import sb_install
 from integrations.selenium_grid import grid_hub
 from integrations.selenium_grid import grid_node
 from integrations.selenium_ide import convert_ide
@@ -32,18 +34,37 @@ def show_basic_usage():
     print("")
     print("Commands:")
     print("")
+    print("    install [DRIVER_NAME]")
     print("    mkdir [NEW_TEST_DIRECTORY_NAME]")
     print("    convert [PYTHON_WEBDRIVER_UNITTEST_FILE]")
     print("    grid-hub {start|stop|restart} [OPTIONS]")
     print("    grid-node {start|stop|restart} --hub=[HUB_IP] [OPTIONS]")
     print("")
 
 
+def show_install_usage():
+    print("  ** install **")
+    print("")
+    print("  Usage:")
+    print("            seleniumbase install [DRIVER_NAME]")
+    print("                  (Drivers: chromedriver, geckodriver, edgedriver)")
+    print("  Example:")
+    print("            seleniumbase install chromedriver")
+    print("  Output:")
+    print("            Installs the specified webdriver.")
+    print("            (chromedriver is required for Chrome automation)")
+    print("            (geckodriver is required for Firefox automation)")
+    print("            (edgedriver is required for MS Edge automation)")
+    print("")
+
+
 def show_mkdir_usage():
     print("  ** mkdir **")
     print("")
     print("  Usage:")
     print("            seleniumbase mkdir [DIRECTORY_NAME]")
+    print("  Example:")
+    print("            seleniumbase mkdir gui_tests")
     print("  Output:")
     print("            Creates a new folder for running SeleniumBase scripts.")
     print("            The new folder contains default config files,")
@@ -105,6 +126,7 @@ def show_detailed_help():
     show_basic_usage()
     print("More Info:")
     print("")
+    show_install_usage()
     show_mkdir_usage()
     show_convert_usage()
     show_grid_hub_usage()
@@ -123,14 +145,20 @@ def main():
         command = sys.argv[1]
         command_args = sys.argv[2:]
 
-    if command == "convert":
+    if command == "install":
+        if len(command_args) >= 1:
+            sb_install.main()
+        else:
+            show_basic_usage()
+            show_install_usage()
+    elif command == "convert":
         if len(command_args) == 1:
             convert_ide.main()
         else:
             show_basic_usage()
             show_convert_usage()
     elif command == "mkdir":
-        if len(command_args) == 1:
+        if len(command_args) >= 1:
             sb_mkdir.main()
         else:
             show_basic_usage()
@@ -149,7 +177,11 @@ def main():
             show_grid_node_usage()
     elif command == "help" or command == "--help":
         if len(command_args) >= 1:
-            if command_args[0] == "mkdir":
+            if command_args[0] == "install":
+                print("")
+                show_install_usage()
+                return
+            elif command_args[0] == "mkdir":
                 print("")
                 show_mkdir_usage()
                 return