Debian Codegraph @

ansible_collections/netapp/ontap/tests/unit/framework/rest_factory.py

raw
1 # (c) 2022-2025, NetApp, Inc
2 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
3 # Author: Laurent Nicolas, [email protected]
4
5 """ unit tests for Ansible modules for ONTAP:
6 utility to build REST responses and errors, and register them to use them in testcases.
7
8 1) at the module level, define the REST responses:
9 SRR = rest_responses() if you're only interested in the default ones: 'empty', 'error', ...
10 SRR = rest_responses(dict) to use the default ones and augment them:
11 a key identifies a response name, and the value is a tuple.
12
13 3) in each test function, create a list of (event, response) using rest_response
14 def test_create_aggr():
15 register_responses([
16 ('GET', 'cluster', SRR['is_rest']),
17 ('POST', 'storage/aggregates', SRR['empty_good'])
18 ])
19
20 See ansible_collections/netapp/ontap/tests/unit/plugins/modules/test_na_ontap_aggregate_rest.py
21 for an example.
22 """
23
24 from __future__ import (absolute_import, division, print_function)
25 __metaclass__ = type
26
27
28 JOB_GET_API = ' cluster/jobs/94b6e6a7-d426-11eb-ac81-00505690980f'
29
30
31 def _build_job(state):
32 return (200, {
33 "uuid": "f03ccbb6-d8bb-11eb-ac81-00505690980f",
34 "description": "job results with state: %s" % state,
35 "state": state,
36 "message": "job reported %s" % state
37 }, None)
38
39
40 # name: (html_code, dict, None or error string)
41 # dict is translated into an xml structure, num_records is None or an integer >= 0
42 _DEFAULT_RESPONSES = {
43 # common responses
44 'is_rest': (200, {}, None),
45 'is_rest_95': (200, dict(version=dict(generation=9, major=5, minor=0, full='dummy_9_5_0')), None),
46 'is_rest_96': (200, dict(version=dict(generation=9, major=6, minor=0, full='dummy_9_6_0')), None),
47 'is_rest_97': (200, dict(version=dict(generation=9, major=7, minor=0, full='dummy_9_7_0')), None),
48 'is_rest_9_7_5': (200, dict(version=dict(generation=9, major=7, minor=5, full='dummy_9_7_5')), None),
49 'is_rest_9_8_0': (200, dict(version=dict(generation=9, major=8, minor=0, full='dummy_9_8_0')), None),
50 'is_rest_9_9_0': (200, dict(version=dict(generation=9, major=9, minor=0, full='dummy_9_9_0')), None),
51 'is_rest_9_9_1': (200, dict(version=dict(generation=9, major=9, minor=1, full='dummy_9_9_1')), None),
52 'is_rest_9_10_1': (200, dict(version=dict(generation=9, major=10, minor=1, full='dummy_9_10_1')), None),
53 'is_rest_9_11_0': (200, dict(version=dict(generation=9, major=11, minor=0, full='dummy_9_11_0')), None),
54 'is_rest_9_11_1': (200, dict(version=dict(generation=9, major=11, minor=1, full='dummy_9_11_1')), None),
55 'is_rest_9_12_0': (200, dict(version=dict(generation=9, major=12, minor=0, full='dummy_9_12_0')), None),
56 'is_rest_9_12_1': (200, dict(version=dict(generation=9, major=12, minor=1, full='dummy_9_12_1')), None),
57 'is_rest_9_13_1': (200, dict(version=dict(generation=9, major=13, minor=1, full='dummy_9_13_1')), None),
58 'is_rest_9_14_1': (200, dict(version=dict(generation=9, major=14, minor=1, full='dummy_9_14_1')), None),
59 'is_rest_9_15_1': (200, dict(version=dict(generation=9, major=15, minor=1, full='dummy_9_15_1')), None),
60 'is_rest_9_16_1': (200, dict(version=dict(generation=9, major=16, minor=1, full='dummy_9_16_1')), None),
61 'is_rest_9_17_1': (200, dict(version=dict(generation=9, major=17, minor=1, full='dummy_9_17_1')), None),
62 'is_zapi': (400, {}, "Unreachable"),
63 'empty_good': (200, {}, None),
64 'success': (200, {}, None),
65 'success_with_job_uuid': (200, {'job': {'_links': {'self': {'href': '/api/%s' % JOB_GET_API}}}}, None),
66 'end_of_sequence': (500, None, "Unexpected call to send_request"),
67 'empty_records': (200, {'records': []}, None),
68 'zero_records': (200, {'num_records': 0}, None),
69 'one_record': (200, {'num_records': 1}, None),
70 'one_vserver_record': (200, {'num_records': 1, 'records': [{'svm': {'name': 'svm_name', 'uuid': 'svm_uuid'}}]}, None),
71 'generic_error': (400, None, "Expected error"),
72 'error_record': (400, None, {'code': 6, 'message': 'Expected error'}),
73 'job_generic_response_success': _build_job('success'),
74 'job_generic_response_running': _build_job('running'),
75 'job_generic_response_failure': _build_job('failure'),
76 }
77
78
79 def rest_error_message(error, api=None, extra='', got=None):
80 if got is None:
81 got = 'got Expected error.'
82 msg = ('%s: ' % error) if error else ''
83 msg += ('calling: %s: ' % api) if api else ''
84 msg += got
85 msg += extra
86 return msg
87
88
89 class rest_responses:
90 ''' return an object that behaves like a read-only dictionary
91 supports [key] to read an entry, and 'in' keyword to check key existence.
92 '''
93 def __init__(self, adict=None, allow_override=True):
94 self.responses = dict(_DEFAULT_RESPONSES.items())
95 if adict:
96 for key, value in adict.items():
97 if not allow_override and key in self.responses:
98 raise KeyError('duplicated key: %s' % key)
99 self.responses[key] = value
100
101 def _get_response(self, name):
102 try:
103 return self.responses[name]
104 except KeyError:
105 raise KeyError('%s not registered, list of valid keys: %s' % (name, self.responses.keys()))
106
107 def __getitem__(self, name):
108 return self._get_response(name)
109
110 def __contains__(self, name):
111 return name in self.responses