FRET support for Robot files

This package provides the framework and capabilities to run FRET requirements in Robot Framework.

This package provides, on the one hand, a script fret-to-robot to convert parsed FRET JSON files into Robot Framework .robot files together with an example implementation for events specified in requirements. Hereby, a few new keywords are used to keep the requirement transformation readable and understandable, to enable proper reviews and traceability.

On the other hand, a Robot Framework library FRETLib is implemented that breaks down these requirements into built-in Robot Framework keywords, to maintain semantic but also reduce maintenance work.

Installation

Install the package and requirements via

pip install -e .

Usage

Script

To convert a parsed FRET JSON into Robot test files and the generated keyword calls, call

fret-to-robot <path_to_fret.json>

This will generate a file tests.robot in the robot_files folder.

For configuration options, like the path to the file, output, or additional libraries to include, use the --help option.

FRETLib

The FRETLib keywords can be used by importing the library:

Library    fretish_robot.FRETLib

Note: This is already done by fret-to-robot.

Requirement behavior implementation

The FretLib library transforms FRET keywords into standard Robot Framework keywords. All non-FRET keywords of the Robot files must be provided by a user library, see the example library implementation.

E.g., while fret-to-robot outputs

Upon    request_set_two,
Satisfies  ($answer_message_good & $answer_is_two)

, the library provides Upon and Satisfies, but not things like request_set_two, answer_message_good and answer_is_two. A user library must provide a keyword implementation for these.

This can be done in two steps:

• Implement a Robot Framework library with proper keywords. An example can be seen in fretish_robot.example_user_lib.ExampleUserLib.
• Pass --extra-libraries with the proper path, e.g. --extra-libraries fretish_robot.example_user_lib.ExampleUserLib when generating, so it is part of the .robot files.

Note: It is not necessary to adjust the robot execution then, if all libraries are installed.

Executing generated Robot files

To run the generated files, just do

robot ./robot_files/result.robot

Limitations

There are some implementation details and restrictions to consider when using:

• Only 'if then' and pure expressions are supported in the 'Satisfy' clause.
• Formatting of printed requirements is fine, but not pretty. This could be improved in newer versions if needed.
• Different events in the 'Upon' clause can only be separated by '|' ('or') and are split into different test cases.

Contributing

Contribute to this project by signing off your Git commits using the following Developer Certificate of Origin:

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Talks

Slides and recordings related to this project can be found in the talks directory.