Merge pull request #13 from cloudengine-labs/copilot/add-setup-instructions

Add --dir option to `devopsos init` command

Author: chefgs

.gitignore

@@ -17,3 +17,13 @@ docs/test-report.html
 hugo-docs/public/
 hugo-docs/resources/
 hugo-docs/.hugo_build.lock
+
+# Scaffold-generated output files (created by `python -m cli.devopsos scaffold *`)
+.gitlab-ci.yml
+Jenkinsfile
+argocd/
+sre/
+
+# GHA workflow generated by scaffold (not the repo's own CI workflows)
+# Only exclude the scaffold-generated workflow name to avoid masking real CI files
+.github/workflows/devops-os-complete.yml

cli/devopsos.py

@@ -1,4 +1,5 @@
 import enum
+import sys
 import typer
 from InquirerPy import inquirer
 import json
@@ -26,7 +27,9 @@ class ProcessFirstSection(str, enum.Enum):
 app = typer.Typer(help="Unified DevOps-OS CLI tool")
 
 @app.command()
-def init():
+def init(
+    directory: str = typer.Option(".", "--dir", help="Target directory in which the .devcontainer folder will be created (defaults to the current directory)"),
+):
     """Interactive project initializer."""
     typer.echo("Welcome to DevOps-OS Init Wizard!")
 
@@ -72,8 +75,8 @@ def init():
         raise typer.Exit(1)
 
     # Write to .devcontainer/devcontainer.env.json
-    devcontainer_dir = Path(".devcontainer")
-    devcontainer_dir.mkdir(exist_ok=True)
+    devcontainer_dir = Path(directory) / ".devcontainer"
+    devcontainer_dir.mkdir(parents=True, exist_ok=True)
     env_json_path = devcontainer_dir / "devcontainer.env.json"
     with open(env_json_path, "w") as f:
         json.dump(config, f, indent=2)
@@ -144,22 +147,33 @@ def scaffold(
     tool: str = typer.Option(None, help="Tool type (e.g., github, jenkins, argo, flux)"),
 ):
     """Scaffold CI/CD or K8s resources."""
