Skip to content

Commit 520a475

Browse files
mdmintzmdmintz
committed
Update ReadMe files
1 parent 1b2ab43 commit 520a475

File tree

6 files changed

+60
-31
lines changed

6 files changed

+60
-31
lines changed

‎README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22

33
[<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://dev.azure.com/seleniumbase/seleniumbase/_apis/build/status/seleniumbase.SeleniumBase?branchName=master" alt=" " />](https://dev.azure.com/seleniumbase/seleniumbase/_build/latest?definitionId=1&branchName=master) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt=" " />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt=" " />](https://gitter.im/seleniumbase/SeleniumBase) [<img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/stargazers)
44

5-
A complete framework for web automation, end-to-end testing, and [user-onboarding](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md). SeleniumBase uses [pytest](https://github.com/pytest-dev/pytest) for running Python scripts, while using [Selenium WebDriver](https://www.seleniumhq.org/) for controlling web browsers.
5+
All-in-one framework for web automation, end-to-end testing, and website tours. SeleniumBase uses pytest for running Python scripts, while using Selenium WebDriver for controlling web browsers.
66

7-
* No more flaky tests! (Smart-waiting keeps tests reliable.)
7+
* Contains reliable, smart-waiting code to prevent flaky tests.
8+
* Simplifies the process of creating UI tests for any website.
89
* Includes [Plugins](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/pytest_plugin.py) for logging [test results and screenshots](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md).
10+
* Multiplies the abilities of [pytest](https://pytest.org) and [Selenium WebDriver](https://www.seleniumhq.org/).
911
* Uses versatile [Python methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md) and [command-line options](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md).
10-
* Has tools for [website tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md), [assisted-QA](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md), and [visual testing](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md).
12+
* Includes tools for [assisted-QA](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md), [visual testing](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md), and [web tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md).
1113
* Integrates with [Selenium Grid](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md), [Katalon Recorder](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_ide/ReadMe.md), and [MySQL](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/core/testcase_manager.py).
1214
* Supports [Azure Pipelines](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/azure/azure_pipelines/ReadMe.md), [GCP](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/google_cloud/ReadMe.md), [TravisCI](https://github.com/seleniumbase/SeleniumBase/blob/master/.travis.yml), [Docker](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/docker/ReadMe.md), and more.
1315
* To see the full list of SeleniumBase features, [click here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md).

‎help_docs/hidden_files_info.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
### Info about hidden files on macOS
1+
## Info about hidden files on macOS
22

33
Depending on your macOS settings, some files may be hidden from view in your Finder window, such as ``.gitignore``. To view all files, run the following command and then reopen the Finder window:
44
```bash
55
defaults write com.apple.finder AppleShowAllFiles -bool true
66
```
77

88
More info on that can be found here:
9-
https://www.defaults-write.com/show-hidden-files-in-os-x-finder/
10-
https://www.macworld.co.uk/how-to/mac-software/hidden-files-mac-3520878/
11-
https://setapp.com/how-to/show-hidden-files-on-mac
9+
* https://www.defaults-write.com/show-hidden-files-in-os-x-finder/
10+
* https://www.macworld.co.uk/how-to/mac-software/hidden-files-mac-3520878/
11+
* https://setapp.com/how-to/show-hidden-files-on-mac

‎help_docs/method_summary.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ self.click_chain(selectors_list, by=By.CSS_SELECTOR, timeout=None, spacing=0)
2424

2525
self.type(selector, text, by=By.CSS_SELECTOR, timeout=None, retry=False)
2626

27+
self.input(selector, text, by=By.CSS_SELECTOR, timeout=None, retry=False)
28+
2729
self.update_text(selector, new_value, by=By.CSS_SELECTOR, timeout=None, retry=False)
2830

2931
self.add_text(selector, text, by=By.CSS_SELECTOR, timeout=None)

‎help_docs/using_safari_driver.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,9 @@
1-
### Info about using Safari Driver for running automated tests on macOS
1+
## Using Safari's WebDriver for running browser tests on macOS
22

3-
(NOTE: SafariDriver requires Safari 10 running on OS X 10.11 El Capitan or greater)
3+
*(NOTE: Safari's WebDriver requires macOS 10.13 "High Sierra" or later.)*
44

5-
You can find info on Safari Driver if you scroll down to that section on the [SeleniumHQ downloads page](https://www.seleniumhq.org/download/).
5+
You can find the official Apple documentation regarding "Testing with WebDriver in Safari" on the following page: https://developer.apple.com/documentation/webkit/testing_with_webdriver_in_safari
66

7-
That page will tell you to [download the required Safari Driver browser extension (SafariDriver.safariextz) here at this link](http://selenium-release.storage.googleapis.com/index.html?path=2.48/).
7+
Run ``safaridriver --enable`` once in a terminal to enable Safari's WebDriver. (If you’re upgrading from a previous macOS release, you may need to prefix the command with ``sudo``.)
88

9-
For that to work, you'll need to [download the Standalone Selenium Server from here](http://docs.seleniumhq.org/download/) and put that JAR file in ``/usr/local/bin/``. To make the next step easier, rename the downloaded JAR file to ``selenium-server-standalone.jar`` (if it's not already called that).
10-
11-
Next, configure the Selenium Server JAR file into your PATH like this:
12-
13-
```bash
14-
export SELENIUM_SERVER_JAR=/usr/local/bin/selenium-server-standalone.jar
15-
export PATH=$PATH:/usr/local/bin/selenium-server-standalone.jar
16-
```
17-
18-
Now you're ready to run automated tests on Safari if you use ``--browser=safari`` on the command line when running your tests/scripts with SeleniumBase.
9+
Now you can use ``--browser=safari`` to run your **SeleniumBase** tests on Safari.

‎help_docs/verify_webdriver.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,39 @@
1-
### Verify that web drivers were successfully installed
1+
## Verifying that web drivers are installed
22

3-
*You can do this by checking inside a Python command prompt. (NOTE: xkcd is a webcomic)*
3+
*You can do this by checking inside a Python command prompt.*
44

55
#### Verifying ChromeDriver
66
```bash
77
python
8+
```
9+
```python
810
>>> from selenium import webdriver
9-
>>> browser = webdriver.Chrome()
10-
>>> browser.get("http://xkcd.com/1337/")
11-
>>> browser.close()
11+
>>> driver = webdriver.Chrome()
12+
>>> driver.get("https://www.google.com/chrome")
13+
>>> driver.quit()
1214
>>> exit()
1315
```
1416

15-
#### Verifying FirefoxDriver (Geckodriver)
17+
#### Verifying Geckodriver (Firefox WebDriver)
1618
```bash
1719
python
20+
```
21+
```python
22+
>>> from selenium import webdriver
23+
>>> driver = webdriver.Firefox()
24+
>>> driver.get("https://www.mozilla.org/firefox")
25+
>>> driver.quit()
26+
>>> exit()
27+
```
28+
29+
#### Verifying WebDriver for Safari
30+
```bash
31+
python
32+
```
33+
```python
1834
>>> from selenium import webdriver
19-
>>> browser = webdriver.Firefox()
20-
>>> browser.get("http://xkcd.com/1337/")
21-
>>> browser.close()
35+
>>> driver = webdriver.Safari()
36+
>>> driver.get("https://www.apple.com/safari")
37+
>>> driver.quit()
2238
>>> exit()
2339
```

‎integrations/selenium_ide/ReadMe.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,19 @@
1-
### The ReadMe for the Katalon / Selenium IDE conversion tool has been moved to: [seleniumbase/utilities/selenium_ide/ReadMe.md](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_ide/ReadMe.md) and all related code has been moved to [seleniumbase/utilities/selenium_ide](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_ide)
1+
## Converting Katalon recordings into SeleniumBase test scripts
2+
3+
Katalon Recorder (Selenium IDE) is a tool that allows you to record and playback actions performed inside a web browser. It's available as a [downloadable Chrome extension](https://chrome.google.com/webstore/detail/katalon-recorder-selenium/ljdobmomdgdljniojadhoplhkpialdid) and a [downloadable Firefox extension](https://addons.mozilla.org/en-US/firefox/addon/katalon-automation-record/). The Katalon Recorder comes with an option to export recordings as various WebDriver test scripts, one of which is ``Python 2 (WebDriver + unittest)``. Unfortunately, these natively-exported scripts can be very messy and don't always run reliably. The purpose of this converter is to clean up and improve the scripts so that they can be used in production-level environments.
4+
5+
#### Step 1: Make a recording with the Katalon Recorder
6+
7+
![](https://cdn2.hubspot.net/hubfs/100006/images/katalon_recorder_2.png "Katalon Recorder example")
8+
9+
#### Step 2: Export your recording as a Python 2 Webdriver script
10+
11+
* ``{} Export`` => ``Python 2 (WebDriver + unittest)`` => ``Save As File``
12+
13+
#### Step 3: Run ``seleniumbase convert`` on your exported Python file
14+
15+
```
16+
seleniumbase convert [MY_TEST.py]
17+
```
18+
19+
* You should see a [MY_TEST_SB.py] file appear in the folder. (``_SB`` is added to the file name so that the original file stays intact in case you still need it.) This new clean & reliable SeleniumBase test script is ready to be added into your test suite for running.

0 commit comments

Comments
 (0)