From 53f4240aacdb2e56415f8c5ef9f6ce6d6452f6ce Mon Sep 17 00:00:00 2001 From: Michael Mintz Date: Tue, 18 Feb 2020 02:10:36 -0500 Subject: [PATCH] Update comments and ReadMe files --- README.md | 2 +- examples/visual_testing/ReadMe.md | 2 +- help_docs/customizing_test_runs.md | 2 +- help_docs/features_list.md | 4 ++++ help_docs/mysql_installation.md | 2 +- seleniumbase/fixtures/base_case.py | 2 +- seleniumbase/plugins/pytest_plugin.py | 4 +++- seleniumbase/plugins/selenium_plugin.py | 6 ++++-- 8 files changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a8afe03a..16469352 100755 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ pytest test_swag_labs.py --demo ## Quick Start * Requires **[Python](https://www.python.org/downloads/)** and **[Git](https://git-scm.com/)** -* [Python versions](https://www.python.org/downloads/) +* [Python:2.7|3.5|3.6|3.7|3.8](https://www.python.org/downloads/) * A [Python virtual env](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/) is recommended. [See shortcut](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md). * Upgrade **[pip](https://pypi.org/project/pip/)** to prevent warnings: ```bash diff --git a/examples/visual_testing/ReadMe.md b/examples/visual_testing/ReadMe.md index 32c6537f..56fe1a44 100755 --- a/examples/visual_testing/ReadMe.md +++ b/examples/visual_testing/ReadMe.md @@ -1,7 +1,7 @@ [](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) ### Automated Visual Regression Testing -[![TensorPy Tutorial](http://img.youtube.com/vi/erwkoiDeNzA/3.jpg)](https://www.youtube.com/watch?v=erwkoiDeNzA "Automated Visual Regression Testing") +[![Automated Visual Regression Testing](http://img.youtube.com/vi/erwkoiDeNzA/3.jpg)](https://www.youtube.com/watch?v=erwkoiDeNzA "Automated Visual Regression Testing") (**[Watch the tutorial on YouTube](https://www.youtube.com/watch?v=erwkoiDeNzA)**) diff --git a/help_docs/customizing_test_runs.md b/help_docs/customizing_test_runs.md index fa5c4ace..5ea5dc86 100755 --- a/help_docs/customizing_test_runs.md +++ b/help_docs/customizing_test_runs.md @@ -35,7 +35,7 @@ pytest test_suite.py --reruns=1 pytest my_first_test.py --data="ABC,DEF" # Run tests on a local Selenium Grid -pytest test_suite.py --server=127.0.0.1 +pytest test_suite.py --server="127.0.0.1" # Run tests on a remote Selenium Grid pytest test_suite.py --server=IP_ADDRESS --port=4444 diff --git a/help_docs/features_list.md b/help_docs/features_list.md index 7d2f4dda..ca660eb9 100755 --- a/help_docs/features_list.md +++ b/help_docs/features_list.md @@ -1,5 +1,9 @@ [](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) +[](https://www.youtube.com/watch?v=Sjzq9kU5kOw) + +(**[Watch an overview on YouTube](https://www.youtube.com/watch?v=Sjzq9kU5kOw)**) + ## **Features:** * A complete test automation framework for building & running reliable testing scripts. diff --git a/help_docs/mysql_installation.md b/help_docs/mysql_installation.md index 871a77ee..b50cebf0 100755 --- a/help_docs/mysql_installation.md +++ b/help_docs/mysql_installation.md @@ -45,7 +45,7 @@ If you want a visual tool to help make your MySQL life easier, [try MySQL Workbe #### Prepare your MySQL DB -You can use the [testcaserepository.sql](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/core/testcaserepository.sql) file to create the necessary tables for storing test data. +You can use the [create_db_tables.sql](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/core/create_db_tables.sql) file to create the necessary tables for storing test data. #### Configure your MySQL DB for SeleniumBase diff --git a/seleniumbase/fixtures/base_case.py b/seleniumbase/fixtures/base_case.py index d8a1450f..0b4ed630 100755 --- a/seleniumbase/fixtures/base_case.py +++ b/seleniumbase/fixtures/base_case.py @@ -4279,7 +4279,7 @@ class BaseCase(unittest.TestCase): self.report_on = True self.use_grid = False if self.servername != "localhost": - # Use Selenium Grid (Use --server=127.0.0.1 for localhost Grid) + # Use Selenium Grid (Use --server="127.0.0.1" for a local Grid) self.use_grid = True if self.with_db_reporting: from seleniumbase.core.application_manager import ( diff --git a/seleniumbase/plugins/pytest_plugin.py b/seleniumbase/plugins/pytest_plugin.py index a0aac541..4fc53023 100644 --- a/seleniumbase/plugins/pytest_plugin.py +++ b/seleniumbase/plugins/pytest_plugin.py @@ -166,7 +166,9 @@ def pytest_addoption(parser): dest='servername', default='localhost', help="""Designates the Selenium Grid server to use. - Default: localhost.""") + Use "127.0.0.1" to connect to a localhost Grid. + If unset or set to "localhost", Grid isn't used. + Default: "localhost".""") parser.addoption('--port', action='store', dest='port', diff --git a/seleniumbase/plugins/selenium_plugin.py b/seleniumbase/plugins/selenium_plugin.py index a844340a..7b546cc3 100755 --- a/seleniumbase/plugins/selenium_plugin.py +++ b/seleniumbase/plugins/selenium_plugin.py @@ -82,7 +82,9 @@ class SeleniumBrowser(Plugin): dest='servername', default='localhost', help="""Designates the Selenium Grid server to use. - Default: localhost.""") + Use "127.0.0.1" to connect to a localhost Grid. + If unset or set to "localhost", Grid isn't used. + Default: "localhost".""") parser.add_option( '--port', action='store', @@ -327,7 +329,7 @@ class SeleniumBrowser(Plugin): test.test.use_grid = False test.test._reuse_session = False if test.test.servername != "localhost": - # Use Selenium Grid (Use --server=127.0.0.1 for localhost Grid) + # Use Selenium Grid (Use --server="127.0.0.1" for localhost Grid) test.test.use_grid = True if "linux" in sys.platform and ( not self.options.headed and not self.options.headless):