E2Easy-Go

E2Easy-Go is a library to create a complex end-to-end tests and validations writing a simple yaml file. It's possible to define a set of information based on pre-defined configuration to start a flow of REST API calls, and use the result for validations or next flows call.

The library runs on the console where it is possible to pass an input file (.yaml) to be consumed, this file defines the steps and validations of the end-to-end test.

How to execute:

Allowed properties

---

Property	Information	Example
name	Set the E2E flow name	name: my_e2e_test
steps	Array of steps for E2E Test	steps: - name: ....
name	Name of a single E2E Test step	steps: - name: get_validation
path	URL path for call API	steps: - ... path: http://my-endpoint/valid
method	REST Method to call API for this step	steps: - ... method: GET
body	string with json BODY to cal API if necessary	steps: - ... body: "{ "reference_id": "TST-E2E004"}"
headers	header information if necessary (name and value)	steps: - ... headers: - name: "Authorization value: Z8LM1y7LMTgbUFgJ4maMKGTdsIR8Nb
vars	Configuration to save a value to a variable to use in E2E Test To get a value of a response, you can navigate with response node like: response.body.PROPERTY	steps: - ... vars: - id: response.body.my_response_property
tests	Set of tests validations to perform for step. You can set how many tests you want, allowed tests type is: - equals: to compare is expected is exactly equals actual value. - contains: to verify if actual value contains expected value. - not_nil: to verify if actual value is no null (nil in go). - nil: to verify if actual value is null (nil in go).	tests: - name: same_reference expected: "TST-E2E-GO" actual: ${id} type: equals

Example 1:

To create a simple GET call to an URL and validate the result:

name: contract_retention
steps:
  - name: contrato
    path: https://mail-generator.herokuapp.com/generate?domain=hotmail
    method: GET
    vars:
      fullBody: response.body
      email: response.body.mail
      statusCode: response.statusCode
    tests:
      - name: return_hotmal
        expected: "hotmail"
        actual: ${email}
        type: contains
      - name: status_ok
        expected: 200
        actual: ${statusCode}
        type: equals
``