A comprehensive reporting framework supporting multiple generators - static, email & realtime, historical analytics with ChainLP.
Note: ChainTest is still in active development.
- Simple: Dark | Light
- Email: Sample
- ChainLP: https://chaintest.onrender.com/
A generator is responsible for creating output files based on the test results and configuration settings. It processes templates, saves necessary resources, and generates reports in a specified format.
Only Java unit test frameworks are supported at present. Generators can be enabled via properties files located on classpath - for more information, see the supported plugins below.
Refer the support matrix for support chaintest-core and chainlp versions.
ChainLP (Chain-Long-Playing like LP Record) is a Java (Spring) server which packs the Angular frontend and is distributed as a Docker image. ChainLP is the framework component providing historical analytics.
Docker image is available from https://hub.docker.com/r/anshooarora/chaintest.
The recommended way to run ChainLP is with docker-compose. Currently, the supported databases are listed below but most RDBMS database should work.
- H2
- MySQL
- PostgreSQL
For each database, there is a separate docker-compose.yml available at chainlp/docker. H2 provides the most straight-forward way to test, but it is NOT recommended for production use.
# example
git clone https://github.com/anshooarora/chaintest.git
cd chaintest/chainlp/docker
docker compose -f docker-compose-h2.yml up
# h2
docker compose -f docker-compose-h2.yml up
# mysql
docker compose -f docker-compose-mysql.yml up
# posgres
docker compose -f docker-compose-postgres.yml up
Use the host:port of the ChainLP server, include it in chaintest.properties along with the required value for chaintest.project.name.
The host:port combination is where the client (via plugin) will connect to and communicate over TCP. For more information how communication is established, look into ChainTestApiClient.
# (only the relevant bits shows below)
# chaintest configuration
chaintest.project.name=default
# generators:
## chainlp
chaintest.generator.chainlp.enabled=true
chaintest.generator.chainlp.host.url=<host:port>
The chaintest-core client is the framework component that supports plugins to store embeds for each report. For example, with SimpleGenerator, the client saves all embeds relative to the report file in the resources folder.
As of chaintest-core:1.0.11 and ChainLP: 0.0.9, embeds are stored in DB by default. This can be turned off using the below property in favor of S3 via chaintest.storage.service.* (next section).
# default: true (embeds will be persisted in db)
chaintest.generator.chainlp.persist-embeds=true
To archive and view embeds in ChainLP from S3, the following settings are required:
# storage
chaintest.storage.service.enabled=true
# [azure-blob, aws-s3]
chaintest.storage.service=aws-s3
# s3 bucket or azure container name
chaintest.storage.service.container-name=<bucket name>
To configure communication between the client & ChainLP with S3:
- Storage parameters need to be configured on both client-side and on ChainLP
- The client and ChainLP both use the AWS Credential Chain to authenticate against the bucket and store/access blob data
- For ChainLP, the secrets can be configured via
<host>/settingsby clicking theSecretstab which will set these parameters as System properties and ChainLP will create a presigned URL for each embed
ChainLP creates a presigned URL which is served to the frontend with a lifetime of 24 hours.
- Docker is not a requirement for any of the static reports (SimpleGenerator, EmailGenerator)
- Docker is required to host ChainLP as it is only available as a Docker image
Contributions are welcome. Please open an issue or submit a pull request.
ChainTest is open-source software and licensed under Apache-2.0.
