4.0 summary counters (#399)

* added test case for SummaryCounters

* system updates

Author: martin-neotech

neo4j/work/summary.py

@@ -135,6 +135,9 @@ class SummaryCounters:
     #:
     constraints_removed = 0
 
+    #:
+    system_updates = 0
+
     def __init__(self, statistics):
         for key, value in dict(statistics).items():
             key = key.replace("-", "_")
@@ -145,12 +148,18 @@ def __repr__(self):
 
     @property
     def contains_updates(self):
+        """True if any of the counters except for system_updates, are greater than 0. Otherwise False."""
         return bool(self.nodes_created or self.nodes_deleted or
                     self.relationships_created or self.relationships_deleted or
                     self.properties_set or self.labels_added or self.labels_removed or
                     self.indexes_added or self.indexes_removed or
                     self.constraints_added or self.constraints_removed)
 
+    @property
+    def contains_system_updates(self):
+        """True if the system database was updated, otherwise False."""
+        return self.system_updates > 0
+
 
 #: A plan describes how the database will execute your statement.
 #:

tests/integration/test_summary.py

@@ -27,6 +27,13 @@
     ProfiledPlan,
     Notification,
     Position,
+    GraphDatabase,
+)
+from neo4j.exceptions import (
+    ServiceUnavailable,
+)
+from neo4j._exceptions import (
+    BoltHandshakeError,
 )
 
 
@@ -121,3 +128,179 @@ def test_protocol_version_information(session):
     assert isinstance(summary.server.protocol_version[1], int)
 
 
+def test_summary_counters_case_1(session):
+    # python -m pytest tests/integration/test_summary.py -s -v -k test_summary_counters_case_1
+
+    result = session.run("RETURN $number AS x", number=3)
+    summary = result.consume()
+
+    assert summary.query == "RETURN $number AS x"
+    assert summary.parameters == {"number": 3}
+
+    assert isinstance(summary.query_type, str)
+
+    counters = summary.counters
+
+    assert isinstance(counters, SummaryCounters)
+    assert counters.nodes_created == 0
+    assert counters.nodes_deleted == 0
+    assert counters.relationships_created == 0
+    assert counters.relationships_deleted == 0
+    assert counters.properties_set == 0
+    assert counters.labels_added == 0
+    assert counters.labels_removed == 0
+    assert counters.indexes_added == 0
+    assert counters.indexes_removed == 0
+    assert counters.constraints_added == 0
+    assert counters.constraints_removed == 0
+    assert counters.contains_updates is False
+
+    assert counters.system_updates == 0
+    assert counters.contains_system_updates is False
+
+
+def test_summary_counters_case_2(neo4j_uri, auth, target):
+    # python -m pytest tests/integration/test_summary.py -s -v -k test_summary_counters_case_2
+    try:
+        with GraphDatabase.driver(neo4j_uri, auth=auth) as driver:
+
+            with driver.session(database="system") as session:
+                session.run("DROP DATABASE test IF EXISTS").consume()
+
+                # SHOW DATABASES
+
+                result = session.run("SHOW DATABASES")
+                databases = set()
+                for record in result:
+                    databases.add(record.get("name"))
+                assert "system" in databases
+                assert "neo4j" in databases
+
+                summary = result.consume()
+
+                assert summary.query == "SHOW DATABASES"
+                assert summary.parameters == {}
+
+                assert isinstance(summary.query_type, str)
+
+                counters = summary.counters
+
+                assert isinstance(counters, SummaryCounters)
+                assert counters.nodes_created == 0
+                assert counters.nodes_deleted == 0
+                assert counters.relationships_created == 0
+                assert counters.relationships_deleted == 0
+                assert counters.properties_set == 0
+                assert counters.labels_added == 0
+                assert counters.labels_removed == 0
+                assert counters.indexes_added == 0
+                assert counters.indexes_removed == 0
+                assert counters.constraints_added == 0
+                assert counters.constraints_removed == 0
+                assert counters.contains_updates is False
+
+                assert counters.system_updates == 0
+                assert counters.contains_system_updates is False
+
+                # CREATE DATABASE test
+
+                summary = session.run("CREATE DATABASE test").consume()
+
+                assert summary.query == "CREATE DATABASE test"
+                assert summary.parameters == {}
+
+                assert isinstance(summary.query_type, str)
+
+                counters = summary.counters
+
+                assert isinstance(counters, SummaryCounters)
+                assert counters.nodes_created == 0
+                assert counters.nodes_deleted == 0
+                assert counters.relationships_created == 0
+                assert counters.relationships_deleted == 0
+                assert counters.properties_set == 0
+                assert counters.labels_added == 0
+                assert counters.labels_removed == 0
+                assert counters.indexes_added == 0
+                assert counters.indexes_removed == 0
+                assert counters.constraints_added == 0
+                assert counters.constraints_removed == 0
+                assert counters.contains_updates is False
+
+                assert counters.system_updates == 1
+                assert counters.contains_system_updates is True
+
+            with driver.session(database="test") as session:
+                summary = session.run("CREATE (n)").consume()
+                assert summary.counters.contains_updates is True
+                assert summary.counters.contains_system_updates is False
+                assert summary.counters.nodes_created == 1
+
+            with driver.session(database="test") as session:
+                summary = session.run("MATCH (n) DELETE (n)").consume()
+                assert summary.counters.contains_updates is True
+                assert summary.counters.contains_system_updates is False
+                assert summary.counters.nodes_deleted == 1
+
+            with driver.session(database="test") as session:
+                summary = session.run("CREATE ()-[:KNOWS]->()").consume()
+                assert summary.counters.contains_updates is True
+                assert summary.counters.contains_system_updates is False
+                assert summary.counters.relationships_created == 1
+
+            with driver.session(database="test") as session:
+                summary = session.run("MATCH ()-[r:KNOWS]->() DELETE r").consume()
+                assert summary.counters.contains_updates is True
+                assert summary.counters.contains_system_updates is False
+                assert summary.counters.relationships_deleted == 1
+
+            with driver.session(database="test") as session:
+                summary = session.run("CREATE (n:ALabel)").consume()
+                assert summary.counters.contains_updates is True
+                assert summary.counters.contains_system_updates is False
+                assert summary.counters.labels_added == 1
+
+            with driver.session(database="test") as session:
+                summary = session.run("MATCH (n:ALabel) REMOVE n:ALabel").consume()
+                assert summary.counters.contains_updates is True
+                assert summary.counters.contains_system_updates is False
+                assert summary.counters.labels_removed == 1
+
+            with driver.session(database="test") as session:
+                summary = session.run("CREATE (n {magic: 42})").consume()
+                assert summary.counters.contains_updates is True
+                assert summary.counters.contains_system_updates is False
+                assert summary.counters.properties_set == 1
+
+            with driver.session(database="test") as session:
+                summary = session.run("CREATE INDEX ON :ALabel(prop)").consume()
+                assert summary.counters.contains_updates is True
+                assert summary.counters.contains_system_updates is False
+                assert summary.counters.indexes_added == 1
+
+            with driver.session(database="test") as session:
+                summary = session.run("DROP INDEX ON :ALabel(prop)").consume()
+                assert summary.counters.contains_updates is True
+                assert summary.counters.contains_system_updates is False
+                assert summary.counters.indexes_removed == 1
+
+            with driver.session(database="test") as session:
+                summary = session.run("CREATE CONSTRAINT ON (book:Book) ASSERT book.isbn IS UNIQUE").consume()
+                assert summary.counters.contains_updates is True
+                assert summary.counters.contains_system_updates is False
+                assert summary.counters.constraints_added == 1
+
+            with driver.session(database="test") as session:
+                summary = session.run("DROP CONSTRAINT ON (book:Book) ASSERT book.isbn IS UNIQUE").consume()
+                assert summary.counters.contains_updates is True
+                assert summary.counters.contains_system_updates is False
+                assert summary.counters.constraints_removed == 1
+
+            with driver.session(database="system") as session:
+                session.run("DROP DATABASE test IF EXISTS").consume()
+    except ServiceUnavailable as error:
+        if error.args[0] == "Server does not support routing":
+            # This is because a single instance Neo4j 3.5 does not have dbms.routing.cluster.getRoutingTable() call
+            pytest.skip(error.args[0])
+        elif isinstance(error.__cause__, BoltHandshakeError):
+            pytest.skip(error.args[0])