Merge "Follow-Up for networking-bgpvpn osc client migration"

Author: Zuul

doc/source/contributor/osc-plugin-migration.rst

@@ -16,7 +16,7 @@ Background
 Historically, advanced Neutron services provided their CLI commands through
 ``python-neutronclient`` as OSC plugins. As the old python-xclient libraries
 were deprecated and their functionality were moved to python-openstackclient
-these plugins were also decided to move to python-openstackclient, see the
+it was also decided to move these plugins to python-openstackclient, see the
 2025 October PTG etherpad:
 https://etherpad.opendev.org/p/oct2025-ptg-neutron#L156
 
@@ -31,7 +31,7 @@ Migration Steps
 ---------------------------------------
 
 Create a new python module under ``openstackclient/network/v2/`` for your
-service with apropriate name, for example for tap-as-a-service ``taas``.
+service with appropriate name, for example for tap-as-a-service ``taas``.
 
 2. Migrate the Command Classes
 -------------------------------

openstackclient/network/v2/bgpvpn/bgpvpn.py

@@ -305,7 +305,7 @@ def take_action(self, parsed_args):
                 parsed_args.project,
                 parsed_args.project_domain,
             ).id
-            attrs['tenant_id'] = project_id
+            attrs['project_id'] = project_id
         obj = client.create_bgpvpn(**attrs)
         display_columns, columns = _get_columns(obj)
         data = osc_utils.get_dict_properties(
@@ -422,7 +422,7 @@ def take_action(self, parsed_args):
                 parsed_args.project,
                 parsed_args.project_domain,
             ).id
-            params['tenant_id'] = project_id
+            params['project_id'] = project_id
         if parsed_args.property:
             params.update(parsed_args.property)
         objs = client.bgpvpns(**params)

openstackclient/network/v2/bgpvpn/network_association.py

@@ -31,15 +31,15 @@
 
 _attr_map = (
     ('id', 'ID', column_util.LIST_BOTH),
-    ('tenant_id', 'Project', column_util.LIST_LONG_ONLY),
+    ('project_id', 'Project', column_util.LIST_LONG_ONLY),
     ('network_id', 'Network ID', column_util.LIST_BOTH),
 )
 _formatters: dict[str, ty.Any] = {}
 
 
 def _get_columns(item):
     column_map: dict[str, str] = {}
-    hidden_columns = ['location', 'name', 'project_id']
+    hidden_columns = ['location', 'name', 'tenant_id']
     return osc_utils.get_osc_show_columns_for_sdk_resource(
         item, column_map, hidden_columns
     )
@@ -76,7 +76,7 @@ def take_action(self, parsed_args):
                 parsed_args.project,
                 parsed_args.project_domain,
             ).id
-            body['tenant_id'] = project_id
+            body['project_id'] = project_id
 
         obj = client.create_bgpvpn_network_association(bgpvpn['id'], **body)
         display_columns, columns = _get_columns(obj)

openstackclient/network/v2/bgpvpn/port_association.py

