3 ##############################################################################
4 # Copyright (c) 2015 Ericsson AB and others.
6 # All rights reserved. This program and the accompanying materials
7 # are made available under the terms of the Apache License, Version 2.0
8 # which accompanies this distribution, and is available at
9 # http://www.apache.org/licenses/LICENSE-2.0
10 ##############################################################################
12 # Unittest for yardstick.benchmark.scenarios.networking.iperf3.Iperf
14 from __future__ import absolute_import
20 from oslo_serialization import jsonutils
22 from yardstick.common import utils
23 from yardstick.benchmark.scenarios.networking import iperf3
26 @mock.patch('yardstick.benchmark.scenarios.networking.iperf3.ssh')
27 class IperfTestCase(unittest.TestCase):
28 output_name_tcp = 'iperf3_sample_output.json'
29 output_name_udp = 'iperf3_sample_output_udp.json'
36 'key_filename': 'mykey.key'
41 'key_filename': 'mykey.key',
42 'ipaddr': '172.16.0.138',
46 def test_iperf_successful_setup(self, mock_ssh):
48 p = iperf3.Iperf({}, self.ctx)
49 mock_ssh.SSH.from_node().execute.return_value = (0, '', '')
52 self.assertIsNotNone(p.target)
53 self.assertIsNotNone(p.host)
54 mock_ssh.SSH.from_node().execute.assert_called_with("iperf3 -s -D")
56 def test_iperf_unsuccessful_setup(self, mock_ssh):
58 p = iperf3.Iperf({}, self.ctx)
59 mock_ssh.SSH.from_node().execute.return_value = (1, '', 'FOOBAR')
60 self.assertRaises(RuntimeError, p.setup)
62 def test_iperf_successful_teardown(self, mock_ssh):
64 p = iperf3.Iperf({}, self.ctx)
65 mock_ssh.SSH.from_node().execute.return_value = (0, '', '')
66 p.host = mock_ssh.SSH.from_node()
67 p.target = mock_ssh.SSH.from_node()
70 self.assertTrue(mock_ssh.SSH.from_node().close.called)
71 mock_ssh.SSH.from_node().execute.assert_called_with("pkill iperf3")
73 def test_iperf_successful_no_sla(self, mock_ssh):
76 args = {'options': options}
79 p = iperf3.Iperf(args, self.ctx)
80 mock_ssh.SSH.from_node().execute.return_value = (0, '', '')
81 p.host = mock_ssh.SSH.from_node()
83 sample_output = self._read_sample_output(self.output_name_tcp)
84 mock_ssh.SSH.from_node().execute.return_value = (0, sample_output, '')
85 expected_result = utils.flatten_dict_key(jsonutils.loads(sample_output))
87 self.assertEqual(result, expected_result)
89 def test_iperf_successful_sla(self, mock_ssh):
94 'sla': {'bytes_per_second': 15000000}
98 p = iperf3.Iperf(args, self.ctx)
99 mock_ssh.SSH.from_node().execute.return_value = (0, '', '')
100 p.host = mock_ssh.SSH.from_node()
102 sample_output = self._read_sample_output(self.output_name_tcp)
103 mock_ssh.SSH.from_node().execute.return_value = (0, sample_output, '')
104 expected_result = utils.flatten_dict_key(jsonutils.loads(sample_output))
106 self.assertEqual(result, expected_result)
108 def test_iperf_unsuccessful_sla(self, mock_ssh):
113 'sla': {'bytes_per_second': 25000000}
117 p = iperf3.Iperf(args, self.ctx)
118 mock_ssh.SSH.from_node().execute.return_value = (0, '', '')
119 p.host = mock_ssh.SSH.from_node()
121 sample_output = self._read_sample_output(self.output_name_tcp)
122 mock_ssh.SSH.from_node().execute.return_value = (0, sample_output, '')
123 self.assertRaises(AssertionError, p.run, result)
125 def test_iperf_successful_sla_jitter(self, mock_ssh):
126 options = {"protocol": "udp", "bandwidth": "20m"}
129 'sla': {'jitter': 10}
133 p = iperf3.Iperf(args, self.ctx)
134 mock_ssh.SSH.from_node().execute.return_value = (0, '', '')
135 p.host = mock_ssh.SSH.from_node()
137 sample_output = self._read_sample_output(self.output_name_udp)
138 mock_ssh.SSH.from_node().execute.return_value = (0, sample_output, '')
139 expected_result = utils.flatten_dict_key(jsonutils.loads(sample_output))
141 self.assertEqual(result, expected_result)
143 def test_iperf_unsuccessful_sla_jitter(self, mock_ssh):
144 options = {"protocol": "udp", "bandwidth": "20m"}
147 'sla': {'jitter': 0.0001}
151 p = iperf3.Iperf(args, self.ctx)
152 mock_ssh.SSH.from_node().execute.return_value = (0, '', '')
153 p.host = mock_ssh.SSH.from_node()
155 sample_output = self._read_sample_output(self.output_name_udp)
156 mock_ssh.SSH.from_node().execute.return_value = (0, sample_output, '')
157 self.assertRaises(AssertionError, p.run, result)
159 def test_iperf_successful_tcp_protocal(self, mock_ssh):
160 options = {"protocol": "tcp", "nodelay": "yes"}
163 'sla': {'bytes_per_second': 15000000}
167 p = iperf3.Iperf(args, self.ctx)
168 mock_ssh.SSH.from_node().execute.return_value = (0, '', '')
169 p.host = mock_ssh.SSH.from_node()
171 sample_output = self._read_sample_output(self.output_name_tcp)
172 mock_ssh.SSH.from_node().execute.return_value = (0, sample_output, '')
173 expected_result = utils.flatten_dict_key(jsonutils.loads(sample_output))
175 self.assertEqual(result, expected_result)
177 def test_iperf_unsuccessful_script_error(self, mock_ssh):
180 args = {'options': options}
183 p = iperf3.Iperf(args, self.ctx)
184 mock_ssh.SSH.from_node().execute.return_value = (0, '', '')
185 p.host = mock_ssh.SSH.from_node()
187 mock_ssh.SSH.from_node().execute.return_value = (1, '', 'FOOBAR')
188 self.assertRaises(RuntimeError, p.run, result)
190 def _read_sample_output(self, filename):
191 curr_path = os.path.dirname(os.path.abspath(__file__))
192 output = os.path.join(curr_path, filename)
193 with open(output) as f:
194 sample_output = f.read()
201 if __name__ == '__main__':