Add panicx package.

CHANGELOG.md

@@ -28,6 +28,7 @@ migrate tests from prior versions.
 - Add `TimeAdjuster` interface, for use with `AdvanceTime()`
 - Add `engine.EnableHandler()`
 - Add `Test.EnableHandlers()` and `DisableHandlers()`
+- Add `panicx.Location`
 - **[BC]** Add `TestingT.Failed()`, `Fatal()` and `Helper()` methods
 
 ### Changed
@@ -37,6 +38,7 @@ migrate tests from prior versions.
 - **[BC]** `engine.New()` and `MustNew()` now accept `configkit.RichApplication` (previously `dogma.Application`)
 - **[BC]** Rename `WithStartTime()` to `StartTimeAt()`
 - **[BC]** Rename `WithOperationOptions()` to `WithUnsafeOperationOptions()`
+- **[BC]** Move `controller.ConvertUnexpectedMessagePanic()` to `panicx.EnrichUnexpectedMessage()`
 
 ### Removed
 

engine/controller/aggregate/controller.go

@@ -7,9 +7,9 @@ import (
 
 	"github.com/dogmatiq/configkit"
 	"github.com/dogmatiq/configkit/message"
-	"github.com/dogmatiq/testkit/engine/controller"
 	"github.com/dogmatiq/testkit/engine/envelope"
 	"github.com/dogmatiq/testkit/engine/fact"
+	"github.com/dogmatiq/testkit/engine/panicx"
 )
 
 // Controller is an implementation of engine.Controller for
