2 # -*- coding: UTF-8 -*-
4 # Copyright (c) 2017 Orange and others.
6 # All rights reserved. This program and the accompanying materials
7 # are made available under the terms of the Apache License, Version 2.0
8 # which accompanies this distribution, and is available at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 """This module manages calls to Energy recording API."""
16 from functools import wraps
18 from six.moves import urllib
20 from functest.utils.constants import CONST
21 import functest.utils.functest_utils as ft_utils
24 def finish_session(current_scenario):
25 """Finish a recording session."""
26 if current_scenario is None:
29 EnergyRecorder.logger.debug("Restoring previous scenario (%s/%s)",
30 current_scenario["scenario"],
31 current_scenario["step"])
32 EnergyRecorder.submit_scenario(
33 current_scenario["scenario"],
34 current_scenario["step"]
38 def enable_recording(method):
40 Record energy during method execution.
42 Decorator to record energy during "method" exection.
44 param method: Method to suround with start and stop
45 :type method: function
47 .. note:: "method" should belong to a class having a "case_name"
53 Record energy during method execution (implementation).
55 Wrapper for decorator to handle method arguments.
57 current_scenario = EnergyRecorder.get_current_scenario()
58 EnergyRecorder.start(args[0].case_name)
60 return_value = method(*args)
61 finish_session(current_scenario)
62 except Exception as exc: # pylint: disable=broad-except
63 EnergyRecorder.logger.exception(exc)
64 finish_session(current_scenario)
70 # Class to manage energy recording sessions
71 class EnergyRecorder(object):
72 """Manage Energy recording session."""
74 logger = logging.getLogger(__name__)
75 # Energy recording API connectivity settings
76 # see load_config method
77 energy_recorder_api = None
79 # Default initial step
80 INITIAL_STEP = "running"
82 # Default connection timeout
83 CONNECTION_TIMEOUT = 4
88 Load connectivity settings from yaml.
90 Load connectivity settings to Energy recording API
91 Use functest global config yaml file
92 (see functest_utils.get_functest_config)
94 # Singleton pattern for energy_recorder_api static member
95 # Load only if not previouly done
96 if EnergyRecorder.energy_recorder_api is None:
97 environment = CONST.__getattribute__('NODE_NAME')
100 energy_recorder_uri = ft_utils.get_functest_config(
101 "energy_recorder.api_url")
102 assert energy_recorder_uri
105 uri_comp = "/recorders/environment/"
106 uri_comp += urllib.parse.quote_plus(environment)
109 creds_usr = ft_utils.get_functest_config(
110 "energy_recorder.api_user")
111 creds_pass = ft_utils.get_functest_config(
112 "energy_recorder.api_password")
114 if creds_usr != "" and creds_pass != "":
115 energy_recorder_api_auth = (creds_usr, creds_pass)
117 energy_recorder_api_auth = None
120 resp = requests.get(energy_recorder_uri + "/monitoring/ping",
121 auth=energy_recorder_api_auth,
123 'content-type': 'application/json'
125 timeout=EnergyRecorder.CONNECTION_TIMEOUT)
126 api_available = json.loads(resp.text)["status"] == "OK"
127 EnergyRecorder.logger.info(
128 "API recorder available at : %s",
129 energy_recorder_uri + uri_comp)
130 except Exception as exc: # pylint: disable=broad-except
131 EnergyRecorder.logger.info(
132 "Energy recorder API is not available, cause=%s",
134 api_available = False
136 EnergyRecorder.energy_recorder_api = {
137 "uri": energy_recorder_uri + uri_comp,
138 "auth": energy_recorder_api_auth,
139 "available": api_available
141 return EnergyRecorder.energy_recorder_api["available"]
144 def submit_scenario(scenario, step):
146 Submit a complet scenario definition to Energy recorder API.
148 param scenario: Scenario name
149 :type scenario: string
150 param step: Step name
155 # Ensure that connectyvity settings are loaded
156 if EnergyRecorder.load_config():
157 EnergyRecorder.logger.debug("Submitting scenario (%s/%s)",
165 # Call API to start energy recording
166 response = requests.post(
167 EnergyRecorder.energy_recorder_api["uri"],
168 data=json.dumps(payload),
169 auth=EnergyRecorder.energy_recorder_api["auth"],
171 'content-type': 'application/json'
173 timeout=EnergyRecorder.CONNECTION_TIMEOUT
175 if response.status_code != 200:
176 EnergyRecorder.logger.error(
177 "Error while submitting scenario\n%s",
179 return_status = False
180 except requests.exceptions.ConnectionError:
181 EnergyRecorder.logger.warning(
182 "submit_scenario: Unable to connect energy recorder API")
183 return_status = False
184 except Exception: # pylint: disable=broad-except
185 # Default exception handler to ensure that method
187 EnergyRecorder.logger.exception(
188 "Error while submitting scenarion to energy recorder API"
190 return_status = False
196 Start a recording session for scenario.
198 param scenario: Starting scenario
199 :type scenario: string
203 if EnergyRecorder.load_config():
204 EnergyRecorder.logger.debug("Starting recording")
205 return_status = EnergyRecorder.submit_scenario(
207 EnergyRecorder.INITIAL_STEP
210 except Exception: # pylint: disable=broad-except
211 # Default exception handler to ensure that method
213 EnergyRecorder.logger.exception(
214 "Error while starting energy recorder API"
216 return_status = False
221 """Stop current recording session."""
224 # Ensure that connectyvity settings are loaded
225 if EnergyRecorder.load_config():
226 EnergyRecorder.logger.debug("Stopping recording")
228 # Call API to stop energy recording
229 response = requests.delete(
230 EnergyRecorder.energy_recorder_api["uri"],
231 auth=EnergyRecorder.energy_recorder_api["auth"],
233 'content-type': 'application/json'
235 timeout=EnergyRecorder.CONNECTION_TIMEOUT
237 if response.status_code != 200:
238 EnergyRecorder.logger.error(
239 "Error while stating energy recording session\n%s",
241 return_status = False
242 except requests.exceptions.ConnectionError:
243 EnergyRecorder.logger.warning(
244 "stop: Unable to connect energy recorder API")
245 return_status = False
246 except Exception: # pylint: disable=broad-except
247 # Default exception handler to ensure that method
249 EnergyRecorder.logger.exception(
250 "Error while stoping energy recorder API"
252 return_status = False
257 """Notify energy recording service of current step of the testcase."""
260 # Ensure that connectyvity settings are loaded
261 if EnergyRecorder.load_config():
262 EnergyRecorder.logger.debug("Setting step")
269 # Call API to define step
270 response = requests.post(
271 EnergyRecorder.energy_recorder_api["uri"] + "/step",
272 data=json.dumps(payload),
273 auth=EnergyRecorder.energy_recorder_api["auth"],
275 'content-type': 'application/json'
277 timeout=EnergyRecorder.CONNECTION_TIMEOUT
279 if response.status_code != 200:
280 EnergyRecorder.logger.error(
281 "Error while setting current step of testcase\n%s",
283 return_status = False
284 except requests.exceptions.ConnectionError:
285 EnergyRecorder.logger.warning(
286 "set_step: Unable to connect energy recorder API")
287 return_status = False
288 except Exception: # pylint: disable=broad-except
289 # Default exception handler to ensure that method
291 EnergyRecorder.logger.exception(
292 "Error while setting step on energy recorder API"
294 return_status = False
298 def get_current_scenario():
299 """Get current running scenario (if any, None else)."""
302 # Ensure that connectyvity settings are loaded
303 if EnergyRecorder.load_config():
304 EnergyRecorder.logger.debug("Getting current scenario")
306 # Call API get running scenario
307 response = requests.get(
308 EnergyRecorder.energy_recorder_api["uri"],
309 auth=EnergyRecorder.energy_recorder_api["auth"],
310 timeout=EnergyRecorder.CONNECTION_TIMEOUT
312 if response.status_code == 200:
313 return_value = json.loads(response.text)
314 elif response.status_code == 404:
315 EnergyRecorder.logger.info(
316 "No current running scenario at %s",
317 EnergyRecorder.energy_recorder_api["uri"])
320 EnergyRecorder.logger.error(
321 "Error while getting current scenario\n%s",
324 except requests.exceptions.ConnectionError:
325 EnergyRecorder.logger.warning(
326 "get_currernt_sceario: Unable to connect energy recorder API")
328 except Exception: # pylint: disable=broad-except
329 # Default exception handler to ensure that method
331 EnergyRecorder.logger.exception(
332 "Error while getting current scenario from energy recorder API"