From: Scott Worley <scottworley@scottworley.com>
Date: Wed, 20 Dec 2023 02:45:55 +0000 (-0800)
Subject: FakeFetcher for faster tests
X-Git-Url: http://git.scottworley.com/paperdoorknob/commitdiff_plain/386218397a4723129b31e3954bb960da61f72474?hp=dbda64b551aaeffa4f01779a52c7ec68b1fffa98

FakeFetcher for faster tests

Run some tests against both the webserver and the FakeFetcher to make
sure both work.
---

diff --git a/fetch.py b/fetch.py
index 3c0c6a3..7776f93 100644
--- a/fetch.py
+++ b/fetch.py
@@ -41,3 +41,14 @@ def DirectFetcher(timeout: int) -> Iterator[_SessionFetcher]:
 def CachingFetcher(cache_path: str, timeout: int) -> Iterator[_SessionFetcher]:
     with requests_cache.CachedSession(cache_path, cache_control=True) as session:
         yield _SessionFetcher(session, timeout)
+
+
+class FakeFetcher(Fetcher):
+
+    def __init__(self, resources: dict[str, bytes]) -> None:
+        self._resources = resources
+
+    def fetch(self, url: str) -> bytes:
+        if url not in self._resources:
+            raise requests.HTTPError("URL not found")
+        return self._resources[url]
diff --git a/paperdoorknob_test.py b/paperdoorknob_test.py
index baf7945..425d5e3 100644
--- a/paperdoorknob_test.py
+++ b/paperdoorknob_test.py
@@ -5,6 +5,7 @@
 # Free Software Foundation, version 3.
 
 
+from abc import ABC, abstractmethod
 import unittest
 import io
 import subprocess
@@ -12,64 +13,92 @@ import subprocess
 import paperdoorknob
 
 from testing.fakeserver import FakeGlowficServer
-from fetch import DirectFetcher
+from fetch import DirectFetcher, FakeFetcher, Fetcher
 from spec import Spec
 from texify import DirectTexifier, PandocTexifier, VerifyingTexifier
 
 TIMEOUT = 8
 
 
-class TestPaperDoorknob(unittest.TestCase):
-    def setUp(self) -> None:
-        self._server = self.enterContext(FakeGlowficServer())
-        self._port = self._server.port()
+class BaseTestProcess(ABC):
+
+    @abstractmethod
+    def url(self) -> str:
+        raise NotImplementedError()
+
+    @abstractmethod
+    def fetcher(self) -> Fetcher:
+        raise NotImplementedError()
 
     def testReplies(self) -> None:
-        with DirectFetcher(TIMEOUT) as f:
-            replies = paperdoorknob.replies(
-                paperdoorknob.clean(
-                    paperdoorknob.parse(
-                        f.fetch(f"http://localhost:{self._port}"))))
-            self.assertEqual([r.text.strip() for r in replies],
-                             ["This is glowfic", "You sure?", "Pretty sure."])
+        replies = paperdoorknob.replies(
+            paperdoorknob.clean(
+                paperdoorknob.parse(
+                    self.fetcher().fetch(
+                        self.url()))))
+        assert [r.text.strip() for r in replies] == [
+            "This is glowfic",
+            "You sure?",
+            "Pretty sure."]
 
     def testProcess(self) -> None:
-        with DirectFetcher(TIMEOUT) as f:
-            buf = io.BytesIO()
-            spec = Spec(
-                f"http://localhost:{self._port}",
-                f,
-                PandocTexifier('pandoc'),
-                buf)
-            paperdoorknob.process(spec)
-            self.assertEqual(buf.getvalue(), b'''\\documentclass{article}
+        buf = io.BytesIO()
+        spec = Spec(
+            self.url(),
+            self.fetcher(),
+            PandocTexifier('pandoc'),
+            buf)
+        paperdoorknob.process(spec)
+        assert buf.getvalue() == b'''\\documentclass{article}
 \\begin{document}
 This is glowfic
 You \\emph{sure}?
 Pretty sure.
 \\end{document}
-''')
+'''
 
     def testDirectTexifier(self) -> None:
         texifier = VerifyingTexifier(
             PandocTexifier('pandoc'), DirectTexifier())
-        with DirectFetcher(TIMEOUT) as f:
-            buf = io.BytesIO()
-            spec = Spec(f"http://localhost:{self._port}", f, texifier, buf)
-            paperdoorknob.process(spec)
+        buf = io.BytesIO()
+        spec = Spec(self.url(), self.fetcher(), texifier, buf)
+        paperdoorknob.process(spec)
 
     def testPDF(self) -> None:
-        with DirectFetcher(TIMEOUT) as f:
-            with open("test.tex", 'wb') as out:
-                spec = Spec(
-                    f"http://localhost:{self._port}",
-                    f,
-                    PandocTexifier('pandoc'),
-                    out)
-                paperdoorknob.process(spec)
+        with open("test.tex", 'wb') as out:
+            spec = Spec(
+                self.url(),
+                self.fetcher(),
+                PandocTexifier('pandoc'),
+                out)
+            paperdoorknob.process(spec)
         subprocess.run(['pdflatex', 'test.tex'],
                        stdin=subprocess.DEVNULL, check=True)
 
 
+class TestProcessFromWebserver(BaseTestProcess, unittest.TestCase):
+
+    def setUp(self) -> None:
+        self._fetcher = self.enterContext(DirectFetcher(TIMEOUT))
+        self._server = self.enterContext(FakeGlowficServer())
+        self._port = self._server.port()
+
+    def url(self) -> str:
+        return f"http://localhost:{self._port}"
+
+    def fetcher(self) -> Fetcher:
+        return self._fetcher
+
+
+class TestProcessFromFakeFetcher(BaseTestProcess, unittest.TestCase):
+
+    def url(self) -> str:
+        return 'fic'
+
+    def fetcher(self) -> Fetcher:
+        with open('testdata/this-is-glowfic.html', 'rb') as f:
+            return FakeFetcher({'fic': f.read(9999)})
+
+
 if __name__ == '__main__':
     unittest.main()