-
Notifications
You must be signed in to change notification settings - Fork 108
/
AWSS3StorageDownloadTest.java
320 lines (286 loc) · 12.6 KB
/
AWSS3StorageDownloadTest.java
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
/*
* Copyright 2021 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.
*/
package com.amplifyframework.storage.s3;
import android.content.Context;
import com.amplifyframework.auth.AuthPlugin;
import com.amplifyframework.auth.cognito.AWSCognitoAuthPlugin;
import com.amplifyframework.core.Amplify;
import com.amplifyframework.core.async.Cancelable;
import com.amplifyframework.core.async.Resumable;
import com.amplifyframework.hub.HubChannel;
import com.amplifyframework.hub.HubEvent;
import com.amplifyframework.hub.SubscriptionToken;
import com.amplifyframework.storage.StorageAccessLevel;
import com.amplifyframework.storage.StorageCategory;
import com.amplifyframework.storage.StorageChannelEventName;
import com.amplifyframework.storage.TransferState;
import com.amplifyframework.storage.operation.StorageDownloadFileOperation;
import com.amplifyframework.storage.options.StorageDownloadFileOptions;
import com.amplifyframework.storage.options.StorageUploadFileOptions;
import com.amplifyframework.storage.s3.test.R;
import com.amplifyframework.storage.s3.util.WorkmanagerTestUtils;
import com.amplifyframework.testutils.FileAssert;
import com.amplifyframework.testutils.random.RandomTempFile;
import com.amplifyframework.testutils.sync.SynchronousAuth;
import com.amplifyframework.testutils.sync.SynchronousStorage;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import java.io.File;
import java.util.HashSet;
import java.util.Set;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;
import static androidx.test.core.app.ApplicationProvider.getApplicationContext;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
/**
* Instrumentation test for operational work on download.
*/
public final class AWSS3StorageDownloadTest {
private static final long EXTENDED_TIMEOUT_MS = TimeUnit.SECONDS.toMillis(60);
private static final StorageAccessLevel TESTING_ACCESS_LEVEL = StorageAccessLevel.PUBLIC;
private static final long LARGE_FILE_SIZE = 10 * 1024 * 1024L; // 10 MB
private static final long SMALL_FILE_SIZE = 100L;
private static final String LARGE_FILE_NAME = "large-" + System.currentTimeMillis();
private static final String SMALL_FILE_NAME = "small-" + System.currentTimeMillis();
private static File largeFile;
private static File smallFile;
private static StorageCategory storageCategory;
private static SynchronousStorage synchronousStorage;
private File downloadFile;
private StorageDownloadFileOptions options;
private Set<SubscriptionToken> subscriptions;
/**
* Initialize mobile client and configure the storage.
* Upload the test files ahead of time.
*
* @throws Exception if mobile client initialization fails
*/
@BeforeClass
public static void setUpOnce() throws Exception {
Context context = getApplicationContext();
WorkmanagerTestUtils.INSTANCE.initializeWorkmanagerTestUtil(context);
SynchronousAuth.delegatingToCognito(context, (AuthPlugin) new AWSCognitoAuthPlugin());
// Get a handle to storage
storageCategory = TestStorageCategory.create(context, R.raw.amplifyconfiguration);
synchronousStorage = SynchronousStorage.delegatingTo(storageCategory);
// Upload to PUBLIC for consistency
String key;
StorageUploadFileOptions uploadOptions = StorageUploadFileOptions.builder()
.accessLevel(TESTING_ACCESS_LEVEL)
.build();
// Upload large test file
largeFile = new RandomTempFile(LARGE_FILE_NAME, LARGE_FILE_SIZE);
key = LARGE_FILE_NAME;
synchronousStorage.uploadFile(key, largeFile, uploadOptions, EXTENDED_TIMEOUT_MS);
// Upload small test file
smallFile = new RandomTempFile(SMALL_FILE_NAME, SMALL_FILE_SIZE);
key = SMALL_FILE_NAME;
synchronousStorage.uploadFile(key, smallFile, uploadOptions);
}
/**
* Sets up the options to use for transfer.
*
* @throws Exception if fails to create random temp file
*/
@Before
public void setUp() throws Exception {
// Always interact with PUBLIC access for consistency
options = StorageDownloadFileOptions.builder()
.accessLevel(TESTING_ACCESS_LEVEL)
.build();
// Create a set to remember all the subscriptions
subscriptions = new HashSet<>();
// Create a file to download to
downloadFile = new RandomTempFile();
}
/**
* Unsubscribe from everything after each test.
*/
@After
public void tearDown() {
// Unsubscribe from everything
for (SubscriptionToken token : subscriptions) {
Amplify.Hub.unsubscribe(token);
}
}
/**
* Tests that small file (single-part) downloads successfully.
*
* @throws Exception if download fails
*/
@Test
public void testDownloadSmallFile() throws Exception {
synchronousStorage.downloadFile(SMALL_FILE_NAME, downloadFile, options);
FileAssert.assertEquals(smallFile, downloadFile);
}
/**
* Tests that large file (multi-part) downloads successfully.
*
* @throws Exception if download fails
*/
@Test
public void testDownloadLargeFile() throws Exception {
synchronousStorage.downloadFile(LARGE_FILE_NAME, downloadFile, options, EXTENDED_TIMEOUT_MS);
FileAssert.assertEquals(largeFile, downloadFile);
}
/**
* Tests that file download operation can be canceled while the
* transfer hasn't completed yet.
*
* @throws Exception if download is not canceled successfully
* before timeout
*/
@SuppressWarnings("unchecked")
@Test
public void testDownloadFileIsCancelable() throws Exception {
final CountDownLatch canceled = new CountDownLatch(1);
final AtomicReference<Cancelable> opContainer = new AtomicReference<>();
final AtomicReference<Throwable> errorContainer = new AtomicReference<>();
// Listen to Hub events for cancel
SubscriptionToken cancelToken = Amplify.Hub.subscribe(HubChannel.STORAGE, hubEvent -> {
if (StorageChannelEventName.DOWNLOAD_STATE.toString().equals(hubEvent.getName())) {
HubEvent<String> stateEvent = (HubEvent<String>) hubEvent;
TransferState state = TransferState.getState(stateEvent.getData());
if (TransferState.CANCELED.equals(state)) {
canceled.countDown();
}
}
});
subscriptions.add(cancelToken);
// Begin downloading a large file
StorageDownloadFileOperation<?> op = storageCategory.downloadFile(
LARGE_FILE_NAME,
downloadFile,
options,
progress -> {
if (progress.getCurrentBytes() > 0 && canceled.getCount() > 0) {
opContainer.get().cancel();
}
},
result -> errorContainer.set(new RuntimeException("Download completed without canceling.")),
errorContainer::set
);
opContainer.set(op);
// Assert that the required conditions have been met
assertTrue(canceled.await(EXTENDED_TIMEOUT_MS, TimeUnit.MILLISECONDS));
assertNull(errorContainer.get());
}
/**
* Tests that file download operation can be paused and resumed
* while the transfer hasn't completed yet.
*
* @throws Exception if download is not paused, resumed, and
* completed successfully before timeout
*/
@SuppressWarnings("unchecked")
@Test
public void testDownloadFileIsResumable() throws Exception {
final CountDownLatch completed = new CountDownLatch(1);
final CountDownLatch resumed = new CountDownLatch(1);
final AtomicReference<Resumable> opContainer = new AtomicReference<>();
final AtomicReference<Throwable> errorContainer = new AtomicReference<>();
// Listen to Hub events to resume when operation has been paused
SubscriptionToken resumeToken = Amplify.Hub.subscribe(HubChannel.STORAGE, hubEvent -> {
if (StorageChannelEventName.DOWNLOAD_STATE.toString().equals(hubEvent.getName())) {
HubEvent<String> stateEvent = (HubEvent<String>) hubEvent;
TransferState state = TransferState.getState(stateEvent.getData());
if (TransferState.PAUSED.equals(state)) {
opContainer.get().resume();
resumed.countDown();
}
}
});
subscriptions.add(resumeToken);
// Begin downloading a large file
StorageDownloadFileOperation<?> op = storageCategory.downloadFile(
LARGE_FILE_NAME,
downloadFile,
options,
progress -> {
//Log.i("DOWNLOAD TEST", "received "+progress.getFractionCompleted());
if (progress.getCurrentBytes() > 0 && resumed.getCount() > 0) {
opContainer.get().pause();
}
},
result -> completed.countDown(),
errorContainer::set
);
opContainer.set(op);
// Assert that all the required conditions have been met
assertTrue(resumed.await(EXTENDED_TIMEOUT_MS, TimeUnit.MILLISECONDS));
assertTrue(completed.await(EXTENDED_TIMEOUT_MS, TimeUnit.MILLISECONDS));
assertNull(errorContainer.get());
FileAssert.assertEquals(largeFile, downloadFile);
}
/**
* Tests that a pause operation could be resumed using get transferAPI.
*
* @throws Exception if download is not paused, resumed, and
* completed successfully before timeout
*/
@SuppressWarnings("unchecked")
@Test
public void testGetTransferOnPause() throws Exception {
final CountDownLatch completed = new CountDownLatch(1);
final CountDownLatch resumed = new CountDownLatch(1);
final AtomicReference<StorageDownloadFileOperation<?>> opContainer = new AtomicReference<>();
final AtomicReference<String> transferId = new AtomicReference<>();
final AtomicReference<Throwable> errorContainer = new AtomicReference<>();
// Listen to Hub events to resume when operation has been paused
SubscriptionToken resumeToken = Amplify.Hub.subscribe(HubChannel.STORAGE, hubEvent -> {
if (StorageChannelEventName.DOWNLOAD_STATE.toString().equals(hubEvent.getName())) {
HubEvent<String> stateEvent = (HubEvent<String>) hubEvent;
TransferState state = TransferState.getState(stateEvent.getData());
if (TransferState.PAUSED.equals(state)) {
opContainer.get().clearAllListeners();
storageCategory.getTransfer(transferId.get(), operation -> {
StorageDownloadFileOperation<?> getOp = (StorageDownloadFileOperation) operation;
getOp.resume();
resumed.countDown();
getOp.setOnSuccess(result -> {
completed.countDown();
});
}, errorContainer::set);
}
}
});
subscriptions.add(resumeToken);
// Begin downloading a large file
StorageDownloadFileOperation<?> op = storageCategory.downloadFile(
LARGE_FILE_NAME,
downloadFile,
options,
progress -> {
if (progress.getCurrentBytes() > 0 && resumed.getCount() > 0) {
opContainer.get().pause();
}
},
result -> {
},
errorContainer::set
);
opContainer.set(op);
transferId.set(op.getTransferId());
// Assert that all the required conditions have been met
assertTrue(resumed.await(EXTENDED_TIMEOUT_MS, TimeUnit.MILLISECONDS));
assertTrue(completed.await(EXTENDED_TIMEOUT_MS, TimeUnit.MILLISECONDS));
assertNull(errorContainer.get());
FileAssert.assertEquals(largeFile, downloadFile);
}
}