/usr/lib/python3/dist-packages/uaclient/entitlements/__pycache__
Edit: /usr/lib/python3/dist-packages/uaclient/entitlements/__pycache__/base.cpython-310.pyc (34192B)
o
Ki @ s" d dl Z d dlZd dlZd dlZd dlmZ d dlmZmZmZm Z m
Z
m Z m Z m
Z
d dlmZmZmZmZmZmZmZmZmZmZmZ d dlmZ d dl m Z m Z m Z m Z m!Z!m"Z"m#Z#m$Z$ d dl%m&Z& d dl'm(Z( d d l)m*Z*m+Z+ e, Z-e.e/e0Z1G d
d d Z2G d d
d
e j3dZ4dS ) N)datetime)AnyDictListOptionalSetTupleTypeUnion) apiaptconfigcontract event_logger
exceptionshttpmessagessnapsystemutil) _is_attached)ApplicabilityStatusApplicationStatusCanDisableFailureCanDisableFailureReasonCanEnableFailureCanEnableFailureReasonContractStatusUserFacingStatus)
machine_token)status_cache_file)MessagingOperationsDictStaticAffordancec @ s$ e Zd Zded dejfddZdS )EntitlementWithMessage entitlement
UAEntitlement named_msgc C s || _ || _d S N)r$ r& )selfr$ r& r) d?Z
de e e e? f fdDdEZ@dFeAjBde e eCde?f f fdGdHZDdFeAjBde fdIdJZEde fdKdLZFdFeAjBde fdMdNZGde fdOdPZHejdFeAjBde fdQdRZIdee% fdSdTZJde fdUdVZKdFeAjBde e e e j f fdWdXZLdYdZ ZMd[d\ ZNdFeAjBde e e e j f fd]d^ZO dd_e de e e eP f fd`daZQdFeAjBde e e eP f fdbdcZRejdFeAjBde fdddeZSde fdfdgZTdee(d fdhdiZUdFeAjBde e e e j f fdjdkZVde fdldmZW ddnedoe ddfdpdqZXde eYe e j f fdrdsZZde[fdtduZ\de e]e e j f fdvdwZ^ejde e_e e j f fdxdyZ`de e e e j f fdzd{Zade e fd|d}Zbde fd~dZcde_fddZddeeef de e de fddZe ddeeef deeef de de de f
ddZfdFeAjBfddZgdS )r% NF r) Treturnc C dS )z?The lowercase name of this entitlement, in case it is a variantr0 r) r( r) r) r* variant_nameS zUAEntitlement.variant_namec C s$ | j g}| j| j kr|| j |S )z1The list of names this entitlement may be called.)namepresentation_nameappend)r( valid_namesr) r) r* r9 X s zUAEntitlement.valid_namesc C r2 )z,The human readable title of this entitlementNr) r3 r) r) r* title` zUAEntitlement.titlec C r2 )z&A sentence describing this entitlementNr) r3 r) r) r* descriptionf r; zUAEntitlement.descriptionc C s: | j r| jS | jjr| jdi di d| jS | jS )z/The user-facing name shown for this entitlementr$ affordances presentedAs)
is_variantr4 machine_token_file
is_presententitlement_cfggetr6 r3 r) r) r* r7 l s
z UAEntitlement.presentation_nameplatform_checkc C r2 )zVerify specific platform checks for a service.
This should only be used if the service requires custom platform checks
to check if it is available or not in the machine.
TNr) )r( rD r) r) r* verify_platform_checksz s z$UAEntitlement.verify_platform_checksc C sF | j }| jr!dd | j D }ddtj d g| }||7 }|S )z$Help information for the entitlementc S s g | ] \}}d ||jqS )z
* {}: {})formatr< ).0r4 variant_clsr) r) r*
s z+UAEntitlement.help_info..
z
) help_textvariantsitemsjoinr CLI_HELP_VARIANTS_HEADER)r( rL
variant_items variant_textr) r) r* help_info s zUAEntitlement.help_info.c C r2 )Nr) r) r3 r) r) r* static_affordances z UAEntitlement.static_affordancesc C | j S )a
Return a list of packages that aren't compatible with the entitlement.
When we are enabling the entitlement we can directly ask the user
if those entitlements can be disabled before proceding.
Overridden in livepatch and fips
)_incompatible_servicesr3 r) r) r* incompatible_services z#UAEntitlement.incompatible_servicesc C rV )a
Return a list of packages that must be active before enabling this
service. When we are enabling the entitlement we can directly ask
the user if those entitlements can be enabled before proceding.
Overridden in ros and ros-updates.
)_required_servicesr3 r) r) r* required_services rY z UAEntitlement.required_servicesc C rV )a
Return a list of packages that depend on this service.
We will use that list during disable operations, where
a disable operation will also disable all of the services
required by the original service
Overriden in esm-apps and esm-infra
)_dependent_servicesr3 r) r) r* dependent_services s z UAEntitlement.dependent_servicesc C i S r' r) r3 r) r) r*
_get_variants s zUAEntitlement._get_variantsc C sP t }| }|di dg }|D ]}|di d}|r%|| q|S )zV
Fetch all available variants defined in the Contract Server response
r$ overridesselectorvariant)set_base_entitlement_cfgrC add)r( valid_variantsrB r` overriderb r) r) r* _get_contract_variants s
z$UAEntitlement._get_contract_variantsc C s` | }| }d|v rd|d i}ni }t|D ] }||v r%|| ||< qt|dkr.|S i S )Ngeneric )r_ rh sortedlen)r( service_variantscontract_variantsrf rb r) r) r* _get_valid_variants s z!UAEntitlement._get_valid_variantsc C s | j ri S | S )zf
Return a list of services that are considered a variant
of the main service.
)r? ro r3 r) r) r* rM s zUAEntitlement.variantsc s$ j si S fdd D S )zw
On a variant, return the other variants of the main service.
On a non-variant, returns empty.
c s i | ] \}}| j kr||qS r) )r4 )rH r6 clsr3 r) r*
s
z0UAEntitlement.other_variants..)r? ro rN r3 r) r3 r* other_variants s
z UAEntitlement.other_variantsc C sR | j D ]!}|jdkr
q|| j| j| jd}| \}}|tjkr&| S qdS )z
On an enabled service class, return the variant that is enabled.
Return None if no variants exist or none are enabled (e.g. access-only)
ri )cfg called_name access_onlyN) rM valuesr4 rs _called_nameru application_statusr ENABLED)r( rI rb status_r) r) r* enabled_variant s
z UAEntitlement.enabled_variantc C r2 )zt
Only implemented on variant classes.
Returns True if this variant should be auto-selected.
Fr) r3 r) r) r* variant_auto_select s z!UAEntitlement.variant_auto_selectc C s t | j }|r
|d S dS )z
Cannot actually set the return type because
https://github.com/python/typing/issues/266
affects xenial.
:rtype: Optional[Type["UAEntitlement"]]
r N)listrM rv )r( rM r) r) r* default_variant s z UAEntitlement.default_variantc C r^ r' r) r3 r) r) r* messaging rU zUAEntitlement.messagingrs rt ru purge
extra_argsc C sT |st }|| _t | _|| _|| _|dur || _ng | _|| _ d| _
d| _ dS )z]Setup UAEntitlement instance
@param config: Parsed configuration dictionary
NF) r
UAConfigrs r get_machine_token_filer@ ru r r rw _valid_service_is_sources_list_updated)r( rs rt ru r r r) r) r* r+ $ s
zUAEntitlement.__init__c C s t | j | ji S r' )copydeepcopyr@ entitlementsrC r6 r3 r) r) r* rd > s z#UAEntitlement._base_entitlement_cfgc C s* | }| jr |s |S tj|| jd |S )N) orig_accessrb )rd r? r apply_contract_overridesr4 r( rB r) r) r* rB C s
z UAEntitlement.entitlement_cfgc C r2 )z
The number of steps that are reported as progress while enabling
this specific entitlement that are not shared with other entitlements.
Nr) r3 r) r) r* enable_stepsP zUAEntitlement.enable_stepsc C r2 )z
The number of steps that are reported as progress while disabling
this specific entitlement that are not shared with other entitlements.
Nr) r3 r) r) r*
disable_stepsX r zUAEntitlement.disable_stepsc C s | }| jdi di d}|d ur t|dkr |d7 }| jdi di d}|d urE s
z5UAEntitlement.handle_required_snaps..)keyr6 classicConfinementSupportFchannel)r )r classic_confinement_support)#rB rC r is_snapd_installedr r INSTALLING_PACKAGESrG
install_snapd is_snapd_installed_as_a_snap install_snapr ProcessExecutionErrorr warningEXECUTING_COMMAND_FAILEDrun_snapd_wait_cmd refresh_snapeventr r validate_proxyrs r PROXY_VALIDATION_SNAP_HTTP_URLr PROXY_VALIDATION_SNAP_HTTPS_URLconfigure_snap_proxySNAP_INSTALL_RETRIESr INSTALLING_REQUIRED_SNAPSrk
get_snap_infoSnapNotInstalledError INSTALLING_REQUIRED_SNAP_PACKAGE)
r( r r er r snap_pkg snap_namer r r) r) r* r s
z#UAEntitlement.handle_required_snapsc sP | j di di d}|sdS dd |D }t t fdd|D S )/install packages necessary to enable a service.r$ r r Tc S g | ]}|d qS r6 r) rH packager) r) r* rJ k zAUAEntitlement.are_required_packages_installed..c s g | ]}| v qS r) r) )rH requiredinstalled_packagesr) r* rJ o r )rB rC r get_installed_packages_namesall)r( r
package_namesr) r r* are_required_packages_installed^ s z-UAEntitlement.are_required_packages_installedc C sp | j di di d}|sdS | | dd |D }td| |tjjd |d t
| dS )
r r$ r r Tc S r r r) r r) r) r* rJ r z:UAEntitlement.handle_required_packages..zInstalling packages %r r ) rB rC _update_sources_listr r r r r rG rO r run_apt_install_command)r( r r r r) r) r* r r s
z&UAEntitlement.handle_required_packagesc C s | j di di d}|sdS dd |D }t|dkr!dS td| d |}ttj j
|d
t |tj
j
|d
dS ) r r$ r r Tc S s g | ] }| d dr|d qS )removeOnDisableFr6 r r r) r) r* rJ s
zCUAEntitlement.handle_removing_required_packages..r zUninstalling packages %rr r )rB rC rl r r rO r r r UNINSTALLING_PACKAGESrG r remove_packages UNINSTALLING_PACKAGES_FAILED)r( r r package_names_strr) r) r* !handle_removing_required_packages s.
z/UAEntitlement.handle_removing_required_packagesc C r2 )a
Enable specific entitlement. This should be implemented by subclasses.
This method does the actual enablement, and does not check can_enable
or handle pre_enable or post_enable messaging.
@return: True on success, False otherwise.
Nr) r( r r) r) r* r s z UAEntitlement._perform_enablec C sD g }| j D ]}|j| jd \}}|tjtjfv r || q|S )zI
:return: List of incompatible services that are enabled
rs )rX r$ rs rx r ry WARNINGr8 r( r service
ent_statusr{ r) r) r* r s
z,UAEntitlement.blocking_incompatible_servicesc C t | dkS )z
Check for incompatible services.
:return:
True if there are incompatible services enabled
False if there are no incompatible services enabled
r )rl r r3 r) r) r* r z*UAEntitlement.detect_incompatible_servicesc C s t j| jjdd}| D ]=}|| j}tjj| j|jd}|r'd|f S | dtj
j|jd | |\}}|sJ||rE|j f S df S q
dS ) a)
Prompt user when incompatible services are found during enable.
When enabling a service, we may find that there is an incompatible
service already enable. In that situation, we can ask the user
if the incompatible service should be disabled before proceeding.
There are also different ways to configure that behavior:
We can disable removing incompatible service during enable by
adding the following lines into uaclient.conf:
features:
block_disable_on_enable: true
z features.block_disable_on_enable)r
path_to_value)service_being_enabledr Fr r
NrE )
r is_config_value_truers r r$ r #E_INCOMPATIBLE_SERVICE_STOPS_ENABLErG r: r DISABLING_INCOMPATIBLE_SERVICEdisabler )r( r cfg_block_disable_on_enabler
ente_msgr r r) r) r* r s. z*UAEntitlement.handle_incompatible_servicesc C s t | dkS )z
Check if all required services are active
:return:
True if all required services are active
False is at least one of the required services is disabled
r )rl r r3 r) r) r* r r
z,UAEntitlement.check_required_services_activec C sB g }| j D ]}|| j \}}|tjtjfvr || q|S )zF
:return: List of required services that are disabled
)r[ r$ rs rx r ry r r8 r r) r) r* r s
z(UAEntitlement.blocking_required_servicesc C s | D ]>}|j| jd}|dtjj|jd ||\}}|sBd}|r3|j r3|j j
r3d|j j
}tj j||jd}||f S qdS )a,
Prompt user when required services are found during enable.
When enabling a service, we may find that there are required services
that must be enabled first. In that situation, we can ask the user
if the required service should be enabled before proceeding.
r r r r0 rK )r r
rE ) r r$ rs r r ENABLING_REQUIRED_SERVICErG r: r r msg ERROR_ENABLING_REQUIRED_SERVICE)r( r r r r r error_msgr r) r) r* r s&
z'UAEntitlement._enable_required_servicesignore_dependent_servicesc C s | \}}|tjkrdttjtjj| jddfS | \}}| j
r(|t j kr7dttj
tjj| jddfS | jrG|sG| rGdttjfS | js[| jr[dttjtjj| jdfS dS )zReport whether or not disabling is possible for the entitlement.
:return:
(True, None) if can disable
(False, CanDisableFailure) if can't disable
Fr r rE )rx r r r r ALREADY_DISABLEDr rG r: r rB r r NOT_APPLICABLE CANNOT_DISABLE_NOT_APPLICABLEr] detect_dependent_servicesACTIVE_DEPENDENT_SERVICESsupports_purger PURGE_NOT_SUPPORTEDDISABLE_PURGE_NOT_SUPPORTED)r( r rx r{ r r) r) r* can_disable= sJ
zUAEntitlement.can_disablec C s | d| jd | \}}|s3|du rdS |jtjkr/| |\}}|s.||_d|fS nd|fS | |s:dS |
s@dS | d| jd dS )a Disable specific entitlement
@param silent: Boolean set True to silence print/log of messages
@return: tuple of (success, optional reason)
(True, None) on success.
(False, reason) otherwise. reason is only non-None if it is a
populated CanDisableFailure reason. This may expand to
include other types of reasons in the future.
r pre_disableNr F post_disablerE ) r r rC r% r r r! _disable_dependent_servicesr _perform_disabler )r( r r% r r r r) r) r* r | s(
zUAEntitlement.disablec C r2 )a\
Disable specific entitlement. This should be implemented by subclasses.
This method does the actual disable, and does not check can_disable
or handle pre_disable or post_disable messaging.
@param silent: Boolean set True to silence print/log of messages
@return: True on success, False otherwise.
Nr) r r) r) r* r) s z UAEntitlement._perform_disablec C r )z
Check for depedent services.
:return:
True if there are dependent services enabled
False if there are no dependent services enabled
r )rl r r3 r) r) r* r r
z'UAEntitlement.detect_dependent_servicesc C s: g }| j D ]}|| j \}}|tjkr|| q|S )zo
Return list of depedent services that must be disabled
before disabling this service.
)r] rs rx r ry r8 )r( blockingdependent_service_clsr r{ r) r) r* r s
z)UAEntitlement.blocking_dependent_servicesc C s | D ]=}|| jd}|dtjj|jd ||\}}|sAd}|r2|jr2|jj r2d|jj }tj
j||jd}d|f S qdS ) ay
Disable dependent services
When performing a disable operation, we might have
other services that depend on the original services.
If that is true, we will alert the user about this
and prompt for confirmation to disable these services
as well.
@param silent: Boolean set True to silence print/log of messages
r r )r r0 rK )r r FrE ) r rs r r DISABLING_DEPENDENT_SERVICErG r: r r r "FAILED_DISABLING_DEPENDENT_SERVICE)r( r r+ r r r r r r) r) r* r( s&
z)UAEntitlement._disable_dependent_servicesc C r2 )z=Check if system needs to be rebooted because of this service.Fr) r3 r) r) r* _check_for_reboot rU z UAEntitlement._check_for_reboot operationsilentc C s, | r|sttjj|d dS dS dS )zCheck if user should be alerted that a reboot must be performed.
@param operation: The operation being executed.
@param silent: Boolean set True to silence print/log of messages
)r/ N)r. r r r ENABLE_REBOOT_REQUIRED_TMPLrG )r( r/ r0 r) r) r* _check_for_reboot_msg s z#UAEntitlement._check_for_reboot_msgc C s* | j }|s tjtjfS | jD ]\}}}| |kr tj|f S q|d di }|dd}| jrR|durRt
|vrRt |}tjtj
j| jt
d|dfS |dd}| jru|durut j|vrutjtjj| jt jdfS t } |d d}
|d
d} | jr|
dur| j|
vrtjtjj| j| jd|
d fS | jr| r| j dur| j durtj j| j| j| d } z| d
\}
}t |
}t |}W n t!y t"#d| tj| f Y S w | j |k rtj| fS | j |kr| j |k rtj| fS |di }| $|\}}|stj|fS tjdfS )a Check all contract affordances to vet current platform
Affordances are a list of support constraints for the entitlement.
Examples include a list of supported series, architectures for kernel
revisions.
:return:
tuple of (ApplicabilityStatus, NamedMessage). APPLICABLE if
platform passes all defined affordances, INAPPLICABLE if it doesn't
meet all of the provided constraints.
r$ r=
architecturesNz, )r: archsupported_archesseries)r: r6
kernelFlavorsminKernelVersion)r: kernelsupported_kernels)r: r9
min_kernel.z$Could not parse minKernelVersion: %splatformChecks)%rB r
APPLICABLEr "NO_ENTITLEMENT_AFFORDANCES_CHECKEDrT r rC affordance_check_archr
get_dpkg_archr deduplicate_archesINAPPLICABLE_ARCHrG r: rO affordance_check_seriesget_release_infor6 INAPPLICABLE_SERIESpretty_versionget_kernel_info affordance_check_kernel_flavorflavorINAPPLICABLE_KERNEL
uname_release#affordance_check_kernel_min_versionmajorminorINAPPLICABLE_KERNEL_VERsplitint
ValueErrorr r rF )r( rB
error_messagefunctorexpected_resultr= affordance_archesdeduplicated_archesaffordance_series kernel_infoaffordance_kernelsaffordance_min_kernel invalid_msg kernel_major kernel_minormin_kern_majormin_kern_minoraffordances_platform_checkr r r) r) r* r s
z"UAEntitlement.applicability_statusc C s6 t | jjs tjS | j}|r|d drtjS tjS )z=Return whether the user is entitled to the entitlement or notr$ entitled)r rs is_attachedr r rB rC r r r) r) r* r m s z UAEntitlement.contract_statusc C s | \}}|tjkrtj|fS | j}|s tjtjj | j
dfS |d dddu r5tjtjj | j
dfS | \}}|t
jkrEtj|fS |t
jkrOtj|fS | \}}|r\tj|fS tj|fS )z4Return (user-facing status, details) for entitlementr r$ rc F)r r r> r r rB UNAVAILABLEr SERVICE_NOT_ENTITLEDrG r: rC rx r r INACTIVEr enabled_warning_statusACTIVE)r(
applicabilityr rB rx explanationr warn_msgr) r) r* user_facing_statusv s*
z UAEntitlement.user_facing_statusc C r2 )z
The current status of application of this entitlement
:return:
A tuple of (ApplicationStatus, human-friendly reason)
Nr) r3 r) r) r* rx
z UAEntitlement.application_statusc C r2 )z
If the entitlment is enabled, are there any warnings?
The message is displayed as a Warning Notice in status output
:return:
A tuple of (warning bool, human-friendly reason)
r r) r3 r) r) r* rh rn z$UAEntitlement.enabled_warning_statusc C s d S r' r) r3 r) r) r* status_description_override r5 z)UAEntitlement.status_description_overridec C s4 | j d}|s
dS t|d}|t krdS dS )z s (4
(