aboutsummaryrefslogtreecommitdiffstats
path: root/tests/mock_tracker.py
blob: 4e69afd7aaf70756ea19ce0494942aa6489a77d4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# ============LICENSE_START=======================================================
# Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
# ================================================================================
# 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.
# ============LICENSE_END=========================================================
#
# ECOMP is a trademark and service mark of AT&T Intellectual Property.
"""record all the messages going outside policy-handler during testing"""

import copy
import json

from policyhandler.onap.audit import REQUEST_X_ECOMP_REQUESTID
from policyhandler.policy_utils import Utils

from .mock_expected import HISTORY_EXPECTED
from .mock_settings import Settings

RESPONSE = "res"

class _MockHttpRequestInResponse(object):
    """Mock http request in reponse object"""
    def __init__(self, method, uri, **kwargs):
        self.method = method
        self.uri = uri
        self.params = copy.deepcopy(kwargs.get("params"))
        self.req_json = copy.deepcopy(kwargs.get("json"))
        self.headers = copy.deepcopy(kwargs.get("headers"))

    def to_json(self):
        """create json of the request"""
        return {
            "method": self.method,
            "uri": self.uri,
            "params": self.params,
            "json": self.req_json,
            "headers": self.headers
        }


class MockHttpResponse(object):
    """Mock http response based on request"""
    def __init__(self, method, uri, res_json, **kwargs):
        """create response based on request"""
        self.request = _MockHttpRequestInResponse(method, uri, **kwargs)

        self.status_code = kwargs.get("status_code", 200)
        self.res = copy.deepcopy(res_json)
        self.text = json.dumps(self.res)

        self._track()

    def json(self):
        """returns json of response"""
        return self.res

    def raise_for_status(self):
        """ignoring"""
        pass

    def to_json(self):
        """create json of the message"""
        return {
            "request": self.request.to_json(),
            "status_code": self.status_code,
            RESPONSE: self.res
        }

    def _track(self):
        """append the message to tracker's history"""
        Tracker.track(self.to_json())

    def __str__(self):
        """stringify for logging"""
        return json.dumps(self.to_json(), sort_keys=True)


class Tracker(object):
    """record all the messages going outside policy-handler during testing"""
    test_name = None
    messages = []

    @staticmethod
    def reset(test_name):
        """remove all the messages from history"""
        Tracker.test_name = test_name
        Tracker.messages.clear()

    @staticmethod
    def track(message):
        """append the tracked message to the history"""
        message = copy.deepcopy(message)
        Tracker.messages.append(message)
        if Settings.logger:
            Settings.logger.info("tracked_message: %s", json.dumps(message, sort_keys=True))

    @staticmethod
    def to_string():
        """stringify message history for logging"""
        return json.dumps(Tracker.messages, sort_keys=True)

    @staticmethod
    def _hide_volatiles(obj):
        """hides the volatile field values"""
        if not isinstance(obj, dict):
            return obj

        for key, value in obj.items():
            if key in [REQUEST_X_ECOMP_REQUESTID, RESPONSE]:
                obj[key] = "*"
            elif isinstance(value, dict):
                obj[key] = Tracker._hide_volatiles(value)

        return obj

    @staticmethod
    def validate():
        """validate that the message history is as expected"""
        Settings.logger.info("Tracker.validate(%s)", Tracker.test_name)
        messages = [Tracker._hide_volatiles(copy.deepcopy(message))
                    for message in Tracker.messages]
        expected = HISTORY_EXPECTED.get(Tracker.test_name, [])

        Settings.logger.info("messages: %s", json.dumps(messages, sort_keys=True))
        Settings.logger.info("expected: %s", json.dumps(expected, sort_keys=True))
        assert Utils.are_the_same(messages, expected)

        Settings.logger.info("history valid for Tracker.validate(%s)", Tracker.test_name)