From 7f918d7c4870b817016d5aaf68ff2ba92a51fb9e Mon Sep 17 00:00:00 2001
From: Katie Smith <katie.smith@digital.cabinet-office.gov.uk>
Date: Thu, 8 Nov 2018 11:16:59 +0000
Subject: [PATCH] Remove relationship to folder when archiving a template
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

When a template is archived, it should no longer belong to any folder.

If we don’t do this it will make it very hard to delete folders later
(because folders can only be deleted if they have no templates or folders
inside them).

We originally tried to check if the link between a template and folder
should be removed with

`if template.archived and template.folder:`

instead of using `if template.archived:`. However, this caused issues
because checking `template.folder` flushes the session. Since the
session is no longer dirty, the versioning decorator doesn't work as
expected and doesn't create a new row in `TemplateHistory`.
---
 app/dao/templates_dao.py            |  3 +++
 tests/app/dao/test_templates_dao.py | 30 +++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+)

diff --git a/app/dao/templates_dao.py b/app/dao/templates_dao.py
index 2a9164429..e5e93199f 100644
--- a/app/dao/templates_dao.py
+++ b/app/dao/templates_dao.py
@@ -38,6 +38,9 @@ def dao_create_template(template):
 @transactional
 @version_class(Template, TemplateHistory)
 def dao_update_template(template):
+    if template.archived:
+        template.folder = None
+
     db.session.add(template)
 
 
diff --git a/tests/app/dao/test_templates_dao.py b/tests/app/dao/test_templates_dao.py
index cd2eb8992..b3d27a6d6 100644
--- a/tests/app/dao/test_templates_dao.py
+++ b/tests/app/dao/test_templates_dao.py
@@ -15,6 +15,7 @@ from app.dao.templates_dao import (
 )
 from app.models import (
     Template,
+    TemplateFolder,
     TemplateHistory,
     TemplateRedacted
 )
@@ -93,6 +94,35 @@ def test_update_template(sample_service, sample_user):
     assert dao_get_all_templates_for_service(sample_service.id)[0].name == 'new name'
 
 
+def test_update_template_in_a_folder_to_archived(sample_service, sample_user):
+    template_data = {
+        'name': 'Sample Template',
+        'template_type': "sms",
+        'content': "Template content",
+        'service': sample_service,
+        'created_by': sample_user
+    }
+    template = Template(**template_data)
+
+    template_folder_data = {
+        'name': 'My Folder',
+        'service_id': sample_service.id,
+    }
+    template_folder = TemplateFolder(**template_folder_data)
+
+    template.folder = template_folder
+    dao_create_template(template)
+
+    template.archived = True
+    dao_update_template(template)
+
+    template_folder = TemplateFolder.query.one()
+    archived_template = Template.query.one()
+
+    assert template_folder
+    assert not archived_template.folder
+
+
 def test_dao_update_template_reply_to_none_to_some(sample_service, sample_user):
     letter_contact = create_letter_contact(sample_service, 'Edinburgh, ED1 1AA')