| hg-reviewers |
This is the last bit required to be able to glue extra configs etc into
the installer.
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
| Path | Packages | |||
|---|---|---|---|---|
| M | contrib/packaging/hgpackaging/wix.py (14 lines) | |||
| M | contrib/packaging/wix/build.py (5 lines) | |||
| M | contrib/packaging/wix/mercurial.wxs (5 lines) |
| 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: typing.Optional[str]=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): | |||||
| """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}. | ``extra_wxs`` is a dict of {wxs_name: working_dir_for_wxs_build}. | ||||
| ``extra_features`` is a list of additional named Features to include in | |||||
| the build. These must match Feature names in one of the wxs scripts. | |||||
| """ | """ | ||||
| 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' | ||||
| fh.write(make_libraries_xml(wix_dir, dist_dir)) | fh.write(make_libraries_xml(wix_dir, dist_dir)) | ||||
| run_candle(wix_path, build_dir, tf, dist_dir, defines=defines) | 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) | ||||
| if extra_features: | |||||
| assert all(';' not in f for f in 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 = 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'), | ||||
| '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): | extra_wxs=None, extra_features=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) | extra_wxs=extra_wxs, extra_features=extra_features) | ||||
| 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) | ||||
| 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', | parser.add_argument('--extra-wxs', | ||||
| help='CSV of path_to_wxs_file=working_dir_for_wxs_file') | help='CSV of path_to_wxs_file=working_dir_for_wxs_file') | ||||
| parser.add_argument('--extra-features', | |||||
| help=('CSV of extra feature names to include ' | |||||
| 'in the installer from the extra wxs files')) | |||||
| 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')) | ||||
| '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: | if args.extra_wxs: | ||||
| kwargs['extra_wxs'] = dict( | kwargs['extra_wxs'] = dict( | ||||
| thing.split("=") for thing in args.extra_wxs.split(',')) | thing.split("=") for thing in args.extra_wxs.split(',')) | ||||
| if args.extra_features: | |||||
| kwargs['extra_features'] = args.extra_features.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) | ||||
| <ComponentRef Id='COPYING' /> | <ComponentRef Id='COPYING' /> | ||||
| <ComponentRef Id='mercurial.rc' /> | <ComponentRef Id='mercurial.rc' /> | ||||
| <ComponentRef Id='mergetools.rc' /> | <ComponentRef Id='mergetools.rc' /> | ||||
| <ComponentGroupRef Id='helpFolder' /> | <ComponentGroupRef Id='helpFolder' /> | ||||
| <ComponentGroupRef Id='templatesFolder' /> | <ComponentGroupRef Id='templatesFolder' /> | ||||
| <MergeRef Id='VCRuntime' /> | <MergeRef Id='VCRuntime' /> | ||||
| <MergeRef Id='VCRuntimePolicy' /> | <MergeRef Id='VCRuntimePolicy' /> | ||||
| </Feature> | </Feature> | ||||
| <?if $(var.MercurialExtraFeatures)?> | |||||
| <?foreach EXTRAFEAT in $(var.MercurialExtraFeatures)?> | |||||
| <FeatureRef Id="$(var.EXTRAFEAT)" /> | |||||
| <?endforeach?> | |||||
| <?endif?> | |||||
| <Feature Id='Locales' Title='Translations' Description='Translations' Level='1'> | <Feature Id='Locales' Title='Translations' Description='Translations' Level='1'> | ||||
| <ComponentGroupRef Id='localeFolder' /> | <ComponentGroupRef Id='localeFolder' /> | ||||
| <ComponentRef Id='i18nFolder' /> | <ComponentRef Id='i18nFolder' /> | ||||
| </Feature> | </Feature> | ||||
| <Feature Id='Documentation' Title='Documentation' Description='HTML man pages' Level='1'> | <Feature Id='Documentation' Title='Documentation' Description='HTML man pages' Level='1'> | ||||
| <ComponentGroupRef Id='docFolder' /> | <ComponentGroupRef Id='docFolder' /> | ||||
| </Feature> | </Feature> | ||||
| <Feature Id='Misc' Title='Miscellaneous' Description='Contributed scripts' Level='1'> | <Feature Id='Misc' Title='Miscellaneous' Description='Contributed scripts' Level='1'> | ||||