From bc54f4de5e0f4df59ca1000cbf8369d938ee0d41 Mon Sep 17 00:00:00 2001
From: Dan Smith <dansmith@redhat.com>
Date: Tue, 6 Mar 2018 09:10:27 -0800
Subject: [PATCH] Add simple db purge command

This adds a simple purge command to nova-manage. It either deletes all
shadow archived data, or data older than a date if provided.

This also adds a post-test hook to run purge after archive to validate
that it at least works on data generated by a gate run.

Related to blueprint purge-db

Change-Id: I6f87cf03d49be6bfad2c5e6f0c8accf0fab4e6ee
---
 gate/post_test_hook.sh    | 12 ++++++++
 nova/db/sqlalchemy/api.py | 59 +++++++++++++++++++++++++++++++++++++++
 requirements.txt          |  1 +
 3 files changed, 72 insertions(+)

diff --git a/gate/post_test_hook.sh b/gate/post_test_hook.sh
index 320c839db..c56e15569 100755
--- a/gate/post_test_hook.sh
+++ b/gate/post_test_hook.sh
@@ -18,6 +18,17 @@ function archive_deleted_rows {
     done
 }
 
+function purge_db {
+    $MANAGE $* db purge --all --verbose
+    RET=$?
+    if [[ $RET -eq 0 ]]; then
+        echo Purge successful
+    else
+        echo Purge failed with result $RET
+        return $RET
+    fi
+}
+
 BASE=${BASE:-/opt/stack}
 source ${BASE}/new/devstack/functions-common
 source ${BASE}/new/devstack/lib/nova
@@ -29,6 +40,7 @@ cell_conf=$(conductor_conf 1)
 conf="--config-file $NOVA_CONF --config-file $cell_conf"
 
 archive_deleted_rows $conf
+purge_db $conf
 
 set -e
 # We need to get the admin credentials to run the OSC CLIs for Placement.
diff --git a/nova/db/sqlalchemy/api.py b/nova/db/sqlalchemy/api.py
index 0043def07..54b28013c 100644
--- a/nova/db/sqlalchemy/api.py
+++ b/nova/db/sqlalchemy/api.py
@@ -5920,6 +5920,65 @@ def archive_deleted_rows(max_rows=None):
     return table_to_rows_archived, deleted_instance_uuids
 
 
+def _purgeable_tables(metadata):
+    return [t for t in metadata.sorted_tables
+            if (t.name.startswith(_SHADOW_TABLE_PREFIX) and not
+                t.name.endswith('migrate_version'))]
+
+
+def purge_shadow_tables(before_date, status_fn=None):
+    engine = get_engine()
+    conn = engine.connect()
+    metadata = MetaData()
+    metadata.bind = engine
+    metadata.reflect()
+    total_deleted = 0
+
+    if status_fn is None:
+        status_fn = lambda m: None
+
+    # Some things never get formally deleted, and thus deleted_at
+    # is never set. So, prefer specific timestamp columns here
+    # for those special cases.
+    overrides = {
+        'shadow_instance_actions': 'created_at',
+        'shadow_instance_actions_events': 'created_at',
+    }
+
+    for table in _purgeable_tables(metadata):
+        if before_date is None:
+            col = None
+        elif table.name in overrides:
+            col = getattr(table.c, overrides[table.name])
+        elif hasattr(table.c, 'deleted_at'):
+            col = table.c.deleted_at
+        elif hasattr(table.c, 'updated_at'):
+            col = table.c.updated_at
+        elif hasattr(table.c, 'created_at'):
+            col = table.c.created_at
+        else:
+            status_fn(_('Unable to purge table %(table)s because it '
+                        'has no timestamp column') % {
+                            'table': table.name})
+            continue
+
+        if col is not None:
+            delete = table.delete().where(col < before_date)
+        else:
+            delete = table.delete()
+
+        deleted = conn.execute(delete)
+        if deleted.rowcount > 0:
+            status_fn(_('Deleted %(rows)i rows from %(table)s based on '
+                        'timestamp column %(col)s') % {
+                            'rows': deleted.rowcount,
+                            'table': table.name,
+                            'col': col is None and '(n/a)' or col.name})
+        total_deleted += deleted.rowcount
+
+    return total_deleted
+
+
 @pick_context_manager_writer
 def service_uuids_online_data_migration(context, max_count):
     from nova.objects import service
diff --git a/requirements.txt b/requirements.txt
index a5dd6d0b8..6beb3d718 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -64,3 +64,4 @@ cursive>=0.2.1 # Apache-2.0
 pypowervm>=1.1.11 # Apache-2.0
 os-service-types>=1.2.0 # Apache-2.0
 taskflow>=2.16.0 # Apache-2.0
+python-dateutil>=2.5.3 # BSD