CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.18.1 - 2024-10-05

Changed

• Use enginekit/message instead of configkit/message.
• It is no longer possible to (mis-)use a single message type as both a pointer and a non-pointer. If a type implements dogma.Command, dogma.Event, or dogma.Timeout using pointer receivers then a pointer type must be used; otherwise, a non-pointer type must be used.

0.18.0 - 2024-10-03

Added

• Added Not() expectation, which negates a single expectation. Not() is functionally equivalent to using NoneOf() with a single argument, but produces more intuitive test reports.
• Added CommandValidationScope(), EventValidationScope(), and TimeoutValidationScope() to help when testing message validation logic.

0.17.2 - 2024-09-25

Fixed

• Fix argument type of ToRecordEvent() and ToRecordEventOfType().

0.17.1 - 2024-09-25

Fixed

• Fixed issue that caused an empty SUGGESTIONS section to be printed on test reports in some circumstances.
• ToExecuteCommandMatching(), ToOnlyExecuteCommandsMatching(), ToRecordEventMatching() and ToOnlyRecordEventsMatching() now properly report impossible assertions when the predicate's argument type is not a recognized message.

0.17.0 - 2024-08-21

Added

• Added ReportGenerationContext to hold information required when generating test reports.
• Added Test.Annotate() to add human-readable annotations to values within test reports.

Changed

• [BC] Changed Predicate.Report() to accept a ReportGenerationContext instead of individual arguments.

0.16.0 - 2024-08-17

Changed

• Bumped Dogma to v0.14.0, which involved removing any calls to the TimeoutHint() method on the handler interfaces, which has been removed.
• ToExecuteCommandMatching() and ToRecordEventMatching() now accept predicate functions with a more specific argument type than dogma.Command and dogma.Event, respectively. Any message that does not match the argument type of the predicate is ignored.
• ToOnlyExecuteCommandsMatching() and ToOnlyRecordEventsMatching() now accept predicate functions with a more specific argument type than dogma.Command and dogma.Event, respectively. Any message that does not match the argument type of the predicate is considered a failure.

Fixed

• Fixed poor wording of ToOnlyExecuteCommandsMatching() and ToOnlyRecordEventsMatching() failure reports when no messages were matched.
• Fixed a few swapped references to dogma.Command and dogma.Event which were aliases preior to Dogma v0.14.0.

0.15.4 - 2024-08-16

Added

• Added ToExecuteCommandType[T]() and ToRecordEventType[T]() expectations.

Deprecated

• Marked ToExecuteCommandOfType() and ToRecordEventOfType() as deprecated. These functions will be removed in a future release; use the new generic versions instead.

0.15.3 - 2024-08-16

Changed

• Use dogma.Command, Event and Timeout interfaces instead of dogma.Message where appropriate.

Fixed

• Supress rendering of explanation and suggestions in test reports when a failed expectation is negated by NoneOf() (thanks @sameaste92).

0.15.2 - 2024-07-24

Fixed

• Fixed log messages about disabled handlers to properly indicate why they are disabled.

0.15.1 - 2024-07-16

Added

• Added support for Disable() method in dogmatiq/dogma v0.13.1.

0.15.0 - 2024-03-26

Added

• Added Test.EnableHandlersLike() and DisableHandlersLike(), which enable/disable any handler with a name matches at least one of a given set of regular expressions.

Changed

• [BC] Test.EnableHandlers() and DisableHandlers() will now panic when called with names of handlers that do not exist.

0.14.0 - 2024-03-26

This release updates the testkit implementation to adhere to Dogma v0.13.0 interfaces.

Removed

• [BC] Removed Test.EventRecorder().
• [BC] Removed EventRecorder.
• [BC] Removed EventRecorderInterceptor and InterceptEventRecorder().
• [BC] Removed engine.EventRecorder.
• [BC] Removed ActionScope.EventRecorder.

0.13.12 - 2024-03-05

Changed

