Skip to content

Commit fc46f88

Browse files
committed
Update ReadMe files
1 parent f54fa21 commit fc46f88

File tree

3 files changed

+18
-18
lines changed

3 files changed

+18
-18
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,6 @@ pytest my_first_test.py --with-selenium --browser=chrome --demo_mode
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

115-
If you ever make any changes to your local copy of ``settings.py``, you may need to run ``python setup.py develop`` for those changes to take effect.
116-
117115
```bash
118116
nosetests my_first_test.py --with-selenium --browser=chrome --demo_mode --demo_sleep=1.2
119117
```
@@ -158,6 +156,8 @@ pytest my_first_test.py --with-testing_base --browser=chrome
158156

159157
(NOTE: If you're using **pytest** instead of nosetests for running tests outside of the SeleniumBase repo, **you'll need a copy of [pytest.ini](https://github.com/seleniumbase/SeleniumBase/blob/master/pytest.ini) at the base of the new folder structure, already provided here.**
160158

159+
If you want to pass additional data from the command line to your tests, you can use ``--data=STRING``. Now inside your tests, you can use ``self.data`` to access that.
160+
161161

162162
<a id="creating_visual_reports"></a>
163163
### ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") **Creating Visual Test Suite Reports:**
@@ -349,10 +349,10 @@ self.click('a[name*="partial_name"]')
349349
#### Asserting visibility of text inside an element on a page within some number of seconds:
350350

351351
```python
352-
self.wait_for_text_visible("Make it so!", "div#trek div.picard div.quotes", timeout=3)
353-
self.wait_for_text_visible("Tea. Earl Grey. Hot.", "div#trek div.picard div.quotes", timeout=1)
352+
self.assert_text("Make it so!", "div#trek div.picard div.quotes")
353+
self.assert_text("Tea. Earl Grey. Hot.", "div#trek div.picard div.quotes", timeout=3)
354354
```
355-
(NOTE: The short versions of this are ``self.find_text(TEXT, ELEMENT)`` and ``self.assert_text(TEXT, ELEMENT)``)
355+
(NOTE: ``self.find_text(TEXT, ELEMENT)`` and ``self.wait_for_text(TEXT, ELEMENT)`` also do this. For backwords compatibility, older method names were kept, but the default timeout may be different.)
356356

357357
#### Asserting Anything
358358

examples/ReadMe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Running SeleniumBase Scripts
22

3-
(NOTE: If you didn't install SeleniumBase properly, these scripts won't work. Installation steps include "``pip install seleniumbase``" and/or "``python setup.py install``" from the top-level directory.)
3+
(NOTE: If you didn't install SeleniumBase properly, these scripts won't work. Installation steps include "``pip install seleniumbase``" and/or "``python setup.py develop``" from the top-level directory.)
44

55
To makes things easier, here's a simple GUI program that allows you to kick off a few example scripts by pressing a button:
66

@@ -14,7 +14,7 @@ python gui_test_runner.py
1414

1515
![](http://cdn2.hubspot.net/hubfs/100006/images/GUI_Test_Runner_5.png "GUI Test Runner")
1616

17-
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.
17+
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

1919
**For running scripts the usual way, here are some of the example run commands:**
2020

integrations/google_cloud/ReadMe.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ sudo pip install -r server_requirements.txt --upgrade
7676
#### Step 12. Install SeleniumBase (Make sure you already installed the requirements above)
7777

7878
```bash
79-
sudo python server_setup.py install
79+
sudo python server_setup.py develop
8080
```
8181

8282
#### Step 13. Run an [example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) in Chrome to verify installation (Takes ~10 seconds)
@@ -146,31 +146,31 @@ If you have a web application that you want to test, you'll be able to create Se
146146
* Give the instance a zone
147147
* Click "Create"
148148

149-
#### Step 22. Get the Connection credentials for your new MySQL DB
149+
#### Step 22. Get the Connection credentials for your new MySQL Instance
150150

151151
* Under the Google Cloud Platform menu, go to "Compute Engine"
152152
* Find your new MySQL instance and then write down the value written in the "External IP" section.
153153
* Under the Google Cloud Platform menu, go to "Deployment Manager"
154154
* Find your new MySQL instance and then click on it.
155155
* Write down the values for Admin username and password. (Username should be "root")
156156

157-
#### Step 23. Get a MySQL GUI tool so that you can connect to your MySQL DB
157+
#### Step 23. Get a MySQL GUI tool so that you can connect to your MySQL Instance
158158

159159
* You can download [MySQL Workbench](http://dev.mysql.com/downloads/tools/workbench/) for this.
160160

161-
#### Step 24. Create a new connection to your MySQL DB
161+
#### Step 24. Create a new connection to your MySQL Instance
162162

163163
* Use the MySQL DB credentials that you saved in Step 21 for this.
164164

165-
#### Step 25. Create a new schema in your MySQL DB
165+
#### Step 25. Create a new database/schema in your MySQL Instance
166166

167-
* You can name your schema ``test``.
167+
* You can name your database/schema ``test_db``.
168168

169-
#### Step 26. Create the necessary tables in your MySQL schema
169+
#### Step 26. Create the necessary tables in your MySQL database/schema
170170

171-
* Run a SQL script in your MySQL schema using [testcaserepository.sql](https://raw.githubusercontent.com/seleniumbase/SeleniumBase/master/seleniumbase/core/testcaserepository.sql)
171+
* Run a SQL script in your MySQL database/schema using [testcaserepository.sql](https://raw.githubusercontent.com/seleniumbase/SeleniumBase/master/seleniumbase/core/testcaserepository.sql)
172172

173-
#### Step 27. Have your local clone of SeleniumBase connect to your MySQL DB
173+
#### Step 27. Have your local clone of SeleniumBase connect to your MySQL Instance
174174

175175
* Update the MySQL connection details in your [settings.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py) file to use the credentials that you saved in Step 21.
176176
* Run the following command again from the top-level SeleniumBase folder to make sure that SeleniumBase uses the updated credentials:
@@ -179,7 +179,7 @@ If you have a web application that you want to test, you'll be able to create Se
179179
sudo python setup.py install
180180
```
181181

182-
#### Step 28. Have your SeleniumBase Jenkins jobs use your MySQL DB
182+
#### Step 28. Have your SeleniumBase Jenkins jobs use your MySQL Instance
183183

184184
* For the "Execute shell", use the following as your updated "Command":
185185

@@ -192,6 +192,6 @@ nosetests examples/my_test_suite.py --with-selenium --headless --browser=chrome
192192
#### Step 29. Run your new Jenkins job
193193

194194
* Click on "Build Now"
195-
* If all goes well, you should be seeing new rows appear in your MySQL DB.
195+
* If all goes well, you should be seeing new rows appear in your MySQL DB tables.
196196

197197
#### Step 30. Congratulations! If you made it this far, you're awesome!

0 commit comments

Comments
 (0)