File: test_ringbuf.py

package info (click to toggle)
python-mbedtls 2.10.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 960 kB
  • sloc: python: 4,595; sh: 170; makefile: 18
file content (288 lines) | stat: -rw-r--r-- 7,867 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
# SPDX-License-Identifier: MIT

from __future__ import annotations

import pickle
from random import randint
from typing import Any, Callable

import pytest

from mbedtls._ringbuf import RingBuffer  # type: ignore


@pytest.fixture
def randomize_start(
    randbytes: Callable[[int], bytes]
) -> Callable[[bytes], None]:
    def impl(buffer: RingBuffer) -> None:
        # Randomize start of the buffer.
        size = randint(0, buffer.maxlen)
        buffer.write(randbytes(size))
        consumed = buffer.consume(size)
        assert buffer.empty()
        assert consumed == size

    return impl


class TestRingBuf:
    @pytest.fixture(params=[2000, 16384])
    def maxlen(self, request: Any) -> int:
        assert isinstance(request.param, int)
        return request.param

    def test_initial_conditions(self, maxlen: int) -> None:
        buffer = RingBuffer(maxlen)

        assert not buffer
        assert len(buffer) == 0
        assert buffer.maxlen == maxlen
        assert buffer.empty()
        assert not buffer.full()

        assert buffer == b""

    def test_clear(
        self,
        maxlen: int,
        randomize_start: Callable[[bytes], None],
        randbytes: Callable[[int], bytes],
    ) -> None:
        buffer = RingBuffer(maxlen)
        randomize_start(buffer)

        data = randbytes(maxlen)
        written = buffer.write(data)
        buffer.clear()

        assert written == maxlen
        assert not buffer
        assert len(buffer) == 0
        assert buffer.maxlen == maxlen
        assert buffer.empty()
        assert not buffer.full()

        assert buffer == b""

    def test_write_empty(
        self, maxlen: int, randomize_start: Callable[[bytes], None]
    ) -> None:
        buffer = RingBuffer(maxlen)
        randomize_start(buffer)

        written = buffer.write(b"")
        assert not written
        assert not buffer
        assert len(buffer) == 0
        assert buffer.empty()
        assert not buffer.full()

        assert buffer == b""

    def test_pickle(
        self,
        maxlen: int,
        randomize_start: Callable[[bytes], None],
        randbytes: Callable[[int], bytes],
    ) -> None:
        buffer = RingBuffer(maxlen)
        randomize_start(buffer)

        data = randbytes(maxlen // 2)
        assert buffer.write(data) == len(data)

        other = pickle.loads(pickle.dumps(buffer))
        assert other
        assert other == buffer

    def test_consume_zero(
        self,
        maxlen: int,
        randomize_start: Callable[[bytes], None],
        randbytes: Callable[[int], bytes],
    ) -> None:
        buffer = RingBuffer(maxlen)
        randomize_start(buffer)

        data = randbytes(maxlen)
        assert buffer.write(data) == len(data)
        buffer.consume(0)

        assert buffer.full()
        assert buffer == data

    def test_peek_zero(
        self,
        maxlen: int,
        randomize_start: Callable[[bytes], None],
        randbytes: Callable[[int], bytes],
    ) -> None:
        buffer = RingBuffer(maxlen)
        randomize_start(buffer)

        data = randbytes(maxlen)
        assert buffer.write(data) == len(data)

        peeked = buffer.peek(0)
        assert peeked == b""

        assert buffer.full()
        assert buffer == data

    def test_read_zero(
        self,
        maxlen: int,
        randomize_start: Callable[[bytes], None],
        randbytes: Callable[[int], bytes],
    ) -> None:
        buffer = RingBuffer(maxlen)
        randomize_start(buffer)

        data = randbytes(maxlen)
        written = buffer.write(data)

        assert written == maxlen
        assert buffer.read(0) == b""

    def test_write_full(
        self,
        maxlen: int,
        randomize_start: Callable[[bytes], None],
        randbytes: Callable[[int], bytes],
    ) -> None:
        buffer = RingBuffer(maxlen)
        randomize_start(buffer)

        data = randbytes(maxlen)
        written = buffer.write(data)
        assert written == maxlen
        assert buffer
        assert len(buffer) == maxlen
        assert buffer.maxlen == maxlen
        assert not buffer.empty()
        assert buffer.full()

        assert buffer == data

    @pytest.mark.parametrize(
        "chunk_size", [10, 100, 1000, 1997, 1998, 1999, 2000]
    )
    def test_write_chunks(
        self,
        maxlen: int,
        chunk_size: int,
        randomize_start: Callable[[bytes], None],
        randbytes: Callable[[int], bytes],
    ) -> None:
        buffer = RingBuffer(maxlen)
        randomize_start(buffer)

        data = randbytes(maxlen)
        written = 0
        for index in range(0, maxlen, chunk_size):
            written += buffer.write(data[index : index + chunk_size])

        assert written == maxlen
        assert buffer.full()
        assert buffer == data

    @pytest.mark.parametrize(
        "chunk_size", [10, 100, 1000, 1997, 1998, 1999, 2000]
    )
    def test_peek(
        self,
        maxlen: int,
        chunk_size: int,
        randomize_start: Callable[[bytes], None],
        randbytes: Callable[[int], bytes],
    ) -> None:
        buffer = RingBuffer(maxlen)
        randomize_start(buffer)

        data = randbytes(maxlen)
        written = buffer.write(data)
        for index in range(0, maxlen, chunk_size):
            assert buffer.peek(index) == data[0:index]

        assert written == maxlen
        assert buffer == data

    @pytest.mark.parametrize(
        "chunk_size", [10, 100, 1000, 1997, 1998, 1999, 2000]
    )
    def test_read_chunks(
        self,
        maxlen: int,
        chunk_size: int,
        randomize_start: Callable[[bytes], None],
        randbytes: Callable[[int], bytes],
    ) -> None:
        buffer = RingBuffer(maxlen)
        randomize_start(buffer)

        data = randbytes(maxlen)
        written = buffer.write(data)
        for index in range(0, maxlen, chunk_size):
            assert len(buffer) == maxlen - index
            assert buffer.read(chunk_size) == data[index : index + chunk_size]
        assert written == maxlen
        assert buffer.empty()

    @pytest.mark.parametrize(
        "chunk_size", [10, 100, 1000, 1997, 1998, 1999, 2000]
    )
    def test_read_write_with_wraparound(
        self,
        maxlen: int,
        chunk_size: int,
        randomize_start: Callable[[bytes], None],
        randbytes: Callable[[int], bytes],
    ) -> None:
        buffer = RingBuffer(maxlen)
        randomize_start(buffer)

        wraparound = 5
        written = 0
        for _ in range(wraparound * maxlen // chunk_size):
            data = randbytes(chunk_size)
            written += buffer.write(data)
            assert buffer.read(chunk_size) == data
            assert buffer.empty()
        assert written >= maxlen * (wraparound - 1)

    def test_read_write_with_wraparound_long(
        self,
        maxlen: int,
        randomize_start: Callable[[bytes], None],
        randbytes: Callable[[int], bytes],
    ) -> None:
        buffer = RingBuffer(maxlen)
        randomize_start(buffer)

        size = randint(2, 42) * maxlen
        step = randint(1, maxlen)
        written = 0
        for _ in range(0, size, step):
            data = randbytes(step)
            amt = buffer.write(data)
            written += amt
            assert amt == step
            assert amt == len(data)
            assert written % step == 0
            assert buffer.read(len(data)) == data
            assert buffer.empty()

    def test_write_overflow_raises_buffererror(
        self,
        maxlen: int,
        randomize_start: Callable[[bytes], None],
        randbytes: Callable[[int], bytes],
    ) -> None:
        buffer = RingBuffer(maxlen)
        randomize_start(buffer)

        data = randbytes(maxlen + 1)
        with pytest.raises(BufferError):
            buffer.write(data)
        assert not buffer