multissltests.py

#!./python
"""Run Python tests against multiple installations of OpenSSL and LibreSSL

The script

 (1) downloads OpenSSL / LibreSSL tar bundle
 (2) extracts it to ./src
 (3) compiles OpenSSL / LibreSSL
 (4) installs OpenSSL / LibreSSL into ../multissl/$LIB/$VERSION/
 (5) forces a recompilation of Python modules using the
 header and library files from ../multissl/$LIB/$VERSION/
 (6) runs Python's test suite

The script must be run with Python's build directory as current working
directory.

The script uses LD_RUN_PATH, LD_LIBRARY_PATH, CPPFLAGS and LDFLAGS to bend
search paths for header files and shared libraries. It's known to work on
Linux with GCC and clang.

Please keep this script compatible with Python 2.7, and 3.4 to 3.7.

(c) 2013-2017 Christian Heimes <christian@python.org>
"""
from __future__ importprint_function

importargparse
fromdatetimeimportdatetime
importlogging
importos
try:
fromurllib.requestimporturlopen
exceptImportError:
fromurllib2importurlopen
importsubprocess
importshutil
importsys
importtarfile


log=logging.getLogger("multissl")

OPENSSL_OLD_VERSIONS= [
"1.0.1u",
"1.0.2o",
]

OPENSSL_RECENT_VERSIONS= [
"1.0.2t",
"1.1.0l",
"1.1.1f",
]

LIBRESSL_OLD_VERSIONS= [
"2.3.10",
"2.4.5",
]

LIBRESSL_RECENT_VERSIONS= [
"2.5.5",
"2.6.5",
"2.7.4",
]

# store files in ../multissl
HERE=os.path.dirname(os.path.abspath(__file__))
PYTHONROOT=os.path.abspath(os.path.join(HERE, '..', '..'))
MULTISSL_DIR=os.path.abspath(os.path.join(PYTHONROOT, '..', 'multissl'))


parser=argparse.ArgumentParser(
prog='multissl',
description=(
"Run CPython tests with multiple OpenSSL and LibreSSL "
"versions."
 )
)
parser.add_argument(
'--debug',
action='store_true',
help="Enable debug logging",
)
parser.add_argument(
'--disable-ancient',
action='store_true',
help="Don't test OpenSSL < 1.0.2 and LibreSSL < 2.5.3.",
)
parser.add_argument(
'--openssl',
nargs='+',
default=(),
help=(
"OpenSSL versions, defaults to '{}' (ancient: '{}') if no "
"OpenSSL and LibreSSL versions are given."
 ).format(OPENSSL_RECENT_VERSIONS, OPENSSL_OLD_VERSIONS)
)
parser.add_argument(
'--libressl',
nargs='+',
default=(),
help=(
"LibreSSL versions, defaults to '{}' (ancient: '{}') if no "
"OpenSSL and LibreSSL versions are given."
 ).format(LIBRESSL_RECENT_VERSIONS, LIBRESSL_OLD_VERSIONS)
)
parser.add_argument(
'--tests',
nargs='*',
default=(),
help="Python tests to run, defaults to all SSL related tests.",
)
parser.add_argument(
'--base-directory',
default=MULTISSL_DIR,
help="Base directory for OpenSSL / LibreSSL sources and builds."
)
parser.add_argument(
'--no-network',
action='store_false',
dest='network',
help="Disable network tests."
)
parser.add_argument(
'--steps',
choices=['library', 'modules', 'tests'],
default='tests',
help=(
"Which steps to perform. 'library' downloads and compiles OpenSSL "
"or LibreSSL. 'module' also compiles Python modules. 'tests' builds "
"all and runs the test suite."
 )
)

parser.add_argument(
'--force',
action='store_true',
dest='force',
help="Force build and installation."
)
parser.add_argument(
'--keep-sources',
action='store_true',
dest='keep_sources',
help="Keep original sources for debugging."
)

classAbstractBuilder(object):
library=None
url_template=None
src_template=None
build_template=None
install_target='install'

module_files= ("Modules/_ssl.c",
"Modules/_hashopenssl.c")
module_libs= ("_ssl", "_hashlib")

def__init__(self, version, args):
self.version=version
self.args=args
# installation directory
self.install_dir=os.path.join(
os.path.join(args.base_directory, self.library.lower()), version
 )
