aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/python/TrafficGenerator.py
blob: 5dab8b98d5345a72f5e1d865e83887426d5bbc4b (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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
# Copyright (c) 2016 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Performance testing traffic generator library."""

from robot.api import logger
from robot.libraries.BuiltIn import BuiltIn

from resources.libraries.python.ssh import SSH
from resources.libraries.python.topology import NodeType
from resources.libraries.python.topology import NodeSubTypeTG
from resources.libraries.python.topology import Topology
from resources.libraries.python.DropRateSearch import DropRateSearch

__all__ = ['TrafficGenerator', 'TGDropRateSearchImpl']


class TGDropRateSearchImpl(DropRateSearch):
    """Drop Rate Search implementation."""

    def __init__(self):
        super(TGDropRateSearchImpl, self).__init__()

    def measure_loss(self, rate, frame_size, loss_acceptance,
                     loss_acceptance_type, traffic_type):

        # we need instance of TrafficGenerator instantiated by Robot Framework
        # to be able to use trex_stl-*()
        tg_instance = BuiltIn().get_library_instance(
            'resources.libraries.python.TrafficGenerator')

        if tg_instance._node['subtype'] is None:
            raise Exception('TG subtype not defined')
        elif tg_instance._node['subtype'] == NodeSubTypeTG.TREX:
            unit_rate = str(rate) + self.get_rate_type_str()
            tg_instance.trex_stl_start_remote_exec(self.get_duration(),
                                                   unit_rate, frame_size,
                                                   traffic_type, False)
            loss = tg_instance.get_loss()
            sent = tg_instance.get_sent()
            if self.loss_acceptance_type_is_percentage():
                loss = (float(loss) / float(sent)) * 100

            # TODO: getters for tg_instance
            logger.trace("comparing: {} < {} {}".format(loss,
                                                        loss_acceptance,
                                                        loss_acceptance_type))
            if float(loss) > float(loss_acceptance):
                return False
            else:
                return True
        else:
            raise NotImplementedError("TG subtype not supported")


class TrafficGenerator(object):
    """Traffic Generator."""

    # use one instance of TrafficGenerator for all tests in test suite
    ROBOT_LIBRARY_SCOPE = 'TEST SUITE'

    def __init__(self):
        self._result = None
        self._loss = None
        self._sent = None
        self._received = None
        self._node = None
        # T-REX interface order mapping
        self._ifaces_reordered = 0

    def get_loss(self):
        """Return number of lost packets.

        :return: Number of lost packets.
        :rtype: str
        """
        return self._loss

    def get_sent(self):
        """Return number of sent packets.

        :return: Number of sent packets.
        :rtype: str
        """
        return self._sent

    def get_received(self):
        """Return number of received packets.

        :return: Number of received packets.
        :rtype: str
        """
        return self._received

    #pylint: disable=too-many-arguments, too-many-locals
    def initialize_traffic_generator(self, tg_node, tg_if1, tg_if2,
                                     dut1_node, dut1_if1, dut1_if2,
                                     dut2_node, dut2_if1, dut2_if2,
                                     test_type):
        """TG initialization.

        :param tg_node: Traffic generator node.
        :param tg_if1: TG - name of first interface.
        :param tg_if2: TG - name of second interface.
        :param dut1_node: DUT1 node.
        :param dut1_if1: DUT1 - name of first interface.
        :param dut1_if2: DUT1 - name of second interface.
        :param dut2_node: DUT2 node.
        :param dut2_if1: DUT2 - name of first interface.
        :param dut2_if2: DUT2 - name of second interface.
        :test_type: 'L2' or 'L3' - src/dst MAC address.
        :type tg_node: dict
        :type tg_if1: str
        :type tg_if2: str
        :type dut1_node: dict
        :type dut1_if1: str
        :type dut1_if2: str
        :type dut2_node: dict
        :type dut2_if1: str
        :type dut2_if2: str
        :type test_type: str
        :return: nothing
        """

        trex_path = "/opt/trex-core-2.00"

        topo = Topology()

        if tg_node['type'] != NodeType.TG:
            raise Exception('Node type is not a TG')
        self._node = tg_node

        if tg_node['subtype'] == NodeSubTypeTG.TREX:
            ssh = SSH()
            ssh.connect(tg_node)

            if1_pci = topo.get_interface_pci_addr(tg_node, tg_if1)
            if2_pci = topo.get_interface_pci_addr(tg_node, tg_if2)
            if1_mac = topo.get_interface_mac(tg_node, tg_if1)
            if2_mac = topo.get_interface_mac(tg_node, tg_if2)

            if test_type == 'L2':
                if1_adj_mac = if2_mac
                if2_adj_mac = if1_mac
            elif test_type == 'L3':
                if1_adj_mac = topo.get_interface_mac(dut1_node, dut1_if1)
                if2_adj_mac = topo.get_interface_mac(dut2_node, dut2_if2)
            else:
                raise Exception("test_type unknown")

            if min(if1_pci, if2_pci) != if1_pci:
                if1_mac, if2_mac = if2_mac, if1_mac
                if1_pci, if2_pci = if2_pci, if1_pci
                if1_adj_mac, if2_adj_mac = if2_adj_mac, if1_adj_mac
                self._ifaces_reordered = 1

            if1_mac_hex = "0x"+if1_mac.replace(":", ",0x")
            if2_mac_hex = "0x"+if2_mac.replace(":", ",0x")
            if1_adj_mac_hex = "0x"+if1_adj_mac.replace(":", ",0x")
            if2_adj_mac_hex = "0x"+if2_adj_mac.replace(":", ",0x")

            (ret, stdout, stderr) = ssh.exec_command(
                "sudo sh -c 'cat << EOF > /etc/trex_cfg.yaml\n"
                "- port_limit      : 2\n"
                "  version         : 2\n"
                "  interfaces      : [\"{}\",\"{}\"]\n"
                "  port_bandwidth_gb : 10\n"
                "  port_info       :\n"
                "          - dest_mac        :   [{}]\n"
                "            src_mac         :   [{}]\n"
                "          - dest_mac        :   [{}]\n"
                "            src_mac         :   [{}]\n"
                "EOF'"\
                .format(if1_pci, if2_pci,
                        if1_adj_mac_hex, if1_mac_hex,
                        if2_adj_mac_hex, if2_mac_hex))
            if int(ret) != 0:
                logger.error("failed to create t-rex config: {}"\
                .format(stdout + stderr))
                raise RuntimeError('trex config generation error')

            (ret, stdout, stderr) = ssh.exec_command(
                "sh -c 'cd {0}/scripts/ && "
                "sudo ./trex-cfg'"\
                .format(trex_path))
            if int(ret) != 0:
                logger.error('trex-cfg failed: {0}'.format(stdout + stderr))
                raise RuntimeError('trex-cfg failed')

            (ret, _, _) = ssh.exec_command(
                "sh -c 'pgrep t-rex && sudo pkill t-rex'")

            (ret, _, _) = ssh.exec_command(
                "sh -c 'cd {0}/scripts/ && "
                "sudo nohup ./t-rex-64 -i -c 7 --iom 0 > /dev/null 2>&1 &'"
                "> /dev/null"\
                .format(trex_path))
            if int(ret) != 0:
                raise RuntimeError('t-rex-64 startup failed')

    @staticmethod
    def teardown_traffic_generator(node):
        """TG teardown.

        :param node: Traffic generator node.
        :type node: dict
        :return: nothing
        """
        if node['type'] != NodeType.TG:
            raise Exception('Node type is not a TG')
        if node['subtype'] == NodeSubTypeTG.TREX:
            ssh = SSH()
            ssh.connect(node)
            (ret, stdout, stderr) = ssh.exec_command(
                "sh -c 'sudo pkill t-rex'")
            if int(ret) != 0:
                logger.error('pkill t-rex failed: {0}'.format(stdout + stderr))
                raise RuntimeError('pkill t-rex failed')

    @staticmethod
    def trex_stl_stop_remote_exec(node):
        """Execute script on remote node over ssh to stop running traffic.

        :param node: T-REX generator node.
        :type node: dict
        :return: Nothing
        """
        ssh = SSH()
        ssh.connect(node)

        (ret, stdout, stderr) = ssh.exec_command(
            "sh -c '/tmp/openvpp-testing/resources/tools/t-rex/"
            "t-rex-stateless-stop.py'")
        logger.trace(ret)
        logger.trace(stdout)
        logger.trace(stderr)

        if int(ret) != 0:
            raise RuntimeError('T-rex stateless runtime error')

    def trex_stl_start_remote_exec(self, duration, rate, framesize,
                                   traffic_type, async_call, warmup_time=5):
        """Execute script on remote node over ssh to start traffic.

        :param duration: Time expresed in seconds for how long to send traffic.
        :param rate: Traffic rate expressed with units (pps, %)
        :param framesize: L2 frame size to send (without padding and IPG).
        :param traffic_type: Traffic profile.
        :param async_call: If enabled then don't wait for all incomming trafic.
        :param warmup_time: Warmup time period.
        :type duration: int
        :type rate: str
        :type framesize: int
        :type traffic_type: str
        :type async_call: bool
        :type warmup_time: int
        :return: Nothing
        """
        ssh = SSH()
        ssh.connect(self._node)

        _p0 = 1
        _p1 = 2
        _async = ""

        if async_call:
            _async = "--async"
        if self._ifaces_reordered != 0:
            _p0, _p1 = _p1, _p0

        if traffic_type in ["3-node-xconnect", "3-node-bridge"]:
            (ret, stdout, stderr) = ssh.exec_command(
                "sh -c '/tmp/openvpp-testing/resources/tools/t-rex/"
                "t-rex-stateless.py "
                "--duration={0} -r {1} -s {2} "
                "--p{3}_src_start_ip 10.10.10.1 "
                "--p{3}_src_end_ip 10.10.10.254 "
                "--p{3}_dst_start_ip 20.20.20.1 "
                "--p{4}_src_start_ip 20.20.20.1 "
                "--p{4}_src_end_ip 20.20.20.254 "
                "--p{4}_dst_start_ip 10.10.10.1 "
                "{5} --warmup_time={6}'".format(duration, rate, framesize, _p0,
                                                _p1, _async, warmup_time),
                timeout=int(duration)+60)
        elif traffic_type in ["3-node-IPv4"]:
            (ret, stdout, stderr) = ssh.exec_command(
                "sh -c '/tmp/openvpp-testing/resources/tools/t-rex/"
                "t-rex-stateless.py "
                "--duration={0} -r {1} -s {2} "
                "--p{3}_src_start_ip 10.10.10.2 "
                "--p{3}_src_end_ip 10.10.10.254 "
                "--p{3}_dst_start_ip 20.20.20.2 "
                "--p{4}_src_start_ip 20.20.20.2 "
                "--p{4}_src_end_ip 20.20.20.254 "
                "--p{4}_dst_start_ip 10.10.10.2 "
                "{5} --warmup_time={6}'".format(duration, rate, framesize, _p0,
                                                _p1, _async, warmup_time),
                timeout=int(duration)+60)
        elif traffic_type in ["3-node-IPv6"]:
            (ret, stdout, stderr) = ssh.exec_command(
                "sh -c '/tmp/openvpp-testing/resources/tools/t-rex/"
                "t-rex-stateless.py "
                "--duration={0} -r {1} -s {2} -6 "
                "--p{3}_src_start_ip 2001:1::2 "
                "--p{3}_src_end_ip 2001:1::FE "
                "--p{3}_dst_start_ip 2001:2::2 "
                "--p{4}_src_start_ip 2001:2::2 "
                "--p{4}_src_end_ip 2001:2::FE "
                "--p{4}_dst_start_ip 2001:1::2 "
                "{5} --warmup_time={6}'".format(duration, rate, framesize, _p0,
                                                _p1, _async, warmup_time),
                timeout=int(duration)+60)
        else:
            raise NotImplementedError('Unsupported traffic type')

        logger.trace(ret)
        logger.trace(stdout)
        logger.trace(stderr)

        if int(ret) != 0:
            raise RuntimeError('T-rex stateless runtime error')
        elif async_call:
            #no result
            self._received = None
            self._sent = None
            self._loss = None
        else:
            # last line from console output
            line = stdout.splitlines()[-1]

            self._result = line
            logger.info('TrafficGen result: {0}'.format(self._result))

            self._received = self._result.split(', ')[1].split('=')[1]
            self._sent = self._result.split(', ')[2].split('=')[1]
            self._loss = self._result.split(', ')[3].split('=')[1]

    def stop_traffic_on_tg(self):
        """Stop all traffic on TG

        :return: Nothing
        """
        if self._node is None:
            raise RuntimeError("TG is not set")
        if self._node['subtype'] == NodeSubTypeTG.TREX:
            self.trex_stl_stop_remote_exec(self._node)

    def send_traffic_on_tg(self, duration, rate, framesize,
                           traffic_type, warmup_time=5, async_call=False):
        """Send traffic from all configured interfaces on TG.

        :param duration: Duration of test traffic generation in seconds.
        :param rate: Offered load per interface (e.g. 1%, 3gbps, 4mpps, ...).
        :param framesize: Frame size (L2) in Bytes.
        :param traffic_type: Traffic profile.
        :type duration: str
        :type rate: str
        :type framesize: str
        :type traffic_type: str
        :return: TG output.
        :rtype: str
        """

        node = self._node
        if node is None:
            raise RuntimeError("TG is not set")

        if node['type'] != NodeType.TG:
            raise Exception('Node type is not a TG')

        if node['subtype'] is None:
            raise Exception('TG subtype not defined')
        elif node['subtype'] == NodeSubTypeTG.TREX:
            self.trex_stl_start_remote_exec(duration, rate, framesize,
                                            traffic_type, async_call,
                                            warmup_time=warmup_time)
        else:
            raise NotImplementedError("TG subtype not supported")

        return self._result

    def no_traffic_loss_occurred(self):
        """Fail if loss occurred in traffic run.

        :return: nothing
        """
        if self._loss is None:
            raise Exception('The traffic generation has not been issued')
        if self._loss != '0':
            raise Exception('Traffic loss occurred: {0}'.format(self._loss))

    def partial_traffic_loss_accepted(self, loss_acceptance,
                                      loss_acceptance_type):
        """Fail if loss is higher then accepted in traffic run.

        :return: nothing
        """
        if self._loss is None:
            raise Exception('The traffic generation has not been issued')

        if loss_acceptance_type == 'percentage':
            loss = (float(self._loss) / float(self._sent)) * 100
        elif loss_acceptance_type == 'frames':
            loss = float(self._loss)
        else:
            raise Exception('Loss acceptance type not supported')

        if loss > float(loss_acceptance):
            raise Exception("Traffic loss {} above loss acceptance: {}".format(
                loss, loss_acceptance))