| hg-reviewers |
py2exe builds are shared between Inno Setup and WIX. We'll
want the logic for performing py2exe builds to be reusable
across the code for both installers.
This commit extracts the py2exe-specific functionality into
its own module.
There's definitely room to customize things further. This will
be done in future commits, as necessary. (I'm not even sure what
customizations WIX will require yet. Presumably a lot.)
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
| Path | Packages | |||
|---|---|---|---|---|
| P | contrib/packaging/hgpackaging/inno.py (98 lines) Copied to contrib/packaging/hgpackaging/py2exe.py | |||
| P | contrib/packaging/hgpackaging/py2exe.py (49 lines) Copied from contrib/packaging/hgpackaging/inno.py | |||
| M | tests/test-check-code.t (1 line) |
| Status | Author | Revision | |
|---|---|---|---|
| Closed | indygreg | ||
| Closed | indygreg | D6100 wix: remove pywin32 | |
| Closed | indygreg | ||
| Closed | indygreg | D6098 wix: restore COPYING.rtf | |
| Closed | indygreg | ||
| Closed | indygreg | ||
| Closed | indygreg | D6095 wix: remove hg.cmd | |
| Closed | indygreg | ||
| Closed | indygreg | ||
| Closed | indygreg | ||
| Closed | indygreg | ||
| Closed | indygreg | ||
| Closed | indygreg | ||
| Closed | indygreg | ||
| Closed | indygreg | ||
| Closed | indygreg | ||
| Closed | indygreg | ||
| Closed | indygreg | ||
| Closed | indygreg |
| # inno.py - Inno Setup functionality. | # inno.py - Inno Setup functionality. | ||||
| # | # | ||||
| # 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. | ||||
| # no-check-code because Python 3 native. | # no-check-code because Python 3 native. | ||||
| import os | import os | ||||
| import pathlib | import pathlib | ||||
| import shutil | import shutil | ||||
| import subprocess | import subprocess | ||||
| from .downloads import ( | from .py2exe import ( | ||||
| download_entry, | build_py2exe, | ||||
| ) | ) | ||||
| from .util import ( | from .util import ( | ||||
| extract_tar_to_directory, | |||||
| extract_zip_to_directory, | |||||
| find_vc_runtime_files, | find_vc_runtime_files, | ||||
| python_exe_info, | |||||
| ) | ) | ||||
| 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. | ||||
| """ | """ | ||||
| if not iscc_exe.exists(): | if not iscc_exe.exists(): | ||||
| raise Exception('%s does not exist' % iscc_exe) | raise Exception('%s does not exist' % iscc_exe) | ||||
| if 'VCINSTALLDIR' not in os.environ: | vc_x64 = r'\x64' in os.environ.get('LIB', '') | ||||
| 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'] | |||||
| py_info = python_exe_info(python_exe) | |||||
| if vc_x64: | |||||
| if py_info['arch'] != '64bit': | |||||
| raise Exception('architecture mismatch: Visual C++ environment ' | |||||
| 'is configured for 64-bit but Python is 32-bit') | |||||
| else: | |||||
| if py_info['arch'] != '32bit': | |||||
| raise Exception('architecture mismatch: Visual C++ environment ' | |||||
| 'is configured for 32-bit but Python is 64-bit') | |||||
| if py_info['py3']: | |||||
| 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) | |||||
| # This assumes Python 2. We don't need virtualenv on Python 3. | |||||
| virtualenv_src_path = build_dir / ( | |||||
| 'virtualenv-%s' % virtualenv_entry['version']) | |||||
| virtualenv_py = virtualenv_src_path / 'virtualenv.py' | |||||
| if not virtualenv_src_path.exists(): | |||||
| extract_tar_to_directory(virtualenv_pkg, build_dir) | |||||
| py2exe_source_path = build_dir / ('py2exe-%s' % py2exe_entry['version']) | |||||
| if not py2exe_source_path.exists(): | |||||
| extract_zip_to_directory(py2exe_pkg, build_dir) | |||||
| 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' / | requirements_txt = (source_dir / 'contrib' / 'packaging' / | ||||
| 'inno' / 'requirements.txt') | '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 | build_py2exe(source_dir, build_dir, python_exe, 'inno', | ||||
| # validated above. | requirements_txt) | ||||
| 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. | # hg.exe depends on VC9 runtime DLLs. Copy those into place. | ||||
| for f in find_vc_runtime_files(vc_x64): | for f in find_vc_runtime_files(vc_x64): | ||||
| if f.name.endswith('.manifest'): | if f.name.endswith('.manifest'): | ||||
| basename = 'Microsoft.VC90.CRT.manifest' | basename = 'Microsoft.VC90.CRT.manifest' | ||||
| else: | else: | ||||
| basename = f.name | basename = f.name | ||||
| # inno.py - Inno Setup functionality. | # py2exe.py - Functionality for performing py2exe builds. | ||||
| # | # | ||||
| # 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. | ||||
| # no-check-code because Python 3 native. | # no-check-code because Python 3 native. | ||||
| import os | import os | ||||
| import pathlib | import pathlib | ||||
| import shutil | |||||
| import subprocess | import subprocess | ||||
| from .downloads import ( | from .downloads import ( | ||||
| download_entry, | download_entry, | ||||
| ) | ) | ||||
| from .util import ( | from .util import ( | ||||
| extract_tar_to_directory, | extract_tar_to_directory, | ||||
| extract_zip_to_directory, | extract_zip_to_directory, | ||||
| find_vc_runtime_files, | |||||
| python_exe_info, | python_exe_info, | ||||
| ) | ) | ||||
| def build(source_dir: pathlib.Path, build_dir: pathlib.Path, | def build_py2exe(source_dir: pathlib.Path, build_dir: pathlib.Path, | ||||
| python_exe: pathlib.Path, iscc_exe: pathlib.Path, | python_exe: pathlib.Path, build_name: str, | ||||
| version=None): | venv_requirements_txt: pathlib.Path): | ||||
| """Build the Inno installer. | """Build Mercurial with py2exe. | ||||
| 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. | ||||
| """ | """ | ||||
| if not iscc_exe.exists(): | |||||
| raise Exception('%s does not exist' % iscc_exe) | |||||
| 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. | ||||
| vc_x64 = r'\x64' in os.environ['LIB'] | vc_x64 = r'\x64' in os.environ['LIB'] | ||||
| build_dir.mkdir(exist_ok=True) | build_dir.mkdir(exist_ok=True) | ||||
| gettext_pkg, gettext_entry = download_entry('gettext', build_dir) | gettext_pkg, gettext_entry = download_entry('gettext', build_dir) | ||||
| gettext_dep_pkg = download_entry('gettext-dep', build_dir)[0] | gettext_dep_pkg = download_entry('gettext-dep', build_dir)[0] | ||||
| virtualenv_pkg, virtualenv_entry = download_entry('virtualenv', build_dir) | virtualenv_pkg, virtualenv_entry = download_entry('virtualenv', build_dir) | ||||
| py2exe_pkg, py2exe_entry = download_entry('py2exe', build_dir) | py2exe_pkg, py2exe_entry = download_entry('py2exe', build_dir) | ||||
| venv_path = build_dir / ('venv-inno-%s' % ('x64' if vc_x64 else 'x86')) | venv_path = build_dir / ('venv-%s-%s' % (build_name, | ||||
| 'x64' if vc_x64 else 'x86')) | |||||
| gettext_root = build_dir / ( | gettext_root = build_dir / ( | ||||
| 'gettext-win-%s' % gettext_entry['version']) | 'gettext-win-%s' % gettext_entry['version']) | ||||
| if not gettext_root.exists(): | if not gettext_root.exists(): | ||||
| extract_zip_to_directory(gettext_pkg, gettext_root) | extract_zip_to_directory(gettext_pkg, gettext_root) | ||||
| extract_zip_to_directory(gettext_dep_pkg, gettext_root) | extract_zip_to_directory(gettext_dep_pkg, gettext_root) | ||||
| print('creating virtualenv with dependencies') | print('creating virtualenv with dependencies') | ||||
| subprocess.run( | subprocess.run( | ||||
| [str(python_exe), str(virtualenv_py), str(venv_path)], | [str(python_exe), str(virtualenv_py), str(venv_path)], | ||||
| check=True) | check=True) | ||||
| venv_python = venv_path / 'Scripts' / 'python.exe' | venv_python = venv_path / 'Scripts' / 'python.exe' | ||||
| venv_pip = venv_path / 'Scripts' / 'pip.exe' | venv_pip = venv_path / 'Scripts' / 'pip.exe' | ||||
| requirements_txt = (source_dir / 'contrib' / 'packaging' / | subprocess.run([str(venv_pip), 'install', '-r', str(venv_requirements_txt)], | ||||
| 'inno' / 'requirements.txt') | |||||
| subprocess.run([str(venv_pip), 'install', '-r', str(requirements_txt)], | |||||
| check=True) | check=True) | ||||
| # Force distutils to use VC++ settings from environment, which was | # Force distutils to use VC++ settings from environment, which was | ||||
| # validated above. | # validated above. | ||||
| env = dict(os.environ) | env = dict(os.environ) | ||||
| env['DISTUTILS_USE_SDK'] = '1' | env['DISTUTILS_USE_SDK'] = '1' | ||||
| env['MSSdk'] = '1' | env['MSSdk'] = '1' | ||||
| print('building Mercurial') | print('building Mercurial') | ||||
| subprocess.run( | subprocess.run( | ||||
| [str(venv_python), 'setup.py', | [str(venv_python), 'setup.py', | ||||
| 'py2exe', '-b', '3' if vc_x64 else '2', | 'py2exe', '-b', '3' if vc_x64 else '2', | ||||
| 'build_doc', '--html'], | 'build_doc', '--html'], | ||||
| cwd=str(source_dir), | cwd=str(source_dir), | ||||
| env=env, | env=env, | ||||
| check=True) | 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) | |||||
| #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/inno.py it has no-che?k-code (glob) | ||||
| Skipping contrib/packaging/hgpackaging/py2exe.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. | ||||