pytests for NeoAccess.exists_by_internal_id()

Author: BrainAnnex

src/neoaccess/neoaccess.py

@@ -396,11 +396,11 @@ def query_extended(self, q: str, params = None, flatten = False, fields_to_exclu
                     neo4j_properties = dict(item.items())   # EXAMPLE: {'gender': 'M', 'age': 99}
 
                     if isinstance(item, neo4j.graph.Node):
-                        neo4j_properties["internal_id"] = item.id                  # Example: 227
+                        neo4j_properties["internal_id"] = item.id               # Example: 227
                         neo4j_properties["neo4j_labels"] = list(item.labels)    # Example: ['person', 'client']
 
                     elif isinstance(item, neo4j.graph.Relationship):
-                        neo4j_properties["internal_id"] = item.id                  # Example: 227
+                        neo4j_properties["internal_id"] = item.id               # Example: 227
                         neo4j_properties["neo4j_start_node"] = item.start_node  # A neo4j.graph.Node object with "id", "labels" and "properties"
                         neo4j_properties["neo4j_end_node"] = item.end_node      # A neo4j.graph.Node object with "id", "labels" and "properties"
                                                                                 #   Example: <Node id=118 labels=frozenset({'car'}) properties={'color': 'white'}>
@@ -560,11 +560,12 @@ def get_record_by_primary_key(self, labels: str, primary_key_name: str, primary_
     def exists_by_key(self, labels: str, key_name: str, key_value) -> bool:
         """
         Return True if a node with the given labels and key_name/key_value exists, or False otherwise
-
+        TODO: test for multiple labels
         :param labels:
         :param key_name:
         :param key_value:
-        :return:
+        :return:            True if a node with the given labels and key_name/key_value exists,
+                                or False otherwise
         """
         record = self.get_record_by_primary_key(labels, key_name, key_value)
 
@@ -575,12 +576,12 @@ def exists_by_key(self, labels: str, key_name: str, key_value) -> bool:
 
 
 
-    def exists_by_internal_id(self, internal_id) -> bool:         # TODO: test
+    def exists_by_internal_id(self, internal_id) -> bool:
         """
         Return True if a node with the given internal Neo4j exists, or False otherwise
 
-        :param internal_id:
-        :return:        True if a node with the given internal Neo4j exists, or False otherwise
+        :param internal_id: An integer with a node's internal database ID
+        :return:            True if a node with the given internal Neo4j exists, or False otherwise
         """
         q = f'''
         MATCH (n) 

tests/test_neoaccess.py

@@ -299,7 +299,10 @@ def test_get_record_by_primary_key(db):
 
 
 def test_exists_by_key(db):
-    db.empty_dbase(drop_indexes=True, drop_constraints=True)
+    db.empty_dbase()
+
+    assert not db.exists_by_key("person", key_name="SSN", key_value=123)    # Cannot exist, because we just emptied the database
+
     db.create_node("person", {'SSN': 123, 'name': 'Valerie', 'gender': 'F'})
     db.create_node("person", {'SSN': 456, 'name': 'Therese', 'gender': 'F'})
 
@@ -313,6 +316,23 @@ def test_exists_by_key(db):
 
 
 
+def test_exists_by_internal_id(db):
+    db.empty_dbase()
+
+    assert not db.exists_by_internal_id(internal_id = 8888)     # Cannot exist, because we just emptied the database
+
+    Valerie_ID = db.create_node("person", {'SSN': 123, 'name': 'Valerie', 'gender': 'F'})
+    assert db.exists_by_internal_id(Valerie_ID)
+    assert not db.exists_by_internal_id(Valerie_ID+1)
+
+
+    Therese_ID = db.create_node("person", {'SSN': 456, 'name': 'Therese', 'gender': 'F'})
+    assert db.exists_by_internal_id(Therese_ID)
+
+    assert not db.exists_by_internal_id(Valerie_ID + Therese_ID + 1)    # Using an internal ID that could not possibly exist
+
+
+
 def test_get_nodes(db):
     db.empty_dbase(drop_indexes=True, drop_constraints=True)