Migrate integration tests to TestKit & unit tests (#615)

Author: robsdedude

neo4j/work/simple.py

@@ -123,7 +123,10 @@ def _result_error(self, _):
             self._disconnect()
 
     def close(self):
-        """Close the session. This will release any borrowed resources, such as connections, and will roll back any outstanding transactions.
+        """Close the session.
+
+        This will release any borrowed resources, such as connections, and will
+        roll back any outstanding transactions.
         """
         if self._connection:
             if self._autoResult:

tests/integration/test_result.py

@@ -22,231 +22,24 @@
 import pytest
 
 
-from neo4j.exceptions import Neo4jError
-
-
-def test_can_consume_result_immediately(session):
-
-    def f(tx):
-        result = tx.run("UNWIND range(1, 3) AS n RETURN n")
-        assert [record[0] for record in result] == [1, 2, 3]
-
-    session.read_transaction(f)
-
-
-def test_can_consume_result_from_buffer(session):
-
-    def f(tx):
-        result = tx.run("UNWIND range(1, 3) AS n RETURN n")
-        result._buffer_all()
-        assert [record[0] for record in result] == [1, 2, 3]
-
-    session.read_transaction(f)
-
-
-@pytest.mark.skip(reason="This behaviour have changed in 4.0. transaction.commit/rollback -> DISCARD n=-1, COMMIT/ROLL_BACK")
-def test_can_consume_result_after_commit(session):
-    tx = session.begin_transaction()
-    result = tx.run("UNWIND range(1, 3) AS n RETURN n")
-    tx.commit()
-    assert [record[0] for record in result] == [1, 2, 3]
-
-
-@pytest.mark.skip(reason="This behaviour have changed in 4.0. transaction.commit/rollback -> DISCARD n=-1, COMMIT/ROLL_BACK")
-def test_can_consume_result_after_rollback(session):
-    tx = session.begin_transaction()
-    result = tx.run("UNWIND range(1, 3) AS n RETURN n")
-    tx.rollback()
-    assert [record[0] for record in result] == [1, 2, 3]
-
-
-@pytest.mark.skip(reason="This behaviour have changed. transaction.commit/rollback -> DISCARD n=-1, COMMIT/ROLL_BACK")
-def test_can_consume_result_after_session_close(bolt_driver):
-    with bolt_driver.session() as session:
-        tx = session.begin_transaction()
-        result = tx.run("UNWIND range(1, 3) AS n RETURN n")
-        tx.commit()
-    assert [record[0] for record in result] == [1, 2, 3]
-
-
-@pytest.mark.skip(reason="This behaviour have changed. transaction.commit/rollback -> DISCARD n=-1, COMMIT/ROLL_BACK")
-def test_can_consume_result_after_session_reuse(bolt_driver):
-    session = bolt_driver.session()
-    tx = session.begin_transaction()
-    result_a = tx.run("UNWIND range(1, 3) AS n RETURN n")
-    tx.commit()
-    session.close()
-    session = bolt_driver.session()
-    tx = session.begin_transaction()
-    result_b = tx.run("UNWIND range(4, 6) AS n RETURN n")
-    tx.commit()
-    session.close()
-    assert [record[0] for record in result_a] == [1, 2, 3]
-    assert [record[0] for record in result_b] == [4, 5, 6]
-
-
-def test_can_consume_results_after_harsh_session_death(bolt_driver):
-    session = bolt_driver.session()
-    result_a = session.run("UNWIND range(1, 3) AS n RETURN n")
-    del session
-    session = bolt_driver.session()
-    result_b = session.run("UNWIND range(4, 6) AS n RETURN n")
-    del session
-    assert [record[0] for record in result_a] == [1, 2, 3]
-    assert [record[0] for record in result_b] == [4, 5, 6]
-
-
-@pytest.mark.skip(reason="This behaviour have changed. transaction.commit/rollback -> DISCARD n=-1, COMMIT/ROLL_BACK")
-def test_can_consume_result_after_session_with_error(bolt_driver):
-    session = bolt_driver.session()
-    with pytest.raises(Neo4jError):
-        session.run("X").consume()
-    session.close()
-    session = bolt_driver.session()
-    tx = session.begin_transaction()
-    result = tx.run("UNWIND range(1, 3) AS n RETURN n")
-    tx.commit()
-    session.close()
-    assert [record[0] for record in result] == [1, 2, 3]
-
-
-def test_single_with_exactly_one_record(session):
-    result = session.run("UNWIND range(1, 1) AS n RETURN n")
-    record = result.single()
-    assert list(record.values()) == [1]
-
-
-# def test_value_with_no_records(session):
-#     result = session.run("CREATE ()")
-#     assert result.value() == []
-#
-#
-# def test_values_with_no_records(session):
-#     result = session.run("CREATE ()")
-#     assert result.values() == []
-
-
-def test_peek_can_look_one_ahead(session):
-    result = session.run("UNWIND range(1, 3) AS n RETURN n")
-    record = result.peek()
-    assert list(record.values()) == [1]
-
-
-def test_peek_fails_if_nothing_remains(neo4j_driver):
-    with neo4j_driver.session() as session:
-        result = session.run("CREATE ()")
-        upcoming = result.peek()
-        assert upcoming is None
-
-
-def test_peek_does_not_advance_cursor(session):
-    result = session.run("UNWIND range(1, 3) AS n RETURN n")
-    result.peek()
-    assert [record[0] for record in result] == [1, 2, 3]
-
-
-def test_peek_at_different_stages(session):
-    result = session.run("UNWIND range(0, 9) AS n RETURN n")
-    # Peek ahead to the first record
-    expected_next = 0
-    upcoming = result.peek()
-    assert upcoming[0] == expected_next
-    # Then look through all the other records
-    for expected, record in enumerate(result):
-        # Check this record is as expected
-        assert record[0] == expected
-        # Check the upcoming record is as expected...
-        if expected < 9:
-            # ...when one should follow
-            expected_next = expected + 1
-            upcoming = result.peek()
-            assert upcoming[0] == expected_next
-        else:
-            # ...when none should follow
-            upcoming = result.peek()
-            assert upcoming is None
-
-
-def test_can_safely_exit_session_without_consuming_result(session):
-    session.run("RETURN 1")
-    assert True
-
-
-def test_multiple_record_value_case_a(session):
-    result = session.run("UNWIND range(1, 3) AS n "
-                         "RETURN 1 * n AS x, 2 * n AS y, 3 * n AS z")
-    values = []
-    for record in result:
-        values.append(record.value(key=0, default=None))
-    assert values == [1, 2, 3]
-
-
-def test_multiple_record_value_case_b(session):
-    result = session.run("UNWIND range(1, 3) AS n "
-                         "RETURN 1 * n AS x, 2 * n AS y, 3 * n AS z")
-    values = []
-    for record in result:
-        values.append(record.value(key=2, default=None))
-    assert values == [3, 6, 9]
-
-
-def test_multiple_record_value_case_c(session):
-    result = session.run("UNWIND range(1, 3) AS n "
-                         "RETURN 1 * n AS x, 2 * n AS y, 3 * n AS z")
-    values = []
-    for record in result:
-        values.append(record.value(key="z", default=None))
-    assert values == [3, 6, 9]
-
-
-def test_record_values_case_a(session):
-    result = session.run("UNWIND range(1, 3) AS n "
-                         "RETURN 1 * n AS x, 2 * n AS y, 3 * n AS z")
-    values = []
-    for record in result:
-        values.append(record.values())
-    assert values == [[1, 2, 3], [2, 4, 6], [3, 6, 9]]
-
-
-def test_record_values_case_b(session):
-    result = session.run("UNWIND range(1, 3) AS n "
-                         "RETURN 1 * n AS x, 2 * n AS y, 3 * n AS z")
-    values = []
-    for record in result:
-        values.append(record.values(2, 0))
-    assert values == [[3, 1], [6, 2], [9, 3]]
-
-
-def test_record_values_case_c(session):
-    result = session.run("UNWIND range(1, 3) AS n "
-                         "RETURN 1 * n AS x, 2 * n AS y, 3 * n AS z")
-    values = []
-    for record in result:
-        values.append(record.values("z", "x"))
-    assert values == [[3, 1], [6, 2], [9, 3]]
-
-
-def test_no_records(neo4j_driver):
-    with neo4j_driver.session() as session:
-        result = session.run("CREATE ()")
-        values = []
-        for record in result:
-            values.append(record.value())
-        assert values == []
-
-
+# TODO: this test will stay until a uniform behavior for `.single()` across the
+#       drivers has been specified and tests are created in testkit
 def test_result_single_with_no_records(session):
     result = session.run("CREATE ()")
     record = result.single()
     assert record is None
 
 
+# TODO: this test will stay until a uniform behavior for `.single()` across the
+#       drivers has been specified and tests are created in testkit
 def test_result_single_with_one_record(session):
     result = session.run("UNWIND [1] AS n RETURN n")
     record = result.single()
     assert record["n"] == 1
 
 
+# TODO: this test will stay until a uniform behavior for `.single()` across the
+#       drivers has been specified and tests are created in testkit
 def test_result_single_with_multiple_records(session):
     import warnings
     result = session.run("UNWIND [1, 2, 3] AS n RETURN n")
@@ -255,57 +48,11 @@ def test_result_single_with_multiple_records(session):
         assert record[0] == 1
 
 
+# TODO: this test will stay until a uniform behavior for `.single()` across the
+#       drivers has been specified and tests are created in testkit
 def test_result_single_consumes_the_result(session):
     result = session.run("UNWIND [1, 2, 3] AS n RETURN n")
     with pytest.warns(UserWarning, match="Expected a result with a single record"):
         _ = result.single()
         records = list(result)
         assert records == []
-
-
-def test_single_value(session):
-    result = session.run("RETURN 1 AS x, 2 AS y, 3 AS z")
-    assert result.single().value() == 1
-
-
-def test_single_indexed_value(session):
-    result = session.run("RETURN 1 AS x, 2 AS y, 3 AS z")
-    assert result.single().value(2) == 3
-
-
-def test_single_keyed_value(session):
-    result = session.run("RETURN 1 AS x, 2 AS y, 3 AS z")
-    assert result.single().value("z") == 3
-
-
-def test_single_values(session):
-    result = session.run("RETURN 1 AS x, 2 AS y, 3 AS z")
-    assert result.single().values() == [1, 2, 3]
-
-
-def test_single_indexed_values(session):
-    result = session.run("RETURN 1 AS x, 2 AS y, 3 AS z")
-    assert result.single().values(2, 0) == [3, 1]
-
-
-def test_single_keyed_values(session):
-    result = session.run("RETURN 1 AS x, 2 AS y, 3 AS z")
-    assert result.single().values("z", "x") == [3, 1]
-
-
-def test_result_with_helper_function_value(session):
-
-    def f(tx):
-        result = tx.run("UNWIND range(1, 3) AS n RETURN n")
-        assert result.value(0) == [1, 2, 3]
-
-    session.read_transaction(f)
-
-
-def test_result_with_helper_function_values(session):
-
-    def f(tx):
-        result = tx.run("UNWIND range(1, 3) AS n RETURN n, 0")
-        assert result.values(0, 1) == [[1, 0], [2, 0], [3, 0]]
-
-    session.read_transaction(f)