import os
from typing import Tuple, Type, Union
from uaclient import gpg, messages, system
from uaclient.apt import APT_KEYS_DIR, ESM_REPO_FILE_CONTENT, KEYRINGS_DIR
from uaclient.defaults import ESM_APT_ROOTDIR
from uaclient.entitlements import repo
from uaclient.entitlements.base import UAEntitlement
from uaclient.entitlements.entitlement_status import CanDisableFailure
class ESMBaseEntitlement(repo.RepoEntitlement):
help_doc_url = messages.urls.ESM_HOME_PAGE
@property
def dependent_services(self) -> Tuple[Type[UAEntitlement], ...]:
from uaclient.entitlements.ros import (
ROSEntitlement,
ROSUpdatesEntitlement,
)
return (ROSEntitlement, ROSUpdatesEntitlement)
def _perform_enable(self, silent: bool = False) -> bool:
from uaclient.timer.update_messaging import update_motd_messages
enable_performed = super()._perform_enable(silent=silent)
if enable_performed:
update_motd_messages(self.cfg)
self.disable_local_esm_repo()
return enable_performed
def setup_local_esm_repo(self) -> None:
series = system.get_release_info().series
# Ugly? Yes, but so is python < 3.8 without removeprefix
assert self.name.startswith("esm-")
esm_name = self.name[len("esm-") :]
repo_filename = os.path.normpath(
ESM_APT_ROOTDIR + self.repo_list_file_tmpl.format(name=self.name),
)
keyring_file = self.repo_key_file
# No need to create if already present
if os.path.exists(repo_filename):
return
system.write_file(
repo_filename,
ESM_REPO_FILE_CONTENT.format(name=esm_name, series=series),
)
# Set up GPG key
source_keyring_file = os.path.join(KEYRINGS_DIR, keyring_file)
destination_keyring_file = os.path.normpath(
ESM_APT_ROOTDIR + APT_KEYS_DIR + keyring_file
)
os.makedirs(os.path.dirname(destination_keyring_file), exist_ok=True)
gpg.export_gpg_key(source_keyring_file, destination_keyring_file)
def disable_local_esm_repo(self) -> None:
keyring_file = os.path.normpath(
ESM_APT_ROOTDIR + APT_KEYS_DIR + self.repo_key_file
)
repo_filename = os.path.normpath(
ESM_APT_ROOTDIR + self.repo_list_file_tmpl.format(name=self.name),
)
system.ensure_file_absent(repo_filename)
system.ensure_file_absent(keyring_file)
class ESMAppsEntitlement(ESMBaseEntitlement):
origin = "UbuntuESMApps"
name = "esm-apps"
title = messages.ESM_APPS_TITLE
description = messages.ESM_APPS_DESCRIPTION
help_text = messages.ESM_APPS_HELP_TEXT
repo_key_file = "ubuntu-pro-esm-apps.gpg"
def disable(
self, silent=False
) -> Tuple[bool, Union[None, CanDisableFailure]]:
from uaclient.timer.update_messaging import update_motd_messages
disable_performed, fail = super().disable(silent=silent)
if disable_performed:
update_motd_messages(self.cfg)
if system.is_current_series_lts():
self.setup_local_esm_repo()
return disable_performed, fail
class ESMInfraEntitlement(ESMBaseEntitlement):
name = "esm-infra"
origin = "UbuntuESM"
title = messages.ESM_INFRA_TITLE
description = messages.ESM_INFRA_DESCRIPTION
help_text = messages.ESM_INFRA_HELP_TEXT
repo_key_file = "ubuntu-pro-esm-infra.gpg"
def disable(
self, silent=False
) -> Tuple[bool, Union[None, CanDisableFailure]]:
from uaclient.timer.update_messaging import update_motd_messages
disable_performed, fail = super().disable(silent=silent)
if disable_performed:
update_motd_messages(self.cfg)
if system.is_current_series_active_esm():
self.setup_local_esm_repo()
return disable_performed, fail