diff --git a/CLAUDE.md b/CLAUDE.md index fd3019d7..ff6e50a0 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -367,18 +367,46 @@ mvn dependency-check:check ## Configuration -### Application properties (`application.yml`) -- `codeiq.root-path` -- codebase root (default: `.`) -- `codeiq.cache-dir` -- cache directory name (default: `.code-intelligence`) -- `codeiq.graph.path` -- Neo4j graph path (default: `.osscodeiq/graph.db`) -- `codeiq.max-radius` -- max ego graph radius (default: 10) -- `codeiq.max-depth` -- max impact trace depth (default: 10) -- `codeiq.batch-size` -- files per H2 flush batch (default: 500) -- `codeiq.neo4j.enabled` -- Neo4j conditional toggle (default: `true`, overridden to `false` in `indexing` profile) -- `spring.ai.mcp.server.protocol` -- MCP protocol (STREAMABLE) - -### Project-level overrides (`.osscodeiq.yml`) -Placed in the codebase root, loaded by `ProjectConfigLoader` before analysis. +Single source of truth: **`codeiq.yml`** at the repo root. See +`docs/codeiq.yml.example` for the full schema (snake_case throughout; +camelCase accepted as a deprecated alias for one release). Resolution order +(last wins): + +1. Built-in defaults (`ConfigDefaults.builtIn()`) +2. `~/.codeiq/config.yml` (user-global) +3. `./codeiq.yml` (project) +4. `CODEIQ_
_` env vars (e.g. `CODEIQ_SERVING_PORT=9090`) +5. CLI flags on `code-iq ` + +Validate and introspect with: + +```bash +code-iq config validate +code-iq config explain +``` + +### Spring-owned keys (stay in `application.yml`) + +A small set of keys still lives in `src/main/resources/application.yml` +because they drive Spring's `@ConditionalOnProperty` / `@Value` wiring and +have not been migrated into `codeiq.yml`: + +- `codeiq.neo4j.enabled` -- profile-conditional toggle (`false` in the + `indexing` profile, `true` in `serving`). +- `codeiq.neo4j.bolt.port` -- embedded Neo4j Bolt listener port. +- `codeiq.cors.allowed-origin-patterns` -- CORS allow-list for the REST API. +- `codeiq.ui.enabled` -- toggles the React SPA static resource handler. + +`UnifiedConfigBeans` bridges the unified config to the legacy `CodeIqConfig` +bean for code paths that haven't been ported yet. + +### `.osscodeiq.yml` deprecation + +`.osscodeiq.yml` is deprecated. `ProjectConfigLoader` still loads it for one +release, translates its legacy flat keys into the unified nested shape, and +logs a one-time WARN per canonical path. Rename to `codeiq.yml` and migrate +flat keys into the `project:` / `indexing:` / `serving:` / `mcp:` / +`observability:` / `detectors:` sections. ## Gotchas & Lessons Learned diff --git a/README.md b/README.md index 4597eacb..6dc16978 100644 --- a/README.md +++ b/README.md @@ -157,31 +157,100 @@ java -jar code-iq-*-cli.jar serve /shared ## Configuration -Create `.osscodeiq.yml` in your repo root to customize the pipeline: +code-iq is configured by a single YAML file at the repo root: **`codeiq.yml`**. +Every field is optional; omitted fields fall back to the in-code defaults +(`ConfigDefaults.builtIn()`). See +[`docs/codeiq.yml.example`](docs/codeiq.yml.example) for the full reference +with inline documentation. All keys are **snake_case**; camelCase spellings +are accepted as deprecated aliases for one release and log a WARN on load. + +### Resolution order (last wins) + +1. Built-in defaults +2. `~/.codeiq/config.yml` (user-global) +3. `./codeiq.yml` (project) +4. Environment variables: `CODEIQ_
_` (e.g. `CODEIQ_SERVING_PORT=9090`, + `CODEIQ_MCP_AUTH_MODE=bearer`, `CODEIQ_INDEXING_BATCH_SIZE=1000`). Nested + keys are flattened with underscores; values parse as YAML scalars. +5. CLI flags on `code-iq ` + +### Commands + +```bash +code-iq config validate # Validate ./codeiq.yml, exit 1 on error +code-iq config validate -p custom.yml +code-iq config explain # Print each effective value + its source layer +``` + +### Minimal example ```yaml +project: + name: my-service + root: . + +indexing: + exclude: ['**/node_modules/**', '**/build/**', '**/dist/**'] + cache_dir: .code-iq/cache + batch_size: 500 + +serving: + port: 8080 + bind_address: 0.0.0.0 + +mcp: + enabled: true + transport: http +``` + +### Spring-owned keys (stay in `application.yml`) + +A handful of keys drive Spring's `@ConditionalOnProperty` / `@Value` wiring +and have not been migrated into `codeiq.yml`. Keep them in +`src/main/resources/application.yml`: + +- `codeiq.neo4j.enabled` -- profile-conditional Neo4j toggle (`false` under + the `indexing` profile, `true` under `serving`). +- `codeiq.neo4j.bolt.port` -- embedded Neo4j Bolt listener port. +- `codeiq.cors.allowed-origin-patterns` -- CORS allow-list for the REST API. +- `codeiq.ui.enabled` -- toggles the React SPA static resource handler. + +Everything else belongs in `codeiq.yml`. `UnifiedConfigBeans` bridges the +two worlds for values that exist in both. + +### Migration from `.osscodeiq.yml` + +`.osscodeiq.yml` is deprecated. code-iq still loads it for one release via +`ProjectConfigLoader`, translates its legacy flat keys into the unified +shape, and logs a one-time WARN per path. Rename the file to `codeiq.yml` +and restructure flat keys into the nested sections. + +**Before** (`.osscodeiq.yml`, legacy flat schema): + +```yaml +languages: [java, typescript, yaml] +exclude: + - '**/node_modules/**' + - '**/build/**' pipeline: parallelism: 4 batch-size: 500 +batch_size: 500 +``` -languages: - - java - - typescript - - yaml - -detectors: - categories: - - endpoints - - entities - - auth - - config +**After** (`codeiq.yml`, unified snake_case schema): -exclude: - - "**/node_modules/**" - - "**/build/**" +```yaml +indexing: + languages: [java, typescript, yaml] + exclude: + - '**/node_modules/**' + - '**/build/**' + parallelism: 4 + batch_size: 500 ``` -Or auto-generate a config: `code-iq plugins suggest /path/to/repo` +See `docs/codeiq.yml.example` for the full schema. ## Graph Model diff --git a/docs/codeiq.yml.example b/docs/codeiq.yml.example new file mode 100644 index 00000000..6d74202c --- /dev/null +++ b/docs/codeiq.yml.example @@ -0,0 +1,98 @@ +# docs/codeiq.yml.example +# +# Authoritative reference for `codeiq.yml` (Phase B unified config). +# +# - Place this file as `codeiq.yml` at the repo root. +# - Every field is optional; omitted fields fall back to the built-in defaults +# (see `ConfigDefaults.builtIn()`). +# - All keys are snake_case. camelCase spellings (e.g. `cacheDir`, `batchSize`, +# `bindAddress`, `pageCacheMb`, `perToolTimeoutMs`, `logFormat`) are accepted +# as deprecated aliases for one release and emit a WARN on load. Do not use +# camelCase in new config. +# - Run `code-iq config validate` to type-check your file, and +# `code-iq config explain` to print every effective value and the layer it +# was resolved from. + +# --------------------------------------------------------------------------- +# project +# --------------------------------------------------------------------------- +project: + name: my-service # human-readable identifier; defaults to null + root: . # codebase root, relative to this file (default: ".") + service_name: my-service # override for the emitted SERVICE node name + modules: [] # optional list of sub-modules (Phase C). Example: + # - path: services/api + # type: maven # maven | gradle | npm | pnpm | pip | go | cargo | ... + # name: api + # kind: service # service | library | tool | infra + +# --------------------------------------------------------------------------- +# indexing +# --------------------------------------------------------------------------- +indexing: + languages: [] # allow-list; empty = detect all supported languages + include: [] # glob allow-list; empty = include everything discovered + exclude: # glob deny-list; applied after `include` + - '**/node_modules/**' + - '**/build/**' + - '**/dist/**' + - '**/generated/**' + incremental: true # reuse H2 cache when file hashes match + cache_dir: .code-iq/cache # H2 analysis cache directory + parallelism: auto # "auto" or a positive integer + batch_size: 500 # files per H2 flush batch (default: 500) + max_depth: 10 # max impact-trace depth + max_radius: 10 # max ego-graph radius + max_files: null # null = no cap; positive int to bound discovery + max_snippet_lines: null # null = use CodeIqConfig default + +# --------------------------------------------------------------------------- +# serving +# --------------------------------------------------------------------------- +serving: + port: 8080 # HTTP port for REST + MCP + UI + bind_address: 0.0.0.0 # interface to bind; 127.0.0.1 for localhost-only + read_only: false # must be false in non-prod; CI gate enforces this + neo4j: + dir: .code-iq/graph/graph.db # embedded Neo4j data directory + page_cache_mb: 256 # Neo4j page cache (MB) + heap_initial_mb: 256 # JVM -Xms for Neo4j (MB) + heap_max_mb: 1024 # JVM -Xmx for Neo4j (MB) + +# --------------------------------------------------------------------------- +# mcp (Model Context Protocol server) +# --------------------------------------------------------------------------- +mcp: + enabled: true # expose MCP tools via the serving layer + transport: http # http | stdio + base_path: /mcp # HTTP path prefix when transport=http + auth: + mode: none # none (default) | bearer | mtls + token_env: CODEIQ_MCP_TOKEN # env var read when mode=bearer + limits: + per_tool_timeout_ms: 15000 # hard cap per tool invocation + max_results: 500 # cap on result rows returned per tool + max_payload_bytes: 2000000 # cap on single response body (bytes) + rate_per_minute: 300 # per-client rate limit + tools: + enabled: ['*'] # allow-list of tool names; '*' = all + disabled: [] # deny-list wins over `enabled` + +# --------------------------------------------------------------------------- +# observability +# --------------------------------------------------------------------------- +observability: + metrics: true # expose Micrometer/Prometheus metrics + tracing: false # emit OTLP spans (off by default) + log_format: json # json | text + log_level: info # trace | debug | info | warn | error + +# --------------------------------------------------------------------------- +# detectors +# --------------------------------------------------------------------------- +detectors: + profiles: [default] # named detector bundles to activate + overrides: # per-detector feature flags, keyed by SimpleClassName + SpringRestDetector: { enabled: true } + QuarkusRestDetector: { enabled: true } + # MicronautRestDetector: { enabled: false } diff --git a/docs/superpowers/baselines/2026-04-17/PHASE-B-EXIT-GATE.md b/docs/superpowers/baselines/2026-04-17/PHASE-B-EXIT-GATE.md new file mode 100644 index 00000000..2acd2826 --- /dev/null +++ b/docs/superpowers/baselines/2026-04-17/PHASE-B-EXIT-GATE.md @@ -0,0 +1,58 @@ +# Phase B Exit-Gate Verification — 2026-04-22 + +**Branch:** `phase-b/unified-config` +**Head commit:** `5356630 docs(config): document codeiq.yml, resolution order, and migration from .osscodeiq.yml` +**Final test count:** **3275 pass / 0 fail / 0 errors / 31 skipped** (`mvn -B test`, BUILD SUCCESS) + +## Gate status + +| # | Gate | Status | Evidence | +|---|---|---|---| +| 1 | Single source of truth — `codeiq.yml` is authoritative; `application.yml` no longer duplicates migrated keys | PASS | `src/main/resources/application.yml` contains zero instances of `codeiq.root-path`, `codeiq.cache-dir`, `codeiq.graph.path`, `codeiq.max-depth`, `codeiq.max-radius`, `codeiq.batch-size`. Remaining `codeiq.*` keys are exactly: `codeiq.ui.enabled` (L33-35), `codeiq.neo4j.enabled` (L56-58 indexing profile, L94-96 serving profile). `codeiq.neo4j.bolt.port` and `codeiq.cors.allowed-origin-patterns` consume `@Value` defaults with no YAML override (documented at L25-32). | +| 2 | Layered resolution — defaults → user-global → project → env → CLI | PASS | `src/main/java/io/github/randomcodespace/iq/config/unified/ConfigLayer.java` enumerates `BUILT_IN, USER_GLOBAL, PROJECT, ENV, CLI`. `ConfigResolver.resolve()` appends layers in that exact order into `ConfigMerger.Input` list; "last wins" semantics are documented in the class Javadoc. | +| 3 | Provenance — `config explain` prints per-field source | PASS | `ConfigExplainSubcommand` row format `FIELD(40) LAYER(12) SOURCE(40) VALUE`. `ConfigExplainSubcommandTest.printsProvenanceForEachLeaf` asserts stdout contains `serving.port`, value `9000`, layer `PROJECT`, plus `ENV` layer for env-overridden `mcp.limits.per_tool_timeout_ms=30000`, and at least one `BUILT_IN` leaf. `cliOverlayWinsOverEnv` test asserts CLI > ENV precedence on the explain output. | +| 4 | Validation — `config validate` returns exit 0/1 on valid/invalid | PASS | `ConfigValidateSubcommand` returns `1` on validation errors (sorted by `fieldPath`, written to stderr) or load failure. `ConfigValidateSubcommandTest` covers: `invalidFileReturnsOneAndListsErrorsOnStderr` (port 99999 → exit 1, stderr contains `serving.port`), `missingFileReturnsOneAndPrintsLoadErrorToStderr`, `malformedYamlReturnsOneAndReportsLoadError`, `emptyFileIsValidAndReturnsZero`. | +| 5 | Env var overlay — `CODEIQ_
_` works across sections | PASS | `EnvVarOverlayTest` covers 6 cases: `readsServingPort`, `readsNestedMcpLimit` (`CODEIQ_MCP_LIMITS_PERTOOLTIMEOUTMS`), `parsesBooleansAndLists` (`CODEIQ_INDEXING_LANGUAGES=java,typescript,python`), `unknownVarIsIgnored`, `nonCodeiqVarsIgnored`, `malformedIntThrowsWithVarName`. | +| 6 | Schema documented — `docs/codeiq.yml.example` exists, snake_case throughout | PASS | File exists with 6 sections matching `CodeIqUnifiedConfig` record: `project`, `indexing`, `serving`, `mcp`, `observability`, `detectors`. Only "camelCase" hits in real content are `SpringRestDetector`/`QuarkusRestDetector` — Java SimpleClassName keys under `detectors.overrides`, which is the documented convention, not config key casing. Header explicitly calls out camelCase as deprecated alias. | +| 7 | `.osscodeiq.yml` deprecation — WARN once per path; legacy flat keys translated | PASS | `ProjectConfigLoader.loadFrom` uses `ConcurrentHashMap.newKeySet()` (`WARNED_PATHS`) at L70; WARN emitted only on first `add(canonical)`. `ProjectConfigLoaderTest` (14 tests) covers: `preferCodeiqYmlWhenBothPresent` (new file wins, no WARN), `fallsBackToOsscodeIqWithWarn`, `fallbackOsscodeiqWithFlatKeysTranslatesToUnifiedOverlay`, `fallbackOsscodeiqWithNewShapeStillWorks`, `mixedLegacyFlatAndNestedKeysPrefersLegacyPath`, `neitherFilePresentReturnsEmptyConfig`. Per-path dedupe test is **not explicitly covered** (see follow-ups). | +| 8 | `CodeIqConfig` API unchanged | PASS | All legacy getters present with original signatures: `getRootPath`/`setRootPath` (L62-66), `getCacheDir` (L70), `getMaxDepth` (L78), `getMaxFiles` (L86), `getMaxRadius` (L94), `getBatchSize` (L102), `getServiceName` (L118), `getGraph` (L126), `getMaxSnippetLines` (L142). Inner `Graph.getPath`/`setPath` (L50-51). 27 source files still reference `CodeIqConfig`. | +| 9 | Test count baseline — 3275+ tests, 0 failures | PASS | `mvn -B test` → `Tests run: 3275, Failures: 0, Errors: 0, Skipped: 31` — `BUILD SUCCESS`. | +| 10 | No regressions — `.osscodeiq.yml` still loads for legacy users | PASS | Covered by `ProjectConfigLoaderTest.fallsBackToOsscodeIqWithWarn` and `fallbackOsscodeiqWithNewShapeStillWorks`. SpotBugs / frontend build not re-verified in this gate pass (neither is a §3.6 requirement; see follow-ups for any outstanding Phase-A items). | + +## Spec §3.6 acceptance criteria (direct mapping) + +| Spec criterion | Plan task | Verified via | +|---|---|---| +| One file controls pipeline end-to-end; no CLI flag for default run | Task 14 gate 1 | `CodeIqUnifiedConfig` + `UnifiedConfigBeans` wire the full tree; all previously-required CLI overrides now read from `codeiq.yml` via `ConfigResolver`. Full pipeline smoke (`java -jar ... index .`) deferred to release candidate (jar not built in this verification pass) — all unit + integration paths pass. | +| `code-iq config explain` prints effective config + source per value | Task 14 gate 2 | `ConfigExplainSubcommand` + passing tests above. | +| Deprecation warning fires when `.osscodeiq.yml` is used | Task 14 gate 3 | `ProjectConfigLoader.loadFrom` L107 `log.warn(...)`; `fallsBackToOsscodeIqWithWarn` test asserts `r.deprecationWarningEmitted() == true`. | +| Invalid config yields a clear, file-anchored error | Task 14 gate 4 | `ConfigValidateSubcommand` sorts `ConfigError.fieldPath()` to stderr with `field.path: message` format; `invalidFileReturnsOneAndListsErrorsOnStderr` asserts `serving.port` appears in stderr for out-of-range port. | + +## Docs-vs-implementation sync + +- `README.md` §Configuration (L158-218) — documents `codeiq.yml` as single source, resolution order (5 layers, last wins), `config validate` / `config explain` commands, minimal example (snake_case), and the 4 Spring-owned keys. Matches implementation. +- `CLAUDE.md` §Configuration (L368-409) — same structure, including `.osscodeiq.yml` deprecation section pointing to `ProjectConfigLoader`. Matches implementation. + +## Release blockers + +**None.** Phase B meets all §3.6 acceptance criteria. All code paths exercised by 3275 passing tests. + +## Post-release follow-ups + +Tracked issues (priority: post-release): + +- **#47** — Detector taxonomy refactor (post) +- **#48** — SQL / migration detector (post) +- **#49** — Freeze `CodeIqConfig` setters (post — setter mutability does not affect Phase B's contract; unified config is the write path) +- **#50** — Slice `UnifiedConfigBeansTest` (post) +- **#52** — Retire legacy `ProjectConfigLoader` static methods + migrate Analyzer/CliOutput (post — static methods are marked `@Deprecated since 0.2.0, for removal` in javadoc, and `loadFrom` is the new instance path; they can be removed once Analyzer/CliOutput are migrated in a follow-up, without breaking Phase B's single-source-of-truth gate) + +Minor gaps noted (not blockers): + +- `ProjectConfigLoaderTest` covers WARN emission via `LoadResult.deprecationWarningEmitted()` but has no explicit test that calling `loadFrom` twice against the same canonical path emits the WARN only once. The logic (`WARNED_PATHS.add(canonical)`) is correct; a unit test asserting dedupe would be a belt-and-braces addition. **Recommend: add as a trivial follow-up, not a release blocker.** +- Frontend build and SpotBugs not re-executed in this verification pass — neither is a §3.6 criterion. Phase A baseline covered them; no Phase B changes touched frontend or triggered new SpotBugs findings. +- End-to-end smoke test with packaged jar (`java -jar .../code-iq-*-cli.jar index .`) was not run because the packaged jar is not a §3.6 artifact — the four acceptance criteria are fully covered by the subcommand unit tests plus the unified-config loader/merger/resolver tests. Recommended as a final pre-tag sanity check when the release candidate is built. + +## Final verdict + +**APPROVED TO MERGE.** Phase B (Pillar 1 — Unified Config) has met every §3.6 acceptance criterion with passing, deterministic test coverage. Single source of truth (`codeiq.yml`) verified; 5-layer resolution (`BUILT_IN → USER_GLOBAL → PROJECT → ENV → CLI`) verified; provenance surfaced by `config explain`; validation errors are file-anchored and exit 1; `.osscodeiq.yml` deprecation shim translates legacy flat keys and emits a per-path WARN; legacy `CodeIqConfig` API surface preserved; `application.yml` reduced to Spring-framework-consumed keys only (all 4 documented). Full suite green: 3275/0/31. diff --git a/src/main/java/io/github/randomcodespace/iq/cli/CodeIqCli.java b/src/main/java/io/github/randomcodespace/iq/cli/CodeIqCli.java index 9b5f1472..ac92c07c 100644 --- a/src/main/java/io/github/randomcodespace/iq/cli/CodeIqCli.java +++ b/src/main/java/io/github/randomcodespace/iq/cli/CodeIqCli.java @@ -26,6 +26,7 @@ FlowCommand.class, BundleCommand.class, CacheCommand.class, + ConfigCommand.class, StatsCommand.class, TopologyCommand.class, PluginsCommand.class, diff --git a/src/main/java/io/github/randomcodespace/iq/cli/ConfigCommand.java b/src/main/java/io/github/randomcodespace/iq/cli/ConfigCommand.java new file mode 100644 index 00000000..c111d88d --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/cli/ConfigCommand.java @@ -0,0 +1,34 @@ +package io.github.randomcodespace.iq.cli; + +import org.springframework.stereotype.Component; +import picocli.CommandLine; +import picocli.CommandLine.Command; +import picocli.CommandLine.Model.CommandSpec; +import picocli.CommandLine.Spec; + +import java.util.concurrent.Callable; + +/** + * Parent command for configuration-related subcommands. + * + *

Running {@code code-iq config} with no subcommand prints usage to stderr + * and exits with picocli's conventional {@code USAGE} (2) exit code so that + * scripts can distinguish "I invoked the tool wrong" from a successful or + * failed operation. + */ +@Component +@Command( + name = "config", + mixinStandardHelpOptions = true, + description = "Inspect and validate code-iq configuration", + subcommands = {ConfigValidateSubcommand.class, ConfigExplainSubcommand.class}) +public class ConfigCommand implements Callable { + + @Spec private CommandSpec spec; + + @Override + public Integer call() { + spec.commandLine().usage(System.err); + return CommandLine.ExitCode.USAGE; + } +} diff --git a/src/main/java/io/github/randomcodespace/iq/cli/ConfigExplainSubcommand.java b/src/main/java/io/github/randomcodespace/iq/cli/ConfigExplainSubcommand.java new file mode 100644 index 00000000..a01eb689 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/cli/ConfigExplainSubcommand.java @@ -0,0 +1,152 @@ +package io.github.randomcodespace.iq.cli; + +import io.github.randomcodespace.iq.config.unified.CodeIqUnifiedConfig; +import io.github.randomcodespace.iq.config.unified.ConfigLoadException; +import io.github.randomcodespace.iq.config.unified.ConfigProvenance; +import io.github.randomcodespace.iq.config.unified.ConfigResolver; +import io.github.randomcodespace.iq.config.unified.MergedConfig; +import java.io.PrintStream; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Comparator; +import java.util.Map; +import java.util.concurrent.Callable; +import org.springframework.stereotype.Component; +import picocli.CommandLine.Command; +import picocli.CommandLine.Option; + +/** + * Prints the effective {@code codeiq.yml} configuration with per-field provenance: every leaf value + * together with the layer that won (BUILT_IN / USER_GLOBAL / PROJECT / ENV / CLI) and the source + * label (file path or {@code (env)}/{@code (defaults)}/{@code (cli)}). + * + *

Streams: + * + *

    + *
  • {@code out} -- the explain table (this is the command's product, not a log line). + *
  • {@code err} -- load failures (missing/unreadable file). + *
+ * + *

Output is deterministic: rows are emitted sorted by field path so that diffing two runs is + * meaningful. + * + *

Two constructors exist: the no-arg form binds to {@link System#out} and {@link System#err} + * and is what picocli/Spring instantiates at runtime; the two-arg form lets tests inject capture + * streams without touching mutable singleton state between invocations. + */ +@Component +@Command( + name = "explain", + mixinStandardHelpOptions = true, + description = "Show effective config with per-field provenance") +public class ConfigExplainSubcommand implements Callable { + + private static final Path DEFAULT_PATH = Path.of("codeiq.yml"); + + /** + * Row layout: {@code FIELD(40) + space + LAYER(12) + space + SOURCE(40) + " " + VALUE}. The + * divider row must span the header portion exactly -- the value column is not padded, so its + * width is just the width of the literal header {@code "VALUE"} ({@value #VALUE_COLUMN_WIDTH}). + */ + private static final String ROW_FORMAT = "%-40s %-12s %-40s %s%n"; + + private static final int VALUE_COLUMN_WIDTH = "VALUE".length(); + private static final int TABLE_WIDTH = 40 + 1 + 12 + 1 + 40 + 2 + VALUE_COLUMN_WIDTH; + + @Option( + names = {"--path", "-p"}, + description = "Path to codeiq.yml (default: ./codeiq.yml)") + private Path path = DEFAULT_PATH; + + private final PrintStream out; + private final PrintStream err; + + // Nullable on purpose: a Spring-singleton bean must not freeze the env at construction time, + // so we resolve System.getenv() lazily inside call(). Tests inject a fixed map via setEnv. + private Map envMap; + + // Nullable: tests may inject a CLI overlay to exercise CLI-wins-over-ENV precedence. Runtime + // callers pass the real CLI overlay through this same seam once wired end-to-end. + private CodeIqUnifiedConfig cliOverlay; + + public ConfigExplainSubcommand() { + this(System.out, System.err); + } + + public ConfigExplainSubcommand(PrintStream out, PrintStream err) { + this.out = out; + this.err = err; + } + + void setPath(Path p) { + this.path = p; + } + + /** + * Overrides the env used for overlay resolution. {@code null} means "use the real process + * environment" -- {@link #call()} falls back to {@link System#getenv()} at invocation time, so + * a Spring singleton bean sees fresh env each call instead of a frozen snapshot. + */ + void setEnv(Map e) { + this.envMap = e; + } + + /** + * Injects a CLI-layer overlay (highest precedence). {@code null} means no CLI overlay. Exposed + * as a package-private hook so tests can assert CLI-wins-over-ENV precedence without booting a + * full picocli parse. + */ + void setCliOverlay(CodeIqUnifiedConfig overlay) { + this.cliOverlay = overlay; + } + + @Override + public Integer call() { + // Guard against picocli leaving path unset (mirrors ConfigValidateSubcommand). + if (path == null) { + path = DEFAULT_PATH; + } + // UnifiedConfigLoader treats a missing file as an empty overlay, which is the right + // default for an implicit ./codeiq.yml, but when the user points this subcommand at a + // specific path, the absence of that file is a real error -- surface it as a load + // error on stderr, same UX as `config validate`. + if (!Files.exists(path)) { + err.println("Load error: config file does not exist: " + path); + return 1; + } + Map effectiveEnv = (envMap != null) ? envMap : System.getenv(); + final MergedConfig merged; + try { + // ConfigResolver#resolve() invokes UnifiedConfigLoader.load internally; don't + // double-parse the file here. + ConfigResolver resolver = + new ConfigResolver().projectPath(path).env(effectiveEnv); + if (cliOverlay != null) { + resolver = resolver.cliOverlay(cliOverlay, "(cli)"); + } + merged = resolver.resolve(); + } catch (ConfigLoadException e) { + err.println("Load error: " + e.getMessage()); + return 1; + } + + out.printf(ROW_FORMAT, "FIELD", "LAYER", "SOURCE", "VALUE"); + out.println("-".repeat(TABLE_WIDTH)); + // Stream sorted by field path using Comparator.comparing(Map.Entry::getKey) guarantees + // byte-for-byte deterministic output across runs regardless of the underlying + // provenance map's iteration order. + merged.provenance().entrySet().stream() + .sorted(Comparator.comparing(Map.Entry::getKey)) + .forEach( + entry -> { + ConfigProvenance p = entry.getValue(); + out.printf( + ROW_FORMAT, + entry.getKey(), + p.layer(), + p.sourceLabel(), + "= " + p.value()); + }); + return 0; + } +} diff --git a/src/main/java/io/github/randomcodespace/iq/cli/ConfigValidateSubcommand.java b/src/main/java/io/github/randomcodespace/iq/cli/ConfigValidateSubcommand.java new file mode 100644 index 00000000..05370070 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/cli/ConfigValidateSubcommand.java @@ -0,0 +1,104 @@ +package io.github.randomcodespace.iq.cli; + +import io.github.randomcodespace.iq.config.unified.ConfigError; +import io.github.randomcodespace.iq.config.unified.ConfigLoadException; +import io.github.randomcodespace.iq.config.unified.ConfigResolver; +import io.github.randomcodespace.iq.config.unified.ConfigValidator; +import io.github.randomcodespace.iq.config.unified.MergedConfig; +import org.springframework.stereotype.Component; +import picocli.CommandLine.Command; +import picocli.CommandLine.Option; + +import java.io.PrintStream; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Comparator; +import java.util.List; +import java.util.concurrent.Callable; + +/** + * Validates a codeiq.yml configuration file. Exits with 0 when the effective + * config (file overlay composed over built-in defaults) passes validation, + * and 1 otherwise. + * + *

Streams: + *

    + *
  • {@code out} -- human "OK" success messages only.
    • + *
  • {@code err} -- validation-error lists and load failures.
    • + *
+ * + *

Two constructors exist: the no-arg form binds to {@link System#out} and + * {@link System#err} and is what picocli/Spring instantiates at runtime; the + * two-arg form lets tests inject capture streams without touching mutable + * singleton state between invocations. + */ +@Component +@Command( + name = "validate", + mixinStandardHelpOptions = true, + description = "Validate a codeiq.yml file") +public class ConfigValidateSubcommand implements Callable { + + private static final Path DEFAULT_PATH = Path.of("codeiq.yml"); + + @Option( + names = {"--path", "-p"}, + description = "Path to codeiq.yml (default: ./codeiq.yml)") + private Path path = DEFAULT_PATH; + + private final PrintStream out; + private final PrintStream err; + + public ConfigValidateSubcommand() { + this(System.out, System.err); + } + + public ConfigValidateSubcommand(PrintStream out, PrintStream err) { + this.out = out; + this.err = err; + } + + void setPath(Path p) { + this.path = p; + } + + @Override + public Integer call() { + // Guard against picocli leaving path unset when the user did not pass --path; + // picocli normally uses the field initializer, but a null override via reflection + // or a future refactor should still land on a sensible default. + if (path == null) { + path = DEFAULT_PATH; + } + // UnifiedConfigLoader treats a missing file as an empty overlay, which is + // the right default for an implicit ./codeiq.yml, but when the user points + // this subcommand at a specific path, the absence of that file is a real + // error -- not a silent pass. Surface it as a load error. + if (!Files.exists(path)) { + err.println("Load error: config file does not exist: " + path); + return 1; + } + try { + // Validate the effective config (file overlay + built-in defaults) so + // cross-field checks (e.g. heapInitial <= heapMax) always have values. + // ConfigResolver#resolve() invokes UnifiedConfigLoader.load internally, + // so any ConfigLoadException propagates from here. + MergedConfig merged = new ConfigResolver().projectPath(path).resolve(); + List errs = new ConfigValidator().validate(merged.effective()); + if (errs.isEmpty()) { + out.println("OK: " + path + " is valid."); + return 0; + } + err.println("Validation errors in " + path + ":"); + errs.stream() + .sorted( + Comparator.comparing(ConfigError::fieldPath) + .thenComparing(ConfigError::message)) + .forEach(e -> err.println(" " + e.fieldPath() + ": " + e.message())); + return 1; + } catch (ConfigLoadException e) { + err.println("Load error: " + e.getMessage()); + return 1; + } + } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/CodeIqConfig.java b/src/main/java/io/github/randomcodespace/iq/config/CodeIqConfig.java index 849486fb..efa3b342 100644 --- a/src/main/java/io/github/randomcodespace/iq/config/CodeIqConfig.java +++ b/src/main/java/io/github/randomcodespace/iq/config/CodeIqConfig.java @@ -1,20 +1,20 @@ package io.github.randomcodespace.iq.config; -import io.github.randomcodespace.iq.graph.GraphStore; -import io.github.randomcodespace.iq.intelligence.provenance.ArtifactMetadataProvider; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.context.properties.ConfigurationProperties; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import org.springframework.context.annotation.Profile; - -import java.nio.file.Path; - /** - * Configuration properties for Code IQ, bound to the "codeiq" prefix. + * Legacy flat configuration bean for Code IQ. + * + *

Historically bound to Spring Boot {@code @ConfigurationProperties("codeiq")}. + * Task 11 moved bean production to {@link UnifiedConfigBeans#codeIqConfig}, which + * adapts a {@link io.github.randomcodespace.iq.config.unified.CodeIqUnifiedConfig} + * (single source of truth) via {@link UnifiedConfigAdapter#toCodeIqConfig}. The + * getter/setter surface is preserved unchanged so the ~100 call sites that still + * depend on this bean continue to work. + * + *

This class is intentionally a plain POJO (no {@code @Configuration}, + * no {@code @ConfigurationProperties}); Spring Boot no longer instantiates it + * from {@code application.yml}. Instantiable directly in tests via the public + * no-arg constructor and setters. */ -@Configuration -@ConfigurationProperties(prefix = "codeiq") public class CodeIqConfig { /** Root path of the codebase to analyze. */ @@ -146,18 +146,4 @@ public int getMaxSnippetLines() { public void setMaxSnippetLines(int maxSnippetLines) { this.maxSnippetLines = Math.max(1, maxSnippetLines); } - - /** - * Provides on-demand artifact metadata in the {@code serving} profile. - * - *

Graph-derived fields are resolved lazily so H2-to-Neo4j bootstrap can complete - * before clients fetch manifest data. - */ - @Bean - @Profile("serving") - public ArtifactMetadataProvider artifactMetadataProvider( - @Autowired(required = false) GraphStore graphStore) { - Path root = Path.of(rootPath).toAbsolutePath().normalize(); - return new ArtifactMetadataProvider(root, graphStore); - } } diff --git a/src/main/java/io/github/randomcodespace/iq/config/ProjectConfigLoader.java b/src/main/java/io/github/randomcodespace/iq/config/ProjectConfigLoader.java index 98e710f7..14e1c7b2 100644 --- a/src/main/java/io/github/randomcodespace/iq/config/ProjectConfigLoader.java +++ b/src/main/java/io/github/randomcodespace/iq/config/ProjectConfigLoader.java @@ -1,7 +1,15 @@ package io.github.randomcodespace.iq.config; +import io.github.randomcodespace.iq.config.unified.CodeIqUnifiedConfig; +import io.github.randomcodespace.iq.config.unified.DetectorsConfig; +import io.github.randomcodespace.iq.config.unified.IndexingConfig; +import io.github.randomcodespace.iq.config.unified.McpConfig; +import io.github.randomcodespace.iq.config.unified.ObservabilityConfig; +import io.github.randomcodespace.iq.config.unified.ServingConfig; +import io.github.randomcodespace.iq.config.unified.UnifiedConfigLoader; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import org.springframework.stereotype.Component; import org.yaml.snakeyaml.Yaml; import java.io.IOException; @@ -12,39 +20,264 @@ import java.util.LinkedHashMap; import java.util.List; import java.util.Map; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; /** - * Loads project-level configuration from .osscodeiq.yml or .osscodeiq.yaml - * found in the target directory, and applies overrides to {@link CodeIqConfig}. - *

- * Also produces a {@link ProjectConfig} with pipeline filter settings - * (languages, detector categories, detector includes, exclude patterns, etc.). + * Reads the project-scoped {@code codeiq.yml} (preferred) or, if absent, the + * legacy {@code .osscodeiq.yml} with a one-time-per-path deprecation warning. + * The legacy fallback branch will be removed one release after the warning + * first shipped. + * + *

This class exposes two surfaces: + *

    + *
  • The new {@link #loadFrom(Path)} instance method returning a + * {@link LoadResult} with a {@link CodeIqUnifiedConfig} overlay for + * the PROJECT layer. This is the Phase B path consumed by + * {@link UnifiedConfigBeans}. + *
  • The legacy {@link #loadIfPresent(Path, CodeIqConfig)} and + * {@link #loadProjectConfig(Path)} static methods kept for the + * existing {@code Analyzer} / {@code CliOutput} call sites. Migration + * of those call sites to {@link CodeIqUnifiedConfig} is tracked as + * internal task #52. + *
*/ -public final class ProjectConfigLoader { +@Component +public class ProjectConfigLoader { private static final Logger log = LoggerFactory.getLogger(ProjectConfigLoader.class); - private static final String[] CONFIG_FILE_NAMES = {".code-iq.yml", ".code-iq.yaml", ".osscodeiq.yml", ".osscodeiq.yaml"}; + private static final String NEW_NAME = "codeiq.yml"; + private static final String OLD_NAME = ".osscodeiq.yml"; + private static final String[] LEGACY_CONFIG_FILE_NAMES = { + ".code-iq.yml", ".code-iq.yaml", ".osscodeiq.yml", ".osscodeiq.yaml" + }; - private ProjectConfigLoader() { - // utility class + /** + * Top-level flat keys recognised by the pre-Phase-B {@code .osscodeiq.yml} + * schema. Presence of any of these at the YAML root triggers the + * legacy-to-unified translator. + */ + private static final Set LEGACY_FLAT_KEYS = Set.of( + "root_path", "service_name", "cache_dir", + "max_depth", "max_radius", "max_files", "max_snippet_lines", + "batch_size"); + + /** + * Per-canonical-path dedupe of the deprecation WARN so multi-workspace + * callers each see one warning. Keyed by canonical (realPath or + * normalized-absolute) string so symlinked/relative aliases collapse. + */ + private static final Set WARNED_PATHS = ConcurrentHashMap.newKeySet(); + + public ProjectConfigLoader() { + // default bean constructor + } + + /** + * Result of loading the project-scoped config. + * + * @param config the loaded overlay in unified-config form, or + * {@link CodeIqUnifiedConfig#empty()} if neither file exists + * @param deprecationWarningEmitted {@code true} iff the loader fell back to + * {@code .osscodeiq.yml} for this call + */ + public record LoadResult(CodeIqUnifiedConfig config, boolean deprecationWarningEmitted) {} + + /** + * Loads the project-scoped config overlay from {@code repoRoot}. Prefers + * {@code codeiq.yml}; if absent, falls back to the legacy + * {@code .osscodeiq.yml} and emits a per-path SLF4J {@code WARN} pointing + * to the new filename. If neither is present, returns an empty overlay. + * + *

The deprecation warning is logged at most once per canonical file path + * per JVM. The returned {@link LoadResult#deprecationWarningEmitted()} is + * still {@code true} on every fallback call so callers can label provenance + * appropriately. + */ + public LoadResult loadFrom(Path repoRoot) { + Path newFile = repoRoot.resolve(NEW_NAME); + if (Files.exists(newFile)) { + return new LoadResult(UnifiedConfigLoader.load(newFile), false); + } + Path oldFile = repoRoot.resolve(OLD_NAME); + if (Files.exists(oldFile)) { + LegacyParse parsed = readAndTranslateLegacy(oldFile); + String canonical = canonicalize(oldFile); + if (WARNED_PATHS.add(canonical)) { + log.warn(".osscodeiq.yml at {} is deprecated. Translated {} key(s) into the unified config; " + + "migrate to {} (see README for the new schema).", + oldFile, parsed.translatedKeyCount, NEW_NAME); + } + return new LoadResult(parsed.config, true); + } + return new LoadResult(CodeIqUnifiedConfig.empty(), false); + } + + private static String canonicalize(Path p) { + try { + return p.toRealPath().toString(); + } catch (IOException e) { + return p.toAbsolutePath().normalize().toString(); + } } + /** Container for the legacy-parse result + a count of flat keys translated (for the WARN message). */ + private record LegacyParse(CodeIqUnifiedConfig config, int translatedKeyCount) {} + /** - * Look for .osscodeiq.yml or .osscodeiq.yaml in the given directory. - * If found, parse it and apply matching properties to the config. + * Reads {@code oldFile}, detects whether it uses the legacy flat schema + * (top-level {@code max_depth}, {@code cache_dir}, etc.), and produces a + * {@link CodeIqUnifiedConfig} overlay. * - * @param directory the project root directory to search - * @param config the config to apply overrides to - * @return true if a config file was found and applied + *

Precedence when a file mixes shapes: legacy flat keys take + * priority over any nested {@code indexing}/{@code project} sections in + * the same file. Rationale: a user who still has flat keys is clearly on + * the pre-Phase-B schema; honoring the flat values prevents silent data + * loss while the warning tells them to migrate. Nested keys under + * {@code serving}/{@code mcp}/{@code observability}/{@code detectors} + * (which have no legacy flat equivalent) are still read via the unified + * loader path and composed into the overlay. */ @SuppressWarnings("unchecked") + private static LegacyParse readAndTranslateLegacy(Path oldFile) { + Map raw; + try { + String content = Files.readString(oldFile, StandardCharsets.UTF_8); + Yaml yaml = new Yaml(new org.yaml.snakeyaml.constructor.SafeConstructor( + new org.yaml.snakeyaml.LoaderOptions())); + raw = yaml.load(content); + } catch (IOException e) { + log.warn("Failed to read {}: {}", oldFile, e.getMessage()); + return new LegacyParse(CodeIqUnifiedConfig.empty(), 0); + } catch (Exception e) { + log.warn("Failed to parse {}: {}", oldFile, e.getMessage()); + return new LegacyParse(CodeIqUnifiedConfig.empty(), 0); + } + if (raw == null || raw.isEmpty()) { + return new LegacyParse(CodeIqUnifiedConfig.empty(), 0); + } + + boolean hasLegacy = false; + for (String k : LEGACY_FLAT_KEYS) { + if (raw.containsKey(k)) { hasLegacy = true; break; } + } + + if (!hasLegacy) { + // Pure new-shape content accidentally saved as .osscodeiq.yml. + // Delegate to the canonical loader so nested sections work as-is. + return new LegacyParse(UnifiedConfigLoader.load(oldFile), 0); + } + + return new LegacyParse(translateLegacyToUnified(raw), countLegacyKeys(raw)); + } + + private static int countLegacyKeys(Map raw) { + int n = 0; + for (String k : LEGACY_FLAT_KEYS) { + if (raw.containsKey(k)) n++; + } + return n; + } + + /** + * Translator: maps pre-Phase-B flat keys at the YAML root to a + * {@link CodeIqUnifiedConfig} overlay. Reuses {@link #parseProjectConfig} + * for the {@code languages}/{@code detectors}/{@code exclude}/{@code parsers}/ + * {@code pipeline.*} sections (same coercion rules) and adds the flat-key + * mapping documented in the Phase B migration table: + * + * 

+     *   root_path          -> project.root
+     *   service_name       -> project.serviceName
+     *   cache_dir          -> indexing.cacheDir
+     *   max_depth          -> indexing.maxDepth
+     *   max_radius         -> indexing.maxRadius
+     *   max_files          -> indexing.maxFiles
+     *   max_snippet_lines  -> indexing.maxSnippetLines
+     *   batch_size         -> indexing.batchSize
+     *
+ * + * Only section leaves present in {@code raw} are set; absent fields stay + * {@code null} so {@link io.github.randomcodespace.iq.config.unified.ConfigMerger} + * correctly falls through to lower layers. + */ + @SuppressWarnings("unchecked") + static CodeIqUnifiedConfig translateLegacyToUnified(Map raw) { + // --- project layer --- + String root = raw.containsKey("root_path") ? String.valueOf(raw.get("root_path")) : null; + String serviceName = raw.containsKey("service_name") ? String.valueOf(raw.get("service_name")) : null; + io.github.randomcodespace.iq.config.unified.ProjectConfig projectU = + new io.github.randomcodespace.iq.config.unified.ProjectConfig(null, root, serviceName, List.of()); + + // --- indexing layer (flat keys) --- + // Reuse parseProjectConfig to pull languages / exclude / pipeline.batch-size. + ProjectConfig legacy = parseProjectConfig(raw); + List languages = legacy.getLanguages(); + List exclude = legacy.getExclude(); + + String cacheDir = raw.containsKey("cache_dir") ? String.valueOf(raw.get("cache_dir")) : null; + Integer maxDepth = raw.containsKey("max_depth") ? toInteger(raw.get("max_depth")) : null; + Integer maxRadius = raw.containsKey("max_radius") ? toInteger(raw.get("max_radius")) : null; + Integer maxFiles = raw.containsKey("max_files") ? toInteger(raw.get("max_files")) : null; + Integer maxSnippetLines = raw.containsKey("max_snippet_lines") + ? toInteger(raw.get("max_snippet_lines")) : null; + // batch_size at the root is a legacy alias; pipeline.batch-size wins if BOTH are set + // because parseProjectConfig already reads the nested form. + Integer batchSize = legacy.getPipelineBatchSize(); + if (batchSize == null && raw.containsKey("batch_size")) { + batchSize = toInteger(raw.get("batch_size")); + } + String parallelism = legacy.getPipelineParallelism() == null + ? null : String.valueOf(legacy.getPipelineParallelism()); + + IndexingConfig indexingU = new IndexingConfig( + languages == null ? List.of() : languages, + List.of(), + exclude == null ? List.of() : exclude, + null, // incremental — no legacy flat equivalent + cacheDir, + parallelism, + batchSize, + maxDepth, + maxRadius, + maxFiles, + maxSnippetLines); + + return new CodeIqUnifiedConfig( + projectU, + indexingU, + ServingConfig.empty(), + McpConfig.empty(), + ObservabilityConfig.empty(), + DetectorsConfig.empty()); + } + + // --------------------------------------------------------------- + // Legacy static API — retained for pre-unified call sites only. + // Replacement tracked in internal task #52 — Analyzer/CliOutput migration. + // --------------------------------------------------------------- + + /** + * Look for {@code .code-iq.yml}/{@code .yaml} or {@code .osscodeiq.yml}/{@code .yaml} + * in the given directory. If found, parse it and apply matching properties to the + * legacy {@link CodeIqConfig} via setters. + * + *

Legacy path — new code should go through {@link #loadFrom(Path)} and the + * unified config tree. The setter-mutation path is scheduled for removal when + * {@code Analyzer} and {@code CliOutput} migrate (internal task #52). + * + * @deprecated since 0.2.0, for removal. Use {@link #loadFrom(Path)} instead. + */ + @Deprecated(since = "0.2.0", forRemoval = true) + @SuppressWarnings("unchecked") public static boolean loadIfPresent(Path directory, CodeIqConfig config) { - for (String name : CONFIG_FILE_NAMES) { + for (String name : LEGACY_CONFIG_FILE_NAMES) { Path configFile = directory.resolve(name); if (Files.isRegularFile(configFile)) { try { String content = Files.readString(configFile, StandardCharsets.UTF_8); - Yaml yaml = new Yaml(new org.yaml.snakeyaml.constructor.SafeConstructor(new org.yaml.snakeyaml.LoaderOptions())); + Yaml yaml = new Yaml(new org.yaml.snakeyaml.constructor.SafeConstructor( + new org.yaml.snakeyaml.LoaderOptions())); Map data = yaml.load(content); if (data != null) { applyOverrides(data, config); @@ -64,17 +297,21 @@ public static boolean loadIfPresent(Path directory, CodeIqConfig config) { /** * Load the full project configuration including pipeline filter settings. * - * @param directory the project root directory to search - * @return parsed ProjectConfig, or {@link ProjectConfig#empty()} if no config found + *

Legacy path — new code should go through {@link #loadFrom(Path)} and the + * unified config tree. Replacement tracked in internal task #52. + * + * @deprecated since 0.2.0, for removal. Use {@link #loadFrom(Path)} instead. */ + @Deprecated(since = "0.2.0", forRemoval = true) @SuppressWarnings("unchecked") public static ProjectConfig loadProjectConfig(Path directory) { - for (String name : CONFIG_FILE_NAMES) { + for (String name : LEGACY_CONFIG_FILE_NAMES) { Path configFile = directory.resolve(name); if (Files.isRegularFile(configFile)) { try { String content = Files.readString(configFile, StandardCharsets.UTF_8); - Yaml yaml = new Yaml(new org.yaml.snakeyaml.constructor.SafeConstructor(new org.yaml.snakeyaml.LoaderOptions())); + Yaml yaml = new Yaml(new org.yaml.snakeyaml.constructor.SafeConstructor( + new org.yaml.snakeyaml.LoaderOptions())); Map data = yaml.load(content); if (data != null) { log.info("Loaded project config from {}", configFile); @@ -91,27 +328,17 @@ public static ProjectConfig loadProjectConfig(Path directory) { } /** - * Parse a YAML data map into a structured ProjectConfig. - * Supports: - * 

-     * languages:
-     *   - java
-     *   - python
-     * detectors:
-     *   categories:
-     *     - endpoints
-     *     - entities
-     *   include:
-     *     - spring-rest-detector
-     * parsers:
-     *   java: javaparser
-     * pipeline:
-     *   parallelism: 4
-     *   batch-size: 100
-     * exclude:
-     *   - "*.generated.java"
-     *
+ * Parse a YAML data map into a structured legacy {@link ProjectConfig}. + * + *

Reused internally by {@link #translateLegacyToUnified} to pick up + * {@code languages} / {@code detectors} / {@code exclude} / {@code parsers} / + * {@code pipeline.*} sections in legacy files. + * + *

Legacy path — new code should go through {@link #loadFrom(Path)}. + * + * @deprecated since 0.2.0, for removal. Use {@link #loadFrom(Path)} instead. */ + @Deprecated(since = "0.2.0", forRemoval = true) @SuppressWarnings("unchecked") static ProjectConfig parseProjectConfig(Map data) { List languages = toStringList(data.get("languages")); @@ -163,7 +390,6 @@ private static void applyOverrides(Map data, CodeIqConfig config config.setMaxRadius(toInt(data.get("max_radius"), config.getMaxRadius())); } // Nested analysis/output sections are recognized but not yet mapped to CodeIqConfig. - // They are loaded and accessible via data map for CLI commands that need them. } private static int toInt(Object value, int defaultValue) { diff --git a/src/main/java/io/github/randomcodespace/iq/config/UnifiedConfigAdapter.java b/src/main/java/io/github/randomcodespace/iq/config/UnifiedConfigAdapter.java new file mode 100644 index 00000000..ba5812ba --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/UnifiedConfigAdapter.java @@ -0,0 +1,70 @@ +package io.github.randomcodespace.iq.config; + +import io.github.randomcodespace.iq.config.unified.CodeIqUnifiedConfig; + +/** + * Bridge between the new {@link CodeIqUnifiedConfig} tree and the legacy + * {@link CodeIqConfig} bean consumed by ~100 call sites. + * + *

Copies values from the unified tree onto a fresh {@link CodeIqConfig}. + * Fields absent from the unified tree (null) keep {@link CodeIqConfig}'s + * in-code defaults, so behavior matches the pre-unified-config wiring even + * when only a partial overlay is supplied. + * + *

When the call sites migrate to {@link CodeIqUnifiedConfig} directly + * (future refactor), this adapter can be deleted. + */ +public final class UnifiedConfigAdapter { + + private UnifiedConfigAdapter() {} + + public static CodeIqConfig toCodeIqConfig(CodeIqUnifiedConfig u) { + CodeIqConfig c = new CodeIqConfig(); + if (u == null) { + return c; + } + + if (u.project() != null) { + if (u.project().root() != null) { + c.setRootPath(u.project().root()); + } + if (u.project().serviceName() != null) { + c.setServiceName(u.project().serviceName()); + } + } + + if (u.indexing() != null) { + if (u.indexing().cacheDir() != null) { + c.setCacheDir(u.indexing().cacheDir()); + } + if (u.indexing().batchSize() != null) { + c.setBatchSize(u.indexing().batchSize()); + } + if (u.indexing().maxDepth() != null) { + c.setMaxDepth(u.indexing().maxDepth()); + } + if (u.indexing().maxRadius() != null) { + c.setMaxRadius(u.indexing().maxRadius()); + } + if (u.indexing().maxFiles() != null) { + c.setMaxFiles(u.indexing().maxFiles()); + } + if (u.indexing().maxSnippetLines() != null) { + c.setMaxSnippetLines(u.indexing().maxSnippetLines()); + } + } + + if (u.serving() != null) { + if (u.serving().readOnly() != null) { + c.setReadOnly(u.serving().readOnly()); + } + if (u.serving().neo4j() != null && u.serving().neo4j().dir() != null) { + CodeIqConfig.Graph graph = new CodeIqConfig.Graph(); + graph.setPath(u.serving().neo4j().dir()); + c.setGraph(graph); + } + } + + return c; + } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/UnifiedConfigBeans.java b/src/main/java/io/github/randomcodespace/iq/config/UnifiedConfigBeans.java new file mode 100644 index 00000000..8accac51 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/UnifiedConfigBeans.java @@ -0,0 +1,110 @@ +package io.github.randomcodespace.iq.config; + +import io.github.randomcodespace.iq.config.unified.CodeIqUnifiedConfig; +import io.github.randomcodespace.iq.config.unified.ConfigDefaults; +import io.github.randomcodespace.iq.config.unified.ConfigLayer; +import io.github.randomcodespace.iq.config.unified.ConfigMerger; +import io.github.randomcodespace.iq.config.unified.EnvVarOverlay; +import io.github.randomcodespace.iq.config.unified.MergedConfig; +import io.github.randomcodespace.iq.config.unified.UnifiedConfigLoader; +import io.github.randomcodespace.iq.graph.GraphStore; +import io.github.randomcodespace.iq.intelligence.provenance.ArtifactMetadataProvider; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Primary; +import org.springframework.context.annotation.Profile; + +import java.nio.file.Path; +import java.util.List; + +/** + * Produces the unified config tree and the legacy {@link CodeIqConfig} POJO for downstream consumers. + * + *

Config boundary: this class owns all runtime {@code codeiq.*} values (cache dirs, limits, + * pipeline tuning, MCP auth, etc.) via {@link CodeIqUnifiedConfig}. A narrow set of Spring-level + * keys stay in {@code application.yml} because they drive {@code @ConditionalOnProperty} / + * {@code @Value} machinery that reads Spring {@code Environment} directly and is not sourced from + * the unified tree: + * + *

    + *
  • {@code codeiq.neo4j.enabled} — gates {@link Neo4jConfig} (profile-conditional). + *
  • {@code codeiq.neo4j.bolt.port} — {@code @Value} default on the bolt port. + *
  • {@code codeiq.cors.allowed-origin-patterns} — {@code @Value} default in {@code CorsConfig}. + *
  • {@code codeiq.ui.enabled} — gates {@code SpaController}. + *
+ * + *

Everything else was migrated to {@code codeiq.yml} / env / CLI overlays in Phase B. + * + *

The unified bean is produced by running {@link ConfigResolver} once at startup (defaults + + * user-global yml + project yml + env vars). The legacy {@link CodeIqConfig} bean is derived from + * the unified tree via {@link UnifiedConfigAdapter#toCodeIqConfig}, so call sites that still depend + * on the legacy API continue to work unchanged. + * + *

Path layering (last wins): + * 

+ *   BUILT_IN    (ConfigDefaults.builtIn())
+ *   USER_GLOBAL (~/.codeiq/config.yml)
+ *   PROJECT     (./codeiq.yml)
+ *   ENV         (CODEIQ_* environment variables)
+ *   CLI         (injected per-command; not applied here)
+ *
+ */ +@Configuration +public class UnifiedConfigBeans { + + /** + * Resolves {@code codeiq.yml} (or, via {@link ProjectConfigLoader}, the + * deprecated {@code .osscodeiq.yml}) + env vars once at startup; the + * resulting {@link CodeIqUnifiedConfig} is the single source of truth + * for configuration. + * + *

The project layer is sourced through {@link ProjectConfigLoader} so + * users with a pre-Phase-B {@code .osscodeiq.yml} keep working for one + * release with a one-time {@code WARN} pointing them at {@code codeiq.yml}. + */ + @Bean + public CodeIqUnifiedConfig codeIqUnifiedConfig(ProjectConfigLoader loader) { + Path userGlobal = Path.of(System.getProperty("user.home"), ".codeiq", "config.yml"); + ProjectConfigLoader.LoadResult pr = loader.loadFrom(Path.of(".")); + // Compose defaults + user-global + project (from loader) + env. The CLI + // overlay is injected per-command elsewhere. + MergedConfig merged = new ConfigMerger().merge(List.of( + new ConfigMerger.Input(ConfigLayer.BUILT_IN, "(defaults)", ConfigDefaults.builtIn()), + new ConfigMerger.Input(ConfigLayer.USER_GLOBAL, userGlobal.toString(), + UnifiedConfigLoader.load(userGlobal)), + new ConfigMerger.Input(ConfigLayer.PROJECT, + pr.deprecationWarningEmitted() ? "./.osscodeiq.yml (deprecated)" : "./codeiq.yml", + pr.config()), + new ConfigMerger.Input(ConfigLayer.ENV, "(env)", EnvVarOverlay.from(System.getenv())) + )); + return merged.effective(); + } + + /** + * Back-compat bean for the legacy {@link CodeIqConfig} API. Produced by + * adapting the unified tree; preserves existing getter/setter surface + * consumed by ~100 call sites across the codebase. + */ + @Bean + @Primary + public CodeIqConfig codeIqConfig(CodeIqUnifiedConfig unified) { + return UnifiedConfigAdapter.toCodeIqConfig(unified); + } + + /** + * Provides on-demand artifact metadata in the {@code serving} profile. + * + *

Moved here from {@link CodeIqConfig} when that class stopped being a + * {@code @Configuration}. Graph-derived fields are resolved lazily so + * H2-to-Neo4j bootstrap can complete before clients fetch manifest data. + */ + @Bean + @Profile("serving") + public ArtifactMetadataProvider artifactMetadataProvider( + CodeIqConfig config, + @Autowired(required = false) GraphStore graphStore) { + Path root = Path.of(config.getRootPath()).toAbsolutePath().normalize(); + return new ArtifactMetadataProvider(root, graphStore); + } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/CodeIqUnifiedConfig.java b/src/main/java/io/github/randomcodespace/iq/config/unified/CodeIqUnifiedConfig.java new file mode 100644 index 00000000..4691b65a --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/CodeIqUnifiedConfig.java @@ -0,0 +1,28 @@ +package io.github.randomcodespace.iq.config.unified; + +/** + * Root of the unified configuration tree for code-iq. All sections are + * non-null; absent sections in a YAML source become their in-code defaults + * (see ConfigDefaults). Records are immutable — apply overlays by building + * a new instance via ConfigMerger. + */ +public record CodeIqUnifiedConfig( + ProjectConfig project, + IndexingConfig indexing, + ServingConfig serving, + McpConfig mcp, + ObservabilityConfig observability, + DetectorsConfig detectors +) { + /** Returns an instance with all sections at their empty defaults. */ + public static CodeIqUnifiedConfig empty() { + return new CodeIqUnifiedConfig( + ProjectConfig.empty(), + IndexingConfig.empty(), + ServingConfig.empty(), + McpConfig.empty(), + ObservabilityConfig.empty(), + DetectorsConfig.empty() + ); + } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigDefaults.java b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigDefaults.java new file mode 100644 index 00000000..4bce5402 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigDefaults.java @@ -0,0 +1,49 @@ +package io.github.randomcodespace.iq.config.unified; + +import java.util.List; +import java.util.Map; + +/** + * In-code defaults for the unified configuration. These values match + * the historical defaults from application.yml and picocli CLI flags, + * so existing users see identical behavior with a zero-byte codeiq.yml. + */ +public final class ConfigDefaults { + private ConfigDefaults() {} + + public static CodeIqUnifiedConfig builtIn() { + return new CodeIqUnifiedConfig( + new ProjectConfig(null, ".", null, List.of()), + new IndexingConfig( + List.of(), List.of(), List.of(), + true, + ".code-iq/cache", + "auto", + 500, + 10, // maxDepth — matches application.yml codeiq.max-depth + 10, // maxRadius — matches application.yml codeiq.max-radius + null, // maxFiles — not set in application.yml; CodeIqConfig default wins + null // maxSnippetLines — not set in application.yml; CodeIqConfig default wins + ), + new ServingConfig( + 8080, + "0.0.0.0", + false, + new Neo4jConfig( + ".code-iq/graph/graph.db", + 256, 256, 1024 + ) + ), + new McpConfig( + true, + "http", + "/mcp", + new McpAuthConfig("none", "CODEIQ_MCP_TOKEN"), + new McpLimitsConfig(15_000, 500, 2_000_000L, 300), + new McpToolsConfig(List.of("*"), List.of()) + ), + new ObservabilityConfig(true, false, "json", "info"), + new DetectorsConfig(List.of("default"), Map.of()) + ); + } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigError.java b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigError.java new file mode 100644 index 00000000..0851846b --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigError.java @@ -0,0 +1,3 @@ +package io.github.randomcodespace.iq.config.unified; + +public record ConfigError(String fieldPath, String message, String source) {} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigLayer.java b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigLayer.java new file mode 100644 index 00000000..8641a155 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigLayer.java @@ -0,0 +1,8 @@ +package io.github.randomcodespace.iq.config.unified; +public enum ConfigLayer { + BUILT_IN, + USER_GLOBAL, + PROJECT, + ENV, + CLI +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigLoadException.java b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigLoadException.java new file mode 100644 index 00000000..dbce1edd --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigLoadException.java @@ -0,0 +1,6 @@ +package io.github.randomcodespace.iq.config.unified; + +public class ConfigLoadException extends RuntimeException { + public ConfigLoadException(String message, Throwable cause) { super(message, cause); } + public ConfigLoadException(String message) { super(message); } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigMerger.java b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigMerger.java new file mode 100644 index 00000000..005be41d --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigMerger.java @@ -0,0 +1,133 @@ +package io.github.randomcodespace.iq.config.unified; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * Merges a list of CodeIqUnifiedConfig overlays in priority order (first entry + * lowest priority, last entry highest). At each scalar leaf, a non-null value + * in a higher-priority layer wins and replaces the value from lower layers. + * Lists and maps follow whole-value replacement (NOT element-wise merge) — + * this keeps behavior predictable and avoids surprising append semantics. + * + * The output also records the provenance (which layer set the final value + * for each leaf path), used by the `config explain` command. + */ +public final class ConfigMerger { + + public record Input(ConfigLayer layer, String sourceLabel, CodeIqUnifiedConfig overlay) {} + + public MergedConfig merge(List layers) { + CodeIqUnifiedConfig acc = CodeIqUnifiedConfig.empty(); + Map prov = new HashMap<>(); + for (Input layer : layers) { + acc = mergeTwo(acc, layer, prov); + } + return new MergedConfig(acc, prov); + } + + private CodeIqUnifiedConfig mergeTwo(CodeIqUnifiedConfig lo, Input hi, + Map prov) { + CodeIqUnifiedConfig hiCfg = hi.overlay(); + return new CodeIqUnifiedConfig( + mergeProject(lo.project(), hiCfg.project(), hi, prov), + mergeIndexing(lo.indexing(), hiCfg.indexing(), hi, prov), + mergeServing(lo.serving(), hiCfg.serving(), hi, prov), + mergeMcp(lo.mcp(), hiCfg.mcp(), hi, prov), + mergeObservability(lo.observability(), hiCfg.observability(), hi, prov), + mergeDetectors(lo.detectors(), hiCfg.detectors(), hi, prov) + ); + } + + private ProjectConfig mergeProject(ProjectConfig lo, ProjectConfig hi, Input l, Map p) { + return new ProjectConfig( + take("project.name", lo.name(), hi.name(), l, p), + take("project.root", lo.root(), hi.root(), l, p), + take("project.service_name", lo.serviceName(), hi.serviceName(), l, p), + takeList("project.modules", lo.modules(), hi.modules(), l, p)); + } + + private IndexingConfig mergeIndexing(IndexingConfig lo, IndexingConfig hi, Input l, Map p) { + return new IndexingConfig( + takeList("indexing.languages", lo.languages(), hi.languages(), l, p), + takeList("indexing.include", lo.include(), hi.include(), l, p), + takeList("indexing.exclude", lo.exclude(), hi.exclude(), l, p), + take("indexing.incremental", lo.incremental(), hi.incremental(), l, p), + take("indexing.cache_dir", lo.cacheDir(), hi.cacheDir(), l, p), + take("indexing.parallelism", lo.parallelism(), hi.parallelism(), l, p), + take("indexing.batch_size", lo.batchSize(), hi.batchSize(), l, p), + take("indexing.max_depth", lo.maxDepth(), hi.maxDepth(), l, p), + take("indexing.max_radius", lo.maxRadius(), hi.maxRadius(), l, p), + take("indexing.max_files", lo.maxFiles(), hi.maxFiles(), l, p), + take("indexing.max_snippet_lines", lo.maxSnippetLines(), hi.maxSnippetLines(), l, p)); + } + + private ServingConfig mergeServing(ServingConfig lo, ServingConfig hi, Input l, Map p) { + return new ServingConfig( + take("serving.port", lo.port(), hi.port(), l, p), + take("serving.bind_address", lo.bindAddress(), hi.bindAddress(), l, p), + take("serving.read_only", lo.readOnly(), hi.readOnly(), l, p), + new Neo4jConfig( + take("serving.neo4j.dir", lo.neo4j().dir(), hi.neo4j().dir(), l, p), + take("serving.neo4j.page_cache_mb", lo.neo4j().pageCacheMb(), hi.neo4j().pageCacheMb(), l, p), + take("serving.neo4j.heap_initial_mb", lo.neo4j().heapInitialMb(), hi.neo4j().heapInitialMb(), l, p), + take("serving.neo4j.heap_max_mb", lo.neo4j().heapMaxMb(), hi.neo4j().heapMaxMb(), l, p))); + } + + private McpConfig mergeMcp(McpConfig lo, McpConfig hi, Input l, Map p) { + return new McpConfig( + take("mcp.enabled", lo.enabled(), hi.enabled(), l, p), + take("mcp.transport", lo.transport(), hi.transport(), l, p), + take("mcp.base_path", lo.basePath(), hi.basePath(), l, p), + new McpAuthConfig( + take("mcp.auth.mode", lo.auth().mode(), hi.auth().mode(), l, p), + take("mcp.auth.token_env", lo.auth().tokenEnv(), hi.auth().tokenEnv(), l, p)), + new McpLimitsConfig( + take("mcp.limits.per_tool_timeout_ms", lo.limits().perToolTimeoutMs(), hi.limits().perToolTimeoutMs(), l, p), + take("mcp.limits.max_results", lo.limits().maxResults(), hi.limits().maxResults(), l, p), + take("mcp.limits.max_payload_bytes", lo.limits().maxPayloadBytes(), hi.limits().maxPayloadBytes(), l, p), + take("mcp.limits.rate_per_minute", lo.limits().ratePerMinute(), hi.limits().ratePerMinute(), l, p)), + new McpToolsConfig( + takeList("mcp.tools.enabled", lo.tools().enabled(), hi.tools().enabled(), l, p), + takeList("mcp.tools.disabled", lo.tools().disabled(), hi.tools().disabled(), l, p))); + } + + private ObservabilityConfig mergeObservability(ObservabilityConfig lo, ObservabilityConfig hi, Input l, Map p) { + return new ObservabilityConfig( + take("observability.metrics", lo.metrics(), hi.metrics(), l, p), + take("observability.tracing", lo.tracing(), hi.tracing(), l, p), + take("observability.log_format", lo.logFormat(), hi.logFormat(), l, p), + take("observability.log_level", lo.logLevel(), hi.logLevel(), l, p)); + } + + private DetectorsConfig mergeDetectors(DetectorsConfig lo, DetectorsConfig hi, Input l, Map p) { + return new DetectorsConfig( + takeList("detectors.profiles", lo.profiles(), hi.profiles(), l, p), + takeMap("detectors.overrides", lo.overrides(), hi.overrides(), l, p)); + } + + private T take(String path, T lo, T hi, Input l, Map p) { + if (hi != null) { + p.put(path, new ConfigProvenance(l.layer(), path, hi, l.sourceLabel())); + return hi; + } + return lo; + } + + private List takeList(String path, List lo, List hi, Input l, Map p) { + if (hi != null && !hi.isEmpty()) { + p.put(path, new ConfigProvenance(l.layer(), path, hi, l.sourceLabel())); + return hi; + } + return lo == null ? List.of() : lo; + } + + private Map takeMap(String path, Map lo, Map hi, Input l, Map p) { + if (hi != null && !hi.isEmpty()) { + p.put(path, new ConfigProvenance(l.layer(), path, hi, l.sourceLabel())); + return hi; + } + return lo == null ? Map.of() : lo; + } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigProvenance.java b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigProvenance.java new file mode 100644 index 00000000..787867c6 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigProvenance.java @@ -0,0 +1,3 @@ +package io.github.randomcodespace.iq.config.unified; + +public record ConfigProvenance(ConfigLayer layer, String fieldPath, Object value, String sourceLabel) {} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigResolver.java b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigResolver.java new file mode 100644 index 00000000..833135e8 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigResolver.java @@ -0,0 +1,46 @@ +package io.github.randomcodespace.iq.config.unified; + +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +/** + * Builder-style façade that composes ConfigDefaults + UnifiedConfigLoader + + * EnvVarOverlay + a caller-provided CLI overlay, then runs ConfigMerger, + * producing a MergedConfig with per-leaf provenance. Layer order + * (last wins): BUILT_IN -> USER_GLOBAL -> PROJECT -> ENV -> CLI. + */ +public final class ConfigResolver { + + private Path userGlobal; + private Path project; + private Map env = Map.of(); + private CodeIqUnifiedConfig cliOverlay = CodeIqUnifiedConfig.empty(); + private String cliLabel = "(cli)"; + + public ConfigResolver userGlobalPath(Path p) { this.userGlobal = p; return this; } + public ConfigResolver projectPath(Path p) { this.project = p; return this; } + public ConfigResolver env(Map env) { this.env = env; return this; } + public ConfigResolver cliOverlay(CodeIqUnifiedConfig c, String label) { + this.cliOverlay = c == null ? CodeIqUnifiedConfig.empty() : c; + this.cliLabel = label == null ? "(cli)" : label; + return this; + } + + public MergedConfig resolve() { + List layers = new ArrayList<>(); + layers.add(new ConfigMerger.Input(ConfigLayer.BUILT_IN, "(defaults)", ConfigDefaults.builtIn())); + if (userGlobal != null) { + layers.add(new ConfigMerger.Input(ConfigLayer.USER_GLOBAL, userGlobal.toString(), + UnifiedConfigLoader.load(userGlobal))); + } + if (project != null) { + layers.add(new ConfigMerger.Input(ConfigLayer.PROJECT, project.toString(), + UnifiedConfigLoader.load(project))); + } + layers.add(new ConfigMerger.Input(ConfigLayer.ENV, "(env)", EnvVarOverlay.from(env))); + layers.add(new ConfigMerger.Input(ConfigLayer.CLI, cliLabel, cliOverlay)); + return new ConfigMerger().merge(layers); + } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigValidator.java b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigValidator.java new file mode 100644 index 00000000..71b4360e --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/ConfigValidator.java @@ -0,0 +1,73 @@ +package io.github.randomcodespace.iq.config.unified; + +import java.util.ArrayList; +import java.util.List; +import java.util.Set; + +/** + * Validates a merged CodeIqUnifiedConfig. Uses explicit checks rather than + * jakarta.validation annotations because records with inherited nullability + * and enum-like string fields are awkward to express via bean-validation + * alone. The explicit approach also keeps the error messages actionable. + */ +public final class ConfigValidator { + + private static final Set MCP_TRANSPORTS = Set.of("http", "stdio"); + private static final Set MCP_AUTH_MODES = Set.of("none", "bearer", "mtls"); + private static final Set LOG_FORMATS = Set.of("json", "text"); + private static final Set LOG_LEVELS = Set.of("trace", "debug", "info", "warn", "error"); + + public List validate(CodeIqUnifiedConfig c) { + List errs = new ArrayList<>(); + + // serving.port + if (c.serving().port() != null && (c.serving().port() < 1 || c.serving().port() > 65535)) { + errs.add(new ConfigError("serving.port", + "port must be 1-65535; got " + c.serving().port(), "validator")); + } + + // serving.neo4j.*_mb + Integer pc = c.serving().neo4j().pageCacheMb(); + Integer hi = c.serving().neo4j().heapInitialMb(); + Integer hm = c.serving().neo4j().heapMaxMb(); + if (pc != null && pc < 0) errs.add(new ConfigError("serving.neo4j.page_cache_mb", "must be >= 0", "validator")); + if (hi != null && hi < 0) errs.add(new ConfigError("serving.neo4j.heap_initial_mb", "must be >= 0", "validator")); + if (hm != null && hm < 0) errs.add(new ConfigError("serving.neo4j.heap_max_mb", "must be >= 0", "validator")); + if (hi != null && hm != null && hi > hm) + errs.add(new ConfigError("serving.neo4j.heap_initial_mb", + "heap_initial_mb (" + hi + ") must be <= heap_max_mb (" + hm + ")", "validator")); + + // indexing.batch_size + if (c.indexing().batchSize() != null && c.indexing().batchSize() <= 0) + errs.add(new ConfigError("indexing.batch_size", "must be > 0", "validator")); + + // mcp.transport + if (c.mcp().transport() != null && !MCP_TRANSPORTS.contains(c.mcp().transport())) + errs.add(new ConfigError("mcp.transport", + "must be one of " + MCP_TRANSPORTS + "; got " + c.mcp().transport(), "validator")); + + // mcp.auth.mode + if (c.mcp().auth().mode() != null && !MCP_AUTH_MODES.contains(c.mcp().auth().mode())) + errs.add(new ConfigError("mcp.auth.mode", + "must be one of " + MCP_AUTH_MODES + "; got " + c.mcp().auth().mode(), "validator")); + + // mcp.limits.* + Integer perTool = c.mcp().limits().perToolTimeoutMs(); + if (perTool != null && perTool <= 0) + errs.add(new ConfigError("mcp.limits.per_tool_timeout_ms", "must be > 0", "validator")); + Integer maxRes = c.mcp().limits().maxResults(); + if (maxRes != null && maxRes <= 0) + errs.add(new ConfigError("mcp.limits.max_results", "must be > 0", "validator")); + + // observability.log_format / log_level + if (c.observability().logFormat() != null && !LOG_FORMATS.contains(c.observability().logFormat())) + errs.add(new ConfigError("observability.log_format", + "must be one of " + LOG_FORMATS + "; got " + c.observability().logFormat(), "validator")); + if (c.observability().logLevel() != null + && !LOG_LEVELS.contains(c.observability().logLevel().toLowerCase())) + errs.add(new ConfigError("observability.log_level", + "must be one of " + LOG_LEVELS + "; got " + c.observability().logLevel(), "validator")); + + return errs; + } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/DetectorOverride.java b/src/main/java/io/github/randomcodespace/iq/config/unified/DetectorOverride.java new file mode 100644 index 00000000..5959e9ee --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/DetectorOverride.java @@ -0,0 +1,4 @@ +package io.github.randomcodespace.iq.config.unified; +public record DetectorOverride(Boolean enabled) { + public static DetectorOverride empty() { return new DetectorOverride(null); } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/DetectorsConfig.java b/src/main/java/io/github/randomcodespace/iq/config/unified/DetectorsConfig.java new file mode 100644 index 00000000..566acf65 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/DetectorsConfig.java @@ -0,0 +1,6 @@ +package io.github.randomcodespace.iq.config.unified; +import java.util.List; +import java.util.Map; +public record DetectorsConfig(List profiles, Map overrides) { + public static DetectorsConfig empty() { return new DetectorsConfig(List.of(), Map.of()); } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/EnvVarOverlay.java b/src/main/java/io/github/randomcodespace/iq/config/unified/EnvVarOverlay.java new file mode 100644 index 00000000..f6d25de3 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/EnvVarOverlay.java @@ -0,0 +1,102 @@ +package io.github.randomcodespace.iq.config.unified; + +import java.util.Arrays; +import java.util.List; +import java.util.Map; + +/** + * Folds CODEIQ_

_ environment variables into a CodeIqUnifiedConfig + * overlay. Unknown variable names are ignored (forward-compatible with new + * sections). Type mismatches (e.g. non-numeric port) throw ConfigLoadException + * with the variable name in the message. + * + * Mapping rule: strip CODEIQ_ prefix, lowercase, split by "_", and walk the + * record tree. Dotted names are not supported (use separate _ segments). + */ +public final class EnvVarOverlay { + private EnvVarOverlay() {} + + public static CodeIqUnifiedConfig from(Map env) { + Integer port = null, batch = null, perToolMs = null, maxResults = null, ratePerMin = null, + pageMb = null, heapInit = null, heapMax = null, + maxDepth = null, maxRadius = null, maxFiles = null, maxSnippetLines = null; + Long maxPayload = null; + Boolean readOnly = null, incremental = null, metrics = null, tracing = null, mcpEnabled = null; + String cacheDir = null, bindAddr = null, projectName = null, projectRoot = null, + projectServiceName = null, + neo4jDir = null, mcpTransport = null, mcpBasePath = null, mcpMode = null, + mcpTokenEnv = null, logFormat = null, logLevel = null, parallelism = null; + List languages = List.of(), include = List.of(), exclude = List.of(), + toolsEnabled = List.of(), toolsDisabled = List.of(), profiles = List.of(); + + for (var e : env.entrySet()) { + String k = e.getKey(), v = e.getValue(); + if (!k.startsWith("CODEIQ_")) continue; + String key = k.substring("CODEIQ_".length()); + try { + switch (key) { + case "PROJECT_NAME" -> projectName = v; + case "PROJECT_ROOT" -> projectRoot = v; + case "PROJECT_SERVICE_NAME" -> projectServiceName = v; + case "INDEXING_LANGUAGES" -> languages = splitCsv(v); + case "INDEXING_INCLUDE" -> include = splitCsv(v); + case "INDEXING_EXCLUDE" -> exclude = splitCsv(v); + case "INDEXING_INCREMENTAL" -> incremental = Boolean.parseBoolean(v); + case "INDEXING_CACHEDIR" -> cacheDir = v; + case "INDEXING_PARALLELISM" -> parallelism = v; + case "INDEXING_BATCHSIZE" -> batch = Integer.parseInt(v); + case "INDEXING_MAX_DEPTH" -> maxDepth = Integer.parseInt(v); + case "INDEXING_MAX_RADIUS" -> maxRadius = Integer.parseInt(v); + case "INDEXING_MAX_FILES" -> maxFiles = Integer.parseInt(v); + case "INDEXING_MAX_SNIPPET_LINES" -> maxSnippetLines = Integer.parseInt(v); + case "SERVING_PORT" -> port = Integer.parseInt(v); + case "SERVING_BINDADDRESS" -> bindAddr = v; + case "SERVING_READONLY" -> readOnly = Boolean.parseBoolean(v); + case "SERVING_NEO4J_DIR" -> neo4jDir = v; + case "SERVING_NEO4J_PAGECACHEMB" -> pageMb = Integer.parseInt(v); + case "SERVING_NEO4J_HEAPINITIALMB" -> heapInit = Integer.parseInt(v); + case "SERVING_NEO4J_HEAPMAXMB" -> heapMax = Integer.parseInt(v); + case "MCP_ENABLED" -> mcpEnabled = Boolean.parseBoolean(v); + case "MCP_TRANSPORT" -> mcpTransport = v; + case "MCP_BASEPATH" -> mcpBasePath = v; + case "MCP_AUTH_MODE" -> mcpMode = v; + case "MCP_AUTH_TOKENENV" -> mcpTokenEnv = v; + case "MCP_LIMITS_PERTOOLTIMEOUTMS" -> perToolMs = Integer.parseInt(v); + case "MCP_LIMITS_MAXRESULTS" -> maxResults = Integer.parseInt(v); + case "MCP_LIMITS_MAXPAYLOADBYTES" -> maxPayload = Long.parseLong(v); + case "MCP_LIMITS_RATEPERMINUTE" -> ratePerMin = Integer.parseInt(v); + case "MCP_TOOLS_ENABLED" -> toolsEnabled = splitCsv(v); + case "MCP_TOOLS_DISABLED" -> toolsDisabled = splitCsv(v); + case "OBSERVABILITY_METRICS" -> metrics = Boolean.parseBoolean(v); + case "OBSERVABILITY_TRACING" -> tracing = Boolean.parseBoolean(v); + case "OBSERVABILITY_LOGFORMAT" -> logFormat = v; + case "OBSERVABILITY_LOGLEVEL" -> logLevel = v; + case "DETECTORS_PROFILES" -> profiles = splitCsv(v); + default -> { /* unknown key — ignore, forward-compatible */ } + } + } catch (NumberFormatException nfe) { + throw new ConfigLoadException( + "Env var " + k + " must be numeric; got '" + v + "'", nfe); + } + } + + return new CodeIqUnifiedConfig( + new ProjectConfig(projectName, projectRoot, projectServiceName, List.of()), + new IndexingConfig(languages, include, exclude, incremental, cacheDir, parallelism, batch, + maxDepth, maxRadius, maxFiles, maxSnippetLines), + new ServingConfig(port, bindAddr, readOnly, + new Neo4jConfig(neo4jDir, pageMb, heapInit, heapMax)), + new McpConfig(mcpEnabled, mcpTransport, mcpBasePath, + new McpAuthConfig(mcpMode, mcpTokenEnv), + new McpLimitsConfig(perToolMs, maxResults, maxPayload, ratePerMin), + new McpToolsConfig(toolsEnabled, toolsDisabled)), + new ObservabilityConfig(metrics, tracing, logFormat, logLevel), + new DetectorsConfig(profiles, Map.of()) + ); + } + + private static List splitCsv(String v) { + if (v == null || v.isBlank()) return List.of(); + return Arrays.stream(v.split(",")).map(String::trim).filter(s -> !s.isEmpty()).toList(); + } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/IndexingConfig.java b/src/main/java/io/github/randomcodespace/iq/config/unified/IndexingConfig.java new file mode 100644 index 00000000..c27e2c84 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/IndexingConfig.java @@ -0,0 +1,13 @@ +package io.github.randomcodespace.iq.config.unified; +import java.util.List; +public record IndexingConfig( + List languages, List include, List exclude, + Boolean incremental, String cacheDir, String parallelism, Integer batchSize, + Integer maxDepth, Integer maxRadius, Integer maxFiles, Integer maxSnippetLines) { + public static IndexingConfig empty() { + return new IndexingConfig( + List.of(), List.of(), List.of(), + null, null, null, null, + null, null, null, null); + } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/McpAuthConfig.java b/src/main/java/io/github/randomcodespace/iq/config/unified/McpAuthConfig.java new file mode 100644 index 00000000..6fa8e9d9 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/McpAuthConfig.java @@ -0,0 +1,4 @@ +package io.github.randomcodespace.iq.config.unified; +public record McpAuthConfig(String mode, String tokenEnv) { + public static McpAuthConfig empty() { return new McpAuthConfig(null, null); } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/McpConfig.java b/src/main/java/io/github/randomcodespace/iq/config/unified/McpConfig.java new file mode 100644 index 00000000..19280e08 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/McpConfig.java @@ -0,0 +1,7 @@ +package io.github.randomcodespace.iq.config.unified; +public record McpConfig(Boolean enabled, String transport, String basePath, + McpAuthConfig auth, McpLimitsConfig limits, McpToolsConfig tools) { + public static McpConfig empty() { + return new McpConfig(null, null, null, McpAuthConfig.empty(), McpLimitsConfig.empty(), McpToolsConfig.empty()); + } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/McpLimitsConfig.java b/src/main/java/io/github/randomcodespace/iq/config/unified/McpLimitsConfig.java new file mode 100644 index 00000000..76801f41 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/McpLimitsConfig.java @@ -0,0 +1,5 @@ +package io.github.randomcodespace.iq.config.unified; +public record McpLimitsConfig(Integer perToolTimeoutMs, Integer maxResults, + Long maxPayloadBytes, Integer ratePerMinute) { + public static McpLimitsConfig empty() { return new McpLimitsConfig(null, null, null, null); } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/McpToolsConfig.java b/src/main/java/io/github/randomcodespace/iq/config/unified/McpToolsConfig.java new file mode 100644 index 00000000..6696eb3b --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/McpToolsConfig.java @@ -0,0 +1,5 @@ +package io.github.randomcodespace.iq.config.unified; +import java.util.List; +public record McpToolsConfig(List enabled, List disabled) { + public static McpToolsConfig empty() { return new McpToolsConfig(List.of(), List.of()); } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/MergedConfig.java b/src/main/java/io/github/randomcodespace/iq/config/unified/MergedConfig.java new file mode 100644 index 00000000..600215e1 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/MergedConfig.java @@ -0,0 +1,5 @@ +package io.github.randomcodespace.iq.config.unified; + +import java.util.Map; + +public record MergedConfig(CodeIqUnifiedConfig effective, Map provenance) {} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/ModuleConfig.java b/src/main/java/io/github/randomcodespace/iq/config/unified/ModuleConfig.java new file mode 100644 index 00000000..25d49511 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/ModuleConfig.java @@ -0,0 +1,2 @@ +package io.github.randomcodespace.iq.config.unified; +public record ModuleConfig(String path, String type, String name, String kind) {} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/Neo4jConfig.java b/src/main/java/io/github/randomcodespace/iq/config/unified/Neo4jConfig.java new file mode 100644 index 00000000..df8e3ac0 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/Neo4jConfig.java @@ -0,0 +1,4 @@ +package io.github.randomcodespace.iq.config.unified; +public record Neo4jConfig(String dir, Integer pageCacheMb, Integer heapInitialMb, Integer heapMaxMb) { + public static Neo4jConfig empty() { return new Neo4jConfig(null, null, null, null); } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/ObservabilityConfig.java b/src/main/java/io/github/randomcodespace/iq/config/unified/ObservabilityConfig.java new file mode 100644 index 00000000..78cc33fa --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/ObservabilityConfig.java @@ -0,0 +1,4 @@ +package io.github.randomcodespace.iq.config.unified; +public record ObservabilityConfig(Boolean metrics, Boolean tracing, String logFormat, String logLevel) { + public static ObservabilityConfig empty() { return new ObservabilityConfig(null, null, null, null); } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/ProjectConfig.java b/src/main/java/io/github/randomcodespace/iq/config/unified/ProjectConfig.java new file mode 100644 index 00000000..a5dffeb1 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/ProjectConfig.java @@ -0,0 +1,5 @@ +package io.github.randomcodespace.iq.config.unified; +import java.util.List; +public record ProjectConfig(String name, String root, String serviceName, List modules) { + public static ProjectConfig empty() { return new ProjectConfig(null, null, null, List.of()); } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/ServingConfig.java b/src/main/java/io/github/randomcodespace/iq/config/unified/ServingConfig.java new file mode 100644 index 00000000..8734794f --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/ServingConfig.java @@ -0,0 +1,4 @@ +package io.github.randomcodespace.iq.config.unified; +public record ServingConfig(Integer port, String bindAddress, Boolean readOnly, Neo4jConfig neo4j) { + public static ServingConfig empty() { return new ServingConfig(null, null, null, Neo4jConfig.empty()); } +} diff --git a/src/main/java/io/github/randomcodespace/iq/config/unified/UnifiedConfigLoader.java b/src/main/java/io/github/randomcodespace/iq/config/unified/UnifiedConfigLoader.java new file mode 100644 index 00000000..194b18a2 --- /dev/null +++ b/src/main/java/io/github/randomcodespace/iq/config/unified/UnifiedConfigLoader.java @@ -0,0 +1,245 @@ +package io.github.randomcodespace.iq.config.unified; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.yaml.snakeyaml.LoaderOptions; +import org.yaml.snakeyaml.Yaml; +import org.yaml.snakeyaml.constructor.SafeConstructor; +import org.yaml.snakeyaml.error.YAMLException; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.HashSet; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; + +/** + * Reads a single codeiq.yml file into a CodeIqUnifiedConfig overlay. + * Missing file => CodeIqUnifiedConfig.empty(). Malformed YAML or type + * mismatches throw ConfigLoadException with the file path and failing + * field name in the message. + * + *

Key casing policy: snake_case is the primary, canonical form for every + * leaf key. camelCase spellings are accepted as deprecated aliases for one + * release so users with in-flight configs keep working. When both spellings + * appear in the same file for the same leaf, the snake_case value wins and + * a single WARN is logged naming the camelCase form as deprecated. Each + * deprecated alias produces at most one WARN per load() call (per-file + * dedupe) so a large legacy file does not spam the log. + */ +public final class UnifiedConfigLoader { + private static final Logger log = LoggerFactory.getLogger(UnifiedConfigLoader.class); + + private UnifiedConfigLoader() {} + + public static CodeIqUnifiedConfig load(Path path) { + if (path == null || !Files.exists(path)) { + return CodeIqUnifiedConfig.empty(); + } + String yaml; + try { + yaml = Files.readString(path, StandardCharsets.UTF_8); + } catch (IOException e) { + throw new ConfigLoadException("Cannot read config file " + path, e); + } + Yaml parser = new Yaml(new SafeConstructor(new LoaderOptions())); + Object raw; + try { + raw = parser.load(yaml); + } catch (YAMLException e) { + throw new ConfigLoadException( + "Malformed YAML in " + path + ": " + e.getMessage(), e); + } + if (raw == null) return CodeIqUnifiedConfig.empty(); + if (!(raw instanceof Map m)) { + throw new ConfigLoadException( + "Top-level of " + path + " must be a mapping, got: " + raw.getClass().getSimpleName()); + } + try { + return fromMap(m, path); + } catch (ClassCastException | IllegalArgumentException e) { + throw new ConfigLoadException( + "Type mismatch in " + path + ": " + e.getMessage(), e); + } + } + + @SuppressWarnings("unchecked") + private static CodeIqUnifiedConfig fromMap(Map m, Path path) { + // Per-load dedupe: every deprecated-alias form warned only once per file. + Set warnedAliases = new HashSet<>(); + return new CodeIqUnifiedConfig( + projectFrom((Map) m.get("project"), path, warnedAliases), + indexingFrom((Map) m.get("indexing"), path, warnedAliases), + servingFrom((Map) m.get("serving"), path, warnedAliases), + mcpFrom((Map) m.get("mcp"), path, warnedAliases), + observabilityFrom((Map) m.get("observability"), path, warnedAliases), + detectorsFrom((Map) m.get("detectors")) + ); + } + + @SuppressWarnings("unchecked") + private static ProjectConfig projectFrom(Map m, Path path, Set warned) { + if (m == null) return ProjectConfig.empty(); + List> modRaw = (List>) m.get("modules"); + List mods = modRaw == null ? List.of() + : modRaw.stream().map(x -> new ModuleConfig( + (String) x.get("path"), + (String) x.get("type"), + (String) x.get("name"), + (String) x.get("kind"))).toList(); + // project.service_name (canonical) / serviceName (deprecated alias) + String serviceName = (String) pick(m, "project", "service_name", "serviceName", path, warned); + return new ProjectConfig( + (String) m.get("name"), + (String) m.getOrDefault("root", "."), + serviceName, + mods); + } + + private static IndexingConfig indexingFrom(Map m, Path path, Set warned) { + if (m == null) return IndexingConfig.empty(); + return new IndexingConfig( + asStringList(m.get("languages")), + asStringList(m.get("include")), + asStringList(m.get("exclude")), + (Boolean) m.get("incremental"), + (String) pick(m, "indexing", "cache_dir", "cacheDir", path, warned), + m.get("parallelism") == null ? null : String.valueOf(m.get("parallelism")), + requireIntOrNull(pick(m, "indexing", "batch_size", "batchSize", path, warned), + path, "indexing.batch_size"), + requireIntOrNull(m.get("max_depth"), path, "indexing.max_depth"), + requireIntOrNull(m.get("max_radius"), path, "indexing.max_radius"), + requireIntOrNull(m.get("max_files"), path, "indexing.max_files"), + requireIntOrNull(m.get("max_snippet_lines"), path, "indexing.max_snippet_lines")); + } + + @SuppressWarnings("unchecked") + private static ServingConfig servingFrom(Map m, Path path, Set warned) { + if (m == null) return ServingConfig.empty(); + Neo4jConfig n4j = neo4jFrom((Map) m.get("neo4j"), path, warned); + return new ServingConfig( + requireIntOrNull(m.get("port"), path, "serving.port"), + (String) pick(m, "serving", "bind_address", "bindAddress", path, warned), + (Boolean) pick(m, "serving", "read_only", "readOnly", path, warned), + n4j); + } + + private static Neo4jConfig neo4jFrom(Map m, Path path, Set warned) { + if (m == null) return Neo4jConfig.empty(); + return new Neo4jConfig( + (String) m.get("dir"), + requireIntOrNull(pick(m, "serving.neo4j", "page_cache_mb", "pageCacheMb", path, warned), + path, "serving.neo4j.page_cache_mb"), + requireIntOrNull(pick(m, "serving.neo4j", "heap_initial_mb", "heapInitialMb", path, warned), + path, "serving.neo4j.heap_initial_mb"), + requireIntOrNull(pick(m, "serving.neo4j", "heap_max_mb", "heapMaxMb", path, warned), + path, "serving.neo4j.heap_max_mb")); + } + + @SuppressWarnings("unchecked") + private static McpConfig mcpFrom(Map m, Path path, Set warned) { + if (m == null) return McpConfig.empty(); + Map auth = (Map) m.get("auth"); + Map lim = (Map) m.get("limits"); + Map tls = (Map) m.get("tools"); + return new McpConfig( + (Boolean) m.get("enabled"), + (String) m.get("transport"), + (String) pick(m, "mcp", "base_path", "basePath", path, warned), + auth == null ? McpAuthConfig.empty() : new McpAuthConfig( + (String) auth.get("mode"), + (String) pick(auth, "mcp.auth", "token_env", "tokenEnv", path, warned)), + lim == null ? McpLimitsConfig.empty() : new McpLimitsConfig( + requireIntOrNull(pick(lim, "mcp.limits", "per_tool_timeout_ms", "perToolTimeoutMs", path, warned), + path, "mcp.limits.per_tool_timeout_ms"), + requireIntOrNull(pick(lim, "mcp.limits", "max_results", "maxResults", path, warned), + path, "mcp.limits.max_results"), + requireLongOrNull(pick(lim, "mcp.limits", "max_payload_bytes", "maxPayloadBytes", path, warned), + path, "mcp.limits.max_payload_bytes"), + requireIntOrNull(pick(lim, "mcp.limits", "rate_per_minute", "ratePerMinute", path, warned), + path, "mcp.limits.rate_per_minute")), + tls == null ? McpToolsConfig.empty() : new McpToolsConfig( + asStringList(tls.get("enabled")), + asStringList(tls.get("disabled")))); + } + + private static ObservabilityConfig observabilityFrom(Map m, Path path, Set warned) { + if (m == null) return ObservabilityConfig.empty(); + return new ObservabilityConfig( + (Boolean) m.get("metrics"), + (Boolean) m.get("tracing"), + (String) pick(m, "observability", "log_format", "logFormat", path, warned), + (String) pick(m, "observability", "log_level", "logLevel", path, warned)); + } + + @SuppressWarnings("unchecked") + private static DetectorsConfig detectorsFrom(Map m) { + if (m == null) return DetectorsConfig.empty(); + Map overrides = new LinkedHashMap<>(); + Map raw = (Map) m.getOrDefault("overrides", Map.of()); + for (var e : raw.entrySet()) { + Map v = (Map) e.getValue(); + overrides.put(e.getKey(), new DetectorOverride(v == null ? null : (Boolean) v.get("enabled"))); + } + return new DetectorsConfig(asStringList(m.get("profiles")), overrides); + } + + /** + * Returns the value for a leaf that has both a canonical snake_case key and a + * deprecated camelCase alias. Precedence: + *

    + *
  1. If the canonical key is present, use it. If the alias is also + * present (conflict), emit a WARN and discard the alias.
    2. + *
  2. Otherwise, if only the alias is present, use it and emit a WARN.
    3. + *
  3. Otherwise, return {@code null} (unset).
    4. + *
+ * The {@code warned} set guarantees one WARN per alias per file. + */ + private static Object pick(Map m, String section, + String canonical, String alias, + Path path, Set warned) { + boolean hasCanonical = m.containsKey(canonical); + boolean hasAlias = m.containsKey(alias); + String aliasPath = section + "." + alias; + String canonicalPath = section + "." + canonical; + if (hasCanonical && hasAlias) { + if (warned.add(aliasPath)) { + log.warn("codeiq.yml {}: both '{}' and deprecated alias '{}' set; using " + + "'{}'. Remove '{}' -- camelCase keys will be removed in a " + + "future release.", path, canonicalPath, aliasPath, canonicalPath, aliasPath); + } + return m.get(canonical); + } + if (hasAlias) { + if (warned.add(aliasPath)) { + log.warn("codeiq.yml {}: deprecated camelCase key '{}' -- rename to " + + "'{}'. camelCase keys will be removed in a future release.", + path, aliasPath, canonicalPath); + } + return m.get(alias); + } + return m.get(canonical); + } + + private static List asStringList(Object o) { + if (o == null) return List.of(); + if (o instanceof List l) return l.stream().map(String::valueOf).toList(); + throw new IllegalArgumentException("expected list, got: " + o.getClass().getSimpleName()); + } + + private static Integer requireIntOrNull(Object o, Path path, String field) { + if (o == null) return null; + if (o instanceof Number n) return n.intValue(); + throw new IllegalArgumentException(field + " must be an integer; got " + o); + } + + private static Long requireLongOrNull(Object o, Path path, String field) { + if (o == null) return null; + if (o instanceof Number n) return n.longValue(); + throw new IllegalArgumentException(field + " must be an integer; got " + o); + } +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml index 1fb55d70..b6d9b822 100644 --- a/src/main/resources/application.yml +++ b/src/main/resources/application.yml @@ -22,14 +22,15 @@ management: exposure: include: health,info,metrics +# Runtime codeiq.* values (cache dir, limits, pipeline tuning, MCP auth, etc.) +# are sourced from codeiq.yml / env / CLI via CodeIqUnifiedConfig (see +# UnifiedConfigBeans.java). The keys kept here are ONLY those consumed +# directly by Spring's Environment for @ConditionalOnProperty / @Value: +# codeiq.ui.enabled -> SpaController @ConditionalOnProperty +# codeiq.neo4j.enabled -> Neo4jConfig @ConditionalOnProperty (profile-conditional, below) +# codeiq.neo4j.bolt.port -> Neo4jConfig @Value (default 7688) +# codeiq.cors.allowed-origin-patterns -> CorsConfig @Value (default patterns) codeiq: - root-path: "." - cache-dir: ".code-iq/cache" - graph: - path: ".code-iq/graph/graph.db" - max-depth: 10 - max-radius: 10 - batch-size: 500 ui: enabled: true diff --git a/src/test/java/io/github/randomcodespace/iq/cli/ConfigExplainSubcommandTest.java b/src/test/java/io/github/randomcodespace/iq/cli/ConfigExplainSubcommandTest.java new file mode 100644 index 00000000..b0019bb9 --- /dev/null +++ b/src/test/java/io/github/randomcodespace/iq/cli/ConfigExplainSubcommandTest.java @@ -0,0 +1,223 @@ +package io.github.randomcodespace.iq.cli; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import io.github.randomcodespace.iq.config.unified.CodeIqUnifiedConfig; +import io.github.randomcodespace.iq.config.unified.ServingConfig; +import java.io.ByteArrayOutputStream; +import java.io.PrintStream; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Map; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +/** + * Behaviour tests for {@link ConfigExplainSubcommand}. + * + *

Covers the contract promised in Task 9 of the Phase B unified-config plan: + * + *

    + *
  • each leaf field in the merged config is emitted on stdout with its value, source layer, and + * source label; + *
  • output is deterministic (sorted by field path); + *
  • ENV-layer overrides are reflected as {@code ENV}; + *
  • missing {@code --path} file surfaces a load error on stderr with a non-zero exit, mirroring + * {@link ConfigValidateSubcommand}. + *
+ */ +class ConfigExplainSubcommandTest { + + @Test + void printsProvenanceForEachLeaf(@TempDir Path tmp) throws Exception { + Path cfg = tmp.resolve("codeiq.yml"); + Files.writeString(cfg, "serving:\n port: 9000\n"); + + ByteArrayOutputStream outBuf = new ByteArrayOutputStream(); + ByteArrayOutputStream errBuf = new ByteArrayOutputStream(); + ConfigExplainSubcommand cmd = + new ConfigExplainSubcommand( + new PrintStream(outBuf, true, StandardCharsets.UTF_8), + new PrintStream(errBuf, true, StandardCharsets.UTF_8)); + cmd.setPath(cfg); + cmd.setEnv(Map.of("CODEIQ_MCP_LIMITS_PERTOOLTIMEOUTMS", "30000")); + + int rc = cmd.call(); + + assertEquals(0, rc, "explain should succeed; stderr=" + errBuf); + String s = outBuf.toString(StandardCharsets.UTF_8); + assertTrue(s.contains("serving.port"), "must list serving.port, got: " + s); + assertTrue(s.contains("9000"), "must show effective value 9000, got: " + s); + assertTrue(s.contains("PROJECT"), "must show source layer PROJECT, got: " + s); + assertTrue( + s.contains("mcp.limits.per_tool_timeout_ms"), + "must list mcp timeout field, got: " + s); + assertTrue(s.contains("30000"), "must show env-overridden 30000, got: " + s); + assertTrue(s.contains("ENV"), "must show source layer ENV, got: " + s); + assertTrue(s.contains("BUILT_IN"), "must show at least one BUILT_IN leaf, got: " + s); + } + + @Test + void outputIsDeterministicAndSortedByFieldPath(@TempDir Path tmp) throws Exception { + Path cfg = tmp.resolve("codeiq.yml"); + Files.writeString(cfg, "serving:\n port: 9000\n"); + + String first = runCapture(cfg, Map.of()); + String second = runCapture(cfg, Map.of()); + + assertEquals(first, second, "explain must be byte-for-byte deterministic"); + + // Verify sort order: scan lines, extract the first column (field path) via a + // fixed-width slice that matches the 40-char FIELD column in the row format. + // A whitespace-split would silently pass if a future field path contained a space; + // the fixed slice fails loudly in that case. + String prev = ""; + for (String line : first.split("\n")) { + if (line.isBlank() || line.startsWith("FIELD") || line.startsWith("-")) { + continue; + } + String field = line.substring(0, Math.min(40, line.length())).trim(); + assertTrue( + field.compareTo(prev) >= 0, + "fields must be sorted ascending; '" + prev + "' then '" + field + "'"); + prev = field; + } + } + + @Test + void cliOverlayWinsOverEnv(@TempDir Path tmp) throws Exception { + Path cfg = tmp.resolve("codeiq.yml"); + // Empty project file so only ENV and CLI compete (plus BUILT_IN defaults). + Files.writeString(cfg, ""); + + ByteArrayOutputStream outBuf = new ByteArrayOutputStream(); + ByteArrayOutputStream errBuf = new ByteArrayOutputStream(); + ConfigExplainSubcommand cmd = + new ConfigExplainSubcommand( + new PrintStream(outBuf, true, StandardCharsets.UTF_8), + new PrintStream(errBuf, true, StandardCharsets.UTF_8)); + cmd.setPath(cfg); + cmd.setEnv(Map.of("CODEIQ_SERVING_PORT", "8080")); + + // Build a CLI overlay that sets serving.port=7777 and leaves every other field null so + // only the serving.port leaf is attributed to the CLI layer. + CodeIqUnifiedConfig base = CodeIqUnifiedConfig.empty(); + ServingConfig cliServing = new ServingConfig(7777, null, null, base.serving().neo4j()); + CodeIqUnifiedConfig overlay = + new CodeIqUnifiedConfig( + base.project(), + base.indexing(), + cliServing, + base.mcp(), + base.observability(), + base.detectors()); + cmd.setCliOverlay(overlay); + + int rc = cmd.call(); + assertEquals(0, rc, "explain should succeed; stderr=" + errBuf); + + String s = outBuf.toString(StandardCharsets.UTF_8); + String portRow = findRow(s, "serving.port"); + assertTrue( + portRow.contains("CLI"), + "serving.port should be attributed to CLI layer, got row: " + portRow); + assertTrue( + portRow.contains("7777"), + "serving.port should show CLI value 7777, got row: " + portRow); + assertFalse( + portRow.contains("8080"), + "CLI overlay must win over ENV; 8080 should not appear on the serving.port " + + "row, got: " + + portRow); + } + + @Test + void emptyConfigShowsOnlyBuiltInLayer(@TempDir Path tmp) throws Exception { + Path cfg = tmp.resolve("codeiq.yml"); + Files.writeString(cfg, ""); + + ByteArrayOutputStream outBuf = new ByteArrayOutputStream(); + ByteArrayOutputStream errBuf = new ByteArrayOutputStream(); + ConfigExplainSubcommand cmd = + new ConfigExplainSubcommand( + new PrintStream(outBuf, true, StandardCharsets.UTF_8), + new PrintStream(errBuf, true, StandardCharsets.UTF_8)); + cmd.setPath(cfg); + cmd.setEnv(Map.of()); + // No setCliOverlay call -- CLI overlay is null. + + int rc = cmd.call(); + assertEquals(0, rc, "explain should succeed; stderr=" + errBuf); + + String s = outBuf.toString(StandardCharsets.UTF_8); + int dataRowCount = 0; + for (String line : s.split("\n")) { + if (line.isBlank() || line.startsWith("FIELD") || line.startsWith("-")) { + continue; + } + dataRowCount++; + // Extract the LAYER column: columns are [0,40) FIELD, [41,53) LAYER. + String layer = line.substring(41, Math.min(53, line.length())).trim(); + assertEquals( + "BUILT_IN", + layer, + "every leaf in an empty-config explain must be BUILT_IN, got line: " + line); + } + assertTrue(dataRowCount > 0, "expected at least one leaf row, got: " + s); + } + + private static String findRow(String table, String fieldPath) { + for (String line : table.split("\n")) { + String field = line.substring(0, Math.min(40, line.length())).trim(); + if (field.equals(fieldPath)) { + return line; + } + } + throw new AssertionError( + "row for field '" + fieldPath + "' not found in table:\n" + table); + } + + @Test + void missingExplicitPathFailsWithStderrLoadError(@TempDir Path tmp) throws Exception { + Path cfg = tmp.resolve("does-not-exist.yml"); + + ByteArrayOutputStream outBuf = new ByteArrayOutputStream(); + ByteArrayOutputStream errBuf = new ByteArrayOutputStream(); + ConfigExplainSubcommand cmd = + new ConfigExplainSubcommand( + new PrintStream(outBuf, true, StandardCharsets.UTF_8), + new PrintStream(errBuf, true, StandardCharsets.UTF_8)); + cmd.setPath(cfg); + + int rc = cmd.call(); + + assertEquals(1, rc, "missing explicit --path must be a failure, not a silent pass"); + String err = errBuf.toString(StandardCharsets.UTF_8); + assertTrue(err.contains("Load error"), "stderr should carry a load error, got: " + err); + assertTrue( + err.contains(cfg.toString()), + "stderr should mention the missing path, got: " + err); + assertFalse( + outBuf.toString(StandardCharsets.UTF_8).contains("FIELD"), + "stdout must not carry the explain table when loading failed"); + } + + private static String runCapture(Path path, Map env) { + ByteArrayOutputStream outBuf = new ByteArrayOutputStream(); + ByteArrayOutputStream errBuf = new ByteArrayOutputStream(); + ConfigExplainSubcommand cmd = + new ConfigExplainSubcommand( + new PrintStream(outBuf, true, StandardCharsets.UTF_8), + new PrintStream(errBuf, true, StandardCharsets.UTF_8)); + cmd.setPath(path); + cmd.setEnv(env); + int rc = cmd.call(); + if (rc != 0) { + throw new AssertionError("explain failed: stderr=" + errBuf); + } + return outBuf.toString(StandardCharsets.UTF_8); + } +} diff --git a/src/test/java/io/github/randomcodespace/iq/cli/ConfigValidateSubcommandTest.java b/src/test/java/io/github/randomcodespace/iq/cli/ConfigValidateSubcommandTest.java new file mode 100644 index 00000000..155fd7e5 --- /dev/null +++ b/src/test/java/io/github/randomcodespace/iq/cli/ConfigValidateSubcommandTest.java @@ -0,0 +1,153 @@ +package io.github.randomcodespace.iq.cli; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +import java.io.ByteArrayOutputStream; +import java.io.PrintStream; +import java.nio.file.Files; +import java.nio.file.Path; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; + +class ConfigValidateSubcommandTest { + + /** Convenience bundle: a freshly-wired subcommand with captured stdout/stderr. */ + private record Harness( + ConfigValidateSubcommand cmd, ByteArrayOutputStream out, ByteArrayOutputStream err) { + static Harness at(Path path) { + ByteArrayOutputStream o = new ByteArrayOutputStream(); + ByteArrayOutputStream e = new ByteArrayOutputStream(); + ConfigValidateSubcommand cmd = + new ConfigValidateSubcommand(new PrintStream(o), new PrintStream(e)); + cmd.setPath(path); + return new Harness(cmd, o, e); + } + + String stdout() { + return out.toString(); + } + + String stderr() { + return err.toString(); + } + } + + @Test + void validFileReturnsZeroAndWritesOkToStdout(@TempDir Path tmp) throws Exception { + Path cfg = tmp.resolve("codeiq.yml"); + Files.writeString(cfg, "serving:\n port: 8080\n"); + Harness h = Harness.at(cfg); + + int rc = h.cmd.call(); + + assertEquals(0, rc); + assertTrue(h.stdout().contains("OK"), "expected OK in stdout, got: " + h.stdout()); + assertEquals("", h.stderr(), "stderr must be empty on valid config, got: " + h.stderr()); + } + + @Test + void invalidFileReturnsOneAndListsErrorsOnStderr(@TempDir Path tmp) throws Exception { + Path cfg = tmp.resolve("codeiq.yml"); + Files.writeString(cfg, "serving:\n port: 99999\n"); // out of range + Harness h = Harness.at(cfg); + + int rc = h.cmd.call(); + + assertEquals(1, rc); + assertTrue( + h.stderr().contains("serving.port"), + "expected field path in stderr, got: " + h.stderr()); + assertEquals( + "", + h.stdout(), + "stdout must be empty when the config is invalid, got: " + h.stdout()); + } + + @Test + void missingFileReturnsOneAndPrintsLoadErrorToStderr(@TempDir Path tmp) { + Path missing = tmp.resolve("does-not-exist.yml"); + Harness h = Harness.at(missing); + + int rc = h.cmd.call(); + + assertEquals(1, rc); + assertTrue( + h.stderr().contains("Load error"), + "expected 'Load error' in stderr, got: " + h.stderr()); + assertEquals( + "", + h.stdout(), + "stdout must be empty on load failure, got: " + h.stdout()); + } + + @Test + void malformedYamlReturnsOneAndPrintsLoadErrorToStderr(@TempDir Path tmp) throws Exception { + Path cfg = tmp.resolve("codeiq.yml"); + // Unclosed quoted string + mixed indentation -- SnakeYAML rejects this. + Files.writeString(cfg, "serving:\n port: \"8080\n host: \"broken\n"); + Harness h = Harness.at(cfg); + + int rc = h.cmd.call(); + + assertEquals(1, rc); + assertTrue( + h.stderr().contains("Load error"), + "expected 'Load error' in stderr, got: " + h.stderr()); + } + + @Test + void emptyFileIsValidAndReturnsZero(@TempDir Path tmp) throws Exception { + // An empty codeiq.yml parses to an empty overlay; merged with the built-in + // defaults the resulting effective config satisfies ConfigValidator. + Path cfg = tmp.resolve("codeiq.yml"); + Files.writeString(cfg, ""); + Harness h = Harness.at(cfg); + + int rc = h.cmd.call(); + + assertEquals(0, rc); + assertTrue(h.stdout().contains("OK"), "expected OK in stdout, got: " + h.stdout()); + } + + @Test + void validationErrorsPrintedInSortedOrder(@TempDir Path tmp) throws Exception { + // Craft a YAML that trips three distinct validator field paths. After the + // Comparator applied in call(), the expected alphabetical-by-fieldPath + // order is: indexing.batch_size, mcp.transport, serving.port. + Path cfg = tmp.resolve("codeiq.yml"); + Files.writeString( + cfg, + """ + serving: + port: 99999 + indexing: + batch_size: 0 + mcp: + transport: carrier-pigeon + """); + Harness h = Harness.at(cfg); + + int rc = h.cmd.call(); + + assertEquals(1, rc); + String stderr = h.stderr(); + int idxBatch = stderr.indexOf("indexing.batch_size"); + int idxTransport = stderr.indexOf("mcp.transport"); + int idxPort = stderr.indexOf("serving.port"); + assertTrue(idxBatch >= 0, "missing indexing.batch_size in: " + stderr); + assertTrue(idxTransport >= 0, "missing mcp.transport in: " + stderr); + assertTrue(idxPort >= 0, "missing serving.port in: " + stderr); + assertTrue( + idxBatch < idxTransport && idxTransport < idxPort, + "errors must be sorted by fieldPath. got order indices: " + + idxBatch + + "/" + + idxTransport + + "/" + + idxPort + + "; stderr was:\n" + + stderr); + } +} diff --git a/src/test/java/io/github/randomcodespace/iq/config/ProjectConfigLoaderTest.java b/src/test/java/io/github/randomcodespace/iq/config/ProjectConfigLoaderTest.java index 92313aae..e4fd8c92 100644 --- a/src/test/java/io/github/randomcodespace/iq/config/ProjectConfigLoaderTest.java +++ b/src/test/java/io/github/randomcodespace/iq/config/ProjectConfigLoaderTest.java @@ -1,5 +1,6 @@ package io.github.randomcodespace.iq.config; +import io.github.randomcodespace.iq.config.unified.CodeIqUnifiedConfig; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.io.TempDir; @@ -10,10 +11,98 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNull; import static org.junit.jupiter.api.Assertions.assertTrue; class ProjectConfigLoaderTest { + // ---- New LoadResult-based API (Task 12: .osscodeiq.yml deprecation shim) ---- + + @Test + void preferCodeiqYmlWhenBothPresent(@TempDir Path repo) throws Exception { + Files.writeString(repo.resolve("codeiq.yml"), "serving:\n port: 9000\n"); + Files.writeString(repo.resolve(".osscodeiq.yml"), "serving:\n port: 9999\n"); + ProjectConfigLoader.LoadResult r = new ProjectConfigLoader().loadFrom(repo); + assertEquals(9000, r.config().serving().port()); + assertFalse(r.deprecationWarningEmitted()); + } + + @Test + void fallsBackToOsscodeIqWithWarn(@TempDir Path repo) throws Exception { + Files.writeString(repo.resolve(".osscodeiq.yml"), "serving:\n port: 8888\n"); + ProjectConfigLoader.LoadResult r = new ProjectConfigLoader().loadFrom(repo); + assertEquals(8888, r.config().serving().port()); + assertTrue(r.deprecationWarningEmitted(), + "must emit a migration warning when falling back to .osscodeiq.yml"); + } + + @Test + void neitherFilePresentReturnsEmptyConfig(@TempDir Path repo) { + ProjectConfigLoader.LoadResult r = new ProjectConfigLoader().loadFrom(repo); + assertEquals(CodeIqUnifiedConfig.empty(), r.config()); + assertFalse(r.deprecationWarningEmitted()); + } + + @Test + void fallbackOsscodeiqWithFlatKeysTranslatesToUnifiedOverlay(@TempDir Path repo) throws Exception { + String yaml = """ + max_depth: 25 + max_radius: 8 + cache_dir: .custom-cache + root_path: /repo + """; + Files.writeString(repo.resolve(".osscodeiq.yml"), yaml); + + ProjectConfigLoader.LoadResult r = new ProjectConfigLoader().loadFrom(repo); + + assertEquals(25, r.config().indexing().maxDepth()); + assertEquals(8, r.config().indexing().maxRadius()); + assertEquals(".custom-cache", r.config().indexing().cacheDir()); + assertEquals("/repo", r.config().project().root()); + assertTrue(r.deprecationWarningEmitted(), + "must emit a migration warning when falling back to .osscodeiq.yml"); + } + + @Test + void fallbackOsscodeiqWithNewShapeStillWorks(@TempDir Path repo) throws Exception { + // A .osscodeiq.yml that has already been rewritten in the new nested schema + // (e.g., a user renamed codeiq.yml back, or copy-pasted the new sample) must + // continue to work — delegate to UnifiedConfigLoader, still warn. + Files.writeString(repo.resolve(".osscodeiq.yml"), "serving:\n port: 9999\n"); + + ProjectConfigLoader.LoadResult r = new ProjectConfigLoader().loadFrom(repo); + + assertEquals(9999, r.config().serving().port()); + assertTrue(r.deprecationWarningEmitted()); + } + + @Test + void mixedLegacyFlatAndNestedKeysPrefersLegacyPath(@TempDir Path repo) throws Exception { + // Documented behavior (see javadoc on ProjectConfigLoader#readAndTranslateLegacy): + // presence of ANY legacy flat key at the root triggers the legacy translator, + // so flat values are honored. Nested sections that lack a flat equivalent + // (serving / mcp / observability / detectors) are intentionally NOT read in the + // legacy-mixed case — a pure new-shape file should drop the flat keys first. + String yaml = """ + max_depth: 25 + indexing: + batch_size: 100 + """; + Files.writeString(repo.resolve(".osscodeiq.yml"), yaml); + + ProjectConfigLoader.LoadResult r = new ProjectConfigLoader().loadFrom(repo); + + assertEquals(25, r.config().indexing().maxDepth(), + "flat max_depth must translate even when a nested indexing block is present"); + // In legacy-mixed mode, pipeline.batch-size (legacy schema) is the batch-size + // source; a bare `indexing.batch_size` nested block is intentionally ignored. + assertNull(r.config().indexing().batchSize(), + "nested indexing.batch_size is not honored in legacy-mixed mode (documented)"); + assertTrue(r.deprecationWarningEmitted()); + } + + // ---- Legacy static API retained for back-compat call sites (Analyzer, CliOutput) ---- + @Test void loadFromYmlFile(@TempDir Path tempDir) throws IOException { String yamlContent = """ diff --git a/src/test/java/io/github/randomcodespace/iq/config/UnifiedConfigAdapterTest.java b/src/test/java/io/github/randomcodespace/iq/config/UnifiedConfigAdapterTest.java new file mode 100644 index 00000000..490172bd --- /dev/null +++ b/src/test/java/io/github/randomcodespace/iq/config/UnifiedConfigAdapterTest.java @@ -0,0 +1,152 @@ +package io.github.randomcodespace.iq.config; + +import io.github.randomcodespace.iq.config.unified.CodeIqUnifiedConfig; +import io.github.randomcodespace.iq.config.unified.ConfigDefaults; +import io.github.randomcodespace.iq.config.unified.IndexingConfig; +import io.github.randomcodespace.iq.config.unified.McpAuthConfig; +import io.github.randomcodespace.iq.config.unified.McpConfig; +import io.github.randomcodespace.iq.config.unified.McpLimitsConfig; +import io.github.randomcodespace.iq.config.unified.McpToolsConfig; +import io.github.randomcodespace.iq.config.unified.ObservabilityConfig; +import io.github.randomcodespace.iq.config.unified.DetectorsConfig; +import io.github.randomcodespace.iq.config.unified.ProjectConfig; +import io.github.randomcodespace.iq.config.unified.ServingConfig; +import org.junit.jupiter.api.Test; + +import java.util.List; + +import static org.junit.jupiter.api.Assertions.*; + +class UnifiedConfigAdapterTest { + + @Test + void adapterProjectsUnifiedValuesIntoLegacyApi() { + CodeIqUnifiedConfig u = ConfigDefaults.builtIn(); + CodeIqConfig legacy = UnifiedConfigAdapter.toCodeIqConfig(u); + + assertEquals(".", legacy.getRootPath()); + assertEquals(".code-iq/cache", legacy.getCacheDir()); + assertEquals(".code-iq/graph/graph.db", legacy.getGraph().getPath()); + assertEquals(500, legacy.getBatchSize()); + assertFalse(legacy.isReadOnly()); + // maxDepth and maxRadius flow through builtIn() matching application.yml + assertEquals(10, legacy.getMaxDepth()); + assertEquals(10, legacy.getMaxRadius()); + } + + @Test + void nullOverlayReturnsLegacyDefaults() { + CodeIqConfig legacy = UnifiedConfigAdapter.toCodeIqConfig(null); + CodeIqConfig baseline = new CodeIqConfig(); + + assertEquals(baseline.getRootPath(), legacy.getRootPath()); + assertEquals(baseline.getCacheDir(), legacy.getCacheDir()); + assertEquals(baseline.getBatchSize(), legacy.getBatchSize()); + assertEquals(baseline.getMaxDepth(), legacy.getMaxDepth()); + assertEquals(baseline.getMaxRadius(), legacy.getMaxRadius()); + assertEquals(baseline.getMaxFiles(), legacy.getMaxFiles()); + assertEquals(baseline.getMaxSnippetLines(), legacy.getMaxSnippetLines()); + assertEquals(baseline.isReadOnly(), legacy.isReadOnly()); + assertNull(legacy.getServiceName()); + assertEquals(baseline.getGraph().getPath(), legacy.getGraph().getPath()); + } + + @Test + void emptyOverlayPreservesLegacyDefaults() { + // empty() is distinct from builtIn() — every scalar is null. The + // adapter must leave CodeIqConfig's in-code defaults untouched. + CodeIqConfig legacy = UnifiedConfigAdapter.toCodeIqConfig(CodeIqUnifiedConfig.empty()); + CodeIqConfig baseline = new CodeIqConfig(); + + assertEquals(baseline.getRootPath(), legacy.getRootPath()); + assertEquals(baseline.getCacheDir(), legacy.getCacheDir()); + assertEquals(baseline.getBatchSize(), legacy.getBatchSize()); + // empty() doesn't set maxDepth/maxRadius, so CodeIqConfig's own default is 10 + assertEquals(baseline.getMaxDepth(), legacy.getMaxDepth()); + assertEquals(baseline.getMaxRadius(), legacy.getMaxRadius()); + assertEquals(baseline.getMaxFiles(), legacy.getMaxFiles()); + assertEquals(baseline.getMaxSnippetLines(), legacy.getMaxSnippetLines()); + assertFalse(legacy.isReadOnly()); + assertNull(legacy.getServiceName()); + assertEquals(baseline.getGraph().getPath(), legacy.getGraph().getPath()); + } + + @Test + void partialOverlayOnlyOverridesSetFields() { + CodeIqUnifiedConfig u = new CodeIqUnifiedConfig( + new ProjectConfig(null, "/custom", null, List.of()), + IndexingConfig.empty(), + ServingConfig.empty(), + new McpConfig(null, null, null, + McpAuthConfig.empty(), + McpLimitsConfig.empty(), + McpToolsConfig.empty()), + ObservabilityConfig.empty(), + DetectorsConfig.empty() + ); + + CodeIqConfig legacy = UnifiedConfigAdapter.toCodeIqConfig(u); + CodeIqConfig baseline = new CodeIqConfig(); + + assertEquals("/custom", legacy.getRootPath()); + // All other fields remain at CodeIqConfig's in-code defaults + assertEquals(baseline.getCacheDir(), legacy.getCacheDir()); + assertEquals(baseline.getBatchSize(), legacy.getBatchSize()); + assertEquals(baseline.getMaxDepth(), legacy.getMaxDepth()); + assertEquals(baseline.getMaxRadius(), legacy.getMaxRadius()); + assertEquals(baseline.getMaxFiles(), legacy.getMaxFiles()); + assertEquals(baseline.getMaxSnippetLines(), legacy.getMaxSnippetLines()); + assertFalse(legacy.isReadOnly()); + assertNull(legacy.getServiceName()); + assertEquals(baseline.getGraph().getPath(), legacy.getGraph().getPath()); + } + + @Test + void nullNeo4jSectionDoesNotNpe() { + // Hand-roll a ServingConfig where neo4j is explicitly null. + CodeIqUnifiedConfig u = new CodeIqUnifiedConfig( + ProjectConfig.empty(), + IndexingConfig.empty(), + new ServingConfig(null, null, null, null), + new McpConfig(null, null, null, + McpAuthConfig.empty(), + McpLimitsConfig.empty(), + McpToolsConfig.empty()), + ObservabilityConfig.empty(), + DetectorsConfig.empty() + ); + + CodeIqConfig legacy = assertDoesNotThrow(() -> UnifiedConfigAdapter.toCodeIqConfig(u)); + assertEquals(new CodeIqConfig().getGraph().getPath(), legacy.getGraph().getPath()); + } + + @Test + void newFieldsProjectCorrectly() { + CodeIqUnifiedConfig u = new CodeIqUnifiedConfig( + new ProjectConfig(null, null, "billing", List.of()), + new IndexingConfig( + List.of(), List.of(), List.of(), + null, null, null, null, + 25, // maxDepth + 17, // maxRadius + 500, // maxFiles + 12 // maxSnippetLines + ), + ServingConfig.empty(), + new McpConfig(null, null, null, + McpAuthConfig.empty(), + McpLimitsConfig.empty(), + McpToolsConfig.empty()), + ObservabilityConfig.empty(), + DetectorsConfig.empty() + ); + + CodeIqConfig legacy = UnifiedConfigAdapter.toCodeIqConfig(u); + + assertEquals(25, legacy.getMaxDepth()); + assertEquals(17, legacy.getMaxRadius()); + assertEquals(500, legacy.getMaxFiles()); + assertEquals(12, legacy.getMaxSnippetLines()); + assertEquals("billing", legacy.getServiceName()); + } +} diff --git a/src/test/java/io/github/randomcodespace/iq/config/UnifiedConfigBeansTest.java b/src/test/java/io/github/randomcodespace/iq/config/UnifiedConfigBeansTest.java new file mode 100644 index 00000000..195ca8bb --- /dev/null +++ b/src/test/java/io/github/randomcodespace/iq/config/UnifiedConfigBeansTest.java @@ -0,0 +1,116 @@ +package io.github.randomcodespace.iq.config; + +import io.github.randomcodespace.iq.config.unified.CodeIqUnifiedConfig; +import io.github.randomcodespace.iq.config.unified.ConfigLoadException; +import io.github.randomcodespace.iq.config.unified.ConfigResolver; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.context.ActiveProfiles; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Map; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +/** + * Verifies Task 11 wiring: the Spring context exposes a {@link CodeIqUnifiedConfig} + * bean that is the single source of truth, and the legacy {@link CodeIqConfig} bean + * is produced by adapting the unified bean. + * + *

The "defaults path" assertions here run with no {@code codeiq.yml} in cwd, + * so values must match {@link io.github.randomcodespace.iq.config.unified.ConfigDefaults} + * — which in turn matches the values that were historically in {@code application.yml}. + */ +@SpringBootTest +@ActiveProfiles("test") +class UnifiedConfigBeansTest { + + @Autowired + CodeIqUnifiedConfig unified; + + @Autowired + CodeIqConfig legacy; + + @Test + void contextExposesUnifiedAndLegacyBeansBothBackedBySameSource() { + assertNotNull(unified, "unified config bean must be present"); + assertNotNull(legacy, "legacy config bean must be present"); + // Same cacheDir — proves the legacy bean is adapted from unified. + assertEquals(unified.indexing().cacheDir(), legacy.getCacheDir()); + } + + @Test + void defaultsMatchHistoricalApplicationYmlValues() { + // These values came from application.yml pre-Task-11; they must still + // be what CodeIqConfig exposes now that wiring goes through ConfigDefaults. + assertEquals(".code-iq/cache", legacy.getCacheDir()); + assertEquals(".code-iq/graph/graph.db", legacy.getGraph().getPath()); + assertEquals(10, legacy.getMaxDepth()); + assertEquals(10, legacy.getMaxRadius()); + assertEquals(500, legacy.getBatchSize()); + } + + /** + * Locks in the "startup dies with a useful stack trace" contract: a malformed + * {@code codeiq.yml} must surface a {@link ConfigLoadException} whose message + * names the offending file path, so a user can find and fix the broken yml. + * + *

Tested at the {@link ConfigResolver} level (not via Spring context restart) + * because relocating CWD inside a single {@code @SpringBootTest} run is fragile. + * The Spring wiring in {@link UnifiedConfigBeans#codeIqUnifiedConfig()} calls + * exactly this resolver, so the guarantee propagates: Spring wraps the + * {@code ConfigLoadException} in a {@code BeanCreationException} at startup. + */ + @Test + void malformedCodeiqYmlAtStartupSurfacesFileAnchoredError(@TempDir Path tempDir) throws Exception { + Path badYml = tempDir.resolve("codeiq.yml"); + // Unclosed flow mapping -> SnakeYAML parse error. + Files.writeString(badYml, "serving:\n port: [not-a-scalar\n"); + + ConfigLoadException ex = assertThrows( + ConfigLoadException.class, + () -> new ConfigResolver() + .projectPath(badYml) + .env(Map.of()) + .resolve()); + + String msg = ex.getMessage(); + assertNotNull(msg, "exception must carry a message"); + assertTrue(msg.contains(badYml.toString()), + "error message must name the offending file path; was: " + msg); + } + + /** + * Closes the spec-review gap: proves a {@code codeiq.yml} overlay flows through + * {@link ConfigResolver} + {@link UnifiedConfigAdapter} into the legacy + * {@link CodeIqConfig} getters end-to-end. + */ + @Test + void codeiqYmlOverlayFlowsIntoLegacyBean(@TempDir Path tempDir) throws Exception { + Path yml = tempDir.resolve("codeiq.yml"); + // Canonical snake_case keys -- camelCase is still accepted as a deprecated + // alias (see UnifiedConfigLoaderTest) but this test pins the primary form. + Files.writeString(yml, "indexing:\n batch_size: 1234\n max_depth: 42\n"); + + // Point user-global at the same temp dir so the test doesn't pick up the + // running user's real ~/.codeiq/config.yml. + Path userGlobal = tempDir.resolve("user-global-absent.yml"); + + CodeIqUnifiedConfig unifiedFromYml = new ConfigResolver() + .userGlobalPath(userGlobal) + .projectPath(yml) + .env(Map.of()) + .resolve() + .effective(); + + CodeIqConfig legacyFromYml = UnifiedConfigAdapter.toCodeIqConfig(unifiedFromYml); + assertEquals(1234, legacyFromYml.getBatchSize()); + assertEquals(42, legacyFromYml.getMaxDepth()); + } +} diff --git a/src/test/java/io/github/randomcodespace/iq/config/unified/CodeIqUnifiedConfigTest.java b/src/test/java/io/github/randomcodespace/iq/config/unified/CodeIqUnifiedConfigTest.java new file mode 100644 index 00000000..c033f4eb --- /dev/null +++ b/src/test/java/io/github/randomcodespace/iq/config/unified/CodeIqUnifiedConfigTest.java @@ -0,0 +1,17 @@ +package io.github.randomcodespace.iq.config.unified; + +import org.junit.jupiter.api.Test; +import static org.junit.jupiter.api.Assertions.*; + +class CodeIqUnifiedConfigTest { + @Test + void defaultsInstanceHasAllSectionsNonNull() { + CodeIqUnifiedConfig cfg = CodeIqUnifiedConfig.empty(); + assertNotNull(cfg.project()); + assertNotNull(cfg.indexing()); + assertNotNull(cfg.serving()); + assertNotNull(cfg.mcp()); + assertNotNull(cfg.observability()); + assertNotNull(cfg.detectors()); + } +} diff --git a/src/test/java/io/github/randomcodespace/iq/config/unified/ConfigDefaultsTest.java b/src/test/java/io/github/randomcodespace/iq/config/unified/ConfigDefaultsTest.java new file mode 100644 index 00000000..fa297be2 --- /dev/null +++ b/src/test/java/io/github/randomcodespace/iq/config/unified/ConfigDefaultsTest.java @@ -0,0 +1,32 @@ +package io.github.randomcodespace.iq.config.unified; + +import org.junit.jupiter.api.Test; +import static org.junit.jupiter.api.Assertions.*; + +class ConfigDefaultsTest { + @Test + void builtInHasKnownFieldValues() { + CodeIqUnifiedConfig d = ConfigDefaults.builtIn(); + // These reflect values from application.yml + CLI flag defaults today. + assertEquals(".", d.project().root()); + assertEquals(".code-iq/cache", d.indexing().cacheDir()); + assertEquals(500, d.indexing().batchSize()); + assertEquals(true, d.indexing().incremental()); + assertEquals(8080, d.serving().port()); + assertEquals("0.0.0.0", d.serving().bindAddress()); + assertEquals(false, d.serving().readOnly()); + assertEquals(".code-iq/graph/graph.db", d.serving().neo4j().dir()); + assertEquals(true, d.mcp().enabled()); + assertEquals("http", d.mcp().transport()); + assertEquals("/mcp", d.mcp().basePath()); + assertEquals("none", d.mcp().auth().mode()); + assertEquals(15_000, d.mcp().limits().perToolTimeoutMs()); + assertEquals(500, d.mcp().limits().maxResults()); + assertEquals(2_000_000L, d.mcp().limits().maxPayloadBytes()); + assertEquals(300, d.mcp().limits().ratePerMinute()); + assertEquals(true, d.observability().metrics()); + assertEquals(false, d.observability().tracing()); + assertEquals("json", d.observability().logFormat()); + assertEquals("info", d.observability().logLevel()); + } +} diff --git a/src/test/java/io/github/randomcodespace/iq/config/unified/ConfigMergerTest.java b/src/test/java/io/github/randomcodespace/iq/config/unified/ConfigMergerTest.java new file mode 100644 index 00000000..9a76af04 --- /dev/null +++ b/src/test/java/io/github/randomcodespace/iq/config/unified/ConfigMergerTest.java @@ -0,0 +1,58 @@ +package io.github.randomcodespace.iq.config.unified; + +import org.junit.jupiter.api.Test; +import java.util.List; +import java.util.Map; +import static org.junit.jupiter.api.Assertions.*; + +class ConfigMergerTest { + + @Test + void laterLayersWinWhenPresent() { + CodeIqUnifiedConfig defaults = ConfigDefaults.builtIn(); // port=8080 + CodeIqUnifiedConfig project = EnvVarOverlay.from(Map.of("CODEIQ_SERVING_PORT", "9000")); // 9000 + CodeIqUnifiedConfig cli = EnvVarOverlay.from(Map.of("CODEIQ_SERVING_PORT", "9999")); // 9999 + + MergedConfig merged = new ConfigMerger().merge(List.of( + new ConfigMerger.Input(ConfigLayer.BUILT_IN, "defaults", defaults), + new ConfigMerger.Input(ConfigLayer.PROJECT, "./codeiq.yml", project), + new ConfigMerger.Input(ConfigLayer.CLI, "--port=9999", cli) + )); + + assertEquals(9999, merged.effective().serving().port()); + ConfigProvenance p = merged.provenance().get("serving.port"); + assertEquals(ConfigLayer.CLI, p.layer()); + assertEquals("--port=9999", p.sourceLabel()); + } + + @Test + void nullInHigherLayerInheritsFromLower() { + CodeIqUnifiedConfig defaults = ConfigDefaults.builtIn(); // port=8080 + CodeIqUnifiedConfig project = EnvVarOverlay.from(Map.of()); // nothing set + MergedConfig merged = new ConfigMerger().merge(List.of( + new ConfigMerger.Input(ConfigLayer.BUILT_IN, "defaults", defaults), + new ConfigMerger.Input(ConfigLayer.PROJECT, "./codeiq.yml", project) + )); + assertEquals(8080, merged.effective().serving().port()); + assertEquals(ConfigLayer.BUILT_IN, merged.provenance().get("serving.port").layer()); + } + + @Test + void listsFollowWholeLayerReplacementNotMerge() { + // Non-merge semantics: if a higher layer declares `languages`, + // it REPLACES the lower layer entirely. This is predictable and + // matches how most tools handle list overrides. + CodeIqUnifiedConfig defaults = ConfigDefaults.builtIn(); // [] + CodeIqUnifiedConfig project = EnvVarOverlay.from(Map.of( + "CODEIQ_INDEXING_LANGUAGES", "java,ts")); // [java, ts] + CodeIqUnifiedConfig cli = EnvVarOverlay.from(Map.of( + "CODEIQ_INDEXING_LANGUAGES", "python")); // [python] + MergedConfig merged = new ConfigMerger().merge(List.of( + new ConfigMerger.Input(ConfigLayer.BUILT_IN, "defaults", defaults), + new ConfigMerger.Input(ConfigLayer.PROJECT, "./codeiq.yml", project), + new ConfigMerger.Input(ConfigLayer.CLI, "--languages=python", cli) + )); + assertEquals(List.of("python"), merged.effective().indexing().languages()); + assertEquals(ConfigLayer.CLI, merged.provenance().get("indexing.languages").layer()); + } +} diff --git a/src/test/java/io/github/randomcodespace/iq/config/unified/ConfigResolverTest.java b/src/test/java/io/github/randomcodespace/iq/config/unified/ConfigResolverTest.java new file mode 100644 index 00000000..01473a7d --- /dev/null +++ b/src/test/java/io/github/randomcodespace/iq/config/unified/ConfigResolverTest.java @@ -0,0 +1,50 @@ +package io.github.randomcodespace.iq.config.unified; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Map; +import static org.junit.jupiter.api.Assertions.*; + +class ConfigResolverTest { + + @Test + void layersResolveInDocumentedOrder(@TempDir Path tmp) throws Exception { + // user-global: port=7000 + Path userGlobal = tmp.resolve("user.yml"); + Files.writeString(userGlobal, "serving:\n port: 7000\n"); + + // project: port=8500 AND indexing.batch_size=1234 + Path project = tmp.resolve("codeiq.yml"); + Files.writeString(project, "serving:\n port: 8500\nindexing:\n batch_size: 1234\n"); + + // env: port=9100 (should win over project) AND NO batch_size (project wins there) + Map env = Map.of("CODEIQ_SERVING_PORT", "9100"); + + // cli: read_only=true (only CLI sets it) + CodeIqUnifiedConfig cli = new CodeIqUnifiedConfig( + ProjectConfig.empty(), IndexingConfig.empty(), + new ServingConfig(null, null, true, Neo4jConfig.empty()), + McpConfig.empty(), ObservabilityConfig.empty(), DetectorsConfig.empty()); + + MergedConfig merged = new ConfigResolver() + .userGlobalPath(userGlobal) + .projectPath(project) + .env(env) + .cliOverlay(cli, "--read-only") + .resolve(); + + assertEquals(9100, merged.effective().serving().port()); + assertEquals(ConfigLayer.ENV, merged.provenance().get("serving.port").layer()); + assertEquals(1234, merged.effective().indexing().batchSize()); + assertEquals(ConfigLayer.PROJECT, merged.provenance().get("indexing.batch_size").layer()); + assertEquals(Boolean.TRUE, merged.effective().serving().readOnly()); + assertEquals(ConfigLayer.CLI, merged.provenance().get("serving.read_only").layer()); + // indexing.incremental is not set in project/env/cli, so it must + // fall through to BUILT_IN defaults (which set it to true). + assertEquals(Boolean.TRUE, merged.effective().indexing().incremental()); + assertEquals(ConfigLayer.BUILT_IN, + merged.provenance().get("indexing.incremental").layer()); + } +} diff --git a/src/test/java/io/github/randomcodespace/iq/config/unified/ConfigValidatorTest.java b/src/test/java/io/github/randomcodespace/iq/config/unified/ConfigValidatorTest.java new file mode 100644 index 00000000..551d51d8 --- /dev/null +++ b/src/test/java/io/github/randomcodespace/iq/config/unified/ConfigValidatorTest.java @@ -0,0 +1,37 @@ +package io.github.randomcodespace.iq.config.unified; + +import org.junit.jupiter.api.Test; +import java.util.List; +import static org.junit.jupiter.api.Assertions.*; + +class ConfigValidatorTest { + + @Test + void builtInDefaultsAreValid() { + List errs = new ConfigValidator().validate(ConfigDefaults.builtIn()); + assertTrue(errs.isEmpty(), "defaults must be valid; got: " + errs); + } + + @Test + void portOutOfRangeIsRejected() { + CodeIqUnifiedConfig bad = new CodeIqUnifiedConfig( + ProjectConfig.empty(), + IndexingConfig.empty(), + new ServingConfig(99999, "0.0.0.0", false, Neo4jConfig.empty()), + McpConfig.empty(), ObservabilityConfig.empty(), DetectorsConfig.empty()); + List errs = new ConfigValidator().validate(bad); + assertEquals(1, errs.size()); + assertEquals("serving.port", errs.get(0).fieldPath()); + } + + @Test + void mcpTransportMustBeHttpOrStdio() { + CodeIqUnifiedConfig bad = new CodeIqUnifiedConfig( + ProjectConfig.empty(), IndexingConfig.empty(), ServingConfig.empty(), + new McpConfig(true, "websocket", "/mcp", McpAuthConfig.empty(), + McpLimitsConfig.empty(), McpToolsConfig.empty()), + ObservabilityConfig.empty(), DetectorsConfig.empty()); + List errs = new ConfigValidator().validate(bad); + assertTrue(errs.stream().anyMatch(e -> e.fieldPath().equals("mcp.transport"))); + } +} diff --git a/src/test/java/io/github/randomcodespace/iq/config/unified/EnvVarOverlayTest.java b/src/test/java/io/github/randomcodespace/iq/config/unified/EnvVarOverlayTest.java new file mode 100644 index 00000000..f1878465 --- /dev/null +++ b/src/test/java/io/github/randomcodespace/iq/config/unified/EnvVarOverlayTest.java @@ -0,0 +1,56 @@ +package io.github.randomcodespace.iq.config.unified; + +import org.junit.jupiter.api.Test; +import java.util.Map; +import static org.junit.jupiter.api.Assertions.*; + +class EnvVarOverlayTest { + + @Test + void readsServingPort() { + CodeIqUnifiedConfig cfg = EnvVarOverlay.from(Map.of("CODEIQ_SERVING_PORT", "9090")); + assertEquals(9090, cfg.serving().port()); + // everything else remains null (empty overlay) + assertNull(cfg.indexing().batchSize()); + } + + @Test + void readsNestedMcpLimit() { + CodeIqUnifiedConfig cfg = EnvVarOverlay.from(Map.of( + "CODEIQ_MCP_LIMITS_PERTOOLTIMEOUTMS", "30000")); + assertEquals(30_000, cfg.mcp().limits().perToolTimeoutMs()); + } + + @Test + void parsesBooleansAndLists() { + CodeIqUnifiedConfig cfg = EnvVarOverlay.from(Map.of( + "CODEIQ_SERVING_READONLY", "true", + "CODEIQ_INDEXING_LANGUAGES", "java,typescript,python")); + assertTrue(cfg.serving().readOnly()); + assertEquals(3, cfg.indexing().languages().size()); + assertEquals("typescript", cfg.indexing().languages().get(1)); + } + + @Test + void unknownVarIsIgnored() { + CodeIqUnifiedConfig cfg = EnvVarOverlay.from(Map.of( + "CODEIQ_NONEXISTENT_THING", "42")); + // No effect — don't throw, just ignore unknown keys. + assertEquals(CodeIqUnifiedConfig.empty(), cfg); + } + + @Test + void nonCodeiqVarsIgnored() { + CodeIqUnifiedConfig cfg = EnvVarOverlay.from(Map.of( + "PATH", "/usr/bin", + "HOME", "/home/x")); + assertEquals(CodeIqUnifiedConfig.empty(), cfg); + } + + @Test + void malformedIntThrowsWithVarName() { + ConfigLoadException e = assertThrows(ConfigLoadException.class, + () -> EnvVarOverlay.from(Map.of("CODEIQ_SERVING_PORT", "not-a-port"))); + assertTrue(e.getMessage().contains("CODEIQ_SERVING_PORT")); + } +} diff --git a/src/test/java/io/github/randomcodespace/iq/config/unified/UnifiedConfigLoaderTest.java b/src/test/java/io/github/randomcodespace/iq/config/unified/UnifiedConfigLoaderTest.java new file mode 100644 index 00000000..a11b919c --- /dev/null +++ b/src/test/java/io/github/randomcodespace/iq/config/unified/UnifiedConfigLoaderTest.java @@ -0,0 +1,250 @@ +package io.github.randomcodespace.iq.config.unified; + +import ch.qos.logback.classic.Level; +import ch.qos.logback.classic.Logger; +import ch.qos.logback.classic.spi.ILoggingEvent; +import ch.qos.logback.core.read.ListAppender; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; +import org.slf4j.LoggerFactory; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.List; +import java.util.stream.Collectors; + +import static org.junit.jupiter.api.Assertions.*; + +class UnifiedConfigLoaderTest { + + private static Path fixture(String name) { + return Paths.get("src/test/resources/config-unified/" + name); + } + + @Test + void missingFileProducesEmptyOverlay() { + CodeIqUnifiedConfig cfg = UnifiedConfigLoader.load(Paths.get("does/not/exist.yml")); + // Empty overlay = every section present with null/default-empty values. + assertEquals(CodeIqUnifiedConfig.empty(), cfg); + } + + @Test + void minimalFileSetsOnlyDeclaredFields() { + // minimal.yml deliberately uses the deprecated camelCase alias (batchSize) + // so this test also exercises the alias path end-to-end. + CodeIqUnifiedConfig cfg = UnifiedConfigLoader.load(fixture("minimal.yml")); + assertEquals("my-service", cfg.project().name()); + assertEquals(2000, cfg.indexing().batchSize()); + // Unset fields stay null (indicating "inherit from lower layer") + assertNull(cfg.indexing().cacheDir()); + assertNull(cfg.serving().port()); + } + + @Test + void fullFileRoundTripsEveryField() { + CodeIqUnifiedConfig cfg = UnifiedConfigLoader.load(fixture("full.yml")); + assertEquals("demo", cfg.project().name()); + assertEquals(2, cfg.project().modules().size()); + assertEquals("services/api", cfg.project().modules().get(0).path()); + assertEquals("maven", cfg.project().modules().get(0).type()); + assertEquals(9090, cfg.serving().port()); + assertEquals("127.0.0.1", cfg.serving().bindAddress()); + assertEquals(true, cfg.serving().readOnly()); + assertEquals(".code-iq/graph/graph.db", cfg.serving().neo4j().dir()); + assertEquals(2048, cfg.serving().neo4j().heapMaxMb()); + assertEquals(10000, cfg.mcp().limits().perToolTimeoutMs()); + assertEquals(List.of("run_cypher"), cfg.mcp().tools().disabled()); + assertEquals(Boolean.TRUE, cfg.detectors().overrides().get("SpringRestDetector").enabled()); + assertEquals(Boolean.FALSE, cfg.detectors().overrides().get("QuarkusRestDetector").enabled()); + } + + @Test + void malformedFileThrowsWithFileAnchor() { + Path f = fixture("malformed.yml"); + ConfigLoadException e = assertThrows(ConfigLoadException.class, + () -> UnifiedConfigLoader.load(f)); + assertTrue(e.getMessage().contains("malformed.yml"), + "error must name the file, got: " + e.getMessage()); + // Canonical field path uses snake_case; legacy camelCase substring lives on + // only as a transparent alias and does NOT appear in error messages. + assertTrue(e.getMessage().contains("batch_size"), + "error must name the canonical snake_case field, got: " + e.getMessage()); + } + + // ---- Casing-normalization (Task 13 prep) --------------------------------- + + @Test + void snakeCaseKeysAreLoadedWithoutWarning(@TempDir Path tmp) throws Exception { + // The canonical spelling is snake_case for every leaf. Loading a fully + // snake_cased YAML must (a) populate the record fields and (b) emit ZERO + // deprecation warnings. + Path yml = tmp.resolve("codeiq.yml"); + Files.writeString(yml, + "indexing:\n batch_size: 123\n cache_dir: .cache\n" + + "serving:\n bind_address: 0.0.0.0\n read_only: true\n" + + " neo4j:\n page_cache_mb: 64\n heap_initial_mb: 128\n heap_max_mb: 256\n" + + "mcp:\n base_path: /mcp\n" + + " auth:\n token_env: FOO\n" + + " limits:\n per_tool_timeout_ms: 500\n max_results: 10\n" + + " max_payload_bytes: 1000\n rate_per_minute: 30\n" + + "observability:\n log_format: json\n log_level: info\n"); + + ListAppender appender = attachAppender(); + try { + CodeIqUnifiedConfig cfg = UnifiedConfigLoader.load(yml); + + assertEquals(123, cfg.indexing().batchSize()); + assertEquals(".cache", cfg.indexing().cacheDir()); + assertEquals("0.0.0.0", cfg.serving().bindAddress()); + assertEquals(Boolean.TRUE, cfg.serving().readOnly()); + assertEquals(64, cfg.serving().neo4j().pageCacheMb()); + assertEquals(128, cfg.serving().neo4j().heapInitialMb()); + assertEquals(256, cfg.serving().neo4j().heapMaxMb()); + assertEquals("/mcp", cfg.mcp().basePath()); + assertEquals("FOO", cfg.mcp().auth().tokenEnv()); + assertEquals(500, cfg.mcp().limits().perToolTimeoutMs()); + assertEquals(10, cfg.mcp().limits().maxResults()); + assertEquals(1000L, cfg.mcp().limits().maxPayloadBytes()); + assertEquals(30, cfg.mcp().limits().ratePerMinute()); + assertEquals("json", cfg.observability().logFormat()); + assertEquals("info", cfg.observability().logLevel()); + + long warnings = appender.list.stream() + .filter(e -> e.getLevel() == Level.WARN) + .count(); + assertEquals(0, warnings, + "snake_case keys must not trigger deprecation warnings, got: " + + appender.list.stream() + .map(Object::toString) + .collect(Collectors.joining("\n"))); + } finally { + detachAppender(appender); + } + } + + @Test + void camelCaseAliasIsAcceptedAndWarns(@TempDir Path tmp) throws Exception { + // camelCase must still load correctly (backward compatibility), but each + // alias used must produce exactly one WARN naming the canonical form. + Path yml = tmp.resolve("codeiq.yml"); + Files.writeString(yml, + "indexing:\n batchSize: 777\n cacheDir: /tmp/c\n" + + "serving:\n bindAddress: 1.2.3.4\n readOnly: false\n" + + "observability:\n logFormat: text\n logLevel: warn\n"); + + ListAppender appender = attachAppender(); + try { + CodeIqUnifiedConfig cfg = UnifiedConfigLoader.load(yml); + + // Values from the alias keys must flow into the record. + assertEquals(777, cfg.indexing().batchSize()); + assertEquals("/tmp/c", cfg.indexing().cacheDir()); + assertEquals("1.2.3.4", cfg.serving().bindAddress()); + assertEquals(Boolean.FALSE, cfg.serving().readOnly()); + assertEquals("text", cfg.observability().logFormat()); + assertEquals("warn", cfg.observability().logLevel()); + + // Exactly one WARN per alias used. + assertWarnsExactlyFor(appender, + "indexing.batchSize", "indexing.cacheDir", + "serving.bindAddress", "serving.readOnly", + "observability.logFormat", "observability.logLevel"); + for (ILoggingEvent w : warnsOnly(appender)) { + String msg = w.getFormattedMessage(); + assertTrue(msg.contains("deprecated"), + "alias WARN must flag the key as deprecated, got: " + msg); + } + } finally { + detachAppender(appender); + } + } + + @Test + void whenBothSnakeAndCamelCaseSetSnakeCaseWins(@TempDir Path tmp) throws Exception { + // Conflict: both canonical snake_case and deprecated camelCase present + // for the same leaf. snake_case must win; a single WARN must flag the + // conflict. + Path yml = tmp.resolve("codeiq.yml"); + Files.writeString(yml, + "indexing:\n batch_size: 100\n batchSize: 999\n"); + + ListAppender appender = attachAppender(); + try { + CodeIqUnifiedConfig cfg = UnifiedConfigLoader.load(yml); + assertEquals(100, cfg.indexing().batchSize(), + "snake_case must win when both forms are set"); + List warns = warnsOnly(appender); + assertEquals(1, warns.size(), + "exactly one WARN for the conflict; got: " + warns); + String msg = warns.get(0).getFormattedMessage(); + assertTrue(msg.contains("indexing.batchSize"), + "WARN must name the deprecated alias, got: " + msg); + assertTrue(msg.contains("indexing.batch_size"), + "WARN must name the canonical key, got: " + msg); + } finally { + detachAppender(appender); + } + } + + @Test + void aliasWarnIsDedupedPerFile(@TempDir Path tmp) throws Exception { + // A single load() call must emit at most ONE WARN per alias even if the + // same deprecated key appears on multiple leaves. (Here the load touches + // two distinct camelCase leaves -- each produces exactly one WARN; + // reloading the same file produces two more -- the dedupe is per load, + // not global.) + Path yml = tmp.resolve("codeiq.yml"); + Files.writeString(yml, + "indexing:\n batchSize: 1\n" + + "mcp:\n limits:\n perToolTimeoutMs: 2\n maxResults: 3\n"); + + ListAppender appender = attachAppender(); + try { + UnifiedConfigLoader.load(yml); + List warns = warnsOnly(appender); + assertEquals(3, warns.size(), + "one WARN per distinct alias (3 here), got: " + warns); + + // Second load of the same file: another 3 WARNs, NOT cumulative + // (dedupe is scoped per-load). + UnifiedConfigLoader.load(yml); + assertEquals(6, warnsOnly(appender).size(), + "per-load dedupe means a fresh load re-warns"); + } finally { + detachAppender(appender); + } + } + + // ---- helpers -------------------------------------------------------------- + + private static ListAppender attachAppender() { + Logger logger = (Logger) LoggerFactory.getLogger(UnifiedConfigLoader.class); + ListAppender appender = new ListAppender<>(); + appender.start(); + logger.addAppender(appender); + return appender; + } + + private static void detachAppender(ListAppender appender) { + Logger logger = (Logger) LoggerFactory.getLogger(UnifiedConfigLoader.class); + logger.detachAppender(appender); + } + + private static List warnsOnly(ListAppender a) { + return a.list.stream().filter(e -> e.getLevel() == Level.WARN).toList(); + } + + private static void assertWarnsExactlyFor(ListAppender a, String... aliases) { + List warns = warnsOnly(a); + assertEquals(aliases.length, warns.size(), + "expected one WARN per alias. aliases=" + List.of(aliases) + "; warns=" + warns); + for (String alias : aliases) { + boolean found = warns.stream() + .map(ILoggingEvent::getFormattedMessage) + .anyMatch(m -> m.contains(alias)); + assertTrue(found, "expected a WARN mentioning alias '" + alias + + "', got: " + warns); + } + } +} diff --git a/src/test/resources/config-unified/full.yml b/src/test/resources/config-unified/full.yml new file mode 100644 index 00000000..be78dd7b --- /dev/null +++ b/src/test/resources/config-unified/full.yml @@ -0,0 +1,53 @@ +project: + name: demo + root: . + modules: + - path: services/api + type: maven + name: api + kind: service + - path: libs/shared + type: maven + kind: library +indexing: + languages: [java, typescript] + exclude: ['**/generated/**'] + incremental: true + cache_dir: .code-iq/cache + parallelism: auto + batch_size: 500 +serving: + port: 9090 + bind_address: 127.0.0.1 + read_only: true + neo4j: + dir: .code-iq/graph/graph.db + page_cache_mb: 512 + heap_initial_mb: 256 + heap_max_mb: 2048 +mcp: + enabled: true + transport: http + base_path: /mcp + auth: + mode: none + limits: + per_tool_timeout_ms: 10000 + max_results: 200 + max_payload_bytes: 1000000 + rate_per_minute: 120 + tools: + enabled: ['*'] + disabled: [run_cypher] +observability: + metrics: true + tracing: false + log_format: json + log_level: info +detectors: + profiles: [default] + overrides: + SpringRestDetector: + enabled: true + QuarkusRestDetector: + enabled: false diff --git a/src/test/resources/config-unified/malformed.yml b/src/test/resources/config-unified/malformed.yml new file mode 100644 index 00000000..b2839389 --- /dev/null +++ b/src/test/resources/config-unified/malformed.yml @@ -0,0 +1,4 @@ +project: + name: oops +indexing: + batch_size: not-a-number # type mismatch diff --git a/src/test/resources/config-unified/minimal.yml b/src/test/resources/config-unified/minimal.yml new file mode 100644 index 00000000..7c348adb --- /dev/null +++ b/src/test/resources/config-unified/minimal.yml @@ -0,0 +1,4 @@ +project: + name: my-service +indexing: + batchSize: 2000