File: test_worker_integration.py

package info (click to toggle)
python-snitun 0.45.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 664 kB
  • sloc: python: 6,703; sh: 5; makefile: 3
file content (240 lines) | stat: -rw-r--r-- 7,921 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
"""Test metrics integration with ServerWorker."""

import asyncio
import contextlib
from unittest.mock import MagicMock, call, patch

import pytest

from snitun.server.worker import ServerWorker


@pytest.mark.asyncio
async def test_worker_metrics_reporting() -> None:
    """Test that worker reports metrics correctly with comprehensive assertions."""
    mock_metrics = MagicMock()
    mock_factory = MagicMock(return_value=mock_metrics)
    worker = ServerWorker(
        fernet_keys=["Wnng8SA8nnad6Q4YiZCFVMBMvxMJfn9pvMY7Wg_JBtw="],
        metrics_factory=mock_factory,
        metrics_interval=0.1,  # 100ms for faster testing
    )

    with patch.object(worker, "_loop", asyncio.get_event_loop()):
        mock_peers = MagicMock()
        mock_peers._peers = {}
        mock_peers.iter_peers = MagicMock(return_value=[])
        worker._peers = mock_peers
        worker._metrics = mock_factory()

        worker._metrics_task = asyncio.create_task(worker._report_metrics_loop())

        await asyncio.sleep(0.35)  # Should trigger ~3 reports

        worker._metrics_task.cancel()
        with contextlib.suppress(asyncio.CancelledError):
            await worker._metrics_task

        assert mock_metrics.gauge.call_count >= 9  # 3 iterations * 3 calls each

        # Each iteration should call gauge 3 times:
        # 1. Total connections (0)
        # 2. Protocol version 0 connections (0)
        # 3. Protocol version 1 connections (0)
        expected_calls = []
        for _ in range(mock_metrics.gauge.call_count // 3):
            expected_calls.extend(
                [
                    call("snitun.worker.peer_connections", 0),
                    call(
                        "snitun.worker.peer_connections",
                        0,
                        {"protocol_version": "0"},
                    ),
                    call(
                        "snitun.worker.peer_connections",
                        0,
                        {"protocol_version": "1"},
                    ),
                ],
            )

        mock_metrics.gauge.assert_has_calls(expected_calls)


@pytest.mark.asyncio
async def test_worker_metrics_with_multiple_peers() -> None:
    """Test metrics reporting with multiple peers and different protocol versions."""
    mock_metrics = MagicMock()
    mock_factory = MagicMock(return_value=mock_metrics)
    worker = ServerWorker(
        fernet_keys=["Wnng8SA8nnad6Q4YiZCFVMBMvxMJfn9pvMY7Wg_JBtw="],
        metrics_factory=mock_factory,
        metrics_interval=0.1,
    )

    mock_peer1 = MagicMock()
    mock_peer1.protocol_version = 0
    mock_peer1.hostname = "peer1.example.com"
    mock_peer2 = MagicMock()
    mock_peer2.protocol_version = 0
    mock_peer2.hostname = "peer2.example.com"
    mock_peer3 = MagicMock()
    mock_peer3.protocol_version = 1
    mock_peer3.hostname = "peer3.example.com"
    mock_peer4 = MagicMock()
    mock_peer4.protocol_version = 2
    mock_peer4.hostname = "peer4.example.com"

    with patch.object(worker, "_loop", asyncio.get_event_loop()):
        mock_peers = MagicMock()
        mock_peers.iter_peers = MagicMock(
            return_value=[mock_peer1, mock_peer2, mock_peer3, mock_peer4],
        )
        worker._peers = mock_peers
        worker._metrics = mock_factory()

        # Run one collection cycle
        await worker._collect_and_report_metrics()

        assert mock_metrics.gauge.called
        mock_metrics.gauge.assert_has_calls(
            [
                call("snitun.worker.peer_connections", 4),
                call(
                    "snitun.worker.peer_connections",
                    2,
                    {"protocol_version": "0"},
                ),
                call(
                    "snitun.worker.peer_connections",
                    1,
                    {"protocol_version": "1"},
                ),
                call(
                    "snitun.worker.peer_connections",
                    1,
                    {"protocol_version": "2"},
                ),
            ],
        )


def test_worker_with_noop_metrics() -> None:
    """Test that worker works with no-op metrics (default)."""
    worker = ServerWorker(
        fernet_keys=["Wnng8SA8nnad6Q4YiZCFVMBMvxMJfn9pvMY7Wg_JBtw="],
    )
    assert worker._metrics_factory is not None
    collector = worker._metrics_factory()
    collector.gauge("test", 1.0)
    assert not hasattr(collector, "_metrics")


@pytest.mark.asyncio
async def test_worker_metrics_task_lifecycle() -> None:
    """Test that metrics task is properly managed during worker lifecycle."""
    mock_metrics = MagicMock()
    mock_factory = MagicMock(return_value=mock_metrics)
    worker = ServerWorker(
        fernet_keys=["Wnng8SA8nnad6Q4YiZCFVMBMvxMJfn9pvMY7Wg_JBtw="],
        metrics_factory=mock_factory,
        metrics_interval=0.1,
    )

    with patch.object(worker, "_loop", asyncio.get_event_loop()):
        assert worker._metrics_task is None

        mock_peers = MagicMock()
        mock_peers.iter_peers = MagicMock(return_value=[])
        worker._peers = mock_peers

        await worker._async_init()

        assert worker._metrics_task is not None
        assert not worker._metrics_task.done()
        assert worker._metrics is not None

        await asyncio.sleep(0.15)

        assert mock_metrics.gauge.called

        worker._metrics_task.cancel()
        with contextlib.suppress(asyncio.CancelledError):
            await worker._metrics_task

        assert worker._metrics_task.done()


@pytest.mark.asyncio
async def test_metrics_collection_without_peers() -> None:
    """Test metrics collection when PeerManager is None."""
    mock_metrics = MagicMock()
    mock_factory = MagicMock(return_value=mock_metrics)

    worker = ServerWorker(
        fernet_keys=["Wnng8SA8nnad6Q4YiZCFVMBMvxMJfn9pvMY7Wg_JBtw="],
        metrics_factory=mock_factory,
    )
    worker._metrics = mock_factory()
    worker._peers = None

    await worker._collect_and_report_metrics()

    mock_metrics.gauge.assert_has_calls(
        [
            call("snitun.worker.peer_connections", 0),
        ],
    )


@pytest.mark.asyncio
async def test_metrics_collection_with_no_metrics_collector() -> None:
    """Test that metrics collection handles None metrics collector gracefully."""
    worker = ServerWorker(
        fernet_keys=["Wnng8SA8nnad6Q4YiZCFVMBMvxMJfn9pvMY7Wg_JBtw="],
    )

    mock_peers = MagicMock()
    mock_peers.iter_peers = MagicMock(return_value=[])
    worker._peers = mock_peers
    worker._metrics = None

    await worker._collect_and_report_metrics()


@pytest.mark.asyncio
async def test_metrics_reporting_interval() -> None:
    """Test that metrics are reported at the correct interval."""
    mock_metrics = MagicMock()
    mock_factory = MagicMock(return_value=mock_metrics)

    interval = 0.2  # 200ms
    worker = ServerWorker(
        fernet_keys=["Wnng8SA8nnad6Q4YiZCFVMBMvxMJfn9pvMY7Wg_JBtw="],
        metrics_factory=mock_factory,
        metrics_interval=interval,
    )

    with patch.object(worker, "_loop", asyncio.get_event_loop()):
        mock_peers = MagicMock()
        mock_peers.iter_peers = MagicMock(return_value=[])
        worker._peers = mock_peers
        worker._metrics = mock_factory()

        worker._metrics_task = asyncio.create_task(worker._report_metrics_loop())

        await asyncio.sleep(interval * 2.8)

        # Each report calls gauge 3 times (total + version 0 + version 1)
        # After ~2.8 intervals, we expect 2-3 reports = 6-9 gauge calls
        assert 6 <= mock_metrics.gauge.call_count <= 9

        await asyncio.sleep(interval * 1.2)

        # After ~4 intervals total, we expect at least 3 reports = 9+ gauge calls
        assert mock_metrics.gauge.call_count >= 9

        worker._metrics_task.cancel()
        with contextlib.suppress(asyncio.CancelledError):
            await worker._metrics_task