Add filter to image list

* Hides previously broken --page-size option
* Adds --property to image list for filtering on properties
* Adds Visibility, Protected, Owner, Properties/Tags to --long output
* Adds api.utils.simple_filter() for selecting matches out of a list
  of objects
* Adds tests for all of the above
* Updates image docs

There are additional filtering options to be added in later reviews.

Change-Id: I32feff0ad61aae749b33621c817658d7dc90c3aa
Closes-bug: 1401902

2 files changed, 132 insertions, 12 deletions

diff --git a/openstackclient/tests/image/v1/test_image.py b/openstackclient/tests/image/v1/test_image.py
index 88809966..355f8c82 100644
--- a/openstackclient/tests/image/v1/test_image.py
+++ b/openstackclient/tests/image/v1/test_image.py
@@ -407,8 +407,18 @@ class TestImageList(TestImage):
             detailed=True,
         )
 
-        collist = ('ID', 'Name', 'Disk Format', 'Container Format',
-                   'Size', 'Status')
+        collist = (
+            'ID',
+            'Name',
+            'Disk Format',
+            'Container Format',
+            'Size',
+            'Status',
+            'Visibility',
+            'Protected',
+            'Owner',
+            'Properties',
+        )
 
         self.assertEqual(collist, columns)
         datalist = ((
@@ -418,6 +428,45 @@ class TestImageList(TestImage):
             '',
             '',
             '',
+            'public',
+            False,
+            image_fakes.image_owner,
+            "Alpha='a', Beta='b', Gamma='g'",
+        ), )
+        self.assertEqual(datalist, tuple(data))
+
+    @mock.patch('openstackclient.api.utils.simple_filter')
+    def test_image_list_property_option(self, sf_mock):
+        sf_mock.return_value = [
+            copy.deepcopy(image_fakes.IMAGE),
+        ]
+
+        arglist = [
+            '--property', 'a=1',
+        ]
+        verifylist = [
+            ('property', {'a': '1'}),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        # DisplayCommandBase.take_action() returns two tuples
+        columns, data = self.cmd.take_action(parsed_args)
+        self.api_mock.image_list.assert_called_with(
+            detailed=True,
+        )
+        sf_mock.assert_called_with(
+            [image_fakes.IMAGE],
+            attr='a',
+            value='1',
+            property_field='properties',
+        )
+
+        collist = ('ID', 'Name')
+
+        self.assertEqual(columns, collist)
+        datalist = ((
+            image_fakes.image_id,
+            image_fakes.image_name,
         ), )
         self.assertEqual(datalist, tuple(data))
 
diff --git a/openstackclient/tests/image/v2/test_image.py b/openstackclient/tests/image/v2/test_image.py
index 831aad44..db3c32df 100644
--- a/openstackclient/tests/image/v2/test_image.py
+++ b/openstackclient/tests/image/v2/test_image.py
@@ -83,15 +83,14 @@ class TestImageList(TestImage):
         verifylist = [
             ('public', False),
             ('private', False),
+            ('shared', False),
             ('long', False),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         # DisplayCommandBase.take_action() returns two tuples
         columns, data = self.cmd.take_action(parsed_args)
-        self.api_mock.image_list.assert_called_with(
-            detailed=False,
-        )
+        self.api_mock.image_list.assert_called_with()
 
         collist = ('ID', 'Name')
 
@@ -109,6 +108,7 @@ class TestImageList(TestImage):
         verifylist = [
             ('public', True),
             ('private', False),
+            ('shared', False),
             ('long', False),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -116,7 +116,6 @@ class TestImageList(TestImage):
         # DisplayCommandBase.take_action() returns two tuples
         columns, data = self.cmd.take_action(parsed_args)
         self.api_mock.image_list.assert_called_with(
-            detailed=False,
             public=True,
         )
 
@@ -136,6 +135,7 @@ class TestImageList(TestImage):
         verifylist = [
             ('public', False),
             ('private', True),
+            ('shared', False),
             ('long', False),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -143,7 +143,6 @@ class TestImageList(TestImage):
         # DisplayCommandBase.take_action() returns two tuples
         columns, data = self.cmd.take_action(parsed_args)
         self.api_mock.image_list.assert_called_with(
-            detailed=False,
             private=True,
         )
 
@@ -156,6 +155,33 @@ class TestImageList(TestImage):
         ), )
         self.assertEqual(datalist, tuple(data))
 
+    def test_image_list_shared_option(self):
+        arglist = [
+            '--shared',
+        ]
+        verifylist = [
+            ('public', False),
+            ('private', False),
+            ('shared', True),
+            ('long', False),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        # DisplayCommandBase.take_action() returns two tuples
+        columns, data = self.cmd.take_action(parsed_args)
+        self.api_mock.image_list.assert_called_with(
+            shared=True,
+        )
+
+        collist = ('ID', 'Name')
+
+        self.assertEqual(columns, collist)
+        datalist = ((
+            image_fakes.image_id,
+            image_fakes.image_name,
+        ), )
+        self.assertEqual(datalist, tuple(data))
+
     def test_image_list_long_option(self):
         arglist = [
             '--long',
@@ -167,13 +193,21 @@ class TestImageList(TestImage):
 
         # DisplayCommandBase.take_action() returns two tuples
         columns, data = self.cmd.take_action(parsed_args)
-        self.api_mock.image_list.assert_called_with(
-            detailed=True,
+        self.api_mock.image_list.assert_called_with()
+
+        collist = (
+            'ID',
+            'Name',
+            'Disk Format',
+            'Container Format',
+            'Size',
+            'Status',
+            'Visibility',
+            'Protected',
+            'Owner',
+            'Tags',
         )
 
-        collist = ('ID', 'Name', 'Disk Format', 'Container Format',
-                   'Size', 'Status')
-
         self.assertEqual(collist, columns)
         datalist = ((
             image_fakes.image_id,
@@ -182,5 +216,42 @@ class TestImageList(TestImage):
             '',
             '',
             '',
+            '',
+            False,
+            image_fakes.image_owner,
+            '',
+        ), )
+        self.assertEqual(datalist, tuple(data))
+
+    @mock.patch('openstackclient.api.utils.simple_filter')
+    def test_image_list_property_option(self, sf_mock):
+        sf_mock.return_value = [
+            copy.deepcopy(image_fakes.IMAGE),
+        ]
+
+        arglist = [
+            '--property', 'a=1',
+        ]
+        verifylist = [
+            ('property', {'a': '1'}),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        # DisplayCommandBase.take_action() returns two tuples
+        columns, data = self.cmd.take_action(parsed_args)
+        self.api_mock.image_list.assert_called_with()
+        sf_mock.assert_called_with(
+            [image_fakes.IMAGE],
+            attr='a',
+            value='1',
+            property_field='properties',
+        )
+
+        collist = ('ID', 'Name')
+
+        self.assertEqual(columns, collist)
+        datalist = ((
+            image_fakes.image_id,
+            image_fakes.image_name,
         ), )
         self.assertEqual(datalist, tuple(data))