Browse Source

Add functional regression recreate test for bug 1839560

This adds a functional test which recreates bug 1839560
where the driver reports a node, then no longer reports
it so the compute manager deletes it, and then the driver
reports it again later (this can be common with ironic
nodes as they undergo maintenance). The issue is that since
Ia69fabce8e7fd7de101e291fe133c6f5f5f7056a in Rocky, the
ironic node uuid is re-used for the compute node uuid but
there is a unique constraint on the compute node uuid so
when trying to create the compute node once the ironic node
is available again, the compute node create fails with a
duplicate entry error due to the duplicate uuid. To recreate
this in the functional test, a new fake virt driver is added
which provides a predictable uuid per node like the ironic
driver. The test also shows that archiving the database is
a way to workaround the bug until it's properly fixed.

Change-Id: If822509e906d5094f13a8700b2b9ed3c40580431
Related-Bug: #1839560
Matt Riedemann 1 year ago
2 changed files with 136 additions and 0 deletions
  1. +122
  2. +14

+ 122
- 0
nova/tests/functional/regressions/ View File

@@ -0,0 +1,122 @@
# 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
# 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.

from oslo_log import log as logging

from nova import context
from nova.db import api as db_api
from nova import exception
from nova import objects
from nova import test
from nova.tests import fixtures as nova_fixtures
from nova.tests.functional import fixtures as func_fixtures
from nova.tests.functional import integrated_helpers
from nova import utils

LOG = logging.getLogger(__name__)

class PeriodicNodeRecreateTestCase(test.TestCase,
"""Regression test for bug 1839560 introduced in Rocky.

When an ironic node is undergoing maintenance the driver will not report
it as an available node to the ComputeManager.update_available_resource
periodic task. The ComputeManager will then (soft) delete a ComputeNode
record for that no-longer-available node. If/when the ironic node is
available again and the driver reports it, the ResourceTracker will attempt
to create a ComputeNode record for the ironic node.

The regression with change Ia69fabce8e7fd7de101e291fe133c6f5f5f7056a is
that the ironic node uuid is used as the ComputeNode.uuid and there is
a unique constraint on the ComputeNode.uuid value in the database. So
trying to create a ComputeNode with the same uuid (after the ironic node
comes back from being unavailable) fails with a DuplicateEntry error since
there is a (soft) deleted version of the ComputeNode with the same uuid
in the database.
def setUp(self):
super(PeriodicNodeRecreateTestCase, self).setUp()
# We need the PlacementFixture for the compute nodes to report in but
# otherwise don't care about placement for this test.
# Start up the API so we can query the os-hypervisors API.
self.api = self.useFixture(nova_fixtures.OSAPIFixture(
# Make sure we're using the fake driver that has predictable uuids
# for each node.

def test_update_available_resource_node_recreate(self):
# First we create a compute service to manage a couple of fake nodes.
compute = self.start_service('compute', 'node1')
# When start_service runs, it will create the node1 ComputeNode.
compute.manager.driver._set_nodes(['node1', 'node2'])
# Run the update_available_resource periodic to register node2.
ctxt = context.get_admin_context()
# Make sure no compute nodes were orphaned or deleted.
self.assertNotIn('Deleting orphan compute node',
# Now we should have two compute nodes, make sure the hypervisors API
# shows them.
hypervisors = self.api.api_get('/os-hypervisors').body['hypervisors']
self.assertEqual(2, len(hypervisors), hypervisors)
self.assertEqual({'node1', 'node2'},
for hyp in hypervisors]))
# Now stub the driver to only report node1. This is making it look like
# node2 is no longer available when update_available_resource runs.
# node2 should have been deleted, check the logs and API.
log = self.stdlog.logger.output
self.assertIn('Deleting orphan compute node', log)
self.assertIn('hypervisor host is node2', log)
hypervisors = self.api.api_get('/os-hypervisors').body['hypervisors']
self.assertEqual(1, len(hypervisors), hypervisors)
self.assertEqual('node1', hypervisors[0]['hypervisor_hostname'])
# But the node2 ComputeNode is still in the database with deleted!=0.
with utils.temporary_mutation(ctxt, read_deleted='yes'):
cn = objects.ComputeNode.get_by_host_and_nodename(
ctxt, 'node1', 'node2')
# Now stub the driver again to report node2 as being back and run
# the periodic task.
compute.manager.driver._set_nodes(['node1', 'node2'])
# FIXME(mriedem): This is bug 1839560 where the ResourceTracker fails
# to create a ComputeNode for node2 because of conflicting UUIDs.
log = self.stdlog.logger.output
self.assertIn('Error updating resources for node node2', log)
self.assertIn('DBDuplicateEntry', log)
# Should still only have one reported hypervisor (node1).
hypervisors = self.api.api_get('/os-hypervisors').body['hypervisors']
self.assertEqual(1, len(hypervisors), hypervisors)
# Test the workaround for bug 1839560 by archiving the deleted node2
# compute_nodes table record which will allow the periodic to create a
# new entry for node2. We can remove this when the bug is fixed.'Archiving the database.')
archived = db_api.archive_deleted_rows(1000)[0]
self.assertIn('compute_nodes', archived)
self.assertEqual(1, archived['compute_nodes'])
with utils.temporary_mutation(ctxt, read_deleted='yes'):
ctxt, 'node1', 'node2')
# Now run the periodic again and we should have a new ComputeNode for
# node2.'Running update_available_resource which should create a new '
'ComputeNode record for node2.')
hypervisors = self.api.api_get('/os-hypervisors').body['hypervisors']
self.assertEqual(2, len(hypervisors), hypervisors)

+ 14
- 0
nova/virt/ View File

@@ -26,6 +26,7 @@ semantics of real hypervisor connections.
import collections
import contextlib
import time
import uuid

import fixtures
import os_resource_classes as orc
@@ -726,6 +727,19 @@ class FakeFinishMigrationFailDriver(FakeDriver):
raise exception.VirtualInterfaceCreateException()

class PredictableNodeUUIDDriver(SmallFakeDriver):
"""SmallFakeDriver variant that reports a predictable node uuid in
get_available_resource, like IronicDriver.
def get_available_resource(self, nodename):
resources = super(
PredictableNodeUUIDDriver, self).get_available_resource(nodename)
# This is used in ComputeNode.update_from_virt_driver which is called
# from the ResourceTracker when creating a ComputeNode.
resources['uuid'] = uuid.uuid5(uuid.NAMESPACE_DNS, nodename)
return resources

class FakeRescheduleDriver(FakeDriver):
"""FakeDriver derivative that triggers a reschedule on the first spawn
attempt. This is expected to only be used in tests that have more than