Mfal/copilot files #440

flkmhd · 2026-01-29T08:25:10Z

No description provided.

…plars

- Add -O for --oid (organization ID) - Add -W for --wid (workspace ID) - Add -S for --sid (solution ID) - Add -d for --did (dataset ID) - Add -r for --rid (runner ID) - Add -R for --rnid (run ID) - Add comprehensive tests for API short-form options

- Add -N for --namespace in apply and destroy macros - Append Macro test class skeleton - Update Step 2 checklist and verification

…form -w for --workspace-id in multiple PowerBI command files (without testing powerbi commands)

…ers add command

- Added short-form alternatives (-X) for all applicable CLI options across Babylon commands to enhance usability.

Copilot

Pull request overview

This PR adds short-form CLI option support to the Babylon CLI tool, along with comprehensive documentation, tests, and GitHub Copilot configuration files for maintaining code quality and architectural consistency.

Changes:

Adds short-form options (e.g., -O, -w, -e, -l) to API, PowerBI, Azure, and main CLI commands
Introduces comprehensive test coverage for short-form options via two test files
Adds GitHub Copilot instructions and prompt templates for structured development workflows
Documents architectural patterns, code exemplars, and implementation details

Reviewed changes

Copilot reviewed 41 out of 43 changed files in this pull request and generated 13 comments.

Show a summary per file

File	Description
`tests/unit/test_option_shortform.py`	Comprehensive tests verifying short-form options appear in help text for API, PowerBI, Azure, and main CLI commands
`tests/unit/test_help_shortform.py`	Test ensuring `-h` and `--help` produce identical output across all commands
`plans/short-form-options/implementation.md`	Detailed step-by-step implementation guide with verification checklists
`plans/short-form-options/changes.md`	Summary of all short-form option changes and conflicts
`plans/short-form-options/exemplars.md`	Code quality guidelines and architectural patterns
`plans/doc_copilot/plan.md`	Development planning workflow documentation
`plans/doc_copilot/Project_Architecture_Blueprint.md`	Comprehensive architecture documentation
`Babylon/main.py`	Adds `-h` help shortform and `-l` for `--log-path`
`Babylon/commands/powerbi/*/.py`	Adds `-w` for `--workspace-id` and `-e` for `--email` across PowerBI commands
`Babylon/commands/azure/token/*.py`	Adds `-e` for `--email` in Azure token commands
`Babylon/commands/api/*.py`	Adds short forms for organization, workspace, solution, dataset, runner, and run ID options
`Babylon/commands/macro/apply.py`	Adds `-N` for `--namespace` option
`Babylon/commands/macro/destroy.py`	Adds `-N` for `--namespace` option
`.github/prompts/*.md`	GitHub Copilot prompt templates for planning, implementation, and blueprint generation
`.github/copilot-instructions.md`	Project-specific coding instructions for GitHub Copilot
`babylon_info.log`, `babylon_error.log`	Empty log files (should not be committed)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-29T08:30:48Z

.github/copilot-instructions.md

+- [Project_Architecture_Blueprint.md](Project_Architecture_Blueprint.md): For a deep dive into the system's architecture, layers, and design decisions.
+- [exemplars.md](exemplars.md): For high-quality code examples demonstrating standard patterns and best practices.


The file paths referenced in lines 56-57 are incorrect. The files are located at plans/doc_copilot/Project_Architecture_Blueprint.md and plans/short-form-options/exemplars.md respectively, not in the root directory. These paths should be updated to reflect the actual file locations so that developers can find the referenced documentation.

Suggested change

- [Project_Architecture_Blueprint.md](Project_Architecture_Blueprint.md): For a deep dive into the system's architecture, layers, and design decisions.

- [exemplars.md](exemplars.md): For high-quality code examples demonstrating standard patterns and best practices.

- [Project_Architecture_Blueprint.md](plans/doc_copilot/Project_Architecture_Blueprint.md): For a deep dive into the system's architecture, layers, and design decisions.

- [exemplars.md](plans/short-form-options/exemplars.md): For high-quality code examples demonstrating standard patterns and best practices.

Copilot · 2026-01-29T08:30:49Z

tests/unit/test_option_shortform.py

+        result = runner.invoke(main, command_path + ["--help"])
+        assert result.exit_code == 0
+        assert "-d" in result.output, f"-d not found in {' '.join(command_path)} help"
+        assert "--did" in result.output, f"--did not found in {' '.join(command_path)} help"


