File: test_senderprotocol.py

package info (click to toggle)
python-protobix 1.0.2-16
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 476 kB
  • sloc: python: 2,321; sql: 35; sh: 32; makefile: 3
file content (324 lines) | stat: -rw-r--r-- 11,125 bytes parent folder | download
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
"""
Tests for protobix.SenderProtocol
"""
import configobj
import pytest
from unittest import mock
import unittest
import time
try: import simplejson as json
except ImportError: import json
import socket

import sys
import os
sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..'))
import protobix

try: import simplejson as json
except ImportError: import json
import struct
if sys.version_info < (3,):
    def b(x):
        return x
else:
    import codecs
    def b(x):
        return codecs.utf_8_encode(x)[0]

# Zabbix force TLSv1.2 protocol
# in src/libs/zbxcrypto/tls.c function zbx_tls_init_child
HAVE_DECENT_SSL = False
if sys.version_info > (2,7,9):
    import ssl
    HAVE_DECENT_SSL = True

def test_default_params():
    """
    Default configuration
    """
    zbx_senderprotocol = protobix.SenderProtocol()

    assert zbx_senderprotocol.server_active == '127.0.0.1'
    assert zbx_senderprotocol.server_port == 10051
    assert zbx_senderprotocol._config.dryrun is False
    assert zbx_senderprotocol.items_list == []

def test_server_active_custom():
    """
    Test setting zbx_server with custom value
    """
    zbx_senderprotocol = protobix.SenderProtocol()
    assert zbx_senderprotocol.server_active == '127.0.0.1'
    zbx_senderprotocol.server_active = 'myserver.domain.tld'
    assert zbx_senderprotocol.server_active == 'myserver.domain.tld'

def test_server_port_custom():
    """
    Test setting server_port with custom value
    """
    zbx_senderprotocol = protobix.SenderProtocol()
    assert zbx_senderprotocol.server_port == 10051
    zbx_senderprotocol.server_port = 10052
    assert zbx_senderprotocol.server_port == 10052

def test_server_port_invalid_greater_than_32767():
    """
    Test setting server_port with invalid value
    """
    zbx_senderprotocol = protobix.SenderProtocol()
    with pytest.raises(ValueError) as err:
        zbx_senderprotocol.server_port = 40000
    assert str(err.value) == 'ServerPort must be between 1024 and 32767'
    assert zbx_senderprotocol.server_port == 10051

def test_server_port_invalid_lower_than_1024():
    """
    Test setting server_port with invalid value
    """
    zbx_senderprotocol = protobix.SenderProtocol()
    with pytest.raises(ValueError) as err:
        zbx_senderprotocol.server_port = 1000
    assert str(err.value) == 'ServerPort must be between 1024 and 32767'
    assert zbx_senderprotocol.server_port == 10051

def test_debug_custom():
    """
    Test setting server_port with custom value
    """
    zbx_senderprotocol = protobix.SenderProtocol()
    assert zbx_senderprotocol.debug_level == 3
    zbx_senderprotocol.debug_level = 4
    assert zbx_senderprotocol.debug_level == 4

def test_debug_invalid_lower_than_0():
    """
    Test setting server_port with invalid value
    """
    zbx_senderprotocol = protobix.SenderProtocol()
    with pytest.raises(ValueError) as err:
        zbx_senderprotocol.debug_level = -1
    assert str(err.value) == 'DebugLevel must be between 0 and 5, -1 provided'
    assert zbx_senderprotocol.debug_level == 3

def test_debug_invalid_greater_than_5():
    """
    Test setting server_port with invalid value
    """
    zbx_senderprotocol = protobix.SenderProtocol()
    with pytest.raises(ValueError) as err:
        zbx_senderprotocol.debug_level = 10
    assert str(err.value) == 'DebugLevel must be between 0 and 5, 10 provided'
    assert zbx_senderprotocol.debug_level == 3

def test_dryrun_custom():
    """
    Test setting dryrun with custom value
    """
    zbx_senderprotocol = protobix.SenderProtocol()
    assert zbx_senderprotocol._config.dryrun is False
    zbx_senderprotocol._config.dryrun = True
    assert zbx_senderprotocol._config.dryrun is True
    zbx_senderprotocol._config.dryrun = False
    assert zbx_senderprotocol._config.dryrun is False

def test_dryrun_invalid():
    """
    Test setting dryrun with invalid value
    """
    zbx_senderprotocol = protobix.SenderProtocol()
    assert zbx_senderprotocol._config.dryrun is False
    with pytest.raises(ValueError) as err:
        zbx_senderprotocol._config.dryrun = 'invalid'
    assert str(err.value) == 'dryrun parameter requires boolean'
    assert zbx_senderprotocol._config.dryrun is False

def test_clock_integer():
    """
    Test clock method
    """
    zbx_senderprotocol = protobix.SenderProtocol()
    assert isinstance(zbx_senderprotocol.clock, int) is True

def test_clock_accurate():
    """
    Test clock method
    """
    zbx_senderprotocol = protobix.SenderProtocol()
    assert zbx_senderprotocol.clock == int(time.time())

@mock.patch('socket.socket', return_value=mock.MagicMock(name='socket', spec=socket.socket))
def test_send_to_zabbix(mock_socket):
    """
    Test sending data to Zabbix Server
    """
    item = { 'host': 'myhostname', 'key': 'my.item.key',
             'value': 1, 'clock': int(time.time())}
    payload = json.dumps({
        "data": [item],
        "request": "sender data",
        "clock": int(time.time())
    })
    packet = b('ZBXD\1') + struct.pack('<Q', 136) + b(payload)

    zbx_senderprotocol = protobix.SenderProtocol()
    zbx_senderprotocol.socket = mock_socket
    zbx_senderprotocol.data_type='item'
    zbx_senderprotocol._items_list.append(item)
    zbx_senderprotocol._send_to_zabbix(zbx_senderprotocol._items_list)

    zbx_senderprotocol.socket.sendall.assert_called_with(packet)

zabbix_answer_params= (
    # Zabbix Sender protocol <= 2.0
    'Processed 1 Failed 2 Total 3 Seconds spent 0.123456',
    # Zabbix Sender protocol >= 2.2
    'processed: 1; failed: 2; total: 3; seconds spent: 0.123456',
)
@pytest.mark.parametrize('zabbix_answer', zabbix_answer_params)
def test_handle_response(zabbix_answer):
    """
    Test Zabbix Server/Proxy answer
    """
    payload='{"response":"success","info":"'+zabbix_answer+'"}'
    zbx_datacontainer = protobix.DataContainer()
    srv_response, processed, failed, total, time = zbx_datacontainer._handle_response(payload)
    assert srv_response == 'success'
    assert processed == 1
    assert failed == 2
    assert total == 3
    assert time == 0.123456

zabbix_answer_params= (
    # Zabbix Sender protocol <= 2.0
    'Invalid content',
    # Zabbix Sender protocol >= 2.2
    'invalid content',
)
@pytest.mark.parametrize('zabbix_answer', zabbix_answer_params)
def test_handle_response_with_invalid_content(zabbix_answer):
    """
    Test Zabbix Server/Proxy answer
    """
    payload='{"response":"success","info":"'+zabbix_answer+'"}'
    zbx_datacontainer = protobix.DataContainer()
    with pytest.raises(IndexError):
        zbx_datacontainer._handle_response(payload)

@mock.patch('socket.socket', return_value=mock.MagicMock(name='socket', spec=socket.socket))
def test_read_from_zabbix_valid_content(mock_socket):
    """
    Test sending data to Zabbix Server
    """
    answer_payload = '{"info": "processed: 0; failed: 1; total: 1; seconds spent: 0.000441", "response": "success"}'
    answer_packet = b('ZBXD\1') + struct.pack('<Q', 93) + b(answer_payload)
    mock_socket.recv.return_value = answer_packet

    zbx_senderprotocol = protobix.SenderProtocol()
    zbx_senderprotocol.data_type='item'
    zbx_senderprotocol.socket = mock_socket
    srv_response, processed, failed, total, time = zbx_senderprotocol._read_from_zabbix()
    assert srv_response == 'success'
    assert processed == 0
    assert failed == 1
    assert total == 1
    assert time == 0.000441

