|
| 1 | +//go:build !integration |
| 2 | + |
| 3 | +package workflow |
| 4 | + |
| 5 | +import ( |
| 6 | + "testing" |
| 7 | + |
| 8 | + "github.com/github/gh-aw/pkg/constants" |
| 9 | + "github.com/stretchr/testify/assert" |
| 10 | + "github.com/stretchr/testify/require" |
| 11 | +) |
| 12 | + |
| 13 | +// TestNewEngineCatalog_BuiltIns checks that all four built-in engines are registered |
| 14 | +// and resolve to the expected runtime adapters. |
| 15 | +func TestNewEngineCatalog_BuiltIns(t *testing.T) { |
| 16 | + registry := NewEngineRegistry() |
| 17 | + catalog := NewEngineCatalog(registry) |
| 18 | + |
| 19 | + tests := []struct { |
| 20 | + engineID string |
| 21 | + displayName string |
| 22 | + provider string |
| 23 | + }{ |
| 24 | + {"claude", "Claude Code", "anthropic"}, |
| 25 | + {"codex", "Codex", "openai"}, |
| 26 | + {"copilot", "GitHub Copilot CLI", "github"}, |
| 27 | + {"gemini", "Google Gemini CLI", "google"}, |
| 28 | + } |
| 29 | + |
| 30 | + for _, tt := range tests { |
| 31 | + t.Run(tt.engineID, func(t *testing.T) { |
| 32 | + resolved, err := catalog.Resolve(tt.engineID, &EngineConfig{ID: tt.engineID}) |
| 33 | + require.NoError(t, err, "expected %s to resolve without error", tt.engineID) |
| 34 | + require.NotNil(t, resolved, "expected non-nil ResolvedEngineTarget for %s", tt.engineID) |
| 35 | + |
| 36 | + assert.Equal(t, tt.engineID, resolved.Definition.ID, "Definition.ID should match") |
| 37 | + assert.Equal(t, tt.displayName, resolved.Definition.DisplayName, "Definition.DisplayName should match") |
| 38 | + assert.Equal(t, tt.provider, resolved.Definition.Provider.Name, "Definition.Provider.Name should match") |
| 39 | + assert.Equal(t, tt.engineID, resolved.Runtime.GetID(), "Runtime.GetID() should match engine ID") |
| 40 | + }) |
| 41 | + } |
| 42 | +} |
| 43 | + |
| 44 | +// TestEngineCatalog_Resolve_LegacyStringFormat verifies that resolving via plain string |
| 45 | +// ("engine: claude") and object ID format ("engine.id: claude") produce the same runtime. |
| 46 | +func TestEngineCatalog_Resolve_LegacyStringFormat(t *testing.T) { |
| 47 | + registry := NewEngineRegistry() |
| 48 | + catalog := NewEngineCatalog(registry) |
| 49 | + |
| 50 | + // Simulate "engine: claude" — EngineConfig built from string |
| 51 | + stringConfig := &EngineConfig{ID: "claude"} |
| 52 | + resolvedString, err := catalog.Resolve("claude", stringConfig) |
| 53 | + require.NoError(t, err, "string-format engine should resolve without error") |
| 54 | + |
| 55 | + // Simulate "engine:\n id: claude" — same logical ID |
| 56 | + objectConfig := &EngineConfig{ID: "claude"} |
| 57 | + resolvedObject, err := catalog.Resolve("claude", objectConfig) |
| 58 | + require.NoError(t, err, "object-format engine should resolve without error") |
| 59 | + |
| 60 | + assert.Equal(t, resolvedString.Runtime.GetID(), resolvedObject.Runtime.GetID(), |
| 61 | + "both formats should resolve to the same runtime adapter") |
| 62 | + assert.Equal(t, resolvedString.Definition.ID, resolvedObject.Definition.ID, |
| 63 | + "both formats should resolve to the same definition") |
| 64 | +} |
| 65 | + |
| 66 | +// TestEngineCatalog_Resolve_PrefixFallback verifies backward-compat prefix matching |
| 67 | +// (e.g. "codex-experimental" should resolve to the codex runtime). |
| 68 | +func TestEngineCatalog_Resolve_PrefixFallback(t *testing.T) { |
| 69 | + registry := NewEngineRegistry() |
| 70 | + catalog := NewEngineCatalog(registry) |
| 71 | + |
| 72 | + resolved, err := catalog.Resolve("codex-experimental", &EngineConfig{ID: "codex-experimental"}) |
| 73 | + require.NoError(t, err, "prefix-matched engine should resolve without error") |
| 74 | + require.NotNil(t, resolved, "expected non-nil ResolvedEngineTarget for prefix match") |
| 75 | + |
| 76 | + assert.Equal(t, "codex", resolved.Runtime.GetID(), "prefix match should resolve to codex runtime") |
| 77 | +} |
| 78 | + |
| 79 | +// TestEngineCatalog_Resolve_UnknownEngine verifies that unknown engine IDs return a |
| 80 | +// descriptive validation error containing the engine ID, a list of valid engines, and |
| 81 | +// the documentation URL. |
| 82 | +func TestEngineCatalog_Resolve_UnknownEngine(t *testing.T) { |
| 83 | + registry := NewEngineRegistry() |
| 84 | + catalog := NewEngineCatalog(registry) |
| 85 | + |
| 86 | + _, err := catalog.Resolve("nonexistent-engine", &EngineConfig{ID: "nonexistent-engine"}) |
| 87 | + require.Error(t, err, "unknown engine should return an error") |
| 88 | + assert.Contains(t, err.Error(), "invalid engine", |
| 89 | + "error should mention 'invalid engine', got: %s", err.Error()) |
| 90 | + assert.Contains(t, err.Error(), "nonexistent-engine", |
| 91 | + "error should mention the unknown engine ID, got: %s", err.Error()) |
| 92 | + assert.Contains(t, err.Error(), string(constants.DocsEnginesURL), |
| 93 | + "error should include the engines documentation URL, got: %s", err.Error()) |
| 94 | + assert.Contains(t, err.Error(), "engine: copilot", |
| 95 | + "error should include an example, got: %s", err.Error()) |
| 96 | +} |
| 97 | + |
| 98 | +// TestEngineCatalog_Resolve_ConfigPassthrough verifies that the EngineConfig passed to |
| 99 | +// Resolve is surfaced unchanged in the ResolvedEngineTarget. |
| 100 | +func TestEngineCatalog_Resolve_ConfigPassthrough(t *testing.T) { |
| 101 | + registry := NewEngineRegistry() |
| 102 | + catalog := NewEngineCatalog(registry) |
| 103 | + |
| 104 | + cfg := &EngineConfig{ID: "copilot", Model: "gpt-4o", MaxTurns: "10"} |
| 105 | + resolved, err := catalog.Resolve("copilot", cfg) |
| 106 | + require.NoError(t, err, "copilot with config should resolve without error") |
| 107 | + assert.Equal(t, cfg, resolved.Config, "resolved Config should be the same pointer passed in") |
| 108 | +} |
| 109 | + |
| 110 | +// TestEngineCatalog_Register_Custom verifies that a custom engine definition can be |
| 111 | +// registered and resolved via the catalog. |
| 112 | +func TestEngineCatalog_Register_Custom(t *testing.T) { |
| 113 | + registry := NewEngineRegistry() |
| 114 | + // Register a test engine in the registry so the catalog can look it up |
| 115 | + registry.Register(NewCopilotEngine()) // reuse copilot as the backing runtime |
| 116 | + |
| 117 | + catalog := NewEngineCatalog(registry) |
| 118 | + catalog.Register(&EngineDefinition{ |
| 119 | + ID: "my-custom-engine", |
| 120 | + DisplayName: "My Custom Engine", |
| 121 | + Description: "A custom engine for testing", |
| 122 | + RuntimeID: "copilot", // backed by copilot runtime |
| 123 | + Provider: ProviderSelection{Name: "custom"}, |
| 124 | + }) |
| 125 | + |
| 126 | + resolved, err := catalog.Resolve("my-custom-engine", &EngineConfig{ID: "my-custom-engine"}) |
| 127 | + require.NoError(t, err, "custom engine should resolve without error") |
| 128 | + assert.Equal(t, "my-custom-engine", resolved.Definition.ID, "custom engine definition ID should match") |
| 129 | + assert.Equal(t, "copilot", resolved.Runtime.GetID(), "custom engine should use copilot runtime") |
| 130 | +} |
0 commit comments