Refactor: move MockRequest and MockResponse into mock_http module (#226)

This starts to cover some of the server refactoring tasks in #28 by moving the mock request/response classes out of the main server module and into a separate submodule.

Author: Adeelp1

README.md

@@ -254,6 +254,7 @@ Thanks to the following people for all their contributions! This project depends
 | Contributions | Name |
 | ----: | :---- |
 | [📖](# "Documentation") | [aaxis-em](https://github.com/aaxis-em) |
+| [💻](# "Code") | [Adeel](https://github.com/Adeelp1) |
 | [💻](# "Code") [⚠️](# "Tests") [🚇](# "Infrastructure") [📖](# "Documentation") [💬](# "Answering Questions") [👀](# "Reviewer") | [Dan Allan](https://github.com/danielballan) |
 | [💻](# "Code") | [Vangelis Banos](https://github.com/vbanos) |
 | [💻](# "Code") [📖](# "Documentation") | [Chaitanya Prakash Bapat](https://github.com/ChaiBapchya) |

docs/source/release-history.rst

@@ -2,6 +2,12 @@
 Release History
 ===============
 
+In Development
+--------------
+
+- Move mock request/response classes into a separate submodule of `server`. (:issue:`226`)
+
+
 Version 0.2.0 (2026-03-16)
 --------------------------
 

web_monitoring_diff/server/mock_http.py

@@ -0,0 +1,37 @@
+import mimetypes
+
+
+class MockRequest:
+    "An HTTPRequest-like object for local file:/// requests."
+    def __init__(self, url):
+        self.url = url
+
+
+class MockResponse:
+    "An HTTPResponse-like object for local file:/// requests."
+    def __init__(self, url, body, headers=None):
+        self.request = MockRequest(url)
+        self.body = body
+        self.headers = headers
+        self.error = None
+
+        if self.headers is None:
+            self.headers = {}
+
+        if 'Content-Type' not in self.headers:
+            self.headers.update(self._get_content_type_headers_from_url(url))
+
+    @staticmethod
+    def _get_content_type_headers_from_url(url):
+        # If the extension is not recognized, assume text/html
+        headers = {'Content-Type': 'text/html'}
+
+        content_type, content_encoding = mimetypes.guess_type(url)
+
+        if content_type is not None:
+            headers['Content-Type'] = content_type
+
+        if content_encoding is not None:
+            headers['Content-Encoding'] = content_encoding
+
+        return headers

web_monitoring_diff/server/server.py

@@ -6,7 +6,6 @@
 import inspect
 import functools
 import logging
-import mimetypes
 import os
 import pycurl
 import re
@@ -20,6 +19,7 @@
 import tornado.web
 import traceback
 import web_monitoring_diff
+from .mock_http import MockResponse
 from .. import basic_diffs, html_render_diff, html_links_diff
 from ..exceptions import UndiffableContentError, UndecodableContentError
 from ..utils import shutdown_executor_in_loop, Signal
@@ -169,42 +169,6 @@ def __init__(self, status_code=500, public_message=None, log_message=None,
         super().__init__(status_code, log_message, **kwargs)
 
 
-class MockRequest:
-    "An HTTPRequest-like object for local file:/// requests."
-    def __init__(self, url):
-        self.url = url
-
-
-class MockResponse:
-    "An HTTPResponse-like object for local file:/// requests."
-    def __init__(self, url, body, headers=None):
-        self.request = MockRequest(url)
-        self.body = body
-        self.headers = headers
-        self.error = None
-
-        if self.headers is None:
-            self.headers = {}
-
-        if 'Content-Type' not in self.headers:
-            self.headers.update(self._get_content_type_headers_from_url(url))
-
-    @staticmethod
-    def _get_content_type_headers_from_url(url):
-        # If the extension is not recognized, assume text/html
-        headers = {'Content-Type': 'text/html'}
-
-        content_type, content_encoding = mimetypes.guess_type(url)
-
-        if content_type is not None:
-            headers['Content-Type'] = content_type
-
-        if content_encoding is not None:
-            headers['Content-Encoding'] = content_encoding
-
-        return headers
-
-
 DEBUG_MODE = os.environ.get('DIFFING_SERVER_DEBUG', 'False').strip().lower() == 'true'
 
 VALIDATE_TARGET_CERTIFICATES = \

web_monitoring_diff/tests/test_server_exc_handling.py

@@ -10,6 +10,7 @@
 from tornado.testing import AsyncHTTPTestCase, bind_unused_port
 from unittest.mock import patch
 import web_monitoring_diff.server.server as df
+from web_monitoring_diff.server.mock_http import MockResponse
 from web_monitoring_diff.exceptions import UndecodableContentError
 import web_monitoring_diff
 from tornado.escape import utf8
@@ -234,7 +235,7 @@ async def responder(handler):
             assert response.code == 504
 
     def test_missing_params_caller_func(self):
-        response = df.MockResponse('http://example.org/', 'Whatever')
+        response = MockResponse('http://example.org/', 'Whatever')
         with self.assertRaises(KeyError):
             df.caller(mock_diffing_method, response, response)
 
@@ -603,7 +604,7 @@ def mock_tornado_request(fixture, headers=None):
     path = fixture_path(fixture)
     with open(path, 'rb') as f:
         body = f.read()
-        return df.MockResponse(f'file://{path}', body, headers)
+        return MockResponse(f'file://{path}', body, headers)
 
 
 # TODO: we may want to extract this to a support module
@@ -680,23 +681,23 @@ def _find_stub(self, request):
 
 class MockResponderHeadersTest(unittest.TestCase):
     def test_pdf_extension(self):
-        response = df.MockResponse(f'file://{fixture_path("simple.pdf")}', '')
+        response = MockResponse(f'file://{fixture_path("simple.pdf")}', '')
         assert response.headers['Content-Type'] == 'application/pdf'
 
     def test_html_extension(self):
-        response = df.MockResponse(f'file://{fixture_path("unknown_encoding.html")}', '')
+        response = MockResponse(f'file://{fixture_path("unknown_encoding.html")}', '')
         assert response.headers['Content-Type'] == 'text/html'
 
     def test_txt_extension(self):
-        response = df.MockResponse(f'file://{fixture_path("empty.txt")}', '')
+        response = MockResponse(f'file://{fixture_path("empty.txt")}', '')
         assert response.headers['Content-Type'] == 'text/plain'
 
     def test_no_extension_should_assume_html(self):
-        response = df.MockResponse(f'file://{fixture_path("unknown_encoding")}', '')
+        response = MockResponse(f'file://{fixture_path("unknown_encoding")}', '')
         assert response.headers['Content-Type'] == 'text/html'
 
     def test_unknown_extension_should_assume_html(self):
-        response = df.MockResponse(f'file://{fixture_path("unknown_encoding.notarealextension")}', '')
+        response = MockResponse(f'file://{fixture_path("unknown_encoding.notarealextension")}', '')
         assert response.headers['Content-Type'] == 'text/html'