@@ -31,7 +31,7 @@
 
 _attr_map = (
     ('id', 'ID', column_util.LIST_BOTH),
-    ('tenant_id', 'Project', column_util.LIST_LONG_ONLY),
+    ('project_id', 'Project', column_util.LIST_LONG_ONLY),
     ('port_id', 'Port ID', column_util.LIST_BOTH),
     (
         'prefix_routes',
@@ -57,7 +57,7 @@
 
 def _get_columns(item):
     column_map: dict[str, str] = {}
-    hidden_columns = ['location', 'name', 'project_id']
+    hidden_columns = ['location', 'name', 'tenant_id']
     return osc_utils.get_osc_show_columns_for_sdk_resource(
         item, column_map, hidden_columns
     )
@@ -314,7 +314,7 @@ def take_action(self, parsed_args):
                 parsed_args.project,
                 parsed_args.project_domain,
             ).id
-            body['tenant_id'] = project_id
+            body['project_id'] = project_id
 
         body.update(_args2body(client, 'create', bgpvpn['id'], parsed_args))
 

openstackclient/network/v2/bgpvpn/router_association.py

@@ -30,7 +30,7 @@
 
 _attr_map = (
     ('id', 'ID', column_util.LIST_BOTH),
-    ('tenant_id', 'Project', column_util.LIST_LONG_ONLY),
+    ('project_id', 'Project', column_util.LIST_LONG_ONLY),
     ('router_id', 'Router ID', column_util.LIST_BOTH),
     (
         'advertise_extra_routes',
@@ -43,7 +43,7 @@
 
 def _get_columns(item):
     column_map: dict[str, str] = {}
-    hidden_columns = ['location', 'name', 'project_id']
+    hidden_columns = ['location', 'name', 'tenant_id']
     return osc_utils.get_osc_show_columns_for_sdk_resource(
         item, column_map, hidden_columns
     )
@@ -115,7 +115,7 @@ def take_action(self, parsed_args):
                 parsed_args.project,
                 parsed_args.project_domain,
             ).id
-            body['tenant_id'] = project_id
+            body['project_id'] = project_id
 
         body.update(_args2body('create', parsed_args))
 

openstackclient/tests/unit/network/v2/bgpvpn/fakes.py

@@ -40,7 +40,7 @@ def create_one_bgpvpn(attrs=None):
     # Set default attributes.
     bgpvpn_attrs = {
         'id': 'fake_bgpvpn_id',
-        'tenant_id': _FAKE_PROJECT_ID,
+        'project_id': _FAKE_PROJECT_ID,
         'name': '',
         'type': 'l3',
         'route_targets': [],
@@ -105,7 +105,7 @@ def create_one_network_association(attrs=None):
     assoc_attrs = {
         'id': 'fake_association_id',
         'network_id': 'fake_resource_id',
-        'tenant_id': _FAKE_PROJECT_ID,
+        'project_id': _FAKE_PROJECT_ID,
     }
     assoc_attrs.update(attrs)
     return _net_assoc.BgpVpnNetworkAssociation(**assoc_attrs)
@@ -119,7 +119,7 @@ def create_network_associations(count=1):
             {
                 'id': f'fake_association_id{idx}',
                 'network_id': f'fake_resource_id{idx}',
-                'tenant_id': _FAKE_PROJECT_ID,
+                'project_id': _FAKE_PROJECT_ID,
             }
         )
     return assocs
@@ -131,7 +131,7 @@ def create_one_router_association(attrs=None):
     assoc_attrs = {
         'id': 'fake_association_id',
         'router_id': 'fake_resource_id',
-        'tenant_id': _FAKE_PROJECT_ID,
+        'project_id': _FAKE_PROJECT_ID,
     }
     assoc_attrs.update(attrs)
     return _router_assoc.BgpVpnRouterAssociation(**assoc_attrs)
@@ -145,7 +145,7 @@ def create_router_associations(count=1):
             {
                 'id': f'fake_association_id{idx}',
                 'router_id': f'fake_resource_id{idx}',
-                'tenant_id': _FAKE_PROJECT_ID,
+                'project_id': _FAKE_PROJECT_ID,
             }
         )
     return assocs
@@ -157,7 +157,7 @@ def create_one_port_association(attrs=None):
     assoc_attrs = {
         'id': 'fake_association_id',
         'port_id': 'fake_resource_id',
-        'tenant_id': _FAKE_PROJECT_ID,
+        'project_id': _FAKE_PROJECT_ID,
         'routes': [],
     }
     assoc_attrs.update(attrs)
@@ -172,7 +172,7 @@ def create_port_associations(count=1):
             {
                 'id': f'fake_association_id{idx}',
                 'port_id': f'fake_resource_id{idx}',
-                'tenant_id': _FAKE_PROJECT_ID,
+                'project_id': _FAKE_PROJECT_ID,
                 'routes': [],
             }
         )

openstackclient/tests/unit/network/v2/bgpvpn/test_bgpvpn.py

@@ -91,7 +91,7 @@ def test_create_bgpvpn_with_no_args(self):
     @mock.patch('osc_lib.cli.identity.find_project')
     def test_create_bgpvpn_with_all_args(self, mock_find_project):
         attrs = {
-            'tenant_id': 'new_fake_project_id',
+            'project_id': 'new_fake_project_id',
             'name': 'fake_name',
             'type': 'l2',
             'vni': 100,
@@ -103,10 +103,12 @@ def test_create_bgpvpn_with_all_args(self, mock_find_project):
         }
         fake_bgpvpn = fakes.create_one_bgpvpn(attrs)
         self.network_client.create_bgpvpn.return_value = fake_bgpvpn
