Mercurial > hg
view contrib/packaging/hgpackaging/util.py @ 43516:d053d3f10b6a
packaging: stage installed files for Inno
Previously, the Inno installer maintained its own mapping of
source files to install location. (We have to maintain a
similar mapping in the WiX installer.)
Managing the explicit file layout for Windows packages is
cumbersome and redundant. Every time you want to change the
layout you need to change N locations. We frequently forget
to do this and we only find out when people install Mercurial
from our packages at release time.
This commit starts the process of consolidating and simplifying
the logic for managing the install layout on Windows.
We introduce a list of install layout rules. These are simply
source filenames (which can contain wildcards) and destination
paths.
The Inno packaging code has been updated to assemble all
files into a staging directory that mirrors the final install
layout. The list of files to add to the installer is derived
by walking this staging directory and dynamically emitting
the proper entries for the Inno Setup script.
I diffed the file layout before and after this commit and
there is no difference.
Another benefit of this change is that it facilitates easier
testing of the Windows install layout. Before, in order to
test the final install layout, you needed to build an installer
and run it. Now, you can stage files into the final layout
and test from there, without running the installer. This
should cut down on overhead when changing Windows code.
Differential Revision: https://phab.mercurial-scm.org/D7159
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Wed, 23 Oct 2019 18:39:28 -0700 |
parents | 2372284d9457 |
children | 7c9f63a5cb14 |
line wrap: on
line source
# util.py - Common packaging utility code. # # Copyright 2019 Gregory Szorc <gregory.szorc@gmail.com> # # This software may be used and distributed according to the terms of the # GNU General Public License version 2 or any later version. # no-check-code because Python 3 native. import distutils.version import getpass import glob import os import pathlib import shutil import subprocess import tarfile import zipfile def extract_tar_to_directory(source: pathlib.Path, dest: pathlib.Path): with tarfile.open(source, 'r') as tf: tf.extractall(dest) def extract_zip_to_directory(source: pathlib.Path, dest: pathlib.Path): with zipfile.ZipFile(source, 'r') as zf: zf.extractall(dest) def find_vc_runtime_files(x64=False): """Finds Visual C++ Runtime DLLs to include in distribution.""" winsxs = pathlib.Path(os.environ['SYSTEMROOT']) / 'WinSxS' prefix = 'amd64' if x64 else 'x86' candidates = sorted( p for p in os.listdir(winsxs) if p.lower().startswith('%s_microsoft.vc90.crt_' % prefix) ) for p in candidates: print('found candidate VC runtime: %s' % p) # Take the newest version. version = candidates[-1] d = winsxs / version return [ d / 'msvcm90.dll', d / 'msvcp90.dll', d / 'msvcr90.dll', winsxs / 'Manifests' / ('%s.manifest' % version), ] def windows_10_sdk_info(): """Resolves information about the Windows 10 SDK.""" base = pathlib.Path(os.environ['ProgramFiles(x86)']) / 'Windows Kits' / '10' if not base.is_dir(): raise Exception('unable to find Windows 10 SDK at %s' % base) # Find the latest version. bin_base = base / 'bin' versions = [v for v in os.listdir(bin_base) if v.startswith('10.')] version = sorted(versions, reverse=True)[0] bin_version = bin_base / version return { 'root': base, 'version': version, 'bin_root': bin_version, 'bin_x86': bin_version / 'x86', 'bin_x64': bin_version / 'x64', } def find_signtool(): """Find signtool.exe from the Windows SDK.""" sdk = windows_10_sdk_info() for key in ('bin_x64', 'bin_x86'): p = sdk[key] / 'signtool.exe' if p.exists(): return p raise Exception('could not find signtool.exe in Windows 10 SDK') def sign_with_signtool( file_path, description, subject_name=None, cert_path=None, cert_password=None, timestamp_url=None, ): """Digitally sign a file with signtool.exe. ``file_path`` is file to sign. ``description`` is text that goes in the signature. The signing certificate can be specified by ``cert_path`` or ``subject_name``. These correspond to the ``/f`` and ``/n`` arguments to signtool.exe, respectively. The certificate password can be specified via ``cert_password``. If not provided, you will be prompted for the password. ``timestamp_url`` is the URL of a RFC 3161 timestamp server (``/tr`` argument to signtool.exe). """ if cert_path and subject_name: raise ValueError('cannot specify both cert_path and subject_name') while cert_path and not cert_password: cert_password = getpass.getpass('password for %s: ' % cert_path) args = [ str(find_signtool()), 'sign', '/v', '/fd', 'sha256', '/d', description, ] if cert_path: args.extend(['/f', str(cert_path), '/p', cert_password]) elif subject_name: args.extend(['/n', subject_name]) if timestamp_url: args.extend(['/tr', timestamp_url, '/td', 'sha256']) args.append(str(file_path)) print('signing %s' % file_path) subprocess.run(args, check=True) PRINT_PYTHON_INFO = ''' import platform; print("%s:%s" % (platform.architecture()[0], platform.python_version())) '''.strip() def python_exe_info(python_exe: pathlib.Path): """Obtain information about a Python executable.""" res = subprocess.check_output([str(python_exe), '-c', PRINT_PYTHON_INFO]) arch, version = res.decode('utf-8').split(':') version = distutils.version.LooseVersion(version) return { 'arch': arch, 'version': version, 'py3': version >= distutils.version.LooseVersion('3'), } def process_install_rules( rules: list, source_dir: pathlib.Path, dest_dir: pathlib.Path ): for source, dest in rules: if '*' in source: if not dest.endswith('/'): raise ValueError('destination must end in / when globbing') # We strip off the source path component before the first glob # character to construct the relative install path. prefix_end_index = source[: source.index('*')].rindex('/') relative_prefix = source_dir / source[0:prefix_end_index] for res in glob.glob(str(source_dir / source), recursive=True): source_path = pathlib.Path(res) if source_path.is_dir(): continue rel_path = source_path.relative_to(relative_prefix) dest_path = dest_dir / dest[:-1] / rel_path dest_path.parent.mkdir(parents=True, exist_ok=True) print('copying %s to %s' % (source_path, dest_path)) shutil.copy(source_path, dest_path) # Simple file case. else: source_path = pathlib.Path(source) if dest.endswith('/'): dest_path = pathlib.Path(dest) / source_path.name else: dest_path = pathlib.Path(dest) full_source_path = source_dir / source_path full_dest_path = dest_dir / dest_path full_dest_path.parent.mkdir(parents=True, exist_ok=True) shutil.copy(full_source_path, full_dest_path) print('copying %s to %s' % (full_source_path, full_dest_path))