| hg-reviewers |
Like we did for Inno, we want to split out the building
of Mercurial from invoking the packaging tool so that we
can introduce an alternate build mechanism.
As part of this refactor, there are inconsequential changes
to file layouts. Before, some shared files such as the
WiX binaries and merge modules would be installed under
build/. Now, they are installed under build/wix-*. This
is to keep implementation simpler. But it also helps keep
build state more isolated.
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
| Path | Packages | |||
|---|---|---|---|---|
| M | contrib/packaging/hgpackaging/wix.py (37 lines) |
| ``extra_wxs`` is a dict of {wxs_name: working_dir_for_wxs_build}. | ``extra_wxs`` is a dict of {wxs_name: working_dir_for_wxs_build}. | ||||
| ``extra_features`` is a list of additional named Features to include in | ``extra_features`` is a list of additional named Features to include in | ||||
| the build. These must match Feature names in one of the wxs scripts. | the build. These must match Feature names in one of the wxs scripts. | ||||
| """ | """ | ||||
| arch = 'x64' if r'\x64' in os.environ.get('LIB', '') else 'x86' | arch = 'x64' if r'\x64' in os.environ.get('LIB', '') else 'x86' | ||||
| hg_build_dir = source_dir / 'build' | hg_build_dir = source_dir / 'build' | ||||
| dist_dir = source_dir / 'dist' | dist_dir = source_dir / 'dist' | ||||
| wix_dir = source_dir / 'contrib' / 'packaging' / 'wix' | |||||
| requirements_txt = ( | requirements_txt = ( | ||||
| source_dir / 'contrib' / 'packaging' / 'requirements_win32.txt' | source_dir / 'contrib' / 'packaging' / 'requirements_win32.txt' | ||||
| ) | ) | ||||
| build_py2exe( | build_py2exe( | ||||
| source_dir, | source_dir, | ||||
| hg_build_dir, | hg_build_dir, | ||||
| # And remove some files we don't want. | # And remove some files we don't want. | ||||
| for f in STAGING_REMOVE_FILES: | for f in STAGING_REMOVE_FILES: | ||||
| p = staging_dir / f | p = staging_dir / f | ||||
| if p.exists(): | if p.exists(): | ||||
| print('removing %s' % p) | print('removing %s' % p) | ||||
| p.unlink() | p.unlink() | ||||
| wix_pkg, wix_entry = download_entry('wix', hg_build_dir) | return run_wix_packaging( | ||||
| wix_path = hg_build_dir / ('wix-%s' % wix_entry['version']) | source_dir, | ||||
| build_dir, | |||||
| staging_dir, | |||||
| arch, | |||||
| version=version, | |||||
| orig_version=orig_version, | |||||
| msi_name=msi_name, | |||||
| extra_wxs=extra_wxs, | |||||
| extra_features=extra_features, | |||||
| ) | |||||
| def run_wix_packaging( | |||||
| source_dir: pathlib.Path, | |||||
| build_dir: pathlib.Path, | |||||
| staging_dir: pathlib.Path, | |||||
| arch: str, | |||||
| version: str, | |||||
| orig_version: str, | |||||
| msi_name: typing.Optional[str] = "mercurial", | |||||
| extra_wxs: typing.Optional[typing.Dict[str, str]] = None, | |||||
| extra_features: typing.Optional[typing.List[str]] = None, | |||||
| ): | |||||
| """Invokes WiX to package up a built Mercurial.""" | |||||
| wix_dir = source_dir / 'contrib' / 'packaging' / 'wix' | |||||
| wix_pkg, wix_entry = download_entry('wix', build_dir) | |||||
| wix_path = build_dir / ('wix-%s' % wix_entry['version']) | |||||
| if not wix_path.exists(): | if not wix_path.exists(): | ||||
| extract_zip_to_directory(wix_pkg, wix_path) | extract_zip_to_directory(wix_pkg, wix_path) | ||||
| ensure_vc90_merge_modules(hg_build_dir) | ensure_vc90_merge_modules(build_dir) | ||||
| source_build_rel = pathlib.Path(os.path.relpath(source_dir, build_dir)) | source_build_rel = pathlib.Path(os.path.relpath(source_dir, build_dir)) | ||||
| defines = {'Platform': arch} | defines = {'Platform': arch} | ||||
| # Derive a .wxs file with the staged files. | # Derive a .wxs file with the staged files. | ||||
| manifest_wxs = build_dir / 'stage.wxs' | manifest_wxs = build_dir / 'stage.wxs' | ||||
| with manifest_wxs.open('w', encoding='utf-8') as fh: | with manifest_wxs.open('w', encoding='utf-8') as fh: | ||||
| fh.write(make_files_xml(staging_dir, is_x64=arch == 'x64')) | fh.write(make_files_xml(staging_dir, is_x64=arch == 'x64')) | ||||
| run_candle(wix_path, build_dir, manifest_wxs, staging_dir, defines=defines) | run_candle(wix_path, build_dir, manifest_wxs, staging_dir, defines=defines) | ||||
| for source, rel_path in sorted((extra_wxs or {}).items()): | for source, rel_path in sorted((extra_wxs or {}).items()): | ||||
| run_candle(wix_path, build_dir, source, rel_path, defines=defines) | run_candle(wix_path, build_dir, source, rel_path, defines=defines) | ||||
| source = wix_dir / 'mercurial.wxs' | source = wix_dir / 'mercurial.wxs' | ||||
| defines['Version'] = version | defines['Version'] = version | ||||
| defines['Comments'] = 'Installs Mercurial version %s' % version | defines['Comments'] = 'Installs Mercurial version %s' % version | ||||
| defines['VCRedistSrcDir'] = str(hg_build_dir) | defines['VCRedistSrcDir'] = str(build_dir) | ||||
| if extra_features: | if extra_features: | ||||
| assert all(';' not in f for f in extra_features) | assert all(';' not in f for f in extra_features) | ||||
| defines['MercurialExtraFeatures'] = ';'.join(extra_features) | defines['MercurialExtraFeatures'] = ';'.join(extra_features) | ||||
| run_candle(wix_path, build_dir, source, source_build_rel, defines=defines) | run_candle(wix_path, build_dir, source, source_build_rel, defines=defines) | ||||
| msi_path = ( | msi_path = ( | ||||
| source_dir / 'dist' / ('%s-%s-%s.msi' % (msi_name, orig_version, arch)) | source_dir / 'dist' / ('%s-%s-%s.msi' % (msi_name, orig_version, arch)) | ||||