-        mock_find_project.return_value = mock.Mock(id=fake_bgpvpn['tenant_id'])
+        mock_find_project.return_value = mock.Mock(
+            id=fake_bgpvpn['project_id']
+        )
         arglist = [
             '--project',
-            fake_bgpvpn['tenant_id'],
+            fake_bgpvpn['project_id'],
             '--name',
             fake_bgpvpn['name'],
             '--type',
@@ -125,7 +127,7 @@ def test_create_bgpvpn_with_all_args(self, mock_find_project):
         for rd in fake_bgpvpn['route_distinguishers']:
             arglist.extend(['--route-distinguisher', rd])
         verifylist = [
-            ('project', fake_bgpvpn['tenant_id']),
+            ('project', fake_bgpvpn['project_id']),
             ('name', fake_bgpvpn['name']),
             ('type', fake_bgpvpn['type']),
             ('vni', fake_bgpvpn['vni']),
@@ -495,7 +497,7 @@ def test_list_all_bgpvpn_long_mode(self):
     def test_list_project_bgpvpn(self, mock_find_project):
         count = 3
         project_id = 'list_fake_project_id'
-        attrs = {'tenant_id': project_id}
+        attrs = {'project_id': project_id}
         fake_bgpvpns = fakes.create_bgpvpns(count=count, attrs=attrs)
         self.network_client.bgpvpns.return_value = fake_bgpvpns
         mock_find_project.return_value = mock.Mock(id=project_id)
@@ -512,7 +514,7 @@ def test_list_project_bgpvpn(self, mock_find_project):
         headers, data = self.cmd.take_action(parsed_args)
 
         self.network_client.bgpvpns.assert_called_once_with(
-            tenant_id=project_id
+            project_id=project_id
         )
         self.assertEqual(headers, list(headers_short))
         self.assertListEqual(

openstackclient/tests/unit/network/v2/bgpvpn/test_network_association.py

@@ -78,17 +78,19 @@ def test_create_network_association(self, mock_find_project):
         self.network_client.create_bgpvpn_network_association.return_value = (
             fake_assoc
         )
-        mock_find_project.return_value = mock.Mock(id=fake_bgpvpn['tenant_id'])
+        mock_find_project.return_value = mock.Mock(
+            id=fake_bgpvpn['project_id']
+        )
         arglist = [
             fake_bgpvpn['id'],
             fake_res['id'],
             '--project',
-            fake_bgpvpn['tenant_id'],
+            fake_bgpvpn['project_id'],
         ]
         verifylist = [
             ('bgpvpn', fake_bgpvpn['id']),
             ('resource', fake_res['id']),
-            ('project', fake_bgpvpn['tenant_id']),
+            ('project', fake_bgpvpn['project_id']),
         ]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -98,7 +100,7 @@ def test_create_network_association(self, mock_find_project):
         self.network_client.create_bgpvpn_network_association.assert_called_once_with(
             fake_bgpvpn['id'],
             network_id=fake_res['id'],
-            tenant_id='fake_project_id',
+            project_id='fake_project_id',
         )
         self.assertEqual(sorted_columns, cols)
         self.assertEqual(_get_data(fake_assoc), data)

openstackclient/tests/unit/network/v2/bgpvpn/test_port_association.py

@@ -83,18 +83,18 @@ def test_create_port_association(self, mock_find_project):
             fake_assoc
         )
         mock_find_project.return_value = mock.Mock(
-            id=self.fake_bgpvpn['tenant_id']
+            id=self.fake_bgpvpn['project_id']
         )
         arglist = [
             self.fake_bgpvpn['id'],
             self.fake_port['id'],
             '--project',
-            self.fake_bgpvpn['tenant_id'],
+            self.fake_bgpvpn['project_id'],
         ]
         verifylist = [
             ('bgpvpn', self.fake_bgpvpn['id']),
             ('port', self.fake_port['id']),
-            ('project', self.fake_bgpvpn['tenant_id']),
+            ('project', self.fake_bgpvpn['project_id']),
         ]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -104,7 +104,7 @@ def test_create_port_association(self, mock_find_project):
         self.network_client.create_bgpvpn_port_association.assert_called_once_with(
             self.fake_bgpvpn['id'],
             port_id=self.fake_port['id'],
-            tenant_id='fake_project_id',
+            project_id='fake_project_id',
             routes=[],
         )
         self.assertIn('id', cols)

openstackclient/tests/unit/network/v2/bgpvpn/test_router_association.py

@@ -80,7 +80,7 @@ def _build_args(self, param=None):
             self.fake_bgpvpn['id'],
             self.fake_router['id'],
             '--project',
-            self.fake_bgpvpn['tenant_id'],
+            self.fake_bgpvpn['project_id'],
         ]
         if param is not None:
             if isinstance(param, list):
@@ -93,7 +93,7 @@ def _build_verify_list(self, param=None):
         verifylist = [
             ('bgpvpn', self.fake_bgpvpn['id']),
             ('resource', self.fake_router['id']),
-            ('project', self.fake_bgpvpn['tenant_id']),
+            ('project', self.fake_bgpvpn['project_id']),
         ]
         if param is not None:
             verifylist.append(param)
@@ -111,7 +111,7 @@ def _exec_create_router_association(
 
         fake_assoc_call = {
             'router_id': self.fake_router['id'],
-            'tenant_id': 'fake_project_id',
+            'project_id': 'fake_project_id',
         }
         if verifylist:
             for key, value in verifylist: