dogmatiq / dogmatiq/testkit

Allow the user to provide "describers" on a per-handler basis.

Open
#202 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
1
Forks
1
Avg merge
2m
Merged PRs (30d)
1

Description

It might be useful if the user could provide a function that can describe the current state of a projection (or perhaps any other handler) so that it can be observed when a test fails and/or between each engine dispatch/tick.

I am not sure how much merit this idea has; specifically, I wouldn't want devs to spend forever writing and updating code that exports SQL database state in a human readable format. For SQL projectionkit could help with that, but obviously projections are not limited to any particular storage technology.

This is also potentially a LOT of data, possibly too much to include in an expectation report, but I suppose it could be written to disk and the expectation report could print the file location. Another option would be to reimplement some kind of verbose option.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by tracing how handlers, projections, engine dispatch/ticks, and expectation reports are represented, then compare the proposed per-handler describer with the verbose option and output-to-disk ideas. Done requires an agreed design and documented behavior for describing handler state without imposing a storage format.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
testing-qa
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.