plugin: allow setting host and port from envvar

csernazs · csernazs · commit a7b855c4510a · 2018-09-11T08:04:40.000+02:00
Allow setting host and port from environment variable.

Also, this is a refactor:
* Change how the plugin works. Introduce a new class which register and
  de-register itself, so no need for extra workarounds.

* Handling of stopped servers

* Default listen host and port are moved to HTTPServer class attribute,
  so this can also be changed if desired by the user.
diff --git a/pytest_httpserver/httpserver.py b/pytest_httpserver/httpserver.py
@@ -262,7 +262,10 @@ class HTTPServer:   # pylint: disable=too-many-instance-attributes
         of the server.
     """
 
-    def __init__(self, host="localhost", port=4000, ssl_context=None):
+    DEFAULT_LISTEN_HOST = "localhost"
+    DEFAULT_LISTEN_PORT = 4000
+
+    def __init__(self, host=DEFAULT_LISTEN_HOST, port=DEFAULT_LISTEN_PORT, ssl_context=None):
         """
         Initializes the instance.
 
diff --git a/pytest_httpserver/pytest_plugin.py b/pytest_httpserver/pytest_plugin.py
@@ -1,5 +1,7 @@
 
 
+import os
+
 import pytest
 from .httpserver import HTTPServer
 
@@ -8,21 +10,45 @@ class Plugin:
     SERVER = None
 
 
+class PluginHTTPServer(HTTPServer):
+    def start(self):
+        super().start()
+        Plugin.SERVER = self
+
+    def stop(self):
+        super().stop()
+        Plugin.SERVER = None
+
+
+def get_httpserver_listen_address():
+    listen_host = os.environ.get("PYTEST_HTTPSERVER_HOST")
+    listen_port = os.environ.get("PYTEST_HTTPSERVER_PORT")
+    if listen_port:
+        listen_port = int(listen_port)
+
+    return (listen_host, listen_port)
+
+
 @pytest.fixture
 def httpserver():
-    if Plugin.SERVER is None:
-        server = HTTPServer()
-        server.start()
-        Plugin.SERVER = server
-    else:
-        server = Plugin.SERVER
-
-    server.clear()
+    if Plugin.SERVER:
+        Plugin.SERVER.clear()
+        yield Plugin.SERVER
+        return
+
+    host, port = get_httpserver_listen_address()
+    if not host:
+        host = HTTPServer.DEFAULT_LISTEN_HOST
+    if not port:
+        port = HTTPServer.DEFAULT_LISTEN_PORT
+
+    server = PluginHTTPServer(host=host, port=port)
+    server.start()
     yield server
 
 
 def pytest_sessionfinish(session, exitstatus):  # pylint: disable=unused-argument
     if Plugin.SERVER is not None:
         Plugin.SERVER.clear()
-        Plugin.SERVER.stop()
-        Plugin.SERVER = None
+        if Plugin.SERVER.is_running():
+            Plugin.SERVER.stop()
diff --git a/tests/test_port_changing.py b/tests/test_port_changing.py
@@ -0,0 +1,19 @@
+
+import os
+import pytest
+from pytest_httpserver import HTTPServer
+
+PORT_KEY = "PYTEST_HTTPSERVER_PORT"
+HOST_KEY = "PYTEST_HTTPSERVER_HOST"
+
+
+@pytest.mark.skipif(HOST_KEY not in os.environ,
+                    reason="requires {} environment variable".format(HOST_KEY))
+def test_host_changing_by_environment(httpserver: HTTPServer):
+    assert httpserver.host == os.environ[HOST_KEY]
+
+
+@pytest.mark.skipif(PORT_KEY not in os.environ,
+                    reason="requires {} environment variable".format(PORT_KEY))
+def test_port_changing_by_environment(httpserver: HTTPServer):
+    assert httpserver.port == int(os.environ[PORT_KEY])
