Support building for multiple platforms

This commit is contained in:
Janek Bevendorff 2025-03-10 16:08:08 +01:00
parent a2fd6ccaed
commit 29821e00b6
No known key found for this signature in database
GPG Key ID: 2CF41D2AA8438F99

View File

@ -149,7 +149,7 @@ def _yes_no_prompt(prompt, default_no=True):
def _run(cmd, *args, cwd, path=None, env=None, input=None, capture_output=True, timeout=None, check=True, def _run(cmd, *args, cwd, path=None, env=None, input=None, capture_output=True, timeout=None, check=True,
docker_image=None, docker_privileged=False, docker_mounts=None, **kwargs): docker_image=None, docker_privileged=False, docker_mounts=None, docker_platform=None, **kwargs):
""" """
Run a command and return its output. Run a command and return its output.
Raises an error if ``check`` is ``True`` and the process exited with a non-zero code. Raises an error if ``check`` is ``True`` and the process exited with a non-zero code.
@ -174,6 +174,8 @@ def _run(cmd, *args, cwd, path=None, env=None, input=None, capture_output=True,
docker_cmd.extend([f'--volume={d.absolute()}:{d.absolute()}:rw' for d in docker_mounts]) docker_cmd.extend([f'--volume={d.absolute()}:{d.absolute()}:rw' for d in docker_mounts])
if docker_privileged: if docker_privileged:
docker_cmd.extend(['--cap-add=SYS_ADMIN', '--security-opt=apparmor:unconfined', '--device=/dev/fuse']) docker_cmd.extend(['--cap-add=SYS_ADMIN', '--security-opt=apparmor:unconfined', '--device=/dev/fuse'])
if docker_platform:
docker_cmd.append(f'--platform={docker_platform}')
docker_cmd.append(docker_image) docker_cmd.append(docker_image)
cmd = docker_cmd + cmd cmd = docker_cmd + cmd
@ -502,6 +504,8 @@ class Build(Command):
help='Build target platform (default: %(default)s).', choices=['x86_64', 'arm64']) help='Build target platform (default: %(default)s).', choices=['x86_64', 'arm64'])
elif sys.platform == 'linux': elif sys.platform == 'linux':
parser.add_argument('-d', '--docker-image', help='Run build in Docker image (overrides --use-system-deps).') parser.add_argument('-d', '--docker-image', help='Run build in Docker image (overrides --use-system-deps).')
parser.add_argument('-p', '--platform-target', help='Build target platform (default: %(default)s).',
choices=['x86_64', 'aarch64'], default=platform.uname().machine)
parser.add_argument('-a', '--appimage', help='Build an AppImage.', action='store_true') parser.add_argument('-a', '--appimage', help='Build an AppImage.', action='store_true')
parser.add_argument('-c', '--cmake-opts', nargs=argparse.REMAINDER, parser.add_argument('-c', '--cmake-opts', nargs=argparse.REMAINDER,
@ -626,40 +630,47 @@ class Build(Command):
logger.info('All done! Please don\'t forget to sign the binaries before distribution.') logger.info('All done! Please don\'t forget to sign the binaries before distribution.')
@staticmethod @staticmethod
def _download_tools_if_not_available(toolname, bin_dir, url, docker_image=None): def _download_tools_if_not_available(toolname, bin_dir, url, docker_args=None):
if _run(['which', toolname], cwd=None, check=False, docker_image=docker_image).returncode != 0: if _run(['which', toolname], cwd=None, check=False, **(docker_args or {})).returncode != 0:
logger.info(f'Downloading {toolname}...') logger.info(f'Downloading {toolname}...')
outfile = bin_dir / toolname outfile = bin_dir / toolname
urlretrieve(url, outfile) urlretrieve(url, outfile)
outfile.chmod(outfile.stat().st_mode | stat.S_IEXEC) outfile.chmod(outfile.stat().st_mode | stat.S_IEXEC)
# noinspection PyMethodMayBeStatic
def build_linux(self, version, src_dir, output_dir, *, install_prefix, parallelism, cmake_opts, def build_linux(self, version, src_dir, output_dir, *, install_prefix, parallelism, cmake_opts,
appimage, docker_image, **_): platform_target, appimage, docker_image, **_):
if platform_target != platform.uname().machine and not docker_image:
raise Error('Need --docker-image for platform cross-compilation!')
docker_args = dict(
docker_image=docker_image,
docker_mounts=[src_dir],
docker_platform=f'linux/{platform_target}',
)
if docker_image: if docker_image:
logger.info('Pulling Docker image...') logger.info('Pulling Docker image...')
_run(['docker', 'pull', docker_image], cwd=None, capture_output=False) _run(['docker', 'pull', docker_image], cwd=None, capture_output=False)
with tempfile.TemporaryDirectory() as build_dir: with tempfile.TemporaryDirectory() as build_dir:
logger.info('Configuring build...') logger.info('Configuring build...')
_run(['cmake', *cmake_opts, str(src_dir)], cwd=build_dir, capture_output=False, _run(['cmake', *cmake_opts, str(src_dir)], cwd=build_dir, capture_output=False, **docker_args)
docker_image=docker_image, docker_mounts=[src_dir])
logger.info('Compiling sources...') logger.info('Compiling sources...')
_run(['cmake', '--build', '.', f'--parallel={parallelism}'], cwd=build_dir, capture_output=False, _run(['cmake', '--build', '.', f'--parallel={parallelism}'],
docker_image=docker_image, docker_mounts=[src_dir]) cwd=build_dir, capture_output=False, **docker_args)
logger.info('Bundling AppDir...') logger.info('Bundling AppDir...')
app_dir = Path(build_dir) / f'KeePassXC-{version}.AppDir' app_dir = Path(build_dir) / f'KeePassXC-{version}-{platform_target}.AppDir'
_run(['cmake', '--install', f'--prefix={app_dir / install_prefix}', '--strip'], _run(['cmake', '--install', f'--prefix={app_dir / install_prefix}', '--strip'],
cwd=build_dir, capture_output=False, docker_image=docker_image, docker_mounts=[src_dir]) cwd=build_dir, capture_output=False, **docker_args)
shutil.copytree(app_dir, output_dir / app_dir.name, symlinks=True) shutil.copytree(app_dir, output_dir / app_dir.name, symlinks=True)
if appimage: if appimage:
self._build_linux_appimage( self._build_linux_appimage(
version, src_dir, output_dir, app_dir, build_dir, install_prefix, docker_image) version, src_dir, output_dir, app_dir, build_dir, install_prefix, platform_target, docker_args)
def _build_linux_appimage(self, version, src_dir, output_dir, app_dir, build_dir, install_prefix, docker_image): def _build_linux_appimage(self, version, src_dir, output_dir, app_dir, build_dir, install_prefix,
platform_target, docker_args):
if (app_dir / 'AppRun').exists(): if (app_dir / 'AppRun').exists():
raise Error('AppDir has already been run through linuxdeploy! Please create a fresh AppDir and try again.') raise Error('AppDir has already been run through linuxdeploy! Please create a fresh AppDir and try again.')
@ -667,17 +678,20 @@ class Build(Command):
bin_dir.mkdir() bin_dir.mkdir()
self._download_tools_if_not_available( self._download_tools_if_not_available(
'linuxdeploy', bin_dir, 'linuxdeploy', bin_dir,
'https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage', 'https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/' +
docker_image=docker_image) f'linuxdeploy-{platform_target}.AppImage',
**docker_args)
self._download_tools_if_not_available( self._download_tools_if_not_available(
'linuxdeploy-plugin-qt', bin_dir, 'linuxdeploy-plugin-qt', bin_dir,
'https://github.com/linuxdeploy/linuxdeploy-plugin-qt/releases/download/continuous/' + 'https://github.com/linuxdeploy/linuxdeploy-plugin-qt/releases/download/continuous/' +
'linuxdeploy-plugin-qt-x86_64.AppImage', f'linuxdeploy-plugin-qt-{platform_target}.AppImage',
docker_image=docker_image) **docker_args)
self._download_tools_if_not_available( self._download_tools_if_not_available(
'appimagetool', bin_dir, 'appimagetool', bin_dir,
'https://github.com/AppImage/AppImageKit/releases/download/continuous/appimagetool-x86_64.AppImage', 'https://github.com/AppImage/AppImageKit/releases/download/continuous/' +
docker_image=docker_image) f'appimagetool-{platform_target}.AppImage',
**docker_args)
env_path = ':'.join([bin_dir, _get_bin_path()]) env_path = ':'.join([bin_dir, _get_bin_path()])
desktop_file = app_dir / install_prefix / 'share/applications/org.keepassxc.KeePassXC.desktop' desktop_file = app_dir / install_prefix / 'share/applications/org.keepassxc.KeePassXC.desktop'
icon_file = app_dir / install_prefix / 'share/icons/hicolor/256x256/apps/keepassxc.png' icon_file = app_dir / install_prefix / 'share/icons/hicolor/256x256/apps/keepassxc.png'
@ -687,16 +701,14 @@ class Build(Command):
logger.info('Running linuxdeploy...') logger.info('Running linuxdeploy...')
_run(['linuxdeploy', '--plugin=qt', f'--appdir={app_dir}', f'--custom-apprun={app_run}', _run(['linuxdeploy', '--plugin=qt', f'--appdir={app_dir}', f'--custom-apprun={app_run}',
f'--desktop-file={desktop_file}', f'--icon-file={icon_file}', *executables], f'--desktop-file={desktop_file}', f'--icon-file={icon_file}', *executables],
cwd=build_dir, capture_output=False, path=env_path, cwd=build_dir, capture_output=False, path=env_path, **docker_args)
docker_image=docker_image, docker_mounts=[src_dir])
logger.info('Building AppImage...') logger.info('Building AppImage...')
appimage_name = f'KeePassXC-{version}-{platform.uname().machine}.AppImage' appimage_name = f'KeePassXC-{version}-{platform_target}.AppImage'
desktop_file.write_text(desktop_file.read_text().strip() + f'\nX-AppImage-Version={version}\n') desktop_file.write_text(desktop_file.read_text().strip() + f'\nX-AppImage-Version={version}\n')
_run(['appimagetool', '--updateinformation=gh-releases-zsync|keepassxreboot|keepassxc|latest|' + _run(['appimagetool', '--updateinformation=gh-releases-zsync|keepassxreboot|keepassxc|latest|' +
f'KeePassXC-*-{platform.uname().machine}.AppImage.zsync', str(app_dir), str(output_dir / appimage_name)], f'KeePassXC-*-{platform_target}.AppImage.zsync', str(app_dir), str(output_dir / appimage_name)],
cwd=build_dir, capture_output=False, path=env_path, cwd=build_dir, capture_output=False, path=env_path, **docker_args, docker_privileged=True)
docker_image=docker_image, docker_mounts=[src_dir], docker_privileged=True)
class GPGSign(Command): class GPGSign(Command):