Ticket #78: cp2bugtest.py

"""
Copyright (c) 2004, CherryPy Team (team@cherrypy.org)
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, 
      this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice, 
      this list of conditions and the following disclaimer in the documentation 
      and/or other materials provided with the distribution.
    * Neither the name of the CherryPy Team nor the names of its contributors 
      may be used to endorse or promote products derived from this software 
      without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
ANY EXPRESS 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 OWNER OR CONTRIBUTORS 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.

-------------------------------------------------------------------------------

Helper script for debugging CherryPy ticket #107 and #78

Todos:
 * get documentation in here
 * if possible, have the tests be evaluated automagically
 * do something with the output on the console, as this can be
   handles quite easily. 
 * insert a full blown list of examples, and prefereble, insert
   them all by hand, and make each url a: "should crash, should
   move to another location, should run" kinda thing. (this also
   allows for easily automating the test)
 * once done, it's an extensive and comprehensive list of all
   mappings CherryPy can do. 

"""
__version__ = "0.1-20050414"
__authors__ = ["Remco Boema"]
__license__ = "The BSD License, see http://www.opensource.org/licenses/bsd-license.php"


try:
    # used by Remco 
    import fixpath
except:
    pass 
from cherrypy import cpg
import sys

def concat(*p):
    return " ".join([str(x) for x in p])
_ = concat
        

class ObjWithParamIndex(object):
    def __init__(self):
        self.exposed = True
        self.testurls = ['','/','/index','/index?param=value','/param/value','/?invalidname=value','to/many/params']
    def __call__(self):
        pass

    def index(self,param):
        print 'parameterized index:( param:',`param`,')'
        return _('parameterized index:( param:',`param`,')')
    index.exposed = True

class ObjWithPlainIndex(object):
    def __init__(self):
        self.exposed = True
        self.testurls = ['','/','/index','/index?param=value','/param/value','/?invalidname=value','to/many/params']
    def __call__(self):
        pass

    def index(self,param):
        print 'plain index:( )'
        return 'plain index:( )'
    index.exposed = True

class Root(object):
    def _cpOnError(self):
        try:
            raise
        except Exception, e:
            print >>sys.stderr, 'Raised: ',str(e)
            raise
        
    def __init__(self):
        self.objWithParamIndex = ObjWithParamIndex()
        self.objWithPlainIndex = ObjWithPlainIndex()
        self.recursive = self

    def paramless(self):
        print 'paramless( )'
        return _('paramless( )')
    paramless.exposed = True

    def test1(self,str):
        print 'test1( str:',`str`,')'
        return _('test1( str:',`str`,')')
    test1.exposed = True
    test1.testurls = ['/a','?str=somestring']

    def test2(self,*p):
        print 'test2( *p:',`p`,')'
        return _('test2( *p:',`p`,')')
    test2.exposed = True

    def test3(self,x='valuex'):
        print 'test3( x=valuex:',`x`,')'
        return _('test3( x=valuex:',`x`,')')
    test3.exposed = True
    test3.testurls = ['/x','?x=value','/x/y','/x/y?bla=pir']

    def test4(self,**kwp):
        print 'test4( **kwp:',`kwp`,')'
        return _('test4( **kwp:',`kwp`,')')
    test4.exposed = True

    def test5(self,*p,**kwp):
        print 'test5( *p:',`p`,', **kwp:',`kwp`,')'
        return _('test5( *p:',`p`,', **kwp:',`kwp`,')')
    test5.exposed = True

    def default(self,*p,**kwp):
        print 'ROOT.DEFAULT( *p:',`p`,', **kwp:',`kwp`,')'
        return _('ROOT.DEFAULT( *p:',`p`,', **kwp:',`kwp`,')')
    default.exposed = True


    def TEST(self):
        header = """
        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
        <html xmlns="Testinghttp://www.w3.org/1999/xhtml"><head><title>Testing</title><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /></head>
        <body>"""
        iframe = """<br>Iframe: for %s:<br><iframe src="%s" width="500" height="200">no iframes?</iframe>"""
        footer = """        
        </body>
        </html>
        """
        defaultTests = ['','/','/someparam','?some=param','/?some=other','/some?other=param']
        urls = []
        def addUrls(obj,root):
            "Don't you just _love_ introspection? :)"
            for name,value in [(x,getattr(obj,x)) for x in dir(obj) if callable(getattr(obj,x))]:
                if not hasattr(value,'exposed'): continue
                if name== 'TEST': continue
                testUrls = getattr(value,'testurls',[])
                testUrls.extend(defaultTests)
                for testurl in testUrls:
                    urls.append('%s%s%s' % (root,name,testurl))
        addUrls(self,'/')
        #addUrls(self.recursive,'/recursive/')
        return header+"".join([iframe % (url,url) for url in urls]) + footer
    TEST.exposed = True

cpg.root = Root()

if __name__=='__main__':
    try:
        import os.path, sys
        cpg.server.start(configMap = {'socketPort': 80,
                                      'threadPool':1,
                                      'socketQueueSize':1,
                                      'sessionStorageType':'ram'
                                      }
                         )
    except Exception,e:
        try:
            import os.path, sys
            cpg.server.start(configDict = {'socketPort': 80,
                                          'threadPool':1,
                                          'socketQueueSize':1,
                                          'sessionStorageType':'ram'
                                          }
                             )
        except Exception, e:
            print 'Error: ',str(e)
            raw_input('hit enter')