Package cherrypy :: Package test :: Module modfcgid
[hide private]
[frames] | no frames]

Source Code for Module cherrypy.test.modfcgid

  1  """Wrapper for mod_fcgid, for use as a CherryPy HTTP server when testing. 
  2   
  3  To autostart fcgid, the "apache" executable or script must be 
  4  on your system path, or you must override the global APACHE_PATH. 
  5  On some platforms, "apache" may be called "apachectl", "apache2ctl", 
  6  or "httpd"--create a symlink to them if needed. 
  7   
  8  You'll also need the WSGIServer from flup.servers. 
  9  See http://projects.amor.org/misc/wiki/ModPythonGateway 
 10   
 11   
 12  KNOWN BUGS 
 13  ========== 
 14   
 15  1. Apache processes Range headers automatically; CherryPy's truncated 
 16      output is then truncated again by Apache. See test_core.testRanges. 
 17      This was worked around in http://www.cherrypy.org/changeset/1319. 
 18  2. Apache does not allow custom HTTP methods like CONNECT as per the spec. 
 19      See test_core.testHTTPMethods. 
 20  3. Max request header and body settings do not work with Apache. 
 21  4. Apache replaces status "reason phrases" automatically. For example, 
 22      CherryPy may set "304 Not modified" but Apache will write out 
 23      "304 Not Modified" (capital "M"). 
 24  5. Apache does not allow custom error codes as per the spec. 
 25  6. Apache (or perhaps modpython, or modpython_gateway) unquotes %xx in the 
 26      Request-URI too early. 
 27  7. mod_python will not read request bodies which use the "chunked" 
 28      transfer-coding (it passes REQUEST_CHUNKED_ERROR to ap_setup_client_block 
 29      instead of REQUEST_CHUNKED_DECHUNK, see Apache2's http_protocol.c and 
 30      mod_python's requestobject.c). 
 31  8. Apache will output a "Content-Length: 0" response header even if there's 
 32      no response entity body. This isn't really a bug; it just differs from 
 33      the CherryPy default. 
 34  """ 
 35   
 36  import os 
 37  curdir = os.path.join(os.getcwd(), os.path.dirname(__file__)) 
 38  import re 
 39  import sys 
 40  import time 
 41   
 42  import cherrypy 
 43  from cherrypy._cpcompat import ntob 
 44  from cherrypy.process import plugins, servers 
 45  from cherrypy.test import helper 
 46   
 47   
48 -def read_process(cmd, args=""):
49 pipein, pipeout = os.popen4("%s %s" % (cmd, args)) 50 try: 51 firstline = pipeout.readline() 52 if (re.search(r"(not recognized|No such file|not found)", firstline, 53 re.IGNORECASE)): 54 raise IOError('%s must be on your system path.' % cmd) 55 output = firstline + pipeout.read() 56 finally: 57 pipeout.close() 58 return output
59 60 61 APACHE_PATH = "httpd" 62 CONF_PATH = "fcgi.conf" 63 64 conf_fcgid = """ 65 # Apache2 server conf file for testing CherryPy with mod_fcgid. 66 67 DocumentRoot "%(root)s" 68 ServerName 127.0.0.1 69 Listen %(port)s 70 LoadModule fastcgi_module modules/mod_fastcgi.dll 71 LoadModule rewrite_module modules/mod_rewrite.so 72 73 Options ExecCGI 74 SetHandler fastcgi-script 75 RewriteEngine On 76 RewriteRule ^(.*)$ /fastcgi.pyc [L] 77 FastCgiExternalServer "%(server)s" -host 127.0.0.1:4000 78 """ 79 80
81 -class ModFCGISupervisor(helper.LocalSupervisor):
82 83 using_apache = True 84 using_wsgi = True 85 template = conf_fcgid 86
87 - def __str__(self):
88 return "FCGI Server on %s:%s" % (self.host, self.port)
89
90 - def start(self, modulename):
91 cherrypy.server.httpserver = servers.FlupFCGIServer( 92 application=cherrypy.tree, bindAddress=('127.0.0.1', 4000)) 93 cherrypy.server.httpserver.bind_addr = ('127.0.0.1', 4000) 94 # For FCGI, we both start apache... 95 self.start_apache() 96 # ...and our local server 97 helper.LocalServer.start(self, modulename)
98
99 - def start_apache(self):
100 fcgiconf = CONF_PATH 101 if not os.path.isabs(fcgiconf): 102 fcgiconf = os.path.join(curdir, fcgiconf) 103 104 # Write the Apache conf file. 105 f = open(fcgiconf, 'wb') 106 try: 107 server = repr(os.path.join(curdir, 'fastcgi.pyc'))[1:-1] 108 output = self.template % {'port': self.port, 'root': curdir, 109 'server': server} 110 output = ntob(output.replace('\r\n', '\n')) 111 f.write(output) 112 finally: 113 f.close() 114 115 result = read_process(APACHE_PATH, "-k start -f %s" % fcgiconf) 116 if result: 117 print(result)
118
119 - def stop(self):
120 """Gracefully shutdown a server that is serving forever.""" 121 read_process(APACHE_PATH, "-k stop") 122 helper.LocalServer.stop(self)
123
124 - def sync_apps(self):
125 cherrypy.server.httpserver.fcgiserver.application = self.get_app()
126