Add new filters for 'security-service-list' command

Add filtering by following options:
- share network
- name
- type
- user
- dns-ip
- server
- domain

Add information about share networks to output if
'--detailed' options is enabled.

Add '--offset' and '--limit' options to specify start point
of security services listing and number of security services to show.

Implements bp improve-security-service-list-filtering

Change-Id: I8afc230eb82f3c3591fb11638e6911094b50baf8

manilaclient/v1/shell.py

@@ -1194,20 +1194,92 @@ def do_security_service_show(cs, args):
     const=1,
     default=0,
     help='Display information from all tenants (Admin only).')
+@cliutils.arg(
+    '--share-network',
+    '--share_network',  # alias
+    metavar='<share_network>',
+    action='single_alias',
+    default=None,
+    help='Filter results by share network id or name.')
 @cliutils.arg(
     '--status',
     metavar='<status>',
     default=None,
     help='Filter results by status.')
+@cliutils.arg(
+    '--name',
+    metavar='<name>',
+    default=None,
+    help='Filter results by name.')
+@cliutils.arg(
+    '--type',
+    metavar='<type>',
+    default=None,
+    help='Filter results by type.')
+@cliutils.arg(
+    '--user',
+    metavar='<user>',
+    default=None,
+    help='Filter results by user or group used by tenant.')
+@cliutils.arg(
+    '--dns-ip',
+    '--dns_ip',  # alias
+    metavar='<dns_ip>',
+    action='single_alias',
+    default=None,
+    help="Filter results by DNS IP address used inside tenant's network.")
+@cliutils.arg(
+    '--server',
+    metavar='<server>',
+    default=None,
+    help="Filter results by security service IP address or hostname.")
+@cliutils.arg(
+    '--domain',
+    metavar='<domain>',
+    default=None,
+    help="Filter results by domain.")
+@cliutils.arg(
+    '--detailed',
+    dest='detailed',
+    metavar='<0|1>',
+    nargs='?',
+    type=int,
+    const=1,
+    default=0,
+    help="Show detailed information about filtered security services.")
+@cliutils.arg(
+    '--offset',
+    metavar="<offset>",
+    default=None,
+    help='Start position of security services listing.')
+@cliutils.arg(
+    '--limit',
+    metavar="<limit>",
+    default=None,
+    help='Number of security services to return per request.')
 def do_security_service_list(cs, args):
     """Get a list of security services."""
     all_tenants = int(os.environ.get("ALL_TENANTS", args.all_tenants))
     search_opts = {
         'all_tenants': all_tenants,
         'status': args.status,
+        'name': args.name,
+        'type': args.type,
+        'user': args.user,
+        'dns_ip': args.dns_ip,
+        'server': args.server,
+        'domain': args.domain,
+        'offset': args.offset,
+        'limit': args.limit,
     }
-    security_services = cs.security_services.list(search_opts=search_opts)
+    if args.share_network:
+        search_opts['share_network_id'] = _find_share_network(
+            cs, args.share_network).id
+    security_services = cs.security_services.list(search_opts=search_opts,
+                                                  detailed=args.detailed)
     fields = ['id', 'name', 'status', 'type', ]
+    if args.detailed:
+        fields.append('share_networks')
     utils.print_list(security_services, fields=fields)
 
 

tests/v1/test_shell.py

@@ -17,6 +17,7 @@
 import fixtures
 import mock
 import requests
+import six
 
 from manilaclient import client
 from manilaclient.common import constants
@@ -24,13 +25,14 @@ from manilaclient import exceptions
 from manilaclient.openstack.common import cliutils
 from manilaclient.openstack.common import jsonutils
 from manilaclient import shell
+from manilaclient import utils
 from manilaclient.v1 import client as client_v1
 from manilaclient.v1 import shell as shell_v1
-from tests import utils
+from tests import utils as test_utils
 from tests.v1 import fakes
 
 
