Migrate static analysis code from configkit.

config/aggregate_test.go

@@ -105,7 +105,7 @@ func TestAggregate(t *testing.T) {
 				Name: "nil aggregate",
 				Error: multiline(
 					`aggregate is invalid:`,
-					`  - could not evaluate entire configuration`,
+					`  - could not evaluate entire configuration: handler is nil`,
 					`  - no identity`,
 					`  - no handles-command routes`,
 					`  - no records-event routes`,

config/application_test.go

@@ -76,7 +76,7 @@ func TestApplication(t *testing.T) {
 				Name: "nil application",
 				Error: multiline(
 					`application is invalid:`,
-					`  - could not evaluate entire configuration`,
+					`  - could not evaluate entire configuration: application is nil`,
 					`  - no identity`,
 				),
 				Component: runtimeconfig.FromApplication(nil),

config/component.go

@@ -2,6 +2,9 @@ package config
 
 import (
 	"fmt"
+	"strings"
+
+	"github.com/dogmatiq/enginekit/config/internal/renderer"
 )
 
 // Component is the "top-level" interface for the individual elements that form
@@ -24,12 +27,12 @@ type ComponentCommon struct {
 	// not be evaluated at configuration time.
 	IsSpeculative bool
 
-	// IsPartial indicates that the configuration could not be loaded in its
-	// entirety. The configuration may be valid, but cannot be safely used to
-	// execute an application.
+	// IsPartialReasons is a list of reasons that the configuration could not be
+	// loaded in its entirety. The configuration may be valid, but cannot be
+	// safely used to execute an application.
 	//
-	// A value of false does not imply a complete configuration.
-	IsPartial bool
+	// An empty slice does not imply a complete or valid configuration.
+	IsPartialReasons []string
 }
 
 // ComponentProperties returns the properties common to all [Component] types.
@@ -40,8 +43,8 @@ func (p *ComponentCommon) ComponentProperties() *ComponentCommon {
 func validateComponent(ctx *validateContext) {
 	p := ctx.Component.ComponentProperties()
 
-	if p.IsPartial {
-		ctx.Invalid(PartialConfigurationError{})
+	if len(p.IsPartialReasons) != 0 {
+		ctx.Invalid(PartialConfigurationError{p.IsPartialReasons})
 	}
 
 	if ctx.Options.ForExecution && p.IsSpeculative {
@@ -63,16 +66,35 @@ func (e ConfigurationUnavailableError) Error() string {
 
 // PartialConfigurationError indicates that a [Component]'s configuration could
 // not be loaded in its entirety.
-type PartialConfigurationError struct{}
+type PartialConfigurationError struct {
+	Reasons []string
+}
 
 func (e PartialConfigurationError) Error() string {
-	return "could not evaluate entire configuration"
+	w := &strings.Builder{}
+	r := &renderer.Renderer{Target: w}
+
+	r.Print("could not evaluate entire configuration:")
+
+	if len(e.Reasons) == 1 {
+		r.Print(" ", e.Reasons[0])
+	} else if len(e.Reasons) > 1 {
+		for _, reason := range e.Reasons {
+			r.Print("\n")
+			r.StartChild()
+			r.Print(reason)
+			r.EndChild()
+		}
+	}
+
+	return w.String()
 }
 
 // SpeculativeConfigurationError indicates that a [Component]'s inclusion in the
 // configuration is subject to some condition that could not be evaluated at the
 // time the configuration was built.
-type SpeculativeConfigurationError struct{}
+type SpeculativeConfigurationError struct {
+}
 
 func (e SpeculativeConfigurationError) Error() string {
 	return "conditions for the component's inclusion in the configuration could not be evaluated"

config/describe.go

@@ -85,7 +85,7 @@ func hasError[T error](ctx *describeContext) bool {
 func (ctx *describeContext) DescribeFidelity() {
 	p := ctx.Component.ComponentProperties()
 
-	if p.IsPartial || hasError[PartialConfigurationError](ctx) || hasError[ConfigurationUnavailableError](ctx) {
+	if len(p.IsPartialReasons) != 0 || hasError[PartialConfigurationError](ctx) || hasError[ConfigurationUnavailableError](ctx) {
 		ctx.Print("incomplete ")
 	} else if !ctx.options.ValidationResult.IsPresent() {
 		ctx.Print("unvalidated ")

config/entity_test.go

@@ -53,7 +53,7 @@ func testEntity[
 		t.Run("it panics if the entity is partially configured", func(t *testing.T) {
 			entity := build(
 				func(b B) {
-					b.Partial()
+					b.Partial("<reason>")
 					b.Identity(
 						func(b *configbuilder.IdentityBuilder) {
 							b.Name("name")
@@ -65,7 +65,7 @@ func testEntity[
 
 			test.ExpectPanic(
 				t,
-				"could not evaluate entire configuration",
+				"could not evaluate entire configuration: <reason>",
 				func() {
 					entity.Identity()
 				},

config/handler_test.go

@@ -65,14 +65,14 @@ func testHandler[
 			handler := build(func(b B) {
 				b.Disabled(
 					func(b *configbuilder.FlagBuilder[Disabled]) {
-						b.Partial()
+						b.Partial("<reason>")
 					},
 				)
 			})
 
 			test.ExpectPanic(
 				t,
-				`flag:disabled is invalid: could not evaluate entire configuration`,
+				`flag:disabled is invalid: could not evaluate entire configuration: <reason>`,
 				func() {
 					handler.IsDisabled()
 				},

config/identity_test.go

@@ -63,14 +63,14 @@ func TestIdentity(t *testing.T) {
 			},
 			{
 				Name:  "partial",
-				Error: `identity:name/e6b691dd-731c-4c14-8e1c-1622381202dc is invalid: could not evaluate entire configuration`,
+				Error: `identity:name/e6b691dd-731c-4c14-8e1c-1622381202dc is invalid: could not evaluate entire configuration: <reason>`,
 				Component: &Identity{
 					// It's possibly non-sensical to have an identity that contains
 					// both it's name and key be considered incomplete, but this
 					// allows us to represent a case where the name and key are
 					// build dynamically and we don't have the _entire_ string.
 					ComponentCommon: ComponentCommon{
-						IsPartial: true,
+						IsPartialReasons: []string{"<reason>"},
 					},
 					Name: optional.Some("name"),
 					Key:  optional.Some("e6b691dd-731c-4c14-8e1c-1622381202dc"),

config/integration_test.go

@@ -92,7 +92,7 @@ func TestIntegration(t *testing.T) {
 				Name: "nil integration",
 				Error: multiline(
 					`integration is invalid:`,
-					`  - could not evaluate entire configuration`,
+					`  - could not evaluate entire configuration: handler is nil`,
 					`  - no identity`,
 					`  - no handles-command routes`,
 				),

config/internal/configbuilder/aggregate.go

@@ -1,6 +1,8 @@
 package configbuilder
 
 import (
+	"fmt"
+
 	"github.com/dogmatiq/dogma"
 	"github.com/dogmatiq/enginekit/config"
 )
@@ -47,8 +49,8 @@ func (b *AggregateBuilder) Disabled(fn func(*FlagBuilder[config.Disabled])) {
 }
 
 // Partial marks the compomnent as partially configured.
-func (b *AggregateBuilder) Partial() {
-	b.target.IsPartial = true
+func (b *AggregateBuilder) Partial(format string, args ...any) {
+	b.target.IsPartialReasons = append(b.target.IsPartialReasons, fmt.Sprintf(format, args...))
 }
 
 // Speculative marks the component as speculative.

config/internal/configbuilder/application.go

@@ -1,6 +1,8 @@
 package configbuilder
 
 import (
+	"fmt"
+
 	"github.com/dogmatiq/dogma"
 	"github.com/dogmatiq/enginekit/config"
 )
@@ -59,8 +61,8 @@ func (b *ApplicationBuilder) Projection(fn func(*ProjectionBuilder)) {
 }
 
 // Partial marks the compomnent as partially configured.
-func (b *ApplicationBuilder) Partial() {
-	b.target.IsPartial = true
+func (b *ApplicationBuilder) Partial(format string, args ...any) {
+	b.target.IsPartialReasons = append(b.target.IsPartialReasons, fmt.Sprintf(format, args...))
 }
 
 // Speculative marks the component as speculative.

config/internal/configbuilder/builder.go

@@ -7,10 +7,16 @@ import (
 	"github.com/dogmatiq/enginekit/optional"
 )
 
+// UntypedComponentBuilder is the interface for builders of some unknown
+// [config.Component] type.
+type UntypedComponentBuilder interface {
+	Partial(format string, args ...any)
+	Speculative()
+}
+
 // ComponentBuilder an interface for builders that produce a [config.Component].
 type ComponentBuilder[T config.Component] interface {
-	Partial()
-	Speculative()
+	UntypedComponentBuilder
 	Done() T
 }
 

config/internal/configbuilder/flag.go

@@ -1,6 +1,8 @@
 package configbuilder
 
 import (
+	"fmt"
+
 	"github.com/dogmatiq/enginekit/config"
 	"github.com/dogmatiq/enginekit/optional"
 )
@@ -23,8 +25,8 @@ func (b *FlagBuilder[S]) Value(v bool) {
 }
 
 // Partial marks the compomnent as partially configured.
-func (b *FlagBuilder[S]) Partial() {
-	b.target.IsPartial = true
+func (b *FlagBuilder[S]) Partial(format string, args ...any) {
+	b.target.IsPartialReasons = append(b.target.IsPartialReasons, fmt.Sprintf(format, args...))
 }
 
 // Speculative marks the component as speculative.

config/internal/configbuilder/identity.go

@@ -1,6 +1,8 @@
 package configbuilder
 
 import (
+	"fmt"
+
 	"github.com/dogmatiq/enginekit/config"
 	"github.com/dogmatiq/enginekit/optional"
 )
@@ -33,8 +35,8 @@ func (b *IdentityBuilder) Key(key string) {
 }
 
 // Partial marks the compomnent as partially configured.
-func (b *IdentityBuilder) Partial() {
-	b.target.IsPartial = true
+func (b *IdentityBuilder) Partial(format string, args ...any) {
+	b.target.IsPartialReasons = append(b.target.IsPartialReasons, fmt.Sprintf(format, args...))
 }
 
 // Speculative marks the component as speculative.

config/internal/configbuilder/integration.go

@@ -1,6 +1,8 @@
 package configbuilder
 
 import (
+	"fmt"
+
 	"github.com/dogmatiq/dogma"
 	"github.com/dogmatiq/enginekit/config"
 )
@@ -47,8 +49,8 @@ func (b *IntegrationBuilder) Disabled(fn func(*FlagBuilder[config.Disabled])) {
 }
 
 // Partial marks the compomnent as partially configured.
-func (b *IntegrationBuilder) Partial() {
-	b.target.IsPartial = true
+func (b *IntegrationBuilder) Partial(format string, args ...any) {
+	b.target.IsPartialReasons = append(b.target.IsPartialReasons, fmt.Sprintf(format, args...))
 }
 
 // Speculative marks the component as speculative.

config/internal/configbuilder/process.go

@@ -1,6 +1,8 @@
 package configbuilder
 
 import (
+	"fmt"
+
 	"github.com/dogmatiq/dogma"
 	"github.com/dogmatiq/enginekit/config"
 )
@@ -47,8 +49,8 @@ func (b *ProcessBuilder) Disabled(fn func(*FlagBuilder[config.Disabled])) {
 }
 
 // Partial marks the compomnent as partially configured.
-func (b *ProcessBuilder) Partial() {
-	b.target.IsPartial = true
+func (b *ProcessBuilder) Partial(format string, args ...any) {
+	b.target.IsPartialReasons = append(b.target.IsPartialReasons, fmt.Sprintf(format, args...))
 }
 
 // Speculative marks the component as speculative.

config/internal/configbuilder/projection.go

@@ -1,6 +1,8 @@
 package configbuilder
 
 import (
+	"fmt"
+
 	"github.com/dogmatiq/dogma"
 	"github.com/dogmatiq/enginekit/config"
 )
@@ -53,8 +55,8 @@ func (b *ProjectionBuilder) DeliveryPolicy(fn func(*ProjectionDeliveryPolicyBuil
 }
 
 // Partial marks the compomnent as partially configured.
-func (b *ProjectionBuilder) Partial() {
-	b.target.IsPartial = true
+func (b *ProjectionBuilder) Partial(format string, args ...any) {
+	b.target.IsPartialReasons = append(b.target.IsPartialReasons, fmt.Sprintf(format, args...))
 }
 
 // Speculative marks the component as speculative.

config/internal/configbuilder/projectiondeliverypolicy.go

@@ -1,6 +1,8 @@
 package configbuilder
 
 import (
+	"fmt"
+
 	"github.com/dogmatiq/dogma"
 	"github.com/dogmatiq/enginekit/config"
 	"github.com/dogmatiq/enginekit/optional"
@@ -46,8 +48,8 @@ func (b *ProjectionDeliveryPolicyBuilder) BroadcastToPrimaryFirst(v bool) {
 }
 
 // Partial marks the compomnent as partially configured.
-func (b *ProjectionDeliveryPolicyBuilder) Partial() {
-	b.target.IsPartial = true
+func (b *ProjectionDeliveryPolicyBuilder) Partial(format string, args ...any) {
+	b.target.IsPartialReasons = append(b.target.IsPartialReasons, fmt.Sprintf(format, args...))
 }
 
 // Speculative marks the component as speculative.

config/internal/configbuilder/route.go

@@ -1,6 +1,7 @@
 package configbuilder
 
 import (
+	"fmt"
 	"reflect"
 
 	"github.com/dogmatiq/dogma"
@@ -67,8 +68,8 @@ func (b *RouteBuilder) MessageType(t message.Type) {
 }
 
 // Partial marks the compomnent as partially configured.
-func (b *RouteBuilder) Partial() {
-	b.target.IsPartial = true
+func (b *RouteBuilder) Partial(format string, args ...any) {
+	b.target.IsPartialReasons = append(b.target.IsPartialReasons, fmt.Sprintf(format, args...))
 }
 
 // Speculative marks the component as speculative.

config/process_test.go

@@ -106,7 +106,7 @@ func TestProcess(t *testing.T) {
 				Name: "nil process",
 				Error: multiline(
 					`process is invalid:`,
-					`  - could not evaluate entire configuration`,
+					`  - could not evaluate entire configuration: handler is nil`,
 					`  - no identity`,
 					`  - no handles-event routes`,
 					`  - no executes-command routes`,

config/projection_test.go

@@ -103,7 +103,7 @@ func TestProjection(t *testing.T) {
 				Name: "nil projection",
 				Error: multiline(
 					`projection is invalid:`,
-					`  - could not evaluate entire configuration`,
+					`  - could not evaluate entire configuration: handler is nil`,
 					`  - no identity`,
 					`  - no handles-event routes`,
 				),
@@ -426,13 +426,13 @@ func TestProjection(t *testing.T) {
 		t.Run("it panics if the handler is partially configured", func(t *testing.T) {
 			handler := configbuilder.Projection(
 				func(b *configbuilder.ProjectionBuilder) {
-					b.Partial()
+					b.Partial("<reason>")
 				},
 			)
 
 			test.ExpectPanic(
 				t,
-				"could not evaluate entire configuration",
+				`could not evaluate entire configuration: <reason>`,
 				func() {
 					handler.DeliveryPolicy()
 				},