Skip to content

toast-tk/toast-tk-engine

Repository files navigation

Build Status Quality Gate Technical debt ratio License

Stories in Ready Gitter

Toast-tk-engine

Toast-tk-engine is the core automation framework for your acceptance tests. It provides a concise, self-explanatory and type safe way for writing test cases. No more “REGEX HELL” :bowtie:

Example

A scenario action: “Navigate to url *http://www.google.com*”
Would be written, in Toast, as follows:

Navigate to url {{value:string}} 

instead of

Navigate to url *([\w\W]+)*

Toast TK Engine

  1. Parses a script written in a markdown format to a TestPage
  2. Executes the TestPage by locating the best matching @Action within a given @ActionAdapter
  3. Outputs a Value Based Test Execution Report

Toast TK is not another Cucumber / JBehave like framework, nor a Gherkin based toolkit.
It supports BDD and TDD collaborative testing on top of being pluggable to any test driver of your choice such as Selenium or Fest.
It makes test scripts easier to share between technical team members (i.e: Developers) and non-technical ones (i.e: Business Analysts) as it overcomes the need for learning a specific scripting syntax.

Installation

Using MAVEN

Add Toast Runtime dependency

<dependency>
  <groupId>io.toast-tk</groupId>
  <artifactId>toast-tk-runtime</artifactId>
  <version>0.1.5</version>
</dependency>

How to use Toast Tk Engine

The toast-tk-example project hosts different examples for:

  • Web Browser automation
  • Custom sentences
  • Rest API automation
  • JSON and XML value management as a variable
  • Test report generation
  • Toast Maven plugin

Contribution

Toast TK is a young Open Source Love project.

For contribution rules and guidelines, See CONTRIBUTING.md

If you'd like to help, get in touch and let us know how you'd like to help. We love contributors!!

Licence

Toast TK regroups multiple open source projects licensed under the Apache Software License 2.