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
|
import os
from django.conf import settings
from django.contrib.staticfiles import finders, storage
from django.core.exceptions import ImproperlyConfigured
from django.test import SimpleTestCase, override_settings
from django.utils.deprecation import RemovedInDjango61Warning
from .cases import StaticFilesTestCase
from .settings import TEST_ROOT
DEPRECATION_MSG = (
"Passing the `all` argument to find() is deprecated. Use `find_all` instead."
)
class TestFinders:
"""
Base finder test mixin.
On Windows, sometimes the case of the path we ask the finders for and the
path(s) they find can differ. Compare them using os.path.normcase() to
avoid false negatives.
"""
def test_find_first(self):
src, dst = self.find_first
found = self.finder.find(src)
self.assertEqual(os.path.normcase(found), os.path.normcase(dst))
def test_find_all(self):
src, dst = self.find_all
found = self.finder.find(src, find_all=True)
found = [os.path.normcase(f) for f in found]
dst = [os.path.normcase(d) for d in dst]
self.assertEqual(found, dst)
def test_find_all_deprecated_param(self):
src, dst = self.find_all
with self.assertWarnsMessage(RemovedInDjango61Warning, DEPRECATION_MSG) as ctx:
found = self.finder.find(src, all=True)
found = [os.path.normcase(f) for f in found]
dst = [os.path.normcase(d) for d in dst]
self.assertEqual(found, dst)
self.assertEqual(ctx.filename, __file__)
def test_find_all_conflicting_params(self):
src, dst = self.find_all
msg = (
f"{self.finder.__class__.__qualname__}.find() got multiple values for "
"argument 'find_all'"
)
with (
self.assertWarnsMessage(RemovedInDjango61Warning, DEPRECATION_MSG) as ctx,
self.assertRaisesMessage(TypeError, msg),
):
self.finder.find(src, find_all=True, all=True)
self.assertEqual(ctx.filename, __file__)
def test_find_all_unexpected_params(self):
src, dst = self.find_all
msg = (
f"{self.finder.__class__.__qualname__}.find() got an unexpected keyword "
"argument 'wrong'"
)
with (
self.assertWarnsMessage(RemovedInDjango61Warning, DEPRECATION_MSG) as ctx,
self.assertRaisesMessage(TypeError, msg),
):
self.finder.find(src, all=True, wrong=1)
self.assertEqual(ctx.filename, __file__)
with self.assertRaisesMessage(TypeError, msg):
self.finder.find(src, find_all=True, wrong=1)
with self.assertRaisesMessage(TypeError, msg):
self.finder.find(src, wrong=1)
class TestFileSystemFinder(TestFinders, StaticFilesTestCase):
"""
Test FileSystemFinder.
"""
def setUp(self):
super().setUp()
self.finder = finders.FileSystemFinder()
test_file_path = os.path.join(
TEST_ROOT, "project", "documents", "test", "file.txt"
)
self.find_first = (os.path.join("test", "file.txt"), test_file_path)
self.find_all = (os.path.join("test", "file.txt"), [test_file_path])
class TestAppDirectoriesFinder(TestFinders, StaticFilesTestCase):
"""
Test AppDirectoriesFinder.
"""
def setUp(self):
super().setUp()
self.finder = finders.AppDirectoriesFinder()
test_file_path = os.path.join(
TEST_ROOT, "apps", "test", "static", "test", "file1.txt"
)
self.find_first = (os.path.join("test", "file1.txt"), test_file_path)
self.find_all = (os.path.join("test", "file1.txt"), [test_file_path])
class TestDefaultStorageFinder(TestFinders, StaticFilesTestCase):
"""
Test DefaultStorageFinder.
"""
def setUp(self):
super().setUp()
self.finder = finders.DefaultStorageFinder(
storage=storage.StaticFilesStorage(location=settings.MEDIA_ROOT)
)
test_file_path = os.path.join(settings.MEDIA_ROOT, "media-file.txt")
self.find_first = ("media-file.txt", test_file_path)
self.find_all = ("media-file.txt", [test_file_path])
@override_settings(
STATICFILES_FINDERS=["django.contrib.staticfiles.finders.FileSystemFinder"],
STATICFILES_DIRS=[os.path.join(TEST_ROOT, "project", "documents")],
)
class TestMiscFinder(SimpleTestCase):
"""
A few misc finder tests.
"""
def test_get_finder(self):
self.assertIsInstance(
finders.get_finder("django.contrib.staticfiles.finders.FileSystemFinder"),
finders.FileSystemFinder,
)
def test_get_finder_bad_classname(self):
with self.assertRaises(ImportError):
finders.get_finder("django.contrib.staticfiles.finders.FooBarFinder")
def test_get_finder_bad_module(self):
with self.assertRaises(ImportError):
finders.get_finder("foo.bar.FooBarFinder")
def test_cache(self):
finders.get_finder.cache_clear()
for n in range(10):
finders.get_finder("django.contrib.staticfiles.finders.FileSystemFinder")
cache_info = finders.get_finder.cache_info()
self.assertEqual(cache_info.hits, 9)
self.assertEqual(cache_info.currsize, 1)
def test_searched_locations(self):
finders.find("spam")
self.assertEqual(
finders.searched_locations,
[os.path.join(TEST_ROOT, "project", "documents")],
)
def test_searched_locations_find_all(self):
finders.find("spam", find_all=True)
self.assertEqual(
finders.searched_locations,
[os.path.join(TEST_ROOT, "project", "documents")],
)
def test_searched_locations_deprecated_all(self):
with self.assertWarnsMessage(RemovedInDjango61Warning, DEPRECATION_MSG) as ctx:
finders.find("spam", all=True)
self.assertEqual(
finders.searched_locations,
[os.path.join(TEST_ROOT, "project", "documents")],
)
self.assertEqual(ctx.filename, __file__)
def test_searched_locations_conflicting_params(self):
msg = "find() got multiple values for argument 'find_all'"
with (
self.assertWarnsMessage(RemovedInDjango61Warning, DEPRECATION_MSG) as ctx,
self.assertRaisesMessage(TypeError, msg),
):
finders.find("spam", find_all=True, all=True)
self.assertEqual(ctx.filename, __file__)
def test_searched_locations_unexpected_params(self):
msg = "find() got an unexpected keyword argument 'wrong'"
with (
self.assertWarnsMessage(RemovedInDjango61Warning, DEPRECATION_MSG) as ctx,
self.assertRaisesMessage(TypeError, msg),
):
finders.find("spam", all=True, wrong=1)
self.assertEqual(ctx.filename, __file__)
with self.assertRaisesMessage(TypeError, msg):
finders.find("spam", find_all=True, wrong=1)
with self.assertRaisesMessage(TypeError, msg):
finders.find("spam", wrong=1)
@override_settings(MEDIA_ROOT="")
def test_location_empty(self):
msg = (
"The storage backend of the staticfiles finder "
"<class 'django.contrib.staticfiles.finders.DefaultStorageFinder'> "
"doesn't have a valid location."
)
with self.assertRaisesMessage(ImproperlyConfigured, msg):
finders.DefaultStorageFinder()
|
