[Repoze-checkins] r1108 - in repoze.accelerator: . branches tags trunk trunk/repoze trunk/repoze/accelerator

Chris McDonough chrism at agendaless.com
Fri Jun 20 02:29:02 EDT 2008


Author: Chris McDonough <chrism at agendaless.com>
Date: Fri Jun 20 02:29:01 2008
New Revision: 1108

Log:
First cut at HTTP acceleration middleware.



Added:
   repoze.accelerator/
   repoze.accelerator/branches/
   repoze.accelerator/tags/
   repoze.accelerator/trunk/
   repoze.accelerator/trunk/CHANGES.txt   (contents, props changed)
   repoze.accelerator/trunk/COPYRIGHT.txt   (contents, props changed)
   repoze.accelerator/trunk/LICENSE.txt   (contents, props changed)
   repoze.accelerator/trunk/README.txt   (contents, props changed)
   repoze.accelerator/trunk/TODO.txt   (contents, props changed)
   repoze.accelerator/trunk/ez_setup.py   (contents, props changed)
   repoze.accelerator/trunk/repoze/
   repoze.accelerator/trunk/repoze/__init__.py   (contents, props changed)
   repoze.accelerator/trunk/repoze/accelerator/
   repoze.accelerator/trunk/repoze/accelerator/__init__.py   (contents, props changed)
   repoze.accelerator/trunk/repoze/accelerator/middleware.py   (contents, props changed)
   repoze.accelerator/trunk/repoze/accelerator/tests.py   (contents, props changed)
   repoze.accelerator/trunk/setup.py   (contents, props changed)

Added: repoze.accelerator/trunk/CHANGES.txt
==============================================================================
--- (empty file)
+++ repoze.accelerator/trunk/CHANGES.txt	Fri Jun 20 02:29:01 2008
@@ -0,0 +1,4 @@
+0.1
+
+  Initial release.
+

