Better --node error message (#427)

* Track main

* Better error message when wrong syntax for --node <name>=<file>

---------

Co-authored-by: Johannes Ernst <[email protected]>

src/feditest/cli/commands/convert_transcript.py

@@ -43,7 +43,7 @@ def run(parser: ArgumentParser, args: Namespace, remaining: list[str]) -> int:
     return 0
 
 
-def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> None:
+def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> ArgumentParser:
     """
     Add command-line options for this sub-command
     parent_parser: the parent argparse parser

src/feditest/cli/commands/create_constellation.py

@@ -33,7 +33,7 @@ def run(parser: ArgumentParser, args: Namespace, remaining: list[str]) -> int:
     return 0
 
 
-def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> None:
+def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> ArgumentParser:
     """
     Add command-line options for this sub-command
     parent_parser: the parent argparse parser
@@ -42,7 +42,7 @@ def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> None:
     parser = parent_parser.add_parser(cmd_name, help='Combine node definitions into a constellation')
     parser.add_argument('--name', default=None, required=False, help='Name of the generated constellation')
     parser.add_argument('--node', action='append', required=True,
-                        help="Use role=file to specify that the node definition in 'file' is supposed to be used for constellation role 'role'")
+                        help="Use <role>=<file> to specify that the node definition in 'file' is supposed to be used for constellation role 'role'")
     parser.add_argument('--out', '-o', default=None, required=False, help='Name of the file for the generated constellation')
 
     return parser

src/feditest/cli/commands/create_session_template.py

@@ -30,7 +30,7 @@ def run(parser: ArgumentParser, args: Namespace, remaining: list[str]) -> int:
     return 0
 
 
-def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> None:
+def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> ArgumentParser:
     """
     Add command-line options for this sub-command
     parent_parser: the parent argparse parser

src/feditest/cli/commands/create_testplan.py

@@ -30,7 +30,7 @@ def run(parser: ArgumentParser, args: Namespace, remaining: list[str]) -> int:
     return 0
 
 
-def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> None:
+def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> ArgumentParser:
     """
     Add command-line options for this sub-command
     parent_parser: the parent argparse parser
@@ -45,7 +45,7 @@ def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> None:
     parser.add_argument('--constellation', action='append', help='File(s) each containing a JSON fragment defining a constellation')
     parser.add_argument('--session', '--session-template', required=False, help='File containing a JSON fragment defining a test session')
     parser.add_argument('--node', action='append',
-                        help="Use role=file to specify that the node definition in 'file' is supposed to be used for constellation role 'role'")
+                        help="Use <role>=<file> to specify that the node definition in 'file' is supposed to be used for constellation role 'role'")
     parser.add_argument('--filter-regex', default=None, help='Only include tests whose name matches this regular expression')
     parser.add_argument('--test', action='append', help='Run this/these named tests(s)')
 

src/feditest/cli/commands/info.py

@@ -92,7 +92,7 @@ def run_info_node_driver(name: str) -> int:
     return 1
 
 
-def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> None:
+def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> ArgumentParser:
     """
     Add command-line options for this sub-command
     parent_parser: the parent argparse parser

src/feditest/cli/commands/list-templates.py

@@ -28,7 +28,7 @@ def run(parser: ArgumentParser, args: Namespace, remaining: list[str]) -> int:
     return 0
 
 
-def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> None:
+def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> ArgumentParser:
     help = "List the available templates"
     parser = parent_parser.add_parser(cmd_name, help=help, description=help)
 

src/feditest/cli/commands/list_nodedrivers.py

@@ -25,7 +25,7 @@ def run(parser: ArgumentParser, args: Namespace, remaining: list[str]) -> int:
     return 0
 
 
-def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> None:
+def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> ArgumentParser:
     """
     Add command-line options for this sub-command
     parent_parser: the parent argparse parser

src/feditest/cli/commands/list_tests.py

@@ -26,7 +26,7 @@ def run(parser: ArgumentParser, args: Namespace, remaining: list[str]) -> int:
 
     return 0
 
-def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> None:
+def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> ArgumentParser:
     """
     Add command-line options for this sub-command
     parent_parser: the parent argparse parser

src/feditest/cli/commands/run.py

@@ -89,7 +89,7 @@ def run(parser: ArgumentParser, args: Namespace, remaining: list[str]) -> int:
     return 0
 
 
-def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> None:
+def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> ArgumentParser:
     """
     Add command-line options for this sub-command
     parent_parser: the parent argparse parser
@@ -109,7 +109,7 @@ def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> None:
     parser.add_argument('--constellation', action='append', help='File(s) each containing a JSON fragment defining a constellation')
     parser.add_argument('--session', '--session-template', required=False, help='File(s) each containing a JSON fragment defining a test session')
     parser.add_argument('--node', action='append',
-                        help="Use role=file to specify that the node definition in 'file' is supposed to be used for constellation role 'role'")
+                        help="Use <role>=<file> to specify that the node definition in 'file' is supposed to be used for constellation role 'role'")
     parser.add_argument('--filter-regex', default=None, help='Only include tests whose name matches this regular expression')
     parser.add_argument('--test', action='append', help='Run this/these named tests(s)')
 

src/feditest/cli/commands/version.py

@@ -18,7 +18,7 @@ def run(parser: ArgumentParser, args: Namespace, remaining: list[str]) -> int:
     return 0
 
 
-def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> None:
+def add_sub_parser(parent_parser: _SubParsersAction, cmd_name: str) -> ArgumentParser:
     """
     Add command-line options for this sub-command
     parent_parser: the parent argparse parser

src/feditest/cli/utils.py

@@ -118,6 +118,8 @@ def create_constellation_from_nodes(args: Namespace) -> TestPlanConstellation:
     roles : dict[str, TestPlanConstellationNode | None] = {}
     if args.node:
         for nodepair in args.node:
+            if '=' not in nodepair:
+                raise ArgumentError(None, 'Syntax error in argument: need --node <role>=<file>')
             rolename, nodefile = nodepair.split('=', 1)
             if not rolename:
                 raise ArgumentError(None, f'Rolename component of --node must not be empty: "{ nodepair }".')