File: test_python_streambuf.py

package info (click to toggle)
dials 3.25.0%2Bdfsg3-3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 20,112 kB
  • sloc: python: 134,740; cpp: 34,526; makefile: 160; sh: 142
file content (154 lines) | stat: -rw-r--r-- 5,196 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
from __future__ import annotations

import io
from unittest import mock

import pytest

import boost_adaptbx.boost.python

from dials.util.ext import ostream, streambuf

ext = boost_adaptbx.boost.python.import_ext("dials_util_streambuf_test_ext")


class io_test_case:
    phrase = b"Coding should be fun"
    #          01234567890123456789

    def run(self):
        m = streambuf.default_buffer_size
        for n in range(50, 0, -1):
            streambuf.default_buffer_size = n
            self.exercise_read_failure()
            self.exercise_write_failure()
            self.exercise_read()
            self.exercise_write()
            self.exercise_seek_and_read()
            self.exercise_partial_read()
            self.exercise_write_and_seek()
        streambuf.default_buffer_size = m

    def exercise_read(self):
        self.create_file_object(mode="rb")
        words = ext.read_word(streambuf(self.file_object))
        assert words == b"Coding, should, be, fun, [ fail, eof ]"
        self.file_object.close()

    def exercise_partial_read(self):
        self.create_file_object(mode="rb")
        words = ext.partial_read(streambuf(self.file_object))
        assert words == b"Coding, should, "
        trailing = self.file_object.read()
        assert trailing == b" be fun"
        self.file_object.close()

    def exercise_read_failure(self):
        self.create_file_object(mode="rb")
        self.file_object.close()
        with pytest.raises(ValueError):
            ext.read_word(streambuf(self.file_object))
        self.file_object.close()

    def exercise_write(self):
        self.create_file_object(mode="wb")
        report = ext.write_word(ostream(self.file_object))
        assert report == b""
        assert self.file_content() == b"2 times 1.6 equals 3.2"
        self.file_object.close()

    def exercise_seek_and_read(self):
        self.create_file_object(mode="rb")
        instrumented_file = mock.Mock(spec=self.file_object, wraps=self.file_object)
        words = ext.read_and_seek(streambuf(instrumented_file))
        assert words == b"should, should, uld, ding, fun, [ eof ]"
        n = streambuf.default_buffer_size
        soughts = instrumented_file.seek.call_args_list
        # stringent tests carefully crafted to make sure the seek-in-buffer
        # optimisation works as expected
        # C.f. the comment in the C++ function actual_write_test
        assert soughts[-1] == mock.call(-4, 2)
        soughts = soughts[:-1]
        if n >= 14:
            assert soughts == []
        else:
            assert soughts[0] == mock.call(6, 0)
            soughts = soughts[1:]
            if 8 <= n <= 13:
                assert len(soughts) == 1 and self.only_seek_cur(soughts)
            elif n == 7:
                assert len(soughts) == 2 and self.only_seek_cur(soughts)
            else:
                assert soughts[0] == mock.call(6, 0)
                soughts = soughts[1:]
                assert self.only_seek_cur(soughts)
                if n == 4:
                    assert len(soughts) == 1
                else:
                    assert len(soughts) == 2
        self.file_object.close()

    def exercise_write_and_seek(self):
        self.create_file_object(mode="wb")
        instrumented_file = mock.Mock(spec=self.file_object, wraps=self.file_object)
        report = ext.write_and_seek(ostream(instrumented_file))
        assert report == b""
        expected = b"1000 times 1000 equals 1000000"
        assert self.file_content() == expected
        assert self.file_object.tell() == 9
        if streambuf.default_buffer_size >= 30:
            assert instrumented_file.write.call_count == 1
        self.file_object.close()

    @staticmethod
    def only_seek_cur(seek_calls):
        return all(call == mock.call(mock.ANY, 1) for call in seek_calls)


class bytesio_test_case(io_test_case):
    def exercise_write_failure(self):
        pass

    def create_file_object(self, mode):
        if mode == "rb":
            self.file_object = io.BytesIO(self.phrase)
        elif mode == "wb":
            self.file_object = io.BytesIO()
        else:
            raise NotImplementedError("Internal error in the test code")

    def file_content(self):
        return self.file_object.getvalue()


class mere_file_test_case(io_test_case):
    def exercise_write_failure(self):
        self.create_file_object(mode="rb")
        with pytest.raises(IOError):
            ext.write_word(streambuf(self.file_object))
        self.file_object.close()

    def create_file_object(self, mode):
        f = open("tmp_tst_python_streambuf", "wb")
        if mode.find("rb") > -1:
            f.write(self.phrase)
        f.close()
        self.file_object = open(f.name, mode)

    def file_content(self):
        self.file_object.flush()
        with open(self.file_object.name, "rb") as fh:
            result = fh.read()
        return result


def test_with_bytesio():
    bytesio_test_case().run()


@pytest.mark.xfail(
    "os.name == 'nt'", reason="crashes python process on Windows", run=False
)
def test_with_file(tmp_path, monkeypatch):
    monkeypatch.chdir(tmp_path)
    mere_file_test_case().run()