-    if target == "cicd":
-        scaffold_cicd.main()
-    elif target == "gha":
-        scaffold_gha.main()
-    elif target == "gitlab":
-        scaffold_gitlab.main()
-    elif target == "jenkins":
-        scaffold_jenkins.main()
-    elif target == "argocd":
-        scaffold_argocd.main()
-    elif target == "sre":
-        scaffold_sre.main()
-    elif target == "devcontainer":
-        scaffold_devcontainer.main()
-    else:
-        typer.echo("Unknown scaffold target.")
+    # Each scaffold module uses argparse internally and calls parse_args() which
+    # reads sys.argv.  When invoked via `python -m cli.devopsos scaffold <target>`
+    # sys.argv still contains the parent CLI tokens (e.g. ['devopsos.py', 'scaffold',
+    # 'gha']).  Temporarily strip those extra tokens so argparse inside each
+    # scaffold module only sees the program name and falls back to env-var / default
+    # values, then restore sys.argv afterwards.
+    _saved_argv = sys.argv[:]
+    sys.argv = sys.argv[:1]
+    try:
+        if target == "cicd":
+            scaffold_cicd.main()
+        elif target == "gha":
+            scaffold_gha.main()
+        elif target == "gitlab":
+            scaffold_gitlab.main()
+        elif target == "jenkins":
+            scaffold_jenkins.main()
+        elif target == "argocd":
+            scaffold_argocd.main()
+        elif target == "sre":
+            scaffold_sre.main()
+        elif target == "devcontainer":
+            scaffold_devcontainer.main()
+        else:
+            typer.echo("Unknown scaffold target.")
+    finally:
+        sys.argv = _saved_argv
 
 @app.command("process-first")
 def process_first_cmd(

cli/test_cli.py

@@ -1,5 +1,6 @@
 import subprocess
 import sys
+import re
 import tempfile
 import os
 import yaml
@@ -15,12 +16,59 @@ def _run_module(module, extra_args=None):
     args = ["-m", module] + (extra_args or [])
     return _run(args)
 
+_ANSI_ESCAPE = re.compile(r'\x1b\[[0-9;]*[mK]')
+
+def _strip_ansi(s):
+    """Remove ANSI escape codes so plain-text assertions work regardless of terminal colour."""
+    return _ANSI_ESCAPE.sub('', s)
+
 # -- devopsos CLI ----------------------------------------------------------
 
 def test_help():
     result = _run(["-m", "cli.devopsos", "--help"])
     assert "Unified DevOps-OS CLI tool" in result.stdout
 
+def test_init_help_shows_dir_option():
+    """--dir option must appear in `devopsos init --help`."""
+    result = subprocess.run(
+        [sys.executable, "-m", "cli.devopsos", "init", "--help"],
+        capture_output=True, text=True,
+        cwd=os.path.dirname(os.path.dirname(__file__)),
+        env={**os.environ, "NO_COLOR": "1"},
+    )
+    assert result.returncode == 0
+    assert "--dir" in _strip_ansi(result.stdout)
+
+def test_init_dir_option_creates_devcontainer_in_specified_dir():
+    """--dir places .devcontainer inside the given directory, not the cwd."""
+    from unittest.mock import MagicMock, patch
+    from typer.testing import CliRunner
+    from cli.devopsos import app
+
+    checkbox_mock = MagicMock()
+    checkbox_mock.execute.return_value = []  # nothing selected
+
+    # First confirm  → Proceed = True
+    # Second confirm → Generate Dockerfile = False (skip, we only need env.json)
+    confirm_proceed = MagicMock()
+    confirm_proceed.execute.return_value = True
+    confirm_skip = MagicMock()
+    confirm_skip.execute.return_value = False
+
+    with tempfile.TemporaryDirectory() as tmp:
+        with patch("cli.devopsos.inquirer.checkbox", return_value=checkbox_mock), \
+             patch("cli.devopsos.inquirer.confirm",
+                   side_effect=[confirm_proceed, confirm_skip]):
+            runner = CliRunner()
+            result = runner.invoke(app, ["init", "--dir", tmp])
+
+        assert result.exit_code == 0, result.output
+        dc_dir = Path(tmp) / ".devcontainer"
+        assert dc_dir.is_dir(), "Expected .devcontainer dir inside --dir target"
+        assert (dc_dir / "devcontainer.env.json").exists(), (
+            "Expected devcontainer.env.json inside .devcontainer"
+        )
+
 def test_scaffold_unknown():
     result = _run(["-m", "cli.devopsos", "scaffold", "unknown"])
     assert "Unknown scaffold target" in result.stdout
@@ -32,6 +80,45 @@ def test_scaffold_help_lists_new_targets():
     assert "argocd" in result.stdout
     assert "sre" in result.stdout
 
+def test_scaffold_gha_via_cli():
+    """Regression: `python -m cli.devopsos scaffold gha` must not raise argparse error."""
+    with tempfile.TemporaryDirectory() as tmp:
+        env = {**os.environ, "DEVOPS_OS_GHA_OUTPUT": os.path.join(tmp, ".github/workflows")}
+        result = subprocess.run(
+            [sys.executable, "-m", "cli.devopsos", "scaffold", "gha"],
+            capture_output=True, text=True,
+            cwd=os.path.dirname(os.path.dirname(__file__)),
+            env=env,
+        )
+        assert result.returncode == 0, result.stderr
+        assert "error: unrecognized arguments" not in result.stderr
+
+def test_scaffold_gitlab_via_cli():
+    """Regression: `python -m cli.devopsos scaffold gitlab` must not raise argparse error."""
+    with tempfile.TemporaryDirectory() as tmp:
+        env = {**os.environ, "DEVOPS_OS_GITLAB_OUTPUT": os.path.join(tmp, ".gitlab-ci.yml")}
+        result = subprocess.run(
+            [sys.executable, "-m", "cli.devopsos", "scaffold", "gitlab"],
+            capture_output=True, text=True,
+            cwd=os.path.dirname(os.path.dirname(__file__)),
+            env=env,
+        )
+        assert result.returncode == 0, result.stderr
+        assert "error: unrecognized arguments" not in result.stderr
+
+def test_scaffold_argocd_via_cli():
+    """Regression: `python -m cli.devopsos scaffold argocd` must not raise argparse error."""
+    with tempfile.TemporaryDirectory() as tmp:
+        env = {**os.environ, "DEVOPS_OS_ARGOCD_OUTPUT_DIR": tmp}
+        result = subprocess.run(
+            [sys.executable, "-m", "cli.devopsos", "scaffold", "argocd"],
+            capture_output=True, text=True,
+            cwd=os.path.dirname(os.path.dirname(__file__)),
+            env=env,
+        )
+        assert result.returncode == 0, result.stderr
+        assert "error: unrecognized arguments" not in result.stderr
+
 # -- GitLab CI generator ---------------------------------------------------
 
 def test_scaffold_gitlab_build():