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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
|
#!/usr/bin/env python
# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
from dateutil import parser, tz
from tests.functional.s3 import BaseS3TransferCommandTest
class TestLSCommand(BaseS3TransferCommandTest):
def test_operations_used_in_recursive_list(self):
time_utc = "2014-01-09T20:45:49.000Z"
self.parsed_responses = [
{
"CommonPrefixes": [],
"Contents": [
{
"Key": "foo/bar.txt",
"Size": 100,
"LastModified": time_utc,
}
],
}
]
stdout, _, _ = self.run_cmd(
's3 ls s3://bucket/ --recursive', expected_rc=0
)
call_args = self.operations_called[0][1]
# We should not be calling the args with any delimiter because we
# want a recursive listing.
self.assertEqual(call_args['Prefix'], '')
self.assertEqual(call_args['Bucket'], 'bucket')
self.assertNotIn('delimiter', call_args)
# Time is stored in UTC timezone, but the actual time displayed
# is specific to your tzinfo, so shift the timezone to your local's.
time_local = parser.parse(time_utc).astimezone(tz.tzlocal())
self.assertEqual(
stdout,
'%s 100 foo/bar.txt\n'
% time_local.strftime('%Y-%m-%d %H:%M:%S'),
)
def test_errors_out_with_extra_arguments(self):
stderr = self.run_cmd('s3 ls --extra-argument-foo', expected_rc=252)[1]
self.assertIn('Unknown options', stderr)
self.assertIn('--extra-argument-foo', stderr)
def test_list_buckets_use_page_size(self):
stdout, _, _ = self.run_cmd('s3 ls --page-size 8', expected_rc=0)
call_args = self.operations_called[0][1]
# The page size gets translated to ``MaxBuckets`` in the s3 model
self.assertEqual(call_args['MaxBuckets'], 8)
def test_operations_use_page_size(self):
time_utc = "2014-01-09T20:45:49.000Z"
self.parsed_responses = [
{
"CommonPrefixes": [],
"Contents": [
{
"Key": "foo/bar.txt",
"Size": 100,
"LastModified": time_utc,
}
],
}
]
stdout, _, _ = self.run_cmd(
's3 ls s3://bucket/ --page-size 8', expected_rc=0
)
call_args = self.operations_called[0][1]
# We should not be calling the args with any delimiter because we
# want a recursive listing.
self.assertEqual(call_args['Prefix'], '')
self.assertEqual(call_args['Bucket'], 'bucket')
# The page size gets translated to ``MaxKeys`` in the s3 model
self.assertEqual(call_args['MaxKeys'], 8)
def test_operations_use_page_size_recursive(self):
time_utc = "2014-01-09T20:45:49.000Z"
self.parsed_responses = [
{
"CommonPrefixes": [],
"Contents": [
{
"Key": "foo/bar.txt",
"Size": 100,
"LastModified": time_utc,
}
],
}
]
stdout, _, _ = self.run_cmd(
's3 ls s3://bucket/ --page-size 8 --recursive', expected_rc=0
)
call_args = self.operations_called[0][1]
# We should not be calling the args with any delimiter because we
# want a recursive listing.
self.assertEqual(call_args['Prefix'], '')
self.assertEqual(call_args['Bucket'], 'bucket')
# The page size gets translated to ``MaxKeys`` in the s3 model
self.assertEqual(call_args['MaxKeys'], 8)
self.assertNotIn('Delimiter', call_args)
def test_success_rc_has_prefixes_and_objects(self):
time_utc = "2014-01-09T20:45:49.000Z"
self.parsed_responses = [
{
"CommonPrefixes": [{"Prefix": "foo/"}],
"Contents": [
{
"Key": "foo/bar.txt",
"Size": 100,
"LastModified": time_utc,
}
],
}
]
self.run_cmd('s3 ls s3://bucket/foo', expected_rc=0)
def test_success_rc_has_only_prefixes(self):
self.parsed_responses = [{"CommonPrefixes": [{"Prefix": "foo/"}]}]
self.run_cmd('s3 ls s3://bucket/foo', expected_rc=0)
def test_success_rc_has_only_objects(self):
time_utc = "2014-01-09T20:45:49.000Z"
self.parsed_responses = [
{
"Contents": [
{
"Key": "foo/bar.txt",
"Size": 100,
"LastModified": time_utc,
}
]
}
]
self.run_cmd('s3 ls s3://bucket/foo', expected_rc=0)
def test_success_rc_with_pagination(self):
time_utc = "2014-01-09T20:45:49.000Z"
# Pagination should not affect a successful return code of zero, even
# if there are no results on the second page because there were
# results in previous pages.
self.parsed_responses = [
{
"CommonPrefixes": [{"Prefix": "foo/"}],
"Contents": [
{
"Key": "foo/bar.txt",
"Size": 100,
"LastModified": time_utc,
}
],
},
{},
]
self.run_cmd('s3 ls s3://bucket/foo', expected_rc=0)
def test_success_rc_empty_bucket_no_key_given(self):
# If no key has been provdided and the bucket is empty, it should
# still return an rc of 0 since the user is not looking for an actual
# object.
self.parsed_responses = [{}]
self.run_cmd('s3 ls s3://bucket', expected_rc=0)
def test_fail_rc_no_objects_nor_prefixes(self):
self.parsed_responses = [{}]
self.run_cmd('s3 ls s3://bucket/foo', expected_rc=1)
def test_human_readable_file_size(self):
time_utc = "2014-01-09T20:45:49.000Z"
self.parsed_responses = [
{
"CommonPrefixes": [],
"Contents": [
{
"Key": "onebyte.txt",
"Size": 1,
"LastModified": time_utc,
},
{
"Key": "onekilobyte.txt",
"Size": 1024,
"LastModified": time_utc,
},
{
"Key": "onemegabyte.txt",
"Size": 1024**2,
"LastModified": time_utc,
},
{
"Key": "onegigabyte.txt",
"Size": 1024**3,
"LastModified": time_utc,
},
{
"Key": "oneterabyte.txt",
"Size": 1024**4,
"LastModified": time_utc,
},
{
"Key": "onepetabyte.txt",
"Size": 1024**5,
"LastModified": time_utc,
},
],
}
]
stdout, _, _ = self.run_cmd(
's3 ls s3://bucket/ --human-readable', expected_rc=0
)
call_args = self.operations_called[0][1]
# Time is stored in UTC timezone, but the actual time displayed
# is specific to your tzinfo, so shift the timezone to your local's.
time_local = parser.parse(time_utc).astimezone(tz.tzlocal())
time_fmt = time_local.strftime('%Y-%m-%d %H:%M:%S')
self.assertIn('%s 1 Byte onebyte.txt\n' % time_fmt, stdout)
self.assertIn('%s 1.0 KiB onekilobyte.txt\n' % time_fmt, stdout)
self.assertIn('%s 1.0 MiB onemegabyte.txt\n' % time_fmt, stdout)
self.assertIn('%s 1.0 GiB onegigabyte.txt\n' % time_fmt, stdout)
self.assertIn('%s 1.0 TiB oneterabyte.txt\n' % time_fmt, stdout)
self.assertIn('%s 1.0 PiB onepetabyte.txt\n' % time_fmt, stdout)
def test_summarize(self):
time_utc = "2014-01-09T20:45:49.000Z"
self.parsed_responses = [
{
"CommonPrefixes": [],
"Contents": [
{
"Key": "onebyte.txt",
"Size": 1,
"LastModified": time_utc,
},
{
"Key": "onekilobyte.txt",
"Size": 1024,
"LastModified": time_utc,
},
{
"Key": "onemegabyte.txt",
"Size": 1024**2,
"LastModified": time_utc,
},
{
"Key": "onegigabyte.txt",
"Size": 1024**3,
"LastModified": time_utc,
},
{
"Key": "oneterabyte.txt",
"Size": 1024**4,
"LastModified": time_utc,
},
{
"Key": "onepetabyte.txt",
"Size": 1024**5,
"LastModified": time_utc,
},
],
}
]
stdout, _, _ = self.run_cmd(
's3 ls s3://bucket/ --summarize', expected_rc=0
)
call_args = self.operations_called[0][1]
# Time is stored in UTC timezone, but the actual time displayed
# is specific to your tzinfo, so shift the timezone to your local's.
time_local = parser.parse(time_utc).astimezone(tz.tzlocal())
time_fmt = time_local.strftime('%Y-%m-%d %H:%M:%S')
self.assertIn('Total Objects: 6\n', stdout)
self.assertIn('Total Size: 1127000493261825\n', stdout)
def test_summarize_with_human_readable(self):
time_utc = "2014-01-09T20:45:49.000Z"
self.parsed_responses = [
{
"CommonPrefixes": [],
"Contents": [
{
"Key": "onebyte.txt",
"Size": 1,
"LastModified": time_utc,
},
{
"Key": "onekilobyte.txt",
"Size": 1024,
"LastModified": time_utc,
},
{
"Key": "onemegabyte.txt",
"Size": 1024**2,
"LastModified": time_utc,
},
{
"Key": "onegigabyte.txt",
"Size": 1024**3,
"LastModified": time_utc,
},
{
"Key": "oneterabyte.txt",
"Size": 1024**4,
"LastModified": time_utc,
},
{
"Key": "onepetabyte.txt",
"Size": 1024**5,
"LastModified": time_utc,
},
],
}
]
stdout, _, _ = self.run_cmd(
's3 ls s3://bucket/ --human-readable --summarize', expected_rc=0
)
call_args = self.operations_called[0][1]
# Time is stored in UTC timezone, but the actual time displayed
# is specific to your tzinfo, so shift the timezone to your local's.
time_local = parser.parse(time_utc).astimezone(tz.tzlocal())
time_fmt = time_local.strftime('%Y-%m-%d %H:%M:%S')
self.assertIn('Total Objects: 6\n', stdout)
self.assertIn('Total Size: 1.0 PiB\n', stdout)
def test_requester_pays(self):
time_utc = "2014-01-09T20:45:49.000Z"
self.parsed_responses = [
{
"CommonPrefixes": [],
"Contents": [
{
"Key": "onebyte.txt",
"Size": 1,
"LastModified": time_utc,
},
],
}
]
command = 's3 ls s3://mybucket/foo/ --request-payer requester'
self.assert_params_for_cmd(
command,
{
'Bucket': 'mybucket',
'Delimiter': '/',
'RequestPayer': 'requester',
'EncodingType': 'url',
'Prefix': 'foo/',
},
)
def test_requester_pays_with_no_args(self):
time_utc = "2014-01-09T20:45:49.000Z"
self.parsed_responses = [
{
"CommonPrefixes": [],
"Contents": [
{
"Key": "onebyte.txt",
"Size": 1,
"LastModified": time_utc,
},
],
}
]
command = 's3 ls s3://mybucket/foo/ --request-payer'
self.assert_params_for_cmd(
command,
{
'Bucket': 'mybucket',
'Delimiter': '/',
'RequestPayer': 'requester',
'EncodingType': 'url',
'Prefix': 'foo/',
},
)
def test_accesspoint_arn(self):
self.parsed_responses = [self.list_objects_response(['bar.txt'])]
arn = 'arn:aws:s3:us-west-2:123456789012:accesspoint/endpoint'
self.run_cmd('s3 ls s3://%s' % arn, expected_rc=0)
call_args = self.operations_called[0][1]
self.assertEqual(call_args['Bucket'], arn)
def test_list_buckets_uses_bucket_name_prefix(self):
stdout, _, _ = self.run_cmd(
's3 ls --bucket-name-prefix myprefix', expected_rc=0
)
call_args = self.operations_called[0][1]
self.assertEqual(call_args['Prefix'], 'myprefix')
def test_list_buckets_uses_bucket_region(self):
stdout, _, _ = self.run_cmd(
's3 ls --bucket-region us-west-1', expected_rc=0
)
call_args = self.operations_called[0][1]
self.assertEqual(call_args['BucketRegion'], 'us-west-1')
def test_list_objects_ignores_bucket_name_prefix(self):
stdout, _, _ = self.run_cmd(
's3 ls s3://mybucket --bucket-name-prefix myprefix', expected_rc=0
)
call_args = self.operations_called[0][1]
self.assertEqual(call_args['Prefix'], '')
def test_list_objects_ignores_bucket_region(self):
stdout, _, _ = self.run_cmd(
's3 ls s3://mybucket --bucket-region us-west-1', expected_rc=0
)
call_args = self.operations_called[0][1]
self.assertNotIn('BucketRegion', call_args)
|
