This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8477

packaging: support building WiX installers with PyOxidizer
ClosedPublic

Authored by indygreg on Apr 21 2020, 10:39 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG234882d17814: packaging: support building WiX installers with PyOxidizer
rHGc9517d9d3ae7: packaging: support building WiX installers with PyOxidizer
Summary

We initially implemented PyOxidizer support for Inno installers.
That did most of the heavy work of integrating PyOxidizer into
the packaging system. Implementing WiX installer support was
pretty straightforward.

Aspects of this patch look very similar to Inno's.

The main difference is the handling of the Visual C++
Redistributable Runtime files.

The WiX installer was formerly using merge modules to
install the VC++ 9.0 runtime because this feature is
supported by the WiX installer (it isn't easily available
to Inno installers).

Our strategy for the runtime files is to install the
vcruntime140.dll file next to hg.exe just like any other
file. While we could leverage WiX's functionality for invoking
a VCRedist installer, I don't want to deal with the complexity
at this juncture. So, we let run_pyoxidizer() copy vcruntime140.dll
into the staging directory (like it does for Inno) and our
dynamic WiX XML generator picks it up as a regular file and
installs it.

We did, however, have to teach mercurial.wxs how to conditionally
use the merge modules. But this was rather straightforward.

Comparing the file layout of the WiX installers before and
after:

  • Various lib/*.{pyd, dll} files no longer exist
  • python27.dll was replaced by python37.dll
  • vcruntime140.dll was added

All these changes are expected due to the transition to
Python 3 and to PyOxidizer, which embeded the .pyd and .dll files
in hg.exe.

Diff Detail

Repository
rHG Mercurial
Branch
stable
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

indygreg created this revision.Apr 21 2020, 10:39 PM
durin42 added a subscriber: durin42.Apr 23 2020, 1:59 PM

Clarifying: we can still build hg-with-2.x as a traditional install, and can also do PyOxidizer 3.x? or do we lose 2.x support when we land this series?

indygreg added a comment.Apr 23 2020, 4:38 PM
In D8477#126516, @durin42 wrote:

Clarifying: we can still build hg-with-2.x as a traditional install, and can also do PyOxidizer 3.x? or do we lose 2.x support when we land this series?

We can still do both. Although the filenames of the installers collide. I have some patches queued up that differentiate the installer names to indicate Python 2/3. And I also have some changes to contrib/automation to teach that system to generate Python 3 artifacts.

The goal is to produce Python 2 and 3 variants for the Windows artifacts and distribute those for 5.4. Sometime later (hopefully 5.5!) we can rip out Python 2 support.

indygreg updated this revision to Diff 21220.Apr 24 2020, 6:20 PM
mharbison72 added a subscriber: mharbison72.Apr 26 2020, 10:53 PM

This may not be a big deal, and I'm not sure that this patch is the cause. When I built the py2 installer with py -3 contrib\packaging\packaging.py wix --python C:\Python2717\python.exe, I got a 25K hg.exe in the dist directory with all of the installers that had a mod time 1 minute before the installer. I don't remember seeing this when I was building installers at the end of January. (It also has screwy output, but that's a different issue)

C:\Users\Matt\hg>C:\Users\Matt\hg\dist\hg.exe version
Traceback (most recent call last):
  File "hg", line 43, in <module>
    dispatch.run()
  File "mercurial\dispatch.pyc", line 112, in run

  File "mercurial\dispatch.pyc", line 271, in dispatch

  File "mercurial\ui.pyc", line 308, in load
    >>> u.configbytes(s, b'invalid')
  File "mercurial\rcutil.pyc", line 99, in rccomponents

  File "mercurial\rcutil.pyc", line 69, in default_rc_resources

  File "mercurial\utils\resourceutil.pyc", line 97, in contents

WindowsError: [Error 3] The system cannot find the path specified: 'C:\\Users\\Matt\\hg\\dist\\defaultrc\\*.*'
mharbison72 added a comment.Apr 26 2020, 11:36 PM

I'm trying to build this with PyOxidizer and get an error after upgrading to v0.7.0. I wonder if some of the references in rust/hgcli/Cargo.lock need to be updated from 0.7.0-pre. Here's the command output:

C:\Users\Matt\hg>py -3 contrib\packaging\packaging.py wix --pyoxidizer-target x86_64-pc-windows-msvc
downloading https://versaweb.dl.sourceforge.net/project/gnuwin32/gettext/0.14.4/gettext-0.14.4-bin.zip to C:\Users\Matt\hg\build\wix-x86_64-pc-windows-msvc\gettext-0.14.4-bin.zip
C:\Users\Matt\hg\build\wix-x86_64-pc-windows-msvc\gettext-0.14.4-bin.zip exists and passes integrity checks
downloading https://versaweb.dl.sourceforge.net/project/gnuwin32/gettext/0.14.4/gettext-0.14.4-dep.zip to C:\Users\Matt\hg\build\wix-x86_64-pc-windows-msvc\gettext-0.14.4-dep.zip
C:\Users\Matt\hg\build\wix-x86_64-pc-windows-msvc\gettext-0.14.4-dep.zip exists and passes integrity checks
resolving 1 targets
resolving target app_windows
resolving target distribution_windows
resolving target exe_windows
resolving Python distribution Url { url: "https://github.com/indygreg/python-build-standalone/releases/download/20200408/cpython-3.7.7-windows-amd64-shared-pgo-20200409T0115.tar.zst", sha256: "c43c44ebfe9b9f9c59c12481a6233b17bc9a4ad965f8f0dc0063abff4dc59875" }
Python distribution available at C:\Users\Matt\hg\build\pyoxidizer\python_distributions\cpython-3.7.7-windows-amd64-shared-pgo-20200409T0115.tar.zst
reading data from Python distribution...
pip installing to C:\Users\Matt\AppData\Local\Temp\pyoxidizer-pip-install.ILmZHu00Qhwj\install
Non-user install due to --prefix or --target option
Created temporary directory: C:\Users\Matt\AppData\Local\Temp\pip-target-7s2381ds
Created temporary directory: C:\Users\Matt\AppData\Local\Temp\pip-ephem-wheel-cache-wv7fdx_0
Created temporary directory: C:\Users\Matt\AppData\Local\Temp\pip-req-tracker-2zs2cynh
Initialized build tracking at C:\Users\Matt\AppData\Local\Temp\pip-req-tracker-2zs2cynh
Created build tracker: C:\Users\Matt\AppData\Local\Temp\pip-req-tracker-2zs2cynh
Entered build tracker: C:\Users\Matt\AppData\Local\Temp\pip-req-tracker-2zs2cynh
Created temporary directory: C:\Users\Matt\AppData\Local\Temp\pip-install-i2r5lvpe
Processing c:\users\matt\hg
  Created temporary directory: C:\Users\Matt\AppData\Local\Temp\pip-req-build-2l899b53
ERROR: Could not install packages due to an EnvironmentError.
Traceback (most recent call last):
  File "C:\Users\Matt\hg\build\pyoxidizer\python_distributions\python.c43c44ebfe9b\python\install\lib\site-packages\pip-20.0.2-py3.7.egg\pip\_internal\commands\install.py", line 331, in run
    resolver.resolve(requirement_set)
  File "C:\Users\Matt\hg\build\pyoxidizer\python_distributions\python.c43c44ebfe9b\python\install\lib\site-packages\pip-20.0.2-py3.7.egg\pip\_internal\legacy_resolve.py", line 177, in resolve
    discovered_reqs.extend(self._resolve_one(requirement_set, req))
  File "C:\Users\Matt\hg\build\pyoxidizer\python_distributions\python.c43c44ebfe9b\python\install\lib\site-packages\pip-20.0.2-py3.7.egg\pip\_internal\legacy_resolve.py", line 333, in _resolve_one
    abstract_dist = self._get_abstract_dist_for(req_to_install)
  File "C:\Users\Matt\hg\build\pyoxidizer\python_distributions\python.c43c44ebfe9b\python\install\lib\site-packages\pip-20.0.2-py3.7.egg\pip\_internal\legacy_resolve.py", line 282, in _get_abstract_dist_for
    abstract_dist = self.preparer.prepare_linked_requirement(req)
  File "C:\Users\Matt\hg\build\pyoxidizer\python_distributions\python.c43c44ebfe9b\python\install\lib\site-packages\pip-20.0.2-py3.7.egg\pip\_internal\operations\prepare.py", line 482, in prepare_linked_requirement
    hashes=hashes,
  File "C:\Users\Matt\hg\build\pyoxidizer\python_distributions\python.c43c44ebfe9b\python\install\lib\site-packages\pip-20.0.2-py3.7.egg\pip\_internal\operations\prepare.py", line 278, in unpack_url
    return unpack_file_url(link, location, download_dir, hashes=hashes)
  File "C:\Users\Matt\hg\build\pyoxidizer\python_distributions\python.c43c44ebfe9b\python\install\lib\site-packages\pip-20.0.2-py3.7.egg\pip\_internal\operations\prepare.py", line 224, in unpack_file_url
    _copy_source_tree(link_path, location)
  File "C:\Users\Matt\hg\build\pyoxidizer\python_distributions\python.c43c44ebfe9b\python\install\lib\site-packages\pip-20.0.2-py3.7.egg\pip\_internal\operations\prepare.py", line 207, in _copy_source_tree
    shutil.copytree(source, target, **kwargs)
  File "C:\Users\Matt\hg\build\pyoxidizer\python_distributions\python.c43c44ebfe9b\python\install\lib\shutil.py", line 368, in copytree
    raise Error(errors)
shutil.Error: [('C:\\Users\\Matt\\hg\\.hg\\wcache\\checklink', 'C:\\Users\\Matt\\AppData\\Local\\Temp\\pip-req-build-2l899b53\\.hg\\wcache\\checklink', "[Errno 22] Invalid argument: 'C:\\\\Users\\\\Matt\\\\hg\\\\.hg\\\\wcache\\\\checklink'"), ('C:\\Users\\Matt\\hg\\build\\pyoxidizer\\python_distributions\\python.86a3260edabeed314c6f32a931e60dd097fa854b1346561443353e1bc90e3edd\\python\\install\\Lib\\site-packages\\pip-19.3.1-py3.7.egg\\pip\\_vendor\\urllib3\\contrib\\_securetransport', 'C:\\Users\\Matt\\AppData\\Local\\Temp\\pip-req-build-2l899b53\\build\\pyoxidizer\\python_distributions\\python.86a3260edabeed314c6f32a931e60dd097fa854b1346561443353e1bc90e3edd\\python\\install\\Lib\\site-packages\\pip-19.3.1-py3.7.egg\\pip\\_vendor\\urllib3\\contrib\\_securetransport', "[WinError 3] The system cannot find the path specified: 'C:\\\\Users\\\\Matt\\\\AppData\\\\Local\\\\Temp\\\\pip-req-build-2l899b53\\\\build\\\\pyoxidizer\\\\python_distributions\\\\python.86a3260edabeed314c6f32a931e60dd097fa854b1346561443353e1bc90e3edd\\\\python\\\\install\\\\Lib\\\\site-packages\\\\pip-19.3.1-py3.7.egg\\\\pip\\\\_vendor\\\\urllib3\\\\contrib\\\\_securetransport'"), ('C:\\Users\\Matt\\hg\\build\\pyoxidizer\\python_distributions\\python.86a3260edabeed314c6f32a931e60dd097fa854b1346561443353e1bc90e3edd\\python\\install\\Lib\\site-packages\\pip-19.3.1-py3.7.egg\\pip\\_vendor\\urllib3\\packages', 'C:\\Users\\Matt\\AppData\\Local\\Temp\\pip-req-build-2l899b53\\build\\pyoxidizer\\python_distributions\\python.86a3260edabeed314c6f32a931e60dd097fa854b1346561443353e1bc90e3edd\\python\\install\\Lib\\site-packages\\pip-19.3.1-py3.7.egg\\pip\\_vendor\\urllib3\\packages', "[WinError 206] The filename or extension is too long: 'C:\\\\Users\\\\Matt\\\\AppData\\\\Local\\\\Temp\\\\pip-req-build-2l899b53\\\\build\\\\pyoxidizer\\\\python_distributions\\\\python.86a3260edabeed314c6f32a931e60dd097fa854b1346561443353e1bc90e3edd\\\\python\\\\install\\\\Lib\\\\site-packages\\\\pip-19.3.1-py3.7.egg\\\\pip\\\\_vendor\\\\urllib3\\\\packages'")]
Cleaning up...
Removed build tracker: 'C:\\Users\\Matt\\AppData\\Local\\Temp\\pip-req-tracker-2zs2cynh'
error[PIP_INSTALL_ERROR]: error running pip install: error running pip
  --> C:\Users\Matt\hg\rust\hgcli\pyoxidizer.bzl:39:21
   |
39 |     for resource in dist.pip_install(["--verbose", ROOT]):
   |                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ pip_install()


error: error running pip install: error running pip
contrib/packaging/hgpackaging/cli.py
133

Does this have to be run from a specific Visual Studio command prompt, such that this can be inferred from the environment?

indygreg added a commit: rHGc9517d9d3ae7: packaging: support building WiX installers with PyOxidizer.Apr 30 2020, 1:52 AM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHGc9517d9d3ae7: packaging: support building WiX installers with PyOxidizer (authored by indygreg). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 21209

contrib/packaging/hgpackaging/cli.py

else: else:
inno.build_with_py2exe( inno.build_with_py2exe(
SOURCE_DIR, build_dir, pathlib.Path(python), iscc, version=version, SOURCE_DIR, build_dir, pathlib.Path(python), iscc, version=version,
) )
def build_wix( def build_wix(
name=None, name=None,
pyoxidizer_target=None,
python=None, python=None,
version=None, version=None,
sign_sn=None, sign_sn=None,
sign_cert=None, sign_cert=None,
sign_password=None, sign_password=None,
sign_timestamp_url=None, sign_timestamp_url=None,
extra_packages_script=None, extra_packages_script=None,
extra_wxs=None, extra_wxs=None,
extra_features=None, extra_features=None,
): ):
if not pyoxidizer_target and not python:
raise Exception("--python required unless building with PyOxidizer")
if python and not os.path.isabs(python):
raise Exception("--python arg must be an absolute path")
kwargs = { kwargs = {
"source_dir": SOURCE_DIR, "source_dir": SOURCE_DIR,
"python_exe": pathlib.Path(python),
"version": version, "version": version,
} }
if not os.path.isabs(python): if pyoxidizer_target:
raise Exception("--python arg must be an absolute path") fn = wix.build_installer_pyoxidizer
kwargs["target_triple"] = pyoxidizer_target
else:
fn = wix.build_installer_py2exe
kwargs["python_exe"] = pathlib.Path(python)
if extra_packages_script: if extra_packages_script:
if pyoxidizer_target:
raise Exception(
"pyoxidizer does not support --extra-packages-script"
)
kwargs["extra_packages_script"] = extra_packages_script kwargs["extra_packages_script"] = extra_packages_script
if extra_wxs: if extra_wxs:
kwargs["extra_wxs"] = dict( kwargs["extra_wxs"] = dict(
thing.split("=") for thing in extra_wxs.split(",") thing.split("=") for thing in extra_wxs.split(",")
) )
if extra_features: if extra_features:
kwargs["extra_features"] = extra_features.split(",") kwargs["extra_features"] = extra_features.split(",")
if sign_sn or sign_cert: if sign_sn or sign_cert:
kwargs["signing_info"] = { kwargs["signing_info"] = {
"name": name, "name": name,
"subject_name": sign_sn, "subject_name": sign_sn,
"cert_path": sign_cert, "cert_path": sign_cert,
"cert_password": sign_password, "cert_password": sign_password,
"timestamp_url": sign_timestamp_url, "timestamp_url": sign_timestamp_url,
} }
wix.build_installer(**kwargs) fn(**kwargs)
def get_parser(): def get_parser():
parser = argparse.ArgumentParser() parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers() subparsers = parser.add_subparsers()
sp = subparsers.add_parser("inno", help="Build Inno Setup installer") sp = subparsers.add_parser("inno", help="Build Inno Setup installer")
) )
sp.set_defaults(func=build_inno) sp.set_defaults(func=build_inno)
sp = subparsers.add_parser( sp = subparsers.add_parser(
"wix", help="Build Windows installer with WiX Toolset" "wix", help="Build Windows installer with WiX Toolset"
) )
sp.add_argument("--name", help="Application name", default="Mercurial") sp.add_argument("--name", help="Application name", default="Mercurial")
sp.add_argument( sp.add_argument(
"--python", help="Path to Python executable to use", required=True "--pyoxidizer-target",
choices={"i686-pc-windows-msvc", "x86_64-pc-windows-msvc"},
mharbison72Unsubmitted
Not Done

Does this have to be run from a specific Visual Studio command prompt, such that this can be inferred from the environment?

mharbison72: Does this have to be run from a specific Visual Studio command prompt, such that this can be…
help="Build with PyOxidizer targeting this host triple",
) )
sp.add_argument("--python", help="Path to Python executable to use")
sp.add_argument( sp.add_argument(
"--sign-sn", "--sign-sn",
help="Subject name (or fragment thereof) of certificate " help="Subject name (or fragment thereof) of certificate "
"to use for signing", "to use for signing",
) )
sp.add_argument( sp.add_argument(
"--sign-cert", help="Path to certificate to use for signing" "--sign-cert", help="Path to certificate to use for signing"
) )

contrib/packaging/hgpackaging/wix.py

import uuid import uuid
import xml.dom.minidom import xml.dom.minidom
from .downloads import download_entry from .downloads import download_entry
from .py2exe import ( from .py2exe import (
build_py2exe, build_py2exe,
stage_install, stage_install,
) )
from .pyoxidizer import run_pyoxidizer
from .util import ( from .util import (
extract_zip_to_directory, extract_zip_to_directory,
normalize_windows_version, normalize_windows_version,
process_install_rules, process_install_rules,
sign_with_signtool, sign_with_signtool,
) )
for k, v in sorted(metadata.items()): for k, v in sorted(metadata.items()):
shortcut.setAttribute(k, v) shortcut.setAttribute(k, v)
el.appendChild(shortcut) el.appendChild(shortcut)
return doc.toprettyxml() return doc.toprettyxml()
def build_installer( def build_installer_py2exe(
source_dir: pathlib.Path, source_dir: pathlib.Path,
python_exe: pathlib.Path, python_exe: pathlib.Path,
msi_name='mercurial', msi_name='mercurial',
version=None, version=None,
extra_packages_script=None, extra_packages_script=None,
extra_wxs: typing.Optional[typing.Dict[str, str]] = None, extra_wxs: typing.Optional[typing.Dict[str, str]] = None,
extra_features: typing.Optional[typing.List[str]] = None, extra_features: typing.Optional[typing.List[str]] = None,
signing_info: typing.Optional[typing.Dict[str, str]] = None, signing_info: typing.Optional[typing.Dict[str, str]] = None,
): ):
"""Build a WiX MSI installer. """Build a WiX MSI installer using py2exe.
``source_dir`` is the path to the Mercurial source tree to use. ``source_dir`` is the path to the Mercurial source tree to use.
``arch`` is the target architecture. either ``x86`` or ``x64``. ``arch`` is the target architecture. either ``x86`` or ``x64``.
``python_exe`` is the path to the Python executable to use/bundle. ``python_exe`` is the path to the Python executable to use/bundle.
``version`` is the Mercurial version string. If not defined, ``version`` is the Mercurial version string. If not defined,
``mercurial/__version__.py`` will be consulted. ``mercurial/__version__.py`` will be consulted.
``extra_packages_script`` is a command to be run to inject extra packages ``extra_packages_script`` is a command to be run to inject extra packages
into the py2exe binary. It should stage packages into the virtualenv and into the py2exe binary. It should stage packages into the virtualenv and
p.unlink() p.unlink()
return run_wix_packaging( return run_wix_packaging(
source_dir, source_dir,
build_dir, build_dir,
staging_dir, staging_dir,
arch, arch,
version=version, version=version,
python2=True,
msi_name=msi_name,
extra_wxs=extra_wxs,
extra_features=extra_features,
signing_info=signing_info,
)
def build_installer_pyoxidizer(
source_dir: pathlib.Path,
target_triple: str,
msi_name='mercurial',
version=None,
extra_wxs: typing.Optional[typing.Dict[str, str]] = None,
extra_features: typing.Optional[typing.List[str]] = None,
signing_info: typing.Optional[typing.Dict[str, str]] = None,
):
"""Build a WiX MSI installer using PyOxidizer."""
hg_build_dir = source_dir / "build"
build_dir = hg_build_dir / ("wix-%s" % target_triple)
staging_dir = build_dir / "stage"
arch = "x64" if "x86_64" in target_triple else "x86"
build_dir.mkdir(parents=True, exist_ok=True)
run_pyoxidizer(source_dir, staging_dir, target_triple)
# We also install some extra files.
process_install_rules(EXTRA_INSTALL_RULES, source_dir, staging_dir)
# And remove some files we don't want.
for f in STAGING_REMOVE_FILES:
p = staging_dir / f
if p.exists():
print('removing %s' % p)
p.unlink()
return run_wix_packaging(
source_dir,
build_dir,
staging_dir,
arch,
version,
python2=False,
msi_name=msi_name, msi_name=msi_name,
extra_wxs=extra_wxs, extra_wxs=extra_wxs,
extra_features=extra_features, extra_features=extra_features,
signing_info=signing_info, signing_info=signing_info,
) )
def run_wix_packaging( def run_wix_packaging(
source_dir: pathlib.Path, source_dir: pathlib.Path,
build_dir: pathlib.Path, build_dir: pathlib.Path,
staging_dir: pathlib.Path, staging_dir: pathlib.Path,
arch: str, arch: str,
version: str, version: str,
python2: bool,
msi_name: typing.Optional[str] = "mercurial", msi_name: typing.Optional[str] = "mercurial",
extra_wxs: typing.Optional[typing.Dict[str, str]] = None, extra_wxs: typing.Optional[typing.Dict[str, str]] = None,
extra_features: typing.Optional[typing.List[str]] = None, extra_features: typing.Optional[typing.List[str]] = None,
signing_info: typing.Optional[typing.Dict[str, str]] = None, signing_info: typing.Optional[typing.Dict[str, str]] = None,
): ):
"""Invokes WiX to package up a built Mercurial. """Invokes WiX to package up a built Mercurial.
``signing_info`` is a dict defining properties to facilitate signing the ``signing_info`` is a dict defining properties to facilitate signing the
wix_dir = source_dir / 'contrib' / 'packaging' / 'wix' wix_dir = source_dir / 'contrib' / 'packaging' / 'wix'
wix_pkg, wix_entry = download_entry('wix', build_dir) wix_pkg, wix_entry = download_entry('wix', build_dir)
wix_path = build_dir / ('wix-%s' % wix_entry['version']) 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)
if python2:
ensure_vc90_merge_modules(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
if python2:
defines["PythonVersion"] = "2"
defines['VCRedistSrcDir'] = str(build_dir) defines['VCRedistSrcDir'] = str(build_dir)
else:
defines["PythonVersion"] = "3"
if (staging_dir / "lib").exists():
defines["MercurialHasLib"] = "1"
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))

contrib/packaging/wix/mercurial.wxs

<RegistryValue Root='HKCU' Key='Software\Mercurial\InstallDir' Type='string' <RegistryValue Root='HKCU' Key='Software\Mercurial\InstallDir' Type='string'
Value='[INSTALLDIR]' KeyPath='yes' /> Value='[INSTALLDIR]' KeyPath='yes' />
<Shortcut Id='UrlShortcut' Directory='ProgramMenuDir' Name='Mercurial Web Site' <Shortcut Id='UrlShortcut' Directory='ProgramMenuDir' Name='Mercurial Web Site'
Target='[ARPHELPLINK]' Icon="hgIcon.ico" IconIndex='0' /> Target='[ARPHELPLINK]' Icon="hgIcon.ico" IconIndex='0' />
</Component> </Component>
</Directory> </Directory>
</Directory> </Directory>
<!-- Install VCRedist merge modules on Python 2. On Python 3,
vcruntimeXXX.dll is part of the install layout and gets picked up
as a regular file. -->
<?if $(var.PythonVersion) = "2" ?>
<?if $(var.Platform) = "x86" ?> <?if $(var.Platform) = "x86" ?>
<Merge Id='VCRuntime' DiskId='1' Language='1033' <Merge Id='VCRuntime' DiskId='1' Language='1033'
SourceFile='$(var.VCRedistSrcDir)\microsoft.vcxx.crt.x86_msm.msm' /> SourceFile='$(var.VCRedistSrcDir)\microsoft.vcxx.crt.x86_msm.msm' />
<Merge Id='VCRuntimePolicy' DiskId='1' Language='1033' <Merge Id='VCRuntimePolicy' DiskId='1' Language='1033'
SourceFile='$(var.VCRedistSrcDir)\policy.x.xx.microsoft.vcxx.crt.x86_msm.msm' /> SourceFile='$(var.VCRedistSrcDir)\policy.x.xx.microsoft.vcxx.crt.x86_msm.msm' />
<?else?> <?else?>
<Merge Id='VCRuntime' DiskId='1' Language='1033' <Merge Id='VCRuntime' DiskId='1' Language='1033'
SourceFile='$(var.VCRedistSrcDir)\microsoft.vcxx.crt.x64_msm.msm' /> SourceFile='$(var.VCRedistSrcDir)\microsoft.vcxx.crt.x64_msm.msm' />
<Merge Id='VCRuntimePolicy' DiskId='1' Language='1033' <Merge Id='VCRuntimePolicy' DiskId='1' Language='1033'
SourceFile='$(var.VCRedistSrcDir)\policy.x.xx.microsoft.vcxx.crt.x64_msm.msm' /> SourceFile='$(var.VCRedistSrcDir)\policy.x.xx.microsoft.vcxx.crt.x64_msm.msm' />
<?endif?> <?endif?>
<?endif?>
</Directory> </Directory>
<Feature Id='Complete' Title='Mercurial' Description='The complete package' <Feature Id='Complete' Title='Mercurial' Description='The complete package'
Display='expand' Level='1' ConfigurableDirectory='INSTALLDIR' > Display='expand' Level='1' ConfigurableDirectory='INSTALLDIR' >
<Feature Id='MainProgram' Title='Program' Description='Mercurial command line app' <Feature Id='MainProgram' Title='Program' Description='Mercurial command line app'
Level='1' Absent='disallow' > Level='1' Absent='disallow' >
<ComponentRef Id='MainExecutable' /> <ComponentRef Id='MainExecutable' />
<ComponentRef Id='ProgramMenuDir' /> <ComponentRef Id='ProgramMenuDir' />
<ComponentGroupRef Id="hg.group.ROOT" /> <ComponentGroupRef Id="hg.group.ROOT" />
<ComponentGroupRef Id="hg.group.defaultrc" /> <ComponentGroupRef Id="hg.group.defaultrc" />
<ComponentGroupRef Id="hg.group.helptext" /> <ComponentGroupRef Id="hg.group.helptext" />
<?ifdef MercurialHasLib?>
<ComponentGroupRef Id="hg.group.lib" /> <ComponentGroupRef Id="hg.group.lib" />
<?endif?>
<ComponentGroupRef Id="hg.group.templates" /> <ComponentGroupRef Id="hg.group.templates" />
<?if $(var.PythonVersion) = "2" ?>
<MergeRef Id='VCRuntime' /> <MergeRef Id='VCRuntime' />
<MergeRef Id='VCRuntimePolicy' /> <MergeRef Id='VCRuntimePolicy' />
<?endif?>
</Feature> </Feature>
<?ifdef MercurialExtraFeatures?> <?ifdef MercurialExtraFeatures?>
<?foreach EXTRAFEAT in $(var.MercurialExtraFeatures)?> <?foreach EXTRAFEAT in $(var.MercurialExtraFeatures)?>
<FeatureRef Id="$(var.EXTRAFEAT)" /> <FeatureRef Id="$(var.EXTRAFEAT)" />
<?endforeach?> <?endforeach?>
<?endif?> <?endif?>
<Feature Id='Locales' Title='Translations' Description='Translations' Level='1'> <Feature Id='Locales' Title='Translations' Description='Translations' Level='1'>
<ComponentGroupRef Id="hg.group.locale" /> <ComponentGroupRef Id="hg.group.locale" />