new: Break out command help page logic; sort actions in output (#638)

Author: lgarber-akamai

linodecli/__init__.py

@@ -27,6 +27,7 @@
 from .help_pages import (
     HELP_TOPICS,
     print_help_action,
+    print_help_command_actions,
     print_help_commands,
     print_help_default,
     print_help_env_vars,
@@ -224,23 +225,7 @@ def main():  # pylint: disable=too-many-branches,too-many-statements
         and parsed.action is None
         and parsed.command in cli.ops
     ):
-        print(f"linode-cli {parsed.command} [ACTION]")
-        print()
-        print("Available actions: ")
-
-        content = [
-            [", ".join([action, *op.action_aliases]), op.summary]
-            for action, op in cli.ops[parsed.command].items()
-        ]
-
-        table = Table(
-            Column(header="action", no_wrap=True),
-            Column(header="summary", style="cyan"),
-        )
-        for row in content:
-            table.add_row(*row)
-
-        rprint(table)
+        print_help_command_actions(cli.ops, parsed.command)
         sys.exit(ExitCodes.SUCCESS)
 
     if parsed.command is not None and parsed.action is not None:

linodecli/help_pages.py

@@ -3,15 +3,16 @@
 help pages.
 """
 
+import sys
 import textwrap
 from collections import defaultdict
-from typing import List, Optional
+from typing import Dict, List, Optional
 
 from rich import box
 from rich import print as rprint
 from rich.console import Console
 from rich.padding import Padding
-from rich.table import Table
+from rich.table import Column, Table
 from rich.text import Text
 
 from linodecli import plugins
@@ -140,6 +141,36 @@ def print_help_default():
     )
 
 
+def print_help_command_actions(
+    ops: Dict[str, Dict[str, OpenAPIOperation]],
+    command: Optional[str],
+    file=sys.stdout,
+):
+    """
+    Prints the help page for a single command, including all actions
+    under the given command.
+
+    :param ops: A dictionary mapping CLI commands -> actions -> operations.
+    :param command: The command to print the help page for.
+    """
+
+    print(f"linode-cli {command} [ACTION]\n\nAvailable actions: ", file=file)
+
+    content = [
+        [", ".join([action, *op.action_aliases]), op.summary]
+        for action, op in sorted(ops[command].items(), key=lambda v: v[0])
+    ]
+
+    table = Table(
+        Column(header="action", no_wrap=True),
+        Column(header="summary", style="cyan"),
+    )
+    for row in content:
+        table.add_row(*row)
+
+    rprint(table, file=file)
+
+
 def print_help_action(
     cli: "CLI", command: Optional[str], action: Optional[str]
 ):

tests/unit/conftest.py

@@ -1,4 +1,5 @@
 import configparser
+from typing import List
 
 import pytest
 from openapi3 import OpenAPI
@@ -321,3 +322,22 @@ def write_config(self):  # pylint: disable=missing-function-docstring
             pass
 
     return Config()
+
+
+def assert_contains_ordered_substrings(target: str, entries: List[str]):
+    """
+    Asserts whether the given string contains the given entries in order,
+    ignoring any irrelevant characters in-between.
+
+    :param target: The string to search.
+    :param entries: The ordered list of entries to search for.
+    """
+
+    start_index = 0
+
+    for entry in entries:
+        find_index = target[start_index:].find(entry)
+        assert find_index >= 0
+
+        # Search for the next entry after the end of this entry
+        start_index = find_index + len(entry)

tests/unit/test_help_pages.py

@@ -1,6 +1,8 @@
+from io import StringIO
 from types import SimpleNamespace
 
 from linodecli import help_pages
+from tests.unit.conftest import assert_contains_ordered_substrings
 
 
 class TestHelpPages:
@@ -175,3 +177,40 @@ def test_action_help_post_method(self, capsys, mocker, mock_cli):
         assert "(required, nullable, conflicts with children)" in captured.out
         assert "(JSON, nullable, conflicts with children)" in captured.out
         assert "filter results" not in captured.out
+
+    def test_help_command_actions(self, mocker):
+        test_operations = {
+            "foo": {
+                "b-create": mocker.MagicMock(
+                    summary="Test summary.", action_aliases=[]
+                ),
+                "b-list": mocker.MagicMock(
+                    summary="Test summary 2.", action_aliases=["b-ls"]
+                ),
+                "a-list": mocker.MagicMock(
+                    summary="Test summary 3.", action_aliases=["a-ls"]
+                ),
+            }
+        }
+
+        stdout_buffer = StringIO()
+        help_pages.print_help_command_actions(
+            test_operations, "foo", file=stdout_buffer
+        )
+
+        # Ensure the given snippets are printed in order, ignoring irrelevant characters
+        assert_contains_ordered_substrings(
+            stdout_buffer.getvalue(),
+            [
+                "linode-cli foo [ACTION]",
+                "Available actions:",
+                "action",
+                "summary",
+                "a-list, a-ls",
+                "Test summary 3.",
+                "b-create",
+                "Test summary.",
+                "b-list, b-ls",
+                "Test summary 2.",
+            ],
+        )