Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 1 | # Copyright 2012 OpenStack Foundation |
| 2 | # All Rights Reserved. |
| 3 | # |
| 4 | # Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 5 | # not use this file except in compliance with the License. You may obtain |
| 6 | # a copy of the License at |
| 7 | # |
| 8 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | # |
| 10 | # Unless required by applicable law or agreed to in writing, software |
| 11 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 12 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 13 | # License for the specific language governing permissions and limitations |
| 14 | # under the License. |
| 15 | |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 16 | import functools |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 17 | import math |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 18 | |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 19 | import netaddr |
| 20 | from tempest.lib.common.utils import data_utils |
| 21 | from tempest.lib import exceptions as lib_exc |
| 22 | from tempest import test |
| 23 | |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 24 | from neutron.common import constants |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 25 | from neutron.common import utils |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 26 | from neutron.tests.tempest.api import clients |
| 27 | from neutron.tests.tempest import config |
| 28 | from neutron.tests.tempest import exceptions |
| 29 | |
| 30 | CONF = config.CONF |
| 31 | |
| 32 | |
| 33 | class BaseNetworkTest(test.BaseTestCase): |
| 34 | |
| 35 | """ |
| 36 | Base class for the Neutron tests that use the Tempest Neutron REST client |
| 37 | |
| 38 | Per the Neutron API Guide, API v1.x was removed from the source code tree |
| 39 | (docs.openstack.org/api/openstack-network/2.0/content/Overview-d1e71.html) |
| 40 | Therefore, v2.x of the Neutron API is assumed. It is also assumed that the |
| 41 | following options are defined in the [network] section of etc/tempest.conf: |
| 42 | |
| 43 | project_network_cidr with a block of cidr's from which smaller blocks |
| 44 | can be allocated for tenant networks |
| 45 | |
| 46 | project_network_mask_bits with the mask bits to be used to partition |
| 47 | the block defined by tenant-network_cidr |
| 48 | |
| 49 | Finally, it is assumed that the following option is defined in the |
| 50 | [service_available] section of etc/tempest.conf |
| 51 | |
| 52 | neutron as True |
| 53 | """ |
| 54 | |
| 55 | force_tenant_isolation = False |
| 56 | credentials = ['primary'] |
| 57 | |
| 58 | # Default to ipv4. |
| 59 | _ip_version = 4 |
| 60 | |
| 61 | @classmethod |
| 62 | def get_client_manager(cls, credential_type=None, roles=None, |
| 63 | force_new=None): |
Genadi Chereshnya | cc395c0 | 2016-07-25 12:17:37 +0300 | [diff] [blame] | 64 | manager = super(BaseNetworkTest, cls).get_client_manager( |
| 65 | credential_type=credential_type, |
| 66 | roles=roles, |
| 67 | force_new=force_new |
| 68 | ) |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 69 | # Neutron uses a different clients manager than the one in the Tempest |
| 70 | return clients.Manager(manager.credentials) |
| 71 | |
| 72 | @classmethod |
| 73 | def skip_checks(cls): |
| 74 | super(BaseNetworkTest, cls).skip_checks() |
| 75 | if not CONF.service_available.neutron: |
| 76 | raise cls.skipException("Neutron support is required") |
| 77 | if cls._ip_version == 6 and not CONF.network_feature_enabled.ipv6: |
| 78 | raise cls.skipException("IPv6 Tests are disabled.") |
Jakub Libosvar | 1982aa1 | 2017-05-30 11:15:33 +0000 | [diff] [blame] | 79 | for req_ext in getattr(cls, 'required_extensions', []): |
| 80 | if not test.is_extension_enabled(req_ext, 'network'): |
| 81 | msg = "%s extension not enabled." % req_ext |
| 82 | raise cls.skipException(msg) |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 83 | |
| 84 | @classmethod |
| 85 | def setup_credentials(cls): |
| 86 | # Create no network resources for these test. |
| 87 | cls.set_network_resources() |
| 88 | super(BaseNetworkTest, cls).setup_credentials() |
| 89 | |
| 90 | @classmethod |
| 91 | def setup_clients(cls): |
| 92 | super(BaseNetworkTest, cls).setup_clients() |
fumihiko kakuma | a216fc1 | 2017-07-14 10:43:29 +0900 | [diff] [blame] | 93 | cls.client = cls.os_primary.network_client |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 94 | |
| 95 | @classmethod |
| 96 | def resource_setup(cls): |
| 97 | super(BaseNetworkTest, cls).resource_setup() |
| 98 | |
| 99 | cls.networks = [] |
Miguel Lavalle | 124378b | 2016-09-21 16:41:47 -0500 | [diff] [blame] | 100 | cls.admin_networks = [] |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 101 | cls.subnets = [] |
| 102 | cls.ports = [] |
| 103 | cls.routers = [] |
| 104 | cls.floating_ips = [] |
| 105 | cls.metering_labels = [] |
| 106 | cls.service_profiles = [] |
| 107 | cls.flavors = [] |
| 108 | cls.metering_label_rules = [] |
| 109 | cls.qos_rules = [] |
| 110 | cls.qos_policies = [] |
| 111 | cls.ethertype = "IPv" + str(cls._ip_version) |
| 112 | cls.address_scopes = [] |
| 113 | cls.admin_address_scopes = [] |
| 114 | cls.subnetpools = [] |
| 115 | cls.admin_subnetpools = [] |
Itzik Brown | bac51dc | 2016-10-31 12:25:04 +0000 | [diff] [blame] | 116 | cls.security_groups = [] |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 117 | |
| 118 | @classmethod |
| 119 | def resource_cleanup(cls): |
| 120 | if CONF.service_available.neutron: |
| 121 | # Clean up QoS rules |
| 122 | for qos_rule in cls.qos_rules: |
| 123 | cls._try_delete_resource(cls.admin_client.delete_qos_rule, |
| 124 | qos_rule['id']) |
| 125 | # Clean up QoS policies |
| 126 | for qos_policy in cls.qos_policies: |
| 127 | cls._try_delete_resource(cls.admin_client.delete_qos_policy, |
| 128 | qos_policy['id']) |
| 129 | # Clean up floating IPs |
| 130 | for floating_ip in cls.floating_ips: |
| 131 | cls._try_delete_resource(cls.client.delete_floatingip, |
| 132 | floating_ip['id']) |
| 133 | # Clean up routers |
| 134 | for router in cls.routers: |
| 135 | cls._try_delete_resource(cls.delete_router, |
| 136 | router) |
| 137 | # Clean up metering label rules |
| 138 | for metering_label_rule in cls.metering_label_rules: |
| 139 | cls._try_delete_resource( |
| 140 | cls.admin_client.delete_metering_label_rule, |
| 141 | metering_label_rule['id']) |
| 142 | # Clean up metering labels |
| 143 | for metering_label in cls.metering_labels: |
| 144 | cls._try_delete_resource( |
| 145 | cls.admin_client.delete_metering_label, |
| 146 | metering_label['id']) |
| 147 | # Clean up flavors |
| 148 | for flavor in cls.flavors: |
| 149 | cls._try_delete_resource( |
| 150 | cls.admin_client.delete_flavor, |
| 151 | flavor['id']) |
| 152 | # Clean up service profiles |
| 153 | for service_profile in cls.service_profiles: |
| 154 | cls._try_delete_resource( |
| 155 | cls.admin_client.delete_service_profile, |
| 156 | service_profile['id']) |
| 157 | # Clean up ports |
| 158 | for port in cls.ports: |
| 159 | cls._try_delete_resource(cls.client.delete_port, |
| 160 | port['id']) |
| 161 | # Clean up subnets |
| 162 | for subnet in cls.subnets: |
| 163 | cls._try_delete_resource(cls.client.delete_subnet, |
| 164 | subnet['id']) |
| 165 | # Clean up networks |
| 166 | for network in cls.networks: |
| 167 | cls._try_delete_resource(cls.client.delete_network, |
| 168 | network['id']) |
| 169 | |
Miguel Lavalle | 124378b | 2016-09-21 16:41:47 -0500 | [diff] [blame] | 170 | # Clean up admin networks |
| 171 | for network in cls.admin_networks: |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 172 | cls._try_delete_resource(cls.admin_client.delete_network, |
| 173 | network['id']) |
| 174 | |
Itzik Brown | bac51dc | 2016-10-31 12:25:04 +0000 | [diff] [blame] | 175 | # Clean up security groups |
| 176 | for secgroup in cls.security_groups: |
| 177 | cls._try_delete_resource(cls.client.delete_security_group, |
| 178 | secgroup['id']) |
| 179 | |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 180 | for subnetpool in cls.subnetpools: |
| 181 | cls._try_delete_resource(cls.client.delete_subnetpool, |
| 182 | subnetpool['id']) |
| 183 | |
| 184 | for subnetpool in cls.admin_subnetpools: |
| 185 | cls._try_delete_resource(cls.admin_client.delete_subnetpool, |
| 186 | subnetpool['id']) |
| 187 | |
| 188 | for address_scope in cls.address_scopes: |
| 189 | cls._try_delete_resource(cls.client.delete_address_scope, |
| 190 | address_scope['id']) |
| 191 | |
| 192 | for address_scope in cls.admin_address_scopes: |
| 193 | cls._try_delete_resource( |
| 194 | cls.admin_client.delete_address_scope, |
| 195 | address_scope['id']) |
| 196 | |
| 197 | super(BaseNetworkTest, cls).resource_cleanup() |
| 198 | |
| 199 | @classmethod |
| 200 | def _try_delete_resource(cls, delete_callable, *args, **kwargs): |
| 201 | """Cleanup resources in case of test-failure |
| 202 | |
| 203 | Some resources are explicitly deleted by the test. |
| 204 | If the test failed to delete a resource, this method will execute |
| 205 | the appropriate delete methods. Otherwise, the method ignores NotFound |
| 206 | exceptions thrown for resources that were correctly deleted by the |
| 207 | test. |
| 208 | |
| 209 | :param delete_callable: delete method |
| 210 | :param args: arguments for delete method |
| 211 | :param kwargs: keyword arguments for delete method |
| 212 | """ |
| 213 | try: |
| 214 | delete_callable(*args, **kwargs) |
| 215 | # if resource is not found, this means it was deleted in the test |
| 216 | except lib_exc.NotFound: |
| 217 | pass |
| 218 | |
| 219 | @classmethod |
Sergey Belous | a627ed9 | 2016-10-07 14:29:07 +0300 | [diff] [blame] | 220 | def create_network(cls, network_name=None, client=None, **kwargs): |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 221 | """Wrapper utility that returns a test network.""" |
| 222 | network_name = network_name or data_utils.rand_name('test-network-') |
| 223 | |
Sergey Belous | a627ed9 | 2016-10-07 14:29:07 +0300 | [diff] [blame] | 224 | client = client or cls.client |
| 225 | body = client.create_network(name=network_name, **kwargs) |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 226 | network = body['network'] |
| 227 | cls.networks.append(network) |
| 228 | return network |
| 229 | |
| 230 | @classmethod |
| 231 | def create_shared_network(cls, network_name=None, **post_body): |
| 232 | network_name = network_name or data_utils.rand_name('sharednetwork-') |
| 233 | post_body.update({'name': network_name, 'shared': True}) |
| 234 | body = cls.admin_client.create_network(**post_body) |
| 235 | network = body['network'] |
Miguel Lavalle | 124378b | 2016-09-21 16:41:47 -0500 | [diff] [blame] | 236 | cls.admin_networks.append(network) |
| 237 | return network |
| 238 | |
| 239 | @classmethod |
| 240 | def create_network_keystone_v3(cls, network_name=None, project_id=None, |
| 241 | tenant_id=None, client=None): |
| 242 | """Wrapper utility that creates a test network with project_id.""" |
| 243 | client = client or cls.client |
| 244 | network_name = network_name or data_utils.rand_name( |
| 245 | 'test-network-with-project_id') |
| 246 | project_id = cls.client.tenant_id |
| 247 | body = client.create_network_keystone_v3(network_name, project_id, |
| 248 | tenant_id) |
| 249 | network = body['network'] |
| 250 | if client is cls.client: |
| 251 | cls.networks.append(network) |
| 252 | else: |
| 253 | cls.admin_networks.append(network) |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 254 | return network |
| 255 | |
| 256 | @classmethod |
| 257 | def create_subnet(cls, network, gateway='', cidr=None, mask_bits=None, |
| 258 | ip_version=None, client=None, **kwargs): |
| 259 | """Wrapper utility that returns a test subnet.""" |
| 260 | |
| 261 | # allow tests to use admin client |
| 262 | if not client: |
| 263 | client = cls.client |
| 264 | |
| 265 | # The cidr and mask_bits depend on the ip version. |
| 266 | ip_version = ip_version if ip_version is not None else cls._ip_version |
| 267 | gateway_not_set = gateway == '' |
| 268 | if ip_version == 4: |
| 269 | cidr = cidr or netaddr.IPNetwork( |
| 270 | config.safe_get_config_value( |
| 271 | 'network', 'project_network_cidr')) |
| 272 | mask_bits = ( |
| 273 | mask_bits or config.safe_get_config_value( |
| 274 | 'network', 'project_network_mask_bits')) |
| 275 | elif ip_version == 6: |
| 276 | cidr = ( |
| 277 | cidr or netaddr.IPNetwork( |
| 278 | config.safe_get_config_value( |
| 279 | 'network', 'project_network_v6_cidr'))) |
| 280 | mask_bits = ( |
| 281 | mask_bits or config.safe_get_config_value( |
| 282 | 'network', 'project_network_v6_mask_bits')) |
| 283 | # Find a cidr that is not in use yet and create a subnet with it |
| 284 | for subnet_cidr in cidr.subnet(mask_bits): |
| 285 | if gateway_not_set: |
| 286 | gateway_ip = str(netaddr.IPAddress(subnet_cidr) + 1) |
| 287 | else: |
| 288 | gateway_ip = gateway |
| 289 | try: |
| 290 | body = client.create_subnet( |
| 291 | network_id=network['id'], |
| 292 | cidr=str(subnet_cidr), |
| 293 | ip_version=ip_version, |
| 294 | gateway_ip=gateway_ip, |
| 295 | **kwargs) |
| 296 | break |
| 297 | except lib_exc.BadRequest as e: |
| 298 | is_overlapping_cidr = 'overlaps with another subnet' in str(e) |
| 299 | if not is_overlapping_cidr: |
| 300 | raise |
| 301 | else: |
| 302 | message = 'Available CIDR for subnet creation could not be found' |
| 303 | raise ValueError(message) |
| 304 | subnet = body['subnet'] |
| 305 | cls.subnets.append(subnet) |
| 306 | return subnet |
| 307 | |
| 308 | @classmethod |
| 309 | def create_port(cls, network, **kwargs): |
| 310 | """Wrapper utility that returns a test port.""" |
| 311 | body = cls.client.create_port(network_id=network['id'], |
| 312 | **kwargs) |
| 313 | port = body['port'] |
| 314 | cls.ports.append(port) |
| 315 | return port |
| 316 | |
| 317 | @classmethod |
| 318 | def update_port(cls, port, **kwargs): |
| 319 | """Wrapper utility that updates a test port.""" |
| 320 | body = cls.client.update_port(port['id'], |
| 321 | **kwargs) |
| 322 | return body['port'] |
| 323 | |
| 324 | @classmethod |
Genadi Chereshnya | c0411e9 | 2016-07-11 16:59:42 +0300 | [diff] [blame] | 325 | def _create_router_with_client( |
| 326 | cls, client, router_name=None, admin_state_up=False, |
| 327 | external_network_id=None, enable_snat=None, **kwargs |
| 328 | ): |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 329 | ext_gw_info = {} |
| 330 | if external_network_id: |
| 331 | ext_gw_info['network_id'] = external_network_id |
YAMAMOTO Takashi | 9bd4f97 | 2017-06-20 12:49:30 +0900 | [diff] [blame] | 332 | if enable_snat is not None: |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 333 | ext_gw_info['enable_snat'] = enable_snat |
Genadi Chereshnya | c0411e9 | 2016-07-11 16:59:42 +0300 | [diff] [blame] | 334 | body = client.create_router( |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 335 | router_name, external_gateway_info=ext_gw_info, |
| 336 | admin_state_up=admin_state_up, **kwargs) |
| 337 | router = body['router'] |
| 338 | cls.routers.append(router) |
| 339 | return router |
| 340 | |
| 341 | @classmethod |
Genadi Chereshnya | c0411e9 | 2016-07-11 16:59:42 +0300 | [diff] [blame] | 342 | def create_router(cls, *args, **kwargs): |
| 343 | return cls._create_router_with_client(cls.client, *args, **kwargs) |
| 344 | |
| 345 | @classmethod |
| 346 | def create_admin_router(cls, *args, **kwargs): |
rajat29 | 4495c04 | 2017-06-28 15:37:16 +0530 | [diff] [blame] | 347 | return cls._create_router_with_client(cls.os_admin.network_client, |
Genadi Chereshnya | c0411e9 | 2016-07-11 16:59:42 +0300 | [diff] [blame] | 348 | *args, **kwargs) |
| 349 | |
| 350 | @classmethod |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 351 | def create_floatingip(cls, external_network_id): |
| 352 | """Wrapper utility that returns a test floating IP.""" |
| 353 | body = cls.client.create_floatingip( |
| 354 | floating_network_id=external_network_id) |
| 355 | fip = body['floatingip'] |
| 356 | cls.floating_ips.append(fip) |
| 357 | return fip |
| 358 | |
| 359 | @classmethod |
| 360 | def create_router_interface(cls, router_id, subnet_id): |
| 361 | """Wrapper utility that returns a router interface.""" |
| 362 | interface = cls.client.add_router_interface_with_subnet_id( |
| 363 | router_id, subnet_id) |
| 364 | return interface |
| 365 | |
| 366 | @classmethod |
Sławek Kapłoński | ff29406 | 2016-12-04 15:00:54 +0000 | [diff] [blame] | 367 | def get_supported_qos_rule_types(cls): |
| 368 | body = cls.client.list_qos_rule_types() |
| 369 | return [rule_type['type'] for rule_type in body['rule_types']] |
| 370 | |
| 371 | @classmethod |
Ihar Hrachyshka | b7940d9 | 2016-06-10 13:44:22 +0200 | [diff] [blame] | 372 | def create_qos_policy(cls, name, description=None, shared=False, |
Hirofumi Ichihara | 39a6ee1 | 2017-08-23 13:55:12 +0900 | [diff] [blame^] | 373 | tenant_id=None, is_default=False): |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 374 | """Wrapper utility that returns a test QoS policy.""" |
| 375 | body = cls.admin_client.create_qos_policy( |
Hirofumi Ichihara | 39a6ee1 | 2017-08-23 13:55:12 +0900 | [diff] [blame^] | 376 | name, description, shared, tenant_id, is_default) |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 377 | qos_policy = body['policy'] |
| 378 | cls.qos_policies.append(qos_policy) |
| 379 | return qos_policy |
| 380 | |
| 381 | @classmethod |
Sławek Kapłoński | 153f345 | 2017-03-24 22:04:53 +0000 | [diff] [blame] | 382 | def create_qos_bandwidth_limit_rule(cls, policy_id, max_kbps, |
| 383 | max_burst_kbps, |
| 384 | direction=constants.EGRESS_DIRECTION): |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 385 | """Wrapper utility that returns a test QoS bandwidth limit rule.""" |
| 386 | body = cls.admin_client.create_bandwidth_limit_rule( |
Sławek Kapłoński | 153f345 | 2017-03-24 22:04:53 +0000 | [diff] [blame] | 387 | policy_id, max_kbps, max_burst_kbps, direction) |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 388 | qos_rule = body['bandwidth_limit_rule'] |
| 389 | cls.qos_rules.append(qos_rule) |
| 390 | return qos_rule |
| 391 | |
| 392 | @classmethod |
| 393 | def delete_router(cls, router): |
| 394 | body = cls.client.list_router_interfaces(router['id']) |
| 395 | interfaces = body['ports'] |
| 396 | for i in interfaces: |
| 397 | try: |
| 398 | cls.client.remove_router_interface_with_subnet_id( |
| 399 | router['id'], i['fixed_ips'][0]['subnet_id']) |
| 400 | except lib_exc.NotFound: |
| 401 | pass |
| 402 | cls.client.delete_router(router['id']) |
| 403 | |
| 404 | @classmethod |
| 405 | def create_address_scope(cls, name, is_admin=False, **kwargs): |
| 406 | if is_admin: |
| 407 | body = cls.admin_client.create_address_scope(name=name, **kwargs) |
| 408 | cls.admin_address_scopes.append(body['address_scope']) |
| 409 | else: |
| 410 | body = cls.client.create_address_scope(name=name, **kwargs) |
| 411 | cls.address_scopes.append(body['address_scope']) |
| 412 | return body['address_scope'] |
| 413 | |
| 414 | @classmethod |
| 415 | def create_subnetpool(cls, name, is_admin=False, **kwargs): |
| 416 | if is_admin: |
| 417 | body = cls.admin_client.create_subnetpool(name, **kwargs) |
| 418 | cls.admin_subnetpools.append(body['subnetpool']) |
| 419 | else: |
| 420 | body = cls.client.create_subnetpool(name, **kwargs) |
| 421 | cls.subnetpools.append(body['subnetpool']) |
| 422 | return body['subnetpool'] |
| 423 | |
| 424 | |
| 425 | class BaseAdminNetworkTest(BaseNetworkTest): |
| 426 | |
| 427 | credentials = ['primary', 'admin'] |
| 428 | |
| 429 | @classmethod |
| 430 | def setup_clients(cls): |
| 431 | super(BaseAdminNetworkTest, cls).setup_clients() |
fumihiko kakuma | a216fc1 | 2017-07-14 10:43:29 +0900 | [diff] [blame] | 432 | cls.admin_client = cls.os_admin.network_client |
Jakub Libosvar | f575801 | 2017-08-15 13:45:30 +0000 | [diff] [blame] | 433 | cls.identity_admin_client = cls.os_admin.projects_client |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 434 | |
| 435 | @classmethod |
| 436 | def create_metering_label(cls, name, description): |
| 437 | """Wrapper utility that returns a test metering label.""" |
| 438 | body = cls.admin_client.create_metering_label( |
| 439 | description=description, |
| 440 | name=data_utils.rand_name("metering-label")) |
| 441 | metering_label = body['metering_label'] |
| 442 | cls.metering_labels.append(metering_label) |
| 443 | return metering_label |
| 444 | |
| 445 | @classmethod |
| 446 | def create_metering_label_rule(cls, remote_ip_prefix, direction, |
| 447 | metering_label_id): |
| 448 | """Wrapper utility that returns a test metering label rule.""" |
| 449 | body = cls.admin_client.create_metering_label_rule( |
| 450 | remote_ip_prefix=remote_ip_prefix, direction=direction, |
| 451 | metering_label_id=metering_label_id) |
| 452 | metering_label_rule = body['metering_label_rule'] |
| 453 | cls.metering_label_rules.append(metering_label_rule) |
| 454 | return metering_label_rule |
| 455 | |
| 456 | @classmethod |
| 457 | def create_flavor(cls, name, description, service_type): |
| 458 | """Wrapper utility that returns a test flavor.""" |
| 459 | body = cls.admin_client.create_flavor( |
| 460 | description=description, service_type=service_type, |
| 461 | name=name) |
| 462 | flavor = body['flavor'] |
| 463 | cls.flavors.append(flavor) |
| 464 | return flavor |
| 465 | |
| 466 | @classmethod |
| 467 | def create_service_profile(cls, description, metainfo, driver): |
| 468 | """Wrapper utility that returns a test service profile.""" |
| 469 | body = cls.admin_client.create_service_profile( |
| 470 | driver=driver, metainfo=metainfo, description=description) |
| 471 | service_profile = body['service_profile'] |
| 472 | cls.service_profiles.append(service_profile) |
| 473 | return service_profile |
| 474 | |
| 475 | @classmethod |
| 476 | def get_unused_ip(cls, net_id, ip_version=None): |
Gary Kotton | 011345f | 2016-06-15 08:04:31 -0700 | [diff] [blame] | 477 | """Get an unused ip address in a allocation pool of net""" |
Daniel Mellado | 3c0aeab | 2016-01-29 11:30:25 +0000 | [diff] [blame] | 478 | body = cls.admin_client.list_ports(network_id=net_id) |
| 479 | ports = body['ports'] |
| 480 | used_ips = [] |
| 481 | for port in ports: |
| 482 | used_ips.extend( |
| 483 | [fixed_ip['ip_address'] for fixed_ip in port['fixed_ips']]) |
| 484 | body = cls.admin_client.list_subnets(network_id=net_id) |
| 485 | subnets = body['subnets'] |
| 486 | |
| 487 | for subnet in subnets: |
| 488 | if ip_version and subnet['ip_version'] != ip_version: |
| 489 | continue |
| 490 | cidr = subnet['cidr'] |
| 491 | allocation_pools = subnet['allocation_pools'] |
| 492 | iterators = [] |
| 493 | if allocation_pools: |
| 494 | for allocation_pool in allocation_pools: |
| 495 | iterators.append(netaddr.iter_iprange( |
| 496 | allocation_pool['start'], allocation_pool['end'])) |
| 497 | else: |
| 498 | net = netaddr.IPNetwork(cidr) |
| 499 | |
| 500 | def _iterip(): |
| 501 | for ip in net: |
| 502 | if ip not in (net.network, net.broadcast): |
| 503 | yield ip |
| 504 | iterators.append(iter(_iterip())) |
| 505 | |
| 506 | for iterator in iterators: |
| 507 | for ip in iterator: |
| 508 | if str(ip) not in used_ips: |
| 509 | return str(ip) |
| 510 | |
| 511 | message = ( |
| 512 | "net(%s) has no usable IP address in allocation pools" % net_id) |
| 513 | raise exceptions.InvalidConfiguration(message) |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 514 | |
| 515 | |
Sławek Kapłoński | ff29406 | 2016-12-04 15:00:54 +0000 | [diff] [blame] | 516 | def require_qos_rule_type(rule_type): |
| 517 | def decorator(f): |
| 518 | @functools.wraps(f) |
| 519 | def wrapper(self, *func_args, **func_kwargs): |
| 520 | if rule_type not in self.get_supported_qos_rule_types(): |
| 521 | raise self.skipException( |
| 522 | "%s rule type is required." % rule_type) |
| 523 | return f(self, *func_args, **func_kwargs) |
| 524 | return wrapper |
| 525 | return decorator |
| 526 | |
| 527 | |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 528 | def _require_sorting(f): |
| 529 | @functools.wraps(f) |
| 530 | def inner(self, *args, **kwargs): |
Ihar Hrachyshka | 34feb5b | 2016-06-14 16:16:06 +0200 | [diff] [blame] | 531 | if not test.is_extension_enabled("sorting", "network"): |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 532 | self.skipTest('Sorting feature is required') |
| 533 | return f(self, *args, **kwargs) |
| 534 | return inner |
| 535 | |
| 536 | |
| 537 | def _require_pagination(f): |
| 538 | @functools.wraps(f) |
| 539 | def inner(self, *args, **kwargs): |
Ihar Hrachyshka | 34feb5b | 2016-06-14 16:16:06 +0200 | [diff] [blame] | 540 | if not test.is_extension_enabled("pagination", "network"): |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 541 | self.skipTest('Pagination feature is required') |
| 542 | return f(self, *args, **kwargs) |
| 543 | return inner |
| 544 | |
| 545 | |
| 546 | class BaseSearchCriteriaTest(BaseNetworkTest): |
| 547 | |
| 548 | # This should be defined by subclasses to reflect resource name to test |
| 549 | resource = None |
| 550 | |
Armando Migliaccio | 57581c6 | 2016-07-01 10:13:19 -0700 | [diff] [blame] | 551 | field = 'name' |
| 552 | |
Ihar Hrachyshka | a8fe5a1 | 2016-05-24 14:50:58 +0200 | [diff] [blame] | 553 | # NOTE(ihrachys): some names, like those starting with an underscore (_) |
| 554 | # are sorted differently depending on whether the plugin implements native |
| 555 | # sorting support, or not. So we avoid any such cases here, sticking to |
| 556 | # alphanumeric. Also test a case when there are multiple resources with the |
| 557 | # same name |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 558 | resource_names = ('test1', 'abc1', 'test10', '123test') + ('test1',) |
| 559 | |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 560 | force_tenant_isolation = True |
| 561 | |
Ihar Hrachyshka | a8fe5a1 | 2016-05-24 14:50:58 +0200 | [diff] [blame] | 562 | list_kwargs = {} |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 563 | |
Ihar Hrachyshka | b7940d9 | 2016-06-10 13:44:22 +0200 | [diff] [blame] | 564 | list_as_admin = False |
| 565 | |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 566 | def assertSameOrder(self, original, actual): |
| 567 | # gracefully handle iterators passed |
| 568 | original = list(original) |
| 569 | actual = list(actual) |
| 570 | self.assertEqual(len(original), len(actual)) |
| 571 | for expected, res in zip(original, actual): |
Armando Migliaccio | 57581c6 | 2016-07-01 10:13:19 -0700 | [diff] [blame] | 572 | self.assertEqual(expected[self.field], res[self.field]) |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 573 | |
| 574 | @utils.classproperty |
| 575 | def plural_name(self): |
| 576 | return '%ss' % self.resource |
| 577 | |
Ihar Hrachyshka | b7940d9 | 2016-06-10 13:44:22 +0200 | [diff] [blame] | 578 | @property |
| 579 | def list_client(self): |
| 580 | return self.admin_client if self.list_as_admin else self.client |
| 581 | |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 582 | def list_method(self, *args, **kwargs): |
Ihar Hrachyshka | b7940d9 | 2016-06-10 13:44:22 +0200 | [diff] [blame] | 583 | method = getattr(self.list_client, 'list_%s' % self.plural_name) |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 584 | kwargs.update(self.list_kwargs) |
| 585 | return method(*args, **kwargs) |
| 586 | |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 587 | def get_bare_url(self, url): |
| 588 | base_url = self.client.base_url |
| 589 | self.assertTrue(url.startswith(base_url)) |
| 590 | return url[len(base_url):] |
| 591 | |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 592 | @classmethod |
| 593 | def _extract_resources(cls, body): |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 594 | return body[cls.plural_name] |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 595 | |
| 596 | def _test_list_sorts(self, direction): |
| 597 | sort_args = { |
| 598 | 'sort_dir': direction, |
Armando Migliaccio | 57581c6 | 2016-07-01 10:13:19 -0700 | [diff] [blame] | 599 | 'sort_key': self.field |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 600 | } |
| 601 | body = self.list_method(**sort_args) |
| 602 | resources = self._extract_resources(body) |
| 603 | self.assertNotEmpty( |
| 604 | resources, "%s list returned is empty" % self.resource) |
Armando Migliaccio | 57581c6 | 2016-07-01 10:13:19 -0700 | [diff] [blame] | 605 | retrieved_names = [res[self.field] for res in resources] |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 606 | expected = sorted(retrieved_names) |
| 607 | if direction == constants.SORT_DIRECTION_DESC: |
| 608 | expected = list(reversed(expected)) |
| 609 | self.assertEqual(expected, retrieved_names) |
| 610 | |
| 611 | @_require_sorting |
| 612 | def _test_list_sorts_asc(self): |
| 613 | self._test_list_sorts(constants.SORT_DIRECTION_ASC) |
| 614 | |
| 615 | @_require_sorting |
| 616 | def _test_list_sorts_desc(self): |
| 617 | self._test_list_sorts(constants.SORT_DIRECTION_DESC) |
| 618 | |
| 619 | @_require_pagination |
| 620 | def _test_list_pagination(self): |
| 621 | for limit in range(1, len(self.resource_names) + 1): |
| 622 | pagination_args = { |
| 623 | 'limit': limit, |
| 624 | } |
| 625 | body = self.list_method(**pagination_args) |
| 626 | resources = self._extract_resources(body) |
| 627 | self.assertEqual(limit, len(resources)) |
| 628 | |
| 629 | @_require_pagination |
| 630 | def _test_list_no_pagination_limit_0(self): |
| 631 | pagination_args = { |
| 632 | 'limit': 0, |
| 633 | } |
| 634 | body = self.list_method(**pagination_args) |
| 635 | resources = self._extract_resources(body) |
Béla Vancsics | f180618 | 2016-08-23 07:36:18 +0200 | [diff] [blame] | 636 | self.assertGreaterEqual(len(resources), len(self.resource_names)) |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 637 | |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 638 | def _test_list_pagination_iteratively(self, lister): |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 639 | # first, collect all resources for later comparison |
| 640 | sort_args = { |
| 641 | 'sort_dir': constants.SORT_DIRECTION_ASC, |
Armando Migliaccio | 57581c6 | 2016-07-01 10:13:19 -0700 | [diff] [blame] | 642 | 'sort_key': self.field |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 643 | } |
| 644 | body = self.list_method(**sort_args) |
| 645 | expected_resources = self._extract_resources(body) |
| 646 | self.assertNotEmpty(expected_resources) |
| 647 | |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 648 | resources = lister( |
| 649 | len(expected_resources), sort_args |
| 650 | ) |
| 651 | |
| 652 | # finally, compare that the list retrieved in one go is identical to |
| 653 | # the one containing pagination results |
| 654 | self.assertSameOrder(expected_resources, resources) |
| 655 | |
| 656 | def _list_all_with_marker(self, niterations, sort_args): |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 657 | # paginate resources one by one, using last fetched resource as a |
| 658 | # marker |
| 659 | resources = [] |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 660 | for i in range(niterations): |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 661 | pagination_args = sort_args.copy() |
| 662 | pagination_args['limit'] = 1 |
| 663 | if resources: |
| 664 | pagination_args['marker'] = resources[-1]['id'] |
| 665 | body = self.list_method(**pagination_args) |
| 666 | resources_ = self._extract_resources(body) |
| 667 | self.assertEqual(1, len(resources_)) |
| 668 | resources.extend(resources_) |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 669 | return resources |
Ihar Hrachyshka | 5938225 | 2016-04-05 15:54:33 +0200 | [diff] [blame] | 670 | |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 671 | @_require_pagination |
| 672 | @_require_sorting |
| 673 | def _test_list_pagination_with_marker(self): |
| 674 | self._test_list_pagination_iteratively(self._list_all_with_marker) |
| 675 | |
| 676 | def _list_all_with_hrefs(self, niterations, sort_args): |
| 677 | # paginate resources one by one, using next href links |
| 678 | resources = [] |
| 679 | prev_links = {} |
| 680 | |
| 681 | for i in range(niterations): |
| 682 | if prev_links: |
| 683 | uri = self.get_bare_url(prev_links['next']) |
| 684 | else: |
Ihar Hrachyshka | 7f79fe6 | 2016-06-07 21:23:44 +0200 | [diff] [blame] | 685 | sort_args.update(self.list_kwargs) |
Ihar Hrachyshka | b7940d9 | 2016-06-10 13:44:22 +0200 | [diff] [blame] | 686 | uri = self.list_client.build_uri( |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 687 | self.plural_name, limit=1, **sort_args) |
Ihar Hrachyshka | b7940d9 | 2016-06-10 13:44:22 +0200 | [diff] [blame] | 688 | prev_links, body = self.list_client.get_uri_with_links( |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 689 | self.plural_name, uri |
| 690 | ) |
| 691 | resources_ = self._extract_resources(body) |
| 692 | self.assertEqual(1, len(resources_)) |
| 693 | resources.extend(resources_) |
| 694 | |
| 695 | # The last element is empty and does not contain 'next' link |
| 696 | uri = self.get_bare_url(prev_links['next']) |
| 697 | prev_links, body = self.client.get_uri_with_links( |
| 698 | self.plural_name, uri |
| 699 | ) |
| 700 | self.assertNotIn('next', prev_links) |
| 701 | |
| 702 | # Now walk backwards and compare results |
| 703 | resources2 = [] |
| 704 | for i in range(niterations): |
| 705 | uri = self.get_bare_url(prev_links['previous']) |
Ihar Hrachyshka | b7940d9 | 2016-06-10 13:44:22 +0200 | [diff] [blame] | 706 | prev_links, body = self.list_client.get_uri_with_links( |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 707 | self.plural_name, uri |
| 708 | ) |
| 709 | resources_ = self._extract_resources(body) |
| 710 | self.assertEqual(1, len(resources_)) |
| 711 | resources2.extend(resources_) |
| 712 | |
| 713 | self.assertSameOrder(resources, reversed(resources2)) |
| 714 | |
| 715 | return resources |
| 716 | |
| 717 | @_require_pagination |
| 718 | @_require_sorting |
| 719 | def _test_list_pagination_with_href_links(self): |
| 720 | self._test_list_pagination_iteratively(self._list_all_with_hrefs) |
| 721 | |
| 722 | @_require_pagination |
| 723 | @_require_sorting |
| 724 | def _test_list_pagination_page_reverse_with_href_links( |
| 725 | self, direction=constants.SORT_DIRECTION_ASC): |
| 726 | pagination_args = { |
| 727 | 'sort_dir': direction, |
Armando Migliaccio | 57581c6 | 2016-07-01 10:13:19 -0700 | [diff] [blame] | 728 | 'sort_key': self.field, |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 729 | } |
| 730 | body = self.list_method(**pagination_args) |
| 731 | expected_resources = self._extract_resources(body) |
| 732 | |
| 733 | page_size = 2 |
| 734 | pagination_args['limit'] = page_size |
| 735 | |
| 736 | prev_links = {} |
| 737 | resources = [] |
| 738 | num_resources = len(expected_resources) |
| 739 | niterations = int(math.ceil(float(num_resources) / page_size)) |
| 740 | for i in range(niterations): |
| 741 | if prev_links: |
| 742 | uri = self.get_bare_url(prev_links['previous']) |
| 743 | else: |
Ihar Hrachyshka | 7f79fe6 | 2016-06-07 21:23:44 +0200 | [diff] [blame] | 744 | pagination_args.update(self.list_kwargs) |
Ihar Hrachyshka | b7940d9 | 2016-06-10 13:44:22 +0200 | [diff] [blame] | 745 | uri = self.list_client.build_uri( |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 746 | self.plural_name, page_reverse=True, **pagination_args) |
Ihar Hrachyshka | b7940d9 | 2016-06-10 13:44:22 +0200 | [diff] [blame] | 747 | prev_links, body = self.list_client.get_uri_with_links( |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 748 | self.plural_name, uri |
| 749 | ) |
| 750 | resources_ = self._extract_resources(body) |
Béla Vancsics | f180618 | 2016-08-23 07:36:18 +0200 | [diff] [blame] | 751 | self.assertGreaterEqual(page_size, len(resources_)) |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 752 | resources.extend(reversed(resources_)) |
| 753 | |
| 754 | self.assertSameOrder(expected_resources, reversed(resources)) |
| 755 | |
| 756 | @_require_pagination |
| 757 | @_require_sorting |
| 758 | def _test_list_pagination_page_reverse_asc(self): |
| 759 | self._test_list_pagination_page_reverse( |
| 760 | direction=constants.SORT_DIRECTION_ASC) |
| 761 | |
| 762 | @_require_pagination |
| 763 | @_require_sorting |
| 764 | def _test_list_pagination_page_reverse_desc(self): |
| 765 | self._test_list_pagination_page_reverse( |
| 766 | direction=constants.SORT_DIRECTION_DESC) |
| 767 | |
| 768 | def _test_list_pagination_page_reverse(self, direction): |
| 769 | pagination_args = { |
| 770 | 'sort_dir': direction, |
Armando Migliaccio | 57581c6 | 2016-07-01 10:13:19 -0700 | [diff] [blame] | 771 | 'sort_key': self.field, |
Ihar Hrachyshka | aeb03a0 | 2016-05-18 20:03:18 +0200 | [diff] [blame] | 772 | 'limit': 3, |
| 773 | } |
| 774 | body = self.list_method(**pagination_args) |
| 775 | expected_resources = self._extract_resources(body) |
| 776 | |
| 777 | pagination_args['limit'] -= 1 |
| 778 | pagination_args['marker'] = expected_resources[-1]['id'] |
| 779 | pagination_args['page_reverse'] = True |
| 780 | body = self.list_method(**pagination_args) |
| 781 | |
| 782 | self.assertSameOrder( |
| 783 | # the last entry is not included in 2nd result when used as a |
| 784 | # marker |
| 785 | expected_resources[:-1], |
| 786 | self._extract_resources(body)) |
Victor Morales | 1be97b4 | 2016-09-05 08:50:06 -0500 | [diff] [blame] | 787 | |
| 788 | def _test_list_validation_filters(self): |
| 789 | validation_args = { |
| 790 | 'unknown_filter': 'value', |
| 791 | } |
| 792 | body = self.list_method(**validation_args) |
| 793 | resources = self._extract_resources(body) |
| 794 | for resource in resources: |
| 795 | self.assertIn(resource['name'], self.resource_names) |