Added functionality to archive a template.

Renamed migration file.

app/models.py

@@ -174,6 +174,7 @@ class Template(db.Model, Versioned):
         nullable=True,
         onupdate=datetime.datetime.utcnow)
     content = db.Column(db.Text, index=False, unique=False, nullable=False)
+    archived = db.Column(db.Boolean, index=False, nullable=False, default=False)
     service_id = db.Column(UUID(as_uuid=True), db.ForeignKey('services.id'), index=True, unique=False, nullable=False)
     service = db.relationship('Service', backref=db.backref('templates', lazy='dynamic'))
     subject = db.Column(db.Text, index=False, unique=True, nullable=True)

migrations/versions/0008_archive_template.py

@@ -0,0 +1,33 @@
+"""empty message
+
+Revision ID: 0008_archive_template
+Revises: 0007_template_history
+Create Date: 2016-04-25 14:16:49.787229
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = '0008_archive_template'
+down_revision = '0007_template_history'
+
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+def upgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('templates', sa.Column('archived', sa.Boolean(), nullable=True))
+    op.add_column('templates_history', sa.Column('archived', sa.Boolean(), nullable=True))
+    op.get_bind()
+    op.execute('UPDATE templates SET archived = FALSE')
+    op.execute('UPDATE templates_history set archived = FALSE')
+    op.alter_column('templates', 'archived', nullable=False)
+    op.alter_column('templates', 'archived', nullable=False)
+    ### end Alembic commands ###
+
+
+def downgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('templates_history', 'archived')
+    op.drop_column('templates', 'archived')
+    ### end Alembic commands ###

tests/__init__.py

@@ -1,13 +1,24 @@
+import uuid
 from flask import current_app
 from notifications_python_client.authentication import create_jwt_token
-
+from app.models import ApiKey
-from app.dao.api_key_dao import get_unsigned_secrets
+from app.dao.api_key_dao import (get_unsigned_secrets, save_model_api_key)
+from app.dao.services_dao import dao_fetch_service_by_id
 
 
 def create_authorization_header(path, method, request_body=None, service_id=None):
     if service_id:
         client_id = str(service_id)
+        secrets = get_unsigned_secrets(service_id)
+        if secrets:
+            secret = secrets[0]
+        else:
+            service = dao_fetch_service_by_id(service_id)
+            data = {'service': service, 'name': uuid.uuid4(), 'created_by': service.created_by}
+            api_key = ApiKey(**data)
+            save_model_api_key(api_key)
             secret = get_unsigned_secrets(service_id)[0]
+
     else:
         client_id = current_app.config.get('ADMIN_CLIENT_USER_NAME')
         secret = current_app.config.get('ADMIN_CLIENT_SECRET')

tests/app/conftest.py

@@ -44,7 +44,6 @@ def sample_user(notify_db,
                 notify_db_session,
                 mobile_numnber="+447700900986",
                 email="notify@digital.cabinet-office.gov.uk"):
-    try:
     data = {
         'name': 'Test User',
         'email_address': email,
@@ -56,9 +55,7 @@ def sample_user(notify_db,
     if not usr:
         usr = User(**data)
         save_model_user(usr)
-    except Exception:
+
-        import traceback
-        traceback.print_exc()
     return usr
 
 
@@ -134,20 +131,24 @@ def sample_template(notify_db,
                     template_name="Template Name",
                     template_type="sms",
                     content="This is a template",
+                    archived=False,
                     subject_line='Subject',
                     user=None,
-                    service=None):
+                    service=None,
+                    created_by=None):
     if user is None:
         user = sample_user(notify_db, notify_db_session)
     if service is None:
         service = sample_service(notify_db, notify_db_session)
-    sample_api_key(notify_db, notify_db_session, service=service)
+    if created_by is None:
+        created_by = sample_user(notify_db, notify_db_session)
     data = {
         'name': template_name,
         'template_type': template_type,
         'content': content,
         'service': service,
-        'created_by': user
+        'created_by': created_by,
+        'archived': archived
     }
     if template_type == 'email':
         data.update({
@@ -177,7 +178,6 @@ def sample_email_template(
         user = sample_user(notify_db, notify_db_session)
     if service is None:
         service = sample_service(notify_db, notify_db_session)
-    sample_api_key(notify_db, notify_db_session, service=service)
     data = {
         'name': template_name,
         'template_type': template_type,

tests/app/dao/test_api_key_dao.py

@@ -21,7 +21,10 @@ def test_secret_is_signed_and_can_be_read_again(notify_api):
         assert signed_secret != token
 
 
-def test_save_api_key_should_create_new_api_key_and_history(notify_api, notify_db, notify_db_session, sample_service):
+def test_save_api_key_should_create_new_api_key_and_history(notify_api,
+                                                            notify_db,
+                                                            notify_db_session,
+                                                            sample_service):
     api_key = ApiKey(**{'service': sample_service,
                         'name': sample_service.name,
                         'created_by': sample_service.created_by})

tests/app/service/test_api_key_endpoints.py

@@ -98,8 +98,13 @@ def test_get_api_keys_should_return_all_keys_for_service(notify_api, notify_db,
         with notify_api.test_client() as client:
             another_user = create_user(notify_db, notify_db_session, email='another@it.gov.uk')
 
-            another_service = create_sample_service(notify_db, notify_db_session, service_name='another',
+            another_service = create_sample_service(
-                                                    user=another_user, email_from='another')
+                notify_db,
+                notify_db_session,
+                service_name='another',
+                user=another_user,
+                email_from='another'
+            )
             # key for another service
             create_sample_api_key(notify_db, notify_db_session, service=another_service)
 

tests/app/template/test_rest.py

@@ -1,6 +1,6 @@
 import json
 import uuid
-
+from app.models import Template
 from tests import create_authorization_header
 
 
@@ -275,6 +275,38 @@ def test_should_be_able_to_update_a_template(notify_api, sample_user, sample_ser
             assert update_json_resp['data']['content'] == 'my template has new content alert("foo")'
 
 
+def test_should_be_able_to_archive_template(notify_api, sample_user, sample_service, sample_template):
+    with notify_api.test_request_context():
+        with notify_api.test_client() as client:
+            data = {
+                'name': sample_template.name,
+                'template_type': sample_template.template_type,
+                'content': sample_template.content,
+                'archived': True,
+                'service': str(sample_template.service.id),
+                'created_by': str(sample_template.created_by.id)
+            }
+
+            json_data = json.dumps(data)
+
+            auth_header = create_authorization_header(
+                path='/service/{}/template/{}'.format(
+                    str(sample_template.service.id),
+                    str(sample_template.id)),
+                method='POST',
+                request_body=json_data
+            )
+
+            resp = client.post(
+                '/service/{}/template/{}'.format(sample_template.service.id, sample_template.id),
+                headers=[('Content-Type', 'application/json'), auth_header],
+                data=json_data
+            )
+
+            assert resp.status_code == 200
+            assert Template.query.first().archived
+
+
 def test_should_be_able_to_get_all_templates_for_a_service(notify_api, sample_user, sample_service):
     with notify_api.test_request_context():
         with notify_api.test_client() as client: