From 1c86839bee11f2af73d71ed76c4d3eccbac4f316 Mon Sep 17 00:00:00 2001
From: Cameron Dale <camrdale@gmail.com>
Date: Tue, 11 Dec 2007 23:08:43 -0800
Subject: [PATCH] Add a manager for the client downloads and the tests for it.

---
 HTTPDownloader.py | 103 +++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 102 insertions(+), 1 deletion(-)

diff --git a/HTTPDownloader.py b/HTTPDownloader.py
index 3e705dd..290c7f9 100644
--- a/HTTPDownloader.py
+++ b/HTTPDownloader.py
@@ -9,6 +9,9 @@ from zope.interface import implements
 class HTTPClientManager(ClientFactory):
     """A manager for all HTTP requests to a single site.
     
+    Controls all requests that got to a single site (host and port).
+    This includes buffering requests until they can be sent and reconnecting
+    in the even of the connection being closed.
     
     """
 
@@ -42,6 +45,9 @@ class HTTPClientManager(ClientFactory):
         if not self.closed:
             self.proto.transport.loseConnection()
 
+    def is_idle(self):
+        return not self.busy and not self.request_queue and not self.response_queue
+    
     def submitRequest(self, request):
         request.deferRequest = defer.Deferred()
         self.request_queue.append(request)
@@ -97,8 +103,26 @@ class HTTPClientManager(ClientFactory):
         self.proto = None
         if self.request_queue:
             self.processQueue()
+            
+class HTTPDownloader:
+    """Manages all the HTTP connections to various sites."""
+    
+    def __init__(self):
+        self.clients = {}
+    
+    def get(self, host, port, request):
+        site = host + ":" + str(port)
+        if site not in self.clients:
+            self.clients[site] = HTTPClientManager(host, port)
+        return self.clients[site].submitRequest(request)
+    
+    def closeAll(self):
+        for site in self.clients:
+            self.clients[site].close()
+        self.clients = {}
 
-class TestDownloader(unittest.TestCase):
+class TestClientManager(unittest.TestCase):
+    """Unit tests for the HTTPClientManager."""
     
     client = None
     pending_calls = []
@@ -173,3 +197,80 @@ class TestDownloader(unittest.TestCase):
         if self.client:
             self.client.close()
             self.client = None
+
+class TestDownloader(unittest.TestCase):
+    """Unit tests for the HTTPDownloader."""
+    
+    manager = None
+    pending_calls = []
+    
+    def gotResp(self, resp, num, expect):
+        self.failUnless(resp.code >= 200 and resp.code < 300, "Got a non-200 response: %r" % resp.code)
+        if expect is not None:
+            self.failUnless(resp.stream.length == expect, "Length was incorrect, got %r, expected %r" % (resp.stream.length, expect))
+        resp.stream.close()
+    
+    def test_download(self):
+        self.manager = HTTPDownloader()
+        self.timeout = 10
+        lastDefer = defer.Deferred()
+        
+        host = 'www.camrdale.org'
+        d = self.manager.get(host, 80, ClientRequest("GET", '/robots.txt', {'Host':host}, None))
+        d.addCallback(self.gotResp, 1, 309)
+        d.addBoth(lastDefer.callback)
+        return lastDefer
+        
+    def test_head(self):
+        self.manager = HTTPDownloader()
+        self.timeout = 10
+        lastDefer = defer.Deferred()
+        
+        host = 'www.camrdale.org'
+        d = self.manager.get(host, 80, ClientRequest("HEAD", '/robots.txt', {'Host':host}, None))
+        d.addCallback(self.gotResp, 1, 0)
+        d.addBoth(lastDefer.callback)
+        return lastDefer
+        
+    def test_multiple_downloads(self):
+        self.manager = HTTPDownloader()
+        self.timeout = 120
+        lastDefer = defer.Deferred()
+        
+        def newRequest(host, path, num, expect, last=False):
+            d = self.manager.get(host, 80, ClientRequest("GET", path, {'Host':host}, None))
+            d.addCallback(self.gotResp, num, expect)
+            if last:
+                d.addCallback(lastDefer.callback)
+                
+        newRequest('www.camrdale.org', "/", 1, 3433)
+        newRequest('www.camrdale.org', "/blog/", 2, 37121)
+        newRequest('www.google.ca', "/", 3, None)
+        self.pending_calls.append(reactor.callLater(1, newRequest, 'www.sfu.ca', '/', 4, None))
+        self.pending_calls.append(reactor.callLater(10, newRequest, 'www.camrdale.org', '/wikilink.html', 5, 3084))
+        self.pending_calls.append(reactor.callLater(30, newRequest, 'www.camrdale.org', '/sitemap.html', 6, 4750))
+        self.pending_calls.append(reactor.callLater(31, newRequest, 'www.sfu.ca', '/studentcentral/index.html', 7, None))
+        self.pending_calls.append(reactor.callLater(32, newRequest, 'www.camrdale.org', '/openid.html', 8, 2525))
+        self.pending_calls.append(reactor.callLater(32, newRequest, 'www.camrdale.org', '/subpage.html', 9, 2381))
+        self.pending_calls.append(reactor.callLater(62, newRequest, 'www.google.ca', '/intl/en/options/', 0, None, True))
+        return lastDefer
+        
+    def test_range(self):
+        self.manager = HTTPDownloader()
+        self.timeout = 10
+        lastDefer = defer.Deferred()
+        
+        host = 'www.camrdale.org'
+        d = self.manager.get(host, 80, ClientRequest("GET", '/robots.txt', {'Host':host, 'Range': ('bytes', [(100, 199)])}, None))
+        d.addCallback(self.gotResp, 1, 100)
+        d.addBoth(lastDefer.callback)
+        return lastDefer
+        
+    def tearDown(self):
+        for p in self.pending_calls:
+            if p.active():
+                p.cancel()
+        self.pending_calls = []
+        if self.manager:
+            self.manager.closeAll()
+            self.manager = None
-- 
2.39.2