Skip to content

Commit

Permalink
- Fixed support of Windows.
Browse files Browse the repository at this point in the history
- Added support of zc.buildout 3+ into tests.
  • Loading branch information
Cykooz committed Apr 29, 2022
1 parent 44e2201 commit a3a73b0
Show file tree
Hide file tree
Showing 5 changed files with 205 additions and 225 deletions.
360 changes: 160 additions & 200 deletions bootstrap.py
Original file line number Diff line number Diff line change
@@ -1,210 +1,170 @@
##############################################################################
#
# 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.
"""

:Version: 1.1
"""
import argparse
import logging
import os
import platform
import shutil
import subprocess
import sys
import tempfile

from optparse import OptionParser

__version__ = '2015-07-01'
# See zc.buildout's changelog if this version is up to date.

tmpeggs = tempfile.mkdtemp(prefix='bootstrap-')

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("--version",
action="store_true", default=False,
help=("Return bootstrap.py 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"))
parser.add_option("--allow-site-packages",
action="store_true", default=False,
help=("Let bootstrap.py use existing site packages"))
parser.add_option("--buildout-version",
help="Use a specific zc.buildout version")
parser.add_option("--setuptools-version",
help="Use a specific setuptools version", default='51.0.0')
parser.add_option("--setuptools-to-dir",
help=("Allow for re-use of existing directory of "
"setuptools versions"))

options, args = parser.parse_args()
if options.version:
print("bootstrap.py version %s" % __version__)
sys.exit(0)


######################################################################
# load/install setuptools

try:
from urllib.request import urlopen
except ImportError:
from urllib2 import urlopen

ez = {}
if os.path.exists('ez_setup.py'):
exec(open('ez_setup.py').read(), ez)
else:
exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez)

if not options.allow_site_packages:
# ez_setup imports site, which adds site packages
# this will remove them from the path to ensure that incompatible versions
# of setuptools are not in the path
import site
# inside a virtualenv, there is no 'getsitepackages'.
# We can't remove these reliably
if hasattr(site, 'getsitepackages'):
for sitepackage_path in site.getsitepackages():
# Strip all site-packages directories from sys.path that
# are not sys.prefix; this is because on Windows
# sys.prefix is a site-package directory.
if sitepackage_path != sys.prefix:
sys.path[:] = [x for x in sys.path
if sitepackage_path not in x]

setup_args = dict(to_dir=tmpeggs, download_delay=0)

if options.setuptools_version is not None:
setup_args['version'] = options.setuptools_version
if options.setuptools_to_dir is not None:
setup_args['to_dir'] = options.setuptools_to_dir

ez['use_setuptools'](**setup_args)
import setuptools
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)

######################################################################
# Install buildout

ws = pkg_resources.working_set

setuptools_path = ws.find(
pkg_resources.Requirement.parse('setuptools')).location

# Fix sys.path here as easy_install.pth added before PYTHONPATH
cmd = [sys.executable, '-c',
'import sys; sys.path[0:0] = [%r]; ' % setuptools_path +
'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])

requirement = 'zc.buildout'
version = options.buildout_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):
try:
return not parsed_version.is_prerelease
except AttributeError:
# Older setuptools
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 venv
from pathlib import Path
from tempfile import TemporaryDirectory
from urllib.request import urlopen


BUILDOUT_VERSION = '3.0rc2'
PIP_VERSION = '22.0.4'
SETUPTOOLS_VERSION = '59.6.0'
WHEEL_VERSION = '0.37.1'

GET_PIP_URL = 'https://bootstrap.pypa.io/get-pip.py'

import subprocess
if subprocess.call(cmd) != 0:
raise Exception(
"Failed to execute command:\n%s" % repr(cmd)[1:-1])

######################################################################
# Import and run buildout
def main():
parser = argparse.ArgumentParser(description='Bootstrap zc.buildout')
parser.add_argument(
'-r, --recreate', dest='recreate', action='store_true',
help='Recreate virtual python if it exists.',
)
parser.add_argument(
'--buildout_version', default=BUILDOUT_VERSION,
help='Version of zc.buildout (default: %(default)).',
)
parser.add_argument(
'--pip_version', default=PIP_VERSION,
help='Version of pip (default: %(default)).',
)
parser.add_argument(
'--setuptools_version', default=SETUPTOOLS_VERSION,
help='Version of setuptools (default: %(default)).',
)
parser.add_argument(
'--wheel_version', default=WHEEL_VERSION,
help='Version of wheel (default: %(default)).',
)

args = parser.parse_args(sys.argv[1:])
logging.basicConfig(
stream=sys.stdout,
level=logging.DEBUG,
format='%(levelname)s: %(message)s'
)
logger = logging.getLogger('buildout.bootstrap')

project_dir = Path(os.getcwd()).absolute()
venv_dir = project_dir / '.venv'
if args.recreate and venv_dir.is_dir():
logger.info('Delete exists virtual python')
shutil.rmtree(venv_dir)

is_win = platform.system() == 'Windows'
if is_win:
venv_python_path = venv_dir / 'Scripts' / 'python.exe'
else:
venv_python_path = venv_dir / 'bin' / 'python'

if venv_python_path.is_file():
logger.debug('Checking version of exists virtual python...')
proc = subprocess.Popen(
[
str(venv_python_path),
'-c',
'import sys;print(sys.version)',
],
stdout=subprocess.PIPE
)
stdout, stderr = proc.communicate()
env_version = stdout.strip().decode()
if env_version != sys.version:
logger.info(
'Removing exists virtual python environment '
'due to incorrect version of Python in it...'
)
shutil.rmtree(venv_dir)

if not venv_python_path.is_file():
logger.info(f'Installing virtual python environment in directory {venv_dir}')
venv.create(
venv_dir,
symlinks=not is_win,
system_site_packages=False,
with_pip=False,
)
logger.info('Virtual python environment has installed.')

logger.info('Installing pip...')
with TemporaryDirectory() as tmp_dir:
get_pip_path = Path(tmp_dir) / 'get_pip.py'
with urlopen(GET_PIP_URL) as get_pip:
content: bytes = get_pip.read()
get_pip_path.write_bytes(content)
cmd = [
str(venv_python_path),
str(get_pip_path),
'--no-setuptools',
'--no-wheel',
]
if args.pip_version:
cmd.append(f'pip=={args.pip_version}')
_run_cmd(cmd)

logger.info(f'Installing setuptools=={args.setuptools_version} and wheel=={args.wheel_version}')
_run_cmd([
str(venv_python_path),
'-m', 'pip',
'install',
f'setuptools=={args.setuptools_version}',
f'wheel=={args.wheel_version}',
])

logger.info(f'Installing zc.buildout == {args.buildout_version}')
_run_cmd([
str(venv_python_path),
'-m', 'pip',
'install',
f'zc.buildout=={args.buildout_version}'
])

logger.info(f'Bootstrap zc.buildout')
is_win = platform.system() == 'Windows'
if is_win:
buildout_path = venv_dir / 'Scripts' / 'buildout.exe'
else:
buildout_path = venv_dir / 'bin' / 'buildout'
_run_cmd([
str(buildout_path),
'bootstrap',
])

# Delete zc.buildout.egg-link from list of develop eggs
buildout_link = project_dir / 'develop-eggs' / 'zc.buildout.egg-link'
if buildout_link.is_file():
os.remove(buildout_link)

# Fix buildout script
buildout_script_path = project_dir / 'bin' / 'buildout'
buildout_script = buildout_script_path.read_text()
buildout_script = buildout_script.replace(
'import zc.buildout.buildout',
'try:\n'
' from _distutils_hack import DistutilsMetaFinder\n'
' DistutilsMetaFinder.pip_imported_during_build = lambda cls: True\n'
'except ImportError:\n'
' pass\n\n'
'import zc.buildout.buildout\n'
'import warnings\n'
'from pkg_resources import PkgResourcesDeprecationWarning\n\n'
'warnings.filterwarnings("ignore", category=PkgResourcesDeprecationWarning)'
)
buildout_script_path.write_text(buildout_script)

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')
def _run_cmd(cmd):
if subprocess.call(cmd) != 0:
raise Exception(f'Failed to execute command:\n {" ".join(cmd)}')

# 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)
if __name__ == '__main__':
main()
6 changes: 6 additions & 0 deletions src/CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Changes
*******

Next release
============

- Added support of Windows (GH-1).
- Added support of zc.buildout 3+ into tests.

0.3 (2021-12-14)
================

Expand Down
Loading

0 comments on commit a3a73b0

Please sign in to comment.