Add "network agent router set" command

Add a new ``network agent router set`` command that allows updating
properties of a router associated to an L3 agent. This leverages
the ``update_router_in_agent`` SDK method (PUT on the agent's
l3-routers endpoint) added in [1], included in openstacksdk 4.12.0.

Currently supports setting ``--ha-chassis-priority``.

[1]https://review.opendev.org/c/openstack/openstacksdk/+/983852

Partial-Bug: #2103521
Signed-off-by: Rodolfo Alonso Hernandez <ralonsoh@redhat.com>
Change-Id: I68bca1bdf0f10cd4341276519a1ca609150646a1

Author: ralonsoh

openstackclient/network/v2/network_agent.py

@@ -389,6 +389,45 @@ def take_action(self, parsed_args: argparse.Namespace) -> None:
             client.remove_router_from_agent(agent, router)
 
 
+class SetNetworkAgentRouter(command.Command):
+    _description = _("Set properties of a router associated to an agent")
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            '--ha-chassis-priority',
+            metavar='<ha-chassis-priority>',
+            type=int,
+            required=True,
+            help=_(
+                "HA Chassis priority, ranging from [0, 32767]. "
+                "Only used with --l3 and for ML2/OVN L3 agents"
+            ),
+        )
+        parser.add_argument(
+            'agent_id',
+            metavar='<agent-id>',
+            help=_("L3 agent to modify (ID only)"),
+        )
+        parser.add_argument(
+            'router',
+            metavar='<router>',
+            help=_("Router to update (name or ID)"),
+        )
+
+        return parser
+
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        client = self.app.client_manager.network
+        agent = client.get_agent(parsed_args.agent_id)
+        router = client.find_router(parsed_args.router, ignore_missing=False)
+        client.update_router_in_agent(
+            agent,
+            router,
+            ha_chassis_priority=parsed_args.ha_chassis_priority,
+        )
+
+
 class SetNetworkAgent(command.Command):
     _description = _("Set network agent properties")
 

openstackclient/tests/unit/network/v2/test_network_agent.py

@@ -499,6 +499,66 @@ def test_remove_router_required_options(self):
         self.assertIsNone(result)
 
 
+class TestSetNetworkAgentRouter(TestNetworkAgent):
+    def setUp(self):
+        super().setUp()
+        self._router = network_fakes.create_one_router()
+        self._agent = network_fakes.create_one_network_agent()
+        self.network_client.get_agent.return_value = self._agent
+        self.network_client.find_router.return_value = self._router
+        self.cmd = network_agent.SetNetworkAgentRouter(self.app, None)
+
+    def test_set_no_options(self):
+        arglist = []
+        verifylist = []
+
+        self.assertRaises(
+            tests_utils.ParserException,
+            self.check_parser,
+            self.cmd,
+            arglist,
+            verifylist,
+        )
+
+    def test_set_router_missing_ha_chassis_priority(self):
+        arglist = [
+            self._agent.id,
+            self._router.id,
+        ]
+        verifylist = []
+
+        self.assertRaises(
+            tests_utils.ParserException,
+            self.check_parser,
+            self.cmd,
+            arglist,
+            verifylist,
+        )
+
+    def test_set_router_with_ha_chassis_priority(self):
+        arglist = [
+            '--ha-chassis-priority',
+            '200',
+            self._agent.id,
+            self._router.id,
+        ]
+        verifylist = [
+            ('agent_id', self._agent.id),
+            ('router', self._router.id),
+            ('ha_chassis_priority', 200),
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        result = self.cmd.take_action(parsed_args)
+
+        self.network_client.update_router_in_agent.assert_called_with(
+            self._agent,
+            self._router,
+            ha_chassis_priority=200,
+        )
+        self.assertIsNone(result)
+
+
 class TestSetNetworkAgent(TestNetworkAgent):
     _network_agent = network_fakes.create_one_network_agent()
 

pyproject.toml

@@ -418,6 +418,7 @@ network_agent_list = "openstackclient.network.v2.network_agent:ListNetworkAgent"
 network_agent_remove_network = "openstackclient.network.v2.network_agent:RemoveNetworkFromAgent"
 network_agent_remove_router = "openstackclient.network.v2.network_agent:RemoveRouterFromAgent"
 network_agent_set = "openstackclient.network.v2.network_agent:SetNetworkAgent"
+network_agent_router_set = "openstackclient.network.v2.network_agent:SetNetworkAgentRouter"
 network_agent_show = "openstackclient.network.v2.network_agent:ShowNetworkAgent"
 network_auto_allocated_topology_create = "openstackclient.network.v2.network_auto_allocated_topology:CreateAutoAllocatedTopology"
 network_auto_allocated_topology_delete = "openstackclient.network.v2.network_auto_allocated_topology:DeleteAutoAllocatedTopology"

releasenotes/notes/add-set-router-to-agent-d4e343cd5bf34573.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Add a new ``network agent router set`` command that allows updating
+    properties of a router associated to an ML2/OVN L3 agent. Currently
+    supports setting ``--ha-chassis-priority``.