-class ShellTest(utils.TestCase):
+class ShellTest(test_utils.TestCase):
 
     FAKE_ENV = {
         'MANILA_USERNAME': 'username',
@@ -513,6 +515,98 @@ class ShellTest(utils.TestCase):
 
         cmd.split.assert_called_once_with()
 
+    @mock.patch.object(utils, 'print_list', mock.Mock())
+    def test_security_service_list(self):
+        self.run_command('security-service-list')
+        self.assert_called(
+            'GET',
+            '/security-services',
+        )
+        utils.print_list.assert_called_once_with(
+            mock.ANY,
+            fields=['id', 'name', 'status', 'type'])
+
+    @mock.patch.object(utils, 'print_list', mock.Mock())
+    @mock.patch.object(shell_v1, '_find_share_network', mock.Mock())
+    def test_security_service_list_filter_share_network(self):
+        class FakeShareNetwork:
+            id = 'fake-sn-id'
+        sn = FakeShareNetwork()
+        shell_v1._find_share_network.return_value = sn
+        for command in ['--share-network', '--share_network']:
+            self.run_command('security-service-list %(command)s %(sn_id)s' %
+                             {'command': command,
+                              'sn_id': sn.id})
+            self.assert_called(
+                'GET',
+                '/security-services?share_network_id=%s' % sn.id,
+            )
+            shell_v1._find_share_network.assert_called_with(mock.ANY, sn.id)
+            utils.print_list.assert_called_with(
+                mock.ANY,
+                fields=['id', 'name', 'status', 'type'])
+
+    @mock.patch.object(utils, 'print_list', mock.Mock())
+    def test_security_service_list_detailed(self):
+        self.run_command('security-service-list --detailed')
+        self.assert_called(
+            'GET',
+            '/security-services/detail',
+        )
+        utils.print_list.assert_called_once_with(
+            mock.ANY,
+            fields=['id', 'name', 'status', 'type', 'share_networks'])
+
+    @mock.patch.object(utils, 'print_list', mock.Mock())
+    def test_security_service_list_all_tenants(self):
+        self.run_command('security-service-list --all-tenants')
+        self.assert_called(
+            'GET',
+            '/security-services?all_tenants=1',
+        )
+        utils.print_list.assert_called_once_with(
+            mock.ANY,
+            fields=['id', 'name', 'status', 'type'])
+
+    @mock.patch.object(utils, 'print_list', mock.Mock())
+    def test_security_service_list_all_filters(self):
+        filters = {
+            'status': 'new',
+            'name': 'fake-name',
+            'type': 'ldap',
+            'user': 'fake-user',
+            'dns-ip': '1.1.1.1',
+            'server': 'fake-server',
+            'domain': 'fake-domain',
+            'offset': 10,
+            'limit': 20,
+        }
+        command_str = 'security-service-list'
+        for key, value in six.iteritems(filters):
+            command_str += ' --%(key)s=%(value)s' % {'key': key,
+                                                     'value': value}
+        self.run_command(command_str)
+        self.assert_called(
+            'GET',
+            '/security-services?dns_ip=1.1.1.1&domain=fake-domain&limit=20'
+            '&name=fake-name&offset=10&server=fake-server&status=new'
+            '&type=ldap&user=fake-user',
+        )
+        utils.print_list.assert_called_once_with(
+            mock.ANY,
+            fields=['id', 'name', 'status', 'type'])
+
+    @mock.patch.object(utils, 'print_list', mock.Mock())
+    def test_security_service_list_filter_by_dns_ip_alias(self):
+        self.run_command('security-service-list --dns_ip 1.1.1.1')
+        self.assert_called(
+            'GET',
+            '/security-services?dns_ip=1.1.1.1',
+        )
+        utils.print_list.assert_called_once_with(
+            mock.ANY,
+            fields=['id', 'name', 'status', 'type'])
+
     @mock.patch.object(fakes.FakeClient, 'authenticate', mock.Mock())
     @mock.patch.object(shell.SecretsHelper, '_make_key', mock.Mock())
     @mock.patch.object(shell.SecretsHelper, 'password', mock.Mock())
@@ -597,14 +691,14 @@ class ShellTest(utils.TestCase):
             headers = None
             if url == 'new_url/shares/detail':
                 resp_text = {"shares": []}
-                return utils.TestResponse({
+                return test_utils.TestResponse({
                     "status_code": 200,
                     "text": jsonutils.dumps(resp_text),
                 })
             elif url == 'fake/shares/detail':
                 resp_text = {"unauthorized": {"message": "Unauthorized",
                                               "code": "401"}}
-                return utils.TestResponse({
+                return test_utils.TestResponse({
                     "status_code": 401,
                     "text": jsonutils.dumps(resp_text),
                 })
@@ -614,7 +708,7 @@ class ShellTest(utils.TestCase):
                     'x-auth-token': 'new_token',
                 }
                 resp_text = 'some_text'
-                return utils.TestResponse({
+                return test_utils.TestResponse({
                     "status_code": 200,
                     "text": jsonutils.dumps(resp_text),
                     "headers": headers
@@ -642,7 +736,7 @@ class ShellTest(utils.TestCase):
         )
 
 
-class SecretsHelperTestCase(utils.TestCase):
+class SecretsHelperTestCase(test_utils.TestCase):
     def setUp(self):
         super(SecretsHelperTestCase, self).setUp()
         self.cs = client.Client(1, 'user', 'password',