Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: cosmetic changes #13

Merged
merged 2 commits into from
Sep 23, 2024
Merged

docs: cosmetic changes #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f065674
chore: improve .gitignore
schlotter Sep 20, 2024
19ac577
docs(examples): fix typos
schlotter Sep 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ junit-reports

**/build
**/twister-out*

.venv*/
22 changes: 11 additions & 11 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Fretish robot examples
# FRETish robot examples

This folder contains some examples to demonstrate the use of `fret-to-robot`.

## Preparation

You should be familiar with Zephyr and the basic setup as described in the
(Getting Started Guide)[https://docs.zephyrproject.org/latest/develop/getting_started/index.html].
[Getting Started Guide](https://docs.zephyrproject.org/latest/develop/getting_started/index.html).

For a setup in an example, create a virtual environment, source it, and install `west` (Step 1 - 5)
For a setup in an example, create a virtual environment, source it, and install `west` (Steps 1 to 5)
in the Getting Started Guide.

Now, also install the `fretish_robot` library. If you are in the current directory, do
Expand All @@ -24,26 +24,26 @@ west init -l digital_microscope
west update
```

This also fetches a zephyr with (currently custom) `robotframework` harness support for twister, and all
necessary modules
This also fetches a Zephyr with (currently custom) `robotframework` harness support for Twister, and all
necessary modules.

## Creating tests for example

To create robot tests for an example, move into the `assets` folder of the example and call `fret-to-robot`
properly. For example:
To create Robot Framework tests for an example, move into the `assets` folder of the example and call
`fret-to-robot` properly. For example:

```sh
fret-to-robot req_fret.json --extra-libraries DigitalMicroscopeLib
```

The `extra-libraries` argument is necessary as we implement keyword functionality in a library
called `DigitalMicroscopeLib` (see `assets/robot_files/DigitalMicroscopeLib.py`)
called `DigitalMicroscopeLib` (see `assets/robot_files/DigitalMicroscopeLib.py`).

Now, the generated files can be found in `assets/robot_files/tests.robot`
Now, the generated files can be found in `assets/robot_files/tests.robot`.

## Execute tests

Now, you can execute the tests with a proper twister execution.
Now, you can execute the tests with a proper Twister execution.

To execute all tests for `native_sim_64` platform, do

Expand All @@ -54,4 +54,4 @@ PYTHONPATH=digital_microscope/assets/robot_files west twister -p native_sim_64 -
The setting of `PYTHONPATH` is necessary as we have a custom library for implementation,
`-vvv` makes it more verbose to see progress.

Afterwards, the results of the test executions are shown (4 of 15 fail, as `always` FRET keyword is not implemented)
Afterwards, the results of the test executions are shown (4 of 15 fail, as `always` FRET keyword is not implemented).