test_utils.py 9.01 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
"""
Utilities and mock modules for unittests of statistics modules

"""
import os
import io
import time
import sys
import threading
import tempfile
Naoki Kambe's avatar
Naoki Kambe committed
11
import json
12
13

import msgq
14
import isc.config.cfgmgr
15
16
17
import stats
import stats_httpd

Naoki Kambe's avatar
Naoki Kambe committed
18
19
def send_command(command_name, module_name, params=None, session=None, nonblock=False, timeout=None):
    if session is not None:
20
        cc_session = session
Naoki Kambe's avatar
Naoki Kambe committed
21
22
23
24
25
    else:
        cc_session = isc.cc.Session()
    if timeout is not None:
        orig_timeout = cc_session.get_timeout()
        cc_session.set_timeout(timeout * 1000)
26
27
28
29
30
31
32
33
34
    command = isc.config.ccsession.create_command(command_name, params)
    seq = cc_session.group_sendmsg(command, module_name)
    try:
        (answer, env) = cc_session.group_recvmsg(nonblock, seq)
        if answer:
            return isc.config.ccsession.parse_answer(answer)
    except isc.cc.SessionTimeout:
        pass
    finally:
Naoki Kambe's avatar
Naoki Kambe committed
35
        if timeout is not None:
36
            cc_session.set_timeout(orig_timeout)
Naoki Kambe's avatar
Naoki Kambe committed
37
38
        if session is None:
            cc_session.close()
39

Naoki Kambe's avatar
Naoki Kambe committed
40
41
def send_shutdown(module_name, **kwargs):
    return send_command("shutdown", module_name, **kwargs)
42
43

class ThreadingServerManager:
Naoki Kambe's avatar
Naoki Kambe committed
44
45
46
    def __init__(self, server, *args, **kwargs):
        self.server = server(*args, **kwargs)
        self.server_name = server.__name__
47
        self.server._thread = threading.Thread(
Naoki Kambe's avatar
Naoki Kambe committed
48
            name=self.server_name, target=self.server.run)
49
        self.server._thread.daemon = True
50

51
52
53
    def run(self):
        self.server._thread.start()
        self.server._started.wait()
54
        self.server._started.clear()
55
56
57

    def shutdown(self):
        self.server.shutdown()
Naoki Kambe's avatar
Naoki Kambe committed
58
        self.server._thread.join(0) # timeout is 0
59
60

class MockMsgq:
61
    def __init__(self):
62
        self._started = threading.Event()
Naoki Kambe's avatar
Naoki Kambe committed
63
        self.msgq = msgq.MsgQ(verbose=True)
64
65
66
67
68
69
70
        result = self.msgq.setup()
        if result:
            sys.exit("Error on Msgq startup: %s" % result)

    def run(self):
        self._started.set()
        try:
Naoki Kambe's avatar
Naoki Kambe committed
71
72
            # any message is written to /dev/null
            sys.stderr = open(os.devnull, "w")
73
            self.msgq.run()
Naoki Kambe's avatar
Naoki Kambe committed
74
            sys.stderr.close()
75
76
77
        except Exception:
            pass
        finally:
Naoki Kambe's avatar
Naoki Kambe committed
78
            self.msgq.shutdown()
79
80
81
82
83

    def shutdown(self):
        self.msgq.shutdown()

class MockCfgmgr:
84
    def __init__(self):
85
86
87
88
89
90
91
        self._started = threading.Event()
        self.cfgmgr = isc.config.cfgmgr.ConfigManager(
            os.environ['CONFIG_TESTDATA_PATH'], "b10-config.db")
        self.cfgmgr.read_config()

    def run(self):
        self._started.set()
Naoki Kambe's avatar
Naoki Kambe committed
92
        self.cfgmgr.run()
93
94
95

    def shutdown(self):
        self.cfgmgr.running = False
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
class MockBoss:
    spec_str = """\
{
  "module_spec": {
    "module_name": "Boss",
    "module_description": "Mock Master process",
    "config_data": [],
    "commands": [
      {
        "command_name": "sendstats",
        "command_description": "Send data to a statistics module at once",
        "command_args": []
      }
    ],
    "statistics": [
      {
        "item_name": "boot_time",
        "item_type": "string",
        "item_optional": false,
        "item_default": "1970-01-01T00:00:00Z",
        "item_title": "Boot time",
        "item_description": "A date time when bind10 process starts initially",
        "item_format": "date-time"
      }
    ]
  }
}
"""
    _BASETIME = (2011, 6, 22, 8, 14, 8, 2, 173, 0)

127
    def __init__(self):
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
        self._started = threading.Event()
        self.running = False
        self.spec_file = io.StringIO(self.spec_str)
        # create ModuleCCSession object
        self.mccs = isc.config.ModuleCCSession(
            self.spec_file,
            self.config_handler,
            self.command_handler)
        self.spec_file.close()
        self.cc_session = self.mccs._session
        self.got_command_name = ''

    def run(self):
        self.mccs.start()
        self.running = True
        self._started.set()
        while self.running:
            self.mccs.check_command(False)

    def shutdown(self):
        self.running = False

    def config_handler(self, new_config):
        return isc.config.create_answer(0)

    def command_handler(self, command, *args, **kwargs):
Naoki Kambe's avatar
Naoki Kambe committed
154
        self._started.set()
155
156
157
158
159
        self.got_command_name = command
        if command == 'sendstats':
            params = { "owner": "Boss",
                       "data": {
                    'boot_time': time.strftime('%Y-%m-%dT%H:%M:%SZ', self._BASETIME)
160
                    }
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
                       }
            return send_command("set", "Stats", params=params, session=self.cc_session)
        return isc.config.create_answer(1, "Unknown Command")

class MockAuth:
    spec_str = """\
{
  "module_spec": {
    "module_name": "Auth",
    "module_description": "Mock Authoritative service",
    "config_data": [],
    "commands": [
      {
        "command_name": "sendstats",
        "command_description": "Send data to a statistics module at once",
        "command_args": []
      }
    ],
    "statistics": [
      {
        "item_name": "queries.tcp",
        "item_type": "integer",
        "item_optional": false,
        "item_default": 0,
185
        "item_title": "Queries TCP",
186
187
188
189
190
191
192
193
194
195
196
197
198
199
        "item_description": "A number of total query counts which all auth servers receive over TCP since they started initially"
      },
      {
        "item_name": "queries.udp",
        "item_type": "integer",
        "item_optional": false,
        "item_default": 0,
        "item_title": "Queries UDP",
        "item_description": "A number of total query counts which all auth servers receive over UDP since they started initially"
      }
    ]
  }
}
"""
200
    def __init__(self):
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
        self._started = threading.Event()
        self.running = False
        self.spec_file = io.StringIO(self.spec_str)
        # create ModuleCCSession object
        self.mccs = isc.config.ModuleCCSession(
            self.spec_file,
            self.config_handler,
            self.command_handler)
        self.spec_file.close()
        self.cc_session = self.mccs._session
        self.got_command_name = ''
        self.queries_tcp = 3
        self.queries_udp = 2

    def run(self):
        self.mccs.start()
        self.running = True
        self._started.set()
        while self.running:
            self.mccs.check_command(False)

    def shutdown(self):
        self.running = False

    def config_handler(self, new_config):
        return isc.config.create_answer(0)

    def command_handler(self, command, *args, **kwargs):
        self.got_command_name = command
        if command == 'sendstats':
            params = { "owner": "Auth",
                       "data": { 'queries.tcp': self.queries_tcp,
                                 'queries.udp': self.queries_udp } }
            return send_command("set", "Stats", params=params, session=self.cc_session)
        return isc.config.create_answer(1, "Unknown Command")

class MyStats(stats.Stats):
238
    def __init__(self):
239
        self._started = threading.Event()
240
        stats.Stats.__init__(self)
241
242
243

    def run(self):
        self._started.set()
Naoki Kambe's avatar
Naoki Kambe committed
244
        self.start()
245
246

    def shutdown(self):
Naoki Kambe's avatar
Naoki Kambe committed
247
        self.command_shutdown()
248
249

class MyStatsHttpd(stats_httpd.StatsHttpd):
Naoki Kambe's avatar
Naoki Kambe committed
250
251
    ORIG_SPECFILE_LOCATION = stats_httpd.SPECFILE_LOCATION
    def __init__(self, *server_address):
252
        self._started = threading.Event()
Naoki Kambe's avatar
Naoki Kambe committed
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
        if server_address:
            stats_httpd.SPECFILE_LOCATION = self.get_specfile(*server_address)
            try:
                stats_httpd.StatsHttpd.__init__(self)
            finally:
                stats_httpd.SPECFILE_LOCATION.close()
                stats_httpd.SPECFILE_LOCATION = self.ORIG_SPECFILE_LOCATION
        else:
            stats_httpd.StatsHttpd.__init__(self)

    def get_specfile(self, *server_address):
        spec = json.load(open(self.ORIG_SPECFILE_LOCATION))
        config = spec['module_spec']['config_data']
        for i in range(len(config)):
            if config[i]['item_name'] == 'listen_on':
                config[i]['item_default'] = \
                    [ dict(address=a[0], port=a[1]) for a in server_address ]
                break
        return io.StringIO(json.dumps(spec))
272
273
274

    def run(self):
        self._started.set()
Naoki Kambe's avatar
Naoki Kambe committed
275
        self.start()
276
277

    def shutdown(self):
Naoki Kambe's avatar
Naoki Kambe committed
278
        self.stop()
279
280

class BaseModules:
281
    def __init__(self):
282
        # Change value of BIND10_MSGQ_SOCKET_FILE in environment variables
Naoki Kambe's avatar
Naoki Kambe committed
283
284
        if 'BIND10_MSGQ_SOCKET_FILE' not in os.environ:
            os.environ['BIND10_MSGQ_SOCKET_FILE'] = tempfile.mktemp(prefix='msgq_socket_')
285
        # MockMsgq
286
        self.msgq = ThreadingServerManager(MockMsgq)
287
288
        self.msgq.run()
        # MockCfgmgr
289
        self.cfgmgr = ThreadingServerManager(MockCfgmgr)
290
291
        self.cfgmgr.run()
        # MockBoss
292
        self.boss = ThreadingServerManager(MockBoss)
293
294
        self.boss.run()
        # MockAuth
295
        self.auth = ThreadingServerManager(MockAuth)
296
297
298
299
300
301
302
303
304
305
306
        self.auth.run()

    def shutdown(self):
        # MockAuth
        self.auth.shutdown()
        # MockBoss
        self.boss.shutdown()
        # MockCfgmgr
        self.cfgmgr.shutdown()
        # MockMsgq
        self.msgq.shutdown()