New passthrought in shell and ordered help for subcommands

Author: mvaltas

Justfile

@@ -1,4 +1,4 @@
-@test *options: lint
+@test *options: format
   uv run pytest {{options}}
 
 @lint:

devcli/framework/base.py

@@ -12,6 +12,7 @@
 import inspect
 
 import devcli.framework.console as console
+from devcli.core.cli import OrderedGroup
 
 _logger = logging.getLogger()
 
@@ -23,7 +24,7 @@ def new(description: str = None) -> typer.Typer:
     :returns: a typer.Typer
     """
     _logger.info(f"creating new command description:{description}")
-    return typer.Typer(help=description, no_args_is_help=True)
+    return typer.Typer(help=description, no_args_is_help=True, cls=OrderedGroup)
 
 
 def stop(msg: str = "Error", exit_code: int = 1):

devcli/utils/shell.py

@@ -141,6 +141,24 @@ def capture(command: str, cwd: str = os.curdir) -> str:
     return result.stdout
 
 
+def passthrough(command: str, cwd: str = os.curdir) -> int:
+    """
+    Execute command with minimal interference, won't capture
+    the output nor it can run things in parallel
+    """
+    logger.debug(f"running shell passthrough: {command}")
+    final_command = _prepare_command(command)
+    logger.debug(f"about to execute: {final_command}, on: {cwd}")
+    result = subprocess.run(
+        final_command,
+        shell=True,
+        cwd=cwd,
+        env=os.environ,
+    )
+    logger.debug(f"return code: {result.returncode}")
+    return result.returncode
+
+
 def promote_value_to_key(nested_dict: dict, new_key: str, new_value: str) -> dict:
     """This function works on a dict which has values that are also dicts.
     It will swap a value of the nested dict and add the key as a value.

tests/test_cli.py

@@ -44,7 +44,22 @@ def test_should_load_dynamic_commands():
     # of the project, tests of the subcommand 'example' itself
     # are in test_example.py
     result = devcli("example")
-    assert "ping" in result.output
+    assert "config" in result.output
+
+
+def test_help_lists_subcommands_in_alphabetical_order():
+    result = devcli("example")
+    subcommands = ["│ config", "│ hello", "│ ping", "│ text"]
+    index = 0  # order of the commands
+    # per line, mark each found subcommand
+    # if we can mark all they were in order
+    for line in result.output.split("\n"):
+        print(f"index: {index} line:{line}")
+        if index < len(subcommands) and subcommands[index] in line:
+            index += 1
+
+    # Found all subcommands in order we got to 4 index
+    assert index == 4
 
 
 def test_show_config():

tests/utils/test_shell.py

@@ -43,6 +43,11 @@ def test_in_multi_run_is_possible_to_collect_exitcode():
     assert results[1]["exitcode"] == 222
 
 
+def test_passthrough_just_execute_without_capture():
+    result = shell.passthrough("exit 255")
+    assert result == 255
+
+
 def test_result_transform_dict():
     orig = {
         123: {"alias": "cmd1", "code": "111"},