network: Add --evpn-vni to a Neutron router create command

The attribute has two modes:
 - a specified number greater tha 0 sends evpn_vni: <int> to the server
 - an "auto" which sends number 0 to the server, which results in the
   VNI auto-allocation

The evpn-vni attribute on the Neutron server side is immutable
for now and we do not support updates.

Related-Bug: #2144617
Assisted-By: Claude Opus 4.6

Change-Id: I4b11947c3a7e25fec6b1bd55e5134bfd4ffc0bb1
Signed-off-by: Jakub Libosvar <libosvar@redhat.com>

Author: cubeek

openstackclient/network/v2/router.py

@@ -260,14 +260,31 @@ def _get_attrs(
         flavor = n_client.find_flavor(parsed_args.flavor, ignore_missing=False)
         attrs['flavor_id'] = flavor.id
 
-    for attr in ('enable_default_route_bfd', 'enable_default_route_ecmp'):
+    for attr in (
+        'enable_default_route_bfd',
+        'enable_default_route_ecmp',
+        'evpn_vni',
+    ):
         value = getattr(parsed_args, attr, None)
         if value is not None:
             attrs[attr] = value
 
     return attrs
 
 
+def _parse_evpn_vni(value: str) -> int:
+    try:
+        vni = int(value)
+    except ValueError:
+        raise argparse.ArgumentTypeError(
+            _("'%(value)s' is not a valid VNI (use a positive integer)")
+            % {'value': value}
+        )
+    if vni <= 0:
+        raise argparse.ArgumentTypeError(_("VNI must be a positive integer"))
+    return vni
+
+
 def _parser_add_bfd_ecmp_arguments(parser: argparse.ArgumentParser) -> None:
     """Helper to add BFD and ECMP args for CreateRouter and SetRouter."""
     parser.add_argument(
@@ -609,6 +626,24 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
             metavar='<qos-policy>',
             help=_('Attach QoS policy to router gateway IPs'),
         )
+        evpn_group = parser.add_mutually_exclusive_group()
+        evpn_group.add_argument(
+            '--evpn-vni',
+            metavar='<vni>',
+            default=None,
+            type=_parse_evpn_vni,
+            dest='evpn_vni',
+            help=_("Associate the router with an EVPN identified by a VNI."),
+        )
+        evpn_group.add_argument(
+            '--auto-evpn-vni',
+            action='store_const',
+            dest='evpn_vni',
+            const=0,
+            help=_(
+                "Associate the router with an EVPN using an auto-assigned VNI."
+            ),
+        )
 
         return parser
 

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

@@ -613,6 +613,150 @@ def test_create_with_qos_policy_no_external_gateway(self):
             parsed_args,
         )
 
+    def test_create_with_evpn_vni_auto(self):
+        arglist = [
+            '--auto-evpn-vni',
+            self.new_router.name,
+        ]
+        verifylist = [
+            ('name', self.new_router.name),
+            ('enable', True),
+            ('distributed', False),
+            ('ha', False),
+            ('evpn_vni', 0),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.network_client.create_router.assert_called_once_with(
+            **{
+                'admin_state_up': True,
+                'name': self.new_router.name,
+                'evpn_vni': 0,
+            }
+        )
+        self.assertEqual(self.columns, columns)
+        self.assertCountEqual(self.data, data)
+
+    def test_create_with_evpn_vni_explicit(self):
+        arglist = [
+            '--evpn-vni',
+            '10000',
+            self.new_router.name,
+        ]
+        verifylist = [
+            ('name', self.new_router.name),
+            ('enable', True),
+            ('distributed', False),
+            ('ha', False),
+            ('evpn_vni', 10000),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.network_client.create_router.assert_called_once_with(
+            **{
+                'admin_state_up': True,
+                'name': self.new_router.name,
+                'evpn_vni': 10000,
+            }
+        )
+        self.assertEqual(self.columns, columns)
+        self.assertCountEqual(self.data, data)
+
+    def test_create_without_evpn_vni(self):
+        arglist = [
+            self.new_router.name,
+        ]
+        verifylist = [
+            ('name', self.new_router.name),
+            ('enable', True),
+            ('distributed', False),
+            ('ha', False),
+            ('evpn_vni', None),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        _columns, _data = self.cmd.take_action(parsed_args)
+
+        self.network_client.create_router.assert_called_once_with(
+            **{
+                'admin_state_up': True,
+                'name': self.new_router.name,
+            }
+        )
+        self.assertNotIn(
+            'evpn_vni',
+            self.network_client.create_router.call_args[1],
+        )
+
+    def test_create_with_evpn_vni_invalid_string(self):
+        arglist = [
+            '--evpn-vni',
+            'foo',
+            self.new_router.name,
+        ]
+        verifylist = []
+
+        self.assertRaises(
+            tests_utils.ParserException,
+            self.check_parser,
+            self.cmd,
+            arglist,
+            verifylist,
+        )
+
+    def test_create_with_evpn_vni_zero(self):
+        arglist = [
+            '--evpn-vni',
+            '0',
+            self.new_router.name,
+        ]
+        verifylist = []
+
+        self.assertRaises(
+            tests_utils.ParserException,
+            self.check_parser,
+            self.cmd,
+            arglist,
+            verifylist,
+        )
+
+    def test_create_with_evpn_vni_negative(self):
+        arglist = [
+            '--evpn-vni',
+            '-1',
+            self.new_router.name,
+        ]
+        verifylist = []
+
+        self.assertRaises(
+            tests_utils.ParserException,
+            self.check_parser,
+            self.cmd,
+            arglist,
+            verifylist,
+        )
+
+    def test_create_with_evpn_vni_mutually_exclusive_args(self):
+        arglist = [
+            '--evpn-vni',
+            '10000',
+            '--auto-evpn-vni',
+            self.new_router.name,
+        ]
+        verifylist = []
+
+        self.assertRaises(
+            tests_utils.ParserException,
+            self.check_parser,
+            self.cmd,
+            arglist,
+            verifylist,
+        )
+
 
 class TestDeleteRouter(TestRouter):
     # The routers to delete.