Debian Codegraph @

tests/forms_tests/field_tests/test_filefield.py

raw
1 import pickle
2 import unittest
3
4 from django.core.exceptions import ValidationError
5 from django.core.files.uploadedfile import SimpleUploadedFile
6 from django.core.validators import validate_image_file_extension
7 from django.forms import FileField, FileInput
8 from django.test import SimpleTestCase
9
10 try:
11 from PIL import Image # NOQA
12 except ImportError:
13 HAS_PILLOW = False
14 else:
15 HAS_PILLOW = True
16
17
18 class FileFieldTest(SimpleTestCase):
19 def test_filefield_1(self):
20 f = FileField()
21 with self.assertRaisesMessage(ValidationError, "'This field is required.'"):
22 f.clean("")
23 with self.assertRaisesMessage(ValidationError, "'This field is required.'"):
24 f.clean("", "")
25 self.assertEqual("files/test1.pdf", f.clean("", "files/test1.pdf"))
26 with self.assertRaisesMessage(ValidationError, "'This field is required.'"):
27 f.clean(None)
28 with self.assertRaisesMessage(ValidationError, "'This field is required.'"):
29 f.clean(None, "")
30 self.assertEqual("files/test2.pdf", f.clean(None, "files/test2.pdf"))
31 no_file_msg = "'No file was submitted. Check the encoding type on the form.'"
32 file = SimpleUploadedFile(None, b"")
33 file._name = ""
34 with self.assertRaisesMessage(ValidationError, no_file_msg):
35 f.clean(file)
36 with self.assertRaisesMessage(ValidationError, no_file_msg):
37 f.clean(file, "")
38 self.assertEqual("files/test3.pdf", f.clean(None, "files/test3.pdf"))
39 with self.assertRaisesMessage(ValidationError, no_file_msg):
40 f.clean("some content that is not a file")
41 with self.assertRaisesMessage(
42 ValidationError, "'The submitted file is empty.'"
43 ):
44 f.clean(SimpleUploadedFile("name", None))
45 with self.assertRaisesMessage(
46 ValidationError, "'The submitted file is empty.'"
47 ):
48 f.clean(SimpleUploadedFile("name", b""))
49 self.assertEqual(
50 SimpleUploadedFile,
51 type(f.clean(SimpleUploadedFile("name", b"Some File Content"))),
52 )
53 self.assertIsInstance(
54 f.clean(
55 SimpleUploadedFile(
56 "我隻氣墊船裝滿晒鱔.txt",
57 "मेरी मँडराने वाली नाव सर्पमीनों से भरी ह".encode(),
58 )
59 ),
60 SimpleUploadedFile,
61 )
62 self.assertIsInstance(
63 f.clean(
64 SimpleUploadedFile("name", b"Some File Content"), "files/test4.pdf"
65 ),
66 SimpleUploadedFile,
67 )
68
69 def test_filefield_2(self):
70 f = FileField(max_length=5)
71 with self.assertRaisesMessage(
72 ValidationError,
73 "'Ensure this filename has at most 5 characters (it has 18).'",
74 ):
75 f.clean(SimpleUploadedFile("test_maxlength.txt", b"hello world"))
76 self.assertEqual("files/test1.pdf", f.clean("", "files/test1.pdf"))
77 self.assertEqual("files/test2.pdf", f.clean(None, "files/test2.pdf"))
78 self.assertIsInstance(
79 f.clean(SimpleUploadedFile("name", b"Some File Content")),
80 SimpleUploadedFile,
81 )
82
83 def test_filefield_3(self):
84 f = FileField(allow_empty_file=True)
85 self.assertIsInstance(
86 f.clean(SimpleUploadedFile("name", b"")), SimpleUploadedFile
87 )
88
89 def test_filefield_changed(self):
90 """
91 The value of data will more than likely come from request.FILES. The
92 value of initial data will likely be a filename stored in the database.
93 Since its value is of no use to a FileField it is ignored.
94 """
95 f = FileField()
96
97 # No file was uploaded and no initial data.
98 self.assertFalse(f.has_changed("", None))
99
100 # A file was uploaded and no initial data.
101 self.assertTrue(
102 f.has_changed("", {"filename": "resume.txt", "content": "My resume"})
103 )
104
105 # A file was not uploaded, but there is initial data
106 self.assertFalse(f.has_changed("resume.txt", None))
107
108 # A file was uploaded and there is initial data (file identity is not dealt
109 # with here)
110 self.assertTrue(
111 f.has_changed(
112 "resume.txt", {"filename": "resume.txt", "content": "My resume"}
113 )
114 )
115
116 def test_disabled_has_changed(self):
117 f = FileField(disabled=True)
118 self.assertIs(f.has_changed("x", "y"), False)
119
120 def test_file_picklable(self):
121 self.assertIsInstance(pickle.loads(pickle.dumps(FileField())), FileField)
122
123
124 class MultipleFileInput(FileInput):
125 allow_multiple_selected = True
126
127
128 class MultipleFileField(FileField):
129 def __init__(self, *args, **kwargs):
130 kwargs.setdefault("widget", MultipleFileInput())
131 super().__init__(*args, **kwargs)
132
133 def clean(self, data, initial=None):
134 single_file_clean = super().clean
135 if isinstance(data, (list, tuple)):
136 result = [single_file_clean(d, initial) for d in data]
137 else:
138 result = single_file_clean(data, initial)
139 return result
140
141
142 class MultipleFileFieldTest(SimpleTestCase):
143 def test_file_multiple(self):
144 f = MultipleFileField()
145 files = [
146 SimpleUploadedFile("name1", b"Content 1"),
147 SimpleUploadedFile("name2", b"Content 2"),
148 ]
149 self.assertEqual(f.clean(files), files)
150
151 def test_file_multiple_empty(self):
152 f = MultipleFileField()
153 files = [
154 SimpleUploadedFile("empty", b""),
155 SimpleUploadedFile("nonempty", b"Some Content"),
156 ]
157 msg = "'The submitted file is empty.'"
158 with self.assertRaisesMessage(ValidationError, msg):
159 f.clean(files)
160 with self.assertRaisesMessage(ValidationError, msg):
161 f.clean(files[::-1])
162
163 @unittest.skipUnless(HAS_PILLOW, "Pillow not installed")
164 def test_file_multiple_validation(self):
165 f = MultipleFileField(validators=[validate_image_file_extension])
166
167 good_files = [
168 SimpleUploadedFile("image1.jpg", b"fake JPEG"),
169 SimpleUploadedFile("image2.png", b"faux image"),
170 SimpleUploadedFile("image3.bmp", b"fraudulent bitmap"),
171 ]
172 self.assertEqual(f.clean(good_files), good_files)
173
174 evil_files = [
175 SimpleUploadedFile("image1.sh", b"#!/bin/bash -c 'echo pwned!'\n"),
176 SimpleUploadedFile("image2.png", b"faux image"),
177 SimpleUploadedFile("image3.jpg", b"fake JPEG"),
178 ]
179
180 evil_rotations = (
181 evil_files[i:] + evil_files[:i] # Rotate by i.
182 for i in range(len(evil_files))
183 )
184 msg = "File extension “sh” is not allowed. Allowed extensions are: "
185 for rotated_evil_files in evil_rotations:
186 with self.assertRaisesMessage(ValidationError, msg):
187 f.clean(rotated_evil_files)