Container could fail to delete when there were reference properties

Summary

Fix for #179 (closed) and also #180 (closed)

Focus

• Does it work?
• No regressions to expect?

Test Environment

Run unit test: pytest test_container.py, also run integration tests

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/linkahead/common/models.py

@@ -63,6 +63,7 @@ from ..exceptions import (AmbiguousEntityError, AuthorizationError,
                           UniqueNamesError, UnqualifiedParentsError,
                           UnqualifiedPropertiesError)
 from .datatype import (BOOLEAN, DATETIME, DOUBLE, INTEGER, TEXT,
+                       get_list_datatype,
                        is_list_datatype, is_reference)
 from .state import State
 from .timezone import TimeZone
@@ -3250,14 +3251,19 @@ class Container(list):
 
         return sync_dict
 
-    def _test_dependencies_in_container(self, container):
-        """This function returns those elements of a given container that are a dependency of another element of the same container.
+    @staticmethod
+    def _find_dependencies_in_container(container):
+        """Find elements in a container that are a dependency of another element of the same.
 
-        Args:
-            container (Container): a linkahead container
+        Parameters
+        ----------
+        container : Container
+          A LinkAhead container.
 
-        Returns:
-            [set]: a set of unique elements that are a dependency of another element of `container`
+        Returns
+        -------
+        out : set
+          A set of IDs of unique elements that are a dependency of another element of ``container``.
         """
         item_id = set()
         is_parent = set()
@@ -3274,28 +3280,40 @@ class Container(list):
             for parents in container_item.get_parents():
                 is_parent.add(parents.id)
 
-            for references in container_item.get_properties():
-                if is_reference(references.datatype):
-                    # add only if it is a reference, not a property
-
-                    if references.value is None:
-                        continue
-                    elif isinstance(references.value, int):
-                        is_being_referenced.add(references.value)
-                    elif is_list_datatype(references.datatype):
-                        for list_item in references.value:
-                            if isinstance(list_item, int):
-                                is_being_referenced.add(list_item)
-                            else:
-                                is_being_referenced.add(list_item.id)
-                    else:
-                        try:
-                            is_being_referenced.add(references.value.id)
-                        except AttributeError:
+            for prop in container_item.get_properties():
+                prop_dt = prop.datatype
+                if is_reference(prop_dt):
+                    # add only if it is a reference, not a simple property
+                    # Step 1: look for prop.value
+                    if prop.value is not None:
+                        if isinstance(prop.value, int):
+                            is_being_referenced.add(prop.value)
+                        elif is_list_datatype(prop_dt):
+                            for list_item in prop.value:
+                                if isinstance(list_item, int):
+                                    is_being_referenced.add(list_item)
+                                else:
+                                    is_being_referenced.add(list_item.id)
+                        else:
+                            try:
+                                is_being_referenced.add(prop.value.id)
+                            except AttributeError:
+                                pass
+                    # Step 2: Reference properties
+                    if prop.is_reference():
+                        if is_list_datatype(prop_dt):
+                            ref_name = get_list_datatype(prop_dt)
+                            try:
+                                is_being_referenced.add(container.get_entity_by_name(ref_name).id)
+                            except KeyError:
+                                pass
+                        elif isinstance(prop_dt, str):
                             pass
+                        else:
+                            is_being_referenced.add(prop_dt.id)
 
-                if hasattr(references, 'id'):
-                    is_property.add(references.id)
+                if hasattr(prop, 'id'):
+                    is_property.add(prop.id)
 
         dependent_parents = item_id.intersection(is_parent)
         dependent_properties = item_id.intersection(is_property)
@@ -3312,19 +3330,18 @@ class Container(list):
         name otherwise.  If any entity has no id and no name a
         TransactionError will be raised.
 
-        Note: If only a name is given this could lead to ambiguities. If
-        this happens, none of them will be deleted. It occurs an error
-        instead.
+        Note: If only a name is given this could lead to ambiguities. If this happens, none of them
+        will be deleted. An error is raised instead.
+
         """
         item_count = len(self)
         # Split Container in 'chunk_size'-sized containers (if necessary) to avoid error 414 Request-URI Too Long
 
         if item_count > chunk_size:
-            dependencies = self._test_dependencies_in_container(self)
-            '''
-            If there are as many dependencies as entities in the container and it is larger than chunk_size it cannot be split and deleted.
-            This case cannot be handled at the moment.
-            '''
+            dependencies = Container._find_dependencies_in_container(self)
+
+            # If there are as many dependencies as entities in the container and it is larger than
+            # chunk_size it cannot be split and deleted. This case cannot be handled at the moment.
 
             if len(dependencies) == item_count:
                 if raise_exception_on_error: