Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/authorjapps/zerocode

A community-developed, free, opensource, automated testing framework for microservices APIs, Kafka(Data Streams) and Load testing. Zerocode Open Source enables you to create, change and maintain your automated test scenarios via simple JSON or YAML files. Visit documentation below:
https://github.com/authorjapps/zerocode

api assertions automation automation-framework consumer contract declarative dsl framework http java json junit5 kafka library producer soap testing

Last synced: 29 days ago
JSON representation

A community-developed, free, opensource, automated testing framework for microservices APIs, Kafka(Data Streams) and Load testing. Zerocode Open Source enables you to create, change and maintain your automated test scenarios via simple JSON or YAML files. Visit documentation below:

Lists

README 

        
Zerocode Zerocode

===

Automated API, Kafka and Micro-services testing has never been so easy



[![API](https://img.shields.io/badge/api-automation-blue)](https://github.com/authorjapps/zerocode/wiki/What-is-Zerocode-Testing)

[![Performance Testing](https://img.shields.io/badge/performance-testing-ff69b4.svg)](https://github.com/authorjapps/zerocode/wiki/Load-or-Performance-Testing-(IDE-based))



**Latest release:🏹** [![Maven](https://maven-badges.herokuapp.com/maven-central/org.jsmart/zerocode-tdd/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.jsmart/zerocode-tdd/) 


**CI Testing:** ![example workflow](https://github.com/authorjapps/zerocode/actions/workflows/main.yml/badge.svg)




**Issue Discussions:** [Slack](https://join.slack.com/t/zerocode-workspace/shared_invite/enQtNzYxMDAwNTQ3MjY1LTA2YmJjODJhNzQ4ZjBiYTQwZDBmZmNkNmExYjA3ZDk2OGFiZWFmNWJlNGRkOTdiMDQ4ZmQyNzcyNzVjNWQ4ODQ) 
 

**Mailing List:** [Mailing List](https://groups.google.com/forum/#!forum/zerocode-automation) 


**License:** [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0) 



Zerocode makes it easy to create and maintain automated tests with absolute minimum overhead for [REST](https://github.com/authorjapps/zerocode/wiki/User-journey:-Create,-Update-and-GET-Employee-Details),[SOAP](https://github.com/authorjapps/zerocode/blob/master/README.md#soap-method-invocation-example-with-xml-input), [Kafka Real Time Data Streams](https://github.com/authorjapps/zerocode/wiki/Kafka-Testing-Introduction) and much more. 

It has the best of best ideas and practices from the community to keep it super simple, and the adoption is rapidly growing among the developers & testers community.



Documentation

===

For a quick introduction to Zerocode and its features, visit the 

+ [Zerocode TDD Doc Site](https://zerocode-tdd-docs.pages.dev)



IDE Support By 

===

[Jetbrains IDE](https://www.jetbrains.com/idea/)



Maven Dependency

===

+ [New releases - zerocode-tdd](https://maven-badges.herokuapp.com/maven-central/org.jsmart/zerocode-tdd/) 

[![Maven](https://maven-badges.herokuapp.com/maven-central/org.jsmart/zerocode-tdd/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.jsmart/zerocode-tdd/)

+ _[Older releases - zerocode-rest-bdd](https://maven-badges.herokuapp.com/maven-central/org.jsmart/zerocode-rest-bdd/)_ 

[![Maven](https://maven-badges.herokuapp.com/maven-central/org.jsmart/zerocode-rest-bdd/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.jsmart/zerocode-rest-bdd/)



Introduction

===

Zerocode is a modern lightweight, simple and extensible open-source framework for writing test intentions in simple JSON or YAML format that facilitates both declarative configuration and automation. 



Put simply, Zerocode alleviates pain and brings simplicity to modern API automation. The framework manages the response validations, target API invocations, load/stress testing and security testing in a unified way using simple YAML/JSON/Fluent steps, aka DSL.



For example, if your REST API URL `https://localhost:8080/api/v1/customers/123` with `GET` method and `"Content-Type": "application/json"` returns the following payload and a `http` status code `200(OK)` ,

```javaScript

Response:

{

    "id": 123,

    "type": "Premium High Value",

    "addresses": [

        {

            "type":"home",

            "line1":"10 Random St"

        }

    ]

}

```



then, we can easily validate the above API using `Zerocode` like below.



+ Using YAML described as below,



> _The beauty here is, we can use the payload/headers structure for validation as it is without any manipulation or use a flat JSON path to skip the hassles of the entire object hierarchies._



## Validators



Using YAML



```yaml



---

url: api/v1/customers/123

method: GET

request:

  headers:

    Content-Type: application/json

retry:

  max: 3

  delay: 1000

validators:

- field: "$.status"

  value: 200

- field: "$.body.type"

  value: Premium Visa

- field: "$.body.addresses[0].line1"

  value: 10 Random St

```



or



Using JSON



```JSON

{

  "url": "api/v1/customers/123",

  "method": "GET",

  "request": {

    "headers": {

      "Content-Type": "application/json"

    }

  },

  "retry": {

    "max": 3,

    "delay": 1000

  },

  "validators": [

    {

      "field": "$.status",

      "value": 200

    },

    {

      "field": "$.body.type",

      "value": "Premium Visa"

    },

    {

      "field": "$.body.addresses[0].line1",

      "value": "10 Random St"

    }

  ]

}

```



## Matchers



Using YAML



```yaml



---

url: api/v1/customers/123

method: GET

request:

  headers:

    Content-Type: application/json

retry:

  max: 3

  delay: 1000

verify:

  status: 200

  headers:

    Content-Type:

    - application/json; charset=utf-8

  body:

    id: 123

    type: Premium Visa

    addresses:

    - type: Billing

      line1: 10 Random St

verifyMode: LENIENT

```



or



Using JSON



```JSON

{

  "url": "api/v1/customers/123",

  "method": "GET",

  "request": {

    "headers": {

      "Content-Type": "application/json"

    }

  },

  "retry": {

    "max": 3,

    "delay": 1000

  },

  "verify": {

    "status": 200,

    "headers": {

      "Content-Type" : [ "application/json; charset=utf-8" ]

    },

    "body": {

      "id": 123,

      "type": "Premium Visa",

      "addresses": [

        {

          "type": "Billing",

          "line1": "10 Random St"

        }

      ]

    }    

  },

  "verifyMode": "STRICT"

}

```



and run it simply by pointing to the above JSON/YAML file from a JUnit `@Test` method.



```java

   @Test

   @Scenario("test_customer_get_api.yml")

   public void getCustomer_happyCase(){

        // No code goes here. This remains empty.

   }

```



Looks simple n easy? Why not give it a try? Visit the [quick-start guide](https://github.com/authorjapps/zerocode/wiki/Getting-Started) or [user's guide](https://github.com/authorjapps/zerocode/wiki#developer-guide) for more insight.



Zerocode is used by many companies such as Vocalink, HSBC, HomeOffice(Gov) and [many others](https://github.com/authorjapps/zerocode/wiki#smart-projects-using-zerocode) to achieve accurate production drop of their microservices. Learn more about [Validators Vs Matchers](https://github.com/authorjapps/zerocode/wiki/Validators-and-Matchers) here.



Happy Testing! 🐼