# source file
self.src_dir=os.path.join(args.base_directory, 'src')
self.src_file=os.path.join(
self.src_dir, self.src_template.format(version))
# build directory (removed after install)
self.build_dir=os.path.join(
self.src_dir, self.build_template.format(version))

def__str__(self):
return"<{0.__class__.__name__} for {0.version}>".format(self)

def__eq__(self, other):
ifnotisinstance(other, AbstractBuilder):
returnNotImplemented
return (
self.library==other.library
andself.version==other.version
 )

def__hash__(self):
returnhash((self.library, self.version))

@property
defopenssl_cli(self):
"""openssl CLI binary"""
returnos.path.join(self.install_dir, "bin", "openssl")

@property
defopenssl_version(self):
"""output of 'bin/openssl version'"""
cmd= [self.openssl_cli, "version"]
returnself._subprocess_output(cmd)

@property
defpyssl_version(self):
"""Value of ssl.OPENSSL_VERSION"""
cmd= [
sys.executable,
'-c', 'import ssl; print(ssl.OPENSSL_VERSION)'
 ]
returnself._subprocess_output(cmd)

@property
definclude_dir(self):
returnos.path.join(self.install_dir, "include")

@property
deflib_dir(self):
returnos.path.join(self.install_dir, "lib")

@property
defhas_openssl(self):
returnos.path.isfile(self.openssl_cli)

@property
defhas_src(self):
returnos.path.isfile(self.src_file)

def_subprocess_call(self, cmd, env=None, **kwargs):
log.debug("Call '{}'".format(" ".join(cmd)))
returnsubprocess.check_call(cmd, env=env, **kwargs)

def_subprocess_output(self, cmd, env=None, **kwargs):
log.debug("Call '{}'".format(" ".join(cmd)))
ifenvisNone:
env=os.environ.copy()
env["LD_LIBRARY_PATH"] =self.lib_dir
out=subprocess.check_output(cmd, env=env, **kwargs)
returnout.strip().decode("utf-8")

def_download_src(self):
"""Download sources"""
src_dir=os.path.dirname(self.src_file)
ifnotos.path.isdir(src_dir):
os.makedirs(src_dir)
url=self.url_template.format(self.version)
log.info("Downloading from {}".format(url))
req=urlopen(url)
# KISS, read all, write all
data=req.read()
log.info("Storing {}".format(self.src_file))
withopen(self.src_file, "wb") asf:
f.write(data)

def_unpack_src(self):
"""Unpack tar.gz bundle"""
# cleanup
ifos.path.isdir(self.build_dir):
shutil.rmtree(self.build_dir)
os.makedirs(self.build_dir)

tf=tarfile.open(self.src_file)
name=self.build_template.format(self.version)
base=name+'/'
# force extraction into build dir
members=tf.getmembers()
formemberinlist(members):
ifmember.name==name:
members.remove(member)
elifnotmember.name.startswith(base):
raiseValueError(member.name, base)
member.name=member.name[len(base):].lstrip('/')
log.info("Unpacking files to {}".format(self.build_dir))
tf.extractall(self.build_dir, members)

def_build_src(self):
"""Now build openssl"""
log.info("Running build in {}".format(self.build_dir))
cwd=self.build_dir
cmd= [
"./config",
"shared", "--debug",
"--prefix={}".format(self.install_dir)
 ]
env=os.environ.copy()
# set rpath
env["LD_RUN_PATH"] =self.lib_dir
self._subprocess_call(cmd, cwd=cwd)
# Old OpenSSL versions do not support parallel builds.
self._subprocess_call(["make", "-j1"], cwd=cwd)

def_make_install(self):
self._subprocess_call(
 ["make", "-j1", self.install_target],
cwd=self.build_dir
 )
ifnotself.args.keep_sources:
shutil.rmtree(self.build_dir)

definstall(self):
log.info(self.openssl_cli)
ifnotself.has_opensslorself.args.force:
ifnotself.has_src:
self._download_src()
else:
log.debug("Already has src {}".format(self.src_file))
self._unpack_src()
self._build_src()
self._make_install()
else:
log.info("Already has installation {}".format(self.install_dir))
# validate installation
version=self.openssl_version
ifself.versionnotinversion:
raiseValueError(version)

defrecompile_pymods(self):
log.warning("Using build from {}".format(self.build_dir))
# force a rebuild of all modules that use OpenSSL APIs
forfnameinself.module_files:
os.utime(fname, None)
# remove all build artefacts
forroot, dirs, filesinos.walk('build'):
forfilenameinfiles:
iffilename.startswith(self.module_libs):
os.unlink(os.path.join(root, filename))

