0x1949 Team - FAZEMRX - MANAGER
Edit File: __init__.py
import enum import textwrap from collections import defaultdict from typing import Dict, List, Optional, Type from uaclient import exceptions from uaclient.config import UAConfig from uaclient.entitlements import fips from uaclient.entitlements.anbox import AnboxEntitlement from uaclient.entitlements.base import UAEntitlement from uaclient.entitlements.cc import CommonCriteriaEntitlement from uaclient.entitlements.cis import CISEntitlement from uaclient.entitlements.entitlement_status import ApplicabilityStatus from uaclient.entitlements.esm import ESMAppsEntitlement, ESMInfraEntitlement from uaclient.entitlements.landscape import LandscapeEntitlement from uaclient.entitlements.livepatch import LivepatchEntitlement from uaclient.entitlements.realtime import RealtimeKernelEntitlement from uaclient.entitlements.repo import RepoEntitlement from uaclient.entitlements.ros import ROSEntitlement, ROSUpdatesEntitlement from uaclient.exceptions import EntitlementNotFoundError ENTITLEMENT_CLASSES = [ AnboxEntitlement, CommonCriteriaEntitlement, CISEntitlement, ESMAppsEntitlement, ESMInfraEntitlement, fips.FIPSEntitlement, fips.FIPSUpdatesEntitlement, fips.FIPSPreviewEntitlement, LandscapeEntitlement, LivepatchEntitlement, RealtimeKernelEntitlement, ROSEntitlement, ROSUpdatesEntitlement, ] # type: List[Type[UAEntitlement]] def entitlement_factory( cfg: UAConfig, name: str, variant: str = "", purge: bool = False, access_only: bool = False, extra_args: Optional[List[str]] = None, ): """Returns a UAEntitlement object based on the provided name. The return type is Optional[Type[UAEntitlement]]. It cannot be explicit because of the Python version on Xenial (3.5.2). :param cfg: UAConfig instance :param name: The name of the entitlement to return :param variant: The variant name to be used :param purge: If purge operation is enabled :param access_only: If entitlement should be set with access only :param extra_args: Extra parameters to create the entitlement :raise EntitlementNotFoundError: If not_found_okay is False and no entitlement with the given name is found, then raises this error. """ for entitlement in ENTITLEMENT_CLASSES: ent = entitlement( cfg=cfg, access_only=access_only, called_name=name, purge=purge, extra_args=extra_args, ) if name in ent.valid_names: if not variant: return ent elif variant in ent.variants: return ent.variants[variant]( cfg=cfg, called_name=name, purge=purge, extra_args=extra_args, ) else: raise EntitlementNotFoundError(entitlement_name=variant) raise EntitlementNotFoundError(entitlement_name=name) def valid_services(cfg: UAConfig, all_names: bool = False) -> List[str]: """Return a list of valid services. :param cfg: UAConfig instance :param all_names: if we should return all the names for a service instead of just the presentation_name """ entitlements = ENTITLEMENT_CLASSES if all_names: names = [] for entitlement_cls in entitlements: names.extend(entitlement_cls(cfg=cfg).valid_names) return sorted(names) return sorted( [ entitlement_cls(cfg=cfg).presentation_name for entitlement_cls in entitlements ] ) def order_entitlements_for_enabling( cfg: UAConfig, ents: List[str] ) -> List[str]: """ A function to sort entitlments for enabling that preserves invalid names """ valid_ents_ordered = entitlements_enable_order(cfg) def sort_order_with_nonexistent_last(ent): try: return valid_ents_ordered.index(ent) except ValueError: return len(valid_ents_ordered) return sorted(ents, key=lambda ent: sort_order_with_nonexistent_last(ent)) @enum.unique class SortOrder(enum.Enum): REQUIRED_SERVICES = object() DEPENDENT_SERVICES = object() def entitlements_disable_order(cfg: UAConfig) -> List[str]: """ Return the entitlements disable order based on dependent services logic. """ return _sort_entitlements(cfg=cfg, sort_order=SortOrder.DEPENDENT_SERVICES) def entitlements_enable_order(cfg: UAConfig) -> List[str]: """ Return the entitlements enable order based on required services logic. """ return _sort_entitlements(cfg=cfg, sort_order=SortOrder.REQUIRED_SERVICES) def _sort_entitlements_visit( cfg: UAConfig, ent_cls: Type[UAEntitlement], sort_order: SortOrder, visited: Dict[str, bool], order: List[str], ): if ent_cls.name in visited: return ent = ent_cls(cfg) if sort_order == SortOrder.REQUIRED_SERVICES: cls_list = [e.entitlement for e in ent.required_services] else: cls_list = list(ent.dependent_services) for cls_dependency in cls_list: if ent_cls.name not in visited: _sort_entitlements_visit( cfg=cfg, ent_cls=cls_dependency, sort_order=sort_order, visited=visited, order=order, ) order.append(str(ent_cls.name)) visited[str(ent_cls.name)] = True def _sort_entitlements(cfg: UAConfig, sort_order: SortOrder) -> List[str]: order = [] # type: List[str] visited = {} # type: Dict[str, bool] for ent_cls in ENTITLEMENT_CLASSES: _sort_entitlements_visit( cfg=cfg, ent_cls=ent_cls, sort_order=sort_order, visited=visited, order=order, ) return order def get_valid_entitlement_names(names: List[str], cfg: UAConfig): """Return a list of valid entitlement names. :param names: List of entitlements to validate :return: a tuple of List containing the valid and invalid entitlements """ entitlements_found = [] for ent_name in names: if ent_name in valid_services(cfg=cfg, all_names=True): entitlements_found.append(ent_name) entitlements_not_found = sorted(set(names) - set(entitlements_found)) return entitlements_found, entitlements_not_found def create_enable_entitlements_not_found_error( entitlements_not_found, cfg: UAConfig ) -> exceptions.UbuntuProError: """ Constructs the MESSAGE_INVALID_SERVICE_OP_FAILURE message based on the attempted services and valid services. """ valid_services_names = valid_services(cfg=cfg) valid_names = ", ".join(valid_services_names) service_msg = "\n".join( textwrap.wrap( "Try " + valid_names + ".", width=80, break_long_words=False, break_on_hyphens=False, ) ) return exceptions.InvalidServiceOpError( operation="enable", invalid_service=", ".join(entitlements_not_found), service_msg=service_msg, ) # This function is just here to simplify our unittests, as # mocking isinstance directly doesn't work here def _is_repo_entitlement(ent): return isinstance(ent, RepoEntitlement) def check_entitlement_apt_directives_are_unique( cfg: UAConfig, ) -> bool: entitlement_directives = defaultdict(list) for ent_name in valid_services(cfg): ent = entitlement_factory(cfg, ent_name) if not _is_repo_entitlement(ent): continue applicability_status, _ = ent.applicability_status() if applicability_status == ApplicabilityStatus.APPLICABLE: apt_url = ent.apt_url apt_suites = ent.apt_suites or () for suite in apt_suites: entitlement_directive = ent.repo_policy_check_tmpl.format( apt_url, suite ) entitlement_directives[entitlement_directive].append( { "from": ent_name, "apt_url": apt_url, "suite": suite, } ) for def_path, ent_directive in entitlement_directives.items(): if len(ent_directive) > 1: apt_url = ent_directive[0]["apt_url"] suite = ent_directive[0]["suite"] raise exceptions.EntitlementsAPTDirectivesAreNotUnique( url=cfg.contract_url, names=", ".join( sorted(ent["from"] for ent in ent_directive) ), apt_url=apt_url, suite=suite, ) return True def get_title(cfg: UAConfig, ent_name: str, variant=""): try: return entitlement_factory(cfg, ent_name, variant=variant).title except exceptions.UbuntuProError: return ent_name