distcloud/distributedcloud/dcmanager/tests/unit/db/test_subcloud_audits.py
Cristian Mondo a6a6b84258 Subcloud Name Reconfiguration
This change adds the capability to rename the subcloud after
bootstrap or during subcloud rehome operation.

Added a field in the database to separate the region name
from the subcloud name.
The region name determines the subcloud reference in the
Openstack core, through which it is possible to access
the endpoints of a given subcloud. Since the region name
cannot be changed, this commit adds the ability to maintain
a unique region name based on the UUID format, and allows
subcloud renaming when necessary without any endpoint
impact.
The region is randomly generated to configure the subcloud
when it is created and only applies to future subclouds.
For those systems that have existing subclouds, the region
will be the same as on day 0, that is, region will keep the
same name as the subcloud, but subclouds can be renamed.

This topic involves changes to dcmanager, dcmanager-client
and GUI. To ensure the region name reference needed by the
cert-monitor, a mechanism to determine if the request is
coming from the cert-monitor has been created.

Usage for subcloud rename:
dcmanager subcloud update <subcloud-name> --name <new-name>

Usage for subcloud rehoming:
dcmanager subcloud add --name <subcloud-name> --migrate ...

Note: Upgrade test from StarlingX 8 -> 9 for this commit
is deferred until upgrade functionality in master is
restored. Any issue found during upgrade test will be
addressed in a separate commit

Test Plan:
PASS: Run dcmanager subcloud passing subcommands:
      - add/delete/migrate/list/show/show --detail
      - errors/manage/unmanage/reinstall/reconfig
      - update/deploy
PASS: Run dcmanager subcloud add supplying --name
      parameter and validate the operation is not allowed
PASS: Run dcmanager supplying subcommands:
      - kube/patch/prestage strategies
PASS: Run dcmanager to apply patch and remove it
PASS: Run dcmanager subcloud-backup:
      - create/delete/restore/show/upload
PASS: Run subcloud-group:
      - add/delete/list/list-subclouds/show/update
PASS: Run dcmanager subcloud strategy for:
      - patch/kubernetes/firmware
PASS: Run dcmanager subcloud update command passing --name
      parameter supplying the following values:
      - current subcloud name (not changed)
      - different existing subcloud name
PASS: Run dcmanager to migrate a subcloud passing --name
      parameter supplying a new subcloud name
PASS: Run dcmanager to migrate a subcloud without --name
      parameter
PASS: Run dcmanager to migrate a subcloud passing --name
      parameter supplying a new subcloud name and
      different subcloud name in bootstrap file
PASS: Test dcmanager API response using cURL command line
      to validate new region name field
PASS: Run full DC sanity and regression

Story: 2010788
Task: 48217

Signed-off-by: Cristian Mondo <cristian.mondo@windriver.com>
Change-Id: Id04f42504b8e325d9ec3880c240fe4a06e3a20b7
2023-09-07 10:30:06 -03:00

201 lines
9.7 KiB
Python

