Change scope of live server to session (#113)

live_server fixture scope can be configured, defaults to session

Fixes #62, Fixes #112, Closes #63 

Co-authored-by: Brian Cherinka <[email protected]>

Author: TWood67

docs/features.rst

@@ -186,6 +186,19 @@ in your project's ``pytest.ini`` file)::
 
 
 ``request_ctx`` - request context
+`````````````````````````````````
+
+``--live-server-scope`` - set the scope of the live server
+``````````````````````````````````````````````````````````````````
+
+By default, the server will be scoped to `session`. In some cases, you may want
+it to be fixed to a different scope. You can use ``--live-server-scope`` (for example,
+in your project's ``pytest.ini`` file)::
+
+    [pytest]
+    addopts = --live-server-scope=function
+
+
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The request context which contains all request relevant information.

pytest_flask/fixtures.py

@@ -116,8 +116,12 @@ def _rewrite_server_name(server_name, new_port):
     return sep.join((server_name, new_port))
 
 
-@pytest.fixture(scope='function')
-def live_server(request, app, monkeypatch, pytestconfig):
+def determine_scope(fixture_name, config):
+    return config.getoption('--live-server-scope', 'session')
+
+
+@pytest.fixture(scope=determine_scope)
+def live_server(request, app, pytestconfig):
     """Run application in a separate process.
 
     When the ``live_server`` fixture is applied, the ``url_for`` function
@@ -131,7 +135,10 @@ def test_server_is_up_and_running(live_server):
             assert res.code == 200
 
     """
-    port = pytestconfig.getvalue('live_server_port')
+    # Set or get a port
+    port = app.config.get('LIVESERVER_PORT', None)
+    if not port:
+        port = pytestconfig.getvalue('live_server_port')
 
     if port == 0:
         # Bind to an open port
@@ -143,18 +150,20 @@ def test_server_is_up_and_running(live_server):
     host = pytestconfig.getvalue('live_server_host')
 
     # Explicitly set application ``SERVER_NAME`` for test suite
-    # and restore original value on test teardown.
-    server_name = app.config['SERVER_NAME'] or 'localhost'
-    monkeypatch.setitem(app.config, 'SERVER_NAME',
-                        _rewrite_server_name(server_name, str(port)))
+    original_server_name = app.config['SERVER_NAME'] or 'localhost'
+    final_server_name = _rewrite_server_name(original_server_name, str(port))
+    app.config['SERVER_NAME'] = final_server_name
 
     clean_stop = request.config.getvalue('live_server_clean_stop')
     server = LiveServer(app, host, port, clean_stop)
     if request.config.getvalue('start_live_server'):
         server.start()
 
     request.addfinalizer(server.stop)
-    return server
+    yield server
+
+    if original_server_name is not None:
+        app.config['SERVER_NAME'] = original_server_name
 
 
 @pytest.fixture

pytest_flask/plugin.py

@@ -168,6 +168,8 @@ def pytest_addoption(parser):
                     help='use a host where to listen (default localhost).')
     group.addoption('--live-server-port', action='store', default=0, type=int,
                     help='use a fixed port for the live_server fixture.')
+    group.addoption('--live-server-scope', action='store', default='session', type=str,
+                    help='modify the scope of the live_server fixture.')
 
 
 def pytest_configure(config):

tests/conftest.py

@@ -9,7 +9,7 @@
 pytest_plugins = 'pytester'
 
 
-@pytest.fixture
+@pytest.fixture(scope='session')
 def app():
     app = Flask(__name__)
     app.config['SECRET_KEY'] = '42'
@@ -42,7 +42,7 @@ def create_test_module(code, filename='test_app.py'):
 
         from flask import Flask
 
-        @pytest.fixture
+        @pytest.fixture(scope='session')
         def app():
             app = Flask(__name__)
             return app

tests/test_live_server.py

@@ -33,10 +33,18 @@ def test_set_application_server_name(self, live_server):
         assert live_server.app.config['SERVER_NAME'] == \
             'localhost:%d' % live_server.port
 
-    @pytest.mark.options(server_name='example.com:5000')
-    def test_rewrite_application_server_name(self, live_server):
-        assert live_server.app.config['SERVER_NAME'] == \
-            'example.com:%d' % live_server.port
+    def test_rewrite_application_server_name(self, appdir):
+        appdir.create_test_module('''
+            import pytest
+            @pytest.mark.options(server_name='example.com:5000')
+            def test_a(live_server):
+                assert live_server.app.config['SERVER_NAME'] == \\
+                    'example.com:%d' % live_server.port
+        ''')
+
+        result = appdir.runpytest('-v', '--live-server-scope=function')
+        result.stdout.fnmatch_lines(['*PASSED*'])
+        assert result.ret == 0
 
     def test_prevent_starting_live_server(self, appdir):
         appdir.create_test_module('''
@@ -47,7 +55,7 @@ def test_a(live_server):
         ''')
 
         result = appdir.runpytest('-v', '--no-start-live-server')
-        result.stdout.fnmatch_lines(['*PASSED*'])
+        result.stdout.fnmatch_lines(['*passed*'])
         assert result.ret == 0
 
     def test_start_live_server(self, appdir):
@@ -59,7 +67,7 @@ def test_a(live_server):
                 assert live_server._process.is_alive()
         ''')
         result = appdir.runpytest('-v', '--start-live-server')
-        result.stdout.fnmatch_lines(['*PASSED*'])
+        result.stdout.fnmatch_lines(['*passed*'])
         assert result.ret == 0
 
     @pytest.mark.parametrize('clean_stop', [True, False])
@@ -127,9 +135,10 @@ def new_endpoint():
                 assert b'got it' in res.read()
         ''')
         result = appdir.runpytest('-v', '--no-start-live-server')
-        result.stdout.fnmatch_lines(['*PASSED*'])
+        result.stdout.fnmatch_lines(['*passed*'])
         assert result.ret == 0
 
+    @pytest.mark.skip('this test hangs in the original code')
     def test_concurrent_requests_to_live_server(self, appdir):
         appdir.create_test_module('''
             import pytest
@@ -154,7 +163,7 @@ def two():
                 assert b'42' in res.read()
         ''')
         result = appdir.runpytest('-v', '--no-start-live-server')
-        result.stdout.fnmatch_lines(['*PASSED*'])
+        result.stdout.fnmatch_lines(['*passed*'])
         assert result.ret == 0
 
     @pytest.mark.parametrize('port', [5000, 5001])