Added: repoze.accelerator/trunk/COPYRIGHT.txt
==============================================================================
--- (empty file)
+++ repoze.accelerator/trunk/COPYRIGHT.txt	Fri Jun 20 02:29:01 2008
@@ -0,0 +1,3 @@
+Copyright (c) 2007 Agendaless Consulting and Contributors.
+(http://www.agendaless.com), All Rights Reserved
+

Added: repoze.accelerator/trunk/LICENSE.txt
==============================================================================
--- (empty file)
+++ repoze.accelerator/trunk/LICENSE.txt	Fri Jun 20 02:29:01 2008
@@ -0,0 +1,41 @@
+License
+
+  A copyright notice accompanies this license document that identifies
+  the copyright holders.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are
+  met:
+
+  1.  Redistributions in source code must retain the accompanying
+      copyright notice, this list of conditions, and the following
+      disclaimer.
+
+  2.  Redistributions in binary form must reproduce the accompanying
+      copyright notice, this list of conditions, and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+  3.  Names of the copyright holders must not be used to endorse or
+      promote products derived from this software without prior
+      written permission from the copyright holders.
+
+  4.  If any files are modified, you must cause the modified files to
+      carry prominent notices stating that you changed the files and
+      the date of any change.
+
+  Disclaimer
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND
+    ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+    TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+    PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+    HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+    TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+    ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+    TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+    THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+    SUCH DAMAGE.
+

Added: repoze.accelerator/trunk/README.txt
==============================================================================
--- (empty file)
+++ repoze.accelerator/trunk/README.txt	Fri Jun 20 02:29:01 2008
@@ -0,0 +1,5 @@
+repoze.accelerator
+==================
+
+An caching accelerator for web applications.
+

Added: repoze.accelerator/trunk/TODO.txt
==============================================================================
--- (empty file)
+++ repoze.accelerator/trunk/TODO.txt	Fri Jun 20 02:29:01 2008
@@ -0,0 +1 @@
+List todo items here.

Added: repoze.accelerator/trunk/ez_setup.py
==============================================================================
--- (empty file)
+++ repoze.accelerator/trunk/ez_setup.py	Fri Jun 20 02:29:01 2008
@@ -0,0 +1,272 @@
+#!python
+"""Bootstrap setuptools installation
+
+If you want to use setuptools in your package's setup.py, just include this
+file in the same directory with it, and add this to the top of your setup.py::
+
+    from ez_setup import use_setuptools
+    use_setuptools()
+
+If you want to require a specific version of setuptools, set a download
+mirror, or use an alternate download directory, you can do so by supplying
+the appropriate options to ``use_setuptools()``.
+
+This file can also be run as a script to install or upgrade setuptools.
+"""
+import sys
+DEFAULT_VERSION = "0.6c8"
+DEFAULT_URL     = "http://pypi.python.org/packages/%s/s/setuptools/" % sys.version[:3]
+
+md5_data = {
+    'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b996b7f25c6e6ca',
+    'setuptools-0.6b1-py2.4.egg': 'b79a8a403e4502fbb85ee3f1941735cb',
+    'setuptools-0.6b2-py2.3.egg': '5657759d8a6d8fc44070a9d07272d99b',
+    'setuptools-0.6b2-py2.4.egg': '4996a8d169d2be661fa32a6e52e4f82a',
+    'setuptools-0.6b3-py2.3.egg': 'bb31c0fc7399a63579975cad9f5a0618',
+    'setuptools-0.6b3-py2.4.egg': '38a8c6b3d6ecd22247f179f7da669fac',
+    'setuptools-0.6b4-py2.3.egg': '62045a24ed4e1ebc77fe039aa4e6f7e5',
+    'setuptools-0.6b4-py2.4.egg': '4cb2a185d228dacffb2d17f103b3b1c4',
+    'setuptools-0.6c1-py2.3.egg': 'b3f2b5539d65cb7f74ad79127f1a908c',
+    'setuptools-0.6c1-py2.4.egg': 'b45adeda0667d2d2ffe14009364f2a4b',
+    'setuptools-0.6c2-py2.3.egg': 'f0064bf6aa2b7d0f3ba0b43f20817c27',
+    'setuptools-0.6c2-py2.4.egg': '616192eec35f47e8ea16cd6a122b7277',
+    'setuptools-0.6c3-py2.3.egg': 'f181fa125dfe85a259c9cd6f1d7b78fa',
+    'setuptools-0.6c3-py2.4.egg': 'e0ed74682c998bfb73bf803a50e7b71e',
+    'setuptools-0.6c3-py2.5.egg': 'abef16fdd61955514841c7c6bd98965e',
+    'setuptools-0.6c4-py2.3.egg': 'b0b9131acab32022bfac7f44c5d7971f',
+    'setuptools-0.6c4-py2.4.egg': '2a1f9656d4fbf3c97bf946c0a124e6e2',
+    'setuptools-0.6c4-py2.5.egg': '8f5a052e32cdb9c72bcf4b5526f28afc',
+    'setuptools-0.6c5-py2.3.egg': 'ee9fd80965da04f2f3e6b3576e9d8167',
+    'setuptools-0.6c5-py2.4.egg': 'afe2adf1c01701ee841761f5bcd8aa64',
+    'setuptools-0.6c5-py2.5.egg': 'a8d3f61494ccaa8714dfed37bccd3d5d',
+    'setuptools-0.6c6-py2.3.egg': '35686b78116a668847237b69d549ec20',
+    'setuptools-0.6c6-py2.4.egg': '3c56af57be3225019260a644430065ab',
+    'setuptools-0.6c6-py2.5.egg': 'b2f8a7520709a5b34f80946de5f02f53',
+    'setuptools-0.6c7-py2.3.egg': '209fdf9adc3a615e5115b725658e13e2',
+    'setuptools-0.6c7-py2.4.egg': '5a8f954807d46a0fb67cf1f26c55a82e',
+    'setuptools-0.6c7-py2.5.egg': '45d2ad28f9750e7434111fde831e8372',
+    'setuptools-0.6c8-py2.3.egg': '50759d29b349db8cfd807ba8303f1902',
+    'setuptools-0.6c8-py2.4.egg': 'cba38d74f7d483c06e9daa6070cce6de',
+    'setuptools-0.6c8-py2.5.egg': '1721747ee329dc150590a58b3e1ac95b',
+}
+
+import sys, os
+
+def _validate_md5(egg_name, data):
+    if egg_name in md5_data:
+        from md5 import md5
+        digest = md5(data).hexdigest()
+        if digest != md5_data[egg_name]:
+            print >>sys.stderr, (
+                "md5 validation of %s failed!  (Possible download problem?)"
+                % egg_name
+            )
+            sys.exit(2)
+    return data
+
+
+def use_setuptools(
+    version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
+    download_delay=15
+):
+    """Automatically find/download setuptools and make it available on sys.path
+
+    `version` should be a valid setuptools version number that is available
+    as an egg for download under the `download_base` URL (which should end with
+    a '/').  `to_dir` is the directory where setuptools will be downloaded, if
+    it is not already available.  If `download_delay` is specified, it should
+    be the number of seconds that will be paused before initiating a download,
+    should one be required.  If an older version of setuptools is installed,
+    this routine will print a message to ``sys.stderr`` and raise SystemExit in
+    an attempt to abort the calling script.
+    """
+    was_imported = 'pkg_resources' in sys.modules or 'setuptools' in sys.modules
+    def do_download():
+        egg = download_setuptools(version, download_base, to_dir, download_delay)
+        sys.path.insert(0, egg)
+        import setuptools; setuptools.bootstrap_install_from = egg
+    try:
+        import pkg_resources
+    except ImportError:
+        return do_download()       
+    try:
+        pkg_resources.require("setuptools>="+version); return
+    except pkg_resources.VersionConflict, e:
+        if was_imported:
+            print >>sys.stderr, (
+            "The required version of setuptools (>=%s) is not available, and\n"
+            "can't be installed while this script is running. Please install\n"
+            " a more recent version first, using 'easy_install -U setuptools'."
+            "\n\n(Currently using %r)"
+            ) % (version, e.args[0])
+            sys.exit(2)
+        else:
+            del pkg_resources, sys.modules['pkg_resources']    # reload ok
+            return do_download()
+    except pkg_resources.DistributionNotFound:
+        return do_download()
+
+def download_setuptools(
+    version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
+    delay = 15
+):
+    """Download setuptools from a specified location and return its filename
+
+    `version` should be a valid setuptools version number that is available
+    as an egg for download under the `download_base` URL (which should end
+    with a '/'). `to_dir` is the directory where the egg will be downloaded.
+    `delay` is the number of seconds to pause before an actual download attempt.
+    """
+    import urllib2, shutil
+    egg_name = "setuptools-%s-py%s.egg" % (version,sys.version[:3])
+    url = download_base + egg_name
+    saveto = os.path.join(to_dir, egg_name)
+    src = dst = None
+    if not os.path.exists(saveto):  # Avoid repeated downloads
+        try:
+            from distutils import log
+            if delay:
+                log.warn("""
+---------------------------------------------------------------------------
+This script requires setuptools version %s to run (even to display
+help).  I will attempt to download it for you (from
+%s), but
+you may need to enable firewall access for this script first.
+I will start the download in %d seconds.
+
+(Note: if this machine does not have network access, please obtain the file
+
+   %s
+
+and place it in this directory before rerunning this script.)
+---------------------------------------------------------------------------""",
+                    version, download_base, delay, url
+                ); from time import sleep; sleep(delay)
+            log.warn("Downloading %s", url)
+            src = urllib2.urlopen(url)
+            # Read/write all in one block, so we don't create a corrupt file
+            # if the download is interrupted.
+            data = _validate_md5(egg_name, src.read())
+            dst = open(saveto,"wb"); dst.write(data)
+        finally:
+            if src: src.close()
+            if dst: dst.close()
+    return os.path.realpath(saveto)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+def main(argv, version=DEFAULT_VERSION):
+    """Install or upgrade setuptools and EasyInstall"""
+    try:
+        import setuptools
+    except ImportError:
+        egg = None
+        try:
+            egg = download_setuptools(version, delay=0)
+            sys.path.insert(0,egg)
+            from setuptools.command.easy_install import main
+            return main(list(argv)+[egg])   # we're done here
+        finally:
+            if egg and os.path.exists(egg):
+                os.unlink(egg)
+    else:
+        if setuptools.__version__ == '0.0.1':
+            print >>sys.stderr, (
+            "You have an obsolete version of setuptools installed.  Please\n"
+            "remove it from your system entirely before rerunning this script."
+            )
+            sys.exit(2)
+
+    req = "setuptools>="+version
+    import pkg_resources
+    try:
+        pkg_resources.require(req)
+    except pkg_resources.VersionConflict:
+        try:
+            from setuptools.command.easy_install import main
+        except ImportError:
+            from easy_install import main
+        main(list(argv)+[download_setuptools(delay=0)])
+        sys.exit(0) # try to force an exit
+    else:
+        if argv:
+            from setuptools.command.easy_install import main
+            main(argv)
+        else:
+            print "Setuptools version",version,"or greater has been installed."
+            print '(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)'
+
+def update_md5(filenames):
+    """Update our built-in md5 registry"""
+
+    import re
+    from md5 import md5
+
+    for name in filenames:
+        base = os.path.basename(name)
+        f = open(name,'rb')
+        md5_data[base] = md5(f.read()).hexdigest()
+        f.close()
+
+    data = ["    %r: %r,\n" % it for it in md5_data.items()]
+    data.sort()
+    repl = "".join(data)
+
+    import inspect
+    srcfile = inspect.getsourcefile(sys.modules[__name__])
+    f = open(srcfile, 'rb'); src = f.read(); f.close()
+
+    match = re.search("\nmd5_data = {\n([^}]+)}", src)
+    if not match:
+        print >>sys.stderr, "Internal error!"
+        sys.exit(2)
+
+    src = src[:match.start(1)] + repl + src[match.end(1):]
+    f = open(srcfile,'w')
+    f.write(src)
+    f.close()
+
+
+if __name__=='__main__':
+    if len(sys.argv)>2 and sys.argv[1]=='--md5update':
+        update_md5(sys.argv[2:])
+    else:
+        main(sys.argv[1:])
+
+
+
+
+

Added: repoze.accelerator/trunk/repoze/__init__.py
==============================================================================
--- (empty file)
+++ repoze.accelerator/trunk/repoze/__init__.py	Fri Jun 20 02:29:01 2008
@@ -0,0 +1,2 @@
+# repoze package
+__import__('pkg_resources').declare_namespace(__name__)

Added: repoze.accelerator/trunk/repoze/accelerator/__init__.py
==============================================================================
--- (empty file)
+++ repoze.accelerator/trunk/repoze/accelerator/__init__.py	Fri Jun 20 02:29:01 2008
@@ -0,0 +1 @@
+# a package

Added: repoze.accelerator/trunk/repoze/accelerator/middleware.py
==============================================================================
--- (empty file)
+++ repoze.accelerator/trunk/repoze/accelerator/middleware.py	Fri Jun 20 02:29:01 2008
@@ -0,0 +1,124 @@
+import itertools
+import threading
+
+from paste.request import construct_url
+from paste.request import parse_headers
+from paste.response import header_value
+
+class Accelerator:
+    def __init__(self, app, policy):
+        self.app = app
+        self.policy = policy
+
+    def __call__(self, environ, start_response):
+        result = self.policy.fetch(environ)
+
+        if result is not None:
+            status, headers, content = result
+            start_response(status, headers)
+            for chunk in content:
+                yield chunk
+            raise StopIteration
+
+        catch_response = []
+        written = []
+
+        def replace_start_response(status, headers, exc_info=None):
+            catch_response[:] = [status, headers, exc_info]
+            return written.append
+
+        app_iter = self.app(environ, replace_start_response)
+
+        if catch_response:
+            start_response(*catch_response)
+            status, headers, exc_info = catch_response
+        else:
+            raise RuntimeError('start_response not called')
+
+        handler = self.policy.store(status, headers, environ)
+
+        chunks = itertools.chain(written, app_iter)
+
+        for chunk in chunks:
+            yield chunk
+            if handler is not None:
+                handler.write(chunk)
+
+        if handler is not None:
+            handler.close()
+
+        raise StopIteration
+
+class NullPolicy:
+    def fetch(self, environ):
+        return None
+    def store(self, status, headers, environ):
+        pass
+
+class NaivePolicy:
+    def __init__(self, storage):
+        self.storage = storage
+
+    def _minimalCacheOK(self, headers, environ):
+        if environ.get('REQUEST_METHOD', 'GET') != 'GET':
+            return False
+        for nocache in ('Pragma', 'Cache-Control'):
+            value = header_value(headers, nocache)
+            if value and 'no-cache' in value.lower():
+                return
+        return True
+
+    def store(self, status, headers, environ):
+        if not self._minimalCacheOK(headers, environ):
+            return
+
+        if not status.startswith('200') or status.startswith('203'):
+            return
+
+        outheaders = []
+        for key, val in headers:
+            if key.lower() not in ('status', 'content-encoding',
+                                   'transfer-encoding'):
+                outheaders.append((key, val))
+
+        url = construct_url(environ)
+
+        return self.storage.store(url, status, outheaders)
+    
+    def fetch(self, environ):
+        headers = parse_headers(environ)
+
+        if not self._minimalCacheOK(headers, environ):
+            return
+
+        url = construct_url(environ)
+
+        return self.storage.fetch(url)
+
+class RAMStorage:
+    def __init__(self, lock=threading.Lock()):
+        self.data = {}
+        self.lock = lock
+
+    def store(self, url, status, headers):
+        result = []
+        storage = self
+
+        class SimpleHandler:
+            def write(self, chunk):
+                result.append(chunk)
+
+            def close(self):
+                storage.lock.acquire()
+                try:
+                    storage.data[url] = (status, headers, result)
+                finally:
+                    storage.lock.release()
+
+        return SimpleHandler()
+                
+    def fetch(self, url):
+        return self.data.get(url)
+
+def main():
+    raise NotImplementedError

Added: repoze.accelerator/trunk/repoze/accelerator/tests.py
==============================================================================
--- (empty file)
+++ repoze.accelerator/trunk/repoze/accelerator/tests.py	Fri Jun 20 02:29:01 2008
@@ -0,0 +1,305 @@
+import unittest
+
+class TestRAMStorage(unittest.TestCase):
+    def _getTargetClass(self):
+        from repoze.accelerator.middleware import RAMStorage
+        return RAMStorage
+
+    def _makeOne(self, lock):
+        klass = self._getTargetClass()
+        return klass(lock)
+        
+    def test_store_nonexistent(self):
+        lock = DummyLock()
+        storage = self._makeOne(lock)
+        headers = [('Header1', 'value1')]
+        handler = storage.store('url', 'status', headers)
+        self.failIf(handler is None)
+        chunks = ['chunk1', 'chunk2']
+        for chunk in ('chunk1', 'chunk2'):
+            handler.write(chunk)
+        handler.close()
+        self.assertEqual(storage.data['url'], ('status', headers, chunks))
+        self.assertEqual(lock.acquired, 1)
+        self.assertEqual(lock.released, 1)
+
+    def test_store_existing(self):
+        lock = DummyLock()
+        storage = self._makeOne(lock)
+        storage.data['url'] = ('otherstatus', (), ())
+        headers = [('Header1', 'value1')]
+        handler = storage.store('url', 'status', headers)
+        self.failIf(handler is None)
+        chunks = ['chunk1', 'chunk2']
+        for chunk in ('chunk1', 'chunk2'):
+            handler.write(chunk)
+        handler.close()
+        self.assertEqual(storage.data['url'], ('status', headers, chunks))
+        self.assertEqual(lock.acquired, 1)
+        self.assertEqual(lock.released, 1)
+
+    def test_fetch_nonexistent(self):
+        lock = DummyLock()
+        storage = self._makeOne(lock)
+        self.assertEqual(storage.fetch('url'), None)
+        
+    def test_fetch_existing(self):
+        lock = DummyLock()
+        storage = self._makeOne(lock)
+        storage.data['url'] = 1
+        self.assertEqual(storage.fetch('url'), 1)
+
+class TestNaivePolicy(unittest.TestCase):
+    def _getTargetClass(self):
+        from repoze.accelerator.middleware import NaivePolicy
+        return NaivePolicy
+
+    def _makeOne(self, storage):
+        klass = self._getTargetClass()
+        return klass(storage)
+
+    def _makeEnviron(self):
+        return {
+            'wsgi.url_scheme':'http',
+            'SERVER_NAME':'example.com',
+            'SERVER_PORT':'80',
+            'REQUEST_METHOD': 'GET',
+            }
+
+    def test_store_not_cacheable_post_request_method(self):
+        storage = DummyStorage()
+        policy = self._makeOne(storage)
+        environ = self._makeEnviron()
+        environ['REQUEST_METHOD'] = 'POST'
+        result = policy.store('200 OK', [], environ)
+        self.assertEqual(result, None)
+        
+    def test_store_not_cacheable_pragma_no_cache(self):
+        storage = DummyStorage()
+        policy = self._makeOne(storage)
+        environ = self._makeEnviron()
+        headers = [ ('pragma', 'no-cache') ]
+        result = policy.store('200 OK', headers, environ)
+        self.assertEqual(result, None)
+
+    def test_store_not_cacheable_cachecontrol_no_cache(self):
+        storage = DummyStorage()
+        policy = self._makeOne(storage)
+        environ = self._makeEnviron()
+        headers = [ ('cache-control', 'no-cache') ]
+        result = policy.store('200 OK', headers, environ)
+        self.assertEqual(result, None)
+
+    def test_store_not_cacheable_cachecontrol_no_cache(self):
+        storage = DummyStorage()
+        policy = self._makeOne(storage)
+        environ = self._makeEnviron()
+        headers = [ ('cache-control', 'no-cache') ]
+        result = policy.store('200 OK', headers, environ)
+        self.assertEqual(result, None)
+
+    def test_store_not_cacheable_non_2XX_response(self):
+        storage = DummyStorage()
+        policy = self._makeOne(storage)
+        environ = self._makeEnviron()
+        result = policy.store('500 Error', [], environ)
+        self.assertEqual(result, None)
+
+    def test_store_no_request_method_cacheable(self):
+        storage = DummyStorage()
+        policy = self._makeOne(storage)
+        environ = self._makeEnviron()
+        del environ['REQUEST_METHOD']
+        result = policy.store('200 OK', [('header1', 'value1')], environ)
+        self.assertEqual(result, False)
+        self.assertEqual(storage.url, 'http://example.com')
+        self.assertEqual(storage.status, '200 OK')
+        self.assertEqual(storage.outheaders, [('header1', 'value1')])
+
+    def test_store_get_request_method_cacheable(self):
+        storage = DummyStorage()
+        policy = self._makeOne(storage)
+        environ = self._makeEnviron()
+        result = policy.store('200 OK', [('header1', 'value1')], environ)
+        self.assertEqual(result, False)
+        self.assertEqual(storage.url, 'http://example.com')
+        self.assertEqual(storage.status, '200 OK')
+        self.assertEqual(storage.outheaders, [('header1', 'value1')])
+
+    def test_fetch_fails_post_request_method(self):
+        storage = DummyStorage(result=123)
+        policy = self._makeOne(storage)
+        environ = self._makeEnviron()
+        environ['REQUEST_METHOD'] = 'POST'
+        result = policy.fetch(environ)
+        self.failIfEqual(result, 123)
+        
+    def test_fetch_fails_pragma_no_cache(self):
+        storage = DummyStorage(result=123)
+        policy = self._makeOne(storage)
+        environ = self._makeEnviron()
+        environ['HTTP_PRAGMA'] = 'no-cache'
+        result = policy.fetch(environ)
+        self.failIfEqual(result, 123)
+
+    def test_fetch_fails_cachecontrol_no_cache(self):
+        storage = DummyStorage(result=123)
+        policy = self._makeOne(storage)
+        environ = self._makeEnviron()
+        environ['HTTP_PRAGMA'] = 'no-cache'
+        result = policy.fetch(environ)
+        self.failIfEqual(result, 123)
+
+    def test_fetch_succeeds_no_request_method(self):
+        storage = DummyStorage(result=123)
+        policy = self._makeOne(storage)
+        environ = self._makeEnviron()
+        del environ['REQUEST_METHOD']
+        result = policy.fetch(environ)
+        self.assertEqual(result, 123)
+
+    def test_fetch_succeeds_get_request_method(self):
+        storage = DummyStorage(result=123)
+        policy = self._makeOne(storage)
+        environ = self._makeEnviron()
+        result = policy.fetch(environ)
+        self.assertEqual(result, 123)
+
+class TestAcceleratorMiddleware(unittest.TestCase):
+    def _getTargetClass(self):
+        from repoze.accelerator.middleware import Accelerator
+        return Accelerator
+
+    def _makeOne(self, app, policy):
+        klass = self._getTargetClass()
+        return klass(app, policy)
+
+    def _makeEnviron(self):
+        return {}
+
+    def test_call_fetch_from_cache(self):
+        app = DummyApp()
+        policy = DummyPolicy(result=('200 OK', [], ['abc', 'def']))
+        environ = self._makeEnviron()
+        accelerator = self._makeOne(app, policy)
+        start_response = DummyStartResponse()
+        generator = accelerator(environ, start_response)
+        self.assertEqual(list(generator), ['abc', 'def'])
+        self.assertEqual(start_response.status, '200 OK')
+        self.assertEqual(start_response.headers, [])
+        self.assertEqual(start_response.exc_info, None)
+
+    def test_call_fetch_from_cache(self):
+        app = DummyApp()
+        policy = DummyPolicy(result=('200 OK', [], ['abc', 'def']))
+        environ = self._makeEnviron()
+        accelerator = self._makeOne(app, policy)
+        start_response = DummyStartResponse()
+        generator = accelerator(environ, start_response)
+        self.assertEqual(list(generator), ['abc', 'def'])
+        self.assertEqual(start_response.status, '200 OK')
+        self.assertEqual(start_response.headers, [])
+        self.assertEqual(start_response.exc_info, None)
+
+    def test_call_nofetch_start_response_not_called(self):
+        app = DummyApp()
+        app.call_start_response = False
+        policy = DummyPolicy(result=None)
+        environ = self._makeEnviron()
+        accelerator = self._makeOne(app, policy)
+        start_response = DummyStartResponse()
+        result = accelerator(environ, start_response)
+        self.assertRaises(RuntimeError, list, result)
+        
+    def test_call_cantstore(self):
+        app = DummyApp(headers=[('a', 'b')])
+        policy = DummyPolicy(result=None)
+        policy.handler = None
+        environ = self._makeEnviron()
+        accelerator = self._makeOne(app, policy)
+        start_response = DummyStartResponse()
+        result = list(accelerator(environ, start_response))
+        self.assertEqual(result, ['hello', 'world'])
+        self.assertEqual(start_response.status, '200 OK')
+        self.assertEqual(start_response.headers, [('a', 'b')])
+        self.assertEqual(start_response.exc_info, None)
+
+    def test_call_canstore(self):
+        app = DummyApp(headers=[('a', 'b')])
+        policy = DummyPolicy(result=None)
+        policy.handler = DummyHandler()
+        environ = self._makeEnviron()
+        accelerator = self._makeOne(app, policy)
+        start_response = DummyStartResponse()
+        result = list(accelerator(environ, start_response))
+        self.assertEqual(result, ['hello', 'world'])
+        self.assertEqual(start_response.status, '200 OK')
+        self.assertEqual(start_response.headers, [('a', 'b')])
+        self.assertEqual(start_response.exc_info, None)
+        self.assertEqual(policy.handler.chunks, ['hello', 'world'])
+        self.assertEqual(policy.handler.closed, True)
+                         
+
+class DummyHandler:
+    def __init__(self):
+        self.chunks = []
+        self.closed = False
+    def write(self, chunk):
+        self.chunks.append(chunk)
+    def close(self):
+        self.closed = True
+
+class DummyStartResponse:
+    def __call__(self, status, headers, exc_info=None):
+        self.status = status
+        self.headers = headers
+        self.exc_info = exc_info
+
+class DummyApp:
+    def __init__(self, status='200 OK', headers=()):
+        self.status = status
+        self.headers = headers
+        self.call_start_response = True
+        
+    def __call__(self, environ, start_response):
+        self.environ = environ
+        if self.call_start_response:
+            start_response(self.status, self.headers)
+        return ['hello', 'world']
+
+class DummyPolicy:
+    def __init__(self, result):
+        self.result = result
+        self.handler = None
+
+    def fetch(self, environ):
+        return self.result
+
+    def store(self, status, headers, environ):
+        return self.handler
+
+class DummyStorage:
+    def __init__(self, result=None, writer=False):
+        self.result = result
+        self.writer = writer
+        
+    def store(self, url, status, outheaders):
+        self.url = url
+        self.status = status
+        self.outheaders = outheaders
+        return self.writer
+
+    def fetch(self, url):
+        return self.result
+
+class DummyLock:
+    def __init__(self):
+        self.acquired = 0
+        self.released = 0
+
+    def acquire(self):
+        self.acquired += 1
+
+    def release(self):
+        self.released += 1
+        

Added: repoze.accelerator/trunk/setup.py
==============================================================================
--- (empty file)
+++ repoze.accelerator/trunk/setup.py	Fri Jun 20 02:29:01 2008
@@ -0,0 +1,58 @@
+##############################################################################
+#
+# Copyright (c) 2007 Agendaless Consulting and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the BSD-like license at
+# http://www.repoze.org/LICENSE.txt.  A copy of the license should accompany
+# this distribution.  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL
+# EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND
+# FITNESS FOR A PARTICULAR PURPOSE
+#
+##############################################################################
+
+__version__ = '0.1'
+
+import os
+
+from ez_setup import use_setuptools
+use_setuptools()
+
+from setuptools import setup, find_packages
+
+here = os.path.abspath(os.path.dirname(__file__))
+README = open(os.path.join(here, 'README.txt')).read()
+CHANGES = open(os.path.join(here, 'CHANGES.txt')).read()
+
+setup(name='repoze.accelerator',
+      version=__version__,
+      description='An HTTP caching accelerator in middleware',
+      long_description = README + '\n\n' + CHANGES,
+      classifiers=[
+        "Development Status :: 1 - Planning",
+        "Intended Audience :: Developers",
+        "Programming Language :: Python",
+        "Topic :: Internet :: WWW/HTTP",
+        "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+        "Topic :: Internet :: WWW/HTTP :: WSGI",
+        "Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware",
+        ],
+      keywords='web wsgi caching middleware accelerator',
+      author="Agendaless Consulting",
+      author_email="repoze-dev at lists.repoze.org",
+      url="http://www.repoze.org",
+      license="BSD-derived (http://www.repoze.org/LICENSE.txt)",
+      packages=find_packages(),
+      include_package_data=True,
+      namespace_packages=['repoze'],
+      zip_safe=False,
+      tests_require = ['Paste'],
+      install_requires=['Paste'],
+      test_suite="repoze.accelerator.tests",
+      entry_points = """\
+        [paste.filter_app_factory]
+        accelerator = repoze.accelerator.middleware:main
+      """
+      )
+


More information about the Repoze-checkins mailing list