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
|
# -*- coding: utf-8 -*-
import os
import shutil
from django.conf import settings
from django.core.management import CommandError, call_command
from django.test import TestCase
from django.test.utils import override_settings
from io import StringIO
from django_extensions.management.commands.sync_s3 import Command
from unittest.mock import Mock, patch
class SyncS3TestsMixin:
def setUp(self):
self.m_boto = Mock()
self.boto_patch = patch(
"django_extensions.management.commands.sync_s3.boto",
create=True,
boto=self.m_boto,
)
self.boto_patch.start()
def tearDown(self):
super().tearDown()
self.boto_patch.stop()
@patch("django_extensions.management.commands.sync_s3.HAS_BOTO", True)
class SyncS3ExceptionsTests(SyncS3TestsMixin, TestCase):
def test_should_raise_ImportError_if_boto_is_not_installed(self):
with patch("django_extensions.management.commands.sync_s3.HAS_BOTO", False):
with self.assertRaisesRegex(
CommandError,
r"Please install the 'boto' Python library. \(\$ pip install boto\)",
):
call_command("sync_s3")
@override_settings(AWS_ACCESS_KEY_ID=None)
def test_should_raise_CommandError_if_AWS_ACCESS_KEY_ID_is_not_set_or_is_set_to_None(
self,
):
with self.assertRaisesRegex(
CommandError,
"Missing AWS keys from settings file. Please supply both AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY",
):
call_command("sync_s3")
@override_settings(AWS_SECRET_ACCESS_KEY=None)
def test_should_raise_CommandError_if_AWS_SECRET_ACCESS_KEY_is_not_set_or_is_set_to_None(
self,
):
with self.assertRaisesRegex(
CommandError,
"Missing AWS keys from settings file. Please supply both AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY",
):
call_command("sync_s3")
@override_settings(
AWS_ACCESS_KEY_ID="access_key_id",
AWS_SECRET_ACCESS_KEY="secret_access_key",
AWS_BUCKET_NAME="",
)
def test_should_raise_CommandError_if_AWS_BUCKET_NAME_is_set_to_None(self):
with self.assertRaisesRegex(CommandError, "AWS_BUCKET_NAME cannot be empty"):
call_command("sync_s3")
@override_settings(
AWS_ACCESS_KEY_ID="access_key_id",
AWS_SECRET_ACCESS_KEY="secret_access_key",
)
def test_should_raise_CommandError_if_AWS_BUCKET_NAME_does_not_have_AWS_BUCKET_NAME_attr(
self,
):
del settings.AWS_BUCKET_NAME
with self.assertRaisesRegex(
CommandError,
"Missing bucket name from settings file. Please add the AWS_BUCKET_NAME to your settings file.",
):
call_command("sync_s3")
@override_settings(
AWS_ACCESS_KEY_ID="access_key_id",
AWS_SECRET_ACCESS_KEY="secret_access_key",
AWS_BUCKET_NAME="bucket_name",
MEDIA_ROOT=None,
)
def test_should_raise_CommandError_if_MEDIA_ROOT_is_None(self):
with self.assertRaisesRegex(
CommandError, "MEDIA_ROOT must be set in your settings."
):
call_command("sync_s3")
@override_settings(
AWS_ACCESS_KEY_ID="access_key_id",
AWS_SECRET_ACCESS_KEY="secret_access_key",
AWS_BUCKET_NAME="bucket_name",
)
def test_should_raise_CommandError_if_settings_does_not_have_MEDIA_ROOT_attr(self):
del settings.MEDIA_ROOT
with self.assertRaisesRegex(
CommandError, "MEDIA_ROOT must be set in your settings."
):
call_command("sync_s3")
@override_settings(
AWS_ACCESS_KEY_ID="access_key_id",
AWS_SECRET_ACCESS_KEY="secret_access_key",
AWS_BUCKET_NAME="bucket_name",
)
def test_should_raise_CommandError_when_media_only_and_static_only_options_together(
self,
):
with self.assertRaisesRegex(
CommandError,
"Can't use --media-only and --static-only together. Better not use anything...",
):
call_command("sync_s3", "--media-only", "--static-only")
@override_settings(
AWS_ACCESS_KEY_ID="access_key_id",
AWS_SECRET_ACCESS_KEY="secret_access_key",
AWS_BUCKET_NAME="bucket_name",
)
def test_should_raise_CommandError_when_medi(self):
m_bucket = Mock()
del settings.AWS_CLOUDFRONT_DISTRIBUTION
self.m_boto.connect_s3.return_value.get_bucket.return_value = m_bucket
self.m_boto.s3.key.Key.return_value = "bucket_key"
with self.assertRaisesRegex(
CommandError,
"An object invalidation was requested but the variable AWS_CLOUDFRONT_DISTRIBUTION is not present in your settings.",
):
call_command("sync_s3", "--media-only", "--invalidate")
@patch("django_extensions.management.commands.sync_s3.HAS_BOTO", Mock(side_effect=True))
class SyncS3Tests(TestCase):
def setUp(self):
current_dir = os.path.dirname(os.path.abspath(__file__))
media_root = os.path.join(current_dir, "media")
if os.path.isdir(media_root):
shutil.rmtree(media_root)
os.mkdir(media_root)
test_dirs = [
os.path.join(media_root, "testdir1"),
os.path.join(media_root, "testdir2"),
os.path.join(media_root, "testdir3"),
os.path.join(media_root, "testdir4"),
os.path.join(media_root, "testsamenamedir"),
]
for dir_ in test_dirs:
os.mkdir(dir_)
test_sub_dir = os.path.join(media_root, "testdir2", "testsubdir1")
os.mkdir(test_sub_dir)
test_sub_dir_base = os.path.join(media_root, "testdir1")
test_sub_dirs = [
os.path.join(test_sub_dir_base, "testsubdir1"),
os.path.join(test_sub_dir_base, "testsubdir2"),
os.path.join(test_sub_dir_base, "testsubdir3"),
os.path.join(test_sub_dir_base, "testsubdir4"),
]
for dir_ in test_sub_dirs:
os.mkdir(dir_)
test_sub_dir_base2 = os.path.join(media_root, "testdir3")
test_sub_dirs_2 = [
os.path.join(test_sub_dir_base2, "testsubdir1"),
os.path.join(test_sub_dir_base2, "testsubdir2"),
os.path.join(test_sub_dir_base2, "testsubdir3"),
os.path.join(test_sub_dir_base2, "testsubdir4"),
os.path.join(test_sub_dir_base2, "testsamenamedir"),
]
for dir_ in test_sub_dirs_2:
os.mkdir(dir_)
def tearDown(self):
current_dir = os.path.dirname(os.path.abspath(__file__))
media_root = os.path.join(current_dir, "media")
shutil.rmtree(media_root)
@override_settings(
MEDIA_ROOT=os.path.join(os.path.dirname(os.path.abspath(__file__)), "media")
)
@override_settings(
STATIC_ROOT=os.path.join(os.path.dirname(os.path.abspath(__file__)), "static")
)
@override_settings(AWS_ACCESS_KEY_ID="FAKE_KEY")
@override_settings(AWS_SECRET_ACCESS_KEY="FAKE_SECRET_KEY")
@override_settings(AWS_BUCKET_NAME="FAKE_BUCKET_NAME")
def test_sync_s3_dir_exclusions(self):
sync_s3_command = Command()
try:
call_command(
"sync_s3",
"--acl=authenticated-read",
"--filter-list=testsamenamedir,testdir1",
)
except Exception:
# Exception is expected, we're not actually attempting to connect to S3
self.assertEqual(0, 0)
for directory in sync_s3_command.DIRECTORIES:
for root, dirs, files in os.walk(directory):
sync_s3_command.upload_s3(
("FAKE_BUCKET", "FAKE_KEY", "FAKE_BUCKET_NAME", directory),
root,
files,
dirs,
)
dir_name = os.path.basename(root)
if dir_name == "testdir1":
self.assertEqual(len(dirs), 0)
elif dir_name == "testdir2":
self.assertEqual(len(dirs), 1)
elif dir_name == "testdir3":
self.assertEqual(len(dirs), 5)
@patch("django_extensions.management.commands.sync_s3.HAS_BOTO", Mock(side_effect=True))
class SyncS3CommandTests(SyncS3TestsMixin, TestCase):
@override_settings(
AWS_ACCESS_KEY_ID="access_key_id",
AWS_SECRET_ACCESS_KEY="secret_access_key",
AWS_BUCKET_NAME="bucket_name",
)
@patch("sys.stdout", new_callable=StringIO)
def test_should_raise_CommandError_when_medi(self, m_stdout):
self.m_boto.connect_s3.return_value.get_bucket.return_value = Mock()
self.m_boto.s3.key.Key.return_value = "bucket_key"
call_command("sync_s3", "--media-only")
self.assertIn("0 files uploaded.", m_stdout.getvalue())
self.assertIn("0 files skipped.", m_stdout.getvalue())
|
