eventsourcing/es4j

Problem: writing test suites for es4j apps is difficult

Open

#122 opened on Jul 10, 2016

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (406 stars) (27 forks)batch import
help wanted

Description

Writing tests for es4j-powered apps is always a little bit of a hassle. To list a few issues:

  • making sure every test gets the proper clean slate setup
  • reducing the setup time
  • making it compact and DRY
  • (for some apps) a need to test against different journal and index engine backends.

Proposed solution: implement an eventsourcing-test module that will cover this.

Contributor guide

Tech stack
java
Domain
backendtesting
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
unclear
Prerequisites
Javaeventsourcing basicsunit testing concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
First, examine the existing codebase at https://github.com/eventsourcing/es4j to understand the current setup for testing and the eventsourcing framework. Look at files like src/test/java for patterns. Then, consider common issues mentioned: clean slate setup, setup time, DRY, and testing multiple backends. Research existing eventsourcing testing libraries (e.g., for Java) to inspire a design. The issue has no comments or linked PRs, so design a minimal test utility module that provides a base test class or runner for es4j applications. Start by outlining the API in a new module directory.