"""
Copyright 2019 Inmanta
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Contact: code@inmanta.com
"""
import base64
import inspect
import logging
import traceback
import typing
import uuid
from collections import defaultdict
from concurrent.futures import Future
from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Type, TypeVar, Union, cast, overload
from tornado import concurrent
from inmanta import const, data, protocol, resources
from inmanta.agent import io
from inmanta.agent.cache import AgentCache
from inmanta.const import ParameterSource, ResourceState
from inmanta.data.model import AttributeStateChange
from inmanta.protocol import Result
from inmanta.types import SimpleTypes
from inmanta.util import hash_file
if typing.TYPE_CHECKING:
import inmanta.agent.agent
from inmanta.agent.io.local import IOBase
LOGGER = logging.getLogger(__name__)
T = TypeVar("T")
T_FUNC = TypeVar("T_FUNC", bound=Callable[..., Any])
[docs]class provider(object): # noqa: N801
"""
A decorator that registers a new handler.
:param resource_type: The type of the resource this handler provides an implementation for.
For example, :inmanta:entity:`std::File`
:param name: A name to reference this provider.
"""
def __init__(self, resource_type: str, name: str) -> None:
self._resource_type = resource_type
self._name = name
def __call__(self, function):
"""
The wrapping
"""
Commander.add_provider(self._resource_type, self._name, function)
return function
[docs]class SkipResource(Exception):
"""
A handler should raise this exception when a resource should be skipped. The resource will be marked as skipped
instead of failed.
"""
[docs]class ResourcePurged(Exception):
"""
If the :func:`~inmanta.agent.handler.CRUDHandler.read_resource` method raises this exception, the agent will
mark the current state of the resource as purged.
"""
class InvalidOperation(Exception):
"""
This exception is raised by the context or handler methods when an invalid operation is performed.
"""
[docs]def cache(
func: T_FUNC = None,
ignore: typing.List[str] = [],
timeout: int = 5000,
for_version: bool = True,
cache_none: bool = True,
cacheNone: bool = True, # noqa: N803
call_on_delete: Optional[Callable[[Any], None]] = None,
) -> Union[T_FUNC, Callable[[T_FUNC], T_FUNC]]:
"""
decorator for methods in resource handlers to provide caching
this decorator works similar to memoization:
when the decorate method is called, its return value is cached,
for subsequent calls, the cached value is used instead of the actual value
The name of the method + the arguments of the method form the cache key
If an argument named version is present and for_version is True,
the cache entry is flushed after this version has been deployed
If an argument named resource is present,
it is assumed to be a resource and its ID is used, without the version information
:param timeout: the number of second this cache entry should live
:param for_version: if true, this value is evicted from the cache when this deploy is ready
:param ignore: a list of argument names that should not be part of the cache key
:param cache_none: cache returned none values
:param call_on_delete: A callback function that is called when the value is removed from the cache,
with the value as argument.
"""
def actual(f) -> T_FUNC:
myignore = set(ignore)
sig = inspect.signature(f)
myargs = list(sig.parameters.keys())[1:]
def wrapper(self, *args, **kwds):
kwds.update(dict(zip(myargs, args)))
def bound(**kwds):
return f(self, **kwds)
cache_none = cacheNone
return self.cache.get_or_else(
f.__name__, bound, for_version, timeout, myignore, cache_none, **kwds, call_on_delete=call_on_delete
)
# Too much magic to type statically
return cast(T_FUNC, wrapper)
if func is None:
return actual
else:
return actual(func)
[docs]class HandlerContext(object):
"""
Context passed to handler methods for state related "things"
"""
def __init__(
self,
resource: resources.Resource,
dry_run: bool = False,
action_id: Optional[uuid.UUID] = None,
logger: logging.Logger = None,
) -> None:
self._resource = resource
self._dry_run = dry_run
self._cache: Dict[str, Any] = {}
self._purged = False
self._updated = False
self._created = False
self._change = const.Change.nochange
self._changes: Dict[str, AttributeStateChange] = {}
if action_id is None:
action_id = uuid.uuid4()
self._action_id = action_id
self._status: Optional[ResourceState] = None
self._logs: List[data.LogLine] = []
if logger is None:
self.logger = LOGGER
else:
self.logger = logger
self._facts: List[Dict[str, Any]] = []
[docs] def set_fact(self, fact_id: str, value: str) -> None:
"""
Send a fact to the Inmanta server.
:param fact_id: The name of the fact.
:param value: The actual value of the fact.
"""
resource_id = self._resource.id.resource_str()
fact = {
"id": fact_id,
"source": ParameterSource.fact.value,
"value": value,
"resource_id": resource_id,
}
self._facts.append(fact)
@property
def facts(self) -> List[Dict[str, Any]]:
return self._facts
@property
def action_id(self) -> uuid.UUID:
return self._action_id
@property
def status(self) -> Optional[const.ResourceState]:
return self._status
@property
def logs(self) -> List[data.LogLine]:
return self._logs
[docs] def set_status(self, status: const.ResourceState) -> None:
"""
Set the status of the handler operation.
"""
self._status = status
[docs] def is_dry_run(self) -> bool:
"""
Is this a dryrun?
"""
return self._dry_run
def get(self, name: str) -> Any:
return self._cache[name]
def contains(self, key: str) -> bool:
return key in self._cache
def set(self, name: str, value: Any) -> None:
self._cache[name] = value
def set_created(self) -> None:
self._created = True
if self._change is not const.Change.nochange:
raise InvalidOperation(f"Unable to set {const.Change.created} operation, {self._change} already set.")
self._change = const.Change.created
def set_purged(self) -> None:
self._purged = True
if self._change is not const.Change.nochange:
raise InvalidOperation(f"Unable to set {const.Change.purged} operation, {self._change} already set.")
self._change = const.Change.purged
def set_updated(self) -> None:
self._updated = True
if self._change is not const.Change.nochange:
raise InvalidOperation(f"Unable to set {const.Change.updated} operation, {self._change} already set.")
self._change = const.Change.updated
@property
def changed(self) -> bool:
return self._created or self._updated or self._purged
@property
def change(self) -> const.Change:
return self._change
[docs] def add_change(self, name: str, desired: typing.Any, current: typing.Any = None) -> None:
"""
Report a change of a field. This field is added to the set of updated fields
:param name: The name of the field that was updated
:param desired: The desired value to which the field was updated (or should be updated)
:param current: The value of the field before it was updated
"""
self._changes[name] = AttributeStateChange(current=current, desired=desired)
[docs] def add_changes(self, **kwargs: SimpleTypes) -> None:
"""
Report a list of changes at once as kwargs
:param key: The name of the field that was updated. This field is also added to the set of updated fields
:param value: The desired value of the field.
To report the previous value of the field, use the add_change method
"""
for field, value in kwargs.items():
self._changes[field] = AttributeStateChange(desired=value)
[docs] def fields_updated(self, fields: str) -> None:
"""
Report that fields have been updated
"""
for field in fields:
if field not in self._changes:
self._changes[fields] = AttributeStateChange()
@overload # noqa: F811
def update_changes(self, changes: Dict[str, AttributeStateChange]) -> None:
pass
@overload # noqa: F811
def update_changes(self, changes: Dict[str, Dict[str, Optional[SimpleTypes]]]) -> None:
pass
@overload # noqa: F811
def update_changes(self, changes: Dict[str, Tuple[SimpleTypes, SimpleTypes]]) -> None:
pass
[docs] def update_changes( # noqa: F811
self,
changes: Union[
Dict[str, AttributeStateChange],
Dict[str, Dict[str, Optional[SimpleTypes]]],
Dict[str, Tuple[SimpleTypes, SimpleTypes]],
],
) -> None:
"""
Update the changes list with changes
:param changes: This should be a dict with a value a dict containing "current" and "desired" keys
"""
for attribute, change in changes.items():
if isinstance(change, dict):
self._changes[attribute] = AttributeStateChange(
current=change.get("current", None), desired=change.get("desired", None)
)
elif isinstance(change, tuple):
if len(change) != 2:
raise InvalidOperation(
f"Reported changes for {attribute} not valid. Tuple changes should contain 2 element."
)
self._changes[attribute] = AttributeStateChange(current=change[0], desired=change[1])
elif isinstance(change, AttributeStateChange):
self._changes[attribute] = change
else:
raise InvalidOperation(f"Reported changes for {attribute} not in a type that is recognized.")
@property
def changes(self) -> Dict[str, AttributeStateChange]:
return self._changes
def log_msg(self, level: int, msg: str, args: Sequence, kwargs: dict) -> None:
if len(args) > 0:
raise Exception("Args not supported")
if "exc_info" in kwargs:
exc_info = kwargs["exc_info"]
kwargs["traceback"] = traceback.format_exc()
else:
exc_info = False
log = data.LogLine.log(level, msg, **kwargs)
self.logger.log(level, "resource %s: %s", self._resource.id.resource_version_str(), log._data["msg"], exc_info=exc_info)
self._logs.append(log)
[docs] def debug(self, msg: str, *args, **kwargs) -> None:
"""
Log 'msg % args' with severity 'DEBUG'.
To pass exception information, use the keyword argument exc_info with
a true value, e.g.
``logger.debug("Houston, we have a %s", "thorny problem", exc_info=1)``
"""
self.log_msg(logging.DEBUG, msg, args, kwargs)
[docs] def info(self, msg: str, *args, **kwargs) -> None:
"""
Log 'msg % args' with severity 'INFO'.
To pass exception information, use the keyword argument exc_info with
a true value, e.g.
``logger.info("Houston, we have a %s", "interesting problem", exc_info=1)``
"""
self.log_msg(logging.INFO, msg, args, kwargs)
[docs] def warning(self, msg: str, *args, **kwargs) -> None:
"""
Log 'msg % args' with severity 'WARNING'.
To pass exception information, use the keyword argument exc_info with
a true value, e.g.
``logger.warning("Houston, we have a %s", "bit of a problem", exc_info=1)``
"""
self.log_msg(logging.WARNING, msg, args, kwargs)
[docs] def error(self, msg: str, *args, **kwargs) -> None:
"""
Log 'msg % args' with severity 'ERROR'.
To pass exception information, use the keyword argument exc_info with
a true value, e.g.
``logger.error("Houston, we have a %s", "major problem", exc_info=1)``
"""
self.log_msg(logging.ERROR, msg, args, kwargs)
[docs] def exception(self, msg: str, *args, exc_info=True, **kwargs) -> None:
"""
Convenience method for logging an ERROR with exception information.
"""
self.error(msg, *args, exc_info=exc_info, **kwargs)
[docs] def critical(self, msg: str, *args, **kwargs) -> None:
"""
Log 'msg % args' with severity 'CRITICAL'.
To pass exception information, use the keyword argument exc_info with
a true value, e.g.
``logger.critical("Houston, we have a %s", "major disaster", exc_info=1)``
"""
self.log_msg(logging.CRITICAL, msg, args, kwargs)
[docs]class ResourceHandler(object):
"""
A baseclass for classes that handle resources. New handler are registered with the
:func:`~inmanta.agent.handler.provider` decorator.
The implementation of a handler should use the ``self._io`` instance to execute io operations. This io objects
makes abstraction of local or remote operations. See :class:`~inmanta.agent.io.local.LocalIO` for the available
operations.
:param agent: The agent that is executing this handler.
:param io: The io object to use.
"""
def __init__(self, agent: "inmanta.agent.agent.AgentInstance", io: "IOBase" = None) -> None:
self._agent = agent
if io is None:
raise Exception("Unsupported: no resource mgmt in RH")
else:
self._io = io
self._client: Optional[protocol.SessionClient] = None
# explicit ioloop reference, as we don't want the ioloop for the current thread, but the one for the agent
self._ioloop = agent.process._io_loop
[docs] def run_sync(self, func: typing.Callable[[], T]) -> T:
"""
Run a the given async function on the ioloop of the agent. It will block the current thread until the future
resolves.
:param func: A function that returns a yieldable future.
:return: The result of the async function.
"""
f: Future[T] = Future()
# This function is not typed because of generics, the used methods and currying
def run():
try:
result = func()
if result is not None:
from tornado.gen import convert_yielded
result = convert_yielded(result)
concurrent.chain_future(result, f)
except Exception as e:
f.set_exception(e)
self._ioloop.add_callback(run)
return f.result()
[docs] def set_cache(self, cache: AgentCache) -> None:
self.cache = cache
[docs] def get_client(self) -> protocol.SessionClient:
"""
Get the client instance that identifies itself with the agent session.
:return: A client that is associated with the session of the agent that executes this handler.
"""
if self._client is None:
self._client = protocol.SessionClient("agent", self._agent.sessionid)
return self._client
[docs] def process_events(self, ctx: HandlerContext, resource: resources.Resource, events: dict) -> None:
"""
Process events generated by changes to required resources. Override this method to process events in a handler.
The default implementation provides the reload mechanism. It will call do_reload when the handler can_reload() and
if at least one of the dependents have successfully deployed and there were changes. Make sure to call this method
from a subclass if the reload behaviour is required.
This method is called for all dependents of the given resource (inverse of the requires relationship)
that have send_event set to true and for which a deploy was started. These are the only conditions, even if all
dependents have failed or no changes were deployed. It is up to the handler to filter out irrelevant events.
In case of partial deployments (e.g. incremental deploy), only those resources that are being deployed will produce
an event. I.e. it is possible to receive less events then expected.
In case of failure of agent, server or the system being managed, delivery of events can not be guaranteed.
Update events can be lost unrecoverably in case the agent or server fails after the update was performed, but before
the event was emitted. In the current implementation, start of a new deploy while another is in progress can also
causes updates to be lost.
However, while event delivery can not be guaranteed, convergence to the desired state can be reliably detected.
If the record of the convergence is lost, it will be retried until it is recorded.
For strong behavioral guarantees, it is better to rely on desired state than on events.
Events are best used to accelerate convergence.
For example, cross agent dependencies primarily make use of the deployment log on the server to determine if their
dependencies are in their desired state. To speed up convergence, events are sent to notify other agents of relevant
changes to resources they depend on.
:param ctx: Context object to report changes and logs to the agent and server.
:param resource: The resource to process the events for.
:param dict: A dict with events of the resource the given resource requires. The keys of the dict are the resources.
Each value is a dict with the items status (const.ResourceState), changes (dict) and
change (const.Change). The value is also defined by inmanta.data.model.Event
"""
# ctx.status == const.ResourceState.deployed is only true if
# 1- this resource was deployed (i.e. this is not a run to process events of failed dependencies)
# 2- this resource was deployed successfully
if self.can_reload() and ctx.status == const.ResourceState.deployed:
reload = False
for res, result in events.items():
ctx.debug("Processing changes of %(res)s", res=res, result=result)
if result["status"] == const.ResourceState.deployed and len(result["changes"]) > 0:
reload = True
break
if reload:
self.do_reload(ctx, resource)
[docs] def can_process_events(self) -> bool:
"""
Can this handler process events? This is a more generic version of the reload mechanism.
See the :py:func:`ResourceHandler.process_events` for more details about this mechanism.
:return: Return true if this handler processes events.
"""
return self.can_reload()
[docs] def can_reload(self) -> bool:
"""
Can this handler reload?
:return: Return true if this handler needs to reload on requires changes.
"""
return False
[docs] def do_reload(self, ctx: HandlerContext, resource: resources.Resource) -> None:
"""
Perform a reload of this resource.
:param ctx: Context object to report changes and logs to the agent and server.
:param resource: The resource to reload.
"""
[docs] def pre(self, ctx: HandlerContext, resource: resources.Resource) -> None:
"""
Method executed before a handler operation (Facts, dryrun, real deployment, ...) is executed. Override this method
to run before an operation.
:param ctx: Context object to report changes and logs to the agent and server.
:param resource: The resource to query facts for.
"""
[docs] def post(self, ctx: HandlerContext, resource: resources.Resource) -> None:
"""
Method executed after an operation. Override this method to run after an operation.
:param ctx: Context object to report changes and logs to the agent and server.
:param resource: The resource to query facts for.
"""
[docs] def close(self) -> None:
pass
[docs] def _diff(self, current: resources.Resource, desired: resources.Resource) -> typing.Dict[str, typing.Dict[str, typing.Any]]:
"""
Calculate the diff between the current and desired resource state.
:param current: The current state of the resource
:param desired: The desired state of the resource
:return: A dict with key the name of the field and value another dict with "current" and "desired" as keys for
fields that require changes.
"""
changes = {}
# check attributes
for field in current.__class__.fields:
current_value = getattr(current, field)
desired_value = getattr(desired, field)
if current_value != desired_value and desired_value is not None:
changes[field] = {"current": current_value, "desired": desired_value}
return changes
[docs] def check_resource(self, ctx: HandlerContext, resource: resources.Resource) -> resources.Resource:
"""
Check the current state of a resource
:param ctx: Context object to report changes and logs to the agent and server.
:param resource: The resource to check the current state of.
:return: A resource to represents the current state. Use the :func:`~inmanta.resources.Resource.clone` to create
clone of the given resource that can be modified.
"""
raise NotImplementedError()
[docs] def list_changes(self, ctx: HandlerContext, resource: resources.Resource) -> typing.Dict[str, typing.Dict[str, typing.Any]]:
"""
Returns the changes required to bring the resource on this system in the state described in the resource entry.
This method calls :func:`~inmanta.agent.handler.ResourceHandler.check_resource`
:param ctx: Context object to report changes and logs to the agent and server.
:param resource: The resource to check the current state of.
:return: A dict with key the name of the field and value another dict with "current" and "desired" as keys for
fields that require changes.
"""
current = self.check_resource(ctx, resource)
return self._diff(current, resource)
[docs] def do_changes(self, ctx: HandlerContext, resource: resources.Resource, changes: dict) -> None:
"""
Do the changes required to bring the resource on this system in the state of the given resource.
:param ctx: Context object to report changes and logs to the agent and server.
:param resource: The resource to check the current state of.
:param changes: The changes that need to occur as reported by
:func:`~inmanta.agent.handler.ResourceHandler.list_changes`
"""
raise NotImplementedError()
[docs] def execute(self, ctx: HandlerContext, resource: resources.Resource, dry_run: bool = False) -> None:
"""
Update the given resource. This method is called by the agent. Most handlers will not override this method
and will only override :func:`~inmanta.agent.handler.ResourceHandler.check_resource`, optionally
:func:`~inmanta.agent.handler.ResourceHandler.list_changes` and
:func:`~inmanta.agent.handler.ResourceHandler.do_changes`
:param ctx: Context object to report changes and logs to the agent and server.
:param resource: The resource to check the current state of.
:param dry_run: True will only determine the required changes but will not execute them.
"""
try:
self.pre(ctx, resource)
changes = self.list_changes(ctx, resource)
ctx.update_changes(changes)
if not dry_run:
self.do_changes(ctx, resource, changes)
ctx.set_status(const.ResourceState.deployed)
else:
ctx.set_status(const.ResourceState.dry)
except SkipResource as e:
ctx.set_status(const.ResourceState.skipped)
ctx.warning(msg="Resource %(resource_id)s was skipped: %(reason)s", resource_id=resource.id, reason=e.args)
except Exception as e:
ctx.set_status(const.ResourceState.failed)
ctx.exception(
"An error occurred during deployment of %(resource_id)s (exception: %(exception)s",
resource_id=resource.id,
exception=repr(e),
)
finally:
try:
self.post(ctx, resource)
except Exception as e:
ctx.exception(
"An error occurred after deployment of %(resource_id)s (exception: %(exception)s",
resource_id=resource.id,
exception=repr(e),
)
[docs] def facts(self, ctx: HandlerContext, resource: resources.Resource) -> dict:
"""
Override this method to implement fact querying. A queried fact can be reported back in two different ways:
either via the return value of this method or by adding the fact to the HandlerContext via the
:func:`~inmanta.agent.handler.HandlerContext.set_fact` method. :func:`~inmanta.agent.handler.ResourceHandler.pre`
and :func:`~inmanta.agent.handler.ResourceHandler.post` are called before and after this method.
:param ctx: Context object to report changes, logs and facts to the agent and server.
:param resource: The resource to query facts for.
:return: A dict with fact names as keys and facts values.
"""
return {}
[docs] def check_facts(self, ctx: HandlerContext, resource: resources.Resource) -> dict:
"""
This method is called by the agent to query for facts. It runs :func:`~inmanta.agent.handler.ResourceHandler.pre`
and :func:`~inmanta.agent.handler.ResourceHandler.post`. This method calls
:func:`~inmanta.agent.handler.ResourceHandler.facts` to do the actually querying.
:param ctx: Context object to report changes and logs to the agent and server.
:param resource: The resource to query facts for.
:return: A dict with fact names as keys and facts values.
"""
try:
self.pre(ctx, resource)
facts = self.facts(ctx, resource)
finally:
try:
self.post(ctx, resource)
except Exception as e:
ctx.exception(
"An error occurred after getting facts about %(resource_id)s (exception: %(exception)s",
resource_id=resource.id,
exception=repr(e),
)
return facts
[docs] def available(self, resource: resources.Resource) -> bool:
"""
Returns true if this handler is available for the given resource
:param resource: Is this handler available for the given resource?
:return: Available or not?
"""
return True
[docs] def get_file(self, hash_id: str) -> Optional[bytes]:
"""
Retrieve a file from the fileserver identified with the given id. The convention is to use the sha1sum of the
content to identify it.
:param hash_id: The id of the content/file to retrieve from the server.
:return: The content in the form of a bytestring or none is the content does not exist.
"""
def call() -> Result:
return self.get_client().get_file(hash_id)
result = self.run_sync(call)
if result.code == 404:
return None
elif result.code == 200:
file_contents = base64.b64decode(result.result["content"])
actual_hash_of_file = hash_file(file_contents)
if hash_id != actual_hash_of_file:
raise Exception(f"File hash verification failed, expected: {hash_id} but got {actual_hash_of_file}")
return file_contents
else:
raise Exception("An error occurred while retrieving file %s" % hash_id)
[docs] def stat_file(self, hash_id: str) -> bool:
"""
Check if a file exists on the server. This method does and async call to the server and blocks on the result.
:param hash_id: The id of the file on the server. The convention is the use the sha1sum of the content as id.
:return: True if the file is available on the server.
"""
def call() -> Result:
return self.get_client().stat_file(hash_id)
result = self.run_sync(call)
return result.code == 200
[docs] def upload_file(self, hash_id: str, content: bytes) -> None:
"""
Upload a file to the server
:param hash_id: The id to identify the content. The convention is to use the sha1sum of the content to identify it.
:param content: A byte string with the content
"""
def call() -> Result:
return self.get_client().upload_file(id=hash_id, content=base64.b64encode(content).decode("ascii"))
try:
self.run_sync(call)
except Exception:
raise Exception("Unable to upload file to the server.")
[docs]class CRUDHandler(ResourceHandler):
"""
This handler base class requires CRUD methods to be implemented: create, read, update and delete. Such a handler
only works on purgeable resources.
"""
[docs] def read_resource(self, ctx: HandlerContext, resource: resources.PurgeableResource) -> None:
"""
This method reads the current state of the resource. It provides a copy of the resource that should be deployed,
the method implementation should modify the attributes of this resource to the current state.
:param ctx: Context can be used to pass value discovered in the read method to the CUD methods. For example, the
id used in API calls
:param resource: A clone of the desired resource state. The read method need to set values on this object.
:raise SkipResource: Raise this exception when the handler should skip this resource
:raise ResourcePurged: Raise this exception when the resource does not exist yet.
"""
[docs] def create_resource(self, ctx: HandlerContext, resource: resources.PurgeableResource) -> None:
"""
This method is called by the handler when the resource should be created.
:param context: Context can be used to get values discovered in the read method. For example, the id used in API
calls. This context should also be used to let the handler know what changes were made to the
resource.
:param resource: The desired resource state.
"""
[docs] def delete_resource(self, ctx: HandlerContext, resource: resources.PurgeableResource) -> None:
"""
This method is called by the handler when the resource should be deleted.
:param ctx: Context can be used to get values discovered in the read method. For example, the id used in API
calls. This context should also be used to let the handler know what changes were made to the
resource.
:param resource: The desired resource state.
"""
[docs] def update_resource(self, ctx: HandlerContext, changes: dict, resource: resources.PurgeableResource) -> None:
"""
This method is called by the handler when the resource should be updated.
:param ctx: Context can be used to get values discovered in the read method. For example, the id used in API
calls. This context should also be used to let the handler know what changes were made to the
resource.
:param changes: A map of resource attributes that should be changed. Each value is a tuple with the current and the
desired value.
:param resource: The desired resource state.
"""
[docs] def calculate_diff(
self, ctx: HandlerContext, current: resources.Resource, desired: resources.Resource
) -> typing.Dict[str, typing.Dict[str, typing.Any]]:
"""
Calculate the diff between the current and desired resource state.
:param ctx: Context can be used to get values discovered in the read method. For example, the id used in API
calls. This context should also be used to let the handler know what changes were made to the
resource.
:param current: The current state of the resource
:param desired: The desired state of the resource
:return: A dict with key the name of the field and value another dict with "current" and "desired" as keys for
fields that require changes.
"""
return self._diff(current, desired)
[docs] def execute(self, ctx: HandlerContext, resource: resources.Resource, dry_run: bool = None) -> None:
"""
Update the given resource. This method is called by the agent. Override the CRUD methods of this class.
:param ctx: Context object to report changes and logs to the agent and server.
:param resource: The resource to check the current state of.
:param dry_run: True will only determine the required changes but will not execute them.
"""
try:
self.pre(ctx, resource)
# current is clone, except for purged is set to false to prevent a bug that occurs often where the desired
# state defines purged=true but the read_resource fails to set it to false if the resource does exist
desired = resource
assert isinstance(desired, resources.PurgeableResource)
current = desired.clone(purged=False)
assert isinstance(current, resources.PurgeableResource)
changes: typing.Dict[str, typing.Dict[str, typing.Any]] = {}
try:
ctx.debug("Calling read_resource")
self.read_resource(ctx, current)
changes = self.calculate_diff(ctx, current, desired)
except ResourcePurged:
if not desired.purged:
changes["purged"] = dict(desired=desired.purged, current=True)
for field, values in changes.items():
ctx.add_change(field, desired=values["desired"], current=values["current"])
if not dry_run:
if "purged" in changes:
if not changes["purged"]["desired"]:
ctx.debug("Calling create_resource")
self.create_resource(ctx, desired)
else:
ctx.debug("Calling delete_resource")
self.delete_resource(ctx, desired)
elif not desired.purged and len(changes) > 0:
ctx.debug("Calling update_resource", changes=changes)
self.update_resource(ctx, dict(changes), desired)
ctx.set_status(const.ResourceState.deployed)
else:
ctx.set_status(const.ResourceState.dry)
except SkipResource as e:
ctx.set_status(const.ResourceState.skipped)
ctx.warning(msg="Resource %(resource_id)s was skipped: %(reason)s", resource_id=resource.id, reason=e.args)
except Exception as e:
ctx.set_status(const.ResourceState.failed)
ctx.exception(
"An error occurred during deployment of %(resource_id)s (exception: %(exception)s)",
resource_id=resource.id,
exception=repr(e),
traceback=traceback.format_exc(),
)
finally:
try:
self.post(ctx, resource)
except Exception as e:
ctx.exception(
"An error occurred after deployment of %(resource_id)s (exception: %(exception)s",
resource_id=resource.id,
exception=repr(e),
)
class Commander(object):
"""
This class handles commands
"""
__command_functions: Dict[str, Dict[str, Type[ResourceHandler]]] = defaultdict(dict)
@classmethod
def get_handlers(cls) -> Dict[str, Dict[str, Type[ResourceHandler]]]:
return cls.__command_functions
@classmethod
def reset(cls) -> None:
cls.__command_functions = defaultdict(dict)
@classmethod
def close(cls) -> None:
pass
@classmethod
def _get_instance(
cls, handler_class: Type[ResourceHandler], agent: "inmanta.agent.agent.AgentInstance", io: "IOBase"
) -> ResourceHandler:
new_instance = handler_class(agent, io)
return new_instance
@classmethod
def get_provider(
cls, cache: AgentCache, agent: "inmanta.agent.agent.AgentInstance", resource: resources.Resource
) -> ResourceHandler:
"""
Return a provider to handle the given resource
"""
resource_id = resource.id
resource_type = resource_id.get_entity_type()
try:
agent_io = io.get_io(cache, agent.uri, resource_id.get_version())
except Exception:
LOGGER.exception("Exception raised during creation of IO for uri %s", agent.uri)
raise Exception("No handler available for %s (no io available)" % resource_id)
if agent_io is None:
# Skip this resource
raise Exception("No handler available for %s (no io available)" % resource_id)
available = []
if resource_type in cls.__command_functions:
for handlr in cls.__command_functions[resource_type].values():
h = cls._get_instance(handlr, agent, agent_io)
if h.available(resource):
available.append(h)
else:
h.close()
if len(available) > 1:
for h in available:
h.close()
agent_io.close()
raise Exception("More than one handler selected for resource %s" % resource.id)
elif len(available) == 1:
return available[0]
raise Exception("No resource handler registered for resource of type %s" % resource_type)
@classmethod
def add_provider(cls, resource: str, name: str, provider: Type["ResourceHandler"]) -> None:
"""
Register a new provider
:param resource: the name of the resource this handler applies to
:param name: the name of the handler itself
:param provider: the handler function
"""
if resource in cls.__command_functions and name in cls.__command_functions[resource]:
del cls.__command_functions[resource][name]
cls.__command_functions[resource][name] = provider
@classmethod
def get_providers(cls) -> typing.Iterator[Tuple[str, typing.Type["ResourceHandler"]]]:
""" Return an iterator over resource type, handler definition
"""
for resource_type, handler_map in cls.__command_functions.items():
for handle_name, handler_class in handler_map.items():
yield (resource_type, handler_class)
@classmethod
def get_provider_class(cls, resource_type: str, name: str) -> Optional[typing.Type["ResourceHandler"]]:
"""
Return the class of the handler for the given type and with the given name
"""
if resource_type not in cls.__command_functions:
return None
if name not in cls.__command_functions[resource_type]:
return None
return cls.__command_functions[resource_type][name]
class HandlerNotAvailableException(Exception):
"""
This exception is thrown when a resource handler cannot perform its job. For example, the admin interface
it connects to is not available.
"""