Skip to content
Snippets Groups Projects
run.py 51.1 KiB
Newer Older
Simon McVittie's avatar
Simon McVittie committed
#!/usr/bin/python3

# flatdeb — build Flatpak runtimes from Debian packages
#
# Copyright © 2016-2017 Simon McVittie
# Copyright © 2017 Collabora Ltd.
#
# Partially derived from vectis, copyright © 2015-2017 Simon McVittie
#
# SPDX-License-Identifier: MIT
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

"""
Create Flatpak runtimes from Debian packages.

Requires (on host):
    - flatpak
    - ostree
    - python3
    - python3-gi
    - python3-yaml
Simon McVittie's avatar
Simon McVittie committed
    - sshfs (if worker is remote)

Requires (on worker, possibly the same machine as the host):
Simon McVittie's avatar
Simon McVittie committed
    - Debian 9 'stretch'
    - debootstrap
    - flatpak
Simon McVittie's avatar
Simon McVittie committed
    - flatpak-builder
    - ostree
    - sudo
    - systemd-container
Simon McVittie's avatar
Simon McVittie committed
    - time
Simon McVittie's avatar
Simon McVittie committed
"""

import argparse
import json
import os
import re
import subprocess
import urllib.parse
Simon McVittie's avatar
Simon McVittie committed
from contextlib import ExitStack, suppress
from tempfile import TemporaryDirectory

import yaml
from gi.repository import GLib

from flatdeb.worker import HostWorker, NspawnWorker, SshWorker, SudoWorker


class Builder:

    """
    Main object
    """

    def __init__(self):
        #: The Debian suite to use
        self.apt_suite = 'stretch'
        #: The Flatpak branch to use for the runtime, or None for apt_suite
        self.runtime_branch = None
        #: The Flatpak branch to use for the app
        self.app_branch = 'master'
Simon McVittie's avatar
Simon McVittie committed
        #: The freedesktop.org cache directory
        self.xdg_cache_dir = os.getenv(
            'XDG_CACHE_DIR', os.path.expanduser('~/.cache'))
        self.remote_repo = None
        #: Where to write output
        self.build_area = os.path.join(
            self.xdg_cache_dir, 'flatdeb',
        )
        self.remote_build_area = None
        self.repo = os.path.join(self.build_area, 'repo')

        self.__dpkg_arch = None
        self.flatpak_arch = None

        self.__dpkg_arch_matches_cache = {}
        self.suite_details = {}
        self.runtime_details = {}
        self.root_worker = None
        self.worker = None
        self.remote_ostree_mode = None
        self.ostree_mode = 'archive-z2'
        self.export_bundles = False
