https://github.com/thin-edge/robotframework-aws
AWS Robotframework library for testing thin-edge.io with AWS
https://github.com/thin-edge/robotframework-aws
Last synced: 16 days ago
JSON representation
AWS Robotframework library for testing thin-edge.io with AWS
- Host: GitHub
- URL: https://github.com/thin-edge/robotframework-aws
- Owner: thin-edge
- License: mit
- Created: 2024-08-29T09:28:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-03T11:30:38.000Z (about 1 year ago)
- Last Synced: 2025-01-30T12:19:44.055Z (9 months ago)
- Language: Python
- Size: 89.8 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-robotframework - thin-edge/robotframework-aws - edge.io with AWS. (Libraries / IoT)
README
# robotframework-aws
Robot Framework Library for AWS IoT in the context of thin-edge.io
# Using it
1. Install via pip
```sh
pip install git+https://github.com/thin-edge/robotframework-aws.git@main
```
Or add it to your `requirements.txt` file
```sh
robotframework-aws @ git+https://github.com/thin-edge/robotframework-aws.git@main
```
Then install it via
```sh
pip install -r requirements.txt
```
Alternatively you can install a specific version using:
```sh
robotframework-aws @ git+https://github.com/thin-edge/robotframework-aws.git@0.0.7
```
2. Create a `.env` file with the following environment variables
```sh
AWS_ACCESS_KEY_ID=ABCDEFGHI
AWS_SECRET_ACCESS_KEY=
AWS_REGION=us-east-1
```
3. Create a Robot test `tests/Example.robot`
```robot
*** Settings ***
Library AWS
Library DeviceLibrary
*** Test Cases ***
Example
${device_name}= DeviceLibrary.Setup
${aws}= AWS.Create Thing With Self-Signed Certificate name=${device_name}
DeviceLibrary.Execute Command printf -- '${aws.private_key}' > $(tedge config get device.key_path)
DeviceLibrary.Execute Command printf -- '${aws.public_key}' > $(tedge config get device.cert_path)
DeviceLibrary.Execute Command sudo tedge config set aws.url ${aws.url}
${stdout}= DeviceLibrary.Execute Command sudo tedge connect aws retries=0
```
**Note**
The above example uses the [robotframework-devicelibrary](https://github.com/reubenmiller/robotframework-devicelibrary)
4. Run the test
```sh
robot tests/Example.robot
```
## Library docs
You can generate the docs yourself using:
```sh
libdoc AWS/AWS.py show > AWS/AWS.rst
```
Or the more interactive html documentation using:
```sh
libdoc AWS/AWS.py AWS/AWS.html
```
## Development
Before submitting a PR, make sure you run the formatting and linting against your code to ensure you don't have an formatting or linting errors.
You can run the formatting and linting by first installing the development dependencies, using the following [just](https://github.com/casey/just) tasks:
```sh
just venv
just install_dev
```
After the dependencies have been installed, run the linting/formatting task and check the output.
```sh
just lint
```
The pylint output should rate your code as 10.00/10. Below is an example of the console output:
```
Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)
```