File: test_file.py

package info (click to toggle)
flask-wtf 1.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 428 kB
  • sloc: python: 1,313; makefile: 22; sh: 10
file content (270 lines) | stat: -rw-r--r-- 7,726 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
import pytest
from werkzeug.datastructures import FileStorage
from werkzeug.datastructures import ImmutableMultiDict
from werkzeug.datastructures import MultiDict
from wtforms import FileField as BaseFileField
from wtforms import MultipleFileField as BaseMultipleFileField
from wtforms.validators import Length

from flask_wtf import FlaskForm
from flask_wtf.file import FileAllowed
from flask_wtf.file import FileField
from flask_wtf.file import FileRequired
from flask_wtf.file import FileSize
from flask_wtf.file import MultipleFileField


@pytest.fixture
def form(req_ctx):
    class UploadForm(FlaskForm):
        class Meta:
            csrf = False

        file = FileField()
        files = MultipleFileField()

    return UploadForm


def test_process_formdata(form):
    assert form(MultiDict((("file", FileStorage()),))).file.data is None
    assert (
        form(MultiDict((("file", FileStorage(filename="real")),))).file.data is not None
    )


def test_file_required(form):
    form.file.kwargs["validators"] = [FileRequired()]

    f = form()
    assert not f.validate()
    assert f.file.errors[0] == "This field is required."

    f = form(file="not a file")
    assert not f.validate()
    assert f.file.errors[0] == "This field is required."

    f = form(file=FileStorage())
    assert not f.validate()

    f = form(file=FileStorage(filename="real"))
    assert f.validate()


def test_file_allowed(form):
    form.file.kwargs["validators"] = [FileAllowed(("txt",))]

    f = form()
    assert f.validate()

    f = form(file=FileStorage(filename="test.txt"))
    assert f.validate()

    f = form(file=FileStorage(filename="test.png"))
    assert not f.validate()
    assert f.file.errors[0] == "File does not have an approved extension: txt"


def test_file_allowed_uploadset(app, form):
    pytest.importorskip("flask_uploads")
    from flask_uploads import configure_uploads
    from flask_uploads import UploadSet

    app.config["UPLOADS_DEFAULT_DEST"] = "uploads"
    txt = UploadSet("txt", extensions=("txt",))
    configure_uploads(app, (txt,))
    form.file.kwargs["validators"] = [FileAllowed(txt)]

    f = form()
    assert f.validate()

    f = form(file=FileStorage(filename="test.txt"))
    assert f.validate()

    f = form(file=FileStorage(filename="test.png"))
    assert not f.validate()
    assert f.file.errors[0] == "File does not have an approved extension."


def test_file_size_no_file_passes_validation(form):
    form.file.kwargs["validators"] = [FileSize(max_size=100)]
    f = form()
    assert f.validate()


def test_file_size_small_file_passes_validation(form, tmp_path):
    form.file.kwargs["validators"] = [FileSize(max_size=100)]
    path = tmp_path / "test_file_smaller_than_max.txt"
    path.write_bytes(b"\0")

    with path.open("rb") as file:
        f = form(file=FileStorage(file))
        assert f.validate()


@pytest.mark.parametrize(
    "min_size, max_size, invalid_file_size", [(1, 100, 0), (0, 100, 101)]
)
def test_file_size_invalid_file_size_fails_validation(
    form, min_size, max_size, invalid_file_size, tmp_path
):
    form.file.kwargs["validators"] = [FileSize(min_size=min_size, max_size=max_size)]
    path = tmp_path / "test_file_invalid_size.txt"
    path.write_bytes(b"\0" * invalid_file_size)

    with path.open("rb") as file:
        f = form(file=FileStorage(file))
        assert not f.validate()
        assert (
            f.file.errors[0] == f"File must be between {min_size} and {max_size} bytes."
        )


def test_validate_base_field(req_ctx):
    class F(FlaskForm):
        class Meta:
            csrf = False

        f = BaseFileField(validators=[FileRequired()])

    assert not F().validate()
    assert not F(f=FileStorage()).validate()
    assert F(f=FileStorage(filename="real")).validate()
    assert F(f=FileStorage(filename="real")).validate()


