[Checkins] SVN: zope.pytest/ Initial import.
Martijn Faassen
faassen at startifact.com
Mon Jan 3 15:53:17 EST 2011
Log message for revision 119330:
Initial import.
Changed:
A zope.pytest/
A zope.pytest/trunk/
A zope.pytest/trunk/CHANGES.txt
A zope.pytest/trunk/CREDITS.txt
A zope.pytest/trunk/MANIFEST.in
A zope.pytest/trunk/README.txt
A zope.pytest/trunk/TODO.txt
A zope.pytest/trunk/bootstrap.py
A zope.pytest/trunk/buildout.cfg
A zope.pytest/trunk/setup.cfg
A zope.pytest/trunk/setup.py
A zope.pytest/trunk/src/
A zope.pytest/trunk/src/zope/
A zope.pytest/trunk/src/zope/__init__.py
A zope.pytest/trunk/src/zope/pytest/
A zope.pytest/trunk/src/zope/pytest/__init__.py
A zope.pytest/trunk/src/zope/pytest/interact.py
A zope.pytest/trunk/src/zope/pytest/setup.py
A zope.pytest/trunk/src/zope/pytest/test_zopepytest.py
-=-
Added: zope.pytest/trunk/CHANGES.txt
===================================================================
--- zope.pytest/trunk/CHANGES.txt (rev 0)
+++ zope.pytest/trunk/CHANGES.txt 2011-01-03 20:53:16 UTC (rev 119330)
@@ -0,0 +1,2 @@
+CHANGES
+*******
Added: zope.pytest/trunk/CREDITS.txt
===================================================================
--- zope.pytest/trunk/CREDITS.txt (rev 0)
+++ zope.pytest/trunk/CREDITS.txt 2011-01-03 20:53:16 UTC (rev 119330)
@@ -0,0 +1,6 @@
+CREDITS
+*******
+
+* Martijn Faassen (basic pytest integration)
+
+* Izhar Firdaus (separated into package)
Added: zope.pytest/trunk/MANIFEST.in
===================================================================
--- zope.pytest/trunk/MANIFEST.in (rev 0)
+++ zope.pytest/trunk/MANIFEST.in 2011-01-03 20:53:16 UTC (rev 119330)
@@ -0,0 +1 @@
+recursive-include src/zope/pytest/ *
Added: zope.pytest/trunk/README.txt
===================================================================
--- zope.pytest/trunk/README.txt (rev 0)
+++ zope.pytest/trunk/README.txt 2011-01-03 20:53:16 UTC (rev 119330)
@@ -0,0 +1,44 @@
+zope.pytest
+****************************
+
+Introduction
+============
+
+This package contains a set of helper functions to test zope/grok using pytest
+
+Core functions
+==============
+
+zope.pytest.setup.create_app
+
+ * this function creates a wsgi app object which utilize a temporary db.
+
+zope.pytest.setup.configure
+
+ * this function parses zcml file and initialize the component registry
+
+zope.pytest.setup.argument
+
+ * this is a function decorator which register a function as an argument for
+ pytest functions
+
+
+Simple example::
+
+ from zope.pytest import create_app, configure, argument
+ from my.project import Root
+
+ @argument
+ def app(request):
+ return create_app(request, Root())
+
+ @argument
+ def config(request):
+ return configure(request, my.project, 'ftesting.zcml')
+
+ def test_hello(app, config):
+ pass
+
+
+Interact
+=========
Added: zope.pytest/trunk/TODO.txt
===================================================================
--- zope.pytest/trunk/TODO.txt (rev 0)
+++ zope.pytest/trunk/TODO.txt 2011-01-03 20:53:16 UTC (rev 119330)
@@ -0,0 +1,12 @@
+TODO
+====
+
+* the interact stuff could be removed entirely; it's useful for
+ JSON testing but not particularly relevant to pytest integration.
+
+* the @argument decorator should be removed again. This is a layer
+ on top of pytest that we should discuss within the pytest project,
+ and not do as an innovation in zope-land. Instead use
+ ``pyargs_funcarg__foo``, which is the standard pytest way to do it.
+
+* it needs tests
Added: zope.pytest/trunk/bootstrap.py
===================================================================
--- zope.pytest/trunk/bootstrap.py (rev 0)
+++ zope.pytest/trunk/bootstrap.py 2011-01-03 20:53:16 UTC (rev 119330)
@@ -0,0 +1,260 @@
+##############################################################################
+#
+# Copyright (c) 2006 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL 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.
+#
+##############################################################################
+"""Bootstrap a buildout-based project
+
+Simply run this script in a directory containing a buildout.cfg.
+The script accepts buildout command-line options, so you can
+use the -c option to specify an alternate configuration file.
+"""
+
+import os, shutil, sys, tempfile, textwrap, urllib, urllib2, subprocess
+from optparse import OptionParser
+
+if sys.platform == 'win32':
+ def quote(c):
+ if ' ' in c:
+ return '"%s"' % c # work around spawn lamosity on windows
+ else:
+ return c
+else:
+ quote = str
+
+# See zc.buildout.easy_install._has_broken_dash_S for motivation and comments.
+stdout, stderr = subprocess.Popen(
+ [sys.executable, '-Sc',
+ 'try:\n'
+ ' import ConfigParser\n'
+ 'except ImportError:\n'
+ ' print 1\n'
+ 'else:\n'
+ ' print 0\n'],
+ stdout=subprocess.PIPE, stderr=subprocess.PIPE).communicate()
+has_broken_dash_S = bool(int(stdout.strip()))
+
+# In order to be more robust in the face of system Pythons, we want to
+# run without site-packages loaded. This is somewhat tricky, in
+# particular because Python 2.6's distutils imports site, so starting
+# with the -S flag is not sufficient. However, we'll start with that:
+if not has_broken_dash_S and 'site' in sys.modules:
+ # We will restart with python -S.
+ args = sys.argv[:]
+ args[0:0] = [sys.executable, '-S']
+ args = map(quote, args)
+ os.execv(sys.executable, args)
+# Now we are running with -S. We'll get the clean sys.path, import site
+# because distutils will do it later, and then reset the path and clean
+# out any namespace packages from site-packages that might have been
+# loaded by .pth files.
+clean_path = sys.path[:]
+import site
+sys.path[:] = clean_path
+for k, v in sys.modules.items():
+ if k in ('setuptools', 'pkg_resources') or (
+ hasattr(v, '__path__') and
+ len(v.__path__)==1 and
+ not os.path.exists(os.path.join(v.__path__[0],'__init__.py'))):
+ # This is a namespace package. Remove it.
+ sys.modules.pop(k)
+
+is_jython = sys.platform.startswith('java')
+
+setuptools_source = 'http://peak.telecommunity.com/dist/ez_setup.py'
+distribute_source = 'http://python-distribute.org/distribute_setup.py'
+
+# parsing arguments
+def normalize_to_url(option, opt_str, value, parser):
+ if value:
+ if '://' not in value: # It doesn't smell like a URL.
+ value = 'file://%s' % (
+ urllib.pathname2url(
+ os.path.abspath(os.path.expanduser(value))),)
+ if opt_str == '--download-base' and not value.endswith('/'):
+ # Download base needs a trailing slash to make the world happy.
+ value += '/'
+ else:
+ value = None
+ name = opt_str[2:].replace('-', '_')
+ setattr(parser.values, name, value)
+
+usage = '''\
+[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options]
+
+Bootstraps a buildout-based project.
+
+Simply run this script in a directory containing a buildout.cfg, using the
+Python that you want bin/buildout to use.
+
+Note that by using --setup-source and --download-base to point to
+local resources, you can keep this script from going over the network.
+'''
+
+parser = OptionParser(usage=usage)
+parser.add_option("-v", "--version", dest="version",
+ help="use a specific zc.buildout version")
+parser.add_option("-d", "--distribute",
+ action="store_true", dest="use_distribute", default=False,
+ help="Use Distribute rather than Setuptools.")
+parser.add_option("--setup-source", action="callback", dest="setup_source",
+ callback=normalize_to_url, nargs=1, type="string",
+ help=("Specify a URL or file location for the setup file. "
+ "If you use Setuptools, this will default to " +
+ setuptools_source + "; if you use Distribute, this "
+ "will default to " + distribute_source +"."))
+parser.add_option("--download-base", action="callback", dest="download_base",
+ callback=normalize_to_url, nargs=1, type="string",
+ help=("Specify a URL or directory for downloading "
+ "zc.buildout and either Setuptools or Distribute. "
+ "Defaults to PyPI."))
+parser.add_option("--eggs",
+ help=("Specify a directory for storing eggs. Defaults to "
+ "a temporary directory that is deleted when the "
+ "bootstrap script completes."))
+parser.add_option("-t", "--accept-buildout-test-releases",
+ dest='accept_buildout_test_releases',
+ action="store_true", default=False,
+ help=("Normally, if you do not specify a --version, the "
+ "bootstrap script and buildout gets the newest "
+ "*final* versions of zc.buildout and its recipes and "
+ "extensions for you. If you use this flag, "
+ "bootstrap and buildout will get the newest releases "
+ "even if they are alphas or betas."))
+parser.add_option("-c", None, action="store", dest="config_file",
+ help=("Specify the path to the buildout configuration "
+ "file to be used."))
+
+options, args = parser.parse_args()
+
+# if -c was provided, we push it back into args for buildout's main function
+if options.config_file is not None:
+ args += ['-c', options.config_file]
+
+if options.eggs:
+ eggs_dir = os.path.abspath(os.path.expanduser(options.eggs))
+else:
+ eggs_dir = tempfile.mkdtemp()
+
+if options.setup_source is None:
+ if options.use_distribute:
+ options.setup_source = distribute_source
+ else:
+ options.setup_source = setuptools_source
+
+if options.accept_buildout_test_releases:
+ args.append('buildout:accept-buildout-test-releases=true')
+args.append('bootstrap')
+
+try:
+ import pkg_resources
+ import setuptools # A flag. Sometimes pkg_resources is installed alone.
+ if not hasattr(pkg_resources, '_distribute'):
+ raise ImportError
+except ImportError:
+ ez_code = urllib2.urlopen(
+ options.setup_source).read().replace('\r\n', '\n')
+ ez = {}
+ exec ez_code in ez
+ setup_args = dict(to_dir=eggs_dir, download_delay=0)
+ if options.download_base:
+ setup_args['download_base'] = options.download_base
+ if options.use_distribute:
+ setup_args['no_fake'] = True
+ ez['use_setuptools'](**setup_args)
+ if 'pkg_resources' in sys.modules:
+ reload(sys.modules['pkg_resources'])
+ import pkg_resources
+ # This does not (always?) update the default working set. We will
+ # do it.
+ for path in sys.path:
+ if path not in pkg_resources.working_set.entries:
+ pkg_resources.working_set.add_entry(path)
+
+cmd = [quote(sys.executable),
+ '-c',
+ quote('from setuptools.command.easy_install import main; main()'),
+ '-mqNxd',
+ quote(eggs_dir)]
+
+if not has_broken_dash_S:
+ cmd.insert(1, '-S')
+
+find_links = options.download_base
+if not find_links:
+ find_links = os.environ.get('bootstrap-testing-find-links')
+if find_links:
+ cmd.extend(['-f', quote(find_links)])
+
+if options.use_distribute:
+ setup_requirement = 'distribute'
+else:
+ setup_requirement = 'setuptools'
+ws = pkg_resources.working_set
+setup_requirement_path = ws.find(
+ pkg_resources.Requirement.parse(setup_requirement)).location
+env = dict(
+ os.environ,
+ PYTHONPATH=setup_requirement_path)
+
+requirement = 'zc.buildout'
+version = options.version
+if version is None and not options.accept_buildout_test_releases:
+ # Figure out the most recent final version of zc.buildout.
+ import setuptools.package_index
+ _final_parts = '*final-', '*final'
+ def _final_version(parsed_version):
+ for part in parsed_version:
+ if (part[:1] == '*') and (part not in _final_parts):
+ return False
+ return True
+ index = setuptools.package_index.PackageIndex(
+ search_path=[setup_requirement_path])
+ if find_links:
+ index.add_find_links((find_links,))
+ req = pkg_resources.Requirement.parse(requirement)
+ if index.obtain(req) is not None:
+ best = []
+ bestv = None
+ for dist in index[req.project_name]:
+ distv = dist.parsed_version
+ if _final_version(distv):
+ if bestv is None or distv > bestv:
+ best = [dist]
+ bestv = distv
+ elif distv == bestv:
+ best.append(dist)
+ if best:
+ best.sort()
+ version = best[-1].version
+if version:
+ requirement = '=='.join((requirement, version))
+cmd.append(requirement)
+
+if is_jython:
+ import subprocess
+ exitcode = subprocess.Popen(cmd, env=env).wait()
+else: # Windows prefers this, apparently; otherwise we would prefer subprocess
+ exitcode = os.spawnle(*([os.P_WAIT, sys.executable] + cmd + [env]))
+if exitcode != 0:
+ sys.stdout.flush()
+ sys.stderr.flush()
+ print ("An error occurred when trying to install zc.buildout. "
+ "Look above this message for any errors that "
+ "were output by easy_install.")
+ sys.exit(exitcode)
+
+ws.add_entry(eggs_dir)
+ws.require(requirement)
+import zc.buildout.buildout
+zc.buildout.buildout.main(args)
+if not options.eggs: # clean up temporary egg directory
+ shutil.rmtree(eggs_dir)
Added: zope.pytest/trunk/buildout.cfg
===================================================================
--- zope.pytest/trunk/buildout.cfg (rev 0)
+++ zope.pytest/trunk/buildout.cfg 2011-01-03 20:53:16 UTC (rev 119330)
@@ -0,0 +1,13 @@
+[buildout]
+develop = .
+parts = scripts
+versions = versions
+
+[versions]
+
+[scripts]
+recipe = zc.recipe.egg
+eggs =
+ zope.pytest
+ zest.releaser
+ pytest
Added: zope.pytest/trunk/setup.cfg
===================================================================
--- zope.pytest/trunk/setup.cfg (rev 0)
+++ zope.pytest/trunk/setup.cfg 2011-01-03 20:53:16 UTC (rev 119330)
@@ -0,0 +1,4 @@
+[egg_info]
+tag_build =
+tag_date = 0
+tag_svn_revision = 0
Added: zope.pytest/trunk/setup.py
===================================================================
--- zope.pytest/trunk/setup.py (rev 0)
+++ zope.pytest/trunk/setup.py 2011-01-03 20:53:16 UTC (rev 119330)
@@ -0,0 +1,53 @@
+from setuptools import setup, find_packages
+import sys,os
+
+version = '1.0'
+
+def read(*rnames):
+ return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
+
+long_description = (
+ read(os.path.join('docs', 'README.txt'))
+ + '\n' +
+ read(os.path.join('docs', 'CHANGES.txt'))
+ + '\n' +
+ 'Download\n'
+ '********\n'
+ )
+
+setup(name='zope.pytest',
+ version=version,
+ description="zope pytest integration",
+ long_description=long_description,
+ # Get more strings from http://www.python.org/pypi?%3Aaction=list_classifiers
+ classifiers=[
+ "Programming Language :: Python",
+ "Topic :: Software Development :: Libraries :: Python Modules",
+ ],
+ keywords='',
+ author='',
+ author_email='',
+ url='',
+ license='BSD',
+ packages=find_packages('src',exclude=['ez_setup']),
+ namespace_packages=['zope'],
+ package_dir={'': 'src'},
+ include_package_data=True,
+ zip_safe=False,
+ install_requires=[
+ 'setuptools',
+ 'zope.configuration',
+ 'zope.component',
+ 'zope.testing',
+ 'zope.event',
+ 'zope.processlifetime',
+ 'zope.app.publication',
+ 'zope.app.wsgi',
+ 'ZODB3',
+ 'WebOb',
+ 'simplejson'
+ # -*- Extra requirements: -*-
+ ],
+ entry_points={
+ }
+ )
Added: zope.pytest/trunk/src/zope/__init__.py
===================================================================
--- zope.pytest/trunk/src/zope/__init__.py (rev 0)
+++ zope.pytest/trunk/src/zope/__init__.py 2011-01-03 20:53:16 UTC (rev 119330)
@@ -0,0 +1,6 @@
+# See http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages
+try:
+ __import__('pkg_resources').declare_namespace(__name__)
+except ImportError:
+ from pkgutil import extend_path
+ __path__ = extend_path(__path__, __name__)
Added: zope.pytest/trunk/src/zope/pytest/__init__.py
===================================================================
--- zope.pytest/trunk/src/zope/pytest/__init__.py (rev 0)
+++ zope.pytest/trunk/src/zope/pytest/__init__.py 2011-01-03 20:53:16 UTC (rev 119330)
@@ -0,0 +1,2 @@
+from zope.pytest.interact import get_interact_for_url, auth, get_json, post_json
+from zope.pytest.setup import *
Added: zope.pytest/trunk/src/zope/pytest/interact.py
===================================================================
--- zope.pytest/trunk/src/zope/pytest/interact.py (rev 0)
+++ zope.pytest/trunk/src/zope/pytest/interact.py 2011-01-03 20:53:16 UTC (rev 119330)
@@ -0,0 +1,82 @@
+import webob
+import simplejson
+import base64
+from pprint import pformat
+import urllib
+
+def auth(username, password):
+ auth = base64.encodestring('%s:%s' % (username, password))
+ return 'Basic %s' % auth[:-1]
+
+def get_interact_for_url(app, url):
+ json = get_json(app, url)
+ return Interact(app, json)
+
+def get_json(app, url, username='mgr', passwd='mgrpw'):
+ request = webob.Request.blank(url)
+ request.headers['Content-Type'] = 'application/json'
+ if username is not None:
+ request.environ['HTTP_AUTHORIZATION'] = auth(username, passwd)
+ response = request.get_response(app)
+ return simplejson.loads(response.body)
+
+def post_json(app, url, json, username='mgr', passwd='mgrpw'):
+ request = webob.Request.blank(url)
+ request.method = 'POST'
+ request.headers['Content-Type'] = 'application/json'
+ if username is not None:
+ request.environ['HTTP_AUTHORIZATION'] = auth(username, passwd)
+ request.body = simplejson.dumps(json)
+ response = request.get_response(app)
+ return simplejson.loads(response.body)
+
+def normal_post(app, url, data, username, passwd):
+ request = webob.Request.blank(url)
+ request.method = 'POST'
+ if username is not None:
+ request.environ['HTTP_AUTHORIZATION'] = auth(username, passwd)
+ request.body = urllib.urlencode(data)
+ response = request.get_response(app)
+ return simplejson.loads(response.body)
+
+
+class Interact(object):
+ def __init__(self, app, json):
+ self.app = app
+ self.json = json
+
+ def __repr__(self):
+ return pformat(self.json)
+
+ def get_one(self, key, **kw):
+ if isinstance(self.json, list):
+ value = self.json[int(key)]
+ else:
+ value = self.json[key]
+ if isinstance(value, basestring):
+ if value.startswith('http://'):
+ return self.get_url(value, **kw)
+ return Interact(self.app, value)
+
+ def get_url(self, url, **kw):
+ if kw:
+ url = url + '?' + urllib.urlencode(kw)
+ return Interact(self.app, get_json(self.app, url))
+
+ def get(self, key, **kw):
+ steps = key.split('.')
+ assert len(steps) >= 1
+ interact = self
+ for step in steps[:-1]:
+ interact = interact.get_one(step)
+ interact = interact.get_one(steps[-1], **kw)
+ return interact
+
+ def post_url(self, url, json, username='mgr', passwd='mgrpw'):
+ return Interact(self.app, post_json(
+ self.app, url, json, username, passwd))
+
+ def normal_post_url(self, url, data, username='mgr', passwd='mgrpw'):
+ return Interact(self.app, normal_post(
+ self.app, url, data, username, passwd))
+
Added: zope.pytest/trunk/src/zope/pytest/setup.py
===================================================================
--- zope.pytest/trunk/src/zope/pytest/setup.py (rev 0)
+++ zope.pytest/trunk/src/zope/pytest/setup.py 2011-01-03 20:53:16 UTC (rev 119330)
@@ -0,0 +1,120 @@
+import os
+from zope.configuration import xmlconfig, config
+from zope.component.hooks import setHooks
+from zope.testing.cleanup import cleanUp
+from zope import component
+from zope.event import notify
+from zope.app.publication.zopepublication import ZopePublication
+from zope.app.publication.httpfactory import HTTPPublicationRequestFactory
+
+import zope.processlifetime
+
+from zope.app import wsgi
+
+from ZODB.DB import DB
+from ZODB.DemoStorage import DemoStorage
+import ZODB.interfaces
+
+import transaction
+import sys
+
+def argument(func):
+ def function(*args, **kwargs):
+ return func(*args, **kwargs)
+
+ name = 'pytest_funcarg__' + func.func_name
+ function.func_name = name
+
+ if func.__module__ is None:
+ __builtins__[name] = function
+ return function
+ else:
+ __import__(func.__module__)
+ mod = sys.modules[func.__module__]
+ setattr(mod, name, function)
+ return getattr(mod, name)
+
+
+def create_app(request, site_root):
+ db = setup_db()
+ connection = setup_connection(db)
+ root = setup_root(connection)
+ root['test'] = site_root
+
+ wsgi_app = wsgi.WSGIPublisherApplication(
+ db,
+ HTTPPublicationRequestFactory,
+ True)
+
+ transaction.commit()
+
+ def finalize():
+ teardown_root(root)
+ teardown_connection(connection)
+ teardown_db(db)
+
+ request.addfinalizer(finalize)
+
+ # turn this off to let the errors be handled by the server
+ # this is useful for testing the server's error handling
+ wsgi_app.handleErrors = False
+
+ return wsgi_app
+
+def configure(request, module, zcml):
+ def setup_function():
+ return setup_config(module, zcml)
+
+ return request.cached_setup(setup=setup_function,
+ teardown=teardown_config,
+ scope='session')
+
+def setup_config(package, zcml_file):
+ zcml_file = os.path.join(os.path.dirname(package.__file__),
+ zcml_file)
+
+ setHooks()
+ context = config.ConfigurationMachine()
+ xmlconfig.registerCommonDirectives(context)
+
+ return xmlconfig.file(zcml_file,
+ package=package,
+ context=context, execute=True)
+
+def teardown_config(config):
+ cleanUp()
+
+def setup_db():
+ name = 'main'
+ storage = DemoStorage(name)
+ db = DB(storage, database_name=name)
+ db.setActivityMonitor(ZODB.ActivityMonitor.ActivityMonitor())
+
+ # DB are registered as utilities
+ component.provideUtility(db, ZODB.interfaces.IDatabase, name)
+
+ # And we send a event that our DB is available
+ notify(zope.processlifetime.DatabaseOpened(db))
+
+ return db
+
+def teardown_db(db):
+ # Need to unregister DB
+ base = component.getGlobalSiteManager()
+ base.unregisterUtility(
+ db, ZODB.interfaces.IDatabase, 'main')
+ db.close()
+
+def setup_connection(db):
+ return db.open()
+
+def teardown_connection(connection):
+ transaction.abort()
+ connection.close()
+
+def setup_root(connection):
+ return connection.root()[ZopePublication.root_name]
+
+def teardown_root(root):
+ pass
+
Added: zope.pytest/trunk/src/zope/pytest/test_zopepytest.py
===================================================================
--- zope.pytest/trunk/src/zope/pytest/test_zopepytest.py (rev 0)
+++ zope.pytest/trunk/src/zope/pytest/test_zopepytest.py 2011-01-03 20:53:16 UTC (rev 119330)
@@ -0,0 +1,13 @@
+from zope.pytest import argument
+
+# test the argument decorator
+
+def test_argument_decorator():
+
+ @argument
+ def myarg():
+ return {'message': 'helloworld'}
+
+ assert pytest_funcarg__myarg()['message'] == 'helloworld'
+
+
More information about the checkins
mailing list