From 6cf24eafdb1ab67ba59935f855157fb7b9d2b6bf Mon Sep 17 00:00:00 2001
From: Scott K Logan <logans@cottsay.net>
Date: Mon, 11 Mar 2024 18:00:44 -0500
Subject: [PATCH] Handle invocation with no available verbs or env vars (#620)

It might be useful when measuring performance to invoke colcon with an
entire class of extensions blocked. This change "handles" the case where
no verbs are available and minimizes the output when there are no verbs
or environment variables available.
---
 colcon_core/command.py | 17 ++++++++++-------
 test/test_command.py   | 11 +++++++++++
 2 files changed, 21 insertions(+), 7 deletions(-)

diff --git a/colcon_core/command.py b/colcon_core/command.py
index 07dddaf1..fd159be1 100644
--- a/colcon_core/command.py
+++ b/colcon_core/command.py
@@ -232,14 +232,16 @@ def _parse_optional(self, arg_string):
                 return None
             return result
 
+    epilog = get_environment_variables_epilog(environment_variables_group_name)
+    if epilog:
+        epilog += '\n\n'
+    epilog += READTHEDOCS_MESSAGE
+
     # top level parser
     parser = CustomArgumentParser(
         prog=get_prog_name(),
         formatter_class=CustomFormatter,
-        epilog=(
-            get_environment_variables_epilog(
-                environment_variables_group_name
-            ) + '\n\n' + READTHEDOCS_MESSAGE))
+        epilog=epilog)
 
     # enable introspecting and intercepting all command line arguments
     parser = decorate_argument_parser(parser)
@@ -287,6 +289,8 @@ def get_environment_variables_epilog(group_name):
     """
     # list environment variables with descriptions
     entry_points = load_extension_points(group_name)
+    if not entry_points:
+        return ''
     env_vars = {
         env_var.name: env_var.description for env_var in entry_points.values()}
     epilog_lines = []
@@ -376,7 +380,6 @@ def create_subparser(parser, cmd_name, verb_extensions, *, attribute):
     :returns: The special action object
     """
     global colcon_logger
-    assert verb_extensions, 'No verb extensions'
 
     # list of available verbs with their descriptions
     verbs = []
@@ -387,9 +390,9 @@ def create_subparser(parser, cmd_name, verb_extensions, *, attribute):
     # add subparser with description of verb extensions
     subparser = parser.add_subparsers(
         title=f'{cmd_name} verbs',
-        description='\n'.join(verbs),
+        description='\n'.join(verbs) or None,
         dest=attribute,
-        help=f'call `{cmd_name} VERB -h` for specific help',
+        help=f'call `{cmd_name} VERB -h` for specific help' if verbs else None,
     )
     return subparser
 
diff --git a/test/test_command.py b/test/test_command.py
index cdd54770..d2aca2d2 100644
--- a/test/test_command.py
+++ b/test/test_command.py
@@ -82,6 +82,17 @@ def test_main():
             assert rc == signal.SIGINT
 
 
+def test_main_no_verbs_or_env():
+    with ExtensionPointContext():
+        with patch(
+            'colcon_core.command.load_extension_points',
+            return_value={},
+        ):
+            with pytest.raises(SystemExit) as e:
+                main(argv=['--help'])
+            assert e.value.code == 0
+
+
 def test_create_parser():
     with ExtensionPointContext():
         parser = create_parser('colcon_core.environment_variable')