Skip to content

docs(analysis): assess CLI config path test isolation - #2188

Open
josecelano wants to merge 5 commits into
torrust:developfrom
josecelano:docs/analyze-cli-config-path-test-isolation
Open

docs(analysis): assess CLI config path test isolation#2188
josecelano wants to merge 5 commits into
torrust:developfrom
josecelano:docs/analyze-cli-config-path-test-isolation

Conversation

@josecelano

Copy link
Copy Markdown
Member

Summary

Adds a current-code analysis of where the merged --config-toml-path capability can remove configuration base-source environment mutation from tracker tests.

Findings

  • Identifies tests/common/workspace.rs as the highest-value migration candidate: it already owns an isolated TOML file but injects its path into the in-process test environment before app::start().
  • Identifies the shared fixture's seven functional main-level integration-suite consumers that would benefit from one fixture change.
  • Separates child-process configuration from shared test-process environment mutation; tests/common/native_tracker.rs already uses the CLI path correctly.
  • Retains environment mutation where legacy environment-source precedence is the behavior under test.
  • Assesses, but does not propose, a direct-TOML CLI option due to command-line length and secret-exposure risks.

Validation

  • linter markdown
  • linter cspell
  • linter lychee
  • git diff --check
  • required pre-commit gate

Related to #1419

Copilot AI lite review requested due to automatic review settings September 9, 2026 14:50

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Pull request overview

Adds a new analysis document detailing how --config-toml-path can improve tracker test isolation by reducing reliance on process-wide environment mutation, and links it from the docs index.

Changes:

  • Add a new analysis write-up on CLI config-path–driven test isolation.
  • Update the docs index to include the new analysis entry.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/index.md Adds an entry linking to the new analysis document in the analysis index table.
docs/analysis/20260909-cli-config-path-test-isolation/README.md Introduces a detailed analysis of migrating in-process fixtures from env-based config selection to explicit CLI config paths.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/analysis/20260909-cli-config-path-test-isolation/README.md Outdated
Comment thread docs/analysis/20260909-cli-config-path-test-isolation/README.md Outdated
@josecelano josecelano self-assigned this Sep 10, 2026
@josecelano
josecelano force-pushed the docs/analyze-cli-config-path-test-isolation branch from b2736c7 to d2b7cef Compare September 10, 2026 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants