Step Framework

• Introduction
• Installation
• Example
• Usage
• Support and Contact
• Contributing
• License and Trademark

Introduction

Step Framework is a generic open source automation framework to run tests as steps. It has simple plain text syntax and it can be extended easily with generic and custom libraries.

Step Framework is operating system and application independent. It is implemented using Python which is also the primary language to extend it. The framework has a rich ecosystem around it consisting of various generic libraries and tools that are developed as separate projects.

Step Framework project is hosted on GitHub where you can find source code, an issue tracker, and some further documentation.

Step Framework development is sponsored by non-profit Root Of Cyber. If you are using the framework and benefiting from it, consider joining the foundation to help maintaining the framework and developing it further.

Installation

If you already have Python with pip installed, you can simply run:

`pip install git+https://github.com/SanaurAsif/StepFramework`

Example

Step is a simple example test case for testing login to some system. You can find more examples with links to related demo projects from https://github.com/SanaurAsif/StepFramework.

*** Continous ***
Condition:
    Match Image    ${IMAGE_PATH}/images/condition.png    0.9

Then:
    Break Steps

Else:
    Continue


*** Settings ***
Keyword            keywords.py


*** Steps ***
Step 1
    Add Image    ${IMAGE_PATH}/images/condition.png

Step 2
    ${result} = Check Image Match   ${IMAGE_PATH}/images/condition.png    0.9
    If   ${result} == True
        Break Steps
    Else
        Start Step   Step 1
    End

Usage

Tests (or tasks) are executed from the command line using the rocx command or by executing the rocx module directly like python -m rocx .

The basic usage is giving a path to a test (or task) file as an argument with possible command line options before the path:

rocx test.step
rocx --variable BROWSER:Firefox --outputdir results path/to/tests/test.step

Support and Contact

• Slack
• Forum
• Developer on Facebook

Contributing

Interested to contribute to Step Framework? Great! In that case it is a good start by looking at the full code. If you interested submit your pull requests.

License and Trademark

Step Framework is open source software provided under the Apache License 2.0. Step Framework documentation and other similar content use the Creative Commons Attribution 3.0 Unported license. Most libraries and tools in the ecosystem are also open source, but they may use different licenses.

Step Framework trademark is owned by Root Of Cyber.