Skip to content
Snippets Groups Projects
Commit 3091008b authored by André Anjos's avatar André Anjos :speech_balloon:
Browse files

Add unit tests for the environment wrapper

parent 50cc242f
Branches master
No related tags found
No related merge requests found
##############################################################################
#
# 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
import shutil
import sys
import tempfile
from optparse import OptionParser
tmpeggs = tempfile.mkdtemp()
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 --find-links to point to local resources, you can keep
this script from going over the network.
'''
parser = OptionParser(usage=usage)
parser.add_option("-v", "--version", help="use a specific zc.buildout version")
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", "--config-file",
help=("Specify the path to the buildout configuration "
"file to be used."))
parser.add_option("-f", "--find-links",
help=("Specify a URL to search for buildout releases"))
options, args = parser.parse_args()
######################################################################
# load/install setuptools
to_reload = False
try:
import pkg_resources
import setuptools
except ImportError:
ez = {}
try:
from urllib.request import urlopen
except ImportError:
from urllib2 import urlopen
# XXX use a more permanent ez_setup.py URL when available.
exec(urlopen('https://bitbucket.org/pypa/setuptools/raw/0.7.2/ez_setup.py'
).read(), ez)
setup_args = dict(to_dir=tmpeggs, download_delay=0)
ez['use_setuptools'](**setup_args)
if to_reload:
reload(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)
######################################################################
# Try to best guess the version of buildout given setuptools
if options.version is None:
try:
from distutils.version import LooseVersion
package = pkg_resources.require('setuptools')[0]
v = LooseVersion(package.version)
if v < LooseVersion('0.7'):
options.version = '2.1.1'
except:
pass
######################################################################
# Install buildout
ws = pkg_resources.working_set
cmd = [sys.executable, '-c',
'from setuptools.command.easy_install import main; main()',
'-mZqNxd', tmpeggs]
find_links = os.environ.get(
'bootstrap-testing-find-links',
options.find_links or
('http://downloads.buildout.org/'
if options.accept_buildout_test_releases else None)
)
if find_links:
cmd.extend(['-f', find_links])
setuptools_path = ws.find(
pkg_resources.Requirement.parse('setuptools')).location
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=[setuptools_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)
import subprocess
if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0:
raise Exception(
"Failed to execute command:\n%s",
repr(cmd)[1:-1])
######################################################################
# Import and run buildout
ws.add_entry(tmpeggs)
ws.require(requirement)
import zc.buildout.buildout
if not [a for a in args if '=' not in a]:
args.append('bootstrap')
# if -c was provided, we push it back into args for buildout' main function
if options.config_file is not None:
args[0:0] = ['-c', options.config_file]
zc.buildout.buildout.main(args)
shutil.rmtree(tmpeggs)
; vim: set fileencoding=utf-8 :
; Andre Anjos <andre.anjos@idiap.ch>
; Mon 16 Apr 08:29:18 2012 CEST
[buildout]
parts = scripts
develop = .
eggs = xbob.buildout
ipdb
[scripts]
recipe = xbob.buildout:scripts
#!/usr/bin/env python
# encoding: utf-8
# Andre Anjos <andre.dos.anjos@gmail.com>
# Fri 21 Mar 2014 11:50:06 CET
'''Tests for our environment wrapper class'''
import os
import logging
import nose.tools
from .envwrapper import EnvironmentWrapper
def test_default():
e = EnvironmentWrapper(logging.getLogger())
before = dict(os.environ)
e.set()
for key in before:
assert key in os.environ, "key `%s' from before is not on os.environ" % (key,)
for key in os.environ:
assert key in before, "key `%s' was not on os.environ before" % (key,)
nose.tools.eq_(before, os.environ)
e.unset()
for key in before:
assert key in os.environ, "key `%s' from before is not on os.environ" % (key,)
for key in os.environ:
assert key in before, "key `%s' was not on os.environ before" % (key,)
nose.tools.eq_(before, os.environ)
def cleanup():
'''Removes weird variables from the user environment just for the tests'''
remove = ['CFLAGS', 'CXXFLAGS', 'XBOB_PREFIX_PATH', 'PKG_CONFIG_PATH']
for key in remove:
if key in os.environ: del os.environ[key]
@nose.with_setup(cleanup)
def test_set_debug_true():
# a few checks before we start
assert 'CFLAGS' not in os.environ
assert 'CXXFLAGS' not in os.environ
e = EnvironmentWrapper(logging.getLogger(), debug=True)
before = dict(os.environ)
e.set()
nose.tools.eq_(len(os.environ) - len(before), 2)
assert 'CFLAGS' in os.environ
assert os.environ['CFLAGS'].find(EnvironmentWrapper.DEBUG_FLAGS) >= 0
assert os.environ['CFLAGS'].find(EnvironmentWrapper.RELEASE_FLAGS) < 0
assert 'CXXFLAGS' in os.environ
assert os.environ['CXXFLAGS'].find(EnvironmentWrapper.DEBUG_FLAGS) >= 0
assert os.environ['CXXFLAGS'].find(EnvironmentWrapper.RELEASE_FLAGS) < 0
e.unset()
for key in before:
assert key in os.environ, "key `%s' from before is not on os.environ" % (key,)
for key in os.environ:
assert key in before, "key `%s' was not on os.environ before" % (key,)
nose.tools.eq_(before, os.environ)
@nose.with_setup(cleanup)
def test_set_debug_false():
# a few checks before we start
assert 'CFLAGS' not in os.environ
assert 'CXXFLAGS' not in os.environ
e = EnvironmentWrapper(logging.getLogger(), debug=False)
before = dict(os.environ)
e.set()
nose.tools.eq_(len(os.environ) - len(before), 2)
assert 'CFLAGS' in os.environ
assert 'CXXFLAGS' in os.environ
nose.tools.eq_(os.environ['CFLAGS'], e.environ['CFLAGS'])
assert os.environ['CFLAGS'].find(EnvironmentWrapper.DEBUG_FLAGS) < 0
assert os.environ['CFLAGS'].find(EnvironmentWrapper.RELEASE_FLAGS) >= 0
nose.tools.eq_(os.environ['CXXFLAGS'], e.environ['CXXFLAGS'])
assert os.environ['CXXFLAGS'].find(EnvironmentWrapper.DEBUG_FLAGS) < 0
assert os.environ['CXXFLAGS'].find(EnvironmentWrapper.RELEASE_FLAGS) >= 0
e.unset()
for key in before:
assert key in os.environ, "key `%s' from before is not on os.environ" % (key,)
for key in os.environ:
assert key in before, "key `%s' was not on os.environ before" % (key,)
nose.tools.eq_(before, os.environ)
@nose.with_setup(cleanup)
def test_set_prefixes():
# a few checks before we start
assert 'PKG_CONFIG_PATH' not in os.environ
prefixes = ['/a/b', '/c/d']
e = EnvironmentWrapper(logging.getLogger(), prefixes=prefixes)
before = dict(os.environ)
e.set()
#nose.tools.eq_(len(os.environ) - len(before), 2)
assert 'PKG_CONFIG_PATH' in os.environ
nose.tools.eq_(os.environ['PKG_CONFIG_PATH'], e.environ['PKG_CONFIG_PATH'])
assert 'XBOB_PREFIX_PATH' in os.environ
nose.tools.eq_(os.environ['XBOB_PREFIX_PATH'], os.pathsep.join(prefixes))
e.unset()
for key in before:
assert key in os.environ, "key `%s' from before is not on os.environ" % (key,)
for key in os.environ:
assert key in before, "key `%s' was not on os.environ before" % (key,)
nose.tools.eq_(before, os.environ)
@nose.with_setup(cleanup)
def test_set_environment():
# a few checks before we start
varname = 'XBOB_FOO'
varvalue = 'abc'
assert varname not in os.environ
e = EnvironmentWrapper(logging.getLogger(), environ={varname: varvalue})
before = dict(os.environ)
e.set()
nose.tools.eq_(len(os.environ) - len(before), 1)
assert varname in os.environ
nose.tools.eq_(os.environ[varname], varvalue)
e.unset()
for key in before:
assert key in os.environ, "key `%s' from before is not on os.environ" % (key,)
for key in os.environ:
assert key in before, "key `%s' was not on os.environ before" % (key,)
nose.tools.eq_(before, os.environ)
@nose.with_setup(cleanup)
def test_environ_substitutions():
# defines the environment with all legal substitutions
environ = dict(
XBOB_FOO = 'foo',
XBOB_T1 = '${XBOB_FOO}:bar',
XBOB_T2 = 'bar$XBOB_FOO',
)
e = EnvironmentWrapper(logging.getLogger(), environ=environ)
before = dict(os.environ)
e.set()
nose.tools.eq_(len(os.environ) - len(before), 3)
for key in environ: assert key in os.environ
nose.tools.eq_(os.environ['XBOB_FOO'], environ['XBOB_FOO'])
nose.tools.eq_(os.environ['XBOB_T1'], environ['XBOB_FOO'] + ':bar')
nose.tools.eq_(os.environ['XBOB_T2'], 'bar' + environ['XBOB_FOO'])
e.unset()
for key in before:
assert key in os.environ, "key `%s' from before is not on os.environ" % (key,)
for key in os.environ:
assert key in before, "key `%s' was not on os.environ before" % (key,)
nose.tools.eq_(before, os.environ)
@nose.with_setup(cleanup)
def test_set_multiple():
# a few checks before we start
environ = dict(
CFLAGS='-DNDEBUG',
CXXFLAGS='${CFLAGS}',
PKG_CONFIG_PATH='/a/b/lib/pkgconfig',
XBOB_PREFIX_PATH='/c/d'
)
e = EnvironmentWrapper(logging.getLogger(), debug=True, environ=environ)
before = dict(os.environ)
e.set()
nose.tools.eq_(len(os.environ) - len(before), 4)
nose.tools.eq_(os.environ['CFLAGS'], EnvironmentWrapper.DEBUG_FLAGS + ' ' + environ['CFLAGS'])
nose.tools.eq_(os.environ['CXXFLAGS'], os.environ['CFLAGS'])
nose.tools.eq_(os.environ['XBOB_PREFIX_PATH'], environ['XBOB_PREFIX_PATH'])
assert os.environ['PKG_CONFIG_PATH'].startswith(environ['PKG_CONFIG_PATH'])
assert os.environ['PKG_CONFIG_PATH'].find(environ['XBOB_PREFIX_PATH']) >= 0
e.unset()
for key in before:
assert key in os.environ, "key `%s' from before is not on os.environ" % (key,)
for key in os.environ:
assert key in before, "key `%s' was not on os.environ before" % (key,)
nose.tools.eq_(before, os.environ)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment