|
| 1 | +# Copyright 2019, Aiven, https://aiven.io/ |
| 2 | +# |
| 3 | +# This file is under the Apache License, Version 2.0. |
| 4 | +# See the file `LICENSE` for details. |
| 5 | +from journalpump.rsyslog import SyslogTcpClient |
| 6 | +from unittest import mock |
| 7 | + |
| 8 | +import pytest |
| 9 | + |
| 10 | + |
| 11 | +class _StubSocket: |
| 12 | + """Minimal socket stub that records bytes passed to sendall.""" |
| 13 | + |
| 14 | + def __init__(self) -> None: |
| 15 | + self.sent = bytearray() |
| 16 | + |
| 17 | + def sendall(self, data: bytes) -> None: |
| 18 | + self.sent.extend(data) |
| 19 | + |
| 20 | + def close(self) -> None: |
| 21 | + pass |
| 22 | + |
| 23 | + |
| 24 | +def _make_client(*, max_msg: int, octet_counted_framing: bool) -> tuple[SyslogTcpClient, _StubSocket]: |
| 25 | + with mock.patch.object(SyslogTcpClient, "_connect"): |
| 26 | + client = SyslogTcpClient( |
| 27 | + server="127.0.0.1", |
| 28 | + port=1, |
| 29 | + rfc="RFC5424", |
| 30 | + max_msg=max_msg, |
| 31 | + octet_counted_framing=octet_counted_framing, |
| 32 | + ) |
| 33 | + sock = _StubSocket() |
| 34 | + client.socket = sock |
| 35 | + return client, sock |
| 36 | + |
| 37 | + |
| 38 | +def _parse_octet_counted_frames(stream: bytes) -> list[bytes]: |
| 39 | + """Parse an RFC 6587 octet-counted stream into individual message bodies.""" |
| 40 | + frames: list[bytes] = [] |
| 41 | + i = 0 |
| 42 | + while i < len(stream): |
| 43 | + sp = stream.index(b" ", i) |
| 44 | + n = int(stream[i:sp]) |
| 45 | + body = stream[sp + 1 : sp + 1 + n] |
| 46 | + assert len(body) == n, f"stream desync at offset {i}: advertised {n} bytes, got {len(body)}" |
| 47 | + frames.append(bytes(body)) |
| 48 | + i = sp + 1 + n |
| 49 | + return frames |
| 50 | + |
| 51 | + |
| 52 | +class TestNonTransparentFraming: |
| 53 | + """octet_counted_framing=False — must be byte-for-byte identical to the pre-fix behavior.""" |
| 54 | + |
| 55 | + def test_small_body_sent_verbatim(self): |
| 56 | + body = b"<13>1 2024-01-01T00:00:00Z host app - - hello\n" |
| 57 | + max_msg = len(body) + 10 |
| 58 | + client, sock = _make_client(max_msg=max_msg, octet_counted_framing=False) |
| 59 | + |
| 60 | + client.send(body) |
| 61 | + |
| 62 | + assert bytes(sock.sent) == body |
| 63 | + |
| 64 | + def test_small_body_no_extra_newline(self): |
| 65 | + body = b"<13>1 2024-01-01T00:00:00Z host app - - hello\n" |
| 66 | + max_msg = len(body) + 10 |
| 67 | + client, sock = _make_client(max_msg=max_msg, octet_counted_framing=False) |
| 68 | + |
| 69 | + client.send(body) |
| 70 | + |
| 71 | + assert sock.sent.count(b"\n") == 1 |
| 72 | + |
| 73 | + def test_oversize_body_truncated_and_newline_appended(self): |
| 74 | + body = b"A" * 200 + b"\n" |
| 75 | + max_msg = 50 |
| 76 | + client, sock = _make_client(max_msg=max_msg, octet_counted_framing=False) |
| 77 | + |
| 78 | + client.send(body) |
| 79 | + |
| 80 | + expected = body[: max_msg - 1] + b"\n" |
| 81 | + assert bytes(sock.sent) == expected |
| 82 | + |
| 83 | + def test_body_exactly_max_msg_triggers_truncation(self): |
| 84 | + # len(body) == max_msg means the body >= max_msg branch fires |
| 85 | + max_msg = 50 |
| 86 | + body = b"B" * max_msg |
| 87 | + client, sock = _make_client(max_msg=max_msg, octet_counted_framing=False) |
| 88 | + |
| 89 | + client.send(body) |
| 90 | + |
| 91 | + expected = body[: max_msg - 1] + b"\n" |
| 92 | + assert bytes(sock.sent) == expected |
| 93 | + |
| 94 | + |
| 95 | +class TestOctetCountedFraming: |
| 96 | + """octet_counted_framing=True — must produce RFC 6587 section 3.4.1 frames.""" |
| 97 | + |
| 98 | + def test_small_multiline_body_framed_correctly(self): |
| 99 | + body = b"<13>1 2024-01-01T00:00:00Z host app - - line1\nline2\nline3\n" |
| 100 | + max_msg = len(body) + 50 |
| 101 | + client, sock = _make_client(max_msg=max_msg, octet_counted_framing=True) |
| 102 | + |
| 103 | + client.send(body) |
| 104 | + |
| 105 | + wire = bytes(sock.sent) |
| 106 | + sp = wire.index(b" ") |
| 107 | + advertised_len = int(wire[:sp]) |
| 108 | + sent_body = wire[sp + 1 :] |
| 109 | + |
| 110 | + assert advertised_len == len(body) |
| 111 | + assert sent_body == body |
| 112 | + |
| 113 | + def test_small_body_no_trailing_newline_outside_frame(self): |
| 114 | + body = b"<13>1 2024-01-01T00:00:00Z host app - - msg\n" |
| 115 | + max_msg = len(body) + 50 |
| 116 | + client, sock = _make_client(max_msg=max_msg, octet_counted_framing=True) |
| 117 | + |
| 118 | + client.send(body) |
| 119 | + |
| 120 | + wire = bytes(sock.sent) |
| 121 | + sp = wire.index(b" ") |
| 122 | + n = int(wire[:sp]) |
| 123 | + # Everything after the prefix+space+body must be empty (no stray newline) |
| 124 | + assert len(wire) == sp + 1 + n |
| 125 | + |
| 126 | + def test_oversize_body_truncated_and_prefix_matches(self): |
| 127 | + body = b"X" * 300 |
| 128 | + max_msg = 100 |
| 129 | + client, sock = _make_client(max_msg=max_msg, octet_counted_framing=True) |
| 130 | + |
| 131 | + client.send(body) |
| 132 | + |
| 133 | + wire = bytes(sock.sent) |
| 134 | + sp = wire.index(b" ") |
| 135 | + advertised_len = int(wire[:sp]) |
| 136 | + sent_body = wire[sp + 1 :] |
| 137 | + |
| 138 | + assert advertised_len == len(sent_body) |
| 139 | + assert len(sent_body) <= max_msg |
| 140 | + assert sent_body == body[:max_msg] |
| 141 | + |
| 142 | + def test_back_to_back_oversize_messages_no_desync(self): |
| 143 | + """Two oversize messages on the same connection must parse without desync.""" |
| 144 | + body1 = b"<13>1 2024-01-01T00:00:00Z h a - - " + b"M" * 300 + b"\n" |
| 145 | + body2 = b"<14>1 2024-01-01T00:00:01Z h b - - short\n" |
| 146 | + max_msg = 60 |
| 147 | + client, sock = _make_client(max_msg=max_msg, octet_counted_framing=True) |
| 148 | + |
| 149 | + client.send(body1) |
| 150 | + client.send(body2) |
| 151 | + |
| 152 | + frames = _parse_octet_counted_frames(bytes(sock.sent)) |
| 153 | + assert len(frames) == 2 |
| 154 | + assert frames[0] == body1[:max_msg] |
| 155 | + assert frames[1] == body2[:max_msg] |
| 156 | + |
| 157 | + def test_very_small_max_msg_produces_self_consistent_frame(self): |
| 158 | + """Even with max_msg=8 the frame prefix must equal the body length.""" |
| 159 | + body = b"ABCDEFGHIJKLMNOPQRSTUVWXYZ\n" |
| 160 | + max_msg = 8 |
| 161 | + client, sock = _make_client(max_msg=max_msg, octet_counted_framing=True) |
| 162 | + |
| 163 | + client.send(body) |
| 164 | + |
| 165 | + frames = _parse_octet_counted_frames(bytes(sock.sent)) |
| 166 | + assert len(frames) == 1 |
| 167 | + assert len(frames[0]) <= max_msg |
| 168 | + |
| 169 | + @pytest.mark.parametrize("max_msg", [1, 4, 8, 16, 32]) |
| 170 | + def test_various_small_max_msg_always_self_consistent(self, max_msg: int): |
| 171 | + body = b"Hello, multi\nline\nbody\n" * 5 |
| 172 | + client, sock = _make_client(max_msg=max_msg, octet_counted_framing=True) |
| 173 | + |
| 174 | + client.send(body) |
| 175 | + |
| 176 | + frames = _parse_octet_counted_frames(bytes(sock.sent)) |
| 177 | + assert len(frames) == 1 |
| 178 | + assert len(frames[0]) <= max_msg |
0 commit comments