Simon McVittie's avatar
Simon McVittie committed

    @staticmethod
    def get_flatpak_arch(arch=None):
        """
        Return the Flatpak architecture name corresponding to uname
        result arch.

        If arch is None, return the Flatpak architecture name
        corresponding to the machine where this script is running.
        """

        if arch is None:
            arch = os.uname()[4]

        if re.match(r'^i.86$', arch):
            return 'i386'
        elif re.match(r'^arm.*', arch):
            if arch.endswith('b'):
                return 'armeb'
            else:
                return 'arm'
        elif arch in ('mips', 'mips64'):
            import struct
            if struct.pack('i', 1).startswith(b'\x01'):
                return arch + 'el'

        return arch

    @staticmethod
    def dpkg_to_flatpak_arch(arch):
        """
        Return the Flatpak architecture name corresponding to the given
        dpkg architecture name.
        """

        if arch == 'amd64':
            return 'x86_64'
        elif arch == 'arm64':
            return 'aarch64'
        elif arch in ('armel', 'armhf'):
            return 'arm'
        elif arch == 'powerpc':
            return 'ppc'
        elif arch == 'powerpc64':
            return 'ppc64'
        elif arch == 'powerpcel':
            return 'ppcle'
        elif arch == 'ppc64el':
            return 'ppc64le'

        return arch

    @property
    def dpkg_arch(self):
        """
        The Debian architecture we are building a runtime for, such as
        i386 or amd64.
        """
        return self.__dpkg_arch

    @dpkg_arch.setter
    def dpkg_arch(self, value):
        self.__dpkg_arch_matches_cache = {}
        self.__dpkg_arch = value

    def dpkg_arch_matches(self, arch_spec):
        """
        Return True if arch_spec matches dpkg_arch (or
        equivalently, if dpkg_arch is one of the architectures
        described by arch_spec). For example, any-amd64 matches amd64
        but not i386.
        """
        if arch_spec not in self.__dpkg_arch_matches_cache:
            exit_code = self.worker.call(
                ['dpkg-architecture', '--host-arch', self.dpkg_arch,
                 '--is', arch_spec])
            self.__dpkg_arch_matches_cache[arch_spec] = (exit_code == 0)

        return self.__dpkg_arch_matches_cache[arch_spec]

    def run_command_line(self):
        """
        Run appropriate commands for the command-line arguments
        """
        parser = argparse.ArgumentParser(
            description='Build Flatpak runtimes',
        )
        parser.add_argument('--remote', default=None)
        parser.add_argument(
            '--ostree-mode', default=self.ostree_mode,
        )
        parser.add_argument(
            '--remote-ostree-mode', default=None,
        parser.add_argument(
            '--export-bundles', action='store_true', default=False,
        )
Simon McVittie's avatar
Simon McVittie committed
        parser.add_argument('--build-area', default=self.build_area)
        parser.add_argument(
            '--remote-build-area', default=self.remote_build_area,
        )
        parser.add_argument('--repo', default=self.repo)
        parser.add_argument('--remote-repo', default=self.remote_repo)
        parser.add_argument('--suite', '-d', default=self.apt_suite)
        parser.add_argument(
            '--architecture', '--arch', '-a', default=self.dpkg_arch)
        parser.add_argument('--runtime-branch', default=self.runtime_branch)
Simon McVittie's avatar
Simon McVittie committed
        subparsers = parser.add_subparsers(dest='command', metavar='command')

        subparser = subparsers.add_parser(
            'base',
            help='Build a fresh base tarball',
        )

        subparser = subparsers.add_parser(
            'runtimes',
            help='Build runtimes',
        )
        subparser.add_argument('prefix')

        subparser = subparsers.add_parser(
            'app',
            help='Build an app',
        )
        parser.add_argument('--app-branch', default=self.app_branch)
Simon McVittie's avatar
Simon McVittie committed
        subparser.add_argument('prefix')

        subparser = subparsers.add_parser(
            'print-flatpak-architecture',
            help='Print the Flatpak architecture',
        )

        args = parser.parse_args()

        self.build_area = args.build_area
        self.apt_suite = args.suite
        self.runtime_branch = args.runtime_branch
Simon McVittie's avatar
Simon McVittie committed
        self.repo = args.repo
        self.remote_repo = args.remote_repo
        self.export_bundles = args.export_bundles
        self.ostree_mode = args.ostree_mode
Simon McVittie's avatar
Simon McVittie committed

        if args.remote is not None:
            self.worker = SshWorker(args.remote)

            if self.remote_build_area is None:
                self.remote_build_area = self.worker.check_output([
                    'sh', '-euc',
                    'mkdir -p "${XDG_CACHE_HOME:="$HOME/.cache"}/flatdeb"; '
                    'echo "$XDG_CACHE_HOME/flatdeb"',
                ]).decode('utf-8').rstrip('\n')

            if self.remote_repo is None:
                self.remote_repo = '{}/repo'.format(self.remote_build_area)

            self.remote_ostree_mode = args.remote_ostree_mode

            if self.remote_ostree_mode is None:
                self.remote_ostree_mode = self.ostree_mode
Simon McVittie's avatar
Simon McVittie committed
        else:
            self.worker = HostWorker()
            self.remote_build_area = self.build_area
            self.remote_repo = self.repo
            self.remote_ostree_mode = self.ostree_mode
Simon McVittie's avatar
Simon McVittie committed

        self.root_worker = SudoWorker(self.worker)

        if args.architecture is None:
            self.dpkg_arch = self.worker.check_output(
                ['dpkg-architecture', '-q', 'DEB_HOST_ARCH'],
            ).decode('utf-8').rstrip('\n')
        else:
            self.dpkg_arch = args.architecture

        self.flatpak_arch = self.dpkg_to_flatpak_arch(self.dpkg_arch)

        os.makedirs(self.build_area, exist_ok=True)
        os.makedirs(os.path.dirname(self.repo), exist_ok=True)

        if args.command is None:
            parser.error('A command is required')

        with open(self.apt_suite + '.yaml') as reader:
            self.suite_details = yaml.safe_load(reader)

        getattr(
            self, 'command_' + args.command.replace('-', '_'))(**vars(args))

    def command_print_flatpak_architecture(self, **kwargs):
        print(self.flatpak_arch)

    @property
    def apt_uris(self):
        for source in self.suite_details['sources']:
            yield source['apt_uri']

    def command_base(self, **kwargs):
        with ExitStack() as stack:
            stack.enter_context(self.worker)
            stack.enter_context(self.root_worker)

            base_chroot = '{}/base'.format(self.root_worker.scratch)

            argv = [
                'env',
                'http_proxy=http://192.168.122.1:3142',
                'debootstrap',
                '--variant=minbase',
                '--arch={}'.format(self.dpkg_arch),
Simon McVittie's avatar
Simon McVittie committed
            ]

            if self.suite_details.get('can_merge_usr', False):
                argv.append('--merged-usr')

            keyring = self.suite_details['sources'][0].get('keyring')

            if keyring is not None:
                dest = '{}/{}'.format(
                    self.root_worker.scratch,
                    os.path.basename(keyring),
                )
                self.root_worker.install_file(os.path.abspath(keyring), dest)
                argv.append('--keyring=' + dest)

            argv.append(self.suite_details['sources'][0].get(
                'apt_suite', self.apt_suite,
            ))
            argv.append(base_chroot)
            argv.append(self.suite_details['sources'][0]['apt_uri'])

            script = self.suite_details.get('debootstrap_script')

            if script is not None:
                argv.append('/usr/share/debootstrap/scripts/' + script)

            try:
                self.root_worker.check_call(argv)
            except:
                with suppress(Exception):
                    self.root_worker.check_call([
                        'cat',
                        '{}/debootstrap/debootstrap.log'.format(base_chroot),
                    ])
                raise

            # Merge /usr the hard way, if necessary. We are counting on
            # the assumption that most packages are actually usrmergeable,
            # and those that historically weren't are not upgraded often
            # enough to be a practical problem...
            if not self.suite_details.get('can_merge_usr', False):
                self.root_worker.check_call([
                    'time',
Simon McVittie's avatar
Simon McVittie committed
                    'chroot', base_chroot,
                    'sh',
                    '-euc',

                    'usrmerge () {\n'
                    '    local f="$1"\n'
                    '\n'
                    '    ls -dl "$f" "/usr/$f" >&2 || true\n'
                    '    if [ "$(readlink "$f")" = "/usr$f" ]; then\n'
                    '        echo "Removing $f in favour of /usr$f" >&2\n'
                    '        rm -v -f "$f"\n'
                    '    elif [ "$(readlink "/usr$f")" = "$f" ]; then\n'
                    '        echo "Removing /usr$f in favour of $f" >&2\n'
                    '        rm -v -f "/usr$f"\n'
                    '    else\n'
                    '        echo "Cannot merge $f with /usr$f" >&2\n'
                    '        exit 1\n'
                    '    fi\n'
                    '}\n'
                    '\n'
                    'find /bin /sbin /lib* -not -xtype d |\n'
                    'while read f; do\n'
                    '    if [ -e /usr/"$f" ]; then\n'
                    '        usrmerge "$f"\n'
                    '    fi\n'
                    'done\n'
                    '',

                    'sh',   # argv[0]
                    base_chroot,
                ])
                self.root_worker.check_call([
                    'time',
Simon McVittie's avatar
Simon McVittie committed
                    'sh', '-euc',
                    'cd "$1"; tar -cf- bin sbin lib* | tar -C usr -xf-',
                    'sh', base_chroot,
                ])
                self.root_worker.check_call([
                    'time',
Simon McVittie's avatar
Simon McVittie committed
                    'sh', '-euc', 'cd "$1"; rm -fr bin sbin lib*',
                    'sh', base_chroot,
                ])
                self.root_worker.check_call([
                    'time',
Simon McVittie's avatar
Simon McVittie committed
                    'sh', '-euc', 'cd "$1"; ln -vs usr/bin usr/sbin usr/lib* .',
                    'sh', base_chroot,
                ])

            self.configure_base(base_chroot)
            self.configure_apt(base_chroot)

            tarball = 'base-{}-{}.tar.gz'.format(
                self.apt_suite,
                self.dpkg_arch,
            )

            self.root_worker.check_call([
                'time',
Simon McVittie's avatar
Simon McVittie committed
                'tar', '-zcf', '{}/{}'.format(
                    self.remote_build_area, tarball,
                ),
                '-C', base_chroot,
                '--exclude=./etc/.pwd.lock',
                '--exclude=./etc/group-',
                '--exclude=./etc/passwd-',
                '--exclude=./etc/shadow-',
                '--exclude=./home',
                '--exclude=./root',
                '--exclude=./tmp',
                '--exclude=./var/cache',
                '--exclude=./var/lock',
                '--exclude=./var/tmp',
                '.',
            ])

            if not isinstance(self.worker, HostWorker):
                output = os.path.join(self.build_area, tarball)

                with open(output + '.new', 'wb') as writer:
                    self.root_worker.check_call([
                        'cat',
                        '{}/{}'.format(self.remote_build_area, tarball),
                    ], stdout=writer)

                os.rename(output + '.new', output)

    def ensure_remote_repo(self):
        self.worker.check_call([
            'ostree',
            '--repo=' + self.remote_repo,
            'init',
            '--mode={}'.format(self.remote_ostree_mode),
        ])

    def ensure_local_repo(self):
        subprocess.check_call([
            'ostree',
            '--repo=' + self.repo,
            'init',
            '--mode={}'.format(self.ostree_mode),
Simon McVittie's avatar
Simon McVittie committed
        ])

    def command_runtimes(self, *, prefix, **kwargs):
        self.ensure_local_repo()
Simon McVittie's avatar
Simon McVittie committed
        self.ensure_remote_repo()

        if self.runtime_branch is None:
            self.runtime_branch = self.apt_suite

Simon McVittie's avatar
Simon McVittie committed
        # Be nice to people using tab-completion
        if prefix.endswith('.yaml'):
            prefix = prefix[:-5]

        with open(prefix + '.yaml') as reader:
            self.runtime_details = yaml.safe_load(reader)

        tarball = 'base-{}-{}.tar.gz'.format(
            self.apt_suite,
            self.dpkg_arch,
        )

        with ExitStack() as stack:
            stack.enter_context(self.worker)
            stack.enter_context(self.root_worker)

            base_chroot = '{}/base'.format(self.root_worker.scratch)
            self.root_worker.check_call([
                'install', '-d', base_chroot,
            ])
            # TODO: Upload tarball from host to remote worker
Simon McVittie's avatar
Simon McVittie committed
            self.root_worker.check_call([
                'time',
Simon McVittie's avatar
Simon McVittie committed
                'tar', '-zxf',
                '{}/{}'.format(self.remote_build_area, tarball),
                '-C', base_chroot,
                '.',
            ])

            # We do common steps for both the Platform and the Sdk
            # in the base directory, then copy it.
            self.configure_base(base_chroot)

            platform_chroot = '{}/platform'.format(self.root_worker.scratch)
            sdk_chroot = '{}/sdk'.format(self.root_worker.scratch)

            self.root_worker.check_call([
                'time',
Simon McVittie's avatar
Simon McVittie committed
                'cp', '-a', '--reflink=auto', base_chroot, platform_chroot,
            ])
            self.root_worker.check_call([
                'mv', base_chroot, sdk_chroot,
            ])

            self.ostreeify(
                prefix,
                platform_chroot,
            )
            self.ostreeify(
                prefix,
                sdk_chroot,
                sdk=True,
            )

            self.worker.check_call([
                'time',
Simon McVittie's avatar
Simon McVittie committed
                'flatpak',
                'build-update-repo',
                self.remote_repo,
            ])

            if self.export_bundles:
                for suffix in ('.Platform', '.Sdk'):
Simon McVittie's avatar
Simon McVittie committed
                    self.worker.check_call([
                        'time',
                        'flatpak',
                        'build-bundle',
                        '--runtime',
                        self.remote_repo,
Simon McVittie's avatar
Simon McVittie committed
                        '{}/bundle'.format(self.worker.scratch),
                        prefix + suffix,
                        self.runtime_branch,
Simon McVittie's avatar
Simon McVittie committed

                    bundle = '{}-{}-{}.bundle'.format(
                        prefix + suffix,
                        self.flatpak_arch,
                        self.runtime_branch,
                    )
                    output = os.path.join(self.build_area, bundle)

                    with open(output + '.new', 'wb') as writer:
                        self.worker.check_call([
                            'time',
                            'cat',
                            '{}/bundle'.format(self.worker.scratch),
                        ], stdout=writer)

                        os.rename(output + '.new', output)
Simon McVittie's avatar
Simon McVittie committed

    def configure_apt(self, base_chroot):
        """
        Configure apt. We only do this once, so that all chroots
        created from the same base have their version numbers
        aligned.
        """
        with TemporaryDirectory(prefix='flatdeb-apt.') as t:
Simon McVittie's avatar
Simon McVittie committed
            # Set up the apt sources

            to_copy = os.path.join(t, 'sources.list')

            with open(to_copy, 'w') as writer:
                for source in self.suite_details['sources']:
                    suite = source.get('apt_suite', self.apt_suite)
                    suite = suite.replace('*', self.apt_suite)
                    components = source.get(
                        'apt_components',
                        self.suite_details.get(
                            'apt_components',
                            ['main']))

                    for prefix in ('deb', 'deb-src'):
                        writer.write('{} {} {} {}\n'.format(
                            prefix,
                            source['apt_uri'],
                            suite,
                            ' '.join(components),
                        ))

                    keyring = source.get('keyring')

                    if keyring is not None:
                        self.root_worker.install_file(
                            os.path.abspath(keyring),
                            '{}/etc/apt/trusted.gpg.d/{}'.format(
                                base_chroot,
                                os.path.basename(keyring),
                            ),
                        )

            self.root_worker.install_file(
                to_copy,
                '{}/etc/apt/sources.list'.format(base_chroot),
            )
            self.root_worker.check_call([
                'rm', '-fr',
                '{}/etc/apt/sources.list.d'.format(base_chroot),
            ])

        with NspawnWorker(
            self.root_worker,
            base_chroot,
            env=['http_proxy=http://192.168.122.1:3142'],
        ) as nspawn:
            nspawn.check_call([
                'apt-get', '-y', '-q', 'update',
            ])
            nspawn.check_call([
                'apt-get', '-y', '-q', 'dist-upgrade',
            ])

    def configure_base(self, base_chroot):
        """
        Configure the common chroot that will be copied to make both the
        Platform and the Sdk.
        """

        with TemporaryDirectory(prefix='flatdeb-base-install.') as t:
Simon McVittie's avatar
Simon McVittie committed
            # Disable starting services. This container has no init
            # anyway.

            to_copy = os.path.join(t, 'policy-rc.d')

            with open(to_copy, 'w') as writer:
                writer.write('#!/bin/sh\n')
                writer.write('exit 101\n')

            self.root_worker.install_file(
                to_copy,
                '{}/usr/sbin/policy-rc.d'.format(base_chroot),
                permissions=0o755,
            )

            with open(to_copy, 'w') as writer:
                writer.write('#!/bin/sh\n')
                writer.write('exit 0\n')

            self.root_worker.install_file(
                to_copy,
                '{}/usr/sbin/initctl'.format(base_chroot),
                permissions=0o755,
            )

            # There is some cleanup that we can do in the base
            # tarball rather than in every runtime individually.
            # See https://github.com/debuerreotype/debuerreotype
            # for further ideas.

            to_copy = os.path.join(t, 'flatpak-runtime')

            with open(to_copy, 'w') as writer:
                writer.write('force-unsafe-io\n')

                writer.write('path-exclude /usr/share/doc/*/*\n')
                # For license compliance, we should keep the copyright
                # files intact
                writer.write('path-include /usr/share/doc/*/copyright\n')
                self.root_worker.check_call([
                    'find', '{}/usr/share/doc'.format(base_chroot), '-xdev',
                    '-not', '-name', 'copyright', '-not', '-type', 'd',
                    '-delete'
                ])
                self.root_worker.check_call([
                    'find', '{}/usr/share/doc'.format(base_chroot), '-depth',
                    '-xdev', '-type', 'd', '-empty', '-delete'
                ])

                for d in (
                        'doc-base', 'groff', 'info', 'linda', 'lintian', 'man',
                ):
                    writer.write(
                        'path-exclude /usr/share/{}/*\n'.format(d),
                    )
                    self.root_worker.check_call([
                        'rm', '-fr', '{}/usr/share/{}'.format(base_chroot, d),
                    ])

            self.root_worker.check_call([
                'install', '-d',
                '{}/etc/dpkg/dpkg.cfg.d'.format(base_chroot),
            ])
            self.root_worker.install_file(
                to_copy,
                '{}/etc/dpkg/dpkg.cfg.d/flatpak-runtime'.format(base_chroot),
            )

            to_copy = os.path.join(t, 'flatpak-runtime')

            with open(to_copy, 'w') as writer:
                writer.write('Acquire::Languages "none";\n')
                writer.write('Acquire::GzipIndexes "true";\n')
                writer.write('Acquire::CompressionTypes::Order:: "gz";\n')
                writer.write('APT::InstallRecommends "false";\n')
                writer.write(
                    'APT::AutoRemove::SuggestsImportant "false";\n')
                # We rely on autoremove not taking effect immediately
                writer.write('APT::Get::AutomaticRemove "false";\n')
                writer.write('Aptitude::Delete-Unused "false";\n')

            self.root_worker.check_call([
                'install', '-d',
                '{}/etc/apt/apt.conf.d'.format(base_chroot),
            ])
            self.root_worker.install_file(
                to_copy,
                '{}/etc/apt/apt.conf.d/flatpak-runtime'.format(base_chroot),
            )

        if not self.runtime_details:
            return

        with NspawnWorker(
            self.root_worker,
            base_chroot,
            env=['http_proxy=http://192.168.122.1:3142'],
        ) as nspawn:
            nspawn.check_call([
                'install', '-d',
                '/var/cache/apt/archives/partial',
                '/var/lock',
            ])

            # We use aptitude to help prepare the Platform runtime, and
            # it's a useful thing to have in the Sdk runtime
            nspawn.check_call([
                'apt-get', '-y', 'install', 'aptitude',
            ])

            # All packages will be removed from the platform runtime
            # unless they are Essential, depended-on, or in the
            # add_packages list.
            nspawn.check_call([
                'aptitude', '-y', 'markauto', '?installed'
            ])
            # Ubuntu precise doesn't like apt being up for autoremoval.
            nspawn.check_call([
                'aptitude', '-y', 'unmarkauto', 'apt'
            ])

            packages = self.runtime_details.get('add_packages', [])

            if packages:
                nspawn.check_call([
                    'apt-get', '-q', '-y', 'install',
                ] + packages)

    def sdkize(self, sdk_chroot):
        """
        Transform a copy of the chroot into a Sdk runtime.
        """
        sdk_details = self.runtime_details.get('sdk', {})

        with NspawnWorker(
            self.root_worker,
            sdk_chroot,
            env=['http_proxy=http://192.168.122.1:3142'],
        ) as nspawn:
            packages = sdk_details.get('add_packages', [])

            if packages:
                nspawn.check_call([
                    'apt-get', '-q', '-y', 'install',
                ] + packages)

            script = sdk_details.get('post_script', [])

            if script:
                nspawn.check_call([
                    'sh', '-c', script,
                ])

Simon McVittie's avatar
Simon McVittie committed
            nspawn.write_manifest()

            installed = set(nspawn.check_output([
                'dpkg-query', '--show', '-f', '${Package}\\n',
            ]).split())

        return installed

    def platformize(self, platform_chroot):
        """
        Transform a copy of the chroot into a Platform runtime.
        """
        platform_details = self.runtime_details.get('platform', {})

        with NspawnWorker(
            self.root_worker,
            platform_chroot,
            env=[
                'SUDO_FORCE_REMOVE=yes',
                'http_proxy=http://192.168.122.1:3142'
            ],
        ) as nspawn:
            nspawn.check_call([
                'aptitude', '-y', 'purge',
                '?and(?installed,?section(devel))',
                '?and(?installed,?section(libdevel))',
            ])

            installed = set(nspawn.check_output([
                'dpkg-query', '--show', '-f', '${Package}\\n',
            ]).split())
            unwanted = []

            for package in [
                    'aptitude',
                    'fakeroot',
                    'libfakeroot',
            ]:
                if package in installed:
                    unwanted.append(package)

            if unwanted:
                nspawn.check_call([
                    'apt-get', '-y', 'purge', unwanted,
                ])

            nspawn.check_call([
                'apt-get', '-y', '--purge', 'autoremove',
            ])

            installed = set(nspawn.check_output([
                'dpkg-query', '--show', '-f', '${Package}\\n',
            ]).split())
            unwanted = []

            # These are Essential (or at least important) but serve no
            # purpose in an immutable runtime with no init. Note that
            # order is important: adduser needs to be removed before
            # debconf.
            for package in [
                    'adduser',
                    'apt',
                    'busybox-initramfs',
                    'debconf',
                    'debian-archive-keyring',
                    'e2fsprogs',
                    'gnupg',
                    'ifupdown',
                    'init',
                    'init-system-helpers',
                    'initramfs-tools',
                    'initramfs-tools-bin',
                    'initscripts',
                    'insserv',
                    'iproute',
                    'login',
                    'lsb-base',
                    'module-init-tools',
                    'mount',
                    'mountall',
                    'passwd',
                    'plymouth',
                    'systemd',
                    'systemd-sysv',
                    'sysv-rc',
                    'tcpd',
                    'ubuntu-archive-keyring',
                    'ubuntu-keyring',
                    'udev',
                    'upstart',
            ]:
                if package in installed:
                    unwanted.append(package)

            if 'perl' not in installed:
                unwanted.append('perl-base')

            if 'python' not in installed:
                unwanted.append('python-minimal')
                unwanted.append('python2.7-minimal')

            if unwanted:
                nspawn.check_call([
                    'dpkg', '--purge', '--force-remove-essential',
                    '--force-depends',
                ] + unwanted)

            installed = set(nspawn.check_output([
                'dpkg-query', '--show', '-f', '${Package}\\n',
            ]).split())

            # We have to do this before removing dpkg :-)
            nspawn.write_manifest()

            # This has to be last for obvious reasons!
            nspawn.check_call([
                'dpkg', '--purge', '--force-remove-essential',
                '--force-depends',
                'dpkg',
            ])

        return installed

    def ostreeify(self, prefix, chroot, sdk=False, packages=()):
        """
        Move things around to turn a chroot into a runtime.
        """
        if sdk:
            installed = self.sdkize(chroot)
        else:
            installed = self.platformize(chroot)

        with NspawnWorker(
            self.root_worker,
            chroot,
        ) as nspawn:
            nspawn.check_call([
                'find', '/', '-xdev', '(',
                '-lname', '/etc/alternatives/*', '-o',
                '-lname', '/etc/locale.alias',
                ')', '-exec', 'sh', '-euc',

                'set -e\n'
                'while [ $# -gt 0 ]; do\n'
                '    if target="$(readlink -f "$1")"; then\n'
                '        echo "Making $1 a hard link to $target"\n'
                '        rm -f "$1"\n'
                '        cp -al "$target" "$1"\n'
Simon McVittie's avatar
Simon McVittie committed
                '    fi\n'
                '    shift\n'
                'done'
                '',

                'sh', # argv[0] for the one-line shell script
                '{}', '+',
            ])
        self.root_worker.check_call([
            'chmod', '-R', '--changes', 'a-s,o-t,u=rwX,og=rX', chroot,
        ])
        self.root_worker.check_call([
            'chown', '-R', '--changes', 'root:root', chroot,
        ])
        self.root_worker.check_call([
            'rm', '-fr', '--one-file-system',
            '{}/usr/local'.format(chroot),
        ])

        if sdk:
            runtime = prefix + '.Sdk'

            self.root_worker.check_call([
                'rm', '-fr', '--one-file-system',
                '{}/etc/group-'.format(chroot),
                '{}/etc/gshadow-'.format(chroot),
                '{}/etc/passwd-'.format(chroot),
                '{}/etc/shadow-'.format(chroot),
                '{}/etc/subuid-'.format(chroot),
                '{}/etc/subgid-'.format(chroot),
                '{}/var/backups'.format(chroot),
                '{}/var/cache'.format(chroot),
                '{}/var/lib/dpkg/status-old'.format(chroot),
                '{}/var/lib/dpkg/statoverride'.format(chroot),
            ])
            self.root_worker.check_call([
                'install', '-d',
                '{}/var/cache/apt/archives/partial'.format(chroot),
                '{}/var/lib/extrausers'.format(chroot),
            ])
            self.root_worker.check_call([
                'touch', '{}/var/cache/apt/archives/partial/.exists'.format(chroot),
            ])

            # This is only useful if the SDK has libnss-extrausers
            self.root_worker.check_call([
                'cp', '{}/etc/passwd'.format(chroot),
                '{}/var/lib/extrausers/passwd'.format(chroot),
            ])
            self.root_worker.check_call([
                'cp', '{}/etc/group'.format(chroot),
                '{}/var/lib/extrausers/groups'.format(chroot),
            ])

            self.root_worker.check_call([
                'mv', '{}/etc'.format(chroot),
                '{}/usr/etc'.format(chroot),
            ])
            self.root_worker.check_call([
                'mv', '{}/var'.format(chroot),
                '{}/usr/var'.format(chroot),
            ])
        else:
            runtime = prefix + '.Platform'

            self.root_worker.check_call([
                'rm', '-fr', '--one-file-system',
                '{}/etc'.format(chroot),
                '{}/share/bash-completion'.format(chroot),
                '{}/share/bug'.format(chroot),
                '{}/var'.format(chroot),
            ])

        # TODO: Move lib/debug, zoneinfo, locales into extensions
        # TODO: Hook point for GL, instead of just Mesa
        # TODO: GStreamer extension
        # TODO: Icon theme, Gtk theme extension
        # TODO: VAAPI extension