Hide location columns for network objects

osfrickler · osfrickler · commit 90eb0ca4bb25 · 2021-12-16T19:33:04.000Z
Network objects returned from the SDK include a location column which has a reference to the cloud to which the object belongs. We don't want to include them in CLI output where they are useless. The solution implemented in [0] was dropped as a sideeffect in [1]. [0] https://review.opendev.org/c/openstack/python-openstackclient/+/679445 [1] https://review.opendev.org/c/openstack/python-openstackclient/+/815032 Signed-off-by: Dr. Jens Harbott <harbott@osism.tech> Change-Id: I9a408d9721c9c57d752afaab520cd6ee379a5184
diff --git a/openstackclient/network/v2/address_group.py b/openstackclient/network/v2/address_group.py
@@ -31,7 +31,12 @@ def _get_columns(item):
     column_map = {
         'tenant_id': 'project_id',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 def _format_addresses(addresses):
diff --git a/openstackclient/network/v2/address_scope.py b/openstackclient/network/v2/address_scope.py
@@ -31,7 +31,12 @@ def _get_columns(item):
         'is_shared': 'shared',
         'tenant_id': 'project_id',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 def _get_attrs(client_manager, parsed_args):
diff --git a/openstackclient/network/v2/floating_ip.py b/openstackclient/network/v2/floating_ip.py
@@ -30,7 +30,12 @@ def _get_network_columns(item):
     column_map = {
         'tenant_id': 'project_id',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 def _get_columns(item):
diff --git a/openstackclient/network/v2/floating_ip_port_forwarding.py b/openstackclient/network/v2/floating_ip_port_forwarding.py
@@ -29,7 +29,12 @@ def _get_columns(item):
     column_map = {
         'tenant_id': 'project_id',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 class CreateFloatingIPPortForwarding(command.ShowOne,
diff --git a/openstackclient/network/v2/ip_availability.py b/openstackclient/network/v2/ip_availability.py
@@ -29,7 +29,12 @@ def _get_columns(item):
     column_map = {
         'tenant_id': 'project_id',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 # TODO(ankur-gupta-f): Use the SDK resource mapped attribute names once
diff --git a/openstackclient/network/v2/l3_conntrack_helper.py b/openstackclient/network/v2/l3_conntrack_helper.py
@@ -26,7 +26,12 @@
 
 def _get_columns(item):
     column_map = {}
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 def _get_attrs(client, parsed_args):
diff --git a/openstackclient/network/v2/network.py b/openstackclient/network/v2/network.py
@@ -61,7 +61,12 @@ def _get_columns_network(item):
         'tenant_id': 'project_id',
         'tags': 'tags',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 def _get_columns_compute(item):
diff --git a/openstackclient/network/v2/network_agent.py b/openstackclient/network/v2/network_agent.py
@@ -50,7 +50,12 @@ def _get_network_columns(item):
         'is_admin_state_up': 'admin_state_up',
         'is_alive': 'alive',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 class AddNetworkToAgent(command.Command):
diff --git a/openstackclient/network/v2/network_auto_allocated_topology.py b/openstackclient/network/v2/network_auto_allocated_topology.py
@@ -28,7 +28,12 @@ def _get_columns(item):
     column_map = {
         'tenant_id': 'project_id',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 def _format_check_resource_columns():
diff --git a/openstackclient/network/v2/network_flavor.py b/openstackclient/network/v2/network_flavor.py
@@ -32,7 +32,12 @@ def _get_columns(item):
         'tenant_id': 'project_id',
     }
 
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 def _get_attrs(client_manager, parsed_args):
diff --git a/openstackclient/network/v2/network_flavor_profile.py b/openstackclient/network/v2/network_flavor_profile.py
@@ -30,7 +30,12 @@ def _get_columns(item):
         'tenant_id': 'project_id',
     }
 
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 def _get_attrs(client_manager, parsed_args):
diff --git a/openstackclient/network/v2/network_meter.py b/openstackclient/network/v2/network_meter.py
@@ -31,7 +31,12 @@ def _get_columns(item):
         'is_shared': 'shared',
         'tenant_id': 'project_id',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 def _get_attrs(client_manager, parsed_args):
diff --git a/openstackclient/network/v2/network_meter_rule.py b/openstackclient/network/v2/network_meter_rule.py
@@ -30,7 +30,12 @@ def _get_columns(item):
     column_map = {
         'tenant_id': 'project_id',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 def _get_attrs(client_manager, parsed_args):
diff --git a/openstackclient/network/v2/network_qos_policy.py b/openstackclient/network/v2/network_qos_policy.py
@@ -31,7 +31,12 @@ def _get_columns(item):
         'is_shared': 'shared',
         'tenant_id': 'project_id',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 def _get_attrs(client_manager, parsed_args):
diff --git a/openstackclient/network/v2/network_qos_rule.py b/openstackclient/network/v2/network_qos_rule.py
@@ -49,7 +49,12 @@ def _get_columns(item):
     column_map = {
         'tenant_id': 'project_id',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 def _check_type_parameters(attrs, type, is_create):
diff --git a/openstackclient/network/v2/network_qos_rule_type.py b/openstackclient/network/v2/network_qos_rule_type.py
@@ -24,7 +24,7 @@ def _get_columns(item):
         "type": "rule_type_name",
         "drivers": "drivers",
     }
-    invisible_columns = ["id", "name"]
+    invisible_columns = ["id", "location", "name"]
     return utils.get_osc_show_columns_for_sdk_resource(
         item, column_map, invisible_columns)
 
diff --git a/openstackclient/network/v2/network_rbac.py b/openstackclient/network/v2/network_rbac.py
@@ -31,7 +31,12 @@ def _get_columns(item):
         'target_tenant': 'target_project_id',
         'tenant_id': 'project_id',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 def _get_attrs(client_manager, parsed_args):
diff --git a/openstackclient/network/v2/network_segment.py b/openstackclient/network/v2/network_segment.py
@@ -26,7 +26,13 @@
 
 
 def _get_columns(item):
-    return utils.get_osc_show_columns_for_sdk_resource(item, {})
+    column_map = {}
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 class CreateNetworkSegment(command.ShowOne,
diff --git a/openstackclient/network/v2/network_segment_range.py b/openstackclient/network/v2/network_segment_range.py
@@ -32,7 +32,13 @@
 
 
 def _get_columns(item):
-    return utils.get_osc_show_columns_for_sdk_resource(item, {})
+    column_map = {}
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 def _get_ranges(item):
diff --git a/openstackclient/network/v2/port.py b/openstackclient/network/v2/port.py
@@ -65,7 +65,12 @@ def _get_columns(item):
         'is_port_security_enabled': 'port_security_enabled',
         'tenant_id': 'project_id',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 class JSONKeyValueAction(argparse.Action):
diff --git a/openstackclient/network/v2/router.py b/openstackclient/network/v2/router.py
@@ -74,7 +74,7 @@ def _get_columns(item):
     }
     if hasattr(item, 'interfaces_info'):
         column_map['interfaces_info'] = 'interfaces_info'
-    invisible_columns = []
+    invisible_columns = ['location']
     if item.is_ha is None:
         invisible_columns.append('is_ha')
         column_map.pop('is_ha')
diff --git a/openstackclient/network/v2/security_group.py b/openstackclient/network/v2/security_group.py
@@ -89,7 +89,12 @@ def _get_columns(item):
         'security_group_rules': 'rules',
         'tenant_id': 'project_id',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 # TODO(abhiraut): Use the SDK resource mapped attribute names once the
diff --git a/openstackclient/network/v2/security_group_rule.py b/openstackclient/network/v2/security_group_rule.py
@@ -74,7 +74,12 @@ def _get_columns(item):
     column_map = {
         'tenant_id': 'project_id',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 def _convert_to_lowercase(string):
diff --git a/openstackclient/network/v2/subnet.py b/openstackclient/network/v2/subnet.py
@@ -140,11 +140,15 @@ def _get_columns(item):
         'tenant_id': 'project_id',
     }
     # Do not show this column when displaying a subnet
-    invisible_columns = ['use_default_subnet_pool', 'prefix_length']
+    invisible_columns = [
+        'location',
+        'use_default_subnet_pool',
+        'prefix_length'
+    ]
     return utils.get_osc_show_columns_for_sdk_resource(
         item,
         column_map,
-        invisible_columns=invisible_columns
+        invisible_columns
     )
 
 
diff --git a/openstackclient/network/v2/subnet_pool.py b/openstackclient/network/v2/subnet_pool.py
@@ -38,7 +38,12 @@ def _get_columns(item):
         'minimum_prefix_length': 'min_prefixlen',
         'tenant_id': 'project_id',
     }
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    hidden_columns = ['location']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns
+    )
 
 
 _formatters = {
