Skip to content

Commit 5b0f981

Browse files
committed
Update ReadMe files
1 parent c723915 commit 5b0f981

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
(<i>Demo of [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) testing [xkcd.com](http://xkcd.com/353/)</i>)
1010

1111
### ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") **Features**:
12-
* [Python libraries](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures) to help you build reliable [WebDriver scripts](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py). (<i>Python 2.7 or 3.3+</i>)
12+
* [Python libraries](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures) to help you build reliable [WebDriver scripts](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py). (<i>Python 2.7 or 3.4+</i>)
1313
* [Command-line options](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/command_line.md) and a global [config file](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py) to customize runs.
1414
* [Plugins](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/plugins) for logging [data & screenshots](https://github.com/seleniumbase/SeleniumBase/tree/master/examples/example_logs).
1515
* Works with [Selenium Grid](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/selenium_grid), [MySQL](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/core/testcase_manager.py), [Docker](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/docker/ReadMe.md), [NodeJS](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js), [Google Cloud](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/google_cloud/ReadMe.md), and [AWS](#amazon_section).
@@ -95,25 +95,25 @@ class MyTestClass(BaseCase):
9595
```bash
9696
cd examples/
9797

98-
pytest my_first_test.py --with-selenium --browser=chrome
98+
pytest my_first_test.py --browser=chrome
9999

100-
nosetests my_first_test.py --with-selenium --browser=firefox
100+
nosetests my_first_test.py --browser=firefox
101101

102-
nosetests my_first_test.py --with-selenium --browser=phantomjs
102+
nosetests my_first_test.py --browser=phantomjs
103103
```
104104
(<i>If no browser is specified, Chrome is used by default.</i>)
105105

106106
<a id="seleniumbase_demo_mode"></a>
107107
If the example test is moving too fast for your eyes to see what's going on, you can run it in **Demo Mode** by adding ``--demo_mode`` on the command line, which pauses the browser briefly between actions, and highlights page elements being acted on:
108108

109109
```bash
110-
pytest my_first_test.py --with-selenium --browser=chrome --demo_mode
110+
pytest my_first_test.py --browser=chrome --demo_mode
111111
```
112112

113113
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.)
114114

115115
```bash
116-
nosetests my_first_test.py --with-selenium --browser=chrome --demo_mode --demo_sleep=1.2
116+
nosetests my_first_test.py --browser=chrome --demo_mode --demo_sleep=1.2
117117
```
118118

119119
You can also use the following in your scripts to slow down the tests:
@@ -130,7 +130,7 @@ You may also want to have your test sleep in other situations where you need to
130130
If you need to debug things on the fly (in case of errors), use this:
131131

132132
```bash
133-
nosetests my_first_test.py --browser=chrome --with-selenium --pdb --pdb-failures -s
133+
nosetests my_first_test.py --browser=chrome --pdb --pdb-failures -s
134134
```
135135

136136
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.
@@ -179,7 +179,7 @@ pytest my_test_suite.py --html=report.html
179179
The ``--report`` option gives you a fancy report after your test suite completes. (Requires ``--with-testing_base`` to also be set when ``--report`` is used because it's part of that plugin.)
180180

181181
```bash
182-
nosetests my_test_suite.py --with-selenium --with-testing_base --report
182+
nosetests my_test_suite.py --with-testing_base --report
183183
```
184184
![](https://cdn2.hubspot.net/hubfs/100006/images/Test_Report_2.png "Example Nosetest Report")
185185

@@ -208,7 +208,7 @@ Here are some things you can do to setup a production environment for your testi
208208

209209
Here's an example of running tests with additional features enabled:
210210
```bash
211-
nosetests [YOUR_TEST_FILE].py --browser=chrome --with-selenium --with-testing_base --with-db_reporting --with-s3_logging -s
211+
nosetests [YOUR_TEST_FILE].py --browser=chrome --with-testing_base --with-db_reporting --with-s3_logging -s
212212
```
213213
(NOTE: If you haven't configured your MySQL or S3 connections in [settings.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py), don't use ``--with-db_reporting`` or ``--with-s3_logging``.)
214214

@@ -242,7 +242,7 @@ class MyTestClass(BaseCase):
242242
Now run it:
243243

244244
```bash
245-
nosetests test_fail.py --browser=chrome --with-selenium --with-testing_base
245+
nosetests test_fail.py --browser=chrome --with-testing_base
246246
```
247247

248248
You'll notice that a logs folder, "latest_logs", was created to hold information about the failing test, and screenshots. Take a look at what you get. Remember, this data can be saved in your MySQL DB and in S3 if you include the necessary plugins in your run command (and if you set up the neccessary connections properly). For future test runs, past test results will get stored in the archived_logs folder if you have ARCHIVE_EXISTING_LOGS set to True in [settings.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py).

examples/ReadMe.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ python gui_test_runner.py
1212

1313
(NOTE: You can interchange ``nosetests`` with ``pytest`` in most of these examples.)
1414

15-
![](http://cdn2.hubspot.net/hubfs/100006/images/GUI_Test_Runner_5.png "GUI Test Runner")
15+
![](https://cdn2.hubspot.net/hubfs/100006/images/GUI_Test_Runner_7.png "GUI Test Runner")
1616

1717
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).
1818

@@ -40,17 +40,17 @@ pytest my_first_test.py --browser=chrome --demo_mode
4040

4141
Run the example test suite in Chrome and generate an html report: (nosetests-only)
4242
```bash
43-
nosetests my_test_suite.py --with-selenium --browser=chrome --with-testing_base --report
43+
nosetests my_test_suite.py --browser=chrome --with-testing_base --report
4444
```
4545

4646
Run the example test suite in Firefox and generate an html report: (nosetests-only)
4747
```bash
48-
nosetests my_test_suite.py --with-selenium --browser=firefox --with-testing_base --report
48+
nosetests my_test_suite.py --browser=firefox --with-testing_base --report
4949
```
5050

5151
Run the example test suite in PhantomJS and generate an html report: (nosetests-only)
5252
```bash
53-
nosetests my_test_suite.py --with-selenium --browser=phantomjs --with-testing_base --report
53+
nosetests my_test_suite.py --browser=phantomjs --with-testing_base --report
5454
```
5555

5656
Run a test with configuration specifed by a config file:
@@ -65,12 +65,12 @@ nosetests rate_limiting_test.py
6565

6666
Run a failing test with pdb mode enabled: (If a test failure occurs, test enters pdb mode)
6767
```bash
68-
nosetests test_fail.py --browser=chrome --with-selenium --pdb --pdb-failures
68+
nosetests test_fail.py --browser=chrome --pdb --pdb-failures
6969
```
7070

7171
Run a failing test with logging:
7272
```bash
73-
pytest test_fail.py --browser=chrome --with-testing_base --with-basic_test_info --with-page_source --with-screen_shots
73+
pytest test_fail.py --browser=chrome --with-testing_base
7474
```
7575

7676
(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.)

0 commit comments

Comments
 (0)