This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8059

packaging: move the version normalization function to the util module
ClosedPublic

Authored by mharbison72 on Feb 1 2020, 1:48 AM.

Details

Reviewers
indygreg
Group Reviewers
hg-reviewers
Commits
rHGa70108a3d7cc: packaging: move the version normalization function to the util module
Summary

This will be used with Inno as well. Since this module isn't platform specific,
rename to include that this is meant for Windows. (Mac has a different format.)

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.

Revision Contents
Changeset List

Diff 19819

contrib/packaging/hgpackaging/util.py

'root': base, 'root': base,
'version': version, 'version': version,
'bin_root': bin_version, 'bin_root': bin_version,
'bin_x86': bin_version / 'x86', 'bin_x86': bin_version / 'x86',
'bin_x64': bin_version / 'x64', 'bin_x64': bin_version / 'x64',
} }
def normalize_windows_version(version):
"""Normalize Mercurial version string so WiX/Inno accepts it.
Version strings have to be numeric ``A.B.C[.D]`` to conform with MSI's
requirements.
We normalize RC version or the commit count to a 4th version component.
We store this in the 4th component because ``A.B.C`` releases do occur
and we want an e.g. ``5.3rc0`` version to be semantically less than a
``5.3.1rc2`` version. This requires always reserving the 3rd version
component for the point release and the ``X.YrcN`` release is always
point release 0.
In the case of an RC and presence of ``+`` suffix data, we can't use both
because the version format is limited to 4 components. We choose to use
RC and throw away the commit count in the suffix. This means we could
produce multiple installers with the same normalized version string.
>>> normalize_windows_version("5.3")
'5.3.0'
>>> normalize_windows_version("5.3rc0")
'5.3.0.0'
>>> normalize_windows_version("5.3rc1")
'5.3.0.1'
>>> normalize_windows_version("5.3rc1+2-abcdef")
'5.3.0.1'
>>> normalize_windows_version("5.3+2-abcdef")
'5.3.0.2'
"""
if '+' in version:
version, extra = version.split('+', 1)
else:
extra = None
# 4.9rc0
if version[:-1].endswith('rc'):
rc = int(version[-1:])
version = version[:-3]
else:
rc = None
# Ensure we have at least X.Y version components.
versions = [int(v) for v in version.split('.')]
while len(versions) < 3:
versions.append(0)
if len(versions) < 4:
if rc is not None:
versions.append(rc)
elif extra:
# <commit count>-<hash>+<date>
versions.append(int(extra.split('-')[0]))
return '.'.join('%d' % x for x in versions[0:4])
def find_signtool(): def find_signtool():
"""Find signtool.exe from the Windows SDK.""" """Find signtool.exe from the Windows SDK."""
sdk = windows_10_sdk_info() sdk = windows_10_sdk_info()
for key in ('bin_x64', 'bin_x86'): for key in ('bin_x64', 'bin_x86'):
p = sdk[key] / 'signtool.exe' p = sdk[key] / 'signtool.exe'
if p.exists(): if p.exists():

contrib/packaging/hgpackaging/wix.py

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 .util import ( from .util import (
extract_zip_to_directory, extract_zip_to_directory,
normalize_windows_version,
process_install_rules, process_install_rules,
sign_with_signtool, sign_with_signtool,
) )
EXTRA_PACKAGES = { EXTRA_PACKAGES = {
'distutils', 'distutils',
'pygments', 'pygments',
with version_py.open('r', encoding='utf-8') as fh: with version_py.open('r', encoding='utf-8') as fh:
source = fh.read().strip() source = fh.read().strip()
m = re.search('version = b"(.*)"', source) m = re.search('version = b"(.*)"', source)
return m.group(1) return m.group(1)
def normalize_version(version):
"""Normalize Mercurial version string so WiX accepts it.
Version strings have to be numeric ``A.B.C[.D]`` to conform with MSI's
requirements.
We normalize RC version or the commit count to a 4th version component.
We store this in the 4th component because ``A.B.C`` releases do occur
and we want an e.g. ``5.3rc0`` version to be semantically less than a
``5.3.1rc2`` version. This requires always reserving the 3rd version
component for the point release and the ``X.YrcN`` release is always
point release 0.
In the case of an RC and presence of ``+`` suffix data, we can't use both
because the version format is limited to 4 components. We choose to use
RC and throw away the commit count in the suffix. This means we could
produce multiple installers with the same normalized version string.
>>> normalize_version("5.3")
'5.3.0'
>>> normalize_version("5.3rc0")
'5.3.0.0'
>>> normalize_version("5.3rc1")
'5.3.0.1'
>>> normalize_version("5.3rc1+2-abcdef")
'5.3.0.1'
>>> normalize_version("5.3+2-abcdef")
'5.3.0.2'
"""
if '+' in version:
version, extra = version.split('+', 1)
else:
extra = None
# 4.9rc0
if version[:-1].endswith('rc'):
rc = int(version[-1:])
version = version[:-3]
else:
rc = None
# Ensure we have at least X.Y version components.
versions = [int(v) for v in version.split('.')]
while len(versions) < 3:
versions.append(0)
if len(versions) < 4:
if rc is not None:
versions.append(rc)
elif extra:
# <commit count>-<hash>+<date>
versions.append(int(extra.split('-')[0]))
return '.'.join('%d' % x for x in versions[0:4])
def ensure_vc90_merge_modules(build_dir): def ensure_vc90_merge_modules(build_dir):
x86 = ( x86 = (
download_entry( download_entry(
'vc9-crt-x86-msm', 'vc9-crt-x86-msm',
build_dir, build_dir,
local_name='microsoft.vcxx.crt.x86_msm.msm', local_name='microsoft.vcxx.crt.x86_msm.msm',
)[0], )[0],
download_entry( download_entry(
python_exe, python_exe,
'wix', 'wix',
requirements_txt, requirements_txt,
extra_packages=EXTRA_PACKAGES, extra_packages=EXTRA_PACKAGES,
extra_packages_script=extra_packages_script, extra_packages_script=extra_packages_script,
) )
orig_version = version or find_version(source_dir) orig_version = version or find_version(source_dir)
version = normalize_version(orig_version) version = normalize_windows_version(orig_version)
print('using version string: %s' % version) print('using version string: %s' % version)
if version != orig_version: if version != orig_version:
print('(normalized from: %s)' % orig_version) print('(normalized from: %s)' % orig_version)
if post_build_fn: if post_build_fn:
post_build_fn(source_dir, hg_build_dir, dist_dir, version) post_build_fn(source_dir, hg_build_dir, dist_dir, version)
build_dir = hg_build_dir / ('wix-%s' % arch) build_dir = hg_build_dir / ('wix-%s' % arch)