@@ -46,7 +46,7 @@ func (c *Controller) Handle(
 	env.Role.MustBe(message.CommandRole)
 
 	var id string
-	controller.ConvertUnexpectedMessagePanic(
+	panicx.EnrichUnexpectedMessage(
 		c.Config,
 		"AggregateMessageHandler",
 		"RouteCommandToInstance",
@@ -75,7 +75,7 @@ func (c *Controller) Handle(
 
 	if exists {
 		for _, env := range history {
-			controller.ConvertUnexpectedMessagePanic(
+			panicx.EnrichUnexpectedMessage(
 				c.Config,
 				"AggregateRoot",
 				"ApplyEvent",
@@ -111,7 +111,7 @@ func (c *Controller) Handle(
 		command:    env,
 	}
 
-	controller.ConvertUnexpectedMessagePanic(
+	panicx.EnrichUnexpectedMessage(
 		c.Config,
 		"AggregateMessageHandler",
 		"HandleCommand",

engine/controller/aggregate/scope.go

@@ -6,9 +6,9 @@ import (
 
 	"github.com/dogmatiq/configkit"
 	"github.com/dogmatiq/dogma"
-	"github.com/dogmatiq/testkit/engine/controller"
 	"github.com/dogmatiq/testkit/engine/envelope"
 	"github.com/dogmatiq/testkit/engine/fact"
+	"github.com/dogmatiq/testkit/engine/panicx"
 )
 
 // scope is an implementation of dogma.AggregateCommandScope.
@@ -72,7 +72,7 @@ func (s *scope) RecordEvent(m dogma.Message) {
 		s.exists = true
 	}
 
-	controller.ConvertUnexpectedMessagePanic(
+	panicx.EnrichUnexpectedMessage(
 		s.config,
 		"AggregateRoot",
 		"ApplyEvent",

engine/controller/integration/controller.go

@@ -6,9 +6,9 @@ import (
 
 	"github.com/dogmatiq/configkit"
 	"github.com/dogmatiq/configkit/message"
-	"github.com/dogmatiq/testkit/engine/controller"
 	"github.com/dogmatiq/testkit/engine/envelope"
 	"github.com/dogmatiq/testkit/engine/fact"
+	"github.com/dogmatiq/testkit/engine/panicx"
 )
 
 // Controller is an implementation of engine.Controller for
@@ -43,7 +43,7 @@ func (c *Controller) Handle(
 	env.Role.MustBe(message.CommandRole)
 
 	var t time.Duration
-	controller.ConvertUnexpectedMessagePanic(
+	panicx.EnrichUnexpectedMessage(
 		c.Config,
 		"IntegrationMessageHandler",
 		"TimeoutHint",
@@ -68,7 +68,7 @@ func (c *Controller) Handle(
 	}
 
 	var err error
-	controller.ConvertUnexpectedMessagePanic(
+	panicx.EnrichUnexpectedMessage(
 		c.Config,
 		"IntegrationMessageHandler",
 		"HandleCommand",

engine/controller/process/controller.go

@@ -9,9 +9,9 @@ import (
 	"github.com/dogmatiq/configkit"
 	"github.com/dogmatiq/configkit/message"
 	"github.com/dogmatiq/dogma"
-	"github.com/dogmatiq/testkit/engine/controller"
 	"github.com/dogmatiq/testkit/engine/envelope"
 	"github.com/dogmatiq/testkit/engine/fact"
+	"github.com/dogmatiq/testkit/engine/panicx"
 )
 
 // Controller is an implementation of engine.Controller for
@@ -66,7 +66,7 @@ func (c *Controller) Handle(
 	env.Role.MustBe(message.EventRole, message.TimeoutRole)
 
 	var t time.Duration
-	controller.ConvertUnexpectedMessagePanic(
+	panicx.EnrichUnexpectedMessage(
 		c.Config,
 		"ProcessMessageHandler",
 		"TimeoutHint",
@@ -169,7 +169,7 @@ func (c *Controller) routeEvent(
 		ok  bool
 		err error
 	)
-	controller.ConvertUnexpectedMessagePanic(
+	panicx.EnrichUnexpectedMessage(
 		c.Config,
 		"ProcessMessageHandler",
 		"RouteEventToInstance",
@@ -230,7 +230,7 @@ func (c *Controller) handle(ctx context.Context, s *scope) error {
 	}
 
 	var err error
-	controller.ConvertUnexpectedMessagePanic(
+	panicx.EnrichUnexpectedMessage(
 		c.Config,
 		"ProcessMessageHandler",
 		method,

engine/controller/projection/controller.go

@@ -6,9 +6,9 @@ import (
 
 	"github.com/dogmatiq/configkit"
 	"github.com/dogmatiq/configkit/message"
-	"github.com/dogmatiq/testkit/engine/controller"
 	"github.com/dogmatiq/testkit/engine/envelope"
 	"github.com/dogmatiq/testkit/engine/fact"
+	"github.com/dogmatiq/testkit/engine/panicx"
 )
 
 // CompactInterval is how frequently projections should be compacted.
@@ -76,7 +76,7 @@ func (c *Controller) Handle(
 	handler := c.Config.Handler()
 
 	var t time.Duration
-	controller.ConvertUnexpectedMessagePanic(
+	panicx.EnrichUnexpectedMessage(
 		c.Config,
 		"ProjectionMessageHandler",
 		"TimeoutHint",
@@ -145,7 +145,7 @@ func (c *Controller) Handle(
 	}
 
 	var ok bool
-	controller.ConvertUnexpectedMessagePanic(
+	panicx.EnrichUnexpectedMessage(
 		c.Config,
 		"ProjectionMessageHandler",
 		"HandleEvent",

engine/panicx/doc.go

@@ -0,0 +1,3 @@
+// Package panicx contains utilities for providing meaningful contexts to panics
+// that occur with the engine.
+package panicx

engine/panicx/ginkgo_test.go

@@ -0,0 +1,15 @@
+package panicx_test
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/onsi/ginkgo"
+	"github.com/onsi/gomega"
+)
+
+func TestSuite(t *testing.T) {
+	type tag struct{}
+	gomega.RegisterFailHandler(ginkgo.Fail)
+	ginkgo.RunSpecs(t, reflect.TypeOf(tag{}).PkgPath())
+}