Schrandom aims to become a solid "all-in-one" testing tool for those who extensively use Apache Avro as a main data serialization format and thus are also familiar with Schema Registries and Apache Kafka.
Schrandom addresses the following goals:
- Provides API to generate random records according to the schema (both provided explicitly or from Schema Registry) and publish them to Kafka topic;
- Allows generating load test profiles depending on your needs (you may define how many random messages you want to be generated or make the task continuous that may last forever providing you with a constant message stream);
- Allows validating messages against schema obtained both from Schema Registry or provided explicitly;
Schrandom uses REST API as a control plane. Any function Schrandom provides can be accessed through the API.
Schrandom provides swagger documentation which is always accessible at http://host:port/docs.
The main endpoints are:
schrandom/engage: used to assign message-generating processes to the service.
It also splits into three branches:
- /continuos for everlasting tasks executing until interrupted explicitly;
- /externalSchema for tasks that use explicit (user-provided) AVRO schemas;
- /limited for bounded tasks that produce a limited message sets;
A set of /schrandom/disengage endpoints are used to cancel current tasks from the execution.
Please see the latest swagger documentation as a reference.
Schrandom is a regular Scala application that can be deployed in any JVM-friendly environment.
We encourage you to use Schrandom with any containerization engine you want: K8S, Docker Swarm, etc.
Schrandom acts as a standalone microservice that interacts with your current AVRO-related infrastructure represented by Schema Registry and Apache Kafka.
You are able to use any packaging you want but we encourage you to go with sbt-native-packager.
Please see the diagram below:
Schrandom uses Monix as a main execution environment/scheduler. Each task created using REST API in fact translates to a specific Runnable that assigns to the scheduler.
Thanks to Cancelable Futures provided by Monix it is possible to cancel any running task at any time.
Schrandom uses Tapir to describe HTTP-endpoints and generate swagger documentation along with Netty used as NIO-server.
Please see the following diagram as a reference:
