Merge pull request VOLTTRON#2882 from bonicim/feature/vctl-tag

Add --all-tagged option; add and fix vctl tests

Author: craig8

volttron/platform/config.py

@@ -326,7 +326,7 @@ class ArgumentParser(_argparse.ArgumentParser):
 
     def __init__(self, *args, **kwargs):
         allow_in_config = kwargs.pop('allow_in_config', True)
-        super(ArgumentParser, self).__init__(*args, **kwargs)
+        super(ArgumentParser, self).__init__(allow_abbrev=False, *args, **kwargs)
         self.allow_in_config = allow_in_config
         self.register('action', 'add_const', AddConstAction)
         self.register('action', 'store_list', ListAction)

volttron/platform/control.py

@@ -818,6 +818,7 @@ def wrapper(opts, *args, **kwargs):
             return func(opts, *args, **kwargs)
     return wrapper
 
+
 def _list_agents(aip):
     return [
         Agent(name, aip.agent_tag(uuid), uuid, aip.agent_identity(uuid), "")
@@ -845,13 +846,13 @@ def escape(pattern):
 
 
 def filter_agents(agents, patterns, opts):
-    by_name, by_tag, by_uuid = opts.by_name, opts.by_tag, opts.by_uuid
+    by_name, by_tag, by_uuid, by_all_tagged = opts.by_name, opts.by_tag, opts.by_uuid, opts.by_all_tagged
     for pattern in patterns:
         regex, _ = escape(pattern)
         result = set()
 
         # if no option is selected, try matching based on uuid
-        if not (by_uuid or by_name or by_tag):
+        if not (by_uuid or by_name or by_tag or by_all_tagged):
             reobj = re.compile(regex)
             matches = [agent for agent in agents if reobj.match(agent.uuid)]
             if len(matches) == 1:
@@ -873,6 +874,9 @@ def filter_agents(agents, patterns, opts):
             if by_tag:
                 result.update(
                     agent for agent in agents if reobj.match(agent.tag or ""))
+            if by_all_tagged:
+                result.update(
+                    agent for agent in agents if reobj.match(agent.tag))
         yield pattern, result
 
 
@@ -1534,43 +1538,51 @@ def disable_agent(opts):
 
 @needs_connection
 def start_agent(opts):
-    call = opts.connection.call
-    agents = _list_agents(opts.aip)
-    for pattern, match in filter_agents(agents, opts.pattern, opts):
-        if not match:
-            _stderr.write(
-                "{}: error: agent not found: {}\n".format(opts.command,
-                                                          pattern)
-            )
-        for agent in match:
-            pid, status = call("agent_status", agent.uuid)
-            if pid is None or status is not None:
-                _stdout.write(
-                    "Starting {} {}\n".format(agent.uuid, agent.name))
-                call("start_agent", agent.uuid)
+    act_on_agent("start_agent", opts)
 
 
 @needs_connection
 def stop_agent(opts):
+    act_on_agent("stop_agent", opts)
+
+
+def restart_agent(opts):
+    act_on_agent("stop_agent", opts)
+    act_on_agent("start_agent", opts)
+
+
+def act_on_agent(action, opts):
     call = opts.connection.call
     agents = _list_agents(opts.aip)
-    for pattern, match in filter_agents(agents, opts.pattern, opts):
+    pattern_to_use = opts.pattern
+
+    if not opts.by_all_tagged and not opts.pattern:
+        raise ValueError("Missing argument. Command requires at least one argument.")
+
+    # prefilter all agents and update regex pattern for only tagged agents
+    if opts.by_all_tagged and not opts.pattern:
+        agents, pattern_to_use = [a for a in agents if a.tag is not None], '*'
+
+    for pattern, match in filter_agents(agents, pattern_to_use, opts):
         if not match:
-            _stderr.write(
-                "{}: error: agent not found: {}\n".format(opts.command,
-                                                          pattern)
-            )
+            _stderr.write(f"{opts.command}: error: agent not found: {pattern}\n")
         for agent in match:
             pid, status = call("agent_status", agent.uuid)
-            if pid and status is None:
-                _stdout.write(
-                    "Stopping {} {}\n".format(agent.uuid, agent.name))
-                call("stop_agent", agent.uuid)
+            _call_action_on_agent(agent, pid, status, call,  action)
 
 
-def restart_agent(opts):
-    stop_agent(opts)
-    start_agent(opts)
+def _call_action_on_agent(agent, pid, status, call, action):
+    if action == "start_agent":
+        if pid is None or status is not None:
+            _stdout.write(f"Starting {agent.uuid} {agent.name}\n")
+            call(action, agent.uuid)
+            return
+
+    if action == "stop_agent":
+        if pid and status is None:
+            _stdout.write(f"Stopping {agent.uuid} {agent.name}\n")
+            call(action, agent.uuid)
+            return
 
 
 @needs_connection
@@ -3264,13 +3276,17 @@ def main():
         "--tag", dest="by_tag", action="store_true",
         help="filter/search by tag name"
     )
+    filterable.add_argument(
+        "--all-tagged", dest="by_all_tagged", action="store_true",
+        help="filter/search by all tagged agents"
+    )
     filterable.add_argument(
         "--uuid",
         dest="by_uuid",
         action="store_true",
         help="filter/search by UUID (default)",
     )
-    filterable.set_defaults(by_name=False, by_tag=False, by_uuid=False)
+    filterable.set_defaults(by_name=False, by_tag=False, by_all_tagged=False, by_uuid=False)
 
     parser = config.ArgumentParser(
         prog=os.path.basename(sys.argv[0]),
@@ -3423,7 +3439,7 @@ def add_parser(*args, **kwargs) -> argparse.ArgumentParser:
 
     start = add_parser("start", parents=[filterable],
                        help="start installed agent")
-    start.add_argument("pattern", nargs="+", help="UUID or name of agent")
+    start.add_argument("pattern", nargs="*", help="UUID or name of agent", default='')
     if HAVE_RESTRICTED:
         start.add_argument(
             "--verify",
@@ -3440,11 +3456,11 @@ def add_parser(*args, **kwargs) -> argparse.ArgumentParser:
     start.set_defaults(func=start_agent)
 
     stop = add_parser("stop", parents=[filterable], help="stop agent")
-    stop.add_argument("pattern", nargs="+", help="UUID or name of agent")
+    stop.add_argument("pattern", nargs="*", help="UUID or name of agent", default='')
     stop.set_defaults(func=stop_agent)
 
     restart = add_parser("restart", parents=[filterable], help="restart agent")
-    restart.add_argument("pattern", nargs="+", help="UUID or name of agent")
+    restart.add_argument("pattern", nargs="*", help="UUID or name of agent", default='')
     restart.set_defaults(func=restart_agent)
 
     run = add_parser("run", help="start any agent by path")