fix: dry run with YAML config #3104

[rrayst]

Summary by CodeRabbit

• New Features
  • Configuration verification for the CLI now supports YAML files in addition to XML.
• Bug Fixes
  • Dry-run verification correctly handles YAML, avoiding XML-specific parsing errors and ensuring proper success/failure behavior.
• Tests
  • Added automated CLI tests covering valid YAML, valid XML, and invalid YAML, including checks for expected exit codes and absence of the prior XML prolog error.
• Chores
  • Added a dedicated YAML dry-run configuration test resource.

[claude]

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review for a one-time review, or @claude review always to subscribe this PR to a review on every future push.

_{Tip: disable this comment in your organization's Code Review settings.}

[rrayst]

/ok-to-test

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 9968166a-0e1c-4593-b3a9-3e7c1f0aee3b

📥 Commits

Reviewing files that changed from the base of the PR and between 7cb8374 and efb4241.

📒 Files selected for processing (1)

• distribution/src/test/java/com/predic8/membrane/examples/withoutinternet/cli/VerifyConfigurationTest.java

🚧 Files skipped from review as they are similar to previous changes (1)

• distribution/src/test/java/com/predic8/membrane/examples/withoutinternet/cli/VerifyConfigurationTest.java

---

📝 Walkthrough

Walkthrough

Dry-run verification now selects YAML or XML configuration loading based on the file extension. Unit and distribution tests cover valid YAML, valid XML, and invalid YAML CLI behavior.

Changes

Configuration verification

Layer / File(s)	Summary
Format-specific verification dispatch core/src/main/java/.../RouterCLI.java	dryRun delegates to verifyConfiguration, which loads YAML into DefaultRouter and refreshes the XML context for other formats.
Configuration verification coverage core/src/test/java/.../RouterCLITest.java, core/src/test/resources/configuration/dry-run.apis.yaml, distribution/src/test/java/.../VerifyConfigurationTest.java	Tests cover YAML parsing, valid XML verification, invalid YAML exit behavior, and captured CLI output.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Sequence Diagram(s)

sequenceDiagram
  participant CLI
  participant RouterCLI
  participant DefaultRouter
  participant XMLContext
  CLI->>RouterCLI: invoke dry-run verification
  RouterCLI->>RouterCLI: select loader by extension
  RouterCLI->>DefaultRouter: load YAML configuration
  RouterCLI->>XMLContext: refresh XML configuration
  RouterCLI-->>CLI: return verification exit code

Loading

Possibly related PRs

• membrane/api-gateway#1836: Changes the related RouterCLI dry-run configuration flow.
• membrane/api-gateway#2302: Refactors YAML parsing in the same dry-run processing path.
• membrane/api-gateway#2959: Uses the shared YAML router bootstrapping flow in RouterCLI.

Suggested reviewers: predic8

Poem

I’m a rabbit, I test YAML bright,
XML hops through its context right.
Bad configs tumble, exit one,
Good ones greet the rising sun.
Dry runs now leap without a fright!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: fixing dry-run handling for YAML configuration.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat-3104

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}