| 1 |
from django.core.files.uploadedfile import SimpleUploadedFile |
| 2 |
from django.forms import ClearableFileInput, FileField, Form, MultiWidget |
| 3 |
|
| 4 |
from .base import WidgetTest |
| 5 |
|
| 6 |
|
| 7 |
class FakeFieldFile: |
| 8 |
""" |
| 9 |
Quacks like a FieldFile (has a .url and string representation), but |
| 10 |
doesn't require us to care about storages etc. |
| 11 |
""" |
| 12 |
|
| 13 |
url = "something" |
| 14 |
|
| 15 |
def __str__(self): |
| 16 |
return self.url |
| 17 |
|
| 18 |
|
| 19 |
class ClearableFileInputTest(WidgetTest): |
| 20 |
def setUp(self): |
| 21 |
self.widget = ClearableFileInput() |
| 22 |
|
| 23 |
def test_clear_input_renders(self): |
| 24 |
""" |
| 25 |
A ClearableFileInput with is_required False and rendered with an |
| 26 |
initial value that is a file renders a clear checkbox. |
| 27 |
""" |
| 28 |
self.check_html( |
| 29 |
self.widget, |
| 30 |
"myfile", |
| 31 |
FakeFieldFile(), |
| 32 |
html=(""" |
| 33 |
Currently: <a href="something">something</a> |
| 34 |
<input type="checkbox" name="myfile-clear" id="myfile-clear_id"> |
| 35 |
<label for="myfile-clear_id">Clear</label><br> |
| 36 |
Change: <input type="file" name="myfile"> |
| 37 |
"""), |
| 38 |
) |
| 39 |
|
| 40 |
def test_html_escaped(self): |
| 41 |
""" |
| 42 |
A ClearableFileInput should escape name, filename, and URL |
| 43 |
when rendering HTML (#15182). |
| 44 |
""" |
| 45 |
|
| 46 |
class StrangeFieldFile: |
| 47 |
url = "something?chapter=1§=2©=3&lang=en" |
| 48 |
|
| 49 |
def __str__(self): |
| 50 |
return """something<div onclick="alert('oops')">.jpg""" |
| 51 |
|
| 52 |
self.check_html( |
| 53 |
ClearableFileInput(), |
| 54 |
"my<div>file", |
| 55 |
StrangeFieldFile(), |
| 56 |
html=(""" |
| 57 |
Currently: |
| 58 |
<a href="something?chapter=1&sect=2&copy=3&lang=en"> |
| 59 |
something<div onclick="alert('oops')">.jpg</a> |
| 60 |
<input type="checkbox" name="my<div>file-clear" |
| 61 |
id="my<div>file-clear_id"> |
| 62 |
<label for="my<div>file-clear_id">Clear</label><br> |
| 63 |
Change: <input type="file" name="my<div>file"> |
| 64 |
"""), |
| 65 |
) |
| 66 |
|
| 67 |
def test_clear_input_renders_only_if_not_required(self): |
| 68 |
""" |
| 69 |
A ClearableFileInput with is_required=True does not render a clear |
| 70 |
checkbox. |
| 71 |
""" |
| 72 |
widget = ClearableFileInput() |
| 73 |
widget.is_required = True |
| 74 |
self.check_html( |
| 75 |
widget, |
| 76 |
"myfile", |
| 77 |
FakeFieldFile(), |
| 78 |
html=(""" |
| 79 |
Currently: <a href="something">something</a> <br> |
| 80 |
Change: <input type="file" name="myfile"> |
| 81 |
"""), |
| 82 |
) |
| 83 |
|
| 84 |
def test_clear_input_renders_only_if_initial(self): |
| 85 |
""" |
| 86 |
A ClearableFileInput instantiated with no initial value does not render |
| 87 |
a clear checkbox. |
| 88 |
""" |
| 89 |
self.check_html( |
| 90 |
self.widget, "myfile", None, html='<input type="file" name="myfile">' |
| 91 |
) |
| 92 |
|
| 93 |
def test_render_disabled(self): |
| 94 |
self.check_html( |
| 95 |
self.widget, |
| 96 |
"myfile", |
| 97 |
FakeFieldFile(), |
| 98 |
attrs={"disabled": True}, |
| 99 |
html=( |
| 100 |
'Currently: <a href="something">something</a>' |
| 101 |
'<input type="checkbox" name="myfile-clear" ' |
| 102 |
'id="myfile-clear_id" disabled>' |
| 103 |
'<label for="myfile-clear_id">Clear</label><br>' |
| 104 |
'Change: <input type="file" name="myfile" disabled>' |
| 105 |
), |
| 106 |
) |
| 107 |
|
| 108 |
def test_render_checked(self): |
| 109 |
self.widget.checked = True |
| 110 |
self.check_html( |
| 111 |
self.widget, |
| 112 |
"myfile", |
| 113 |
FakeFieldFile(), |
| 114 |
html=( |
| 115 |
'Currently: <a href="something">something</a>' |
| 116 |
'<input type="checkbox" name="myfile-clear" id="myfile-clear_id" ' |
| 117 |
"checked>" |
| 118 |
'<label for="myfile-clear_id">Clear</label><br>Change: ' |
| 119 |
'<input type="file" name="myfile" checked>' |
| 120 |
), |
| 121 |
) |
| 122 |
|
| 123 |
def test_render_no_disabled(self): |
| 124 |
class TestForm(Form): |
| 125 |
clearable_file = FileField( |
| 126 |
widget=self.widget, initial=FakeFieldFile(), required=False |
| 127 |
) |
| 128 |
|
| 129 |
form = TestForm() |
| 130 |
with self.assertNoLogs("django.template", "DEBUG"): |
| 131 |
form.render() |
| 132 |
|
| 133 |
def test_render_as_subwidget(self): |
| 134 |
"""A ClearableFileInput as a subwidget of MultiWidget.""" |
| 135 |
widget = MultiWidget(widgets=(self.widget,)) |
| 136 |
self.check_html( |
| 137 |
widget, |
| 138 |
"myfile", |
| 139 |
[FakeFieldFile()], |
| 140 |
html=(""" |
| 141 |
Currently: <a href="something">something</a> |
| 142 |
<input type="checkbox" name="myfile_0-clear" id="myfile_0-clear_id"> |
| 143 |
<label for="myfile_0-clear_id">Clear</label><br> |
| 144 |
Change: <input type="file" name="myfile_0"> |
| 145 |
"""), |
| 146 |
) |
| 147 |
|
| 148 |
def test_clear_input_checked_returns_false(self): |
| 149 |
""" |
| 150 |
ClearableFileInput.value_from_datadict returns False if the clear |
| 151 |
checkbox is checked, if not required. |
| 152 |
""" |
| 153 |
value = self.widget.value_from_datadict( |
| 154 |
data={"myfile-clear": True}, |
| 155 |
files={}, |
| 156 |
name="myfile", |
| 157 |
) |
| 158 |
self.assertIs(value, False) |
| 159 |
self.assertIs(self.widget.checked, True) |
| 160 |
|
| 161 |
def test_clear_input_checked_returns_false_only_if_not_required(self): |
| 162 |
""" |
| 163 |
ClearableFileInput.value_from_datadict never returns False if the field |
| 164 |
is required. |
| 165 |
""" |
| 166 |
widget = ClearableFileInput() |
| 167 |
widget.is_required = True |
| 168 |
field = SimpleUploadedFile("something.txt", b"content") |
| 169 |
|
| 170 |
value = widget.value_from_datadict( |
| 171 |
data={"myfile-clear": True}, |
| 172 |
files={"myfile": field}, |
| 173 |
name="myfile", |
| 174 |
) |
| 175 |
self.assertEqual(value, field) |
| 176 |
self.assertIs(widget.checked, True) |
| 177 |
|
| 178 |
def test_html_does_not_mask_exceptions(self): |
| 179 |
""" |
| 180 |
A ClearableFileInput should not mask exceptions produced while |
| 181 |
checking that it has a value. |
| 182 |
""" |
| 183 |
|
| 184 |
class FailingURLFieldFile: |
| 185 |
@property |
| 186 |
def url(self): |
| 187 |
raise ValueError("Canary") |
| 188 |
|
| 189 |
def __str__(self): |
| 190 |
return "value" |
| 191 |
|
| 192 |
with self.assertRaisesMessage(ValueError, "Canary"): |
| 193 |
self.widget.render("myfile", FailingURLFieldFile()) |
| 194 |
|
| 195 |
def test_url_as_property(self): |
| 196 |
class URLFieldFile: |
| 197 |
@property |
| 198 |
def url(self): |
| 199 |
return "https://www.python.org/" |
| 200 |
|
| 201 |
def __str__(self): |
| 202 |
return "value" |
| 203 |
|
| 204 |
html = self.widget.render("myfile", URLFieldFile()) |
| 205 |
self.assertInHTML('<a href="https://www.python.org/">value</a>', html) |
| 206 |
|
| 207 |
def test_return_false_if_url_does_not_exists(self): |
| 208 |
class NoURLFieldFile: |
| 209 |
def __str__(self): |
| 210 |
return "value" |
| 211 |
|
| 212 |
html = self.widget.render("myfile", NoURLFieldFile()) |
| 213 |
self.assertHTMLEqual(html, '<input name="myfile" type="file">') |
| 214 |
|
| 215 |
def test_use_required_attribute(self): |
| 216 |
# False when initial data exists. The file input is left blank by the |
| 217 |
# user to keep the existing, initial value. |
| 218 |
self.assertIs(self.widget.use_required_attribute(None), True) |
| 219 |
self.assertIs(self.widget.use_required_attribute("resume.txt"), False) |
| 220 |
|
| 221 |
def test_value_omitted_from_data(self): |
| 222 |
widget = ClearableFileInput() |
| 223 |
self.assertIs(widget.value_omitted_from_data({}, {}, "field"), True) |
| 224 |
self.assertIs( |
| 225 |
widget.value_omitted_from_data({}, {"field": "x"}, "field"), False |
| 226 |
) |
| 227 |
self.assertIs( |
| 228 |
widget.value_omitted_from_data({"field-clear": "y"}, {}, "field"), False |
| 229 |
) |
| 230 |
|
| 231 |
def test_fieldset(self): |
| 232 |
class TestForm(Form): |
| 233 |
template_name = "forms_tests/use_fieldset.html" |
| 234 |
field = FileField(widget=self.widget) |
| 235 |
with_file = FileField(widget=self.widget, initial=FakeFieldFile()) |
| 236 |
clearable_file = FileField( |
| 237 |
widget=self.widget, initial=FakeFieldFile(), required=False |
| 238 |
) |
| 239 |
|
| 240 |
form = TestForm() |
| 241 |
self.assertIs(self.widget.use_fieldset, False) |
| 242 |
self.assertHTMLEqual( |
| 243 |
'<div><label for="id_field">Field:</label>' |
| 244 |
'<input id="id_field" name="field" type="file" required></div>' |
| 245 |
'<div><label for="id_with_file">With file:</label>Currently: ' |
| 246 |
'<a href="something">something</a><br>Change:<input type="file" ' |
| 247 |
'name="with_file" id="id_with_file"></div>' |
| 248 |
'<div><label for="id_clearable_file">Clearable file:</label>' |
| 249 |
'Currently: <a href="something">something</a><input ' |
| 250 |
'type="checkbox" name="clearable_file-clear" id="clearable_file-clear_id">' |
| 251 |
'<label for="clearable_file-clear_id">Clear</label><br>Change:' |
| 252 |
'<input type="file" name="clearable_file" id="id_clearable_file"></div>', |
| 253 |
form.render(), |
| 254 |
) |
| 255 |
|
| 256 |
def test_multiple_error(self): |
| 257 |
msg = "ClearableFileInput doesn't support uploading multiple files." |
| 258 |
with self.assertRaisesMessage(ValueError, msg): |
| 259 |
ClearableFileInput(attrs={"multiple": True}) |