ChainTest

A comprehensive reporting framework supporting multiple generators - static, email & realtime, historical analytics with ChainLP.

Generators

• Simple: Dark | Light
• Email: Sample
• ChainLP: https://chaintest.onrender.com/

What is a ChainTest generator?

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.

How to enable generators?

ChainTest is still in active development, and 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.

Supported Test Frameworks

• junit5
• cucumber-jvm
• testng
• pytest (in progress)

ChainLP

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

ChainLP config

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>

Screenshots/Embeds

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.

For embeds to work with ChainLP, the client requires the following to be enabled:

# storage
chaintest.storage.service.enabled=true
# [azure-blob, aws-s3]
chaintest.storage.service=azure-blob
# s3 bucket or azure container name
chaintest.storage.service.container-name=

There is still some work to be done within this area but a few quick pointers if you're ready to explore further:

• Storage has been tested to work with both azure-blob and aws-s3 if the bucket or container are public access enabled
• For buckets/containers requiring auth, support for AWS S3 has been completed, and also supports pre-signed URLs when served to the frontend
• Azure Blob is not fully supported (yet)
• 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>/settings by clicking the Secrets tab

Is Docker required for all ChainTest reports?

• 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

When is Docker required for ChainTest?

In ChainTest's context, Docker is required only if setting up ChainLP given one or more of the below requirements:

• Comprehensive Dashboard: Ideal for generating historical analytics and consolidating multiple project reports in one place.
• Quick Setup: If you want to avoid manually setting up dependencies, Docker provides a pre-configured environment.
• Consistency: Ensures that the application runs the same way across different systems without dependency conflicts.
• Testing Complete Functionality: If you want to test the entire ChainTest environment with all its features (not just static report generation), Docker simplifies the setup.

Contributing

Contributions are welcome. Please open an issue or submit a pull request.

License

ChainTest is open-source software and licensed under Apache-2.0.