Skip to content

Make TEA config defaults non-interactive#108

Open
muratkeremozcan wants to merge 3 commits into
mainfrom
feat/toml-config-for-install
Open

Make TEA config defaults non-interactive#108
muratkeremozcan wants to merge 3 commits into
mainfrom
feat/toml-config-for-install

Conversation

@muratkeremozcan

@muratkeremozcan muratkeremozcan commented May 26, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • remove TEA-specific installer questions by marking module config entries as non-interactive defaults
  • mirror TEA module defaults in the agent customize.toml [config] block for upcoming BMad customize/global config support
  • default Playwright Utils, Pact.js Utils, Pact MCP, and browser automation integrations on, with docs and tests updated

Notes

  • Kept module.yaml single-select metadata for future UI/config tooling.
  • Kept the existing test_artifacts result transform unchanged pending the BMad core installer contract.

@muratkeremozcan muratkeremozcan marked this pull request as ready for review May 26, 2026 17:00
@augmentcode

augmentcode Bot commented May 26, 2026

Copy link
Copy Markdown
🤖 Augment PR Summary

Summary: This PR makes TEA (Test Engineering Architect) installation/configuration non-interactive by turning TEA module config prompts into fixed defaults.

Changes:

  • Updates src/module.yaml to mark TEA config keys as prompt: false, keeping defaults and result transforms intact.
  • Changes TEA defaults to enable Playwright Utils, Pact.js Utils, and Pact MCP by default, and keeps browser automation in auto mode.
  • Adds a [config] block to src/agents/bmad-tea/customize.toml mirroring module defaults for upcoming customize/global-config tooling.
  • Refreshes docs to reflect the new default-on integrations and the removal of installer questions.
  • Extends installation component tests to assert non-interactive defaults and validate key workflow references.
  • Updates CHANGELOG with the new non-interactive default behavior and new TEA integration defaults.

Technical Notes: Defaults are now expressed in both module.yaml (schema/installer metadata) and customize.toml (future customization surface); projects can still override via _bmad/tea/config.yaml.

🤖 Was this summary useful? React with 👍 or 👎

@augmentcode augmentcode Bot 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.

Review completed. 2 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

Comment thread src/module.yaml
Comment thread test/test-installation-components.js Outdated

assert(customizeContent.includes('[agent]'), 'customize.toml has [agent] section');
assert(customizeContent.includes('[config]'), 'customize.toml has [config] defaults section');
assert(/^\s*tea_use_playwright_utils\s*=\s*true/m.test(customizeContent), 'customize.toml defaults Playwright Utils on');

@augmentcode augmentcode Bot May 26, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

test/test-installation-components.js:162: These regex assertions only verify the keys appear somewhere in customize.toml, so the test could still pass even if the defaults are accidentally moved outside the [config] block. That could mask a mis-scoped default that future customization tooling would ignore.

Severity: low

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

@coderabbitai

coderabbitai Bot commented May 26, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This PR shifts TEA from interactive installer questions to non-interactive defaults. The src/module.yaml file disables prompts for twelve configuration keys and updates defaults for Playwright Utils, Pact.js Utils, and Pact MCP. Matching defaults are mirrored into src/agents/bmad-tea/customize.toml. Tests validate the new behavior, and all documentation is updated to reflect the enabled-by-default semantics and explain the new configuration flow.

Changes

TEA Non-Interactive Defaults Configuration