• Improved wording of "empty instance ID" error message.

Fixed

• Fixed issue that caused internal/mangled names of anonymous functions to be rendered in test reports on some platforms.

0.13.11 - 2023-04-09

This release updates the testkit implementation to adhere to Dogma v0.12.0 interfaces.

0.13.10 - 2023-03-27

Added

• Added MessageDescription method to internal test messages in preparation for it becoming mandatory.

0.13.9 - 2023-01-06

Changed

• Bumped dogmatiq/linger to v1.0.0

0.13.8 - 2022-08-07

Changed

• Bumped dogmatiq/dogma to v0.4.4 to gain support for dapper.Stringer

0.13.7 - 2022-01-24

Fixed

• Fix malformed panic message in engine.CommandExecutor and EventRecorder when passed an unrecognized message

0.13.6 - 2021-04-28

Fixed

• Fix issue rendering Protocol Buffers diffs by upgrading to dogmatiq/dapper v0.4.3

0.13.5 - 2021-04-26

Added

• Add InterceptCommandExecutor() and InterceptEventRecorder() options
• Add functional options to Call(), see CallOption

0.13.4 - 2021-04-22

Changed

• Hide unexported struct fields in message diffs

0.13.3 - 2021-04-22

Added

• Add WithMessageComparator() for specifying custom message comparison behavior within a test
• Add DefaultMessageComparator(), the default comparator, with support for protocol buffers messages

0.13.2 - 2021-04-16

Added

• Add ToOnlyExecuteCommandsMatching() and ToOnlyRecordEventsMatching() expectations

0.13.1 - 2021-04-13

Added

• Add ToExecuteCommandMatching() and ToRecordEventMatching() expectations
• Add ToRepeatedly() expectation

0.13.0 - 2021-03-01

Changed

• [BC] Updated to Dogma to v0.11.0

0.12.0 - 2020-12-20

This release includes several changes to the underlying action and expectation systems, some of which are not backwards compatable. Tests written using v0.11.0 should continue to work without modification.

Added

• [BC] Add PredicateOptions to PredicateScope
• [BC] Add Action.Location() method

Changed

• [BC] Renamed Action.Apply() to Do()
• Test.Expect() now returns the Test, allowing chained calls

Removed

• [BC] Removed the PredicateOptions parameter from Expectation.Predicate()

0.11.0 - 2020-11-27

This release includes extensive changes to the testing API. It formalizes the concepts of "actions" and "expectations" with the goal of a more consistent API and a greater level of extensibility.

Despite the large number of backwards incompatible changes it is relatively simple to migrate existing tests to the new API. Please see the migration guide for detailed instructions.

Testing API

Added

• Add Begin() and BeginContext() functions, used to start a new Test
• Add ExecuteCommand(), RecordEvent(), AdvanceTime() and Call() functions
• Add Expect() method to Test
• Add EnableHandlers() and DisableHandlers() methods to Test
• Add TimeAdjuster interface, for use with AdvanceTime()
• Add Action and ActionScope types
• Add Expectation, Predicate, PredicateScope and PredicateOptions types
• [BC] Add Failed(), Fatal() and Helper() to the TestingT interface

Changed

• [BC] Test.Prepare() now accepts ...Action (previously ...dogma.Message)
• [BC] The function passed to Call() no longer returns an error
• [BC] Rename WithStartTime() to StartTimeAt()
• [BC] Rename WithOperationOptions() to WithUnsafeOperationOptions()
• [BC] Move assert.AllOf(), AnyOf() and NoneOf() to the testkit package
• [BC] Move assert.Should(), to testkit.ToSatisfy()
• [BC] Move assert.CommandExecuted(), to testkit.ToExecuteCommand()
• [BC] Move assert.CommandTypeExecuted(), to testkit.ToExecuteCommandOfType()
• [BC] Move assert.EventExecuted(), to testkit.ToRecordEvent()
• [BC] Move assert.EventTypeExecuted(), to testkit.ToRecordEventOfType()

