monitor/cherrypy/test/test_misc_tools.py

   1 import os
   2 localDir = os.path.dirname(__file__)
   3 logfile = os.path.join(localDir, "test_misc_tools.log")
   4
   5 import cherrypy
   6 from cherrypy import tools
   7
   8
   9 def setup_server():
  10     class Root:
  11         def index(self):
  12             yield "Hello, world"
  13         index.exposed = True
  14         h = [("Content-Language", "en-GB"), ('Content-Type', 'text/plain')]
  15         tools.response_headers(headers=h)(index)
  16
  17         def other(self):
  18             return "salut"
  19         other.exposed = True
  20         other._cp_config = {
  21             'tools.response_headers.on': True,
  22             'tools.response_headers.headers': [("Content-Language", "fr"),
  23                                                ('Content-Type', 'text/plain')],
  24             'tools.log_hooks.on': True,
  25             }
  26
  27
  28     class Accept:
  29         _cp_config = {'tools.accept.on': True}
  30
  31         def index(self):
  32             return '<a href="feed">Atom feed</a>'
  33         index.exposed = True
  34
  35         # In Python 2.4+, we could use a decorator instead:
  36         # @tools.accept('application/atom+xml')
  37         def feed(self):
  38             return """<?xml version="1.0" encoding="utf-8"?>
  39 <feed xmlns="http://www.w3.org/2005/Atom">
  40     <title>Unknown Blog</title>
  41 </feed>"""
  42         feed.exposed = True
  43         feed._cp_config = {'tools.accept.media': 'application/atom+xml'}
  44
  45         def select(self):
  46             # We could also write this: mtype = cherrypy.lib.accept.accept(...)
  47             mtype = tools.accept.callable(['text/html', 'text/plain'])
  48             if mtype == 'text/html':
  49                 return "<h2>Page Title</h2>"
  50             else:
  51                 return "PAGE TITLE"
  52         select.exposed = True
  53
  54     class Referer:
  55         def accept(self):
  56             return "Accepted!"
  57         accept.exposed = True
  58         reject = accept
  59
  60     class AutoVary:
  61         def index(self):
  62             # Read a header directly with 'get'
  63             ae = cherrypy.request.headers.get('Accept-Encoding')
  64             # Read a header directly with '__getitem__'
  65             cl = cherrypy.request.headers['Host']
  66             # Read a header directly with '__contains__'
  67             hasif = 'If-Modified-Since' in cherrypy.request.headers
  68             # Read a header directly with 'has_key'
  69             has = cherrypy.request.headers.has_key('Range')
  70             # Call a lib function
  71             mtype = tools.accept.callable(['text/html', 'text/plain'])
  72             return "Hello, world!"
  73         index.exposed = True
  74
  75     conf = {'/referer': {'tools.referer.on': True,
  76                          'tools.referer.pattern': r'http://[^/]*example\.com',
  77                          },
  78             '/referer/reject': {'tools.referer.accept': False,
  79                                 'tools.referer.accept_missing': True,
  80                                 },
  81             '/autovary': {'tools.autovary.on': True},
  82             }
  83
  84     root = Root()
  85     root.referer = Referer()
  86     root.accept = Accept()
  87     root.autovary = AutoVary()
  88     cherrypy.tree.mount(root, config=conf)
  89     cherrypy.config.update({'log.error_file': logfile})
  90
  91
  92 from cherrypy.test import helper
  93
  94 class ResponseHeadersTest(helper.CPWebCase):
  95     setup_server = staticmethod(setup_server)
  96
  97     def testResponseHeadersDecorator(self):
  98         self.getPage('/')
  99         self.assertHeader("Content-Language", "en-GB")
 100         self.assertHeader('Content-Type', 'text/plain;charset=utf-8')
 101
 102     def testResponseHeaders(self):
 103         self.getPage('/other')
 104         self.assertHeader("Content-Language", "fr")
 105         self.assertHeader('Content-Type', 'text/plain;charset=utf-8')
 106
 107
 108 class RefererTest(helper.CPWebCase):
 109     setup_server = staticmethod(setup_server)
 110
 111     def testReferer(self):
 112         self.getPage('/referer/accept')
 113         self.assertErrorPage(403, 'Forbidden Referer header.')
 114
 115         self.getPage('/referer/accept',
 116                      headers=[('Referer', 'http://www.example.com/')])
 117         self.assertStatus(200)
 118         self.assertBody('Accepted!')
 119
 120         # Reject
 121         self.getPage('/referer/reject')
 122         self.assertStatus(200)
 123         self.assertBody('Accepted!')
 124
 125         self.getPage('/referer/reject',
 126                      headers=[('Referer', 'http://www.example.com/')])
 127         self.assertErrorPage(403, 'Forbidden Referer header.')
 128
 129
 130 class AcceptTest(helper.CPWebCase):
 131     setup_server = staticmethod(setup_server)
 132
 133     def test_Accept_Tool(self):
 134         # Test with no header provided
 135         self.getPage('/accept/feed')
 136         self.assertStatus(200)
 137         self.assertInBody('<title>Unknown Blog</title>')
 138
 139         # Specify exact media type
 140         self.getPage('/accept/feed', headers=[('Accept', 'application/atom+xml')])
 141         self.assertStatus(200)
 142         self.assertInBody('<title>Unknown Blog</title>')
 143
 144         # Specify matching media range
 145         self.getPage('/accept/feed', headers=[('Accept', 'application/*')])
 146         self.assertStatus(200)
 147         self.assertInBody('<title>Unknown Blog</title>')
 148
 149         # Specify all media ranges
 150         self.getPage('/accept/feed', headers=[('Accept', '*/*')])
 151         self.assertStatus(200)
 152         self.assertInBody('<title>Unknown Blog</title>')
 153
 154         # Specify unacceptable media types
 155         self.getPage('/accept/feed', headers=[('Accept', 'text/html')])
 156         self.assertErrorPage(406,
 157                              "Your client sent this Accept header: text/html. "
 158                              "But this resource only emits these media types: "
 159                              "application/atom+xml.")
 160
 161         # Test resource where tool is 'on' but media is None (not set).
 162         self.getPage('/accept/')
 163         self.assertStatus(200)
 164         self.assertBody('<a href="feed">Atom feed</a>')
 165
 166     def test_accept_selection(self):
 167         # Try both our expected media types
 168         self.getPage('/accept/select', [('Accept', 'text/html')])
 169         self.assertStatus(200)
 170         self.assertBody('<h2>Page Title</h2>')
 171         self.getPage('/accept/select', [('Accept', 'text/plain')])
 172         self.assertStatus(200)
 173         self.assertBody('PAGE TITLE')
 174         self.getPage('/accept/select', [('Accept', 'text/plain, text/*;q=0.5')])
 175         self.assertStatus(200)
 176         self.assertBody('PAGE TITLE')
 177
 178         # text/* and */* should prefer text/html since it comes first
 179         # in our 'media' argument to tools.accept
 180         self.getPage('/accept/select', [('Accept', 'text/*')])
 181         self.assertStatus(200)
 182         self.assertBody('<h2>Page Title</h2>')
 183         self.getPage('/accept/select', [('Accept', '*/*')])
 184         self.assertStatus(200)
 185         self.assertBody('<h2>Page Title</h2>')
 186
 187         # Try unacceptable media types
 188         self.getPage('/accept/select', [('Accept', 'application/xml')])
 189         self.assertErrorPage(406,
 190                              "Your client sent this Accept header: application/xml. "
 191                              "But this resource only emits these media types: "
 192                              "text/html, text/plain.")
 193
 194
 195 class AutoVaryTest(helper.CPWebCase):
 196     setup_server = staticmethod(setup_server)
 197
 198     def testAutoVary(self):
 199         self.getPage('/autovary/')
 200         self.assertHeader(
 201             "Vary", 'Accept, Accept-Charset, Accept-Encoding, Host, If-Modified-Since, Range')
 202