Merge pull request #13200 from dimagi/sk/copy_blob

reference form attachments in case attachments instead of copying

corehq/ex-submodules/casexml/apps/case/tests/test_multimedia.py

@@ -14,13 +14,14 @@
 from casexml.apps.case.tests.util import TEST_DOMAIN_NAME
 from casexml.apps.case.xml import V2
 from corehq.apps.receiverwrapper.util import submit_form_locally
+from corehq.blobs import get_blob_db
+from corehq.blobs.tests.util import TemporaryS3BlobDB
 from corehq.form_processor.interfaces.dbaccessors import CaseAccessors, FormAccessors
 from couchforms.models import XFormInstance
 from dimagi.utils.parsing import json_format_datetime
 from corehq.form_processor.interfaces.processor import FormProcessorInterface
 from corehq.form_processor.tests.utils import FormProcessorTestUtils, run_with_all_backends
-from corehq.util.test_utils import TestFileMixin
-
+from corehq.util.test_utils import TestFileMixin, trap_extra_setup
 
 TEST_CASE_ID = "EOL9FIAKIQWOFXFOH0QAMWU64"
 CREATE_XFORM_ID = "6RGAZTETE3Z2QC0PE2DKM88MO"
@@ -300,3 +301,34 @@ def test_sync_log_invalidation_bug(self):
         # this used to fail before we fixed http://manage.dimagi.com/default.asp?158373
         self._doSubmitUpdateWithMultimedia(new_attachments=['commcare_logo_file'], removes=[],
                                            sync_token=sync_log._id)
+
+
+class CaseMultimediaS3DBTest(BaseCaseMultimediaTest):
+    """
+    Tests new attachments for cases and case properties
+    Spec: https://github.com/dimagi/commcare/wiki/CaseAttachmentAPI
+    """
+
+    def setUp(self):
+        super(CaseMultimediaS3DBTest, self).setUp()
+        with trap_extra_setup(AttributeError, msg="S3_BLOB_DB_SETTINGS not configured"):
+            config = settings.S3_BLOB_DB_SETTINGS
+
+        self.s3db = TemporaryS3BlobDB(config)
+        assert get_blob_db() is self.s3db, (get_blob_db(), self.s3db)
+
+    def tearDown(self):
+        self.s3db.close()
+        super(CaseMultimediaS3DBTest, self).tearDown()
+
+    @run_with_all_backends
+    def test_case_attachment(self):
+        single_attach = 'fruity_file'
+        xform, case = self._doCreateCaseWithMultimedia(attachments=[single_attach])
+
+        self.assertEqual(1, len(case.case_attachments))
+        self.assertTrue(single_attach in case.case_attachments)
+        self.assertEqual(
+            self._calc_file_hash(single_attach),
+            hashlib.md5(case.get_attachment(single_attach)).hexdigest()
+        )

corehq/form_processor/backends/sql/update_strategy.py

@@ -157,15 +157,12 @@ def _apply_attachments_action(self, attachment_action, xform):
             new_attachment = CaseAttachmentSQL.from_case_update(att)
             if new_attachment.is_present:
                 form_attachment = xform.get_attachment_meta(att.attachment_src)
-                new_attachment.update_from_attachment(form_attachment)
-
                 if identifier in current_attachments:
                     existing_attachment = current_attachments[identifier]
-                    existing_attachment.update_from_attachment(new_attachment)
-                    existing_attachment.copy_content(form_attachment)
+                    existing_attachment.from_form_attachment(form_attachment)
                     self.case.track_update(existing_attachment)
                 else:
-                    new_attachment.copy_content(form_attachment)
+                    new_attachment.from_form_attachment(form_attachment)
                     new_attachment.case = self.case
                     self.case.track_create(new_attachment)
             elif identifier in current_attachments:

corehq/form_processor/models.py

@@ -462,6 +462,19 @@ class XFormAttachmentSQL(AbstractAttachment, IsImageMixin):
         related_name=AttachmentMixin.ATTACHMENTS_RELATED_NAME, related_query_name="attachment"
     )
 
+    def __unicode__(self):
+        return unicode(
+            "XFormAttachmentSQL("
+            "attachment_id='{a.attachment_id}', "
+            "form_id='{a.form_id}', "
+            "name='{a.name}', "
+            "content_type='{a.content_type}', "
+            "content_length='{a.content_length}', "
+            "md5='{a.md5}', "
+            "blob_id='{a.blob_id}', "
+            "properties='{a.properties}', "
+        ).format(a=self)
+
     class Meta:
         db_table = XFormAttachmentSQL_DB_TABLE
         app_label = "form_processor"
@@ -856,14 +869,15 @@ class CaseAttachmentSQL(AbstractAttachment, CaseAttachmentMixin):
     attachment_src = models.TextField(null=True)
     attachment_from = models.TextField(null=True)
 
-    def update_from_attachment(self, attachment):
+    def from_form_attachment(self, attachment):
         """
-        Update fields in this attachment with fields from anaother attachment
+        Update fields in this attachment with fields from another attachment
 
         :param attachment: XFormAttachmentSQL or CaseAttachmentSQL object
         """
         self.content_length = attachment.content_length
         self.blob_id = attachment.blob_id
+        self.blob_bucket = attachment._blobdb_bucket()
         self.md5 = attachment.md5
         self.content_type = attachment.content_type
         self.properties = attachment.properties
@@ -878,17 +892,6 @@ def update_from_attachment(self, attachment):
             self.attachment_src = attachment.attachment_src
             self.attachment_from = attachment.attachment_from
 
-    def copy_content(self, attachment):
-        if self.is_saved():
-            deleted = self.delete_content()
-            if not deleted:
-                logging.warn(
-                    "Case attachment content not deleted. bucket=%s, blob_id=%s",
-                    self._blobdb_bucket(), self.blob_id
-                )
-        content = attachment.read_content(stream=True)
-        self.write_content(content)
-
     @classmethod
     def from_case_update(cls, attachment):
         if attachment.attachment_src: