Refactor security group list to use SDK

Refactored the 'os security group list' command to use the SDK
when neutron is enabled, but continue to use the nova client
when nova network is enabled.

This refactor also removes the logic for displaying project names
instead of project IDs when the --all-projects option is specified.
This logic was removed because it is inconsistent with the other
network commands.

Since neutron will always display security groups across all
projects for an admin, the --all-projects option is now hidden
when neutron is enabled and the Project column is always
displayed.

Change-Id: I934a1f5084ef3c5f929d0ffd38ebf5064d799941
Partial-Bug: #1519511
Related-to: blueprint neutron-client

Author: rtheis

doc/source/command-objects/security-group.rst

@@ -54,6 +54,9 @@ List security groups
 
     Display information from all projects (admin only)
 
+    *Network version 2 ignores this option and will always display information*
+    *for all projects.*
+
 security group set
 ------------------
 

openstackclient/compute/v2/security_group.py

@@ -18,8 +18,6 @@
 
 import six
 
-from keystoneauth1 import exceptions as ks_exc
-
 try:
     from novaclient.v2 import security_group_rules
 except ImportError:
@@ -169,58 +167,6 @@ def take_action(self, parsed_args):
         return zip(*sorted(six.iteritems(info)))
 
 
-class ListSecurityGroup(command.Lister):
-    """List security groups"""
-
-    def get_parser(self, prog_name):
-        parser = super(ListSecurityGroup, self).get_parser(prog_name)
-        parser.add_argument(
-            '--all-projects',
-            action='store_true',
-            default=False,
-            help='Display information from all projects (admin only)',
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-
-        def _get_project(project_id):
-            try:
-                return getattr(project_hash[project_id], 'name', project_id)
-            except KeyError:
-                return project_id
-
-        compute_client = self.app.client_manager.compute
-        columns = (
-            "ID",
-            "Name",
-            "Description",
-        )
-        column_headers = columns
-        if parsed_args.all_projects:
-            # TODO(dtroyer): Translate Project_ID to Project (name)
-            columns = columns + ('Tenant ID',)
-            column_headers = column_headers + ('Project',)
-        search = {'all_tenants': parsed_args.all_projects}
-        data = compute_client.security_groups.list(search_opts=search)
-
-        project_hash = {}
-        try:
-            projects = self.app.client_manager.identity.projects.list()
-        except ks_exc.ClientException:
-            # This fails when the user is not an admin, just move along
-            pass
-        else:
-            for project in projects:
-                project_hash[project.id] = project
-
-        return (column_headers,
-                (utils.get_item_properties(
-                    s, columns,
-                    formatters={'Tenant ID': _get_project},
-                ) for s in data))
-
-
 class ListSecurityGroupRule(command.Lister):
     """List security group rules"""
 

openstackclient/network/v2/security_group.py

@@ -13,6 +13,8 @@
 
 """Security Group action implementations"""
 
+import argparse
+
 from openstackclient.common import utils
 from openstackclient.network import common
 
@@ -38,3 +40,51 @@ def take_action_compute(self, client, parsed_args):
             parsed_args.group,
         )
         client.security_groups.delete(data.id)
+
+
+class ListSecurityGroup(common.NetworkAndComputeLister):
+    """List security groups"""
+
+    def update_parser_network(self, parser):
+        # Maintain and hide the argument for backwards compatibility.
+        # Network will always return all projects for an admin.
+        parser.add_argument(
+            '--all-projects',
+            action='store_true',
+            default=False,
+            help=argparse.SUPPRESS,
+        )
+        return parser
+
+    def update_parser_compute(self, parser):
+        parser.add_argument(
+            '--all-projects',
+            action='store_true',
+            default=False,
+            help='Display information from all projects (admin only)',
+        )
+        return parser
+
+    def _get_return_data(self, data, include_project=True):
+        columns = (
+            "ID",
+            "Name",
+            "Description",
+        )
+        column_headers = columns
+        if include_project:
+            columns = columns + ('Tenant ID',)
+            column_headers = column_headers + ('Project',)
+        return (column_headers,
+                (utils.get_item_properties(
+                    s, columns,
+                ) for s in data))
+
+    def take_action_network(self, client, parsed_args):
+        return self._get_return_data(client.security_groups())
+
+    def take_action_compute(self, client, parsed_args):
+        search = {'all_tenants': parsed_args.all_projects}
+        data = client.security_groups.list(search_opts=search)
+        return self._get_return_data(data,
+                                     include_project=parsed_args.all_projects)

