Skip to content

Latest commit

 

History

History
131 lines (92 loc) · 4.62 KB

README.md

File metadata and controls

131 lines (92 loc) · 4.62 KB
Raw

Build Status Coverage Quality Gate Status

Arex Icon AREX

An Open Source Testing Framework with Real World Data

Introduction

As your application evolves more complex, the effort required to thoroughly test against it also becomes tremendous. Arex is a framework designed around a quite straightforward principle of leveraging your real world data(i.e. database record, service payload, cache items etc.) for regression testing. Simple is powerful. The idea behind makes it incredibly powerful.

AREX provides an out-of-box agent file that could be attached to any applications with Java 8+ and dynamically weaves solid bytecode into your existing code to record the real data of live traffic, and further use and replay it for mocking, testing, and debugging purpose.

AREX is implemented with an unique mechanism for recording. Instead of being a proxy like other similar framework, AREX sits in the background without awareness of your application to record realistic data in live traffic which means that no intrusive code changes are required when integrating it to your existing application.

AREX utilizes the advanced Java technique, Instrument API, and is capable of instrumenting various libraries and frameworks which are widely used.

Libraries and frameworks supported by Arex (to be added...) maven version range rules

Foundation

  • Java Executors
  • System time
  • Dynamic Type

Cache Library

  • Caffeine Cache
  • Guava Cache
  • Spring Cache

Spring

  • Spring Boot [1.4+, 2.x+]
  • Servlet API 3+、5+

Http Client

  • Apache HttpClient [4.0,)
  • OkHttp [3.0, 4.11]
  • Feign [9.0,)
  • Spring OpenFeign
  • Spring RestTemplate
  • Spring WebClient [5.0,)
  • ning/async-http-client
  • Elasticsearch Client [7.x,)

Redis Client

  • RedisTemplate
  • Jedis [2.10+, 4+]
  • Redisson [3.0,)
  • Lettuce [5.x, 6.x]

Persistence framework

  • MyBatis 3.x, MyBatis-Plus, TkMyBatis
  • Hibernate 5.x

NoSQL

  • MongoDB [3.x, 4.x]

RPC

  • Apache Dubbo [2.x, 3.x]
  • Alibaba Dubbo 2.x

Auth

  • Spring Security 5.x
  • Apache Shiro 1.x
  • JCasbin 1.x
  • Auth0 jwt 3.x
  • JWTK jjwt 0.1+、jjwt-api 0.10+

Netty

  • Netty http server [3.x, 4.x]

Config

  • Apollo Config [1.x, 2.x]

Building

Simply download the latest binary from releases or build the artifacts with the following commands. The build process supports JDK 8 - 21.

mvn clean install -DskipTests

The arex-agent.jar is in the folder arex-agent-jar/ after the build process.

If you wanna jar with version, build the artifacts with the following commands.

mvn clean install -DskipTests -Pjar-with-version

Getting Started

Enable the instrumentation agent by configuring a javaagent flag to the JVM to run arex：

AREX agent works along with the AREX storage service.

You could just configure the host and port of them respectively, like below

java -javaagent:/path/to/arex-agent.jar -Darex.service.name=my-service-name -Darex.storage.service.host=<storage.service.host:port> -jar my-application.jar

Alternatively, you can put those configuration item in arex.agent.conf file, like below

arex.service.name=my-service-name
arex.storage.service.host=<storage.service.host:port>

Then simply run:

java -javaagent:/path/to/arex-agent.jar -Darex.config.path=/path/to/arex.agent.conf -jar my-application.jar

Also, You can Run with CLI in local mode:

Please refer to : AREX standalone mode.

Contributing

  1. Fork it
  2. Create your feature branch
  3. Commit your code changes and push to your feature branch
  4. Create a new Pull Request

License