yardstick/tests/unit/network_services/libs/ixia_libs/test_ixnet_api.py

   1 # Copyright (c) 2018 Intel Corporation
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #      http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 import mock
  16 import IxNetwork
  17 import unittest
  18
  19 from yardstick.common import exceptions
  20 from yardstick.network_services.libs.ixia_libs.ixnet import ixnet_api
  21
  22
  23 UPLINK = 'uplink'
  24 DOWNLINK = 'downlink'
  25
  26 TRAFFIC_PARAMETERS = {
  27     UPLINK: {
  28         'id': 1,
  29         'bidir': 'False',
  30         'duration': 60,
  31         'rate': 10000.5,
  32         'rate_unit': 'fps',
  33         'outer_l2': {
  34             'framesize': {'64B': '25', '256B': '75'}
  35         },
  36         'outer_l3': {
  37             'count': 512,
  38             'dscp': 0,
  39             'proto': 'udp',
  40             'ttl': 32,
  41             'dstip': '152.16.40.20',
  42             'srcip': '152.16.100.20',
  43             'dstmask': 24,
  44             'srcmask': 24
  45         },
  46         'outer_l4': {
  47             'dstport': '2001',
  48             'srcport': '1234'
  49         },
  50         'traffic_type': 'continuous'
  51     },
  52     DOWNLINK: {
  53         'id': 2,
  54         'bidir': 'False',
  55         'duration': 60,
  56         'rate': 75.2,
  57         'rate_unit': '%',
  58         'outer_l2': {
  59             'framesize': {'128B': '35', '1024B': '65'}
  60         },
  61         'outer_l3': {
  62             'count': 1024,
  63             'dscp': 0,
  64             'proto': 'udp',
  65             'ttl': 32,
  66             'dstip': '2001::10',
  67             'srcip': '2021::10',
  68             'dstmask': 64,
  69             'srcmask': 64
  70         },
  71         'outer_l4': {
  72             'dstport': '1234',
  73             'srcport': '2001'
  74         },
  75         'traffic_type': 'continuous'
  76     }
  77 }
  78
  79
  80 class TestIxNextgen(unittest.TestCase):
  81
  82     def setUp(self):
  83         self.ixnet = mock.Mock()
  84         self.ixnet.execute = mock.Mock()
  85         self.ixnet.getRoot.return_value = 'my_root'
  86         self.ixnet_gen = ixnet_api.IxNextgen()
  87         self.ixnet_gen._ixnet = self.ixnet
  88
  89     def test_get_config(self):
  90         tg_cfg = {
  91             'vdu': [
  92                 {
  93                     'external-interface': [
  94                         {'virtual-interface': {'vpci': '0000:07:00.1'}},
  95                         {'virtual-interface': {'vpci': '0001:08:01.2'}}
  96                     ]
  97                 },
  98             ],
  99             'mgmt-interface': {
 100                 'ip': 'test1',
 101                 'tg-config': {
 102                     'dut_result_dir': 'test2',
 103                     'version': 'test3',
 104                     'ixchassis': 'test4',
 105                     'tcl_port': 'test5',
 106                 },
 107             }
 108         }
 109
 110         expected = {
 111             'machine': 'test1',
 112             'port': 'test5',
 113             'chassis': 'test4',
 114             'cards': ['0000', '0001'],
 115             'ports': ['07', '08'],
 116             'output_dir': 'test2',
 117             'version': 'test3',
 118             'bidir': True,
 119         }
 120
 121         result = ixnet_api.IxNextgen.get_config(tg_cfg)
 122         self.assertEqual(result, expected)
 123
 124     def test__get_config_element_by_flow_group_name(self):
 125         self.ixnet_gen._ixnet.getList.side_effect = [['traffic_item'],
 126                                                      ['fg_01']]
 127         self.ixnet_gen._ixnet.getAttribute.return_value = 'flow_group_01'
 128         output = self.ixnet_gen._get_config_element_by_flow_group_name(
 129             'flow_group_01')
 130         self.assertEqual('traffic_item/configElement:flow_group_01', output)
 131
 132     def test__get_config_element_by_flow_group_name_no_match(self):
 133         self.ixnet_gen._ixnet.getList.side_effect = [['traffic_item'],
 134                                                      ['fg_01']]
 135         self.ixnet_gen._ixnet.getAttribute.return_value = 'flow_group_02'
 136         output = self.ixnet_gen._get_config_element_by_flow_group_name(
 137             'flow_group_01')
 138         self.assertIsNone(output)
 139
 140     def test__get_stack_item(self):
 141         self.ixnet_gen._ixnet.getList.return_value = ['tcp1', 'tcp2', 'udp']
 142         with mock.patch.object(
 143                 self.ixnet_gen, '_get_config_element_by_flow_group_name') as \
 144                 mock_get_cfg_element:
 145             mock_get_cfg_element.return_value = 'cfg_element'
 146             output = self.ixnet_gen._get_stack_item(mock.ANY, ixnet_api.PROTO_TCP)
 147         self.assertEqual(['tcp1', 'tcp2'], output)
 148
 149     def test__get_stack_item_no_config_element(self):
 150         with mock.patch.object(
 151                 self.ixnet_gen, '_get_config_element_by_flow_group_name',
 152                 return_value=None):
 153             with self.assertRaises(exceptions.IxNetworkFlowNotPresent):
 154                 self.ixnet_gen._get_stack_item(mock.ANY, mock.ANY)
 155
 156     def test__get_field_in_stack_item(self):
 157         self.ixnet_gen._ixnet.getList.return_value = ['field1', 'field2']
 158         output = self.ixnet_gen._get_field_in_stack_item(mock.ANY, 'field2')
 159         self.assertEqual('field2', output)
 160
 161     def test__get_field_in_stack_item_no_field_present(self):
 162         self.ixnet_gen._ixnet.getList.return_value = ['field1', 'field2']
 163         with self.assertRaises(exceptions.IxNetworkFieldNotPresentInStackItem):
 164             self.ixnet_gen._get_field_in_stack_item(mock.ANY, 'field3')
 165
 166     def test__parse_framesize(self):
 167         framesize = {'64B': '75', '512b': '25'}
 168         output = self.ixnet_gen._parse_framesize(framesize)
 169         self.assertEqual(2, len(output))
 170         self.assertIn([64, 64, 75], output)
 171         self.assertIn([512, 512, 25], output)
 172
 173     @mock.patch.object(IxNetwork, 'IxNet')
 174     def test_connect(self, mock_ixnet):
 175         mock_ixnet.return_value = self.ixnet
 176         with mock.patch.object(self.ixnet_gen, 'get_config') as mock_config:
 177             mock_config.return_value = {'machine': 'machine_fake',
 178                                         'port': 'port_fake',
 179                                         'version': 12345}
 180             self.ixnet_gen.connect(mock.ANY)
 181
 182         self.ixnet.connect.assert_called_once_with(
 183             'machine_fake', '-port', 'port_fake', '-version', '12345')
 184         mock_config.assert_called_once()
 185
 186     def test_connect_invalid_config_no_machine(self):
 187         self.ixnet_gen.get_config = mock.Mock(return_value={
 188             'port': 'port_fake',
 189             'version': '12345'})
 190         self.assertRaises(KeyError, self.ixnet_gen.connect, mock.ANY)
 191         self.ixnet.connect.assert_not_called()
 192
 193     def test_connect_invalid_config_no_port(self):
 194         self.ixnet_gen.get_config = mock.Mock(return_value={
 195             'machine': 'machine_fake',
 196             'version': '12345'})
 197         self.assertRaises(KeyError, self.ixnet_gen.connect, mock.ANY)
 198         self.ixnet.connect.assert_not_called()
 199
 200     def test_connect_invalid_config_no_version(self):
 201         self.ixnet_gen.get_config = mock.Mock(return_value={
 202             'machine': 'machine_fake',
 203             'port': 'port_fake'})
 204         self.assertRaises(KeyError, self.ixnet_gen.connect, mock.ANY)
 205         self.ixnet.connect.assert_not_called()
 206
 207     def test_connect_no_config(self):
 208         self.ixnet_gen.get_config = mock.Mock(return_value={})
 209         self.assertRaises(KeyError, self.ixnet_gen.connect, mock.ANY)
 210         self.ixnet.connect.assert_not_called()
 211
 212     def test_clear_config(self):
 213         self.ixnet_gen.clear_config()
 214         self.ixnet.execute.assert_called_once_with('newConfig')
 215
 216     @mock.patch.object(ixnet_api, 'log')
 217     def test_assign_ports_2_ports(self, *args):
 218         self.ixnet.getAttribute.side_effect = ['up', 'down']
 219         config = {
 220             'chassis': '1.1.1.1',
 221             'cards': ['1', '2'],
 222             'ports': ['2', '2']}
 223         self.ixnet_gen._cfg = config
 224
 225         self.assertIsNone(self.ixnet_gen.assign_ports())
 226         self.assertEqual(self.ixnet.execute.call_count, 2)
 227         self.assertEqual(self.ixnet.commit.call_count, 4)
 228         self.assertEqual(self.ixnet.getAttribute.call_count, 2)
 229
 230     @mock.patch.object(ixnet_api, 'log')
 231     def test_assign_ports_port_down(self, mock_log):
 232         self.ixnet.getAttribute.return_value = 'down'
 233         config = {
 234             'chassis': '1.1.1.1',
 235             'cards': ['1', '2'],
 236             'ports': ['3', '4']}
 237         self.ixnet_gen._cfg = config
 238         self.ixnet_gen.assign_ports()
 239         mock_log.warning.assert_called()
 240
 241     def test_assign_ports_no_config(self):
 242         self.ixnet_gen._cfg = {}
 243         self.assertRaises(KeyError, self.ixnet_gen.assign_ports)
 244
 245     def test__create_traffic_item(self):
 246         self.ixnet.add.return_value = 'my_new_traffic_item'
 247         self.ixnet.remapIds.return_value = ['my_traffic_item_id']
 248
 249         self.ixnet_gen._create_traffic_item()
 250         self.ixnet.add.assert_called_once_with(
 251             'my_root/traffic', 'trafficItem')
 252         self.ixnet.setMultiAttribute.assert_called_once_with(
 253             'my_new_traffic_item', '-name', 'RFC2544', '-trafficType', 'raw')
 254         self.assertEqual(2, self.ixnet.commit.call_count)
 255         self.ixnet.remapIds.assert_called_once_with('my_new_traffic_item')
 256         self.ixnet.setAttribute('my_traffic_item_id/tracking',
 257                                 '-trackBy', 'trafficGroupId0')
 258
 259     def test__create_flow_groups(self):
 260         self.ixnet_gen.ixnet.getList.side_effect = [['traffic_item'], ['1', '2']]
 261         self.ixnet_gen.ixnet.add.side_effect = ['endp1', 'endp2']
 262         self.ixnet_gen._create_flow_groups()
 263         self.ixnet_gen.ixnet.add.assert_has_calls([
 264             mock.call('traffic_item', 'endpointSet'),
 265             mock.call('traffic_item', 'endpointSet')])
 266         self.ixnet_gen.ixnet.setMultiAttribute.assert_has_calls([
 267             mock.call('endp1', '-name', '1', '-sources', ['1/protocols'],
 268                       '-destinations', ['2/protocols']),
 269             mock.call('endp2', '-name', '2', '-sources', ['2/protocols'],
 270                       '-destinations', ['1/protocols'])])
 271
 272     def test__append_protocol_to_stack(self):
 273
 274         self.ixnet_gen._append_procotol_to_stack('my_protocol', 'prev_element')
 275         self.ixnet.execute.assert_called_with(
 276             'append', 'prev_element',
 277             'my_root/traffic/protocolTemplate:"my_protocol"')
 278
 279     def test__setup_config_elements(self):
 280         self.ixnet_gen.ixnet.getList.side_effect = [['traffic_item'],
 281                                                ['cfg_element']]
 282         with mock.patch.object(self.ixnet_gen, '_append_procotol_to_stack') as \
 283                 mock_append_proto:
 284             self.ixnet_gen._setup_config_elements()
 285         mock_append_proto.assert_has_calls([
 286             mock.call(ixnet_api.PROTO_UDP, 'cfg_element/stack:"ethernet-1"'),
 287             mock.call(ixnet_api.PROTO_IPV4, 'cfg_element/stack:"ethernet-1"')])
 288         self.ixnet_gen.ixnet.setAttribute.assert_has_calls([
 289             mock.call('cfg_element/frameRateDistribution', '-portDistribution',
 290                       'splitRateEvenly'),
 291             mock.call('cfg_element/frameRateDistribution',
 292                       '-streamDistribution', 'splitRateEvenly')])
 293
 294     @mock.patch.object(ixnet_api.IxNextgen, '_create_traffic_item')
 295     @mock.patch.object(ixnet_api.IxNextgen, '_create_flow_groups')
 296     @mock.patch.object(ixnet_api.IxNextgen, '_setup_config_elements')
 297     def test_create_traffic_model(self, mock__setup_config_elements,
 298                                   mock__create_flow_groups,
 299                                   mock__create_traffic_item):
 300
 301         self.ixnet_gen.create_traffic_model()
 302         mock__create_traffic_item.assert_called_once()
 303         mock__create_flow_groups.assert_called_once()
 304         mock__setup_config_elements.assert_called_once()
 305
 306     def test__update_frame_mac(self):
 307         with mock.patch.object(self.ixnet_gen, '_get_field_in_stack_item') as \
 308                 mock_get_field:
 309             mock_get_field.return_value = 'field_descriptor'
 310             self.ixnet_gen._update_frame_mac('ethernet_descriptor', 'field', 'mac')
 311         mock_get_field.assert_called_once_with('ethernet_descriptor', 'field')
 312         self.ixnet_gen.ixnet.setMultiAttribute(
 313             'field_descriptor', '-singleValue', 'mac', '-fieldValue', 'mac',
 314             '-valueType', 'singleValue')
 315         self.ixnet_gen.ixnet.commit.assert_called_once()
 316
 317     def test_update_frame(self):
 318         with mock.patch.object(
 319                 self.ixnet_gen, '_get_config_element_by_flow_group_name',
 320                 return_value='cfg_element'), \
 321                 mock.patch.object(self.ixnet_gen, '_update_frame_mac') as \
 322                 mock_update_frame, \
 323                 mock.patch.object(self.ixnet_gen, '_get_stack_item') as \
 324                 mock_get_stack_item:
 325             mock_get_stack_item.side_effect = [['item1'], ['item2'],
 326                                                ['item3'], ['item4']]
 327             self.ixnet_gen.update_frame(TRAFFIC_PARAMETERS, 50)
 328
 329         self.assertEqual(6, len(self.ixnet_gen.ixnet.setMultiAttribute.mock_calls))
 330         self.assertEqual(4, len(mock_update_frame.mock_calls))
 331
 332     def test_update_frame_flow_not_present(self):
 333         with mock.patch.object(
 334                 self.ixnet_gen, '_get_config_element_by_flow_group_name',
 335                 return_value=None):
 336             with self.assertRaises(exceptions.IxNetworkFlowNotPresent):
 337                 self.ixnet_gen.update_frame(TRAFFIC_PARAMETERS, 40)
 338
 339     def test_get_statistics(self):
 340         port_statistics = '::ixNet::OBJ-/statistics/view:"Port Statistics"'
 341         flow_statistics = '::ixNet::OBJ-/statistics/view:"Flow Statistics"'
 342         with mock.patch.object(self.ixnet_gen, '_build_stats_map') as \
 343                 mock_build_stats:
 344             self.ixnet_gen.get_statistics()
 345
 346         mock_build_stats.assert_has_calls([
 347             mock.call(port_statistics, self.ixnet_gen.PORT_STATS_NAME_MAP),
 348             mock.call(flow_statistics, self.ixnet_gen.LATENCY_NAME_MAP)])
 349
 350     def test__update_ipv4_address(self):
 351         with mock.patch.object(self.ixnet_gen, '_get_field_in_stack_item',
 352                                return_value='field_desc'):
 353             self.ixnet_gen._update_ipv4_address(mock.ANY, mock.ANY, '192.168.1.1',
 354                                            100, 26, 25)
 355         self.ixnet_gen.ixnet.setMultiAttribute.assert_called_once_with(
 356             'field_desc', '-seed', 100, '-fixedBits', '192.168.1.1',
 357             '-randomMask', '0.0.0.63', '-valueType', 'random',
 358             '-countValue', 25)
 359
 360     def test_update_ip_packet(self):
 361         with mock.patch.object(self.ixnet_gen, '_update_ipv4_address') as \
 362                 mock_update_add, \
 363                 mock.patch.object(self.ixnet_gen, '_get_stack_item'), \
 364                 mock.patch.object(self.ixnet_gen,
 365                 '_get_config_element_by_flow_group_name', return_value='celm'):
 366             self.ixnet_gen.update_ip_packet(TRAFFIC_PARAMETERS)
 367
 368         self.assertEqual(4, len(mock_update_add.mock_calls))
 369
 370     def test_update_ip_packet_exception_no_config_element(self):
 371         with mock.patch.object(self.ixnet_gen,
 372                                '_get_config_element_by_flow_group_name',
 373                                return_value=None):
 374             with self.assertRaises(exceptions.IxNetworkFlowNotPresent):
 375                 self.ixnet_gen.update_ip_packet(TRAFFIC_PARAMETERS)
 376
 377     @mock.patch.object(ixnet_api.IxNextgen, '_get_traffic_state')
 378     def test_start_traffic(self, mock_ixnextgen_get_traffic_state):
 379         self.ixnet_gen._ixnet.getList.return_value = [0]
 380
 381         mock_ixnextgen_get_traffic_state.side_effect = [
 382             'stopped', 'started', 'started', 'started']
 383
 384         result = self.ixnet_gen.start_traffic()
 385         self.assertIsNone(result)
 386         self.ixnet.getList.assert_called_once()
 387         self.assertEqual(3, self.ixnet_gen._ixnet.execute.call_count)
 388
 389     @mock.patch.object(ixnet_api.IxNextgen, '_get_traffic_state')
 390     def test_start_traffic_traffic_running(
 391             self, mock_ixnextgen_get_traffic_state):
 392         self.ixnet_gen._ixnet.getList.return_value = [0]
 393         mock_ixnextgen_get_traffic_state.side_effect = [
 394             'started', 'stopped', 'started']
 395
 396         result = self.ixnet_gen.start_traffic()
 397         self.assertIsNone(result)
 398         self.ixnet.getList.assert_called_once()
 399         self.assertEqual(4, self.ixnet_gen._ixnet.execute.call_count)
 400
 401     @mock.patch.object(ixnet_api.IxNextgen, '_get_traffic_state')
 402     def test_start_traffic_wait_for_traffic_to_stop(
 403             self, mock_ixnextgen_get_traffic_state):
 404         self.ixnet_gen._ixnet.getList.return_value = [0]
 405         mock_ixnextgen_get_traffic_state.side_effect = [
 406             'started', 'started', 'started', 'stopped', 'started']
 407
 408         result = self.ixnet_gen.start_traffic()
 409         self.assertIsNone(result)
 410         self.ixnet.getList.assert_called_once()
 411         self.assertEqual(4, self.ixnet_gen._ixnet.execute.call_count)
 412
 413     @mock.patch.object(ixnet_api.IxNextgen, '_get_traffic_state')
 414     def test_start_traffic_wait_for_traffic_start(
 415             self, mock_ixnextgen_get_traffic_state):
 416         self.ixnet_gen._ixnet.getList.return_value = [0]
 417         mock_ixnextgen_get_traffic_state.side_effect = [
 418             'stopped', 'stopped', 'stopped', 'started']
 419
 420         result = self.ixnet_gen.start_traffic()
 421         self.assertIsNone(result)
 422         self.ixnet.getList.assert_called_once()
 423         self.assertEqual(3, self.ixnet_gen._ixnet.execute.call_count)