The error message contains a grammatical error. It should read "not found" instead of "not found" (missing the word "not").

Copilot · 2026-01-29T08:30:49Z

Babylon/commands/macro/apply.py

+    # If a namespace is provided, set it for the environment
+    if namespace:
+        env.get_ns_from_text(content=namespace)


The namespace parameter logic has a potential issue. When a namespace is provided via the -N/--namespace flag, it sets the environment namespace globally at line 73. However, the deploy_objects function also calls env.get_ns_from_text(content=namespace) for each resource (see line 23 in deploy_organization.py, deploy_solution.py, and deploy_workspace.py), where the namespace comes from the YAML file. This means that:

If a user provides -N namespace1 but the YAML files contain different namespace values, the namespace from the YAML file will override the CLI-provided namespace for each resource.

The CLI-provided namespace is set once at the beginning but can be overwritten multiple times by YAML files.

This could lead to unexpected behavior. Consider either:

Making the CLI namespace take precedence over YAML namespace values, or

Documenting clearly that YAML namespace values override the CLI namespace, or

Validating that CLI and YAML namespaces match if both are provided

Copilot · 2026-01-29T08:30:49Z

Babylon/commands/macro/destroy.py

 @retrieve_state
+@option("-N", "--namespace", "namespace", required=False, type=str, help="The namespace to destroy")
 @option("--include", "include", multiple=True, type=str, help="Specify the resources to destroy.")
 @option("--exclude", "exclude", multiple=True, type=str, help="Specify the resources to exclude from destroction.")


Spelling error in the help text: "destroction" should be "destruction".

Suggested change

@option("--exclude", "exclude", multiple=True, type=str, help="Specify the resources to exclude from destroction.")

@option("--exclude", "exclude", multiple=True, type=str, help="Specify the resources to exclude from destruction.")

Copilot · 2026-01-29T08:30:50Z

Babylon/commands/api/workspace.py

 @pass_keycloak_token()
-@option("--oid", "organization_id", required=True, type=str, help="Organization ID")
+@option("-O", "--oid", "organization_id", required=True, type=str, help="Organization ID")
 @option("--sid", "solution_id", required=True, type=str, help="Solution ID")


The --sid option is missing its short form -S. According to the documentation in the PR (changes.md and implementation.md), the --sid option should have the short form -S added. This is inconsistent with other files where short forms were added (e.g., line 63 in solution.py has -S). The option on line 35 should be @option("-S", "--sid", ...) to match the pattern used elsewhere.

Suggested change

@option("--sid", "solution_id", required=True, type=str, help="Solution ID")

@option("-S", "--sid", "solution_id", required=True, type=str, help="Solution ID")

Copilot · 2026-01-29T08:30:51Z

Babylon/commands/macro/destroy.py

 @retrieve_state
+@option("-N", "--namespace", "namespace", required=False, type=str, help="The namespace to destroy")
 @option("--include", "include", multiple=True, type=str, help="Specify the resources to destroy.")
 @option("--exclude", "exclude", multiple=True, type=str, help="Specify the resources to exclude from destroction.")
 def destroy(
    state: dict,
+    namespace: str | None,
    include: tuple[str],
    exclude: tuple[str],
 ):
    """Macro Destroy"""
+    # If a namespace is provided, set it for the environment before using state
+    if namespace:
+        env.get_ns_from_text(content=namespace)


The @retrieve_state decorator is called before the namespace is set. The decorator at line 42 will retrieve the state based on the current environment namespace, but the namespace parameter is only processed at lines 54-55 after the state has already been retrieved. This means the state will be retrieved for the wrong namespace.

The namespace parameter should be processed before @retrieve_state is executed. Consider either:

Moving the namespace logic into the decorator chain

Removing @retrieve_state and manually retrieving the state after setting the namespace

Creating a custom decorator that handles both namespace setting and state retrieval in the correct order

Copilot · 2026-01-29T08:30:51Z

Babylon/commands/api/runner.py

 @pass_keycloak_token()
-@option("--oid", "organization_id", required=True, type=str, help="Organization ID")
+@option("-O", "--oid", "organization_id", required=True, type=str, help="Organization ID")
 @option("--sid", "solution_id", required=True, type=str, help="Solution ID")


The --sid option is missing its short form -S. According to the documentation in the PR (changes.md and implementation.md), the --sid option should have the short form -S added. This should be @option("-S", "--sid", ...) to be consistent with the changes made in solution.py and other files.

