FM / entitlements

/usr/lib/python3/dist-packages/uaclient/entitlements/

/usr/lib/python3/dist-packages/uaclient/entitlements

Name	Size	Mode	Actions
__pycache__/	-	0755	rm
anbox.py	3133	0644	edit dl rm
base.py	47864	0644	edit dl rm
cc.py	1013	0644	edit dl rm
cis.py	1174	0644	edit dl rm
entitlement_status.py	3355	0644	edit dl rm
esm.py	4589	0644	edit dl rm
esm_legacy.py	703	0644	edit dl rm
fips.py	26617	0644	edit dl rm
landscape.py	4508	0644	edit dl rm
livepatch.py	14457	0644	edit dl rm
realtime.py	7278	0644	edit dl rm
repo.py	27279	0644	edit dl rm
ros.py	2020	0644	edit dl rm
__init__.py	8939	0644	edit dl rm

Edit: /usr/lib/python3/dist-packages/uaclient/entitlements/entitlement_status.py (3355B)

import enum
from typing import Optional

from uaclient import messages

@enum.unique
class ApplicationStatus(enum.Enum):
    """
    An enum to represent the current application status of an entitlement
    """

ENABLED = object()
    DISABLED = object()
    WARNING = object()

@enum.unique
class ContractStatus(enum.Enum):
    """
    An enum to represent whether a user is entitled to an entitlement

(The value of each member is the string that will be used in status
    output.)
    """

ENTITLED = "yes"
    UNENTITLED = "no"

@enum.unique
class ApplicabilityStatus(enum.Enum):
    """
    An enum to represent whether an entitlement could apply to this machine
    """

APPLICABLE = object()
    INAPPLICABLE = object()

@enum.unique
class UserFacingAvailability(enum.Enum):
    """
    An enum representing whether a service could be available for a machine.

'Availability' means whether a service is available to machines with this
    architecture, series and kernel. Whether a contract is entitled to use
    the specific service is determined by the contract level.

This enum should only be used in display code, it should not be used in
    business logic.
    """

AVAILABLE = "yes"
    UNAVAILABLE = "no"

@enum.unique
class UserFacingConfigStatus(enum.Enum):
    """
    An enum representing the user-visible config status of Pro system.

This enum will be used in display code and will be written to status.json
    """

INACTIVE = "inactive"  # No Pro config commands/daemons
    ACTIVE = "active"  # Pro command is running
    REBOOTREQUIRED = "reboot-required"  # System Reboot required

@enum.unique
class UserFacingStatus(enum.Enum):
    """
    An enum representing the states we will display in status output.

This enum should only be used in display code, it should not be used in
    business logic.
    """

ACTIVE = "enabled"
    INACTIVE = "disabled"
    INAPPLICABLE = "n/a"
    UNAVAILABLE = "—"
    WARNING = "warning"

@enum.unique
class CanEnableFailureReason(enum.Enum):
    """
    An enum representing the reasons an entitlement can't be enabled.
    """

NOT_ENTITLED = object()
    ALREADY_ENABLED = object()
    INAPPLICABLE = object()
    IS_BETA = object()
    INCOMPATIBLE_SERVICE = object()
    INACTIVE_REQUIRED_SERVICES = object()
    ACCESS_ONLY_NOT_SUPPORTED = object()
    ONLY_ACCESS_ONLY_SUPPORTED = object()

class CanEnableFailure:
    def __init__(
        self,
        reason: CanEnableFailureReason,
        message: Optional[messages.NamedMessage] = None,
    ) -> None:
        self.reason = reason
        self.message = message

@enum.unique
class CanDisableFailureReason(enum.Enum):
    """
    An enum representing the reasons an entitlement can't be disabled.
    """

ALREADY_DISABLED = object()
    NOT_APPLICABLE = object()
    ACTIVE_DEPENDENT_SERVICES = object()
    PURGE_NOT_SUPPORTED = object()
    NOT_FOUND_DEPENDENT_SERVICE = object()
    NO_PURGE_WITHOUT_ORIGIN = object()

class CanDisableFailure:
    def __init__(
        self,
        reason: CanDisableFailureReason,
        message: Optional[messages.NamedMessage] = None,
    ) -> None:
        self.reason = reason
        self.message = message

@property
    def message_value(self) -> str:
        return self.message.msg if self.message else ""

import enum from typing import Optional from uaclient import messages @enum.unique class ApplicationStatus(enum.Enum): """ An enum to represent the current application status of an entitlement """ ENABLED = object() DISABLED = object() WARNING = object() @enum.unique class ContractStatus(enum.Enum): """ An enum to represent whether a user is entitled to an entitlement (The value of each member is the string that will be used in status output.) """ ENTITLED = "yes" UNENTITLED = "no" @enum.unique class ApplicabilityStatus(enum.Enum): """ An enum to represent whether an entitlement could apply to this machine """ APPLICABLE = object() INAPPLICABLE = object() @enum.unique class UserFacingAvailability(enum.Enum): """ An enum representing whether a service could be available for a machine. 'Availability' means whether a service is available to machines with this architecture, series and kernel. Whether a contract is entitled to use the specific service is determined by the contract level. This enum should only be used in display code, it should not be used in business logic. """ AVAILABLE = "yes" UNAVAILABLE = "no" @enum.unique class UserFacingConfigStatus(enum.Enum): """ An enum representing the user-visible config status of Pro system. This enum will be used in display code and will be written to status.json """ INACTIVE = "inactive" # No Pro config commands/daemons ACTIVE = "active" # Pro command is running REBOOTREQUIRED = "reboot-required" # System Reboot required @enum.unique class UserFacingStatus(enum.Enum): """ An enum representing the states we will display in status output. This enum should only be used in display code, it should not be used in business logic. """ ACTIVE = "enabled" INACTIVE = "disabled" INAPPLICABLE = "n/a" UNAVAILABLE = "—" WARNING = "warning" @enum.unique class CanEnableFailureReason(enum.Enum): """ An enum representing the reasons an entitlement can't be enabled. """ NOT_ENTITLED = object() ALREADY_ENABLED = object() INAPPLICABLE = object() IS_BETA = object() INCOMPATIBLE_SERVICE = object() INACTIVE_REQUIRED_SERVICES = object() ACCESS_ONLY_NOT_SUPPORTED = object() ONLY_ACCESS_ONLY_SUPPORTED = object() class CanEnableFailure: def __init__( self, reason: CanEnableFailureReason, message: Optional[messages.NamedMessage] = None, ) -> None: self.reason = reason self.message = message @enum.unique class CanDisableFailureReason(enum.Enum): """ An enum representing the reasons an entitlement can't be disabled. """ ALREADY_DISABLED = object() NOT_APPLICABLE = object() ACTIVE_DEPENDENT_SERVICES = object() PURGE_NOT_SUPPORTED = object() NOT_FOUND_DEPENDENT_SERVICE = object() NO_PURGE_WITHOUT_ORIGIN = object() class CanDisableFailure: def __init__( self, reason: CanDisableFailureReason, message: Optional[messages.NamedMessage] = None, ) -> None: self.reason = reason self.message = message @property def message_value(self) -> str: return self.message.msg if self.message else ""