blob: 42845a2a29f4dc309feab9c2a6477d68ddc7bf75 [file] [log] [blame]
Kailash Khalasi8416bfe2017-12-20 13:06:37 -08001*** Settings ***
2Documentation Test Suite for XOS APIs
3Suite Setup Setup
4Suite Teardown Teardown
5Test Template Verify API Functionality
6Library Collections
7Library String
8Library OperatingSystem
9Library XML
10Library RequestsLibrary
Kailash Khalasi78735ea2018-05-01 13:48:26 -070011Library HttpLibrary.HTTP
Kailash Khalasi8416bfe2017-12-20 13:06:37 -080012Library ../Framework/utils/utils.py
13Library ../Framework/restApi.py
14Variables ../Properties/RestApiProperties.py
15
16*** Variables ***
17${xos_service} core
18
19*** Test Cases *** TYPE API
20{%- for m in proto.messages -%}
21{%- if m.name not in ['XOSBase'] -%}
Kailash Khalasi8416bfe2017-12-20 13:06:37 -080022{% autoescape false %}
23{% endautoescape %}
Kailash Khalasi9302c182018-05-07 13:46:15 -060024Create {{ m.name }} CREATE /xosapi/v1/${xos_service}/{{ xproto_pluralize(m) | lower}} ${json_{{ m.name | lower}}_1}
Kailash Khalasi008d5642018-02-12 12:59:53 -080025 [Tags] {{ m.name }}
Kailash Khalasi8416bfe2017-12-20 13:06:37 -080026
Kailash Khalasi9302c182018-05-07 13:46:15 -060027Update {{ m.name }} UPDATE /xosapi/v1/${xos_service}/{{ xproto_pluralize(m) | lower}} ${json_{{ m.name | lower}}_updated_1} ${id}
Kailash Khalasi008d5642018-02-12 12:59:53 -080028 [Tags] {{ m.name }}
Kailash Khalasi8416bfe2017-12-20 13:06:37 -080029
Kailash Khalasi9302c182018-05-07 13:46:15 -060030Get {{ m.name }} RETRIEVE /xosapi/v1/${xos_service}/{{ xproto_pluralize(m) | lower}} ${json_{{ m.name | lower}}_updated_1} ${id} ${json_{{ m.name | lower}}_updated_key}
Kailash Khalasi008d5642018-02-12 12:59:53 -080031 [Tags] {{ m.name }}
Kailash Khalasi8416bfe2017-12-20 13:06:37 -080032
Kailash Khalasi9302c182018-05-07 13:46:15 -060033Delete {{ m.name }} DELETE /xosapi/v1/${xos_service}/{{ xproto_pluralize(m) | lower}} data_id=${id}
Kailash Khalasi008d5642018-02-12 12:59:53 -080034 [Tags] {{ m.name }}
Kailash Khalasi8416bfe2017-12-20 13:06:37 -080035{% endif %}
36{% endfor -%}
37
38*** Keywords ***
39Verify API Functionality
40 [Arguments] ${type} ${endpoint} ${data}=${EMPTY} ${data_id}=${EMPTY} ${key}=${EMPTY}
41 Run Keyword If "${type}" == "RETRIEVE" CORD Get ${endpoint} ${data_id} ${data} ${key}
42 Run Keyword If "${type}" == "CREATE" CORD Post ${endpoint} ${data}
43 Run Keyword If "${type}" == "UPDATE" CORD Put ${endpoint} ${data} ${data_id}
44 Run Keyword If "${type}" == "DELETE" CORD Delete ${endpoint} ${data_id}
45
46CORD Get
47 [Documentation] Make a GET call to the CORD controller
48 [Arguments] ${service} ${id} ${value} ${key}
49 ${resp}= Get Request ${SERVER_IP} ${service}/${id}
50 Log ${resp.content}
51 Should Be Equal As Strings ${resp.status_code} 200
52 ${updated_value}= Run Keyword If '${key}' != 'null' Get Json Value ${resp.content} /${key}
53 ${updated_value}= Run Keyword If '${key}' != 'null' Remove String ${updated_value} "
54 Run Keyword If '${key}' != 'null' Should Contain "${value}" ${updated_value}
55 [Return] ${resp}
56
57CORD Post
58 [Documentation] Make a POST call to the CORD controller
59 [Arguments] ${service} ${data}
60 ${data}= Evaluate json.dumps(${data}) json
61 ${resp}= Post Request ${SERVER_IP} uri=${service} data=${data}
62 Log ${resp.content}
63 Should Be Equal As Strings ${resp.status_code} 200
64 ${id}= Get Json Value ${resp.content} /id
65 Set Suite Variable ${id}
66 [Return] ${resp}
67
68CORD Put
69 [Documentation] Make a PUT call to the CORD controller
70 [Arguments] ${service} ${data} ${data_id}
71 ${data}= Evaluate json.dumps(${data}) json
72 ${resp}= Put Request ${SERVER_IP} uri=${service}/${data_id} data=${data}
73 Log ${resp.content}
74 Should Be Equal As Strings ${resp.status_code} 200
75 ${id}= Get Json Value ${resp.content} /id
76 Set Suite Variable ${id}
77 [Return] ${resp}
78
79CORD Delete
80 [Documentation] Make a DELETE call to the CORD controller
81 [Arguments] ${service} ${data_id}
82 ${resp}= Delete Request ${SERVER_IP} uri=${service}/${data_id}
83 Log ${resp.content}
84 Should Be Equal As Strings ${resp.status_code} 200
85 [Return] ${resp}
86
87Generate JSON Data
88 {%- for m in proto.messages -%}
89 {%- if m.name not in ['XOSBase'] -%}
90 {% autoescape false %}
91 {% endautoescape %}
92 ${json_{{ m.name | lower }}_1}= Set Variable { }
93 ${json_{{ m.name | lower }}_updated_1}= Set Variable { }
94 ${json_{{ m.name | lower}}_updated_key}= Set Variable null
95 Set Suite Variable ${json_{{ m.name | lower}}_updated_key}
96 # set required fields for {{ m.name | lower }} object
Kailash Khalasi78735ea2018-05-01 13:48:26 -070097 {% for f in m.fields + xproto_base_fields(m, proto.message_table) -%}
Kailash Khalasi8416bfe2017-12-20 13:06:37 -080098 {% if f.modifier == "required" -%}
99 {% if f.options.blank == "False" -%}
100 {% if not f.options.default -%}
101 {% if f.link -%}
102 ${tmp_{{ f.options.model | lower }}_id}= Create {{ f.options.model }}
103 ${json_{{ m.name | lower }}_1}= Set Json Value ${json_{{ m.name | lower }}_1} /{{ f.name }}_id ${tmp_{{ f.options.model | lower }}_id}
104 {% else -%}
105 ${json_{{ m.name | lower}}_{{ f.name }}_1}= Generate Random Value {{ f.type }}
106 ${json_{{ m.name | lower }}_1}= Set Json Value ${json_{{ m.name | lower }}_1} /{{ f.name }} "${json_{{ m.name | lower }}_{{ f.name }}_1}"
107 {% if loop.index0 == 0 -%}
108 ${json_{{ m.name | lower}}_updated_key}= Set Variable {{ f.name }}
109 ${json_{{ m.name | lower}}_{{ f.name }}_updated_1}= Generate Random Value {{ f.type }}
110 ${json_{{ m.name | lower }}_updated_1}= Set Json Value ${json_{{ m.name | lower }}_updated__1} /{{ f.name }} "${json_{{ m.name | lower }}_{{ f.name }}_updated_1}"
111 {% endif -%}
112 {% endif -%}
113 {% endif -%}
114 {% endif -%}
115 {% endif -%}
116 {% endfor -%}
Kailash Khalasi0132fd52018-08-09 15:20:45 -0700117 {% if m.name == "User" -%}
118 ${json_{{ m.name | lower}}_email_tmp}= Set Variable testuser@opencord.org
119 ${json_{{ m.name | lower}}_1}= Set Json Value ${json_{{ m.name | lower }}_1} /email "${json_{{ m.name | lower }}_email_tmp}"
120 {% endif %}
Kailash Khalasi8416bfe2017-12-20 13:06:37 -0800121 {% if m.name == "Site" -%}
122 ${json_{{ m.name | lower}}_login_base_tmp}= Set Variable testloginbase
123 ${json_{{ m.name | lower}}_1}= Set Json Value ${json_{{ m.name | lower }}_1} /login_base "${json_{{ m.name | lower }}_login_base_tmp}"
124 {% endif %}
125 {% if m.name == "Slice" -%}
126 ${json_{{ m.name | lower}}_name}= Generate Random Slice Name
127 ${json_{{ m.name | lower}}_1}= Set Json Value ${json_{{ m.name | lower }}_1} /name "${json_{{ m.name | lower }}_name}"
128 ${json_{{ m.name | lower}}_name_updated_1}= Generate Random Slice Name
129 ${json_{{ m.name | lower}}_updated_1}= Set Json Value ${json_{{ m.name | lower }}_updated_1} /name "${json_{{ m.name | lower}}_name_updated_1}"
130 {% endif %}
131 ${json_{{ m.name | lower }}_1}= To JSON ${json_{{ m.name | lower }}_1}
132 ${json_{{ m.name | lower }}_updated_1}= To JSON ${json_{{ m.name | lower }}_updated_1}
133 Set Suite Variable ${json_{{ m.name | lower }}_1}
134 Set Suite Variable ${json_{{ m.name | lower }}_updated_1}
135 {% endif -%}
136 {% endfor %}
137
138{% for m in proto.messages %}
139{%- if m.name not in ['XOSBase'] -%}
140Create {{ m.name }}
141 ##Creating {{ m.name | lower }} object
142 ${json_{{ m.name | lower }}_tmp}= Set Variable { }
143 # set required fields for {{ m.name | lower }} object
Kailash Khalasi78735ea2018-05-01 13:48:26 -0700144 {% for f in m.fields + xproto_base_fields(m, proto.message_table) -%}
Kailash Khalasi8416bfe2017-12-20 13:06:37 -0800145 {% if f.link -%}
146 {% if f.modifier == "required" -%}
147 {% if f.options.blank == "False" -%}
148 # create dependent {{ f.options.model }}
149 ${dependent_{{ f.options.model | lower }}_id}= Create {{ f.options.model }}
150 ${json_{{ m.name | lower}}_tmp}= Set Json Value ${json_{{ m.name | lower }}_tmp} /{{ f.name }}_id ${dependent_{{ f.options.model | lower }}_id}
151 {% endif -%}
152 {% endif -%}
153 {% else -%}
154 {% if f.modifier == "required" -%}
155 {% if f.options.blank == "False" -%}
156 {% if not f.options.default -%}
Kailash Khalasi1470fc32018-08-09 13:09:11 -0700157 {% if m.name == "User" and f.name == "email" -%}
158 ${json_user_email_tmp}= Generate Random Value {{ f.type }}
159 ${json_user_email_tmp}= Catenate SEPARATOR= ${json_user_email_tmp} @opencord.org
160 ${json_user_tmp}= Set Json Value ${json_user_tmp} /email "${json_user_email_tmp}"
161 {% else -%}
Kailash Khalasi8416bfe2017-12-20 13:06:37 -0800162 ${json_{{ m.name | lower}}_{{ f.name }}_tmp}= Generate Random Value {{ f.type }}
163 ${json_{{ m.name | lower}}_tmp}= Set Json Value ${json_{{ m.name | lower }}_tmp} /{{ f.name }} "${json_{{ m.name | lower}}_{{ f.name }}_tmp}"
164 {% endif -%}
165 {% endif -%}
166 {% endif -%}
167 {% endif -%}
Kailash Khalasi1470fc32018-08-09 13:09:11 -0700168 {% endif -%}
Kailash Khalasi8416bfe2017-12-20 13:06:37 -0800169 {% endfor -%}
170 {% if m.name == "Site" -%}
171 ${json_{{ m.name | lower}}_login_base_tmp}= Set Variable testloginbase
172 ${json_{{ m.name | lower}}_tmp}= Set Json Value ${json_{{ m.name | lower }}_tmp} /login_base "${json_{{ m.name | lower }}_login_base_tmp}"
173 {% endif %}
174 {% if m.name == "Slice" -%}
175 ${json_{{ m.name | lower}}_name}= Generate Random Slice Name
176 ${json_{{ m.name | lower}}_tmp}= Set Json Value ${json_{{ m.name | lower }}_tmp} /name "${json_{{ m.name | lower }}_name}"
177 {% endif %}
178 {% if m.name == "Network" -%}
179 ${json_{{ m.name | lower}}_tmp}= Set Json Value ${json_{{ m.name | lower }}_tmp} /permit_all_slices true
180 {% endif %}
181 ${json_{{ m.name | lower }}_tmp}= To JSON ${json_{{ m.name | lower }}_tmp}
182 ${resp}= CORD Post /xosapi/v1/${xos_service}/{{ m.name | lower}}s ${json_{{ m.name | lower }}_tmp}
183 ${id_{{ m.name | lower }}_tmp}= Get Json Value ${resp.content} /id
184 Append To List ${dependent_{{ m.name | lower }}_ids} ${id_{{ m.name | lower }}_tmp}
185 [Return] ${id_{{ m.name | lower }}_tmp}
186{% endif %}
187{% endfor -%}
188
189Setup
190 {% for m in proto.messages %}
191 {%- if m.name not in ['XOSBase'] -%}
192 ${model}= Set Variable {{ m.name | lower }}s
193 @{dependent_{{ m.name | lower }}_ids}= Create List ${model}
194 Set Suite Variable @{dependent_{{ m.name | lower }}_ids}
195 {% endif %}
196 {% endfor -%}
197 @{dependent_models}= Create List
198 Set Suite Variable ${dependent_models}
Kailash Khalasi68f9f632018-04-11 08:09:19 -0700199 ${auth} = Create List ${XOS_USER} ${XOS_PASSWD}
Kailash Khalasi8416bfe2017-12-20 13:06:37 -0800200 ${HEADERS} Create Dictionary Content-Type=application/json
201 Create Session ${SERVER_IP} http://${SERVER_IP}:${SERVER_PORT} auth=${AUTH} headers=${HEADERS}
202 Generate JSON Data
203
204Teardown
205 {% for m in proto.messages %}
206 {%- if m.name not in ['XOSBase'] -%}
207 ${len}= Get Length ${dependent_{{ m.name | lower }}_ids}
208 : FOR ${INDEX} IN RANGE 1 ${len}
209 \ Run Keyword And Ignore Error CORD Delete /xosapi/v1/${xos_service}/${dependent_{{ m.name | lower }}_ids[0]} ${dependent_{{ m.name | lower }}_ids[${INDEX}]}
210 {% endif %}
211 {% endfor -%}
Kailash Khalasi9302c182018-05-07 13:46:15 -0600212 Delete All Sessions
Kailash Khalasi1470fc32018-08-09 13:09:11 -0700213