This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6087

packaging: move Inno Setup core logic into a module
ClosedPublic

Authored by indygreg on Mar 7 2019, 7:49 PM.

Download Raw Diff

Details

Reviewers

None

Group Reviewers

hg-reviewers

Commits

rHGdc7827a9ba64: packaging: move Inno Setup core logic into a module

Summary

Aspects of building the Inno Setup and WIX installers are shared.
It will make sense for them to share code.

Plus, having code in a reusable library (as opposed to a standalone
script) is just a better approach.

This commit moves the core logic to build the Inno Setup installer
into the hgpackaging package. inno/build.py is now a simple frontend
script that calls into a module to do the bulk of the work.

As part of this change, I also found a typo in build() where it was
referencing "iscc" instead of "iscc_exe." Because "iscc" was in
the global scope via the only caller, things just happened to work
before. Another benefit of always using functions and not putting
global code for main in the same file as library code.

Diff Detail

Repository

rHG Mercurial

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

Event Timeline

indygreg created this revision.Mar 7 2019, 7:49 PM

Herald added a reviewer: hg-reviewers. · View Herald TranscriptMar 7 2019, 7:49 PM

Herald added a subscriber: mercurial-devel. · View Herald Transcript

indygreg added a child revision: D6088: packaging: extract virtualenv and py2exe to build directory.Mar 7 2019, 7:49 PM

Closed by commit rHGdc7827a9ba64: packaging: move Inno Setup core logic into a module (authored by indygreg). · Explain WhyMar 9 2019, 8:51 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

		Path
P	M	contrib/packaging/hgpackaging/inno.py (59 lines) Copied from contrib/packaging/inno/build.py
P		contrib/packaging/inno/build.py (160 lines) Copied to contrib/packaging/hgpackaging/inno.py
M		tests/test-check-code.t (1 line)

Status	Author	Revision
Closed	indygreg	D6101 wix: remove enum and future packages
Closed	indygreg	D6100 wix: remove pywin32
Closed	indygreg	D6099 wix: remove sphinx and dependencies
Closed	indygreg	D6098 wix: restore COPYING.rtf
Closed	indygreg	D6097 wix: functionality to automate building WiX installers
Closed	indygreg	D6096 wix: move contrib/wix to contrib/packaging/wix
Closed	indygreg	D6095 wix: remove hg.cmd
Closed	indygreg	D6094 setup: include hgext3rd package in py2exe builds
Closed	indygreg	D6093 setup: properly install build_hgextindex for py2exe builds
Closed	indygreg	D6092 setup: configure py2exe config via environment variables
Closed	indygreg	D6091 packaging: extract py2exe functionality to own module
Closed	indygreg	D6090 packaging: extract python exe info to own function
Closed	indygreg	D6089 packaging: don't use temporary directory
Closed	indygreg	D6088 packaging: extract virtualenv and py2exe to build directory
Closed	indygreg	D6087 packaging: move Inno Setup core logic into a module
Closed	indygreg	D6086 packaging: move find_vc_runtime_files() into hgpackaging.util
Closed	indygreg	D6085 packaging: move DOWNLOADS dict to hgpackaging.downloads
Closed	indygreg	D6084 packaging: split downloading code into own module
Closed	indygreg	D6083 packaging: establish hgpackaging package

Diff 14442

contrib/packaging/hgpackaging/inno.py

This file was copied from contrib/packaging/inno/build.py.

Property	Old Value	New Value
File Mode	100755	100644

	#!/usr/bin/env python3			# inno.py - Inno Setup functionality.
	# build.py - Inno installer build script.
	#			#
	# Copyright 2019 Gregory Szorc <gregory.szorc@gmail.com>			# Copyright 2019 Gregory Szorc <gregory.szorc@gmail.com>
	#			#
	# This software may be used and distributed according to the terms of the			# This software may be used and distributed according to the terms of the
	# GNU General Public License version 2 or any later version.			# GNU General Public License version 2 or any later version.

	# This script automates the building of the Inno MSI installer for Mercurial.

	# no-check-code because Python 3 native.			# no-check-code because Python 3 native.

	import argparse
	import os			import os
	import pathlib			import pathlib
	import shutil			import shutil
	import subprocess			import subprocess
	import sys
	import tempfile			import tempfile

				from .downloads import (
				download_entry,
				)
				from .util import (
				extract_tar_to_directory,
				extract_zip_to_directory,
				find_vc_runtime_files,
				)


	PRINT_PYTHON_INFO = '''			PRINT_PYTHON_INFO = '''
	import platform, sys; print("%s:%d" % (platform.architecture()[0], sys.version_info[0]))			import platform, sys; print("%s:%d" % (platform.architecture()[0], sys.version_info[0]))
	'''.strip()			'''.strip()


	def build(source_dir: pathlib.Path, build_dir: pathlib.Path,			def build(source_dir: pathlib.Path, build_dir: pathlib.Path,
	python_exe: pathlib.Path, iscc_exe: pathlib.Path,			python_exe: pathlib.Path, iscc_exe: pathlib.Path,
	version=None):			version=None):
	"""Build the Inno installer.			"""Build the Inno installer.

	Build files will be placed in ``build_dir``.			Build files will be placed in ``build_dir``.

	py2exe's setup.py doesn't use setuptools. It doesn't have modern logic			py2exe's setup.py doesn't use setuptools. It doesn't have modern logic
	for finding the Python 2.7 toolchain. So, we require the environment			for finding the Python 2.7 toolchain. So, we require the environment
	to already be configured with an active toolchain.			to already be configured with an active toolchain.
	"""			"""
	from hgpackaging.downloads import (			if not iscc_exe.exists():
	download_entry,			raise Exception('%s does not exist' % iscc_exe)
	)
	from hgpackaging.util import (
	extract_tar_to_directory,
	extract_zip_to_directory,
	find_vc_runtime_files,
	)

	if not iscc.exists():
	raise Exception('%s does not exist' % iscc)

	if 'VCINSTALLDIR' not in os.environ:			if 'VCINSTALLDIR' not in os.environ:
	raise Exception('not running from a Visual C++ build environment; '			raise Exception('not running from a Visual C++ build environment; '
	'execute the "Visual C++ <version> Command Prompt" '			'execute the "Visual C++ <version> Command Prompt" '
	'application shortcut or a vcsvarsall.bat file')			'application shortcut or a vcsvarsall.bat file')

	# Identity x86/x64 and validate the environment matches the Python			# Identity x86/x64 and validate the environment matches the Python
	# architecture.			# architecture.

	if version:			if version:
	args.append('/dVERSION=%s' % version)			args.append('/dVERSION=%s' % version)

	args.append('/Odist')			args.append('/Odist')
	args.append('contrib/packaging/inno/mercurial.iss')			args.append('contrib/packaging/inno/mercurial.iss')

	subprocess.run(args, cwd=str(source_dir), check=True)			subprocess.run(args, cwd=str(source_dir), check=True)


	if __name__ == '__main__':
	parser = argparse.ArgumentParser()

	parser.add_argument('--python',
	required=True,
	help='path to python.exe to use')
	parser.add_argument('--iscc',
	help='path to iscc.exe to use')
	parser.add_argument('--version',
	help='Mercurial version string to use '
	'(detected from __version__.py if not defined')

	args = parser.parse_args()

	if args.iscc:
	iscc = pathlib.Path(args.iscc)
	else:
	iscc = (pathlib.Path(os.environ['ProgramFiles(x86)']) / 'Inno Setup 5' /
	'ISCC.exe')

	here = pathlib.Path(os.path.abspath(os.path.dirname(__file__)))
	source_dir = here.parent.parent.parent
	build_dir = source_dir / 'build'

	sys.path.insert(0, str(source_dir / 'contrib' / 'packaging'))

	build(source_dir, build_dir, pathlib.Path(args.python), iscc,
	version=args.version)

contrib/packaging/inno/build.py

This file was copied to contrib/packaging/hgpackaging/inno.py.

	#!/usr/bin/env python3			#!/usr/bin/env python3
	# build.py - Inno installer build script.			# build.py - Inno installer build script.
	#			#
	# Copyright 2019 Gregory Szorc <gregory.szorc@gmail.com>			# Copyright 2019 Gregory Szorc <gregory.szorc@gmail.com>
	#			#
	# This software may be used and distributed according to the terms of the			# This software may be used and distributed according to the terms of the
	# GNU General Public License version 2 or any later version.			# GNU General Public License version 2 or any later version.

	# This script automates the building of the Inno MSI installer for Mercurial.			# This script automates the building of the Inno MSI installer for Mercurial.

	# no-check-code because Python 3 native.			# no-check-code because Python 3 native.

	import argparse			import argparse
	import os			import os
	import pathlib			import pathlib
	import shutil
	import subprocess
	import sys			import sys
	import tempfile


	PRINT_PYTHON_INFO = '''
	import platform, sys; print("%s:%d" % (platform.architecture()[0], sys.version_info[0]))
	'''.strip()


	def build(source_dir: pathlib.Path, build_dir: pathlib.Path,
	python_exe: pathlib.Path, iscc_exe: pathlib.Path,
	version=None):
	"""Build the Inno installer.

	Build files will be placed in ``build_dir``.

	py2exe's setup.py doesn't use setuptools. It doesn't have modern logic
	for finding the Python 2.7 toolchain. So, we require the environment
	to already be configured with an active toolchain.
	"""
	from hgpackaging.downloads import (
	download_entry,
	)
	from hgpackaging.util import (
	extract_tar_to_directory,
	extract_zip_to_directory,
	find_vc_runtime_files,
	)

	if not iscc.exists():
	raise Exception('%s does not exist' % iscc)

	if 'VCINSTALLDIR' not in os.environ:
	raise Exception('not running from a Visual C++ build environment; '
	'execute the "Visual C++ <version> Command Prompt" '
	'application shortcut or a vcsvarsall.bat file')

	# Identity x86/x64 and validate the environment matches the Python
	# architecture.
	vc_x64 = r'\x64' in os.environ['LIB']

	res = subprocess.run(
	[str(python_exe), '-c', PRINT_PYTHON_INFO],
	capture_output=True, check=True)

	py_arch, py_version = res.stdout.decode('utf-8').split(':')
	py_version = int(py_version)

	if vc_x64:
	if py_arch != '64bit':
	raise Exception('architecture mismatch: Visual C++ environment '
	'is configured for 64-bit but Python is 32-bit')
	else:
	if py_arch != '32bit':
	raise Exception('architecture mismatch: Visual C++ environment '
	'is configured for 32-bit but Python is 64-bit')

	if py_version != 2:
	raise Exception('Only Python 2 is currently supported')

	build_dir.mkdir(exist_ok=True)

	gettext_pkg, gettext_entry = download_entry('gettext', build_dir)
	gettext_dep_pkg = download_entry('gettext-dep', build_dir)[0]
	virtualenv_pkg, virtualenv_entry = download_entry('virtualenv', build_dir)
	py2exe_pkg, py2exe_entry = download_entry('py2exe', build_dir)

	venv_path = build_dir / ('venv-inno-%s' % ('x64' if vc_x64 else 'x86'))

	gettext_root = build_dir / (
	'gettext-win-%s' % gettext_entry['version'])

	if not gettext_root.exists():
	extract_zip_to_directory(gettext_pkg, gettext_root)
	extract_zip_to_directory(gettext_dep_pkg, gettext_root)

	with tempfile.TemporaryDirectory() as td:
	td = pathlib.Path(td)

	# This assumes Python 2.
	extract_tar_to_directory(virtualenv_pkg, td)
	extract_zip_to_directory(py2exe_pkg, td)

	virtualenv_src_path = td / ('virtualenv-%s' %
	virtualenv_entry['version'])
	py2exe_source_path = td / ('py2exe-%s' %
	py2exe_entry['version'])

	virtualenv_py = virtualenv_src_path / 'virtualenv.py'

	if not venv_path.exists():
	print('creating virtualenv with dependencies')
	subprocess.run(
	[str(python_exe), str(virtualenv_py), str(venv_path)],
	check=True)

	venv_python = venv_path / 'Scripts' / 'python.exe'
	venv_pip = venv_path / 'Scripts' / 'pip.exe'

	requirements_txt = (source_dir / 'contrib' / 'packaging' /
	'inno' / 'requirements.txt')
	subprocess.run([str(venv_pip), 'install', '-r', str(requirements_txt)],
	check=True)

	# Force distutils to use VC++ settings from environment, which was
	# validated above.
	env = dict(os.environ)
	env['DISTUTILS_USE_SDK'] = '1'
	env['MSSdk'] = '1'

	py2exe_py_path = venv_path / 'Lib' / 'site-packages' / 'py2exe'
	if not py2exe_py_path.exists():
	print('building py2exe')
	subprocess.run([str(venv_python), 'setup.py', 'install'],
	cwd=py2exe_source_path,
	env=env,
	check=True)

	# Register location of msgfmt and other binaries.
	env['PATH'] = '%s%s%s' % (
	env['PATH'], os.pathsep, str(gettext_root / 'bin'))

	print('building Mercurial')
	subprocess.run(
	[str(venv_python), 'setup.py',
	'py2exe', '-b', '3' if vc_x64 else '2',
	'build_doc', '--html'],
	cwd=str(source_dir),
	env=env,
	check=True)

	# hg.exe depends on VC9 runtime DLLs. Copy those into place.
	for f in find_vc_runtime_files(vc_x64):
	if f.name.endswith('.manifest'):
	basename = 'Microsoft.VC90.CRT.manifest'
	else:
	basename = f.name

	dest_path = source_dir / 'dist' / basename

	print('copying %s to %s' % (f, dest_path))
	shutil.copyfile(f, dest_path)

	print('creating installer')

	args = [str(iscc_exe)]

	if vc_x64:
	args.append('/dARCH=x64')

	if version:
	args.append('/dVERSION=%s' % version)

	args.append('/Odist')
	args.append('contrib/packaging/inno/mercurial.iss')

	subprocess.run(args, cwd=str(source_dir), check=True)


	if __name__ == '__main__':			if __name__ == '__main__':
	parser = argparse.ArgumentParser()			parser = argparse.ArgumentParser()

	parser.add_argument('--python',			parser.add_argument('--python',
	required=True,			required=True,
	help='path to python.exe to use')			help='path to python.exe to use')
	'ISCC.exe')			'ISCC.exe')

	here = pathlib.Path(os.path.abspath(os.path.dirname(__file__)))			here = pathlib.Path(os.path.abspath(os.path.dirname(__file__)))
	source_dir = here.parent.parent.parent			source_dir = here.parent.parent.parent
	build_dir = source_dir / 'build'			build_dir = source_dir / 'build'

	sys.path.insert(0, str(source_dir / 'contrib' / 'packaging'))			sys.path.insert(0, str(source_dir / 'contrib' / 'packaging'))

				from hgpackaging.inno import build

	build(source_dir, build_dir, pathlib.Path(args.python), iscc,			build(source_dir, build_dir, pathlib.Path(args.python), iscc,
	version=args.version)			version=args.version)