Suggested change

@option("--sid", "solution_id", required=True, type=str, help="Solution ID")

@option("-S", "--sid", "solution_id", required=True, type=str, help="Solution ID")

Copilot · 2026-01-29T08:30:51Z

Babylon/commands/api/dataset.py

+@option("-O", "--oid", "organization_id", required=True, type=str, help="Organization ID")
+@option("-W", "--wid", "workspace_id", required=True, type=str, help="Workspace ID")
+@option("-d", "--did", "dataset_id", required=True, type=str, help="Dataset ID")
 @option("--dpid", "dataset_part_id", required=True, type=str, help="Dataset Part ID")


The --dpid option is missing its short form -p. This should be @option("-p", "--dpid", ...) to be consistent with the documented changes.

Copilot · 2026-01-29T08:30:52Z

Babylon/commands/api/dataset.py

+@option("-O", "--oid", "organization_id", required=True, type=str, help="Organization ID")
+@option("-W", "--wid", "workspace_id", required=True, type=str, help="Workspace ID")
+@option("-d", "--did", "dataset_id", required=True, type=str, help="Dataset ID")
 @option("--dpid", "dataset_part_id", required=True, type=str, help="Dataset Part ID")


The --dpid option is missing its short form -p. This should be @option("-p", "--dpid", ...) to be consistent with the documented changes.

Suggested change

@option("--dpid", "dataset_part_id", required=True, type=str, help="Dataset Part ID")

@option("-p", "--dpid", "dataset_part_id", required=True, type=str, help="Dataset Part ID")

Copilot · 2026-01-29T08:30:52Z

tests/unit/test_help_shortform.py

@@ -0,0 +1,42 @@
+import pytest


Import of 'pytest' is not used.

- Added short-form options for organization ID (-O), workspace ID (-W), solution ID (-S), dataset ID (-d), dataset part ID (-p), runner ID (-r), and run ID (-R) across various API commands. - Updated macro commands to remove unused namespace option and cleaned up related code. - Enhanced tests to verify the presence of short-form options in help outputs for API, PowerBI, and Azure commands.

Copilot

Pull request overview

Copilot reviewed 37 out of 40 changed files in this pull request and generated 6 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-29T09:41:30Z

plans/short-form-options/implementation.md

+- [x] `-l` and `--log-path` both appear in help output (verified via CliRunner)
+- [x] No syntax errors in modified files
+
+### Step 6 STOP & COMMITsource


The text "STOP & COMMITsource" appears to have a typo. It should be "STOP & COMMIT" (the word "source" seems to be accidentally appended).

Copilot · 2026-01-29T09:41:30Z

.github/prompts/structured-autonomy-plan.prompt.md

+1. **Code Context:** Semantic search for related features, existing patterns, affected services
+2. **Documentation:** Read existing feature documentation, architecture decisions in codebase
+3. **Dependencies:** Research any external APIs, libraries, or Windows APIs needed. Use #context7 if available to read relevant documentation. ALWAYS READ THE DOCUMENTATION FIRST.
+4. **Patterns:** Identify how similar features are implemented in ResizeMe


The prompt references "ResizeMe" on line 78, which appears to be from a different project. This should be updated to reference "Babylon" to match the current project context.

Suggested change

4. **Patterns:** Identify how similar features are implemented in ResizeMe

4. **Patterns:** Identify how similar features are implemented in Babylon

Copilot · 2026-01-29T09:41:30Z

.github/prompts/structured-autonomy-plan.prompt.md

+4. Ask clarifying questions for any `[NEEDS CLARIFICATION]` sections
+5. MANDATORY: Pause for feedback
+6. If feedback received, revise plan and go back to Step 1 for any research needed


The step numbering in the Plan Generation section is incorrect. It goes from step 2 to step 4, skipping step 3. The list should be numbered 1, 2, 3, 4, 5, 6.

Suggested change

4. Ask clarifying questions for any `[NEEDS CLARIFICATION]` sections

5. MANDATORY: Pause for feedback

6. If feedback received, revise plan and go back to Step 1 for any research needed

3. Ask clarifying questions for any `[NEEDS CLARIFICATION]` sections

4. MANDATORY: Pause for feedback

5. If feedback received, revise plan

6. Go back to Step 1 for any research needed

Copilot · 2026-01-29T09:41:31Z

plans/short-form-options/implementation.md

