Improve clean stop test to use mock instead of codecov

Author: nicoddemus

pytest_flask/fixtures.py

@@ -87,21 +87,26 @@ def url(self, url=''):
     def stop(self):
         """Stop application process."""
         if self._process:
-            if self.clean_stop:
-                # We wait a maximum of 5 seconds for the server to terminate cleanly
-                timeout = 5
-                try:
-                    os.kill(self._process.pid, signal.SIGINT)
-                    self._process.join(timeout)
-                except Exception as ex:
-                    logging.error('Failed to join the live server process: %r', ex)
-                finally:
-                    if self._process.is_alive():
-                        # If it's still alive, kill it
-                        self._process.terminate()
-            else:
+            if self.clean_stop and self._stop_cleanly():
+                return
+            if self._process.is_alive():
+                # If it's still alive, kill it
                 self._process.terminate()
 
+    def _stop_cleanly(self, timeout=5):
+        """Attempts to stop the server cleanly by sending a SIGINT signal and waiting for
+        ``timeout`` seconds.
+
+        :return: True if the server was cleanly stopped, False otherwise.
+        """
+        try:
+            os.kill(self._process.pid, signal.SIGINT)
+            self._process.join(timeout)
+            return True
+        except Exception as ex:
+            logging.error('Failed to join the live server process: %r', ex)
+            return False
+
     def __repr__(self):
         return '<LiveServer listening at %s>' % self.url()
 

tests/test_live_server.py

@@ -67,8 +67,25 @@ def test_a(live_server):
         result.stdout.fnmatch_lines(['*PASSED*'])
         assert result.ret == 0
 
-    def test_clean_stop_live_server(self, appdir):
-        pytest_cov = pytest.importorskip("pytest_cov")
+    def test_clean_stop_live_server(self, appdir, monkeypatch):
+        """Ensure the fixture is trying to cleanly stop the server.
+
+        Because this is tricky to test, we are checking that the _stop_cleanly() internal
+        function was called and reported success.
+        """
+        from pytest_flask.fixtures import LiveServer
+
+        original_stop_cleanly_func = LiveServer._stop_cleanly
+
+        stop_cleanly_result = []
+
+        def mocked_stop_cleanly(*args, **kwargs):
+            result = original_stop_cleanly_func(*args, **kwargs)
+            stop_cleanly_result.append(result)
+            return result
+
+        monkeypatch.setattr(LiveServer, '_stop_cleanly', mocked_stop_cleanly)
+
         appdir.create_test_module('''
             import pytest
             try:
@@ -89,30 +106,10 @@ def index():
                 assert res.code == 200
                 assert b'got it' in res.read()
         ''')
-        result_with = appdir.runpytest('-v',
-                                       '--no-start-live-server',
-                                       '--live-server-clean-stop',
-                                       '--cov=%s' % str(appdir.tmpdir),
-                                       '--cov-report=term-missing')
-        result_without = appdir.runpytest('-v',
-                                          '--no-start-live-server',
-                                          '--no-live-server-clean-stop',
-                                          '--cov=%s' % str(appdir.tmpdir),
-                                          '--cov-report=term-missing')
-
-        def _get_missing(r):
-            for line in r.outlines:
-                if not line.startswith('TOTAL'):
-                    continue
-                # Columns: Name   Stmts   Miss   Cover   Missing
-                return int(line.split()[2])
-            raise ValueError("Expected a TOTAL line in the cov output")
-
-        # Read the "Missing" column (i.e. lines not covered)
-        missing_with, missing_without = _get_missing(result_with), _get_missing(result_without)
-
-        # If the clean stop worked, the single line in the view function should be covered
-        assert missing_with == (missing_without - 1)
+        result = appdir.runpytest_inprocess('-v', '--no-start-live-server',
+                                            '--live-server-clean-stop')
+        result.stdout.fnmatch_lines('*1 passed*')
+        assert stop_cleanly_result == [True]
 
     def test_add_endpoint_to_live_server(self, appdir):
         appdir.create_test_module('''