# Copyright (c) 2021-2022 Wind River Systems, Inc.
# 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 datetime
from oslo_db import exception as db_exception
from oslo_utils import uuidutils
from dcmanager.common import exceptions as exception
from dcmanager.db import api as api
from dcmanager.db.sqlalchemy import api as db_api
from dcmanager.tests import base
get_engine = api.get_engine
class DBAPISubcloudAuditsTest(base.DCManagerTestCase):
@staticmethod
def create_subcloud(ctxt, name, **kwargs):
values = {
'name': name,
'description': "This is a subcloud",
'location': "This is the location of the subcloud",
'software_version': "10.04",
'management_subnet': "192.168.101.0/24",
'management_gateway_ip': "192.168.101.1",
'management_start_ip': "192.168.101.2",
'management_end_ip': "192.168.101.50",
'systemcontroller_gateway_ip': "192.168.204.101",
'deploy_status': "not-deployed",
'error_description': 'No errors present',
'region_name': uuidutils.generate_uuid().replace("-", ""),
'openstack_installed': False,
'group_id': 1,
}
values.update(kwargs)
return db_api.subcloud_create(ctxt, **values)
def setUp(self):
super(DBAPISubcloudAuditsTest, self).setUp()
# calling setUp for the superclass sets up the DB and context
self.create_subcloud(self.ctx, "subcloud1")
self.create_subcloud(self.ctx, "subcloud2")
self.create_subcloud(self.ctx, "subcloud3")
def test_subcloud_audits_get(self):
# Test the SubcloudAudits created when we created subcloud2 in setup.
result = db_api.subcloud_audits_get(self.ctx, 2)
self.assertEqual(result['subcloud_id'], 2)
self.assertEqual(result['audit_started_at'], datetime.datetime(1, 1, 1, 0, 0))
self.assertEqual(result['audit_finished_at'], datetime.datetime(1, 1, 1, 0, 0))
self.assertEqual(result['patch_audit_requested'], False)
self.assertEqual(result['load_audit_requested'], False)
self.assertEqual(result['firmware_audit_requested'], False)
self.assertEqual(result['kubernetes_audit_requested'], False)
self.assertEqual(result['kube_rootca_update_audit_requested'], False)
self.assertEqual(result['spare_audit_requested'], False)
self.assertEqual(result['spare2_audit_requested'], False)
self.assertEqual(result['reserved'], None)
def test_subcloud_audits_get_not_found(self):
self.assertRaises(exception.SubcloudNotFound,
db_api.subcloud_audits_get,
self.ctx, '4')
def test_subcloud_alarms_create_duplicate(self):
# There's already an entry for subcloud2, try adding another.
self.assertRaises(db_exception.DBDuplicateEntry,
db_api.subcloud_audits_create,
self.ctx, 2)
def test_subcloud_audits_get_all(self):
subcloud_audits = db_api.subcloud_audits_get_all(self.ctx)
self.assertEqual(len(subcloud_audits), 3)
self.assertEqual(subcloud_audits[0]['subcloud_id'], 1)
self.assertEqual(subcloud_audits[1]['subcloud_id'], 2)
self.assertEqual(subcloud_audits[2]['subcloud_id'], 3)
def test_subcloud_alarms_delete(self):
result = db_api.subcloud_audits_get(self.ctx, 2)
db_api.subcloud_destroy(self.ctx, result['subcloud_id'])
self.assertRaises(exception.SubcloudNotFound,
db_api.subcloud_audits_get,
self.ctx, result['subcloud_id'])
def test_subcloud_audits_update(self):
result = db_api.subcloud_audits_get(self.ctx, 1)
self.assertEqual(result['patch_audit_requested'], False)
result = db_api.subcloud_audits_get(self.ctx, 2)
self.assertEqual(result['patch_audit_requested'], False)
values = {'patch_audit_requested': True}
result = db_api.subcloud_audits_update(self.ctx, 2, values)
self.assertEqual(result['patch_audit_requested'], True)
result = db_api.subcloud_audits_get(self.ctx, 1)
self.assertEqual(result['patch_audit_requested'], False)
result = db_api.subcloud_audits_get(self.ctx, 2)
self.assertEqual(result['patch_audit_requested'], True)
def test_subcloud_audits_update_all(self):
subcloud_audits = db_api.subcloud_audits_get_all(self.ctx)
for audit in subcloud_audits:
self.assertEqual(audit['patch_audit_requested'], False)
self.assertEqual(audit['load_audit_requested'], False)
values = {'patch_audit_requested': True,
'load_audit_requested': True}
result = db_api.subcloud_audits_update_all(self.ctx, values)
self.assertEqual(result, 3)
subcloud_audits = db_api.subcloud_audits_get_all(self.ctx)
for audit in subcloud_audits:
self.assertEqual(audit['patch_audit_requested'], True)
self.assertEqual(audit['load_audit_requested'], True)
def test_subcloud_audits_get_all_need_audit(self):
current_time = datetime.datetime.utcnow()
last_audit_threshold = current_time - datetime.timedelta(
seconds=1000)
audits = db_api.subcloud_audits_get_all_need_audit(
self.ctx, last_audit_threshold)
# They should all need audits.
self.assertEqual(len(audits), 3)
# Update subcloud1 to show it's been audited recently and
# check it doesn't come back as needing an audit.
db_api.subcloud_audits_end_audit(self.ctx, 1, [])
audits = db_api.subcloud_audits_get_all_need_audit(
self.ctx, last_audit_threshold)
subcloud_ids = [audit.subcloud_id for audit in audits]
self.assertEqual(len(subcloud_ids), 2)
self.assertNotIn(1, subcloud_ids)
# Set one of the special audits to make sure it overrides.
values = {'patch_audit_requested': True}
db_api.subcloud_audits_update(self.ctx, 1, values)
audits = db_api.subcloud_audits_get_all_need_audit(
self.ctx, last_audit_threshold)
self.assertEqual(len(audits), 3)
def test_subcloud_audits_start_and_end(self):
audit = db_api.subcloud_audits_get_and_start_audit(self.ctx, 3)
self.assertTrue((datetime.datetime.utcnow() - audit.audit_started_at) <
datetime.timedelta(seconds=1))
audit = db_api.subcloud_audits_end_audit(self.ctx, 3, [])
self.assertTrue((datetime.datetime.utcnow() - audit.audit_finished_at) <
datetime.timedelta(seconds=1))
self.assertFalse(audit.state_update_requested)
def test_subcloud_audits_fix_expired(self):
# Set the 'finished' timestamp later than the 'start' timestamp.
db_api.subcloud_audits_end_audit(self.ctx, 3, [])
# Set the 'start' timestamp later than the 'finished' timestamp
# but with the 'finished' timestamp long ago.
db_api.subcloud_audits_get_and_start_audit(self.ctx, 1)
# Set the 'start' timestamp later than the 'finished' timestamp
# but with the 'finished' timestamp recent.
db_api.subcloud_audits_end_audit(self.ctx, 2, [])
db_api.subcloud_audits_get_and_start_audit(self.ctx, 2)
last_audit_threshold = (datetime.datetime.utcnow() -
datetime.timedelta(seconds=100))
count = db_api.subcloud_audits_fix_expired_audits(
self.ctx, last_audit_threshold)
self.assertEqual(count, 1)
# Check that for the one that was updated we didn't trigger sub-audits.
result = db_api.subcloud_audits_get(self.ctx, 1)
self.assertEqual(result['patch_audit_requested'], False)
def test_subcloud_audits_fix_expired_trigger_audits(self):
# Set the 'start' timestamp later than the 'finished' timestamp
# but with the 'finished' timestamp long ago.
db_api.subcloud_audits_get_and_start_audit(self.ctx, 1)
last_audit_threshold = (datetime.datetime.utcnow() -
datetime.timedelta(seconds=100))
# Fix up expired audits and trigger subaudits.
count = db_api.subcloud_audits_fix_expired_audits(
self.ctx, last_audit_threshold, trigger_audits=True)
self.assertEqual(count, 1)
# For the fixed-up audits, subaudits should be requested.
result = db_api.subcloud_audits_get(self.ctx, 1)
self.assertEqual(result['patch_audit_requested'], True)
self.assertEqual(result['firmware_audit_requested'], True)
self.assertEqual(result['load_audit_requested'], True)
self.assertEqual(result['kubernetes_audit_requested'], True)
self.assertEqual(result['kube_rootca_update_audit_requested'], True)
# For the not-fixed-up audits, subaudits should not be requested.
result = db_api.subcloud_audits_get(self.ctx, 2)
self.assertEqual(result['patch_audit_requested'], False)
self.assertEqual(result['firmware_audit_requested'], False)
self.assertEqual(result['load_audit_requested'], False)
self.assertEqual(result['kubernetes_audit_requested'], False)
self.assertEqual(result['kube_rootca_update_audit_requested'], False)