+All short-form options are covered by tests in:
+- `tests/unit/test_option_shortform.py`
+- `tests/unit/test_help_shortform.py`
+
+Run all tests:
+```bash
+pytest tests/unit/test_option_shortform.py tests/unit/test_help_shortform.py -v
+```


The implementation.md document references test files tests/unit/test_option_shortform.py and tests/unit/test_help_shortform.py throughout (lines 261-297, 337-350, 401-422, 473-489, and in the final verification sections), but these test files do not exist in the repository.

Either:

Create the referenced test files as part of this PR

Remove references to these non-existent test files from the documentation

Update the documentation to clarify that tests are planned but not yet implemented

Copilot · 2026-01-29T09:41:31Z

plans/short-form-options/implementation.md

+### Macro Commands (Steps 1-2, Previously Completed)
+
+| Long Option | Short Option | Files Modified |
+|-------------|--------------|----------------|
+| `--namespace` | `-N` | apply.py, deploy.py, destroy.py |
+


The documentation states that Macro commands have a --namespace option with -N short form added in steps 1-2, but this is inaccurate. The macro commands (apply, destroy, init) don't expose a --namespace CLI option. The namespace parameter exists only in internal functions like deploy_organization(), deploy_solution(), and deploy_workspace(), which are not directly accessible as CLI commands.

Update the documentation to accurately reflect which commands received short-form options, or clarify that these are internal function parameters rather than CLI options.

Copilot · 2026-01-29T09:41:31Z

plans/short-form-options/implementation.md

+## Total Summary
+
+- **Total options with short forms:** 11 unique options
+- **Total files modified:** ~35 files
+- **Commands affected:** API, Macro, PowerBI, Azure, Main CLI


The total count states "11 unique options" with commands affected including "Macro", but based on the codebase analysis, macro commands don't have the documented namespace short-form option. The count should be "10 unique options" and macro commands should be removed from the affected commands list, as already corrected in the changes.md file (line 43).

Mahdi Falek added 9 commits January 27, 2026 10:29

docs: add Copilot instructions, architecture blueprint, and code exem…

118402b

…plars

Add -h help alias via context_settings; add tests

608d703

feat(cli): add -N short-form for macro namespaces

41f9b00

- Add -N for --namespace in apply and destroy macros - Append Macro test class skeleton - Update Step 2 checklist and verification

feat(cli): add short-form options for PowerBI commands - Added short-…

0354183

…form -w for --workspace-id in multiple PowerBI command files (without testing powerbi commands)

feat(cli): add short-form option -e for --email in PowerBI dataset us…

b5fee82

…ers add command

feat(cli): add short-form option -e for --email in Azure token commands

2d063b9

feat(cli): add short-form option -l for --log-path in main CLI

045ac87

feat: Implement short-form options for all CLI commands

51a0b29

- Added short-form alternatives (-X) for all applicable CLI options across Babylon commands to enhance usability.

flkmhd requested a review from Copilot January 29, 2026 08:25

Copilot started reviewing on behalf of flkmhd January 29, 2026 08:25 View session

Copilot AI reviewed Jan 29, 2026

View reviewed changes

flkmhd requested a review from Copilot January 29, 2026 09:34

Copilot started reviewing on behalf of flkmhd January 29, 2026 09:35 View session

Copilot AI reviewed Jan 29, 2026

View reviewed changes

		- [Project_Architecture_Blueprint.md](Project_Architecture_Blueprint.md): For a deep dive into the system's architecture, layers, and design decisions.
		- [exemplars.md](exemplars.md): For high-quality code examples demonstrating standard patterns and best practices.

	@option("--exclude", "exclude", multiple=True, type=str, help="Specify the resources to exclude from destroction.")
	@option("--exclude", "exclude", multiple=True, type=str, help="Specify the resources to exclude from destruction.")

	@option("--sid", "solution_id", required=True, type=str, help="Solution ID")
	@option("-S", "--sid", "solution_id", required=True, type=str, help="Solution ID")

	@option("--dpid", "dataset_part_id", required=True, type=str, help="Dataset Part ID")
	@option("-p", "--dpid", "dataset_part_id", required=True, type=str, help="Dataset Part ID")

	4. Patterns: Identify how similar features are implemented in ResizeMe
	4. Patterns: Identify how similar features are implemented in Babylon

Mfal/copilot files #440

Are you sure you want to change the base?

Mfal/copilot files #440

Uh oh!

Conversation

flkmhd commented Jan 29, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants