From 5a34001e2631d634289018a7c0b843bf26ebc17b Mon Sep 17 00:00:00 2001 From: Michael Mintz Date: Mon, 13 Mar 2017 22:23:36 -0400 Subject: [PATCH] Update the examples ReadMe --- examples/ReadMe.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/examples/ReadMe.md b/examples/ReadMe.md index bdf0f4a5..09a6d5f3 100755 --- a/examples/ReadMe.md +++ b/examples/ReadMe.md @@ -10,31 +10,31 @@ python gui_test_runner.py (NOTE: With the exception of [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py), which should pass, many other tests in this folder fail on purpose to demonstrate features such as screenshots on failure, exception logging, and test reports.) -![](http://cdn2.hubspot.net/hubfs/100006/images/GUI_Test_Runner_3.png "GUI Test Runner") +![](http://cdn2.hubspot.net/hubfs/100006/images/GUI_Test_Runner_4.png "GUI Test Runner") If you run scripts with logging enabled, (using ``--with-testing_base``), you’ll see two folders appear: “latest_logs” and “archived_logs”. The “latest_logs” folder will contain log files from the most recent test run, but logs will only be created if the test run is failing. Afterwards, logs from the “latest_logs” folder will get pushed to the “archived_logs” folder if you have have the ``ARCHIVE_EXISTING_LOGS`` feature enabled in [settings.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py). Make sure to run ``python setup.py install`` for your changes to take effect if you make any changes to that file. **For running scripts the usual way, here are some of the example run commands:** (Note: You can replace ``nosetests`` with ``py.test`` for most of these.) -Run the example test in Firefox: -```bash -nosetests my_first_test.py --with-selenium --browser=firefox -``` - Run the example test in Chrome: ```bash nosetests my_first_test.py --with-selenium --browser=chrome ``` +Run the example test in Firefox: +```bash +nosetests my_first_test.py --with-selenium --browser=firefox +``` + Run the example test in PhantomJS: ```bash nosetests my_first_test.py --with-selenium --browser=phantomjs ``` -Run the example test suite in Firefox and generate an html report: (nosetests-only) +Run the example test in Demo Mode (runs slower and adds highlights): ```bash -nosetests my_test_suite.py --with-selenium --browser=firefox --with-testing_base --report +nosetests my_first_test.py --browser=chrome --with-selenium --demo_mode ``` Run the example test suite in Chrome and generate an html report: (nosetests-only) @@ -42,34 +42,34 @@ Run the example test suite in Chrome and generate an html report: (nosetests-onl nosetests my_test_suite.py --with-selenium --browser=chrome --with-testing_base --report ``` +Run the example test suite in Firefox and generate an html report: (nosetests-only) +```bash +nosetests my_test_suite.py --with-selenium --browser=firefox --with-testing_base --report +``` + Run the example test suite in PhantomJS and generate an html report: (nosetests-only) ```bash nosetests my_test_suite.py --with-selenium --browser=phantomjs --with-testing_base --report ``` -Run a test with all the configuration specifed by a config file: +Run a test with configuration specifed by a config file: ```bash nosetests my_first_test.py --config=example_config.cfg ``` -Example test with the use of python decorators: +Run a test demonstrating the use of Python decorators available: ```bash nosetests rate_limiting_test.py ``` -Run the example test slowly: -```bash -nosetests my_first_test.py --browser=firefox --with-selenium --demo_mode -``` - Run a failing test with pdb mode enabled: (If a test failure occurs, test enters pdb mode) ```bash -nosetests test_fail.py --browser=firefox --with-selenium --pdb --pdb-failures +nosetests test_fail.py --browser=chrome --with-selenium --pdb --pdb-failures ``` Run a failing test with logging: ```bash -nosetests test_fail.py --browser=firefox --with-selenium --with-testing_base --with-basic_test_info --with-page_source --with-screen_shots +nosetests test_fail.py --browser=chrome --with-selenium --with-testing_base --with-basic_test_info --with-page_source --with-screen_shots ``` (NOTE: If you see any ``*.pyc`` files appear as you run tests, that's perfectly normal. Compiled bytecode is a natural result of running Python code.)