def test_process_formdata_for_files(form):
    assert (
        form(
            ImmutableMultiDict([("files", FileStorage()), ("files", FileStorage())])
        ).files.data
        is None
    )
    assert (
        form(
            ImmutableMultiDict(
                [
                    ("files", FileStorage(filename="a.jpg")),
                    ("files", FileStorage(filename="b.jpg")),
                ]
            )
        ).files.data
        is not None
    )


def test_files_required(form):
    form.files.kwargs["validators"] = [FileRequired()]

    f = form()
    assert not f.validate()
    assert f.files.errors[0] == "This field is required."

    f = form(files="not a file")
    assert not f.validate()
    assert f.files.errors[0] == "This field is required."

    f = form(files=[FileStorage()])
    assert not f.validate()

    f = form(files=[FileStorage(filename="real")])
    assert f.validate()


def test_files_allowed(form):
    form.files.kwargs["validators"] = [FileAllowed(("txt",))]

    f = form()
    assert f.validate()

    f = form(
        files=[FileStorage(filename="test.txt"), FileStorage(filename="test2.txt")]
    )
    assert f.validate()

    f = form(files=[FileStorage(filename="test.txt"), FileStorage(filename="test.png")])
    assert not f.validate()
    assert f.files.errors[0] == "File does not have an approved extension: txt"


def test_files_allowed_uploadset(app, form):
    pytest.importorskip("flask_uploads")
    from flask_uploads import configure_uploads
    from flask_uploads import UploadSet

    app.config["UPLOADS_DEFAULT_DEST"] = "uploads"
    txt = UploadSet("txt", extensions=("txt",))
    configure_uploads(app, (txt,))
    form.files.kwargs["validators"] = [FileAllowed(txt)]

    f = form()
    assert f.validate()

    f = form(
        files=[FileStorage(filename="test.txt"), FileStorage(filename="test2.txt")]
    )
    assert f.validate()

    f = form(files=[FileStorage(filename="test.txt"), FileStorage(filename="test.png")])
    assert not f.validate()
    assert f.files.errors[0] == "File does not have an approved extension."


def test_validate_base_multiple_field(req_ctx):
    class F(FlaskForm):
        class Meta:
            csrf = False

        f = BaseMultipleFileField(validators=[FileRequired()])

    assert not F().validate()
    assert not F(f=[FileStorage()]).validate()
    assert F(f=[FileStorage(filename="real")]).validate()


def test_file_size_small_files_pass_validation(form, tmp_path):
    form.files.kwargs["validators"] = [FileSize(max_size=100)]
    path = tmp_path / "test_file_smaller_than_max.txt"
    path.write_bytes(b"\0")

    with path.open("rb") as file:
        f = form(files=[FileStorage(file)])
        assert f.validate()


@pytest.mark.parametrize(
    "min_size, max_size, invalid_file_size", [(1, 100, 0), (0, 100, 101)]
)
def test_file_size_invalid_file_sizes_fails_validation(
    form, min_size, max_size, invalid_file_size, tmp_path
):
    form.files.kwargs["validators"] = [FileSize(min_size=min_size, max_size=max_size)]
    path = tmp_path / "test_file_invalid_size.txt"
    path.write_bytes(b"\0" * invalid_file_size)

    with path.open("rb") as file:
        f = form(files=[FileStorage(file)])
        assert not f.validate()
        assert (
            f.files.errors[0]
            == f"File must be between {min_size} and {max_size} bytes."
        )


def test_files_length(form, min_num=2, max_num=3):
    form.files.kwargs["validators"] = [Length(min_num, max_num)]

    f = form(files=[FileStorage("1")])
    assert not f.validate()
    assert (
        f.files.errors[0]
        == f"Field must be between {min_num} and {max_num} characters long."
    )

    f = form(
        files=[
            FileStorage(filename="1"),
            FileStorage(filename="2"),
        ]
    )
    assert f.validate()