Merge pull request #288 from alphagov/purge_functional_test_data

Purge functional tests command added with passing test.

app/commands.py

@@ -1,8 +1,11 @@
+import uuid
 from datetime import datetime
 from decimal import Decimal
 from flask.ext.script import Command, Manager, Option
-from app.models import PROVIDERS
+from app.models import (PROVIDERS, Service, User)
+from app.dao.services_dao import delete_service_and_all_associated_db_objects
 from app.dao.provider_rates_dao import create_provider_rates
+from app.dao.users_dao import (delete_model_user, delete_user_verify_codes)
 
 
 class CreateProviderRateCommand(Command):
@@ -28,3 +31,36 @@ class CreateProviderRateCommand(Command):
             raise Exception("Invalid valid_from date. Use the format %Y-%m-%dT%H:%M:%S")
 
         create_provider_rates(provider_name, valid_from, cost)
+
+
+class PurgeFunctionalTestDataCommand(Command):
+
+    option_list = (
+        Option('-n', '-service-name-prefix', dest="service_name_prefix", help='Functional service name prefix.'),
+        Option('-u', '-user-email-prefix', dest='user_email_prefix', help="Functional test user email prefix.")
+    )
+
+    def run(self, service_name_prefix=None, user_email_prefix=None):
+        if service_name_prefix:
+            services = Service.query.filter(Service.name.like("{}%".format(service_name_prefix))).all()
+            for service in services:
+                # Make sure the second part of the service name is a uuid.
+                # Just in case someone decides to create a service with that name included in it.
+                try:
+                    uuid.UUID(service.name.split(service_name_prefix)[1])
+                except ValueError:
+                    print("Skipping {} as the service name doesn't contain a UUID.".format(service.name))
+                else:
+                    delete_service_and_all_associated_db_objects(service)
+        if user_email_prefix:
+            users = User.query.filter(User.email_address.like("{}%".format(user_email_prefix))).all()
+            for usr in users:
+                # Make sure the full email includes a uuid in it
+                # Just in case someone decides to use a similar email address.
+                try:
+                    uuid.UUID(usr.email_address.split("@")[0].split('+')[1])
+                except ValueError:
+                    print("Skipping {} as the user email doesn't contain a UUID.".format(usr.email_address))
+                else:
+                    delete_user_verify_codes(usr)
+                    delete_model_user(usr)

app/dao/notifications_dao.py

@@ -200,11 +200,10 @@ def get_notifications_for_job(service_id, job_id, filter_dict=None, page=1, page
         page_size = current_app.config['PAGE_SIZE']
     query = Notification.query.filter_by(service_id=service_id, job_id=job_id)
     query = filter_query(query, filter_dict)
-    pagination = query.order_by(desc(Notification.created_at)).paginate(
+    return query.order_by(desc(Notification.created_at)).paginate(
         page=page,
         per_page=page_size
     )
-    return pagination
 
 
 def get_notification(service_id, notification_id):
@@ -215,7 +214,11 @@ def get_notification_by_id(notification_id):
     return Notification.query.filter_by(id=notification_id).first()
 
 
-def get_notifications_for_service(service_id, filter_dict=None, page=1, page_size=None, limit_days=None):
+def get_notifications_for_service(service_id,
+                                  filter_dict=None,
+                                  page=1,
+                                  page_size=None,
+                                  limit_days=None):
     if page_size is None:
         page_size = current_app.config['PAGE_SIZE']
     filters = [Notification.service_id == service_id]
@@ -226,11 +229,10 @@ def get_notifications_for_service(service_id, filter_dict=None, page=1, page_siz
 
     query = Notification.query.filter(*filters)
     query = filter_query(query, filter_dict)
-    pagination = query.order_by(desc(Notification.created_at)).paginate(
+    return query.order_by(desc(Notification.created_at)).paginate(
         page=page,
         per_page=page_size
     )
-    return pagination
 
 
 def filter_query(query, filter_dict=None):

app/dao/provider_statistics_dao.py

@@ -1,4 +1,5 @@
 from sqlalchemy import func
+from app import db
 from app.models import (ProviderStatistics, SMS_PROVIDERS, EMAIL_PROVIDERS)
 
 

app/dao/services_dao.py

@@ -9,6 +9,21 @@ from app.dao.dao_utils import (
     version_class
 )
 
+from app.models import (
+    NotificationStatistics,
+    TemplateStatistics,
+    ProviderStatistics,
+    VerifyCode,
+    ApiKey,
+    Template,
+    Job,
+    Notification,
+    Permission,
+    User,
+    InvitedUser,
+    Service
+)
+
 
 def dao_fetch_all_services():
     return Service.query.order_by(asc(Service.created_at)).all()
@@ -66,3 +81,31 @@ def dao_remove_user_from_service(service, user):
         raise e
     else:
         db.session.commit()
+
+
+def delete_service_and_all_associated_db_objects(service):
+
+    def _delete_commit(query):
+        query.delete()
+        db.session.commit()
+
+    _delete_commit(NotificationStatistics.query.filter_by(service=service))
+    _delete_commit(TemplateStatistics.query.filter_by(service=service))
+    _delete_commit(ProviderStatistics.query.filter_by(service=service))
+    _delete_commit(InvitedUser.query.filter_by(service=service))
+    _delete_commit(Permission.query.filter_by(service=service))
+    _delete_commit(ApiKey.query.filter_by(service=service))
+    _delete_commit(Notification.query.filter_by(service=service))
+    _delete_commit(Job.query.filter_by(service=service))
+    _delete_commit(Template.query.filter_by(service=service))
+
+    verify_codes = VerifyCode.query.join(User).filter(User.id.in_([x.id for x in service.users]))
+    list(map(db.session.delete, verify_codes))
+    db.session.commit()
+    users = [x for x in service.users]
+    map(service.users.remove, users)
+    [service.users.remove(x) for x in users]
+    db.session.delete(service)
+    db.session.commit()
+    list(map(db.session.delete, users))
+    db.session.commit()

app/dao/users_dao.py

@@ -67,6 +67,11 @@ def delete_model_user(user):
     db.session.commit()
 
 
+def delete_user_verify_codes(user):
+    VerifyCode.query.filter_by(user=user).delete()
+    db.session.commit()
+
+
 def get_model_users(user_id=None):
     if user_id:
         return User.query.filter_by(id=user_id).one()