tests/test-check-code.t

	#require test-repo			#require test-repo

	$ . "$TESTDIR/helpers-testrepo.sh"			$ . "$TESTDIR/helpers-testrepo.sh"
	$ check_code="$TESTDIR"/../contrib/check-code.py			$ check_code="$TESTDIR"/../contrib/check-code.py
	$ cd "$TESTDIR"/..			$ cd "$TESTDIR"/..

	New errors are not allowed. Warnings are strongly discouraged.			New errors are not allowed. Warnings are strongly discouraged.
	(The writing "no-che?k-code" is for not skipping this file when checking.)			(The writing "no-che?k-code" is for not skipping this file when checking.)

	$ testrepohg locate \			$ testrepohg locate \
	> -X contrib/python-zstandard \			> -X contrib/python-zstandard \
	> -X hgext/fsmonitor/pywatchman \			> -X hgext/fsmonitor/pywatchman \
	> -X mercurial/thirdparty \			> -X mercurial/thirdparty \
	> \| sed 's-\\-/-g' \| "$check_code" --warnings --per-file=0 - \|\| false			> \| sed 's-\\-/-g' \| "$check_code" --warnings --per-file=0 - \|\| false
	Skipping contrib/packaging/hgpackaging/downloads.py it has no-che?k-code (glob)			Skipping contrib/packaging/hgpackaging/downloads.py it has no-che?k-code (glob)
				Skipping contrib/packaging/hgpackaging/inno.py it has no-che?k-code (glob)
	Skipping contrib/packaging/hgpackaging/util.py it has no-che?k-code (glob)			Skipping contrib/packaging/hgpackaging/util.py it has no-che?k-code (glob)
	Skipping contrib/packaging/inno/build.py it has no-che?k-code (glob)			Skipping contrib/packaging/inno/build.py it has no-che?k-code (glob)
	Skipping i18n/polib.py it has no-che?k-code (glob)			Skipping i18n/polib.py it has no-che?k-code (glob)
	Skipping mercurial/statprof.py it has no-che?k-code (glob)			Skipping mercurial/statprof.py it has no-che?k-code (glob)
	Skipping tests/badserverext.py it has no-che?k-code (glob)			Skipping tests/badserverext.py it has no-che?k-code (glob)

	@commands in debugcommands.py should be in alphabetical order.			@commands in debugcommands.py should be in alphabetical order.

Diff	ID	Description	Created	Lint	Unit
Base		Base
Diff 1	14394		Mar 7 2019, 7:49 PM	★	★
Diff 2	14442	rHGdc7827a9ba64b1e557288ae05c638de27fc1be7b	Mar 7 2019, 6:43 PM	★	★