This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6179

wix: add support for additional wxs files
ClosedPublic

Authored by durin42 on Apr 2 2019, 10:32 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG978b03d5f66e: wix: add support for additional wxs files
Summary

As with my previous change for an --extra-prebuiild-script, I'm
assuming this is predominantly useful in an enterprise environment
and am only adding this to wix and not also to inno install scripts.

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

durin42 created this revision.Apr 2 2019, 10:32 AM
durin42 updated this revision to Diff 14629.Apr 2 2019, 3:43 PM
Closed by commit rHG978b03d5f66e: wix: add support for additional wxs files (authored by durin42). · Explain WhyApr 2 2019, 4:30 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 14632

contrib/packaging/hgpackaging/wix.py

# wix.py - WiX installer functionality # wix.py - WiX installer 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 re import re
import subprocess import subprocess
import tempfile import tempfile
import typing
import xml.dom.minidom import xml.dom.minidom
from .downloads import ( from .downloads import (
download_entry, download_entry,
) )
from .py2exe import ( from .py2exe import (
build_py2exe, build_py2exe,
) )
f.setAttribute('Name', p.name) f.setAttribute('Name', p.name)
component.appendChild(f) component.appendChild(f)
return doc.toprettyxml() return doc.toprettyxml()
def build_installer(source_dir: pathlib.Path, python_exe: pathlib.Path, def build_installer(source_dir: pathlib.Path, python_exe: pathlib.Path,
msi_name='mercurial', version=None, post_build_fn=None, msi_name='mercurial', version=None, post_build_fn=None,
extra_packages_script=None): extra_packages_script: typing.Optional[str]=None,
extra_wxs:typing.Optional[typing.Dict[str,str]]=None):
"""Build a WiX MSI installer. """Build a WiX MSI installer.
``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.
``post_build_fn`` is a callable that will be called after building ``post_build_fn`` is a callable that will be called after building
Mercurial but before invoking WiX. It can be used to e.g. facilitate Mercurial but before invoking WiX. It can be used to e.g. facilitate
signing. It is passed the paths to the Mercurial source, build, and signing. It is passed the paths to the Mercurial source, build, and
dist directories and the resolved Mercurial version. dist directories and the resolved Mercurial version.
``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
print a null byte followed by a newline-separated list of packages that print a null byte followed by a newline-separated list of packages that
should be included in the exe. should be included in the exe.
``extra_wxs`` is a dict of {wxs_name: working_dir_for_wxs_build}.
""" """
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' wix_dir = source_dir / 'contrib' / 'packaging' / 'wix'
requirements_txt = wix_dir / 'requirements.txt' requirements_txt = wix_dir / 'requirements.txt'
defines = {'Platform': arch} defines = {'Platform': arch}
for wxs, rel_path in SUPPORT_WXS: for wxs, rel_path in SUPPORT_WXS:
wxs = wix_dir / wxs wxs = wix_dir / wxs
wxs_source_dir = source_dir / rel_path wxs_source_dir = source_dir / rel_path
run_candle(wix_path, build_dir, wxs, wxs_source_dir, defines=defines) run_candle(wix_path, build_dir, wxs, wxs_source_dir, defines=defines)
for source, rel_path in sorted((extra_wxs or {}).items()):
run_candle(wix_path, build_dir, source, rel_path, defines=defines)
# candle.exe doesn't like when we have an open handle on the file. # candle.exe doesn't like when we have an open handle on the file.
# So use TemporaryDirectory() instead of NamedTemporaryFile(). # So use TemporaryDirectory() instead of NamedTemporaryFile().
with tempfile.TemporaryDirectory() as td: with tempfile.TemporaryDirectory() as td:
td = pathlib.Path(td) td = pathlib.Path(td)
tf = td / 'library.wxs' tf = td / 'library.wxs'
with tf.open('w') as fh: with tf.open('w') as fh:
fh.write(make_libraries_xml(wix_dir, dist_dir)) fh.write(make_libraries_xml(wix_dir, dist_dir))
'-spdb', '-spdb',
'-o', str(msi_path), '-o', str(msi_path),
] ]
for source, rel_path in SUPPORT_WXS: for source, rel_path in SUPPORT_WXS:
assert source.endswith('.wxs') assert source.endswith('.wxs')
args.append(str(build_dir / ('%s.wixobj' % source[:-4]))) args.append(str(build_dir / ('%s.wixobj' % source[:-4])))
for source, rel_path in sorted((extra_wxs or {}).items()):
assert source.endswith('.wxs')
source = os.path.basename(source)
args.append(str(build_dir / ('%s.wixobj' % source[:-4])))
args.extend([ args.extend([
str(build_dir / 'library.wixobj'), str(build_dir / 'library.wixobj'),
str(build_dir / 'mercurial.wixobj'), str(build_dir / 'mercurial.wixobj'),
]) ])
subprocess.run(args, cwd=str(source_dir), check=True) subprocess.run(args, cwd=str(source_dir), check=True)
print('%s created' % msi_path) print('%s created' % msi_path)
return { return {
'msi_path': msi_path, 'msi_path': msi_path,
} }
def build_signed_installer(source_dir: pathlib.Path, python_exe: pathlib.Path, def build_signed_installer(source_dir: pathlib.Path, python_exe: pathlib.Path,
name: str, version=None, subject_name=None, name: str, version=None, subject_name=None,
cert_path=None, cert_password=None, cert_path=None, cert_password=None,
timestamp_url=None, extra_packages_script=None): timestamp_url=None, extra_packages_script=None,
extra_wxs=None):
"""Build an installer with signed executables.""" """Build an installer with signed executables."""
post_build_fn = make_post_build_signing_fn( post_build_fn = make_post_build_signing_fn(
name, name,
subject_name=subject_name, subject_name=subject_name,
cert_path=cert_path, cert_path=cert_path,
cert_password=cert_password, cert_password=cert_password,
timestamp_url=timestamp_url) timestamp_url=timestamp_url)
info = build_installer(source_dir, python_exe=python_exe, info = build_installer(source_dir, python_exe=python_exe,
msi_name=name.lower(), version=version, msi_name=name.lower(), version=version,
post_build_fn=post_build_fn, post_build_fn=post_build_fn,
extra_packages_script=extra_packages_script) extra_packages_script=extra_packages_script,
extra_wxs=extra_wxs)
description = '%s %s' % (name, version) description = '%s %s' % (name, version)
sign_with_signtool(info['msi_path'], description, sign_with_signtool(info['msi_path'], description,
subject_name=subject_name, cert_path=cert_path, subject_name=subject_name, cert_path=cert_path,
cert_password=cert_password, timestamp_url=timestamp_url) cert_password=cert_password, timestamp_url=timestamp_url)

contrib/packaging/wix/build.py

help='Password for signing certificate') help='Password for signing certificate')
parser.add_argument('--sign-timestamp-url', parser.add_argument('--sign-timestamp-url',
help='URL of timestamp server to use for signing') help='URL of timestamp server to use for signing')
parser.add_argument('--version', parser.add_argument('--version',
help='Version string to use') help='Version string to use')
parser.add_argument('--extra-packages-script', parser.add_argument('--extra-packages-script',
help=('Script to execute to include extra packages in ' help=('Script to execute to include extra packages in '
'py2exe binary.')) 'py2exe binary.'))
parser.add_argument('--extra-wxs',
help='CSV of path_to_wxs_file=working_dir_for_wxs_file')
args = parser.parse_args() args = parser.parse_args()
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
sys.path.insert(0, str(source_dir / 'contrib' / 'packaging')) sys.path.insert(0, str(source_dir / 'contrib' / 'packaging'))
from hgpackaging.wix import ( from hgpackaging.wix import (
build_installer, build_installer,
build_signed_installer, build_signed_installer,
) )
fn = build_installer fn = build_installer
kwargs = { kwargs = {
'source_dir': source_dir, 'source_dir': source_dir,
'python_exe': pathlib.Path(args.python), 'python_exe': pathlib.Path(args.python),
'version': args.version, 'version': args.version,
} }
if args.extra_packages_script: if args.extra_packages_script:
kwargs['extra_packages_script'] = args.extra_packages_script kwargs['extra_packages_script'] = args.extra_packages_script
if args.extra_wxs:
kwargs['extra_wxs'] = dict(
thing.split("=") for thing in args.extra_wxs.split(','))
if args.sign_sn or args.sign_cert: if args.sign_sn or args.sign_cert:
fn = build_signed_installer fn = build_signed_installer
kwargs['name'] = args.name kwargs['name'] = args.name
kwargs['subject_name'] = args.sign_sn kwargs['subject_name'] = args.sign_sn
kwargs['cert_path'] = args.sign_cert kwargs['cert_path'] = args.sign_cert
kwargs['cert_password'] = args.sign_password kwargs['cert_password'] = args.sign_password
kwargs['timestamp_url'] = args.sign_timestamp_url kwargs['timestamp_url'] = args.sign_timestamp_url
fn(**kwargs) fn(**kwargs)