Removed

• [BC] Remove the Runner type and New() which constructed it
• [BC] Remove ExecuteCommand(), RecordEvent(), AdvanceTime() and Call() methods from Test
• [BC] Remove TimeAdvancer function (replaced with TimeAdjustment interface)
• [BC] Remove WithEngineOptions()
• [BC] Remove the assert package
• [BC] Remove the compare package
• [BC] Remove the render package

Engine

Added

• Add EnableHandler() operation option

Changed

• [BC] engine.New() and MustNew() now require a configkit.RichApplication
• [BC] Moved the engine/fact package to fact
• [BC] Moved the engine/envelope package to envelope

Removed

• [BC] Remove the engine/controller package

Fixed

• Engine.Tick() now properly ignores disabled handlers

0.10.0 - 2020-11-16

Changed

• [BC] Updated to Dogma to v0.10.0

Added

• Add support for projection compaction

Fixed

• Fix issue where engine operation options were not taking precedence over test options

0.9.0 - 2020-11-06

Changed

• [BC] Updated to Dogma to v0.9.0

0.8.1 - 2020-11-04

Added

• Add engine.MustNew()

0.8.0 - 2020-11-03

Changed

• [BC] Remove aggregate Create() and Exists() methods (complies with Dogma v0.8.0)

0.7.0 - 2020-11-02

Added

• Add Test.AdvanceTime(), ByDuration() and ToTime()
• Add Test.Call()
• Add assert.Nothing
• Add engine.CommandExecutor
• Add engine.EventRecorder
• [BC] Add op parameter to assert.Assertion.Begin()

Removed

• [BC] Remove Test.AdvanceTimeTo() and AdvanceTimeBy()
• [BC] Remove verbose parameter assert.Assertion.BuildReport()
• [BC] Remove RunnerVerbose() and Verbose() options
• [BC] Remove Engine.ExecuteCommand() and RecordEvent()

Changed

• The -v (verbose) option to go test no longer affects testkit's behavior, full logs are always rendered

0.6.2 - 2020-10-19

Changed

• Test.AdvanceTimeBy() and AdvanceTimeTo() can now be called without making any assertions by passing a nil assertion

0.6.1 - 2020-10-19

Added

• Add Exists() and HasBegun() methods to aggregate & process scopes

0.6.0 - 2020-06-12

Changed

• [BC] Renamed T to TestingT, to avoid conflicts with *testing.T when dot-importing
• [BC] Renamed assert.T to S, to avoid conflicts with *testing.T when dot-importing

0.5.0 - 2020-06-11

Added

• [BC] Add assert.Assertion.End()
• Add engine.Run() and RunTimeScaled()
• engine.Engine now protects its internal state with a mutex, allowing concurrent use

Changed

• [BC] assert.Should() now provides an assert.T to the user instead of checking the error return value
• [BC] Rename assert.Assertion.Prepare() to Begin()
• [BC] Add verbose parameter to assert.Assertion.BuildReport()

0.4.0 - 2020-02-04

Added

• Add assert.Should() for specifying user-defined assertions

Changed

• [BC] Switched from enginekit to configkit for application configurations
• [BC] Flatten fields from Envelope.Correlation directly into Envelope
• Test logs and assertion reports now display the file and line number of the test operation

Removed

• [BC] Removed the assert.CompositeAssertion type
• [BC] Removed the assert.MessageAssertion type
• [BC] Removed the assert.MessageTypeAssertion type

Fixed

• assert.CommandExecuted() now renders the correct suggestions when it fails due to mismatched message role

0.3.0 - 2019-10-31

Changed

• Updated EngineKit to v0.8.0

0.2.0 - 2019-10-21

Changed

• [BC] Rename StartTime() option to WithStartTime() for consistency

0.1.1 - 2019-10-18

Added

• Add StartTime() test option to configure the initial time of the test clock

0.1.0 - 2019-08-01

• Initial release