aboutsummaryrefslogtreecommitdiffstats
path: root/yardstick/benchmark/scenarios/networking/ping.py
blob: 6caeab5eff14b5b2e2cdaca18d592153cfb9e63b (plain)
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
##############################################################################
# Copyright (c) 2015 Ericsson AB and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################

# ping scenario

from __future__ import print_function
from __future__ import absolute_import
import pkg_resources
import logging

import yardstick.ssh as ssh
from yardstick.common import utils
from yardstick.benchmark.scenarios import base

LOG = logging.getLogger(__name__)


class Ping(base.Scenario):
    """Execute ping between two hosts

    If ping error, RTT will be set to 999999

  Parameters
    packetsize - number of data bytes to send
        type:    int
        unit:    bytes
        default: 56
    """

    __scenario_type__ = "Ping"

    PING_ERROR_RTT = 999999

    TARGET_SCRIPT = 'ping_benchmark.bash'

    def __init__(self, scenario_cfg, context_cfg):
        self.scenario_cfg = scenario_cfg
        self.context_cfg = context_cfg
        self.target_script = pkg_resources.resource_filename(
            'yardstick.benchmark.scenarios.networking', Ping.TARGET_SCRIPT)
        host = self.context_cfg['host']

        self.connection = ssh.SSH.from_node(host, defaults={"user": "ubuntu"})

        self.connection.wait(timeout=600)

    def run(self, result):
        """execute the benchmark"""

        if "options" in self.scenario_cfg:
            options = "-s %s" % \
                self.scenario_cfg['options'].get("packetsize", '56')
        else:
            options = ""

        destination = self.context_cfg['target'].get('ipaddr', '127.0.0.1')
        dest_list = [s.strip() for s in destination.split(',')]

        rtt_result = {}
        ping_result = {"rtt": rtt_result}
        sla_max_rtt = self.scenario_cfg.get("sla", {}).get("max_rtt")

        for pos, dest in enumerate(dest_list):
            if 'targets' in self.scenario_cfg:
                target_vm = self.scenario_cfg['targets'][pos]
            else:
                target_vm = self.scenario_cfg['target']

            LOG.debug("ping %s %s", options, dest)
            with open(self.target_script, "r") as stdin_file:
                exit_status, stdout, stderr = self.connection.execute(
                    "/bin/sh -s {0} {1}".format(dest, options),
                    stdin=stdin_file)

            if exit_status != 0:
                raise RuntimeError(stderr)

            if isinstance(target_vm, dict):
                target_vm_name = target_vm.get("name")
            else:
                target_vm_name = target_vm.split('.')[0]
            if stdout:
                rtt_result[target_vm_name] = float(stdout.strip())
                # store result before potential AssertionError
                result.update(utils.flatten_dict_key(ping_result))
                if sla_max_rtt is not None:
                    sla_max_rtt = float(sla_max_rtt)
                    self.verify_SLA(
                        rtt_result[target_vm_name] <= sla_max_rtt,
                        "rtt %f > sla: max_rtt(%f); "
                        % (rtt_result[target_vm_name], sla_max_rtt))
            else:
                LOG.error("ping '%s' '%s' timeout", options, target_vm)
                # we need to specify a result to satisfy influxdb schema
                # choose a very large number to inidcate timeout
                # in this case choose an order of magnitude greater than the SLA
                rtt_result[target_vm_name] = float(self.PING_ERROR_RTT)
                # store result before potential AssertionError
                result.update(utils.flatten_dict_key(ping_result))
                self.verify_SLA(sla_max_rtt is None,
                                "packet dropped rtt %f > sla: max_rtt(%f)"
                                % (rtt_result[target_vm_name], sla_max_rtt))
                self.verify_SLA(False,
                                "packet dropped rtt %f"
                                % (rtt_result[target_vm_name]))


def _test():    # pragma: no cover
    """internal test function"""
    key_filename = pkg_resources.resource_filename("yardstick.resources",
                                                   "files/yardstick_key")
    ctx = {
        "host": {
            "ip": "10.229.47.137",
            "user": "root",
            "key_filename": key_filename
        },
        "target": {
            "ipaddr": "10.229.17.105",
        }
    }

    logger = logging.getLogger("yardstick")
    logger.setLevel(logging.DEBUG)

    args = {}
    result = {}

    p = Ping(args, ctx)
    p.run(result)
    print(result)


if __name__ == '__main__':    # pragma: no cover
    _test()