https://github.com/nhn/eat

Json based scenario testing tool(which can have test for functional and non-functional)
https://github.com/nhn/eat

functional-testing game-server-test game-server-testing json load-testing server-client-communication stress-testing test test-automation test-driven-development test-framework test-runner testing testing-framework testing-tools unit-testing

Last synced: 4 months ago
JSON representation

Json based scenario testing tool(which can have test for functional and non-functional)

• Host: GitHub
• URL: https://github.com/nhn/eat
• Owner: nhn
• License: mit
• Created: 2018-03-16T06:17:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-04-02T22:34:45.000Z (over 6 years ago)
• Last Synced: 2025-06-19T12:44:05.741Z (5 months ago)
• Topics: functional-testing, game-server-test, game-server-testing, json, load-testing, server-client-communication, stress-testing, test, test-automation, test-driven-development, test-framework, test-runner, testing, testing-framework, testing-tools, unit-testing
• Language: Java
• Homepage:
• Size: 34.4 MB
• Stars: 41
• Watchers: 13
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# EAT(End-point Autonomous Testing Tool)

[![GitHub release](https://img.shields.io/github/release/nhnent/eat.svg)](https://github.com/nhnent/eat/releases/latest) [![GitHub license](https://img.shields.io/github/license/nhnent/eat.svg)](https://github.com/nhnent/eat/blob/master/LICENSE) [![PRs welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg)](https://github.com/nhnent/eat/pulls) [![code with hearth by NHN Entertainment](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-NHN%20Entertainment-ff1414.svg)](https://github.com/nhnent)

## 🚩 Table of Contents

- [System Requirements](#-System-Requirements)

- Features

  - [Scenario using Json](#-scenario-using-json)

  - [Report Test Result](#-report-test-result)

- [Background](#-background)

- [Using Actor model](#-using-actor-model)

- [Communications](#-communications)

- [Contributing](#-contributing)

- [License](#-license)

------

## 🌏 System Requirements

- JDK(1.8)

- Windos, MAC, Linux

---

## 🎬 Introduction Video Clip 

[![Introduction](eat/document/img/video_clip.png)](https://www.youtube.com/watch?v=Sk-PUh6DHjY)

[YouTube Link](https://www.youtube.com/watch?v=Sk-PUh6DHjY)

## 🎨 Features

### 📖 Scenario using Json

![example of scenario](eat/document/img/processing.png)

**Json based scenario testing tool(which can have test for functional and non-functional)**

- Transfer/Receiving packets are defined with **Json format**

- The defined Json will encoded to Binary packet, and received binary packet will decoded to Json as well.

- It provides **easy to understand and define** Test Case.

- Internally,it uses java reflection, so **developer doesn’t need consider testing implementation**, just define **Test Scenario**.

![example of scenario](eat/document/img/scenario_example1.JPG)

### 👫 For Who?

EAT can be used for the following developer who want have regression/load test

- Developer who need Game Server Test

- Developer who need General Server(which communicate with binary packet) Test

### 📃 Report Test Result

The test report will displayed with the following features

- Test result per each Scenario Unit 

- Summary for functional scenario test

- Statistics Information

#### 👍 Succeed

![Test Fail](eat/document/img/test_succeed.JPG)

####  👎 Failure

![Test Fail](eat/document/img/test_failed.JPG)

####  👏 Summary

![Test Fail](eat/document/img/test_count.JPG)

#### 🌌 Statistics

![Test Fail](eat/document/img/test_statistics.JPG)

------

## 👤 Background

### End-point Testing Tool

- **Independence from client program**, server developer can have tests for their function.

- Besides Unit-testing tool, server developer need testing tool which can **test end-point**.

- Even unit function works well, we cannot guarantee that operation of service works properly. (Unit testing is not sufficient condition for full valid serviceoperation)

### Scenario base

- The scenario should **easy to read** for maintenance.

- The scenario should support **integration and regression test**.

### Expand to Load Testing.

- Based on scenario, it can support **load testing**.(ex,Peak test, Stress test and so on)

------

### 🐋 Using Actor model

–EAT is developed based on Actor model. 

–So,it can scaled out through nodes for Load Testing.

![Actor Model](eat/document/img/actor_model.jpg)

[More Detail](https://github.nhnent.com/ngt/eat/wiki/Overview/#using-actor-model)

---

## 👫 Communications

Basically, EAT supports communication method such as Strem Socket, Web Socket, RESTful API and JMX with plug-in method.

And if you want add more communication method, you can add it using plugin interface.

[More Detail](https://github.nhnent.com/ngt/eat/wiki/Overview/#architecture)

---

## 💬 Contributing

- [Code of Conduct](eat/document/CODE_OF_CONDUCT.md)

------

## 📜 License

This software is licensed under the [MIT](https://github.nhnent.com/ngt/eat/blob/develop/LICENSE) © [NHN](https://github.com/nhnent)