subiquity/system_setup/server/server.py

# Copyright 2021 Canonical, Ltd.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from aiohttp import web

from system_setup.common.wsl_utils import is_reconfigure
from subiquity.server.server import SubiquityServer
from system_setup.models.system_setup import SystemSetupModel
from subiquity.models.subiquity import ModelNames

import logging
import yaml
import os

log = logging.getLogger('system_setup.server.server')

INSTALL_MODEL_NAMES = ModelNames({
        "locale",
        "wslconfbase",
    },
    wsl_setup={
        "identity",
    },
    wsl_configuration={
        "wslconfadvanced",
    })

POSTINSTALL_MODEL_NAMES = ModelNames(set())

LOCALHOST_ADDR = "127.0.0.1"


class SystemSetupServer(SubiquityServer):
    prefillInfo = None

    from system_setup.server import controllers as controllers_mod
    controllers = [
        "Early",
        "Reporting",
        "Error",
        "WSLLocale",
        "WSLSetupOptions",
        "WSLIdentity",
        "WSLConfigurationBase",
        "WSLConfigurationAdvanced",
        "Configure",
        "Late",
        "SetupShutdown",
    ]

    supported_variants = ["wsl_setup", "wsl_configuration"]

    def __init__(self, opts, block_log_dir):
        super().__init__(opts, block_log_dir)
        self.event_syslog_id = ""
        self.log_syslog_id = ""
        self.echo_syslog_id = ""
        if is_reconfigure(opts.dry_run):
            self.set_source_variant("wsl_configuration")
        if self.opts.prefill:
            with open(self.opts.prefill, 'r') as stream:
                try:
                    # Shared with controllers thru self.app.
                    self.prefillInfo = yaml.safe_load(stream)
                except yaml.YAMLError as exc:
                    log.error('Exception while parsing prefill file: {}.'
                              ' Ignoring file.'.format(self.opts.prefill))
                    log.error(exc)
                    self.prefillInfo = None

    def make_model(self):
        root = '/'
        if self.opts.dry_run:
            root = os.path.abspath(self.opts.output_base)
        model = SystemSetupModel(root, self.hub, INSTALL_MODEL_NAMES,
                                 POSTINSTALL_MODEL_NAMES)
        model.set_source_variant(self.variant)
        return model

    # We don’t have cloudinit in system_setup.
    async def wait_for_cloudinit(self):
        self.cloud_init_ok = True
        return

    async def start_site(self, runner: web.AppRunner):
        port = self.opts.tcp_port
        if port is None:
            return await super().start_site(runner)

        # Subiquity runs with root privileges, that's why we don't want
        # outsiders to connect to it. Only localhost loopback is allowed.
        site = web.TCPSite(runner, host=LOCALHOST_ADDR, port=port)
        await site.start()