cjscommonplatform / domain-test-dsl Goto Github PK

There have been reports of problems passing lists of POJOs to the aggregate method. We need to:

• Test that if you have a List method argument that the wrapper can correctly find the right method based on the input JSON
• Check that nested POJO classes work (eg, an argument that takes a POJO that in turn has another POJO as a field
• Consider other POJO deserialisation cases and talk to the other teams about what might not work.

If an aggregate generates data (eg, creates a UUID or the current timestamp) and uses those values in an expected event, then we cannot match against the expected event because an exact match is done between the expected and actual events.

We need to add support for specifying a wildcard in the expected event data to support this scenario.

If a "Then" (or subsequent "And") does not match an event, it should report what event (if any) was found instead of the one expected. Currently, if no event is found, the following stack trace is emitted instead:

Then hearing allocated for listing # DomainTestSteps.previous_events(String)
java.lang.IndexOutOfBoundsException: Index: 0, Size: 0
at java.util.LinkedList.checkElementIndex(LinkedList.java:555)
at java.util.LinkedList.get(LinkedList.java:476)
at uk.gov.justice.services.test.domain.DomainTestSteps.assert_events_generated(DomainTestSteps.java:54)
at uk.gov.justice.services.test.domain.DomainTestSteps.previous_events(DomainTestSteps.java:32)
at ✽.Then hearing allocated for listing(allocate-hearing.feature:28)

Currently, if a field is omitted from the argument JSON that is used to create the arguments passed to the aggregate method, because it is not a required field, then the aggregate wrapper fails to find the matching method.

We need to expand the code that finds a matching method so that if it doesn't find an exact match it looks for methods that take additional optionals.

We should discuss whether this should be expanded to pass nulls for unmatched parameters, or whether to insist on optionals.

Add support to allow multiple events to be listed in a JSON array in an input or output file. It should act as though the events were listed explicitly in the Given or Then.

Currently we support When clauses such as:

When you doSomething to an ExampleAggregate

We would like to make the "to" (and other similar words) optional, so we can support:

When you something an ExampleAggregate

We would also like to update the joingin words that are used with the method arguments in the When clause, so that the "a|an" is not mandatory and to additionally support "some":

When you doSomething to an ExampleAggregate using a turnip
When you doSomething to an ExampleAggregate using some turnips
When you doSomething to an ExampleAggregate using turnips

• Allow whitespace between events names and commas.
• Remove the "there are previous events" text for the Given clause. We would just list the event names
• Add support for "nothing happens" (ie, no events) in the Then clause
• Update When definition to support "When (you) something (to|from|on|in) (a|an) Thing (using|with) (a|an) (*)" with then last three bits optional. eg, "When you addIngredients to a Recipe using an empty list" would load a file called "empty-list.json" to use as the parameters
• Remove "the" from Then
• Add support for methods with no parameters in the When clause.
• Add support for unqualified aggregate class names. eg, "When you addIngredients to a Recipe" should classpath scan for a class called Reciepe that implements the Aggregate interface.
• Add support for leaving out dashes from filenames, and add them programmaticly when trying to load the specified file. eg, "Given cake ordered" will load an event file calledcake-ordered.json
• Add support for the "And" operation for specifying multiple Given and Then clauses as well as supporting commas,
• Add support for "with" in Given and Then. eg: "Given cake ordered with unknown cake" should look for an event JSON file called cake-ordered-with-unknown-cake.json. We may add other phrases as well as "with" to expand this vocabulary. Using these words to separate the event name from a qualifier will make syntax highlighting clearer.

Comma separated events appear to work, but events listed with "And"s do not get applied prior to the action method being called on the aggregate