aboutsummaryrefslogtreecommitdiffstats
path: root/yardstick/benchmark/scenarios/networking/netperf_node.py
blob: d52e6b9e1d733c48cb877ac6329804d9d4699049 (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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
##############################################################################
# Copyright (c) 2016 Huawei Technologies Co.,Ltd 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
##############################################################################
# bulk data test and req/rsp test are supported
from __future__ import absolute_import
from __future__ import print_function

import logging

import pkg_resources
from oslo_serialization import jsonutils

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

LOG = logging.getLogger(__name__)


class NetperfNode(base.Scenario):
    """Execute netperf between two nodes

  Parameters
    testname - to specify the test you wish to perform.
    the valid testnames are TCP_STREAM, TCP_RR, UDP_STREAM, UDP_RR
        type:    string
        unit:    na
        default: TCP_STREAM
    send_msg_size - value set the local send size to value bytes.
        type:    int
        unit:    bytes
        default: na
    recv_msg_size - setting the receive size for the remote system.
        type:    int
        unit:    bytes
        default: na
    req_rsp_size - set the request and/or response sizes based on sizespec.
        type:    string
        unit:    na
        default: na
    duration - duration of the test
        type:    int
        unit:    seconds
        default: 20

    read link below for more netperf args description:
    http://www.netperf.org/netperf/training/Netperf.html
    """
    __scenario_type__ = "NetperfNode"
    TARGET_SCRIPT = 'netperf_benchmark.bash'
    INSTALL_SCRIPT = 'netperf_install.bash'
    REMOVE_SCRIPT = 'netperf_remove.bash'

    def __init__(self, scenario_cfg, context_cfg):
        self.scenario_cfg = scenario_cfg
        self.context_cfg = context_cfg
        self.setup_done = False

    def setup(self):
        """scenario setup"""
        self.target_script = pkg_resources.resource_filename(
            'yardstick.benchmark.scenarios.networking',
            NetperfNode.TARGET_SCRIPT)
        host = self.context_cfg['host']
        target = self.context_cfg['target']
        self.target_ip = target['ip']

        # netserver start automatically during the vm boot
        LOG.info("user:%s, target:%s", target['user'], target['ip'])
        self.server = ssh.SSH.from_node(target, defaults={"user": "ubuntu"})
        self.server.wait(timeout=600)

        LOG.info("user:%s, host:%s", host['user'], host['ip'])
        self.client = ssh.SSH.from_node(host, defaults={"user": "ubuntu"})
        self.client.wait(timeout=600)

        # copy script to host
        with open(self.target_script, "rb") as file_run:
            self.client.run("cat > ~/netperf.sh", stdin=file_run)
        # copy script to host and client
        self.install_script = pkg_resources.resource_filename(
            'yardstick.benchmark.scenarios.networking',
            NetperfNode.INSTALL_SCRIPT)
        self.remove_script = pkg_resources.resource_filename(
            'yardstick.benchmark.scenarios.networking',
            NetperfNode.REMOVE_SCRIPT)

        with open(self.install_script, "rb") as file_install:
            self.server.run("cat > ~/netperf_install.sh", stdin=file_install)
        with open(self.install_script, "rb") as file_install:
            self.client.run("cat > ~/netperf_install.sh", stdin=file_install)
        with open(self.remove_script, "rb") as file_remove:
            self.server.run("cat > ~/netperf_remove.sh", stdin=file_remove)
        with open(self.remove_script, "rb") as file_remove:
            self.client.run("cat > ~/netperf_remove.sh", stdin=file_remove)
        self.server.execute("sudo bash netperf_install.sh")
        self.client.execute("sudo bash netperf_install.sh")

        self.setup_done = True

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

        if not self.setup_done:
            self.setup()

        # get global options
        ipaddr = self.context_cfg['target'].get("ipaddr", '127.0.0.1')
        ipaddr = self.target_ip
        options = self.scenario_cfg['options']
        testname = options.get("testname", 'TCP_STREAM')
        duration_time = self.scenario_cfg["runner"].get("duration", None) \
            if "runner" in self.scenario_cfg else None
        arithmetic_time = options.get("duration", None)
        if duration_time:
            testlen = duration_time
        elif arithmetic_time:
            testlen = arithmetic_time
        else:
            testlen = 20

        cmd_args = "-H %s -l %s -t %s -c -C" % (ipaddr, testlen, testname)

        # get test specific options
        output_opt = options.get(
            "output_opt", "THROUGHPUT,THROUGHPUT_UNITS,MEAN_LATENCY")
        default_args = "-O %s" % output_opt
        cmd_args += " -- %s" % default_args
        option_pair_list = [("send_msg_size", "-m"),
                            ("recv_msg_size", "-M"),
                            ("req_rsp_size", "-r")]
        for option_pair in option_pair_list:
            if option_pair[0] in options:
                cmd_args += " %s %s" % (option_pair[1],
                                        options[option_pair[0]])

        cmd = "sudo bash netperf.sh %s" % (cmd_args)
        LOG.debug("Executing command: %s", cmd)
        status, stdout, stderr = self.client.execute(cmd)

        if status:
            raise RuntimeError(stderr)

        result.update(jsonutils.loads(stdout))

        if result['mean_latency'] == '':
            raise RuntimeError(stdout)

        # sla check
        mean_latency = float(result['mean_latency'])
        if "sla" in self.scenario_cfg:
            sla_max_mean_latency = int(
                self.scenario_cfg["sla"]["mean_latency"])

            assert mean_latency <= sla_max_mean_latency, \
                "mean_latency %f > sla_max_mean_latency(%f); " % \
                (mean_latency, sla_max_mean_latency)

    def teardown(self):
        """remove netperf from nodes after test"""
        self.server.execute("sudo bash netperf_remove.sh")
        self.client.execute("sudo bash netperf_remove.sh")


def _test():    # pragma: no cover
    """internal test function"""
    ctx = {
        "host": {
            "ip": "192.168.10.10",
            "user": "root",
            "password": "root"
        },
        "target": {
            "ip": "192.168.10.11",
            "user": "root",
            "password": "root"
        }
    }

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

    options = {
        "testname": 'TCP_STREAM'
    }

    args = {"options": options}
    result = {}

    netperf = NetperfNode(args, ctx)
    netperf.run(result)
    print(result)


if __name__ == '__main__':
    _test()