( )⚙ D6139 wix: autogenerate wxs file for library files

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6139

wix: autogenerate wxs file for library files
ClosedPublic

Authored by indygreg on Mar 14 2019, 9:39 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG131d0b7c3940: wix: autogenerate wxs file for library files
Summary

Currently, dist.wxs contains an enumeration of .pyd and .dll
files staged to dist/lib by py2exe.

Having a manual list of files is error prone, as things can
easily get out of sync (as the previous commit demonstrates).
This is especially an issue for TortoiseHG, which ships a
number of custom modules, which may pull in additional dependencies.

Let's prevent this problem from manifesting by dynamically
generating a .wxs file containing the .pyd and .dll files staged
by py2exe.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

indygreg created this revision.Mar 14 2019, 9:39 PM
Closed by commit rHG131d0b7c3940: wix: autogenerate wxs file for library files (authored by indygreg). · Explain WhyMar 15 2019, 11:11 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 14502

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 xml.dom.minidom
from .downloads import ( from .downloads import (
download_entry, download_entry,
) )
from .py2exe import ( from .py2exe import (
build_py2exe, build_py2exe,
) )
from .util import ( from .util import (
sign_with_signtool(dist_dir / 'hg.exe', description, sign_with_signtool(dist_dir / 'hg.exe', description,
subject_name=subject_name, cert_path=cert_path, subject_name=subject_name, cert_path=cert_path,
cert_password=cert_password, cert_password=cert_password,
timestamp_url=timestamp_url) timestamp_url=timestamp_url)
return post_build_sign return post_build_sign
LIBRARIES_XML = '''
<?xml version="1.0" encoding="utf-8"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
<?include {wix_dir}/guids.wxi ?>
<?include {wix_dir}/defines.wxi ?>
<Fragment>
<DirectoryRef Id="INSTALLDIR" FileSource="$(var.SourceDir)">
<Directory Id="libdir" Name="lib" FileSource="$(var.SourceDir)/lib">
<Component Id="libOutput" Guid="$(var.lib.guid)" Win64='$(var.IsX64)'>
</Component>
</Directory>
</DirectoryRef>
</Fragment>
</Wix>
'''.lstrip()
def make_libraries_xml(wix_dir: pathlib.Path, dist_dir: pathlib.Path):
"""Make XML data for library components WXS."""
# We can't use ElementTree because it doesn't handle the
# <?include ?> directives.
doc = xml.dom.minidom.parseString(
LIBRARIES_XML.format(wix_dir=str(wix_dir)))
component = doc.getElementsByTagName('Component')[0]
f = doc.createElement('File')
f.setAttribute('Name', 'library.zip')
f.setAttribute('KeyPath', 'yes')
component.appendChild(f)
lib_dir = dist_dir / 'lib'
for p in sorted(lib_dir.iterdir()):
if not p.name.endswith(('.dll', '.pyd')):
continue
f = doc.createElement('File')
f.setAttribute('Name', p.name)
component.appendChild(f)
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):
"""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,
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)
# candle.exe doesn't like when we have an open handle on the file.
# So use TemporaryDirectory() instead of NamedTemporaryFile().
with tempfile.TemporaryDirectory() as td:
td = pathlib.Path(td)
tf = td / 'library.wxs'
with tf.open('w') as fh:
fh.write(make_libraries_xml(wix_dir, dist_dir))
run_candle(wix_path, build_dir, tf, dist_dir, 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(hg_build_dir)
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 = source_dir / 'dist' / ( msi_path = source_dir / 'dist' / (
'%s-%s-%s.msi' % (msi_name, version, arch)) '%s-%s-%s.msi' % (msi_name, version, arch))
args = [ args = [
str(wix_path / 'light.exe'), str(wix_path / 'light.exe'),
'-nologo', '-nologo',
'-ext', 'WixUIExtension', '-ext', 'WixUIExtension',
'-sw1076', '-sw1076',
'-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])))
args.append(str(build_dir / 'mercurial.wixobj')) args.extend([
str(build_dir / 'library.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,
} }

contrib/packaging/wix/dist.wxs

<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi"> <Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
<?include guids.wxi ?> <?include guids.wxi ?>
<?include defines.wxi ?> <?include defines.wxi ?>
<Fragment> <Fragment>
<DirectoryRef Id="INSTALLDIR" FileSource="$(var.SourceDir)"> <DirectoryRef Id="INSTALLDIR" FileSource="$(var.SourceDir)">
<Component Id="distOutput" Guid="$(var.dist.guid)" Win64='$(var.IsX64)'> <Component Id="distOutput" Guid="$(var.dist.guid)" Win64='$(var.IsX64)'>
<File Name="python27.dll" KeyPath="yes" /> <File Name="python27.dll" KeyPath="yes" />
</Component> </Component>
<Directory Id="libdir" Name="lib" FileSource="$(var.SourceDir)/lib">
<Component Id="libOutput" Guid="$(var.lib.guid)" Win64='$(var.IsX64)'>
<File Name="library.zip" KeyPath="yes" />
<File Name="mercurial.cext.base85.pyd" />
<File Name="mercurial.cext.bdiff.pyd" />
<File Name="mercurial.cext.mpatch.pyd" />
<File Name="mercurial.cext.osutil.pyd" />
<File Name="mercurial.cext.parsers.pyd" />
<File Name="mercurial.thirdparty.zope.interface._zope_interface_coptimizations.pyd" />
<File Name="mercurial.zstd.pyd" />
<File Name="hgext.fsmonitor.pywatchman.bser.pyd" />
<File Name="pyexpat.pyd" />
<File Name="bz2.pyd" />
<File Name="select.pyd" />
<File Name="sqlite3.dll" />
<File Name="tcl85.dll" />
<File Name="tk85.dll" />
<File Name="unicodedata.pyd" />
<File Name="_ctypes.pyd" />
<File Name="_elementtree.pyd" />
<File Name="_testcapi.pyd" />
<File Name="_hashlib.pyd" />
<File Name="_multiprocessing.pyd" />
<File Name="_socket.pyd" />
<File Name="_sqlite3.pyd" />
<File Name="_ssl.pyd" />
<File Name="_tkinter.pyd" />
</Component>
</Directory>
</DirectoryRef> </DirectoryRef>
</Fragment> </Fragment>
</Wix> </Wix>