Merge "Point to user guide to get started on VNF testing"
[yardstick.git] / yardstick / benchmark / scenarios / networking / ping.py
1 ##############################################################################
2 # Copyright (c) 2015 Ericsson AB and others.
3 #
4 # All rights reserved. This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
7 # http://www.apache.org/licenses/LICENSE-2.0
8 ##############################################################################
9
10 # ping scenario
11
12 from __future__ import print_function
13 from __future__ import absolute_import
14 import pkg_resources
15 import logging
16
17 import yardstick.ssh as ssh
18 from yardstick.benchmark.scenarios import base
19
20 LOG = logging.getLogger(__name__)
21
22
23 class Ping(base.Scenario):
24     """Execute ping between two hosts
25
26   Parameters
27     packetsize - number of data bytes to send
28         type:    int
29         unit:    bytes
30         default: 56
31     """
32
33     __scenario_type__ = "Ping"
34
35     TARGET_SCRIPT = 'ping_benchmark.bash'
36
37     def __init__(self, scenario_cfg, context_cfg):
38         self.scenario_cfg = scenario_cfg
39         self.context_cfg = context_cfg
40         self.target_script = pkg_resources.resource_filename(
41             'yardstick.benchmark.scenarios.networking', Ping.TARGET_SCRIPT)
42         host = self.context_cfg['host']
43
44         self.connection = ssh.SSH.from_node(host, defaults={"user": "ubuntu"})
45
46         self.connection.wait(timeout=600)
47
48     def run(self, result):
49         """execute the benchmark"""
50
51         if "options" in self.scenario_cfg:
52             options = "-s %s" % \
53                 self.scenario_cfg['options'].get("packetsize", '56')
54         else:
55             options = ""
56
57         destination = self.context_cfg['target'].get('ipaddr', '127.0.0.1')
58         dest_list = [s.strip() for s in destination.split(',')]
59
60         result["rtt"] = {}
61         rtt_result = result["rtt"]
62
63         for pos, dest in enumerate(dest_list):
64             if 'targets' in self.scenario_cfg:
65                 target_vm = self.scenario_cfg['targets'][pos]
66             else:
67                 target_vm = self.scenario_cfg['target']
68
69             LOG.debug("ping '%s' '%s'", options, dest)
70             with open(self.target_script, "r") as stdin_file:
71                 exit_status, stdout, stderr = self.connection.execute(
72                     "/bin/sh -s {0} {1}".format(dest, options),
73                     stdin=stdin_file)
74
75             if exit_status != 0:
76                 raise RuntimeError(stderr)
77
78             if stdout:
79                 target_vm_name = target_vm.split('.')[0]
80                 rtt_result[target_vm_name] = float(stdout)
81                 if "sla" in self.scenario_cfg:
82                     sla_max_rtt = int(self.scenario_cfg["sla"]["max_rtt"])
83                     assert rtt_result[target_vm_name] <= sla_max_rtt,\
84                         "rtt %f > sla: max_rtt(%f); " % \
85                         (rtt_result[target_vm_name], sla_max_rtt)
86             else:
87                 LOG.error("ping '%s' '%s' timeout", options, target_vm)
88
89
90 def _test():    # pragma: no cover
91     """internal test function"""
92     key_filename = pkg_resources.resource_filename("yardstick.resources",
93                                                    "files/yardstick_key")
94     ctx = {
95         "host": {
96             "ip": "10.229.47.137",
97             "user": "root",
98             "key_filename": key_filename
99         },
100         "target": {
101             "ipaddr": "10.229.17.105",
102         }
103     }
104
105     logger = logging.getLogger("yardstick")
106     logger.setLevel(logging.DEBUG)
107
108     args = {}
109     result = {}
110
111     p = Ping(args, ctx)
112     p.run(result)
113     print(result)
114
115
116 if __name__ == '__main__':    # pragma: no cover
117     _test()