Add unit tests for coriolisclient.cli.formatter module

Author: Cristi1324

coriolisclient/tests/cli/test_formatter.py

@@ -0,0 +1,152 @@
+# Copyright 2024 Cloudbase Solutions Srl
+# All Rights Reserved.
+
+import ddt
+from unittest import mock
+
+from coriolisclient.cli import formatter
+from coriolisclient.tests import test_base
+
+
+@ddt.ddt
+class EntityFormatterTestCase(test_base.CoriolisBaseTestCase):
+    """Test suite for the Coriolis Entity Formatter."""
+
+    def setUp(self):
+        def _get_formatted_data(self, obj):
+            return mock.sentinel.data
+        setattr(formatter.EntityFormatter, '_get_formatted_data',
+                _get_formatted_data)
+        super(EntityFormatterTestCase, self).setUp()
+        self.format = formatter.EntityFormatter()
+        self.format.columns = mock.sentinel.columns
+
+    def test_get_sorted_list(self):
+        obj_list = ["obj2", "obj1"]
+
+        result = self.format._get_sorted_list(obj_list)
+
+        self.assertEqual(
+            obj_list,
+            result
+        )
+
+    @mock.patch.object(formatter.EntityFormatter, '_get_generic_columns')
+    @mock.patch.object(formatter.EntityFormatter, '_get_sorted_list')
+    @mock.patch.object(formatter.EntityFormatter, '_get_generic_data')
+    def test_list_objects(
+        self,
+        mock_get_generic_data,
+        mock_get_sorted_list,
+        mock_get_generic_columns,
+    ):
+        obj_list = ["obj2", "obj1"]
+        mock_get_sorted_list.return_value = ["obj1", "obj2"]
+        mock_get_generic_data.side_effect = [
+            mock.sentinel.generic_data_1,
+            mock.sentinel.generic_data_2
+        ]
+        mock_get_generic_columns.return_value = mock.sentinel.columns
+
+        result = self.format.list_objects(obj_list)
+
+        self.assertEqual(
+            (
+                mock.sentinel.columns,
+                mock.sentinel.generic_data_1,
+                mock.sentinel.generic_data_2
+            ),
+            (
+                result[0],
+                next(result[1]),
+                next(result[1])
+            )
+        )
+        mock_get_sorted_list.assert_called_once_with(obj_list)
+        mock_get_generic_data.assert_has_calls([
+            mock.call("obj1"),
+            mock.call("obj2")
+        ])
+
+    def test_get_generic_data(self):
+        obj = mock.Mock()
+
+        result = self.format._get_generic_data(obj)
+
+        self.assertEqual(
+            mock.sentinel.data,
+            result
+        )
+
+    def test_get_generic_columns(self):
+        result = self.format._get_generic_columns()
+
+        self.assertEqual(
+            mock.sentinel.columns,
+            result
+        )
+
+    def testget_formatted_entity(self):
+        obj = mock.Mock()
+
+        result = self.format.get_formatted_entity(obj)
+
+        self.assertEqual(
+            (mock.sentinel.columns, mock.sentinel.data),
+            result
+        )
+
+    @ddt.data(
+        {
+            "current_value": 3,
+            "max_value": 9,
+            "percent_format": "{:.0f}%",
+            "expected_result": "33%"
+        },
+        {
+            "current_value": 3,
+            "max_value": 9,
+            "percent_format": "{:.2f}%",
+            "expected_result": "33.33%"
+        },
+        {
+            "current_value": 0,
+            "max_value": 9,
+            "percent_format": "{:.0f}%",
+            "expected_result": None
+        },
+        {
+            "current_value": 3,
+            "max_value": None,
+            "percent_format": "{:.0f}%",
+            "expected_result": None
+        }
+    )
+    def test_get_percent_string(self, data):
+        result = self.format._get_percent_string(
+            data["current_value"],
+            data["max_value"],
+            data["percent_format"]
+        )
+
+        self.assertEqual(
+            data["expected_result"],
+            result
+        )
+
+    @mock.patch.object(formatter.EntityFormatter, '_get_percent_string')
+    def test_format_progress_update(self, mock_get_percent_string):
+        progress_update = {
+            "current_step": "mock_current_step",
+            "total_steps": "mock_total_steps",
+            "created_at": "mock_created_at",
+            "message": "mock_message",
+        }
+        mock_get_percent_string.return_value = "mock_percent_string"
+
+        result = self.format._format_progress_update(progress_update)
+
+        self.assertEqual(
+            "mock_created_at [mock_percent_string] mock_message",
+            result
+        )