@mock.patch('socket.socket', return_value=mock.MagicMock(name='socket', spec=socket.socket))
def test_read_from_zabbix_invalid_content(mock_socket):
    """
    Test sending data to Zabbix Server
    """
    answer_payload = '{"info": "invalid content", "response": "success"}'
    answer_packet = b('ZBXD\1') + struct.pack('<Q', 93) + b(answer_payload)
    mock_socket.recv.return_value = answer_packet

    zbx_senderprotocol = protobix.SenderProtocol()
    zbx_senderprotocol.data_type='item'
    zbx_senderprotocol.socket = mock_socket
    with pytest.raises(IndexError):
        zbx_senderprotocol._read_from_zabbix()

if HAVE_DECENT_SSL is True:

    @mock.patch('configobj.ConfigObj')
    def test_need_backend_init_tls(mock_configobj):
        """
        Test TLS context initialization
        """
        mock_configobj.side_effect = [
            {
                'TLSConnect': 'cert',
                'TLSCAFile': 'tests/tls_ca/rogue-protobix-ca.cert.pem',
                'TLSCertFile': 'tests/tls_ca/rogue-protobix-client.cert.pem',
                'TLSKeyFile': 'tests/tls_ca/rogue-protobix-client.key.pem'
            }
        ]
        zbx_senderprotocol = protobix.SenderProtocol()
        tls_socket = zbx_senderprotocol._socket()
        assert isinstance(tls_socket, ssl.SSLSocket)

    @mock.patch('configobj.ConfigObj')
    def test_need_backend_init_tls_cert_verify_fails(mock_configobj):
        """
        Test TLS context initialization
        """
        mock_configobj.side_effect = [
            {
                'TLSConnect': 'cert',
                'TLSCAFile': 'tests/tls_ca/protobix-ca.cert.pem',
                'TLSCertFile': 'tests/tls_ca/protobix-client.cert.pem',
                'TLSKeyFile': 'tests/tls_ca/protobix-client.key.pem'
            }
        ]
        zbx_senderprotocol = protobix.SenderProtocol()
        with pytest.raises(ssl.SSLError):
            zbx_senderprotocol._socket()

    @mock.patch('configobj.ConfigObj')
    def test_init_tls_non_matching_cert_key(mock_configobj):
        """
        Test TLS context initialization
        """
        mock_configobj.side_effect = [
            {
                'TLSConnect': 'cert',
                'TLSCAFile': 'tests/tls_ca/protobix-ca.cert.pem',
                'TLSCertFile': 'tests/tls_ca/rogue-protobix-client.cert.pem',
                'TLSKeyFile': 'tests/tls_ca/protobix-client.key.pem'
            }
        ]
        zbx_senderprotocol = protobix.SenderProtocol()
        with pytest.raises(ssl.SSLError) as err:
            tls_context = zbx_senderprotocol._init_tls()

    @mock.patch('configobj.ConfigObj')
    def test_need_backend_socket_tls_unencrypted(mock_configobj):
        """
        Test socket with no TLS
        """
        mock_configobj.side_effect = [
            {
                'TLSConnect': 'unencrypted',
            }
        ]
        zbx_senderprotocol = protobix.SenderProtocol()
        _socket = zbx_senderprotocol._socket()
        assert isinstance(_socket, socket.socket)

    @mock.patch('configobj.ConfigObj')
    def test_need_backend_socket_tls_cert(mock_configobj):
        """
        Test socket with TLS
        """
        mock_configobj.side_effect = [
            {
                'TLSConnect': 'cert',
                'TLSCAFile': 'tests/tls_ca/rogue-protobix-ca.cert.pem',
                'TLSCertFile': 'tests/tls_ca/rogue-protobix-client.cert.pem',
                'TLSKeyFile': 'tests/tls_ca/rogue-protobix-client.key.pem'
            }
        ]
        zbx_senderprotocol = protobix.SenderProtocol()
        _socket = zbx_senderprotocol._socket()
        assert isinstance(_socket, ssl.SSLSocket)