openstack/nova
Code Issues Proposed changes
067cd93424
nova/nova/tests/unit/utils.py
Sean Mooney f3d48000b1 Add autopep8 to tox and pre-commit 
autopep8 is a code formating tool that makes python code pep8
compliant without changing everything. Unlike black it will
not radically change all code and the primary change to the
existing codebase is adding a new line after class level doc strings.

This change adds a new tox autopep8 env to manually run it on your
code before you submit a patch, it also adds autopep8 to pre-commit
so if you use pre-commit it will do it for you automatically.

This change runs autopep8 in diff mode with --exit-code in the pep8
tox env so it will fail if autopep8 would modify your code if run
in in-place mode. This allows use to gate on autopep8 not modifying
patches that are submited. This will ensure authorship of patches is
maintianed.

The intent of this change is to save the large amount of time we spend
on ensuring style guidlines are followed automatically to make it
simpler for both new and old contibutors to work on nova and save
time and effort for all involved.

Change-Id: Idd618d634cc70ae8d58fab32f322e75bfabefb9d
2021-11-08 12:37:27 +00:00

372 lines
12 KiB
Python
Raw Blame History

# Copyright 2011 OpenStack Foundation
#
# 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 collections
import errno
import platform
import socket
import sys
import mock
from nova.compute import flavors
import nova.conf
import nova.context
from nova.db.main import api as db
from nova import exception
from nova.image import glance
from nova.network import model as network_model
from nova import objects
from nova.objects import base as obj_base
import nova.utils
CONF = nova.conf.CONF
def get_test_admin_context():
return nova.context.get_admin_context()
def get_test_image_object(context, instance_ref):
if not context:
context = get_test_admin_context()
image_ref = instance_ref['image_ref']
image_service, image_id = glance.get_remote_image_service(context,
image_ref)
return objects.ImageMeta.from_dict(
image_service.show(context, image_id))
def get_test_flavor(context=None, options=None):
options = options or {}
if not context:
context = get_test_admin_context()
test_flavor = {'name': 'kinda.big',
'flavorid': 'someid',
'memory_mb': 2048,
'vcpus': 4,
'root_gb': 40,
'ephemeral_gb': 80,
'swap': 1024}
test_flavor.update(options)
flavor_ref = objects.Flavor(context, **test_flavor)
try:
flavor_ref.create()
except (exception.FlavorExists, exception.FlavorIdExists):
flavor_ref = objects.Flavor.get_by_flavor_id(
context, test_flavor['flavorid'])
return flavor_ref
def get_test_instance(context=None, flavor=None, obj=False):
if not context:
context = get_test_admin_context()
if not flavor:
flavor = get_test_flavor(context)
test_instance = {'memory_kb': '2048000',
'basepath': '/some/path',
'bridge_name': 'br100',
'vcpus': 4,
'root_gb': 40,
'bridge': 'br101',
'image_ref': 'cedef40a-ed67-4d10-800e-17455edce175',
'instance_type_id': flavor['id'],
'system_metadata': {},
'extra_specs': {},
'user_id': context.user_id,
'project_id': context.project_id,
}
if obj:
instance = objects.Instance(context, **test_instance)
instance.flavor = objects.Flavor.get_by_id(context, flavor['id'])
instance.create()
else:
flavors.save_flavor_info(test_instance['system_metadata'], flavor, '')
instance = db.instance_create(context, test_instance)
return instance
FAKE_NETWORK_VLAN = 100
FAKE_NETWORK_BRIDGE = 'br0'
FAKE_NETWORK_INTERFACE = 'eth0'
FAKE_NETWORK_IP4_ADDR1 = '10.0.0.73'
FAKE_NETWORK_IP4_ADDR2 = '10.0.0.74'
FAKE_NETWORK_IP6_ADDR1 = '2001:b105:f00d::1'
FAKE_NETWORK_IP6_ADDR2 = '2001:b105:f00d::2'
FAKE_NETWORK_IP6_ADDR3 = '2001:b105:f00d::3'
FAKE_NETWORK_IP4_GATEWAY = '10.0.0.254'
FAKE_NETWORK_IP6_GATEWAY = '2001:b105:f00d::ff'
FAKE_NETWORK_IP4_CIDR = '10.0.0.0/24'
FAKE_NETWORK_IP6_CIDR = '2001:b105:f00d::0/64'
FAKE_NETWORK_DNS_IP4_ADDR1 = '192.168.122.1'
FAKE_NETWORK_DNS_IP4_ADDR2 = '192.168.122.2'
FAKE_NETWORK_DNS_IP6_ADDR1 = '2001:dead:beef::1'
FAKE_NETWORK_DNS_IP6_ADDR2 = '2001:dead:beef::2'
FAKE_NETWORK_DHCP_IP4_ADDR = '192.168.122.253'
FAKE_NETWORK_UUID = '4587c867-a2e6-4356-8c5b-bc077dcb8620'
FAKE_VIF_UUID = '51a9642b-1414-4bd6-9a92-1320ddc55a63'
FAKE_VIF_MAC = 'de:ad:be:ef:ca:fe'
def get_test_network_info(count=1):
def current():
subnet_4 = network_model.Subnet(
cidr=FAKE_NETWORK_IP4_CIDR,
dns=[network_model.IP(FAKE_NETWORK_DNS_IP4_ADDR1),
network_model.IP(FAKE_NETWORK_DNS_IP4_ADDR2)],
gateway=network_model.IP(FAKE_NETWORK_IP4_GATEWAY),
ips=[network_model.IP(FAKE_NETWORK_IP4_ADDR1),
network_model.IP(FAKE_NETWORK_IP4_ADDR2)],
routes=None,
dhcp_server=FAKE_NETWORK_DHCP_IP4_ADDR)
subnet_6 = network_model.Subnet(
cidr=FAKE_NETWORK_IP6_CIDR,
gateway=network_model.IP(FAKE_NETWORK_IP6_GATEWAY),
ips=[network_model.IP(FAKE_NETWORK_IP6_ADDR1),
network_model.IP(FAKE_NETWORK_IP6_ADDR2),
network_model.IP(FAKE_NETWORK_IP6_ADDR3)],
routes=None,
version=6)
subnets = [subnet_4, subnet_6]
network = network_model.Network(
id=FAKE_NETWORK_UUID,
bridge=FAKE_NETWORK_BRIDGE,
label=None,
subnets=subnets,
vlan=FAKE_NETWORK_VLAN,
bridge_interface=FAKE_NETWORK_INTERFACE,
injected=False)
vif = network_model.VIF(
id=FAKE_VIF_UUID,
address=FAKE_VIF_MAC,
network=network,
type=network_model.VIF_TYPE_OVS,
devname=None,
ovs_interfaceid=None)
return vif
return network_model.NetworkInfo([current() for x in range(0, count)])
def is_osx():
return platform.mac_ver()[0] != ''
def is_linux():
return platform.system() == 'Linux'
def killer_xml_body():
return (("""<!DOCTYPE x [
<!ENTITY a "%(a)s">
<!ENTITY b "%(b)s">
<!ENTITY c "%(c)s">]>
<foo>
<bar>
<v1>%(d)s</v1>
</bar>
</foo>""") % {
'a': 'A' * 10,
'b': '&a;' * 10,
'c': '&b;' * 10,
'd': '&c;' * 9999,
}).strip()
def is_ipv6_supported():
has_ipv6_support = socket.has_ipv6
try:
s = socket.socket(socket.AF_INET6, socket.SOCK_STREAM)
s.bind(('::1', 0))
s.close()
except socket.error as e:
if e.errno == errno.EAFNOSUPPORT or e.errno == errno.EADDRNOTAVAIL:
has_ipv6_support = False
else:
raise
# check if there is at least one interface with ipv6
if has_ipv6_support and sys.platform.startswith('linux'):
try:
with open('/proc/net/if_inet6') as f:
if not f.read():
has_ipv6_support = False
except IOError:
has_ipv6_support = False
return has_ipv6_support
def get_api_version(request):
if request.path[2:3].isdigit():
return int(request.path[2:3])
def compare_obj_primitive(thing1, thing2):
if isinstance(thing1, obj_base.NovaObject):
return thing1.obj_to_primitive() == thing2.obj_to_primitive()
else:
return thing1 == thing2
def _compare_args(args1, args2, cmp):
return all(cmp(*pair) for pair in zip(args1, args2))
def _compare_kwargs(kwargs1, kwargs2, cmp):
return all(cmp(kwargs1[k], kwargs2[k])
for k in set(list(kwargs1.keys()) + list(kwargs2.keys())))
def _obj_called_with(the_mock, *args, **kwargs):
if 'obj_cmp' in kwargs:
cmp = kwargs.pop('obj_cmp')
else:
cmp = compare_obj_primitive
count = 0
for call in the_mock.call_args_list:
if (_compare_args(call[0], args, cmp) and
_compare_kwargs(call[1], kwargs, cmp)):
count += 1
return count
def obj_called_with(the_mock, *args, **kwargs):
return _obj_called_with(the_mock, *args, **kwargs) != 0
def obj_called_once_with(the_mock, *args, **kwargs):
return _obj_called_with(the_mock, *args, **kwargs) == 1
class CustomMockCallMatcher(object):
def __init__(self, comparator):
self.comparator = comparator
def __eq__(self, other):
return self.comparator(other)
class ItemsMatcher(CustomMockCallMatcher):
"""Convenience matcher for iterables (mainly lists) where the order is
unpredictable.
Usage::
my_mock.assert_called_once_with(
...,
listy_kwarg=ItemsMatcher(['foo', 'bar', 'baz']),
...)
Will pass if the mock is called with a listy_kwarg containing 'foo', 'bar',
'baz' in any order. E.g. the following will all pass::
# Called with a list in some other order
my_mock(..., listy_kwarg=['baz', 'foo', 'bar'], ...)
# Called with a set
my_mock(..., listy_kwarg={'baz', 'foo', 'bar'}, ...)
# Called with a tuple in some other order
my_mock(..., listy_kwarg=('baz', 'foo', 'bar'), ...)
But the following will fail::
my_mock(..., listy_kwarg=['foo', 'bar'], ...)
"""
def __init__(self, iterable):
# NOTE(gibi): we need the extra iter() call as Counter handles dicts
# directly to initialize item count. However if a dict passed to
# ItemMatcher we want to use the keys of such dict as an iterable to
# initialize the Counter instead.
self.bag = collections.Counter(iter(iterable))
super(ItemsMatcher, self).__init__(
lambda other: self.bag == collections.Counter(iter(other)))
def __repr__(self):
"""This exists so a failed assertion prints something useful."""
return 'ItemsMatcher(%r)' % list(self.bag.elements())
def assert_instance_delete_notification_by_uuid(
mock_legacy_notify, mock_notify, expected_instance_uuid,
expected_notifier, expected_context, expect_targeted_context=False,
expected_source='nova-api', expected_host='fake-mini'):
match_by_instance_uuid = CustomMockCallMatcher(
lambda instance:
instance.uuid == expected_instance_uuid)
assert_legacy_instance_delete_notification_by_uuid(
mock_legacy_notify, match_by_instance_uuid, expected_notifier,
expected_context, expect_targeted_context)
assert_versioned_instance_delete_notification_by_uuid(
mock_notify, match_by_instance_uuid,
expected_context, expected_source, expected_host=expected_host)
def assert_versioned_instance_delete_notification_by_uuid(
mock_notify, instance_matcher,
expected_context, expected_source, expected_host):
mock_notify.assert_has_calls([
mock.call(expected_context,
instance_matcher,
host=expected_host,
source=expected_source,
action='delete',
phase='start'),
mock.call(expected_context,
instance_matcher,
host=expected_host,
source=expected_source,
action='delete',
phase='end')])
def assert_legacy_instance_delete_notification_by_uuid(
mock_notify, instance_matcher, expected_notifier,
expected_context, expect_targeted_context):
mock_notify.assert_has_calls([
mock.call(expected_notifier,
expected_context,
instance_matcher,
'delete.start'),
mock.call(expected_notifier,
expected_context,
instance_matcher,
'delete.end')])
for call in mock_notify.call_args_list:
if expect_targeted_context:
assert call[0][1].db_connection is not None
else:
assert call[0][1].db_connection is None
View Git Blame Copy Permalink