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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
##############################################################################
# Copyright 2018 EuropeanSoftwareMarketingLtd.
# ===================================================================
# Licensed under the ApacheLicense, Version2.0 (the"License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
#
# software distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and limitations under
# the License
##############################################################################
from __future__ import absolute_import
import copy
import json
import logging
import time
import yaml
from vnftest.common import constants as consts, utils
from vnftest.common import rest_client
from vnftest.common.exceptions import MandatoryKeyException, InputParameterMissing
from vnftest.crawlers.base import Crawler
from vnftest.steps import base
import jinja2
import jinja2.meta
LOG = logging.getLogger(__name__)
class RestCall(base.Step):
"""Call REST API
"""
__step_type__ = "RestCall"
def __init__(self, step_cfg, context, input_params):
self.step_cfg = step_cfg
self.context = context
self.input_params = input_params
self.input_cfg = None
self.output_cfg = None
self.rest_def_file = None
self.delay = None
self.setup_done = False
def setup(self):
options = self.step_cfg['options']
self.rest_def_file = options.get("file")
self.delay = options.get("delay", 0)
self.input_cfg = options.get("input", {})
self.output_cfg = options.get("output", {})
self.sla_cfg = self.step_cfg.get('sla', {'retries': 0})
self.setup_done = True
def eval_input(self, params):
for input_parameter in self.input_cfg:
param_name = input_parameter['parameter_name']
value = None
if 'value' in input_parameter:
value_def = input_parameter['value']
value = utils.format(value_def, self.input_params)
if value is None or value == "":
raise InputParameterMissing(param_name=param_name, source="task configuration")
params[param_name] = value
def run(self, result, attempt=0):
LOG.info("** Handling: " + str(self.rest_def_file))
output = self.run_impl(result)
try:
self.handle_sla(output)
except AssertionError as e:
LOG.info(str(e))
if attempt < self.sla_cfg['retries']:
time.sleep(self.sla_cfg['interval'])
LOG.info("retry operation")
attempt = attempt + 1
return self.run(result, attempt)
else:
raise e
return output
def run_impl(self, result):
if not self.setup_done:
self.setup()
params = {}
params.update(copy.deepcopy(self.input_params))
self.eval_input(params)
execution_result = self.execute_operation(params)
output = Crawler.crawl(execution_result, self.output_cfg)
result.update(output)
return output
def execute_operation(self, params, attempt=0):
if self.delay > 0:
time.sleep(self.delay)
try:
return self.execute_operation_impl(params)
except Exception as e:
LOG.info(str(e))
if attempt < 3:
time.sleep(15)
LOG.info("############# retry operation ##########")
attempt = attempt + 1
return self.execute_operation(params, attempt)
else:
raise e
def execute_operation_impl(self, params):
operation = self.load_file(params)
url = operation['url']
headers = operation.get('headers', {}) or {}
body = operation.get('body', {}) or {}
LOG.info(url)
LOG.info(headers)
LOG.info(body)
if 'form-data' in operation:
form_data_content = {}
form_data_list = operation['form-data']
for form_data_item in form_data_list:
key = form_data_item['key']
if 'file' in form_data_item:
form_data_content[key] = utils.load_resource(form_data_item['file'])
else:
value_str = json.dumps(form_data_item['value'])
form_data_content[key] = value_str
result = rest_client.form_data(url, headers, form_data_content)
else:
result = rest_client.call(url,
operation['method'],
headers,
body)
if result['return_code'] >= 300:
raise RuntimeError(
"Operation failed. return_code:{}, message:{}".format(result['return_code'], result['body']))
LOG.info("Results: " + str(result))
return result
def handle_sla(self, output):
if self.sla_cfg.get('action', "") == 'assert' and 'equals' in self.sla_cfg:
value_def = self.sla_cfg['value']
value = utils.format(value_def, output)
expected_value = self.sla_cfg['equals']
assert value == expected_value, "expected: %s, found: %s" % (expected_value, value)
def load_file(self, params):
operation_template = utils.resource_as_string(self.rest_def_file)
operation = jinja2.Template(operation_template).render(**params)
return yaml.load(operation)
|
