From 19fcec84d8d7d21e796c7624e521b60d28ee21ed Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sun, 7 Apr 2024 20:45:59 +0200
Subject: Adding upstream version 16.2.11+ds.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 src/pybind/mgr/dashboard/tests/test_rest_client.py | 110 +++++++++++++++++++++
 1 file changed, 110 insertions(+)
 create mode 100644 src/pybind/mgr/dashboard/tests/test_rest_client.py

(limited to 'src/pybind/mgr/dashboard/tests/test_rest_client.py')

diff --git a/src/pybind/mgr/dashboard/tests/test_rest_client.py b/src/pybind/mgr/dashboard/tests/test_rest_client.py
new file mode 100644
index 000000000..2df6763f9
--- /dev/null
+++ b/src/pybind/mgr/dashboard/tests/test_rest_client.py
@@ -0,0 +1,110 @@
+# -*- coding: utf-8 -*-
+import unittest
+
+import requests.exceptions
+
+try:
+    from mock import patch
+except ImportError:
+    from unittest.mock import patch
+
+from urllib3.exceptions import MaxRetryError, ProtocolError
+
+from .. import mgr
+from ..rest_client import RequestException, RestClient
+
+
+class RestClientTestClass(RestClient):
+    """RestClient subclass for testing purposes."""
+    @RestClient.api_get('/')
+    def fake_endpoint_method_with_annotation(self, request=None) -> bool:
+        pass
+
+
+class RestClientTest(unittest.TestCase):
+    def setUp(self):
+        settings = {'REST_REQUESTS_TIMEOUT': 45}
+        mgr.get_module_option.side_effect = settings.get
+
+    def test_timeout_auto_set(self):
+        with patch('requests.Session.request') as mock_request:
+            rest_client = RestClient('localhost', 8000)
+            rest_client.session.request('GET', '/test')
+            mock_request.assert_called_with('GET', '/test', timeout=45)
+
+    def test_timeout_auto_set_arg(self):
+        with patch('requests.Session.request') as mock_request:
+            rest_client = RestClient('localhost', 8000)
+            rest_client.session.request(
+                'GET', '/test', None, None, None, None,
+                None, None, None)
+            mock_request.assert_called_with(
+                'GET', '/test', None, None, None, None,
+                None, None, None, timeout=45)
+
+    def test_timeout_no_auto_set_kwarg(self):
+        with patch('requests.Session.request') as mock_request:
+            rest_client = RestClient('localhost', 8000)
+            rest_client.session.request('GET', '/test', timeout=20)
+            mock_request.assert_called_with('GET', '/test', timeout=20)
+
+    def test_timeout_no_auto_set_arg(self):
+        with patch('requests.Session.request') as mock_request:
+            rest_client = RestClient('localhost', 8000)
+            rest_client.session.request(
+                'GET', '/test', None, None, None, None,
+                None, None, 40)
+            mock_request.assert_called_with(
+                'GET', '/test', None, None, None, None,
+                None, None, 40)
+
+
+class RestClientDoRequestTest(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.mock_requests = patch('requests.Session').start()
+        cls.rest_client = RestClientTestClass('localhost', 8000, 'UnitTest')
+
+    def test_endpoint_method_with_annotation(self):
+        self.assertEqual(self.rest_client.fake_endpoint_method_with_annotation(), None)
+
+    def test_do_request_exception_no_args(self):
+        self.mock_requests().get.side_effect = requests.exceptions.ConnectionError()
+        with self.assertRaises(RequestException) as context:
+            self.rest_client.do_request('GET', '/test')
+            self.assertEqual('UnitTest REST API cannot be reached. Please '
+                             'check your configuration and that the API '
+                             'endpoint is accessible',
+                             context.exception.message)
+
+    def test_do_request_exception_args_1(self):
+        self.mock_requests().post.side_effect = requests.exceptions.ConnectionError(
+            MaxRetryError('Abc', 'http://xxx.yyy', 'too many redirects'))
+        with self.assertRaises(RequestException) as context:
+            self.rest_client.do_request('POST', '/test')
+            self.assertEqual('UnitTest REST API cannot be reached. Please '
+                             'check your configuration and that the API '
+                             'endpoint is accessible',
+                             context.exception.message)
+
+    def test_do_request_exception_args_2(self):
+        self.mock_requests().put.side_effect = requests.exceptions.ConnectionError(
+            ProtocolError('Connection broken: xyz'))
+        with self.assertRaises(RequestException) as context:
+            self.rest_client.do_request('PUT', '/test')
+            self.assertEqual('UnitTest REST API cannot be reached. Please '
+                             'check your configuration and that the API '
+                             'endpoint is accessible',
+                             context.exception.message)
+
+    def test_do_request_exception_nested_args(self):
+        self.mock_requests().delete.side_effect = requests.exceptions.ConnectionError(
+            MaxRetryError('Xyz', 'https://foo.bar',
+                          Exception('Foo: [Errno -42] bla bla bla')))
+        with self.assertRaises(RequestException) as context:
+            self.rest_client.do_request('DELETE', '/test')
+            self.assertEqual('UnitTest REST API cannot be reached: bla '
+                             'bla bla [errno -42]. Please check your '
+                             'configuration and that the API endpoint '
+                             'is accessible',
+                             context.exception.message)
-- 
cgit v1.2.3