openstackclient/tests/compute/v2/fakes.py

@@ -298,6 +298,70 @@ def create_hypervisors_stats(attrs={}, count=2):
         return hypervisors
 
 
+class FakeSecurityGroup(object):
+    """Fake one or more security groups."""
+
+    @staticmethod
+    def create_one_security_group(attrs=None, methods=None):
+        """Create a fake security group.
+
+        :param Dictionary attrs:
+            A dictionary with all attributes
+        :param Dictionary methods:
+            A dictionary with all methods
+        :return:
+            A FakeResource object, with id, name, etc.
+        """
+        if attrs is None:
+            attrs = {}
+        if methods is None:
+            methods = {}
+
+        # Set default attributes.
+        security_group_attrs = {
+            'id': 'security-group-id-' + uuid.uuid4().hex,
+            'name': 'security-group-name-' + uuid.uuid4().hex,
+            'description': 'security-group-description-' + uuid.uuid4().hex,
+            'tenant_id': 'project-id-' + uuid.uuid4().hex,
+            'rules': [],
+        }
+
+        # Overwrite default attributes.
+        security_group_attrs.update(attrs)
+
+        # Set default methods.
+        security_group_methods = {}
+
+        # Overwrite default methods.
+        security_group_methods.update(methods)
+
+        security_group = fakes.FakeResource(
+            info=copy.deepcopy(security_group_attrs),
+            methods=copy.deepcopy(security_group_methods),
+            loaded=True)
+        return security_group
+
+    @staticmethod
+    def create_security_groups(attrs=None, methods=None, count=2):
+        """Create multiple fake security groups.
+
+        :param Dictionary attrs:
+            A dictionary with all attributes
+        :param Dictionary methods:
+            A dictionary with all methods
+        :param int count:
+            The number of security groups to fake
+        :return:
+            A list of FakeResource objects faking the security groups
+        """
+        security_groups = []
+        for i in range(0, count):
+            security_groups.append(
+                FakeSecurityGroup.create_one_security_group(attrs, methods))
+
+        return security_groups
+
+
 class FakeSecurityGroupRule(object):
     """Fake one or more security group rules."""
 

openstackclient/tests/compute/v2/test_security_group.py

@@ -125,65 +125,3 @@ def test_security_group_create_description(self):
 
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.data, data)
-
-
-class TestSecurityGroupList(TestSecurityGroup):
-
-    def setUp(self):
-        super(TestSecurityGroupList, self).setUp()
-
-        self.secgroups_mock.list.return_value = [
-            FakeSecurityGroupResource(
-                None,
-                copy.deepcopy(SECURITY_GROUP),
-                loaded=True,
-            ),
-        ]
-
-        # Get the command object to test
-        self.cmd = security_group.ListSecurityGroup(self.app, None)
-
-    def test_security_group_list_no_options(self):
-        self.projects_mock.list.return_value = [
-            fakes.FakeResource(
-                None,
-                copy.deepcopy(identity_fakes.PROJECT),
-                loaded=True,
-            ),
-        ]
-
-        arglist = []
-        verifylist = [
-            ('all_projects', False),
-        ]
-
-        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
-
-        # In base command class Lister in cliff, abstract method take_action()
-        # returns a tuple containing the column names and an iterable
-        # containing the data to be listed.
-        columns, data = self.cmd.take_action(parsed_args)
-
-        # Set expected values
-        kwargs = {
-            'search_opts': {
-                'all_tenants': False,
-            },
-        }
-
-        self.secgroups_mock.list.assert_called_with(
-            **kwargs
-        )
-
-        collist = (
-            'ID',
-            'Name',
-            'Description',
-        )
-        self.assertEqual(collist, columns)
-        datalist = ((
-            security_group_id,
-            security_group_name,
-            security_group_description,
-        ), )
-        self.assertEqual(datalist, tuple(data))