2 # Copyright 2017 Cisco Systems, Inc. All rights reserved.
4 # Licensed under the Apache License, Version 2.0 (the "License"); you may
5 # not use this file except in compliance with the License. You may obtain
6 # a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 # License for the specific language governing permissions and limitations
17 from flask import Flask
18 from flask import jsonify
19 from flask import render_template
20 from flask import request
22 from flask_socketio import emit
23 from flask_socketio import SocketIO
28 from utils import byteify
29 from utils import RunLock
32 # this global cannot reside in Ctx because of the @app and @socketio decorators
37 STATUS_ERROR = 'ERROR'
38 STATUS_PENDING = 'PENDING'
39 STATUS_NOT_FOUND = 'NOT_FOUND'
42 def result_json(status, message, request_id=None):
45 'error_message': message
48 if request_id is not None:
49 body['request_id'] = request_id
55 return json.loads(json.dumps(data), object_hook=byteify)
59 return uuid.uuid4().hex
64 run_queue = Queue.Queue()
67 request_from_socketio = False
73 def enqueue(config, request_id, from_socketio=False):
75 Ctx.request_from_socketio = from_socketio
76 config['request_id'] = request_id
77 Ctx.run_queue.put(config)
79 if len(Ctx.ids) >= Ctx.MAXLEN:
81 del Ctx.results[Ctx.ids.pop(0)]
84 Ctx.ids.append(request_id)
88 config = Ctx.run_queue.get()
89 Ctx.current_id = config['request_id']
99 res['request_id'] = Ctx.current_id
100 Ctx.results[Ctx.current_id] = res
104 def get_result(request_id=None):
107 res = Ctx.results[request_id]
111 if Ctx.result and request_id == Ctx.result['request_id']:
126 def get_current_request_id():
127 return Ctx.current_id
130 def setup_flask(root_path):
133 app = Flask(__name__)
134 app.root_path = root_path
135 socketio = SocketIO(app, async_mode='threading')
136 busy_json = result_json(STATUS_ERROR, 'there is already an NFVbench request running')
137 not_busy_json = result_json(STATUS_ERROR, 'no pending NFVbench run')
138 not_found_msg = 'results not found'
139 pending_msg = 'NFVbench run still pending'
141 # --------- socketio requests ------------
143 @socketio.on('start_run')
144 def socketio_start_run(config):
145 if not Ctx.is_busy():
146 Ctx.enqueue(config, get_uuid(), from_socketio=True)
148 emit('error', {'reason': 'there is already an NFVbench request running'})
151 def socketio_echo(config):
154 # --------- HTTP requests ------------
158 return render_template('index.html')
160 @app.route('/echo', methods=['GET'])
162 config = request.json
163 return jsonify(config)
165 @app.route('/start_run', methods=['POST'])
167 config = load_json(request.json)
169 return jsonify(busy_json)
171 request_id = get_uuid()
172 Ctx.enqueue(config, request_id)
173 return jsonify(result_json(STATUS_PENDING, pending_msg, request_id))
175 @app.route('/status', defaults={'request_id': None}, methods=['GET'])
176 @app.route('/status/<request_id>', methods=['GET'])
177 def get_status(request_id):
179 if Ctx.is_busy() and request_id == Ctx.get_current_request_id():
180 # task with request_id still pending
181 return jsonify(result_json(STATUS_PENDING, pending_msg, request_id))
183 res = Ctx.get_result(request_id)
185 # found result for given request_id
188 # result for given request_id not found
189 return jsonify(result_json(STATUS_NOT_FOUND, not_found_msg, request_id))
192 # task still pending, return with request_id
193 return jsonify(result_json(STATUS_PENDING,
195 Ctx.get_current_request_id()))
197 res = Ctx.get_result()
201 return jsonify(not_busy_json)
204 class WebSocketIoServer(object):
205 """This class takes care of the web socketio server, accepts websocket events, and sends back
206 notifications using websocket events (send_ methods). Caller should simply create an instance
207 of this class and pass a runner object then invoke the run method
209 def __init__(self, http_root, runner):
210 self.nfvbench_runner = runner
211 setup_flask(http_root)
213 def run(self, host='127.0.0.1', port=7556):
215 # socketio.run will not return so we need to run it in a background thread so that
216 # the calling thread (main thread) can keep doing work
217 socketio.start_background_task(target=socketio.run, app=app, host=host, port=port)
219 # wait for run requests
220 # the runner must be executed from the main thread (Trex client library requirement)
222 # print 'main thread waiting for requests...'
223 config = Ctx.dequeue()
224 # print 'main thread processing request...'
227 # remove unfilled values as we do not want them to override default values with None
228 config = {k: v for k, v in config.items() if v is not None}
230 results = self.nfvbench_runner.run(config)
231 except Exception as exc:
232 print 'NFVbench runner exception:'
233 traceback.print_exc()
234 results = result_json(STATUS_ERROR, str(exc))
236 if Ctx.request_from_socketio:
237 socketio.emit('run_end', results)
239 # this might overwrite a previously unfetched result
240 Ctx.set_result(results)
243 def send_interval_stats(self, time_ms, tx_pps, rx_pps, drop_pct):
244 stats = {'time_ms': time_ms, 'tx_pps': tx_pps, 'rx_pps': rx_pps, 'drop_pct': drop_pct}
245 socketio.emit('run_interval_stats', stats)
247 def send_ndr_found(self, ndr_pps):
248 socketio.emit('ndr_found', {'rate_pps': ndr_pps})
250 def send_pdr_found(self, pdr_pps):
251 socketio.emit('pdr_found', {'rate_pps': pdr_pps})