summaryrefslogtreecommitdiffstats
path: root/src/pybind/mgr/dashboard/tests/test_rest_client.py
blob: 2df6763f98fc7f5f45c7bad88625551aaaceb022 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
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)