[4.4] Warnings overhaul (#789)

* Warnings overhaul
* Fix falsely emitted `DeprecationWarning` regarding
  `update_routing_table_timeout`.
* Treat warnings as errors during testing
* Changed tests to expect and catch warning or to avoid them.
* TestKit backend: fix missing Python build dependency
* Improve TestKit glue output
* Close stub server pipes
* ITs: fix 5.0 support: use `WAIT` Cypher keyword when supported
* TestKit backend: close resources when done

Author: robsdedude

neo4j/__init__.py

@@ -383,13 +383,11 @@ def session(self, **config):
         """
         from neo4j.work.simple import Session
         session_config = SessionConfig(self._default_workspace_config, config)
-        SessionConfig.consume(config)  # Consume the config
         return Session(self._pool, session_config)
 
     def pipeline(self, **config):
         from neo4j.work.pipelining import Pipeline, PipelineConfig
         pipeline_config = PipelineConfig(self._default_workspace_config, config)
-        PipelineConfig.consume(config)  # Consume the config
         return Pipeline(self._pool, pipeline_config)
 
     @experimental("The configuration may change in the future.")
@@ -427,13 +425,11 @@ def __init__(self, pool, default_workspace_config):
 
     def session(self, **config):
         session_config = SessionConfig(self._default_workspace_config, config)
-        SessionConfig.consume(config)  # Consume the config
         return Session(self._pool, session_config)
 
     def pipeline(self, **config):
         from neo4j.work.pipelining import Pipeline, PipelineConfig
         pipeline_config = PipelineConfig(self._default_workspace_config, config)
-        PipelineConfig.consume(config)  # Consume the config
         return Pipeline(self._pool, pipeline_config)
 
     @experimental("The configuration may change in the future.")

neo4j/conf.py

@@ -170,9 +170,19 @@ def set_attr(k, v):
             else:
                 raise AttributeError(k)
 
+        rejected_keys = []
         for key, value in data_dict.items():
             if value is not None:
-                set_attr(key, value)
+                try:
+                    set_attr(key, value)
+                except AttributeError as exc:
+                    if not exc.args == (key,):
+                        raise
+                    rejected_keys.append(key)
+
+            if rejected_keys:
+                raise ConfigurationError("Unexpected config keys: "
+                                         + ", ".join(rejected_keys))
 
     def __init__(self, *args, **kwargs):
         for arg in args:

neo4j/io/__init__.py

@@ -277,18 +277,19 @@ def get_handshake(cls):
         return b"".join(version.to_bytes() for version in offered_versions).ljust(16, b"\x00")
 
     @classmethod
-    def ping(cls, address, *, timeout=None, **config):
+    def ping(cls, address, *, timeout=None, pool_config=None):
         """ Attempt to establish a Bolt connection, returning the
         agreed Bolt protocol version if successful.
         """
-        config = PoolConfig.consume(config)
+        if pool_config is None:
+            pool_config = PoolConfig()
         try:
             s, protocol_version, handshake, data = BoltSocket.connect(
                 address,
                 timeout=timeout,
-                custom_resolver=config.resolver,
-                ssl_context=config.get_ssl_context(),
-                keep_alive=config.keep_alive,
+                custom_resolver=pool_config.resolver,
+                ssl_context=pool_config.get_ssl_context(),
+                keep_alive=pool_config.keep_alive,
             )
         except (ServiceUnavailable, SessionExpired, BoltHandshakeError):
             return None
@@ -297,7 +298,8 @@ def ping(cls, address, *, timeout=None, **config):
             return protocol_version
 
     @classmethod
-    def open(cls, address, *, auth=None, timeout=None, routing_context=None, **pool_config):
+    def open(cls, address, *, auth=None, timeout=None, routing_context=None,
+             pool_config=None):
         """ Open a new Bolt connection to a given server address.
 
         :param address:
@@ -316,7 +318,8 @@ def time_remaining():
             return t if t > 0 else 0
 
         t0 = perf_counter()
-        pool_config = PoolConfig.consume(pool_config)
+        if pool_config is None:
+            pool_config = PoolConfig()
 
         socket_connection_timeout = pool_config.connection_timeout
         if socket_connection_timeout is None:
@@ -906,7 +909,7 @@ def open(cls, address, *, auth, pool_config, workspace_config):
         def opener(addr, timeout):
             return Bolt.open(
                 addr, auth=auth, timeout=timeout, routing_context=None,
-                **pool_config
+                pool_config=pool_config
             )
 
         pool = cls(opener, pool_config, workspace_config, address)
@@ -951,7 +954,8 @@ def open(cls, *addresses, auth, pool_config, workspace_config, routing_context=N
 
         def opener(addr, timeout):
             return Bolt.open(addr, auth=auth, timeout=timeout,
-                             routing_context=routing_context, **pool_config)
+                             routing_context=routing_context,
+                             pool_config=pool_config)
 
         pool = cls(opener, pool_config, workspace_config, address)
         return pool

neo4j/io/_socket.py

@@ -259,7 +259,7 @@ def _handshake(cls, s, resolved_address):
     def close_socket(cls, socket_):
         try:
             if isinstance(socket_, BoltSocket):
-                socket.close()
+                socket_.close()
             else:
                 socket_.shutdown(SHUT_RDWR)
                 socket_.close()

neo4j/time/__init__.py

@@ -482,7 +482,7 @@ def __mul__(self, other):
         :rtype: Duration
         """
         if isinstance(other, float):
-            deprecation_warn("Multiplication with float will be deprecated in "
+            deprecation_warn("Multiplication with float will be removed in "
                              "5.0.")
         if isinstance(other, (int, float)):
             return Duration(
@@ -1627,7 +1627,7 @@ def from_clock_time(cls, clock_time, epoch):
         ts = clock_time.seconds % 86400
         nanoseconds = int(NANO_SECONDS * ts + clock_time.nanoseconds)
         ticks = (epoch.time().ticks_ns + nanoseconds) % (86400 * NANO_SECONDS)
-        return Time.from_ticks_ns(ticks)
+        return cls.from_ticks_ns(ticks)
 
     @classmethod
     def __normalize_hour(cls, hour):
@@ -1657,8 +1657,8 @@ def __normalize_nanosecond(cls, hour, minute, second, nanosecond):
         # TODO 5.0: remove -----------------------------------------------------
         seconds, extra_ns = divmod(second, 1)
         if extra_ns:
-            deprecation_warn("Float support second will be removed in 5.0. "
-                             "Use `nanosecond` instead.")
+            deprecation_warn("Float support for `second` will be removed in "
+                             "5.0. Use `nanosecond` instead.")
         # ----------------------------------------------------------------------
         hour, minute, second = cls.__normalize_second(hour, minute, second)
         nanosecond = int(nanosecond
@@ -1753,7 +1753,7 @@ def nanosecond(self):
         return self.__nanosecond
 
     @property
-    @deprecated("hour_minute_second will be removed in 5.0. "
+    @deprecated("`hour_minute_second` will be removed in 5.0. "
                 "Use `hour_minute_second_nanosecond` instead.")
     def hour_minute_second(self):
         """The time as a tuple of (hour, minute, second).

testkit/Dockerfile

@@ -25,7 +25,7 @@ RUN apt-get update && \
     apt-get install -y --no-install-recommends \
         make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev \
         libsqlite3-dev wget curl llvm libncurses5-dev xz-utils tk-dev \
-        libxml2-dev libxmlsec1-dev libffi-dev \
+        libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev \
         ca-certificates && \
     apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 

testkit/backend.py

@@ -3,6 +3,6 @@
 
 if __name__ == "__main__":
     subprocess.check_call(
-        ["python", "-m", "testkitbackend"],
+        ["python", "-W", "error", "-m", "testkitbackend"],
         stdout=sys.stdout, stderr=sys.stderr
     )

testkit/stress.py

@@ -1,8 +1,6 @@
 import subprocess
-import os
 import sys
 
-
 if __name__ == "__main__":
     # Until below works
     sys.exit(0)
@@ -16,4 +14,4 @@
             "NEO4J_PASSWORD": os.environ["TEST_NEO4J_PASS"],
             "NEO4J_URI": uri}
     subprocess.check_call(cmd, universal_newlines=True,
-                          stderr=subprocess.STDOUT, env=env)
+                          stdout=sys.stdout, stderr=sys.stderr, env=env)

testkit/unittests.py

@@ -1,9 +1,12 @@
 import subprocess
+import sys
 
 
 def run(args):
     subprocess.run(
-        args, universal_newlines=True, stderr=subprocess.STDOUT, check=True)
+        args, universal_newlines=True, stdout=sys.stdout, stderr=sys.stderr,
+        check=True
+    )
 
 
 if __name__ == "__main__":

testkitbackend/__main__.py

@@ -1,6 +1,10 @@
+import warnings
+
 from .server import Server
 
+
 if __name__ == "__main__":
+    warnings.simplefilter("error")
     server = Server(("0.0.0.0", 9876))
     while True:
         server.handle_request()