blob: 4ccec72c31befe3b0aedb8fbc196956f06153221 [file] [log] [blame]
Chandan Kumar5e619872017-09-07 22:23:55 +05301# Copyright 2011, VMware, 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.
15#
16# Borrowed from nova code base, more utilities will be added/borrowed as and
17# when needed.
18
19"""Utilities and helper functions."""
20
Chandan Kumar667d3d32017-09-22 12:24:06 +053021import threading
22import time
zheng.yong74e760a2019-05-22 14:16:14 +080023try:
24 import urlparse
25except ImportError:
26 from urllib import parse as urlparse
Chandan Kumar667d3d32017-09-22 12:24:06 +053027
Brian Haley33ef4602018-04-26 14:37:49 -040028import eventlet
Rodolfo Alonso Hernandez0adf8a22020-06-11 11:28:25 +000029
Maciej Józefczyk328edc82019-09-16 14:05:48 +000030from tempest.lib import exceptions
Brian Haley33ef4602018-04-26 14:37:49 -040031
Eduardo Olivares1f665d82022-02-14 17:22:54 +010032from neutron_tempest_plugin import config
33
Rodolfo Alonso Hernandez0adf8a22020-06-11 11:28:25 +000034
zheng.yong74e760a2019-05-22 14:16:14 +080035SCHEMA_PORT_MAPPING = {
36 "http": 80,
37 "https": 443,
38}
Eduardo Olivares1f665d82022-02-14 17:22:54 +010039CONF = config.CONF
zheng.yong74e760a2019-05-22 14:16:14 +080040
Chandan Kumar5e619872017-09-07 22:23:55 +053041
42class classproperty(object):
43 def __init__(self, f):
44 self.func = f
45
46 def __get__(self, obj, owner):
Chandan Kumar667d3d32017-09-22 12:24:06 +053047 return self.func(owner)
48
Chandan Kumar5e619872017-09-07 22:23:55 +053049
50class WaitTimeout(Exception):
51 """Default exception coming from wait_until_true() function."""
52
53
54class LockWithTimer(object):
55 def __init__(self, threshold):
56 self._threshold = threshold
57 self.timestamp = 0
58 self._lock = threading.Lock()
59
60 def acquire(self):
61 return self._lock.acquire(False)
62
63 def release(self):
64 return self._lock.release()
65
66 def time_to_wait(self):
67 return self.timestamp - time.time() + self._threshold
68
Chandan Kumar667d3d32017-09-22 12:24:06 +053069
Chandan Kumar5e619872017-09-07 22:23:55 +053070def wait_until_true(predicate, timeout=60, sleep=1, exception=None):
Brian Haleyae328b92018-10-09 19:51:54 -040071 """Wait until callable predicate is evaluated as True
72
Chandan Kumar5e619872017-09-07 22:23:55 +053073 :param predicate: Callable deciding whether waiting should continue.
74 Best practice is to instantiate predicate with functools.partial()
75 :param timeout: Timeout in seconds how long should function wait.
76 :param sleep: Polling interval for results in seconds.
77 :param exception: Exception instance to raise on timeout. If None is passed
78 (default) then WaitTimeout exception is raised.
79 """
80 try:
81 with eventlet.Timeout(timeout):
82 while not predicate():
83 eventlet.sleep(sleep)
84 except eventlet.Timeout:
85 if exception is not None:
Brian Haley8aaa73f2018-10-09 19:55:44 -040086 # pylint: disable=raising-bad-type
Chandan Kumar5e619872017-09-07 22:23:55 +053087 raise exception
88 raise WaitTimeout("Timed out after %d seconds" % timeout)
Brian Haleyba800452017-12-14 10:30:48 -050089
90
Federico Ressi0e04f8f2018-10-24 12:19:05 +020091def override_class(overriden_class, overrider_class):
92 """Override class definition with a MixIn class
93
94 If overriden_class is not a subclass of overrider_class then it creates
95 a new class that has as bases overrider_class and overriden_class.
96 """
97
98 if not issubclass(overriden_class, overrider_class):
99 name = overriden_class.__name__
100 bases = (overrider_class, overriden_class)
101 overriden_class = type(name, bases, {})
102 return overriden_class
zheng.yong74e760a2019-05-22 14:16:14 +0800103
104
105def normalize_url(url):
106 """Normalize url without port with schema default port
107
108 """
109 parse_result = urlparse.urlparse(url)
110 (scheme, netloc, url, params, query, fragment) = parse_result
111 port = parse_result.port
112 if scheme in SCHEMA_PORT_MAPPING and not port:
113 netloc = netloc + ":" + str(SCHEMA_PORT_MAPPING[scheme])
114 return urlparse.urlunparse((scheme, netloc, url, params, query, fragment))
Maciej Józefczyk328edc82019-09-16 14:05:48 +0000115
116
117def kill_nc_process(ssh_client):
118 cmd = "killall -q nc"
119 try:
120 ssh_client.exec_command(cmd)
121 except exceptions.SSHExecCommandFailed:
122 pass
123
124
Slawek Kaplonskifd4141f2020-03-14 14:34:00 +0100125def process_is_running(ssh_client, process_name):
126 try:
127 ssh_client.exec_command("pidof %s" % process_name)
128 return True
129 except exceptions.SSHExecCommandFailed:
130 return False
131
132
Maciej Józefczyk328edc82019-09-16 14:05:48 +0000133def spawn_http_server(ssh_client, port, message):
134 cmd = ("(echo -e 'HTTP/1.1 200 OK\r\n'; echo '%(msg)s') "
135 "| sudo nc -lp %(port)d &" % {'msg': message, 'port': port})
136 ssh_client.exec_command(cmd)
137
138
139def call_url_remote(ssh_client, url):
140 cmd = "curl %s --retry 3 --connect-timeout 2" % url
141 return ssh_client.exec_command(cmd)
Alex Katzbd2bfd42021-05-26 18:12:36 +0300142
143
144class StatefulConnection:
145 """Class to test connection that should remain opened
146
147 Can be used to perform some actions while the initiated connection
148 remain opened
149 """
150
151 def __init__(self, client_ssh, server_ssh, target_ip, target_port):
152 self.client_ssh = client_ssh
153 self.server_ssh = server_ssh
154 self.ip = target_ip
155 self.port = target_port
156 self.connection_started = False
157 self.test_attempt = 0
158
159 def __enter__(self):
160 return self
161
162 @property
163 def test_str(self):
164 return 'attempt_{}'.format(str(self.test_attempt).zfill(3))
165
166 def _start_connection(self):
Eduardo Olivares1f665d82022-02-14 17:22:54 +0100167 if CONF.neutron_plugin_options.default_image_is_advanced:
168 server_exec_method = self.server_ssh.execute_script
169 client_exec_method = self.client_ssh.execute_script
170 else:
171 server_exec_method = self.server_ssh.exec_command
172 client_exec_method = self.client_ssh.exec_command
173
Alex Katzbd2bfd42021-05-26 18:12:36 +0300174 self.server_ssh.exec_command(
175 'echo "{}" > input.txt'.format(self.test_str))
Eduardo Olivares1f665d82022-02-14 17:22:54 +0100176 server_exec_method('tail -f input.txt | nc -lp '
Alex Katzbd2bfd42021-05-26 18:12:36 +0300177 '{} &> output.txt &'.format(self.port))
178 self.client_ssh.exec_command(
179 'echo "{}" > input.txt'.format(self.test_str))
Eduardo Olivares1f665d82022-02-14 17:22:54 +0100180 client_exec_method('tail -f input.txt | nc {} {} &>'
Alex Katzbd2bfd42021-05-26 18:12:36 +0300181 'output.txt &'.format(self.ip, self.port))
182
183 def _test_connection(self):
184 if not self.connection_started:
185 self._start_connection()
186 else:
187 self.server_ssh.exec_command(
188 'echo "{}" >> input.txt'.format(self.test_str))
189 self.client_ssh.exec_command(
190 'echo "{}" >> input.txt & sleep 1'.format(self.test_str))
191 try:
192 self.server_ssh.exec_command(
193 'grep {} output.txt'.format(self.test_str))
194 self.client_ssh.exec_command(
195 'grep {} output.txt'.format(self.test_str))
196 if not self.should_pass:
197 return False
198 else:
199 if not self.connection_started:
200 self.connection_started = True
201 return True
202 except exceptions.SSHExecCommandFailed:
203 if self.should_pass:
204 return False
205 else:
206 return True
207 finally:
208 self.test_attempt += 1
209
210 def test_connection(self, should_pass=True, timeout=10, sleep_timer=1):
211 self.should_pass = should_pass
212 wait_until_true(
213 self._test_connection, timeout=timeout, sleep=sleep_timer)
214
215 def __exit__(self, type, value, traceback):
Eduardo Olivares1f665d82022-02-14 17:22:54 +0100216 self.server_ssh.exec_command('sudo killall nc || killall nc || '
217 'echo "True"')
Alex Katz5d1043b2021-08-03 10:21:43 +0300218 self.server_ssh.exec_command(
219 'sudo killall tail || killall tail || echo "True"')
Eduardo Olivares1f665d82022-02-14 17:22:54 +0100220 self.client_ssh.exec_command('sudo killall nc || killall nc || '
221 'echo "True"')
Alex Katz5d1043b2021-08-03 10:21:43 +0300222 self.client_ssh.exec_command(
223 'sudo killall tail || killall tail || echo "True"')