https://github.com/browserstack/robot-browserstack
Code samples for robot tests on browserstack
https://github.com/browserstack/robot-browserstack
Last synced: over 1 year ago
JSON representation
Code samples for robot tests on browserstack
- Host: GitHub
- URL: https://github.com/browserstack/robot-browserstack
- Owner: browserstack
- Created: 2022-07-19T17:13:26.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-03T13:53:43.000Z (about 2 years ago)
- Last Synced: 2025-02-03T17:36:40.065Z (over 1 year ago)
- Language: RobotFramework
- Size: 37.1 KB
- Stars: 0
- Watchers: 9
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# BrowserStack Integration with Robot Framework Selenium (Python)
## Prerequisite
```
python3 should be installed
```
## Setup
* Clone the repo
```
git clone -b sdk https://github.com/browserstack/robot-browserstack.git
```
* It is recommended to use a virtual environment to install dependencies. To create a virtual environment:
```
python3 -m venv env
source env/bin/activate # on Mac
env\Scripts\activate # on Windows
```
* Install dependencies
```
pip install -r requirements.txt
```
## Set BrowserStack Credentials
* Add your BrowserStack username and access key in the `browserstack.yml` config fle.
* You can also export them as environment variables, `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY`:
#### For Linux/MacOS
```
export BROWSERSTACK_USERNAME=
export BROWSERSTACK_ACCESS_KEY=
```
#### For Windows
```
set BROWSERSTACK_USERNAME=
set BROWSERSTACK_ACCESS_KEY=
setx BROWSERSTACK_USERNAME=
setx BROWSERSTACK_ACCESS_KEY=
```
## Running tests
* To run sample tests:
- To run the sample tests in parallel across the platforms defined in the `browserstack.yml` file, run:
```
browserstack-sdk robot ./tests/test-*.robot
```
* To run tests on locally hosted websites:
- To run the local test in parallel across the platforms defined in the `browserstack.yml` file, run:
```
browserstack-sdk robot ./tests/local-test.robot
```
Understand how many parallel sessions you need by using our [Parallel Test Calculator](https://www.browserstack.com/automate/parallel-calculator?ref=github)
## Additional Resources
* [Documentation for writing Automate test scripts in Python](https://www.browserstack.com/automate/python)
* [Customizing your tests on BrowserStack](https://www.browserstack.com/automate/capabilities)
* [Browsers & mobile devices for selenium testing on BrowserStack](https://www.browserstack.com/list-of-browsers-and-platforms?product=automate)
* [Using REST API to access information about your tests via the command-line interface](https://www.browserstack.com/automate/rest-api)