Layer / File(s) Summary
Module Configuration Schema and Non-Interactive Defaults
src/module.yaml
Disables interactive prompts (prompt: false) for all TEA configuration variables. Establishes new defaults: Playwright Utils and Pact.js Utils both default to true, Pact MCP defaults to "mcp" (previously "none"), and output folder paths standardize to use {test_artifacts} prefix.
Global Defaults in Customize TOML
src/agents/bmad-tea/customize.toml
Introduces a new [config] section with BMad global defaults mirroring the non-interactive defaults from src/module.yaml, including test artifact paths, Playwright/Pact utility toggles, Pact MCP mode, browser automation behavior, and output/traceability labels.
Installation and Validation Tests
test/test-installation-components.js
Test suite is updated to validate non-interactive configuration keys have prompt: false with explicit defaults, verify new default values for Playwright Utils, Pact.js Utils, and Pact MCP, assert the presence of a [config] section in customize.toml, and check that specific workflow steps reference Pact configuration variables.
Documentation Updates for New Default Behavior
CHANGELOG.md, README.md, docs/explanation/tea-overview.md, docs/how-to/customization/integrate-playwright-utils.md, docs/how-to/workflows/setup-test-framework.md, docs/reference/configuration.md, docs/reference/troubleshooting.md
All documentation is updated to reflect the shift from interactive to non-interactive configuration and the new defaults: CHANGELOG records the changes, README describes defaults driven by customize.toml and module.yaml, tea-overview explains each integration's new default state, configuration reference updates all variable descriptions and examples with new defaults and "Not prompted" behavior, troubleshooting provides guidance for overriding defaults via customization tooling, and how-to docs clarify the enabled-by-default behavior for Playwright Utils.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: making TEA configuration defaults non-interactive, which is the primary objective throughout the changeset.
Description check ✅ Passed The description is directly related to the changeset, explaining the removal of interactive installer questions, mirroring defaults in customize.toml, and defaulting specific integrations on with documentation updates.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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/toml-config-for-install

Warning

Review ran into problems

🔥 Problems

Stopped waiting for pipeline failures after 30000ms. One of your pipelines takes longer than our 30000ms fetch window to run, so review may not consider pipeline-failure results for inline comments if any failures occurred after the fetch window. Increase the timeout if you want to wait longer or run a @coderabbit review after the pipeline has finished.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot 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.

🧹 Nitpick comments (1)
docs/reference/configuration.md (1)

1080-1086: ⚡ Quick win

Consider clarifying installation instructions wording.

Lines 1080-1084 use "when you want" phrasing that might confuse users, since these utilities are already enabled by default. The current wording suggests they're opt-in, when they're actually opt-out.

Consider rewording to reflect the default-enabled state more clearly:

5. Install playwright-utils to use the enabled-by-default utility fixtures:
   npm install -D `@seontechnologies/playwright-utils`
6. Install pactjs-utils to use the enabled-by-default contract-testing patterns:
   npm install -D `@seontechnologies/pactjs-utils` `@pact-foundation/pact`
7. Install SmartBear MCP if your service uses PactFlow/Pact Broker:
   npm install -g `@smartbear/mcp`
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/reference/configuration.md` around lines 1080 - 1086, Update the
phrasing in the installation steps for "playwright-utils", "pactjs-utils" and
SmartBear MCP to reflect that the utility fixtures and contract-testing patterns
are enabled by default (i.e., opt-out) rather than implying they are opt-in;
replace "when you want" wording with language like "to use the
enabled-by-default utility fixtures" for playwright-utils, "to use the
enabled-by-default contract-testing patterns" for pactjs-utils, and change the
Pact MCP line to "Install SmartBear MCP if your service uses PactFlow/Pact
Broker" so the intent is clear for readers.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docs/reference/configuration.md`:
- Around line 1080-1086: Update the phrasing in the installation steps for
"playwright-utils", "pactjs-utils" and SmartBear MCP to reflect that the utility
fixtures and contract-testing patterns are enabled by default (i.e., opt-out)
rather than implying they are opt-in; replace "when you want" wording with
language like "to use the enabled-by-default utility fixtures" for
playwright-utils, "to use the enabled-by-default contract-testing patterns" for
pactjs-utils, and change the Pact MCP line to "Install SmartBear MCP if your
service uses PactFlow/Pact Broker" so the intent is clear for readers.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c7a397ad-b6d5-4ca2-8ae4-3de9bef7fb9d

📥 Commits

Reviewing files that changed from the base of the PR and between 8734d51 and d31dc5c.

📒 Files selected for processing (10)
  • CHANGELOG.md
  • README.md
  • docs/explanation/tea-overview.md
  • docs/how-to/customization/integrate-playwright-utils.md
  • docs/how-to/workflows/setup-test-framework.md
  • docs/reference/configuration.md
  • docs/reference/troubleshooting.md
  • src/agents/bmad-tea/customize.toml
  • src/module.yaml
  • test/test-installation-components.js

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.

1 participant