openstack/charm-nova-cloud-controller
Code Issues Proposed changes

Add new action purge-data

Browse Source 
The action will run
`nova-manage db purge --verbose --all`
to delete rows from shadow tables.

Related-Bug: 2066940
Change-Id: I4602a9cf38126b50bfe188b68a75cff1d2597342
This commit is contained in:
james lin 2024-06-05 17:10:07 +08:00
parent 0094bf072e
commit 02adbab969
No known key found for this signature in database
GPG Key ID: BD6E7CA3593A8494
5 changed files with 122 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
actions.yaml
View File

@ -16,7 +16,14 @@ archive-data:
batch-size:
type: integer
default: 10000
description: Archive old data to shadow tables
purge-data:
description: Run job to purge stale soft deleted rows in database
params:
before:
type: string
description: |
Delete data from all shadow tables that is older than the date provided.
Date strings may be fuzzy, such as `Oct 21 2015`.
security-checklist:
description: |
Validate the running configuration against the OpenStack security guides

11
actions/actions.py
View File

@ -48,6 +48,16 @@ def resume(args):
utils.resume_unit_helper(utils.register_configs())
def purge_data(args):
"""Run data purge process
@raises Exception should the purge fail"""
hookenv.action_set({
'output': utils.purge_stale_soft_deleted_rows(
before=hookenv.action_get('before'),
)
})
def archive_data(args):
"""Run data archival process
@raises Exception should the archival fail"""
@ -198,6 +208,7 @@ ACTIONS = {
"archive-data": archive_data,
"clear-unit-knownhost-cache": clear_unit_knownhost_cache,
"sync-compute-availability-zones": sync_compute_availability_zones,
"purge-data": purge_data,
}

1
actions/purge-data Symbolic link
View File

@ -0,0 +1 @@
actions.py

28
hooks/nova_cc_utils.py
View File

@ -946,6 +946,33 @@ def map_instances():
hookenv.log(msg, level=hookenv.INFO)
def purge_stale_soft_deleted_rows(before=""):
'''Purge all stale soft-deleted rows.'''
hookenv.log('Purging stale soft-deleted rows', level=hookenv.INFO)
cmd = ['nova-manage', 'db', 'purge', '--verbose']
if before:
cmd.extend(['--before', str(before)])
else:
cmd.extend(['--all'])
process = subprocess.Popen(cmd, stdout=subprocess.PIPE)
stdout, stderr = process.communicate()
exit_code = process.wait()
# exit_code 3 means no data was deleted.
if exit_code not in [0, 3]:
msg = (
'Purging stale soft-deleted rows failed\nsstdout: {}\nsstderr: {}'
.format(stdout, stderr)
)
hookenv.log(msg, level=hookenv.ERROR)
raise Exception(msg)
if exit_code == 3:
msg = 'Purging stale soft-deleted rows and no data was deleted'
hookenv.log(msg, level=hookenv.INFO)
return msg
return stdout
def archive_deleted_rows(max_rows=None):
hookenv.log('Archiving deleted rows', level=hookenv.INFO)
cmd = ['nova-manage', 'db', 'archive_deleted_rows', '--verbose']
@ -954,6 +981,7 @@ def archive_deleted_rows(max_rows=None):
process = subprocess.Popen(cmd, stdout=subprocess.PIPE)
stdout, stderr = process.communicate()
exit_code = process.wait()
if exit_code not in [0, 1]:
msg = 'Archiving deleted rows failed\nstdout: {}\nstderr: {}'.format(
stdout,

74
unit_tests/test_nova_cc_utils.py
View File

@ -1622,6 +1622,80 @@ class NovaCCUtilsTests(CharmTestCase):
with self.assertRaises(Exception):
utils.archive_deleted_rows()
@patch('subprocess.Popen')
def test_purge_stale_soft_deleted_rows(self, mock_popen):
process_mock = MagicMock()
attrs = {
'communicate.return_value': ('output', 'error'),
'wait.return_value': 0}
process_mock.configure_mock(**attrs)
mock_popen.return_value = process_mock
expectd_calls = [
call([
'nova-manage',
'db',
'purge',
'--verbose',
'--all'], stdout=-1),
call().communicate(),
call().wait()]
utils.purge_stale_soft_deleted_rows()
self.assertEqual(mock_popen.mock_calls, expectd_calls)
@patch('subprocess.Popen')
def test_purge_stale_soft_deleted_rows_no_data(self, mock_popen):
process_mock = MagicMock()
attrs = {
'communicate.return_value': ('output', 'error'),
'wait.return_value': 3}
process_mock.configure_mock(**attrs)
mock_popen.return_value = process_mock
expectd_calls = [
call([
'nova-manage',
'db',
'purge',
'--verbose',
'--all'], stdout=-1),
call().communicate(),
call().wait()]
msg = utils.purge_stale_soft_deleted_rows()
self.assertEqual(mock_popen.mock_calls, expectd_calls)
self.assertEqual(
msg, 'Purging stale soft-deleted rows and no data was deleted')
@patch('subprocess.Popen')
def test_purge_stale_soft_deleted_rows_with_before(self, mock_popen):
process_mock = MagicMock()
attrs = {
'communicate.return_value': ('output', 'error'),
'wait.return_value': 0}
process_mock.configure_mock(**attrs)
mock_popen.return_value = process_mock
expectd_calls = [
call([
'nova-manage',
'db',
'purge',
'--verbose',
'--before',
'2024-06-06'], stdout=-1),
call().communicate(),
call().wait()]
utils.purge_stale_soft_deleted_rows(before='2024-06-06')
self.assertEqual(mock_popen.mock_calls, expectd_calls)
@patch('subprocess.Popen')
def test_purge_stale_soft_deleted_rows_exception(self, mock_popen):
process_mock = MagicMock()
attrs = {
'communicate.return_value': ('output', 'error'),
'wait.return_value': 123}
process_mock.configure_mock(**attrs)
mock_popen.return_value = process_mock
with self.assertRaises(Exception):
utils.purge_stale_soft_deleted_rows()
def test_is_serial_console_enabled_on_juno(self):
self.os_release.return_value = 'juno'
self.test_config.set('enable-serial-console', True)