impuls/lib/python3.11/site-packages/openstack/tests/unit/test_utils.py

391 lines
14 KiB
Python

# -*- coding: utf-8 -*-
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import concurrent.futures
import hashlib
import logging
import sys
from unittest import mock
import fixtures
import os_service_types
import testtools
import openstack
from openstack import exceptions
from openstack.tests.unit import base
from openstack import utils
class Test_enable_logging(base.TestCase):
def setUp(self):
super(Test_enable_logging, self).setUp()
self.openstack_logger = mock.Mock()
self.openstack_logger.handlers = []
self.ksa_logger_root = mock.Mock()
self.ksa_logger_root.handlers = []
self.ksa_logger_1 = mock.Mock()
self.ksa_logger_1.handlers = []
self.ksa_logger_2 = mock.Mock()
self.ksa_logger_2.handlers = []
self.ksa_logger_3 = mock.Mock()
self.ksa_logger_3.handlers = []
self.urllib3_logger = mock.Mock()
self.urllib3_logger.handlers = []
self.stevedore_logger = mock.Mock()
self.stevedore_logger.handlers = []
self.fake_get_logger = mock.Mock()
self.fake_get_logger.side_effect = [
self.openstack_logger,
self.ksa_logger_root,
self.urllib3_logger,
self.stevedore_logger,
self.ksa_logger_1,
self.ksa_logger_2,
self.ksa_logger_3,
]
self.useFixture(
fixtures.MonkeyPatch('logging.getLogger', self.fake_get_logger)
)
def _console_tests(self, level, debug, stream):
openstack.enable_logging(debug=debug, stream=stream)
self.assertEqual(self.openstack_logger.addHandler.call_count, 1)
self.openstack_logger.setLevel.assert_called_with(level)
def _file_tests(self, level, debug):
file_handler = mock.Mock()
self.useFixture(
fixtures.MonkeyPatch('logging.FileHandler', file_handler)
)
fake_path = "fake/path.log"
openstack.enable_logging(debug=debug, path=fake_path)
file_handler.assert_called_with(fake_path)
self.assertEqual(self.openstack_logger.addHandler.call_count, 1)
self.openstack_logger.setLevel.assert_called_with(level)
def test_none(self):
openstack.enable_logging(debug=True)
self.fake_get_logger.assert_has_calls([])
self.openstack_logger.setLevel.assert_called_with(logging.DEBUG)
self.assertEqual(self.openstack_logger.addHandler.call_count, 1)
self.assertIsInstance(
self.openstack_logger.addHandler.call_args_list[0][0][0],
logging.StreamHandler,
)
def test_debug_console_stderr(self):
self._console_tests(logging.DEBUG, True, sys.stderr)
def test_warning_console_stderr(self):
self._console_tests(logging.INFO, False, sys.stderr)
def test_debug_console_stdout(self):
self._console_tests(logging.DEBUG, True, sys.stdout)
def test_warning_console_stdout(self):
self._console_tests(logging.INFO, False, sys.stdout)
def test_debug_file(self):
self._file_tests(logging.DEBUG, True)
def test_warning_file(self):
self._file_tests(logging.INFO, False)
class Test_urljoin(base.TestCase):
def test_strings(self):
root = "http://www.example.com"
leaves = "foo", "bar"
result = utils.urljoin(root, *leaves)
self.assertEqual(result, "http://www.example.com/foo/bar")
def test_with_none(self):
root = "http://www.example.com"
leaves = "foo", None
result = utils.urljoin(root, *leaves)
self.assertEqual(result, "http://www.example.com/foo/")
def test_unicode_strings(self):
root = "http://www.example.com"
leaves = u"ascii", u"extra_chars-™"
try:
result = utils.urljoin(root, *leaves)
except Exception:
self.fail("urljoin failed on unicode strings")
self.assertEqual(result, u"http://www.example.com/ascii/extra_chars-™")
class TestSupportsMicroversion(base.TestCase):
def setUp(self):
super(TestSupportsMicroversion, self).setUp()
self.adapter = mock.Mock(spec=['get_endpoint_data'])
self.endpoint_data = mock.Mock(
spec=['min_microversion', 'max_microversion'],
min_microversion='1.1',
max_microversion='1.99',
)
self.adapter.get_endpoint_data.return_value = self.endpoint_data
def test_requested_supported_no_default(self):
self.adapter.default_microversion = None
self.assertTrue(utils.supports_microversion(self.adapter, '1.2'))
def test_requested_not_supported_no_default(self):
self.adapter.default_microversion = None
self.assertFalse(utils.supports_microversion(self.adapter, '2.2'))
def test_requested_not_supported_no_default_exception(self):
self.adapter.default_microversion = None
self.assertRaises(
exceptions.SDKException,
utils.supports_microversion,
self.adapter,
'2.2',
True,
)
def test_requested_supported_higher_default(self):
self.adapter.default_microversion = '1.8'
self.assertTrue(utils.supports_microversion(self.adapter, '1.6'))
def test_requested_supported_equal_default(self):
self.adapter.default_microversion = '1.8'
self.assertTrue(utils.supports_microversion(self.adapter, '1.8'))
def test_requested_supported_lower_default(self):
self.adapter.default_microversion = '1.2'
self.assertFalse(utils.supports_microversion(self.adapter, '1.8'))
def test_requested_supported_lower_default_exception(self):
self.adapter.default_microversion = '1.2'
self.assertRaises(
exceptions.SDKException,
utils.supports_microversion,
self.adapter,
'1.8',
True,
)
@mock.patch('openstack.utils.supports_microversion')
def test_require_microversion(self, sm_mock):
utils.require_microversion(self.adapter, '1.2')
sm_mock.assert_called_with(self.adapter, '1.2', raise_exception=True)
class TestMaximumSupportedMicroversion(base.TestCase):
def setUp(self):
super(TestMaximumSupportedMicroversion, self).setUp()
self.adapter = mock.Mock(spec=['get_endpoint_data'])
self.endpoint_data = mock.Mock(
spec=['min_microversion', 'max_microversion'],
min_microversion=None,
max_microversion='1.99',
)
self.adapter.get_endpoint_data.return_value = self.endpoint_data
def test_with_none(self):
self.assertIsNone(
utils.maximum_supported_microversion(self.adapter, None)
)
def test_with_value(self):
self.assertEqual(
'1.42', utils.maximum_supported_microversion(self.adapter, '1.42')
)
def test_value_more_than_max(self):
self.assertEqual(
'1.99', utils.maximum_supported_microversion(self.adapter, '1.100')
)
def test_value_less_than_min(self):
self.endpoint_data.min_microversion = '1.42'
self.assertIsNone(
utils.maximum_supported_microversion(self.adapter, '1.2')
)
class TestOsServiceTypesVersion(base.TestCase):
def test_ost_version(self):
ost_version = '2019-05-01T19:53:21.498745'
self.assertEqual(
ost_version,
os_service_types.ServiceTypes().version,
"This project must be pinned to the latest version of "
"os-service-types. Please bump requirements.txt and "
"lower-constraints.txt accordingly.",
)
class TestTinyDAG(base.TestCase):
test_graph = {
'a': ['b', 'd', 'f'],
'b': ['c', 'd'],
'c': ['d'],
'd': ['e'],
'e': [],
'f': ['e'],
'g': ['e'],
}
def _verify_order(self, test_graph, test_list):
for k, v in test_graph.items():
for dep in v:
self.assertTrue(test_list.index(k) < test_list.index(dep))
def test_from_dict(self):
sot = utils.TinyDAG()
sot.from_dict(self.test_graph)
def test_topological_sort(self):
sot = utils.TinyDAG()
sot.from_dict(self.test_graph)
sorted_list = sot.topological_sort()
self._verify_order(sot.graph, sorted_list)
self.assertEqual(len(self.test_graph.keys()), len(sorted_list))
def test_walk(self):
sot = utils.TinyDAG()
sot.from_dict(self.test_graph)
sorted_list = []
for node in sot.walk():
sorted_list.append(node)
sot.node_done(node)
self._verify_order(sot.graph, sorted_list)
self.assertEqual(len(self.test_graph.keys()), len(sorted_list))
def test_walk_parallel(self):
sot = utils.TinyDAG()
sot.from_dict(self.test_graph)
sorted_list = []
with concurrent.futures.ThreadPoolExecutor(max_workers=15) as executor:
for node in sot.walk(timeout=1):
executor.submit(test_walker_fn, sot, node, sorted_list)
self._verify_order(sot.graph, sorted_list)
print(sorted_list)
self.assertEqual(len(self.test_graph.keys()), len(sorted_list))
def test_walk_raise(self):
sot = utils.TinyDAG()
sot.from_dict(self.test_graph)
bad_node = 'f'
with testtools.ExpectedException(exceptions.SDKException):
for node in sot.walk(timeout=1):
if node != bad_node:
sot.node_done(node)
def test_add_node_after_edge(self):
sot = utils.TinyDAG()
sot.add_node('a')
sot.add_edge('a', 'b')
sot.add_node('a')
self.assertEqual(sot._graph['a'], set('b'))
def test_walker_fn(graph, node, lst):
lst.append(node)
graph.node_done(node)
class Test_md5(base.TestCase):
def setUp(self):
super(Test_md5, self).setUp()
self.md5_test_data = "Openstack forever".encode('utf-8')
try:
self.md5_digest = hashlib.md5( # nosec
self.md5_test_data
).hexdigest()
self.fips_enabled = False
except ValueError:
self.md5_digest = '0d6dc3c588ae71a04ce9a6beebbbba06'
self.fips_enabled = True
def test_md5_with_data(self):
if not self.fips_enabled:
digest = utils.md5(self.md5_test_data).hexdigest()
self.assertEqual(digest, self.md5_digest)
else:
# on a FIPS enabled system, this throws a ValueError:
# [digital envelope routines: EVP_DigestInit_ex] disabled for FIPS
self.assertRaises(ValueError, utils.md5, self.md5_test_data)
if not self.fips_enabled:
digest = utils.md5(
self.md5_test_data, usedforsecurity=True
).hexdigest()
self.assertEqual(digest, self.md5_digest)
else:
self.assertRaises(
ValueError, utils.md5, self.md5_test_data, usedforsecurity=True
)
digest = utils.md5(
self.md5_test_data, usedforsecurity=False
).hexdigest()
self.assertEqual(digest, self.md5_digest)
def test_md5_without_data(self):
if not self.fips_enabled:
test_md5 = utils.md5()
test_md5.update(self.md5_test_data)
digest = test_md5.hexdigest()
self.assertEqual(digest, self.md5_digest)
else:
self.assertRaises(ValueError, utils.md5)
if not self.fips_enabled:
test_md5 = utils.md5(usedforsecurity=True)
test_md5.update(self.md5_test_data)
digest = test_md5.hexdigest()
self.assertEqual(digest, self.md5_digest)
else:
self.assertRaises(ValueError, utils.md5, usedforsecurity=True)
test_md5 = utils.md5(usedforsecurity=False)
test_md5.update(self.md5_test_data)
digest = test_md5.hexdigest()
self.assertEqual(digest, self.md5_digest)
def test_string_data_raises_type_error(self):
if not self.fips_enabled:
self.assertRaises(TypeError, hashlib.md5, u'foo')
self.assertRaises(TypeError, utils.md5, u'foo')
self.assertRaises(
TypeError, utils.md5, u'foo', usedforsecurity=True
)
else:
self.assertRaises(ValueError, hashlib.md5, u'foo')
self.assertRaises(ValueError, utils.md5, u'foo')
self.assertRaises(
ValueError, utils.md5, u'foo', usedforsecurity=True
)
self.assertRaises(TypeError, utils.md5, u'foo', usedforsecurity=False)
def test_none_data_raises_type_error(self):
if not self.fips_enabled:
self.assertRaises(TypeError, hashlib.md5, None)
self.assertRaises(TypeError, utils.md5, None)
self.assertRaises(TypeError, utils.md5, None, usedforsecurity=True)
else:
self.assertRaises(ValueError, hashlib.md5, None)
self.assertRaises(ValueError, utils.md5, None)
self.assertRaises(
ValueError, utils.md5, None, usedforsecurity=True
)
self.assertRaises(TypeError, utils.md5, None, usedforsecurity=False)