Add sort support to image list

Add sort support to image list by sorting items in the client side.
The parameter syntax follows this spec[1].

[1] https://review.openstack.org/#/c/145544/

Change-Id: I42b487d18f00f937db1938daa46487cea2a896ab
Closes-Bug: #1410251

3 files changed, 118 insertions, 0 deletions

diff --git a/openstackclient/tests/common/test_utils.py b/openstackclient/tests/common/test_utils.py
index 583ab99c..cda0b135 100644
--- a/openstackclient/tests/common/test_utils.py
+++ b/openstackclient/tests/common/test_utils.py
@@ -58,6 +58,68 @@ class TestUtils(test_utils.TestCase):
                               utils.get_password,
                               mock_stdin)
 
+    def get_test_items(self):
+        item1 = {'a': 1, 'b': 2}
+        item2 = {'a': 1, 'b': 3}
+        item3 = {'a': 2, 'b': 2}
+        item4 = {'a': 2, 'b': 1}
+        return [item1, item2, item3, item4]
+
+    def test_sort_items_with_one_key(self):
+        items = self.get_test_items()
+        sort_str = 'b'
+        expect_items = [items[3], items[0], items[2], items[1]]
+        self.assertEqual(expect_items, utils.sort_items(items, sort_str))
+
+    def test_sort_items_with_multiple_keys(self):
+        items = self.get_test_items()
+        sort_str = 'a,b'
+        expect_items = [items[0], items[1], items[3], items[2]]
+        self.assertEqual(expect_items, utils.sort_items(items, sort_str))
+
+    def test_sort_items_all_with_direction(self):
+        items = self.get_test_items()
+        sort_str = 'a:desc,b:desc'
+        expect_items = [items[2], items[3], items[1], items[0]]
+        self.assertEqual(expect_items, utils.sort_items(items, sort_str))
+
+    def test_sort_items_some_with_direction(self):
+        items = self.get_test_items()
+        sort_str = 'a,b:desc'
+        expect_items = [items[1], items[0], items[2], items[3]]
+        self.assertEqual(expect_items, utils.sort_items(items, sort_str))
+
+    def test_sort_items_with_object(self):
+        item1 = mock.Mock(a=1, b=2)
+        item2 = mock.Mock(a=1, b=3)
+        item3 = mock.Mock(a=2, b=2)
+        item4 = mock.Mock(a=2, b=1)
+        items = [item1, item2, item3, item4]
+        sort_str = 'b,a'
+        expect_items = [item4, item1, item3, item2]
+        self.assertEqual(expect_items, utils.sort_items(items, sort_str))
+
+    def test_sort_items_with_empty_key(self):
+        items = self.get_test_items()
+        sort_srt = ''
+        self.assertEqual(items, utils.sort_items(items, sort_srt))
+        sort_srt = None
+        self.assertEqual(items, utils.sort_items(items, sort_srt))
+
+    def test_sort_items_with_invalid_key(self):
+        items = self.get_test_items()
+        sort_str = 'c'
+        self.assertRaises(exceptions.CommandError,
+                          utils.sort_items,
+                          items, sort_str)
+
+    def test_sort_items_with_invalid_direction(self):
+        items = self.get_test_items()
+        sort_str = 'a:bad_dir'
+        self.assertRaises(exceptions.CommandError,
+                          utils.sort_items,
+                          items, sort_str)
+
 
 class NoUniqueMatch(Exception):
     pass
diff --git a/openstackclient/tests/image/v1/test_image.py b/openstackclient/tests/image/v1/test_image.py
index 355f8c82..2776e744 100644
--- a/openstackclient/tests/image/v1/test_image.py
+++ b/openstackclient/tests/image/v1/test_image.py
@@ -470,6 +470,35 @@ class TestImageList(TestImage):
         ), )
         self.assertEqual(datalist, tuple(data))
 
+    @mock.patch('openstackclient.common.utils.sort_items')
+    def test_image_list_sort_option(self, si_mock):
+        si_mock.return_value = [
+            copy.deepcopy(image_fakes.IMAGE)
+        ]
+
+        arglist = ['--sort', 'name:asc']
+        verifylist = [('sort', 'name:asc')]
+        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
+        )
+        si_mock.assert_called_with(
+            [image_fakes.IMAGE],
+            'name:asc'
+        )
+
+        collist = ('ID', 'Name')
+
+        self.assertEqual(collist, columns)
+        datalist = ((
+            image_fakes.image_id,
+            image_fakes.image_name
+        ), )
+        self.assertEqual(datalist, tuple(data))
+
 
 class TestImageSet(TestImage):
 
diff --git a/openstackclient/tests/image/v2/test_image.py b/openstackclient/tests/image/v2/test_image.py
index db3c32df..6a28b1ec 100644
--- a/openstackclient/tests/image/v2/test_image.py
+++ b/openstackclient/tests/image/v2/test_image.py
@@ -255,3 +255,30 @@ class TestImageList(TestImage):
             image_fakes.image_name,
         ), )
         self.assertEqual(datalist, tuple(data))
+
+    @mock.patch('openstackclient.common.utils.sort_items')
+    def test_image_list_sort_option(self, si_mock):
+        si_mock.return_value = [
+            copy.deepcopy(image_fakes.IMAGE)
+        ]
+
+        arglist = ['--sort', 'name:asc']
+        verifylist = [('sort', 'name:asc')]
+        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()
+        si_mock.assert_called_with(
+            [image_fakes.IMAGE],
+            'name:asc'
+        )
+
+        collist = ('ID', 'Name')
+
+        self.assertEqual(collist, columns)
+        datalist = ((
+            image_fakes.image_id,
+            image_fakes.image_name
+        ), )
+        self.assertEqual(datalist, tuple(data))