blob: 9d53f794cf83baaa84970b57b5305f66d0cd7982 [file] [log] [blame]
Itzik Browne67ebb52016-05-15 05:34:41 +00001# Copyright 2016 Red Hat, Inc.
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.
Rodolfo Alonso Hernandez13546b82022-05-12 23:56:47 +000015
Slawek Kaplonskiaf83e832020-02-05 12:11:54 +010016import re
Chandan Kumarc125fd12017-11-15 19:41:01 +053017import subprocess
Itzik Browne67ebb52016-05-15 05:34:41 +000018
Federico Ressibf877c82018-08-22 08:36:37 +020019from debtcollector import removals
YAMAMOTO Takashi25935722017-01-23 15:34:11 +090020import netaddr
Assaf Muller92fdc782018-05-31 10:32:47 -040021from neutron_lib.api import validators
22from neutron_lib import constants as neutron_lib_constants
Alex Stafeyevc4d9c352016-12-12 04:13:33 -050023from oslo_log import log
Rodolfo Alonso Hernandez13546b82022-05-12 23:56:47 +000024from packaging import version as packaging_version
Slawek Kaplonski8cccfe02020-09-29 22:34:09 +020025from paramiko import ssh_exception as ssh_exc
Genadi Chereshnya6d10c6e2017-07-05 11:34:20 +030026from tempest.common.utils import net_utils
Itzik Browne67ebb52016-05-15 05:34:41 +000027from tempest.common import waiters
Itzik Browne67ebb52016-05-15 05:34:41 +000028from tempest.lib.common.utils import data_utils
YAMAMOTO Takashi25935722017-01-23 15:34:11 +090029from tempest.lib.common.utils import test_utils
Jakub Libosvarc0c2f1d2017-01-31 12:12:21 -050030from tempest.lib import exceptions as lib_exc
Itzik Browne67ebb52016-05-15 05:34:41 +000031
Chandan Kumar667d3d32017-09-22 12:24:06 +053032from neutron_tempest_plugin.api import base as base_api
Rodolfo Alonso Hernandez4849f002020-01-16 16:01:10 +000033from neutron_tempest_plugin.common import ip as ip_utils
Slawek Kaplonskic4e963e2019-09-11 22:55:34 +020034from neutron_tempest_plugin.common import shell
Chandan Kumar667d3d32017-09-22 12:24:06 +053035from neutron_tempest_plugin.common import ssh
Slawek Kaplonskifd4141f2020-03-14 14:34:00 +010036from neutron_tempest_plugin.common import utils
Chandan Kumar667d3d32017-09-22 12:24:06 +053037from neutron_tempest_plugin import config
Slawek Kaplonskiaf83e832020-02-05 12:11:54 +010038from neutron_tempest_plugin import exceptions
Chandan Kumar667d3d32017-09-22 12:24:06 +053039from neutron_tempest_plugin.scenario import constants
Itzik Browne67ebb52016-05-15 05:34:41 +000040
41CONF = config.CONF
Alex Stafeyevc4d9c352016-12-12 04:13:33 -050042LOG = log.getLogger(__name__)
Eduardo Olivares46fa4242022-04-18 12:47:43 +020043SSH_EXC_TUPLE = (lib_exc.SSHTimeout,
44 ssh_exc.AuthenticationException,
45 ssh_exc.NoValidConnectionsError,
46 ConnectionResetError)
Alex Stafeyevc4d9c352016-12-12 04:13:33 -050047
Itzik Browne67ebb52016-05-15 05:34:41 +000048
Slawek Kaplonskiaf83e832020-02-05 12:11:54 +010049def get_ncat_version(ssh_client=None):
50 cmd = "ncat --version 2>&1"
51 try:
52 version_result = shell.execute(cmd, ssh_client=ssh_client).stdout
53 except exceptions.ShellCommandFailed:
54 m = None
55 else:
56 m = re.match(r"Ncat: Version ([\d.]+) *.", version_result)
57 # NOTE(slaweq): by default lets assume we have ncat 7.60 which is in Ubuntu
58 # 18.04 which is used on u/s gates
Rodolfo Alonso Hernandez13546b82022-05-12 23:56:47 +000059 return packaging_version.Version(m.group(1) if m else '7.60')
Slawek Kaplonskiaf83e832020-02-05 12:11:54 +010060
61
Slawek Kaplonskifd4141f2020-03-14 14:34:00 +010062def get_ncat_server_cmd(port, protocol, msg=None):
Slawek Kaplonskiaf83e832020-02-05 12:11:54 +010063 udp = ''
64 if protocol.lower() == neutron_lib_constants.PROTO_NAME_UDP:
65 udp = '-u'
66 cmd = "nc %(udp)s -p %(port)s -lk " % {
67 'udp': udp, 'port': port}
Slawek Kaplonskifd4141f2020-03-14 14:34:00 +010068 if msg:
69 if CONF.neutron_plugin_options.default_image_is_advanced:
Flavio Fernandesb056ac22020-07-01 14:57:13 -040070 cmd += "-c 'echo %s' " % msg
Slawek Kaplonskifd4141f2020-03-14 14:34:00 +010071 else:
Flavio Fernandesb056ac22020-07-01 14:57:13 -040072 cmd += "-e echo %s " % msg
73 cmd += "< /dev/zero &{0}sleep 0.1{0}".format('\n')
Slawek Kaplonskiaf83e832020-02-05 12:11:54 +010074 return cmd
75
76
Slawek Kaplonski663bbc22023-04-05 16:30:20 +020077def get_ncat_client_cmd(ip_address, port, protocol, ssh_client=None):
Slawek Kaplonskiaf83e832020-02-05 12:11:54 +010078 cmd = 'echo "knock knock" | nc '
Slawek Kaplonskifddcd182023-07-04 11:28:06 +020079 ncat_version = get_ncat_version(ssh_client=ssh_client)
80 if ncat_version > packaging_version.Version('7.60'):
81 cmd += '-d 1 '
Slawek Kaplonskidd5b0e62023-05-31 13:57:25 +020082 if protocol.lower() == neutron_lib_constants.PROTO_NAME_UDP:
83 cmd += '-u '
Slawek Kaplonskidd5b0e62023-05-31 13:57:25 +020084 if ncat_version > packaging_version.Version('7.60'):
85 cmd += '-z '
86 cmd += '-w 1 %(host)s %(port)s' % {'host': ip_address, 'port': port}
Slawek Kaplonskiaf83e832020-02-05 12:11:54 +010087 return cmd
88
89
Itzik Browne67ebb52016-05-15 05:34:41 +000090class BaseTempestTestCase(base_api.BaseNetworkTest):
Itzik Browne67ebb52016-05-15 05:34:41 +000091
Genadi Chereshnya918dd0b2017-05-17 13:02:20 +000092 def create_server(self, flavor_ref, image_ref, key_name, networks,
Roee Agiman6a0a18a2017-11-16 11:51:56 +020093 **kwargs):
Itzik Brownbac51dc2016-10-31 12:25:04 +000094 """Create a server using tempest lib
Brian Haleyaee61ac2018-10-09 20:00:27 -040095
Itzik Brownbac51dc2016-10-31 12:25:04 +000096 All the parameters are the ones used in Compute API
Roee Agiman6a0a18a2017-11-16 11:51:56 +020097 * - Kwargs that require admin privileges
Itzik Brownbac51dc2016-10-31 12:25:04 +000098
99 Args:
100 flavor_ref(str): The flavor of the server to be provisioned.
101 image_ref(str): The image of the server to be provisioned.
102 key_name(str): SSH key to to be used to connect to the
103 provisioned server.
104 networks(list): List of dictionaries where each represent
105 an interface to be attached to the server. For network
106 it should be {'uuid': network_uuid} and for port it should
107 be {'port': port_uuid}
Roee Agiman6a0a18a2017-11-16 11:51:56 +0200108 kwargs:
Itzik Brownbac51dc2016-10-31 12:25:04 +0000109 name(str): Name of the server to be provisioned.
110 security_groups(list): List of dictionaries where
111 the keys is 'name' and the value is the name of
112 the security group. If it's not passed the default
113 security group will be used.
Roee Agiman6a0a18a2017-11-16 11:51:56 +0200114 availability_zone(str)*: The availability zone that
115 the instance will be in.
116 You can request a specific az without actually creating one,
117 Just pass 'X:Y' where X is the default availability
118 zone, and Y is the compute host name.
Itzik Brownbac51dc2016-10-31 12:25:04 +0000119 """
120
Jakub Libosvarffd9b912017-11-16 09:54:14 +0000121 kwargs.setdefault('name', data_utils.rand_name('server-test'))
Itzik Brownbac51dc2016-10-31 12:25:04 +0000122
Jakub Libosvarffd9b912017-11-16 09:54:14 +0000123 # We cannot use setdefault() here because caller could have passed
124 # security_groups=None and we don't want to pass None to
125 # client.create_server()
126 if not kwargs.get('security_groups'):
127 kwargs['security_groups'] = [{'name': 'default'}]
Roee Agiman6a0a18a2017-11-16 11:51:56 +0200128
Slawek Kaplonski2211eab2020-10-20 16:43:53 +0200129 client = kwargs.pop('client', None)
130 if client is None:
131 client = self.os_primary.servers_client
132 if kwargs.get('availability_zone'):
133 client = self.os_admin.servers_client
Roee Agiman6a0a18a2017-11-16 11:51:56 +0200134
Jakub Libosvarffd9b912017-11-16 09:54:14 +0000135 server = client.create_server(
136 flavorRef=flavor_ref,
137 imageRef=image_ref,
138 key_name=key_name,
139 networks=networks,
140 **kwargs)
Genadi Chereshnya918dd0b2017-05-17 13:02:20 +0000141
142 self.addCleanup(test_utils.call_and_ignore_notfound_exc,
Roee Agiman6a0a18a2017-11-16 11:51:56 +0200143 waiters.wait_for_server_termination,
144 client,
145 server['server']['id'])
Genadi Chereshnya918dd0b2017-05-17 13:02:20 +0000146 self.addCleanup(test_utils.call_and_ignore_notfound_exc,
Roee Agiman6a0a18a2017-11-16 11:51:56 +0200147 client.delete_server,
Genadi Chereshnya918dd0b2017-05-17 13:02:20 +0000148 server['server']['id'])
Slawek Kaplonski2211eab2020-10-20 16:43:53 +0200149
150 self.wait_for_server_active(server['server'], client=client)
151 self.wait_for_guest_os_ready(server['server'], client=client)
152
Itzik Browne67ebb52016-05-15 05:34:41 +0000153 return server
154
155 @classmethod
Jens Harbott54357632017-11-21 11:47:06 +0000156 def create_secgroup_rules(cls, rule_list, secgroup_id=None,
157 client=None):
Roee Agiman6a0a18a2017-11-16 11:51:56 +0200158 client = client or cls.os_primary.network_client
Itzik Browne67ebb52016-05-15 05:34:41 +0000159 if not secgroup_id:
160 sgs = client.list_security_groups()['security_groups']
161 for sg in sgs:
162 if sg['name'] == constants.DEFAULT_SECURITY_GROUP:
163 secgroup_id = sg['id']
164 break
Hang Yange6e0ccf2021-02-26 15:07:05 -0600165 resp = []
Itzik Brown1ef813a2016-06-06 12:56:21 +0000166 for rule in rule_list:
167 direction = rule.pop('direction')
Hang Yange6e0ccf2021-02-26 15:07:05 -0600168 resp.append(client.create_security_group_rule(
169 direction=direction,
170 security_group_id=secgroup_id,
171 **rule)['security_group_rule'])
172 return resp
Itzik Brown1ef813a2016-06-06 12:56:21 +0000173
174 @classmethod
Roee Agiman6a0a18a2017-11-16 11:51:56 +0200175 def create_loginable_secgroup_rule(cls, secgroup_id=None,
176 client=None):
Itzik Brown1ef813a2016-06-06 12:56:21 +0000177 """This rule is intended to permit inbound ssh
178
179 Allowing ssh traffic traffic from all sources, so no group_id is
180 provided.
181 Setting a group_id would only permit traffic from ports
182 belonging to the same security group.
183 """
Federico Ressi4c590d72018-10-10 14:01:08 +0200184 return cls.create_security_group_rule(
185 security_group_id=secgroup_id,
186 client=client,
187 protocol=neutron_lib_constants.PROTO_NAME_TCP,
188 direction=neutron_lib_constants.INGRESS_DIRECTION,
189 port_range_min=22,
190 port_range_max=22)
Itzik Browne67ebb52016-05-15 05:34:41 +0000191
192 @classmethod
Slawek Kaplonski83979b92022-12-15 14:15:12 +0100193 def create_ingress_metadata_secgroup_rule(cls, secgroup_id=None):
194 """This rule is intended to permit inbound metadata traffic
195
196 Allowing ingress traffic from metadata server, required only for
197 stateless security groups.
198 """
Maor Blaustein0ea053c2023-02-16 17:23:53 +0200199 # NOTE(slaweq): in case of stateless security groups, there is no
200 # "related" or "established" traffic matching at all so even if
201 # egress traffic to 169.254.169.254 is allowed by default SG, we
202 # need to explicitly allow ingress traffic from the metadata server
203 # to be able to receive responses in the guest vm
204 cls.create_security_group_rule(
205 security_group_id=secgroup_id,
206 direction=neutron_lib_constants.INGRESS_DIRECTION,
207 protocol=neutron_lib_constants.PROTO_NAME_TCP,
208 remote_ip_prefix='169.254.169.254/32',
209 description='metadata out'
210 )
Slawek Kaplonski83979b92022-12-15 14:15:12 +0100211
212 @classmethod
Roee Agiman6a0a18a2017-11-16 11:51:56 +0200213 def create_pingable_secgroup_rule(cls, secgroup_id=None,
214 client=None):
Federico Ressi4c590d72018-10-10 14:01:08 +0200215 """This rule is intended to permit inbound ping
YAMAMOTO Takashi25935722017-01-23 15:34:11 +0900216
Federico Ressi4c590d72018-10-10 14:01:08 +0200217 """
218 return cls.create_security_group_rule(
219 security_group_id=secgroup_id, client=client,
220 protocol=neutron_lib_constants.PROTO_NAME_ICMP,
221 direction=neutron_lib_constants.INGRESS_DIRECTION)
YAMAMOTO Takashi25935722017-01-23 15:34:11 +0900222
223 @classmethod
Genadi Chereshnyac0411e92016-07-11 16:59:42 +0300224 def create_router_by_client(cls, is_admin=False, **kwargs):
225 kwargs.update({'router_name': data_utils.rand_name('router'),
226 'admin_state_up': True,
227 'external_network_id': CONF.network.public_network_id})
228 if not is_admin:
229 router = cls.create_router(**kwargs)
230 else:
231 router = cls.create_admin_router(**kwargs)
Alex Stafeyevc4d9c352016-12-12 04:13:33 -0500232 LOG.debug("Created router %s", router['name'])
Slawek Kaplonskiedf3cba2021-04-21 10:34:02 +0200233 cls._wait_for_router_ha_active(router['id'])
Itzik Browne67ebb52016-05-15 05:34:41 +0000234 return router
235
ccamposre6b10042021-02-12 12:26:08 +0100236 @classmethod
Slawek Kaplonskiedf3cba2021-04-21 10:34:02 +0200237 def _wait_for_router_ha_active(cls, router_id):
238 router = cls.os_admin.network_client.show_router(router_id)['router']
239 if not router.get('ha'):
240 return
241
242 def _router_active_on_l3_agent():
243 agents = cls.os_admin.network_client.list_l3_agents_hosting_router(
244 router_id)['agents']
245 return "active" in [agent['ha_state'] for agent in agents]
246
247 error_msg = (
248 "Router %s is not active on any of the L3 agents" % router_id)
Slawek Kaplonskibb1532a2021-06-17 13:45:56 +0000249 # NOTE(slaweq): timeout here should be lower for sure, but due to
250 # the bug https://launchpad.net/bugs/1923633 let's wait even 10
251 # minutes until router will be active on some of the L3 agents
252 utils.wait_until_true(_router_active_on_l3_agent,
253 timeout=600, sleep=5,
254 exception=lib_exc.TimeoutException(error_msg))
Slawek Kaplonskiedf3cba2021-04-21 10:34:02 +0200255
256 @classmethod
ccamposre6b10042021-02-12 12:26:08 +0100257 def skip_if_no_extension_enabled_in_l3_agents(cls, extension):
258 l3_agents = cls.os_admin.network_client.list_agents(
259 binary='neutron-l3-agent')['agents']
260 if not l3_agents:
261 # the tests should not be skipped when neutron-l3-agent does not
262 # exist (this validation doesn't apply to the setups like
263 # e.g. ML2/OVN)
264 return
265 for agent in l3_agents:
266 if extension in agent['configurations'].get('extensions', []):
267 return
268 raise cls.skipTest("No L3 agent with '%s' extension enabled found." %
269 extension)
270
Federico Ressibf877c82018-08-22 08:36:37 +0200271 @removals.remove(version='Stein',
272 message="Please use create_floatingip method instead of "
273 "create_and_associate_floatingip.")
Roee Agiman6a0a18a2017-11-16 11:51:56 +0200274 def create_and_associate_floatingip(self, port_id, client=None):
275 client = client or self.os_primary.network_client
Federico Ressibf877c82018-08-22 08:36:37 +0200276 return self.create_floatingip(port_id=port_id, client=client)
Itzik Browne67ebb52016-05-15 05:34:41 +0000277
Hongbin Lu965b03d2018-04-25 22:32:30 +0000278 def create_interface(cls, server_id, port_id, client=None):
279 client = client or cls.os_primary.interfaces_client
280 body = client.create_interface(server_id, port_id=port_id)
281 return body['interfaceAttachment']
282
283 def delete_interface(cls, server_id, port_id, client=None):
284 client = client or cls.os_primary.interfaces_client
285 client.delete_interface(server_id, port_id=port_id)
286
Brian Haleyd11f4ec2019-08-13 12:09:57 -0400287 def setup_network_and_server(self, router=None, server_name=None,
288 network=None, **kwargs):
Genadi Chereshnyac0411e92016-07-11 16:59:42 +0300289 """Create network resources and a server.
Itzik Brownbac51dc2016-10-31 12:25:04 +0000290
291 Creating a network, subnet, router, keypair, security group
292 and a server.
293 """
Assaf Mullerd54ae6c2018-05-31 11:38:00 -0400294 self.network = network or self.create_network()
Genadi Chereshnya918dd0b2017-05-17 13:02:20 +0000295 LOG.debug("Created network %s", self.network['name'])
296 self.subnet = self.create_subnet(self.network)
297 LOG.debug("Created subnet %s", self.subnet['id'])
Itzik Brown1ef813a2016-06-06 12:56:21 +0000298
Brian Haleyf86ac2e2017-06-21 10:43:50 -0400299 secgroup = self.os_primary.network_client.create_security_group(
Chandan Kumarc125fd12017-11-15 19:41:01 +0530300 name=data_utils.rand_name('secgroup'))
Alex Stafeyevc4d9c352016-12-12 04:13:33 -0500301 LOG.debug("Created security group %s",
302 secgroup['security_group']['name'])
Genadi Chereshnya918dd0b2017-05-17 13:02:20 +0000303 self.security_groups.append(secgroup['security_group'])
Genadi Chereshnyac0411e92016-07-11 16:59:42 +0300304 if not router:
Genadi Chereshnya918dd0b2017-05-17 13:02:20 +0000305 router = self.create_router_by_client(**kwargs)
306 self.create_router_interface(router['id'], self.subnet['id'])
307 self.keypair = self.create_keypair()
308 self.create_loginable_secgroup_rule(
Itzik Brownbac51dc2016-10-31 12:25:04 +0000309 secgroup_id=secgroup['security_group']['id'])
Assaf Muller92fdc782018-05-31 10:32:47 -0400310
311 server_kwargs = {
312 'flavor_ref': CONF.compute.flavor_ref,
313 'image_ref': CONF.compute.image_ref,
314 'key_name': self.keypair['name'],
315 'networks': [{'uuid': self.network['id']}],
316 'security_groups': [{'name': secgroup['security_group']['name']}],
317 }
318 if server_name is not None:
319 server_kwargs['name'] = server_name
320
321 self.server = self.create_server(**server_kwargs)
Jakub Libosvar1345d9d2017-06-09 13:59:05 +0000322 self.port = self.client.list_ports(network_id=self.network['id'],
323 device_id=self.server[
324 'server']['id'])['ports'][0]
Federico Ressibf877c82018-08-22 08:36:37 +0200325 self.fip = self.create_floatingip(port=self.port)
Jakub Libosvarc0c2f1d2017-01-31 12:12:21 -0500326
Bence Romsics2abbc922020-09-30 16:10:07 +0200327 def check_connectivity(self, host, ssh_user=None, ssh_key=None,
328 servers=None, ssh_timeout=None, ssh_client=None):
329 # Either ssh_client or ssh_user+ssh_key is mandatory.
330 if ssh_client is None:
331 ssh_client = ssh.Client(host, ssh_user,
332 pkey=ssh_key, timeout=ssh_timeout)
Jakub Libosvarc0c2f1d2017-01-31 12:12:21 -0500333 try:
334 ssh_client.test_connection_auth()
Eduardo Olivares46fa4242022-04-18 12:47:43 +0200335 except SSH_EXC_TUPLE as ssh_e:
Jakub Libosvarc0c2f1d2017-01-31 12:12:21 -0500336 LOG.debug(ssh_e)
337 self._log_console_output(servers)
Rodolfo Alonso Hernandez4849f002020-01-16 16:01:10 +0000338 self._log_local_network_status()
Jakub Libosvarc0c2f1d2017-01-31 12:12:21 -0500339 raise
340
341 def _log_console_output(self, servers=None):
342 if not CONF.compute_feature_enabled.console_output:
343 LOG.debug('Console output not supported, cannot log')
344 return
345 if not servers:
Brian Haleyf86ac2e2017-06-21 10:43:50 -0400346 servers = self.os_primary.servers_client.list_servers()
Jakub Libosvarc0c2f1d2017-01-31 12:12:21 -0500347 servers = servers['servers']
348 for server in servers:
Slawek Kaplonskicff79232020-03-03 14:12:18 +0100349 # NOTE(slaweq): sometimes servers are passed in dictionary with
350 # "server" key as first level key and in other cases it may be that
351 # it is just the "inner" dict without "server" key. Lets try to
352 # handle both cases
353 server = server.get("server") or server
Jakub Libosvarc0c2f1d2017-01-31 12:12:21 -0500354 try:
355 console_output = (
Brian Haleyf86ac2e2017-06-21 10:43:50 -0400356 self.os_primary.servers_client.get_console_output(
Jakub Libosvarc0c2f1d2017-01-31 12:12:21 -0500357 server['id'])['output'])
358 LOG.debug('Console output for %s\nbody=\n%s',
359 server['id'], console_output)
360 except lib_exc.NotFound:
361 LOG.debug("Server %s disappeared(deleted) while looking "
362 "for the console log", server['id'])
YAMAMOTO Takashi25935722017-01-23 15:34:11 +0900363
Rodolfo Alonso Hernandez4849f002020-01-16 16:01:10 +0000364 def _log_local_network_status(self):
Slawek Kaplonski8033af72020-05-05 12:01:37 +0200365 self._log_ns_network_status()
366 for ns_name in ip_utils.IPCommand().list_namespaces():
367 self._log_ns_network_status(ns_name=ns_name)
368
369 def _log_ns_network_status(self, ns_name=None):
Rodolfo Alonso Hernandez9817d4f2020-11-17 08:50:50 +0000370 try:
371 local_ips = ip_utils.IPCommand(namespace=ns_name).list_addresses()
372 local_routes = ip_utils.IPCommand(namespace=ns_name).list_routes()
Rodolfo Alonso Hernandezc134ea92021-04-14 15:15:01 +0000373 arp_table = ip_utils.arp_table(namespace=ns_name)
374 iptables = ip_utils.list_iptables(namespace=ns_name)
375 lsockets = ip_utils.list_listening_sockets(namespace=ns_name)
Rodolfo Alonso Hernandez9817d4f2020-11-17 08:50:50 +0000376 except exceptions.ShellCommandFailed:
377 LOG.debug('Namespace %s has been deleted synchronously during the '
378 'host network collection process', ns_name)
379 return
380
Slawek Kaplonski8033af72020-05-05 12:01:37 +0200381 LOG.debug('Namespace %s; IP Addresses:\n%s',
382 ns_name, '\n'.join(str(r) for r in local_ips))
Slawek Kaplonski8033af72020-05-05 12:01:37 +0200383 LOG.debug('Namespace %s; Local routes:\n%s',
384 ns_name, '\n'.join(str(r) for r in local_routes))
Slawek Kaplonski8033af72020-05-05 12:01:37 +0200385 LOG.debug('Namespace %s; Local ARP table:\n%s',
386 ns_name, '\n'.join(str(r) for r in arp_table))
Rodolfo Alonso Hernandezc134ea92021-04-14 15:15:01 +0000387 LOG.debug('Namespace %s; Local iptables:\n%s', ns_name, iptables)
388 LOG.debug('Namespace %s; Listening sockets:\n%s', ns_name, lsockets)
Rodolfo Alonso Hernandez4849f002020-01-16 16:01:10 +0000389
LIU Yulong68ab2452019-05-18 10:19:49 +0800390 def _check_remote_connectivity(self, source, dest, count,
391 should_succeed=True,
Assaf Muller92fdc782018-05-31 10:32:47 -0400392 nic=None, mtu=None, fragmentation=True,
Roman Safronov12663cf2020-07-27 13:11:07 +0300393 timeout=None, pattern=None,
Nurmatov Mamatisa1b1c9d32021-12-27 15:37:03 +0300394 forbid_packet_loss=False,
395 check_response_ip=True):
YAMAMOTO Takashi25935722017-01-23 15:34:11 +0900396 """check ping server via source ssh connection
397
398 :param source: RemoteClient: an ssh connection from which to ping
399 :param dest: and IP to ping against
LIU Yulong68ab2452019-05-18 10:19:49 +0800400 :param count: Number of ping packet(s) to send
YAMAMOTO Takashi25935722017-01-23 15:34:11 +0900401 :param should_succeed: boolean should ping succeed or not
402 :param nic: specific network interface to ping from
Genadi Chereshnya6d10c6e2017-07-05 11:34:20 +0300403 :param mtu: mtu size for the packet to be sent
404 :param fragmentation: Flag for packet fragmentation
LIU Yulong68ab2452019-05-18 10:19:49 +0800405 :param timeout: Timeout for all ping packet(s) to succeed
Eduardo Olivaresf2b60542020-01-30 09:37:22 +0100406 :param pattern: hex digits included in ICMP messages
Roman Safronov12663cf2020-07-27 13:11:07 +0300407 :param forbid_packet_loss: forbid or allow some lost packets
Nurmatov Mamatisa1b1c9d32021-12-27 15:37:03 +0300408 :param check_response_ip: check response ip
YAMAMOTO Takashi25935722017-01-23 15:34:11 +0900409 :returns: boolean -- should_succeed == ping
410 :returns: ping is false if ping failed
411 """
LIU Yulong68ab2452019-05-18 10:19:49 +0800412 def ping_host(source, host, count,
Genadi Chereshnya6d10c6e2017-07-05 11:34:20 +0300413 size=CONF.validation.ping_size, nic=None, mtu=None,
Eduardo Olivaresf2b60542020-01-30 09:37:22 +0100414 fragmentation=True, pattern=None):
Assaf Muller92fdc782018-05-31 10:32:47 -0400415 IP_VERSION_4 = neutron_lib_constants.IP_VERSION_4
416 IP_VERSION_6 = neutron_lib_constants.IP_VERSION_6
417
418 # Use 'ping6' for IPv6 addresses, 'ping' for IPv4 and hostnames
419 ip_version = (
420 IP_VERSION_6 if netaddr.valid_ipv6(host) else IP_VERSION_4)
421 cmd = (
422 'ping6' if ip_version == IP_VERSION_6 else 'ping')
YAMAMOTO Takashi25935722017-01-23 15:34:11 +0900423 if nic:
424 cmd = 'sudo {cmd} -I {nic}'.format(cmd=cmd, nic=nic)
Genadi Chereshnya6d10c6e2017-07-05 11:34:20 +0300425 if mtu:
426 if not fragmentation:
427 cmd += ' -M do'
428 size = str(net_utils.get_ping_payload_size(
Assaf Muller92fdc782018-05-31 10:32:47 -0400429 mtu=mtu, ip_version=ip_version))
Eduardo Olivaresf2b60542020-01-30 09:37:22 +0100430 if pattern:
431 cmd += ' -p {pattern}'.format(pattern=pattern)
Maciej Józefczyk3c324e02020-03-16 10:52:08 +0000432 cmd += ' -c{0} -W{0} -s{1} {2}'.format(count, size, host)
YAMAMOTO Takashi25935722017-01-23 15:34:11 +0900433 return source.exec_command(cmd)
434
435 def ping_remote():
436 try:
LIU Yulong68ab2452019-05-18 10:19:49 +0800437 result = ping_host(source, dest, count, nic=nic, mtu=mtu,
Eduardo Olivaresf2b60542020-01-30 09:37:22 +0100438 fragmentation=fragmentation,
439 pattern=pattern)
YAMAMOTO Takashi25935722017-01-23 15:34:11 +0900440
441 except lib_exc.SSHExecCommandFailed:
442 LOG.warning('Failed to ping IP: %s via a ssh connection '
443 'from: %s.', dest, source.host)
444 return not should_succeed
445 LOG.debug('ping result: %s', result)
Assaf Muller92fdc782018-05-31 10:32:47 -0400446
Roman Safronov12663cf2020-07-27 13:11:07 +0300447 if forbid_packet_loss and ' 0% packet loss' not in result:
448 LOG.debug('Packet loss detected')
449 return not should_succeed
450
Nurmatov Mamatisa1b1c9d32021-12-27 15:37:03 +0300451 if (check_response_ip and
452 validators.validate_ip_address(dest) is None):
Assaf Muller92fdc782018-05-31 10:32:47 -0400453 # Assert that the return traffic was from the correct
454 # source address.
455 from_source = 'from %s' % dest
456 self.assertIn(from_source, result)
YAMAMOTO Takashi25935722017-01-23 15:34:11 +0900457 return should_succeed
458
Assaf Muller92fdc782018-05-31 10:32:47 -0400459 return test_utils.call_until_true(
460 ping_remote, timeout or CONF.validation.ping_timeout, 1)
YAMAMOTO Takashi25935722017-01-23 15:34:11 +0900461
462 def check_remote_connectivity(self, source, dest, should_succeed=True,
Slawek Kaplonskib07251f2018-05-16 12:21:50 +0200463 nic=None, mtu=None, fragmentation=True,
LIU Yulong68ab2452019-05-18 10:19:49 +0800464 servers=None, timeout=None,
Eduardo Olivaresf2b60542020-01-30 09:37:22 +0100465 ping_count=CONF.validation.ping_count,
Nurmatov Mamatisa1b1c9d32021-12-27 15:37:03 +0300466 pattern=None, forbid_packet_loss=False,
467 check_response_ip=True):
Slawek Kaplonskib07251f2018-05-16 12:21:50 +0200468 try:
469 self.assertTrue(self._check_remote_connectivity(
LIU Yulong68ab2452019-05-18 10:19:49 +0800470 source, dest, ping_count, should_succeed, nic, mtu,
471 fragmentation,
Roman Safronov12663cf2020-07-27 13:11:07 +0300472 timeout=timeout, pattern=pattern,
Nurmatov Mamatisa1b1c9d32021-12-27 15:37:03 +0300473 forbid_packet_loss=forbid_packet_loss,
474 check_response_ip=check_response_ip))
Eduardo Olivares46fa4242022-04-18 12:47:43 +0200475 except SSH_EXC_TUPLE as ssh_e:
Slawek Kaplonskib07251f2018-05-16 12:21:50 +0200476 LOG.debug(ssh_e)
477 self._log_console_output(servers)
Slawek Kaplonski8cccfe02020-09-29 22:34:09 +0200478 self._log_local_network_status()
Slawek Kaplonskib07251f2018-05-16 12:21:50 +0200479 raise
480 except AssertionError:
481 self._log_console_output(servers)
Slawek Kaplonski8cccfe02020-09-29 22:34:09 +0200482 self._log_local_network_status()
Slawek Kaplonskib07251f2018-05-16 12:21:50 +0200483 raise
Chandan Kumarc125fd12017-11-15 19:41:01 +0530484
485 def ping_ip_address(self, ip_address, should_succeed=True,
486 ping_timeout=None, mtu=None):
487 # the code is taken from tempest/scenario/manager.py in tempest git
488 timeout = ping_timeout or CONF.validation.ping_timeout
489 cmd = ['ping', '-c1', '-w1']
490
491 if mtu:
492 cmd += [
493 # don't fragment
494 '-M', 'do',
495 # ping receives just the size of ICMP payload
496 '-s', str(net_utils.get_ping_payload_size(mtu, 4))
497 ]
498 cmd.append(ip_address)
499
500 def ping():
501 proc = subprocess.Popen(cmd,
502 stdout=subprocess.PIPE,
503 stderr=subprocess.PIPE)
504 proc.communicate()
505
506 return (proc.returncode == 0) == should_succeed
507
508 caller = test_utils.find_test_caller()
509 LOG.debug('%(caller)s begins to ping %(ip)s in %(timeout)s sec and the'
510 ' expected result is %(should_succeed)s', {
511 'caller': caller, 'ip': ip_address, 'timeout': timeout,
512 'should_succeed':
513 'reachable' if should_succeed else 'unreachable'
514 })
515 result = test_utils.call_until_true(ping, timeout, 1)
Manjeet Singh Bhatia8bbf8992019-03-04 11:59:57 -0800516
517 # To make sure ping_ip_address called by test works
518 # as expected.
519 self.assertTrue(result)
520
Chandan Kumarc125fd12017-11-15 19:41:01 +0530521 LOG.debug('%(caller)s finishes ping %(ip)s in %(timeout)s sec and the '
522 'ping result is %(result)s', {
523 'caller': caller, 'ip': ip_address, 'timeout': timeout,
524 'result': 'expected' if result else 'unexpected'
525 })
526 return result
Federico Ressie7417b72018-05-30 05:50:58 +0200527
528 def wait_for_server_status(self, server, status, client=None, **kwargs):
529 """Waits for a server to reach a given status.
530
531 :param server: mapping having schema {'id': <server_id>}
532 :param status: string status to wait for (es: 'ACTIVE')
533 :param clien: servers client (self.os_primary.servers_client as
534 default value)
535 """
536
537 client = client or self.os_primary.servers_client
538 waiters.wait_for_server_status(client, server['id'], status, **kwargs)
539
540 def wait_for_server_active(self, server, client=None):
541 """Waits for a server to reach active status.
542
543 :param server: mapping having schema {'id': <server_id>}
544 :param clien: servers client (self.os_primary.servers_client as
545 default value)
546 """
547 self.wait_for_server_status(
548 server, constants.SERVER_STATUS_ACTIVE, client)
Jakub Libosvar031fd5a2019-07-15 16:10:07 +0000549
Slawek Kaplonski2211eab2020-10-20 16:43:53 +0200550 def wait_for_guest_os_ready(self, server, client=None):
551 if not CONF.compute_feature_enabled.console_output:
552 LOG.debug('Console output not supported, cannot check if server '
Rodolfo Alonso Hernandezdff870b2020-11-06 08:41:44 +0000553 '%s is ready.', server['id'])
Slawek Kaplonski2211eab2020-10-20 16:43:53 +0200554 return
555
556 client = client or self.os_primary.servers_client
557
558 def system_booted():
559 console_output = client.get_console_output(server['id'])['output']
560 for line in console_output.split('\n'):
561 if 'login:' in line.lower():
562 return True
563 return False
564
565 try:
ccamposr1bd28ae2021-11-29 10:06:02 +0100566 utils.wait_until_true(system_booted, timeout=90, sleep=5)
Slawek Kaplonski2211eab2020-10-20 16:43:53 +0200567 except utils.WaitTimeout:
568 LOG.debug("No correct output in console of server %s found. "
569 "Guest operating system status can't be checked.",
570 server['id'])
571
Flavio Fernandesa1952c62020-10-02 06:39:08 -0400572 def check_servers_hostnames(self, servers, timeout=None, log_errors=True,
573 external_port=None):
Jakub Libosvar031fd5a2019-07-15 16:10:07 +0000574 """Compare hostnames of given servers with their names."""
575 try:
576 for server in servers:
577 kwargs = {}
nfridmand8969542020-06-02 14:59:09 +0300578 if timeout:
579 kwargs['timeout'] = timeout
Jakub Libosvar031fd5a2019-07-15 16:10:07 +0000580 try:
Flavio Fernandesa1952c62020-10-02 06:39:08 -0400581 kwargs['port'] = external_port or (
Slawek Kaplonskic4e963e2019-09-11 22:55:34 +0200582 server['port_forwarding_tcp']['external_port'])
Jakub Libosvar031fd5a2019-07-15 16:10:07 +0000583 except KeyError:
584 pass
585 ssh_client = ssh.Client(
586 self.fip['floating_ip_address'],
587 CONF.validation.image_ssh_user,
588 pkey=self.keypair['private_key'],
589 **kwargs)
590 self.assertIn(server['name'],
Rodolfo Alonso Hernandezaf394dd2020-11-12 14:26:13 +0000591 ssh_client.get_hostname())
Eduardo Olivares46fa4242022-04-18 12:47:43 +0200592 except SSH_EXC_TUPLE as ssh_e:
Jakub Libosvar031fd5a2019-07-15 16:10:07 +0000593 LOG.debug(ssh_e)
594 if log_errors:
595 self._log_console_output(servers)
Slawek Kaplonski8cccfe02020-09-29 22:34:09 +0200596 self._log_local_network_status()
Jakub Libosvar031fd5a2019-07-15 16:10:07 +0000597 raise
598 except AssertionError as assert_e:
599 LOG.debug(assert_e)
600 if log_errors:
601 self._log_console_output(servers)
Slawek Kaplonski8cccfe02020-09-29 22:34:09 +0200602 self._log_local_network_status()
Jakub Libosvar031fd5a2019-07-15 16:10:07 +0000603 raise
Slawek Kaplonskic4e963e2019-09-11 22:55:34 +0200604
Slawek Kaplonskifd4141f2020-03-14 14:34:00 +0100605 def ensure_nc_listen(self, ssh_client, port, protocol, echo_msg=None,
606 servers=None):
607 """Ensure that nc server listening on the given TCP/UDP port is up.
608
609 Listener is created always on remote host.
610 """
611 def spawn_and_check_process():
612 self.nc_listen(ssh_client, port, protocol, echo_msg, servers)
613 return utils.process_is_running(ssh_client, "nc")
614
615 utils.wait_until_true(spawn_and_check_process)
616
617 def nc_listen(self, ssh_client, port, protocol, echo_msg=None,
618 servers=None):
Slawek Kaplonskic4e963e2019-09-11 22:55:34 +0200619 """Create nc server listening on the given TCP/UDP port.
620
621 Listener is created always on remote host.
622 """
Slawek Kaplonskic4e963e2019-09-11 22:55:34 +0200623 try:
Slawek Kaplonskiaf83e832020-02-05 12:11:54 +0100624 return ssh_client.execute_script(
625 get_ncat_server_cmd(port, protocol, echo_msg),
Flavio Fernandesb056ac22020-07-01 14:57:13 -0400626 become_root=True, combine_stderr=True)
Eduardo Olivares46fa4242022-04-18 12:47:43 +0200627 except SSH_EXC_TUPLE as ssh_e:
Slawek Kaplonskic4e963e2019-09-11 22:55:34 +0200628 LOG.debug(ssh_e)
Slawek Kaplonskifd4141f2020-03-14 14:34:00 +0100629 self._log_console_output(servers)
Slawek Kaplonski8cccfe02020-09-29 22:34:09 +0200630 self._log_local_network_status()
Slawek Kaplonskic4e963e2019-09-11 22:55:34 +0200631 raise
632
Slawek Kaplonskib327a632023-02-23 07:59:12 +0100633 def nc_client(self, ip_address, port, protocol, ssh_client=None):
Slawek Kaplonskic4e963e2019-09-11 22:55:34 +0200634 """Check connectivity to TCP/UDP port at host via nc.
635
Slawek Kaplonskib327a632023-02-23 07:59:12 +0100636 If ssh_client is not given, it is executed locally on host where tests
637 are executed. Otherwise ssh_client object is used to execute it.
Slawek Kaplonskic4e963e2019-09-11 22:55:34 +0200638 """
Slawek Kaplonski663bbc22023-04-05 16:30:20 +0200639 cmd = get_ncat_client_cmd(ip_address, port, protocol,
640 ssh_client=ssh_client)
Slawek Kaplonski03bd62e2023-06-02 10:54:05 +0200641 result = shell.execute(cmd, ssh_client=ssh_client, check=False)
Slawek Kaplonskic4e963e2019-09-11 22:55:34 +0200642 return result.stdout
elajkat1f275e42021-10-15 12:47:55 +0200643
644 def _ensure_public_router(self, client=None, tenant_id=None):
645 """Retrieve a router for the given tenant id.
646
647 If a public router has been configured, it will be returned.
648
649 If a public router has not been configured, but a public
650 network has, a tenant router will be created and returned that
651 routes traffic to the public network.
652 """
653 if not client:
654 client = self.client
655 if not tenant_id:
Takashi Kajinamida451772023-03-22 00:19:39 +0900656 tenant_id = client.project_id
elajkat1f275e42021-10-15 12:47:55 +0200657 router_id = CONF.network.public_router_id
658 network_id = CONF.network.public_network_id
659 if router_id:
660 body = client.show_router(router_id)
661 return body['router']
662 elif network_id:
663 router = self.create_router_by_client()
664 self.addCleanup(test_utils.call_and_ignore_notfound_exc,
665 client.delete_router, router['id'])
666 kwargs = {'external_gateway_info': dict(network_id=network_id)}
667 router = client.update_router(router['id'], **kwargs)['router']
668 return router
669 else:
670 raise Exception("Neither of 'public_router_id' or "
671 "'public_network_id' has been defined.")
672
673 def _update_router_admin_state(self, router, admin_state_up):
674 kwargs = dict(admin_state_up=admin_state_up)
675 router = self.client.update_router(
676 router['id'], **kwargs)['router']
677 self.assertEqual(admin_state_up, router['admin_state_up'])
Slawek Kaplonski32b0f8b2023-03-10 17:03:20 +0100678
679 def _check_cmd_installed_on_server(self, ssh_client, server, cmd):
680 try:
681 ssh_client.execute_script('which %s' % cmd)
682 except SSH_EXC_TUPLE as ssh_e:
683 LOG.debug(ssh_e)
684 self._log_console_output([server])
685 self._log_local_network_status()
686 raise
687 except exceptions.SSHScriptFailed:
688 raise self.skipException(
689 "%s is not available on server %s" % (cmd, server['id']))