test_resource_handler.py

"""
    Copyright 2021 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 logging
import typing
from typing import TypeVar

import pytest

from inmanta import const
from inmanta.agent import Agent
from inmanta.agent.handler import ResourceHandler
from inmanta.protocol import SessionClient, VersionMatch, common
from test_protocol import make_random_file
from utils import _wait_until_deployment_finishes, log_contains

T = TypeVar("T")


class MockSessionClient(SessionClient):
    def __init__(self, return_code, content):
        self._version_match = VersionMatch.highest
        self.return_code = return_code
        self.content = content
        pass

    def get_file(self, hash_id):
        content = b""
        if self.return_code != 404:
            content = base64.b64encode(self.content)
        return common.Result(self.return_code, result={"content": content})


class MockGetFileResourceHandler(ResourceHandler):
    def __init__(self, client):
        self._client = client

    def run_sync(self, func: typing.Callable[[], T]) -> T:
        return func()


def test_get_file_corrupted():
    (hash, content, body) = make_random_file()
    client = MockSessionClient(200, b"corrupted_file")
    resource_handler = MockGetFileResourceHandler(client)

    with pytest.raises(Exception):
        resource_handler.get_file(hash)


def test_get_file_success():
    (hash, content, body) = make_random_file()
    client = MockSessionClient(200, content)
    resource_handler = MockGetFileResourceHandler(client)

    result = resource_handler.get_file(hash)
    assert content == result


def test_get_file_not_found():
    client = MockSessionClient(404, None)
    resource_handler = MockGetFileResourceHandler(client)
    result = resource_handler.get_file("hash")
    assert result is None


async def test_logging_error(resource_container, environment, client, agent, clienthelper, caplog):
    """
    When a log call uses an argument that is not JSON serializable, the corresponding resource should be marked as failed,
    and the exception logged.
    """
    resource_container.Provider.reset()
    version = await clienthelper.get_version()

    res_id_1 = "test::BadLogging[agent1,key=key1],v=%d" % version
    resources = [
        {
            "key": "key1",
            "value": "value1",
            "id": res_id_1,
            "send_event": False,
            "purged": False,
            "requires": [],
        },
    ]

    await clienthelper.put_version_simple(resources, version)

    result = await client.release_version(environment, version, True, const.AgentTriggerMethod.push_full_deploy)
    assert result.code == 200

    result = await client.get_version(environment, version)
    assert result.code == 200

    await _wait_until_deployment_finishes(client, environment, version)
    result = await client.get_resource(tid=environment, id=res_id_1, logs=False, status=True)
    assert result.code == 200
    assert result.result["status"] == "failed"

    log_contains(caplog, "inmanta.agent", logging.ERROR, "Failed to serialize argument for log message")


@pytest.mark.parametrize(
    "resource_type",
    ["test::FailFast", "test::FailFastCRUD", "test::BadPost", "test::BadPostCRUD"],
)
async def test_formatting_exception_messages(
    resource_container, environment: str, client, agent: Agent, clienthelper, resource_type: str
) -> None:
    """
    Ensure that exception raised in the Handler are correctly formatted in the resource action log.
    Special characters should not be escaped (see: inmanta/inmanta-lsm#699).
    """
    resource_container.Provider.reset()
    version = await clienthelper.get_version()
    res_id_1 = f"{resource_type}[agent1,key=key1],v={version}"
    resources = [
        {
            "key": "key1",
            "value": "value1",
            "id": res_id_1,
            "send_event": False,
            "purged": False,
            "requires": [],
            **({"purge_on_delete": False} if resource_type.endswith("CRUD") else {}),
        },
    ]

    await clienthelper.put_version_simple(resources, version)
    result = await client.release_version(environment, version, True, const.AgentTriggerMethod.push_full_deploy)
    assert result.code == 200
    await _wait_until_deployment_finishes(client, environment, version)

    result = await client.get_resource_actions(
        tid=environment,
        resource_type=resource_type,
        agent="agent1",
        log_severity=const.LogLevel.ERROR.value,
        limit=1,
    )
    assert result.code == 200, result.result
    assert len(result.result["data"]) == 1
    error_messages = [msg for msg in result.result["data"][0]["messages"] if msg["level"] == const.LogLevel.ERROR.value]
    assert len(error_messages) == 1, error_messages
    assert "(exception: Exception('An\nError\tMessage')" in error_messages[0]["msg"]