# overwrite header and library search paths
env=os.environ.copy()
env["CPPFLAGS"] ="-I{}".format(self.include_dir)
env["LDFLAGS"] ="-L{}".format(self.lib_dir)
# set rpath
env["LD_RUN_PATH"] =self.lib_dir

log.info("Rebuilding Python modules")
cmd= [sys.executable, "setup.py", "build"]
self._subprocess_call(cmd, env=env)
self.check_imports()

defcheck_imports(self):
cmd= [sys.executable, "-c", "import _ssl; import _hashlib"]
self._subprocess_call(cmd)

defcheck_pyssl(self):
version=self.pyssl_version
ifself.versionnotinversion:
raiseValueError(version)

defrun_python_tests(self, tests, network=True):
ifnottests:
cmd= [sys.executable, 'Lib/test/ssltests.py', '-j0']
elifsys.version_info< (3, 3):
cmd= [sys.executable, '-m', 'test.regrtest']
else:
cmd= [sys.executable, '-m', 'test', '-j0']
ifnetwork:
cmd.extend(['-u', 'network', '-u', 'urlfetch'])
cmd.extend(['-w', '-r'])
cmd.extend(tests)
self._subprocess_call(cmd, stdout=None)


classBuildOpenSSL(AbstractBuilder):
library="OpenSSL"
url_template="https://www.openssl.org/source/openssl-{}.tar.gz"
src_template="openssl-{}.tar.gz"
build_template="openssl-{}"
# only install software, skip docs
install_target='install_sw'


classBuildLibreSSL(AbstractBuilder):
library="LibreSSL"
url_template= (
"https://ftp.openbsd.org/pub/OpenBSD/LibreSSL/libressl-{}.tar.gz")
src_template="libressl-{}.tar.gz"
build_template="libressl-{}"


defconfigure_make():
ifnotos.path.isfile('Makefile'):
log.info('Running ./configure')
subprocess.check_call([
'./configure', '--config-cache', '--quiet',
'--with-pydebug'
 ])

log.info('Running make')
subprocess.check_call(['make', '--quiet'])


defmain():
args=parser.parse_args()
ifnotargs.opensslandnotargs.libressl:
args.openssl=list(OPENSSL_RECENT_VERSIONS)
args.libressl=list(LIBRESSL_RECENT_VERSIONS)
ifnotargs.disable_ancient:
args.openssl.extend(OPENSSL_OLD_VERSIONS)
args.libressl.extend(LIBRESSL_OLD_VERSIONS)

logging.basicConfig(
level=logging.DEBUGifargs.debugelselogging.INFO,
format="*** %(levelname)s %(message)s"
 )

start=datetime.now()

ifargs.stepsin {'modules', 'tests'}:
fornamein ['setup.py', 'Modules/_ssl.c']:
ifnotos.path.isfile(os.path.join(PYTHONROOT, name)):
parser.error(
"Must be executed with ./python from CPython build dir"
 )
ifnotos.path.samefile('python', sys.executable):
parser.error(
"Must be executed with ./python from CPython build dir"
 )

# check for configure and run make
configure_make()

# download and register builder
builds= []

forversioninargs.openssl:
build=BuildOpenSSL(
version,
args
 )
build.install()
builds.append(build)

forversioninargs.libressl:
build=BuildLibreSSL(
version,
args
 )
build.install()
builds.append(build)

ifargs.stepsin {'modules', 'tests'}:
forbuildinbuilds:
try:
build.recompile_pymods()
build.check_pyssl()
ifargs.steps=='tests':
build.run_python_tests(
tests=args.tests,
network=args.network,
 )
exceptExceptionase:
log.exception("%s failed", build)
print("{} failed: {}".format(build, e), file=sys.stderr)
sys.exit(2)

log.info("\n{} finished in {}".format(
args.steps.capitalize(),
datetime.now() -start
 ))
print('Python: ', sys.version)
ifargs.steps=='tests':
ifargs.tests:
print('Executed Tests:', ' '.join(args.tests))
else:
print('Executed all SSL tests.')

print('OpenSSL / LibreSSL versions:')
forbuildinbuilds:
print(" * {0.library} {0.version}".format(build))


if__name__=="__main__":
main()