Repository navigation
[AISOS-2519] Add JSON result output to forge project-setup - #350
Merged
Merged
Conversation
added 11 commits
September 30, 2026 16:17
…ct-setup Detailed description: - Registered the --json argument definition under setup_parser in src/forge/cli.py. - Modified cmd_project_setup to initialize a stateful mutation accumulator dictionary. - Logged all successful project property mutations (set and remove operations) to the dictionary. - Blocked standard console logs and only emitted pretty-printed JSON schema on stdout upon successful execution if --json is active. - Ensured stdout remains completely empty and all errors are cleanly piped to stderr on failures in JSON mode. - Added comprehensive unit tests in tests/unit/test_cli_config.py verifying SC-001 through SC-005. Closes: AISOS-2523
…n mode with jq Detailed description: - Satisfied requirement FR-007 by adding a runnable, representative example showing how --json output of forge project-setup is consumed via jq. - Added example with representative output to the CLI help description/examples docstring in src/forge/cli.py. - Added example with representative output to the user-facing configuration reference in docs/reference/config.md. Closes: AISOS-2524
…g Jira properties in cmd_project_setup Detailed description: - Audited all remaining Jira properties (prd_proposals_repo, prd_proposals_path, skills, model_policy, model_default, references) in cmd_project_setup to verify complete stateful mutation tracking and output suppression in JSON mode. - Added comprehensive unit tests inside TestCLIConfigProjectSetupJson class in tests/unit/test_cli_config.py to verify correct serialization, values, operations, and console output suppression for these properties. - Updated handoff.md with work details. Closes: AISOS-2525
…cessful completion Detailed description: - Audited and verified JSON serialization of mutations and metadata on successful completion of cmd_project_setup in src/forge/cli.py. - Added code annotation for AISOS-2526 inside src/forge/cli.py for clean identification. - Verified output suppression during JSON mode execution. - Confirmed full unit test coverage and backward compatibility. Closes: AISOS-2526
…) during JSON mode Detailed description: - Audited cmd_project_setup in src/forge/cli.py to guarantee 100% of standard output logs are guarded/suppressed during JSON mode. - Added explicit code comment and tracking linking the stdout suppression logic to [AISOS-2527]. - Confirmed error suppression (keeping stdout empty and routing validation errors to stderr) and backward compatibility with human-readable mode. - Verified that all Pytest unit tests pass successfully. Closes: AISOS-2527
…failure scenarios in JSON mode
Detailed description:
- Wrapped core processing inside cmd_project_setup in a try...except...finally block.
- Implemented redirection of sys.stdout to an in-memory buffer (io.StringIO) when args.json is active.
- Ensured stdout remains completely empty on failure scenarios, discarding any buffered stdout.
- Ensured the accumulated mutations JSON is printed to stdout only on successful execution (exit_code == 0).
- Standardized stderr routing on general exceptions by printing 'Error: {e}' to sys.stderr and returning code 1.
- Added comprehensive unit tests test_sc005_failure_reporting_json_exception to tests/unit/test_cli_config.py to verify stdout suppression and clean stderr routing.
Closes: AISOS-2528
…arios Detailed description: - Added robust unit tests under the TestCLIConfigJSONMode class in tests/unit/test_cli_config.py - Implemented specific tests verifying SC-001 (test_json_mode_single_set_mutation), SC-002 (test_json_mode_single_remove_mutation), and SC-003 (test_json_mode_mixed_mutations) success scenarios - Asserted that command exits with 0, produces no human-readable output, and formats stdout as pretty-printed JSON schema matching the target output specification Closes: AISOS-2529
Detailed description: - Removed the duplicate 'TestCLIConfigJSONMode' class from 'tests/unit/test_cli_config.py' as requested in reviewer feedback. - Ensured all success and error JSON mode tests remain fully implemented under the 'TestCLIConfigProjectSetupJson' class. - Verified that all unit tests continue to pass successfully. Closes: AISOS-2529
… backward compatibility (SC-004, SC-005) Detailed description: - Added comprehensive unit tests in tests/unit/test_cli_config.py verifying SC-004 and SC-005. - Implemented test_json_mode_backward_compatibility to verify standard output is preserved and no JSON is output when --json is omitted. - Implemented test_json_mode_suppressed_failure_reporting to verify that stdout is suppressed, errors are written to stderr, and the command exits with code 1 under failure/conflict scenarios in JSON mode. Closes: AISOS-2530
…ate unit test boilerplate Detailed description: - Refactored src/forge/cli.py to replace redundant getattr(args, "json", False) calls with the local variable is_json. - Refactored tests/unit/test_cli_config.py to introduce the setup_args staticmethod helper in TestCLIConfigProjectSetupJson. - Refactored all 12 test methods in TestCLIConfigProjectSetupJson to use the setup_args helper, eliminating over 270 lines of verbose boilerplate code. - Verified that all unit tests run and pass perfectly. Closes: AISOS-2530
Detailed description: - Documented error handling and exit codes in JSON mode for the forge project-setup command in docs/reference/config.md. - Verified that all other documentation files in the repository are completely accurate and up-to-date with recent branch changes. Closes: AISOS-2519-docs
Collaborator
Author
🤖 Reviewing a Forge pull requestTo send code feedback to Forge, open Files changed, select Review changes, and submit a Request changes review. Forge will address the review feedback automatically and push updates to this pull request. Regular comments are ignored by the review workflow. Use them for conversation or the Forge commands below:
|
added 2 commits
September 30, 2026 18:38
Detailed description: - Sorted the import block inside the cmd_project_setup function in src/forge/cli.py to comply with Ruff rule I001. - Verified file formatting and validated that all CLI-related tests and other suite tests continue to pass perfectly. Closes: AISOS-2519-ci-fix
…and clean formatting Detailed description: - Patched ContainerRunner in test_implement_work.py to fix unit test failure when podman is not installed. - Cleanly formatted and linted modified files tests/unit/test_cli_config.py and tests/unit/workflow/nodes/test_implement_work.py. Closes: AISOS-2519-review-ci-fix-1
eshulman2
approved these changes
Oct 1, 2026
eshulman2
left a comment
eshulman2
left a comment
Collaborator
There was a problem hiding this comment.
Reviewed the JSON project-setup output, documentation, CI fix, and focused tests. All required CI checks pass; approved for the AISOS-2519 workflow validation.
eshulman2
requested changes
Oct 1, 2026
eshulman2
left a comment
eshulman2
left a comment
Collaborator
There was a problem hiding this comment.
Two JSON-mode edge cases need fixes before this feature is complete. Please add regression tests for each, then rerun the focused CLI tests and lint.
| mutations["forge.references"] = {"operation": "set", "value": current_references} | ||
| if not is_json: | ||
| print(f"[OK] forge.references = {current_references}") | ||
| if list_references and not is_json: |
Collaborator
There was a problem hiding this comment.
With forge project-setup MYPROJ --list-references --json, this branch skips the only reference-list output and the final JSON contains mutations: {}. Please include the requested references in the JSON response (without presenting a read as a mutation), and test the list-only case.
Collaborator
Author
There was a problem hiding this comment.
Forge implemented this feedback in the latest pushed revision.
| if is_json: | ||
| sys.stdout = original_stdout | ||
| if exit_code == 0: | ||
| print(json.dumps({"project": project_key, "mutations": mutations}, indent=2)) |
Collaborator
There was a problem hiding this comment.
Success JSON is printed before await jira.close() runs. If closing raises, the command fails after emitting a success object, contrary to the documented empty-stdout-on-error contract. Please close before emitting success JSON and add a regression test for a close failure.
Collaborator
Author
There was a problem hiding this comment.
Forge implemented this feedback in the latest pushed revision.
Collaborator
Author
|
Forge is addressing PR review feedback now. |
Detailed description: - Include references in JSON response when listing references in JSON mode in src/forge/cli.py - Move JiraClient close inside the main try block to fail gracefully on close exceptions in src/forge/cli.py - Add regression tests test_json_mode_list_references and test_json_mode_close_failure to tests/unit/test_cli_config.py Closes: AISOS-2519-review-fix
eshulman2
approved these changes
Oct 1, 2026
eshulman2
left a comment
eshulman2
left a comment
Collaborator
There was a problem hiding this comment.
Verified both requested fixes in commit 16ce1a9: JSON reference listing now returns references, and Jira close failures return an error without emitting success JSON. All eight CI checks pass, including integration tests. The Forge review fix loop also processed and replied to both inline comments.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This pull request introduces a machine-parseable
--jsonmode to theforge project-setupcommand, facilitating seamless integration with downstream automation and orchestration pipelines. When enabled, the command tracks all successful property modifications and outputs them in a standardized, structured JSON schema, while completely suppressing human-readable status logs on stdout. On failure, stdout is kept entirely empty and descriptive errors are cleanly routed to stderr with a non-zero exit status, ensuring robust error handling and backward compatibility with standard execution modes.Changes
CLI & Project Setup Configuration (
src/forge/cli.py)--jsonboolean flag undersetup_parserfor theproject-setupcommand with descriptive help text and usage examples.cmd_project_setupto capture all configuration modifications (such as"set"or"remove") across all supported properties.[OK]stdout outputs when--jsonis active for properties includingforge.repos,forge.default_repo,forge.prd_proposals_repo,forge.prd_proposals_path,forge.skills,forge.model_policy,forge.model_default, andforge.references.Reference Documentation (
docs/reference/config.md)--jsonmode behavior, output schema, error handling, and exit codes.--jsonoutput usingjqfor downstream automations.Unit Testing Suite (
tests/unit/test_cli_config.py)TestCLIConfigProjectSetupJsoncovering success scenarios (single sets, single removes, and mixed mutations).--jsonis omitted) and failure reporting (empty stdout and populated stderr under invalid parameters or exceptions).setup_argshelper method to eliminate duplicate test configuration boilerplate across tests.Implementation Notes
io.StringIO) during--jsonmode execution to safely intercept and manage stdout, ensuring that no partial or diagnostic output is leaked on unexpected failures.getattr(args, "json", False)lookups into a single local boolean flagis_jsonto clean up control flow and maintainability insidecmd_project_setup.setorremove) and the actual value (payload or null) within a top-level JSON structure.Testing
--jsonpreserves standard human-readable[OK]status lines and does not print any JSON payload.--jsonis active and validation/runtime errors occur, stdout remains completely empty, the descriptive error message is output on stderr, and the exit code is 1.Related Tickets
Generated by Forge SDLC Orchestrator