File size: 18,509 Bytes
e089492 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 | package shellconfig
import (
"context"
"encoding/json"
"os"
"path/filepath"
"testing"
"time"
"github.com/charmbracelet/crush/internal/shell"
"github.com/charmbracelet/crush/internal/version"
"github.com/stretchr/testify/require"
)
// TestLoadShellConfig_Provider verifies that the provider builtin produces
// correct JSON for a basic provider definition.
func TestLoadShellConfig_Provider(t *testing.T) {
dir := t.TempDir()
script := `provider add openai --api-key "$OPENAI_API_KEY" --base-url "https://api.openai.com/v1"`
path := filepath.Join(dir, "crushrc")
t.Setenv("OPENAI_API_KEY", "test-key-123")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
require.NotNil(t, jsonBytes)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
providers, ok := result["providers"].(map[string]any)
require.True(t, ok)
openai, ok := providers["openai"].(map[string]any)
require.True(t, ok)
require.Equal(t, "test-key-123", openai["api_key"])
require.Equal(t, "https://api.openai.com/v1", openai["base_url"])
}
// TestLoadShellConfig_FlagBoolCaseInsensitive verifies that flag booleans
// accept mixed-case values like TRUE/False.
func TestLoadShellConfig_FlagBoolCaseInsensitive(t *testing.T) {
t.Parallel()
dir := t.TempDir()
script := `provider add openai --api-key key --disable TRUE`
path := filepath.Join(dir, "crushrc")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
openai := result["providers"].(map[string]any)["openai"].(map[string]any)
require.Equal(t, true, openai["disable"])
}
// TestLoadShellConfig_MultipleProviders verifies that multiple provider calls
// each produce separate entries.
func TestLoadShellConfig_MultipleProviders(t *testing.T) {
t.Parallel()
dir := t.TempDir()
script := `provider add openai --api-key "key1"
provider add anthropic --api-key "key2"`
path := filepath.Join(dir, "crushrc")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
providers := result["providers"].(map[string]any)
require.Len(t, providers, 2)
require.Equal(t, "key1", providers["openai"].(map[string]any)["api_key"])
require.Equal(t, "key2", providers["anthropic"].(map[string]any)["api_key"])
}
// TestLoadShellConfig_Model verifies the model builtin.
func TestLoadShellConfig_Model(t *testing.T) {
t.Parallel()
dir := t.TempDir()
script := `model large openai/gpt-4o --think
model small anthropic/claude-3-5-haiku`
path := filepath.Join(dir, "crushrc")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
models := result["models"].(map[string]any)
large := models["large"].(map[string]any)
require.Equal(t, "openai", large["provider"])
require.Equal(t, "gpt-4o", large["model"])
require.Equal(t, true, large["think"])
small := models["small"].(map[string]any)
require.Equal(t, "anthropic", small["provider"])
require.Equal(t, "claude-3-5-haiku", small["model"])
}
// TestLoadShellConfig_MCP verifies the mcp builtin with stdio and http types.
func TestLoadShellConfig_MCP(t *testing.T) {
t.Parallel()
dir := t.TempDir()
script := `mcp add github --type stdio --command npx --args "-y" --args "@modelcontextprotocol/server-github" --env GITHUB_TOKEN "ghp_xxx"
mcp add local-server --type http --url "http://localhost:3000/mcp" --header "Authorization" "Bearer token"`
path := filepath.Join(dir, "crushrc")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
mcps := result["mcp"].(map[string]any)
github := mcps["github"].(map[string]any)
require.Equal(t, "stdio", github["type"])
require.Equal(t, "npx", github["command"])
args := github["args"].([]any)
require.Len(t, args, 2)
require.Equal(t, "-y", args[0])
require.Equal(t, "@modelcontextprotocol/server-github", args[1])
env := github["env"].(map[string]any)
require.Equal(t, "ghp_xxx", env["GITHUB_TOKEN"])
local := mcps["local-server"].(map[string]any)
require.Equal(t, "http", local["type"])
require.Equal(t, "http://localhost:3000/mcp", local["url"])
headers := local["headers"].(map[string]any)
require.Equal(t, "Bearer token", headers["Authorization"])
}
// TestLoadShellConfig_LSP verifies the lsp builtin.
func TestLoadShellConfig_LSP(t *testing.T) {
t.Parallel()
dir := t.TempDir()
script := `lsp add gopls --command gopls --filetypes go --filetypes mod --root-markers go.mod --timeout 60`
path := filepath.Join(dir, "crushrc")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
lsps := result["lsp"].(map[string]any)
gopls := lsps["gopls"].(map[string]any)
require.Equal(t, "gopls", gopls["command"])
filetypes := gopls["filetypes"].([]any)
require.Len(t, filetypes, 2)
require.Equal(t, "go", filetypes[0])
require.Equal(t, "mod", filetypes[1])
markers := gopls["root_markers"].([]any)
require.Len(t, markers, 1)
require.Equal(t, "go.mod", markers[0])
require.EqualValues(t, 60, gopls["timeout"])
}
// TestLoadShellConfig_Permissions verifies the permissions builtin.
func TestLoadShellConfig_Permissions(t *testing.T) {
t.Parallel()
dir := t.TempDir()
script := `permissions allow bash view`
path := filepath.Join(dir, "crushrc")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
perms := result["permissions"].(map[string]any)
tools := perms["allowed_tools"].([]any)
require.Len(t, tools, 2)
require.Equal(t, "bash", tools[0])
require.Equal(t, "view", tools[1])
}
// TestLoadShellConfig_PermissionsDeny verifies that `permissions deny` writes
// to options.disabled_tools (not permissions.disabled_tools). This
// cross-section write is load-bearing: deny wins over allow because
// disabled_tools removes a tool from the agent entirely. Pin the destination
// so a rename or relocation of disabled_tools can't silently break it.
func TestLoadShellConfig_PermissionsDeny(t *testing.T) {
t.Parallel()
dir := t.TempDir()
script := `permissions deny bash sourcegraph`
path := filepath.Join(dir, "crushrc")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
opts := result["options"].(map[string]any)
disabled := opts["disabled_tools"].([]any)
require.Equal(t, []any{"bash", "sourcegraph"}, disabled)
require.NotContains(t, result, "permissions",
"deny must not create a permissions section")
}
// TestLoadShellConfig_Hook verifies the hook builtin.
func TestLoadShellConfig_Hook(t *testing.T) {
t.Parallel()
dir := t.TempDir()
script := `hook add PreToolUse --command "echo running" --matcher "bash" --timeout 10 --name "my-hook"`
path := filepath.Join(dir, "crushrc")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
hooks := result["hooks"].(map[string]any)
preToolUse := hooks["PreToolUse"].([]any)
require.Len(t, preToolUse, 1)
hook := preToolUse[0].(map[string]any)
require.Equal(t, "echo running", hook["command"])
require.Equal(t, "bash", hook["matcher"])
require.EqualValues(t, 10, hook["timeout"])
require.Equal(t, "my-hook", hook["name"])
}
// TestLoadShellConfig_Option verifies the option builtin.
func TestLoadShellConfig_Option(t *testing.T) {
t.Parallel()
dir := t.TempDir()
script := `option data-directory .crush
option metrics false
option debug`
path := filepath.Join(dir, "crushrc")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
opts := result["options"].(map[string]any)
require.Equal(t, ".crush", opts["data_directory"])
require.Equal(t, true, opts["disable_metrics"])
require.Equal(t, true, opts["debug"])
}
// TestLoadShellConfig_SourceInclude verifies that source works for includes.
func TestLoadShellConfig_SourceInclude(t *testing.T) {
t.Parallel()
dir := t.TempDir()
// Create an included file with a provider definition.
includeContent := `provider add openai --api-key "included-key"`
includePath := filepath.Join(dir, "shared.sh")
require.NoError(t, os.WriteFile(includePath, []byte(includeContent), 0o644))
// Create the main script that sources the include. Use forward
// slashes so the path survives the bash interpreter on Windows,
// where backslashes would be treated as escape characters.
script := `source ` + filepath.ToSlash(includePath) + `
provider add anthropic --api-key "main-key"`
path := filepath.Join(dir, "crushrc")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
providers := result["providers"].(map[string]any)
require.Len(t, providers, 2)
require.Equal(t, "included-key", providers["openai"].(map[string]any)["api_key"])
require.Equal(t, "main-key", providers["anthropic"].(map[string]any)["api_key"])
}
// TestLoadShellConfig_Conditionals verifies that bash conditionals work.
func TestLoadShellConfig_Conditionals(t *testing.T) {
dir := t.TempDir()
script := `if [[ "$USE_ANTHROPIC" == "1" ]]; then
provider add anthropic --api-key "ant-key"
else
provider add openai --api-key "oai-key"
fi`
path := filepath.Join(dir, "crushrc")
t.Setenv("USE_ANTHROPIC", "1")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
providers := result["providers"].(map[string]any)
require.Len(t, providers, 1)
require.Contains(t, providers, "anthropic")
}
// TestLoadShellConfig_CrushVersionEnv verifies that CRUSH_VERSION is exposed
// to the script so it can feature-detect the running Crush version.
func TestLoadShellConfig_CrushVersionEnv(t *testing.T) {
dir := t.TempDir()
script := `provider add openai --api-key "$CRUSH_VERSION"`
path := filepath.Join(dir, "crushrc")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
providers := result["providers"].(map[string]any)
openai := providers["openai"].(map[string]any)
require.Equal(t, version.Version, openai["api_key"])
}
// TestLoadShellConfig_CommandSubstitution verifies that $(...) works in config values.
func TestLoadShellConfig_CommandSubstitution(t *testing.T) {
t.Parallel()
dir := t.TempDir()
script := `provider add openai --api-key "$(echo dynamic-key)"`
path := filepath.Join(dir, "crushrc")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
providers := result["providers"].(map[string]any)
openai := providers["openai"].(map[string]any)
require.Equal(t, "dynamic-key", openai["api_key"])
}
// TestLoadShellConfig_EnvVarExpansion verifies that $VAR expansion works.
func TestLoadShellConfig_EnvVarExpansion(t *testing.T) {
dir := t.TempDir()
script := `provider add openai --api-key "$MY_API_KEY"`
path := filepath.Join(dir, "crushrc")
t.Setenv("MY_API_KEY", "env-key-456")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
providers := result["providers"].(map[string]any)
openai := providers["openai"].(map[string]any)
require.Equal(t, "env-key-456", openai["api_key"])
}
// TestLoadShellConfig_UnknownFlag verifies error handling for unknown flags.
func TestLoadShellConfig_UnknownFlag(t *testing.T) {
t.Parallel()
dir := t.TempDir()
script := `provider add openai --bogus-flag "value"`
path := filepath.Join(dir, "crushrc")
_, err := LoadShellConfig(t.Context(), path, []byte(script))
require.Error(t, err)
}
// TestLoadShellConfig_MissingRequiredArgs verifies error handling for missing args.
func TestLoadShellConfig_MissingRequiredArgs(t *testing.T) {
t.Parallel()
dir := t.TempDir()
script := `provider`
path := filepath.Join(dir, "crushrc")
_, err := LoadShellConfig(t.Context(), path, []byte(script))
require.Error(t, err)
}
// TestLoadShellConfig_NoBuiltins verifies that a script with no config builtins
// produces no output.
func TestLoadShellConfig_NoBuiltins(t *testing.T) {
t.Parallel()
dir := t.TempDir()
script := `echo "just a normal script"`
path := filepath.Join(dir, "crushrc")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
require.Nil(t, jsonBytes)
}
func TestLoadShellConfig_ProviderJSONFlagsRequireObjects(t *testing.T) {
t.Parallel()
path := filepath.Join(t.TempDir(), "crushrc")
_, err := LoadShellConfig(t.Context(), path, []byte(`provider add custom --extra-body '[]'`))
require.Error(t, err)
require.Contains(t, err.Error(), "expects a JSON object")
}
// TestLoadShellConfig_ExtraHeader verifies the --extra-header flag.
func TestLoadShellConfig_ExtraHeader(t *testing.T) {
t.Parallel()
dir := t.TempDir()
script := `provider add custom --api-key "key" --extra-header "X-Custom" "value123"`
path := filepath.Join(dir, "crushrc")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
providers := result["providers"].(map[string]any)
custom := providers["custom"].(map[string]any)
headers := custom["extra_headers"].(map[string]any)
require.Equal(t, "value123", headers["X-Custom"])
}
// TestLoadShellConfig_FullConfig verifies a complete config with all builtins.
func TestLoadShellConfig_FullConfig(t *testing.T) {
dir := t.TempDir()
t.Setenv("OPENAI_API_KEY", "oai-key")
t.Setenv("ANTHROPIC_API_KEY", "ant-key")
script := `#!/usr/bin/env bash
# Providers
provider add openai --api-key "$OPENAI_API_KEY" --base-url "https://api.openai.com/v1"
provider add anthropic --api-key "$ANTHROPIC_API_KEY"
provider add my-llm --type openai --api-key "ollama" --base-url "http://localhost:11434/v1"
# Models
model large openai/gpt-4o --think
model small anthropic/claude-3-5-haiku
# MCP
mcp add github --type stdio --command npx --args "-y" --args "@modelcontextprotocol/server-github"
# LSP
lsp add gopls --command gopls --filetypes go --root-markers go.mod
# Permissions
permissions allow bash view
# Hooks
hook add PreToolUse --command "echo running" --matcher "bash" --timeout 10
# Options
option data-directory .crush
option metrics false`
path := filepath.Join(dir, "crushrc")
jsonBytes, err := LoadShellConfig(t.Context(), path, []byte(script))
require.NoError(t, err)
require.NotNil(t, jsonBytes)
var result map[string]any
require.NoError(t, json.Unmarshal(jsonBytes, &result))
// Verify providers
providers := result["providers"].(map[string]any)
require.Len(t, providers, 3)
require.Equal(t, "oai-key", providers["openai"].(map[string]any)["api_key"])
require.Equal(t, "ant-key", providers["anthropic"].(map[string]any)["api_key"])
myLLM := providers["my-llm"].(map[string]any)
require.Equal(t, "ollama", myLLM["api_key"])
require.Equal(t, "http://localhost:11434/v1", myLLM["base_url"])
// Verify models
models := result["models"].(map[string]any)
large := models["large"].(map[string]any)
require.Equal(t, "openai", large["provider"])
require.Equal(t, "gpt-4o", large["model"])
require.Equal(t, true, large["think"])
// Verify MCP
mcps := result["mcp"].(map[string]any)
github := mcps["github"].(map[string]any)
require.Equal(t, "npx", github["command"])
// Verify LSP
lsps := result["lsp"].(map[string]any)
require.Contains(t, lsps, "gopls")
// Verify permissions
perms := result["permissions"].(map[string]any)
require.Contains(t, perms, "allowed_tools")
// Verify hooks
hooks := result["hooks"].(map[string]any)
require.Contains(t, hooks, "PreToolUse")
// Verify options
opts := result["options"].(map[string]any)
require.Equal(t, ".crush", opts["data_directory"])
require.Equal(t, true, opts["disable_metrics"])
}
// TestConfigBuilder_NoBuilderInContext verifies that builtins are no-ops
// when no ConfigBuilder is on the context (normal bash tool execution).
func TestConfigBuilder_NoBuilderInContext(t *testing.T) {
t.Parallel()
dir := t.TempDir()
// "provider" without a ConfigBuilder should be a no-op (return nil),
// not an error. The builtins check for the builder and silently skip.
err := shell.Run(t.Context(), shell.RunOptions{
Command: `provider add openai --api-key "test"`,
Cwd: dir,
Env: os.Environ(),
})
require.NoError(t, err)
}
// TestLoadShellConfig_RespectsContextCancellation verifies that a hanging
// crushrc cannot block config loading indefinitely. Config loads run on the
// startup and reload critical paths while the config store's write lock is
// held, so a runaway script (a busy loop, a hung command substitution) must
// be interruptible via the context rather than wedging the whole store. The
// test bounds its own wait so a regression can't hang CI.
func TestLoadShellConfig_RespectsContextCancellation(t *testing.T) {
t.Parallel()
path := filepath.Join(t.TempDir(), "crushrc")
script := `while true; do :; done`
ctx, cancel := context.WithTimeout(t.Context(), 300*time.Millisecond)
t.Cleanup(cancel)
done := make(chan error, 1)
go func() {
_, err := LoadShellConfig(ctx, path, []byte(script))
done <- err
}()
select {
case err := <-done:
require.Error(t, err, "a cancelled crushrc must fail, not succeed")
require.True(t, shell.IsInterrupt(err),
"expected an interrupt/cancellation error, got: %v", err)
case <-time.After(2 * time.Second):
t.Fatal("LoadShellConfig did not return after context cancellation")
}
}
|