summaryrefslogtreecommitdiff
path: root/javatests/com/google/android/libraries/mobiledatadownload/ImportFilesIntegrationTest.java
blob: dc5f1eaac47015082db722f27e66fa1982d33c88 (plain)
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
/*
 * Copyright 2022 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.google.android.libraries.mobiledatadownload;

import static com.google.android.libraries.mobiledatadownload.TestFileGroupPopulator.FILE_CHECKSUM;
import static com.google.android.libraries.mobiledatadownload.TestFileGroupPopulator.FILE_GROUP_NAME;
import static com.google.android.libraries.mobiledatadownload.TestFileGroupPopulator.FILE_ID;
import static com.google.android.libraries.mobiledatadownload.TestFileGroupPopulator.FILE_SIZE;
import static com.google.android.libraries.mobiledatadownload.TestFileGroupPopulator.FILE_URL;
import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertThrows;
import static org.junit.Assert.fail;

import android.content.Context;
import android.net.Uri;
import android.os.Environment;
import androidx.test.core.app.ApplicationProvider;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import com.google.android.libraries.mobiledatadownload.DownloadException.DownloadResultCode;
import com.google.android.libraries.mobiledatadownload.downloader.DownloadRequest;
import com.google.android.libraries.mobiledatadownload.downloader.FileDownloader;
import com.google.android.libraries.mobiledatadownload.downloader.MultiSchemeFileDownloader;
import com.google.android.libraries.mobiledatadownload.downloader.inline.InlineFileDownloader;
import com.google.android.libraries.mobiledatadownload.downloader.offroad.dagger.downloader2.BaseFileDownloaderModule;
import com.google.android.libraries.mobiledatadownload.file.SynchronousFileStorage;
import com.google.android.libraries.mobiledatadownload.file.backends.AndroidFileBackend;
import com.google.android.libraries.mobiledatadownload.file.backends.FileUri;
import com.google.android.libraries.mobiledatadownload.file.backends.JavaFileBackend;
import com.google.android.libraries.mobiledatadownload.file.common.testing.FakeFileBackend;
import com.google.android.libraries.mobiledatadownload.file.common.testing.FakeFileBackend.OperationType;
import com.google.android.libraries.mobiledatadownload.file.integration.downloader.SharedPreferencesDownloadMetadata;
import com.google.android.libraries.mobiledatadownload.file.openers.ReadStreamOpener;
import com.google.android.libraries.mobiledatadownload.file.transforms.CompressTransform;
import com.google.android.libraries.mobiledatadownload.monitor.DownloadProgressMonitor;
import com.google.android.libraries.mobiledatadownload.monitor.NetworkUsageMonitor;
import com.google.android.libraries.mobiledatadownload.testing.BlockingFileDownloader;
import com.google.android.libraries.mobiledatadownload.testing.TestFlags;
import com.google.common.base.Optional;
import com.google.common.base.Supplier;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.truth.Correspondence;
import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.ListeningExecutorService;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.mobiledatadownload.ClientConfigProto.ClientFile;
import com.google.mobiledatadownload.ClientConfigProto.ClientFileGroup;
import com.google.mobiledatadownload.ClientConfigProto.ClientFileGroup.Status;
import com.google.mobiledatadownload.DownloadConfigProto.DataFile;
import com.google.mobiledatadownload.DownloadConfigProto.DataFileGroup;
import com.google.protobuf.ByteString;
import java.io.IOException;
import java.io.InputStream;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.atomic.AtomicInteger;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoRule;

@RunWith(AndroidJUnit4.class)
public final class ImportFilesIntegrationTest {

  @Rule public final MockitoRule mocks = MockitoJUnit.rule();

  private static final String TAG = "ImportFilesIntegrationTest";

  private static final String TEST_DATA_ABSOLUTE_PATH =
      Environment.getExternalStorageDirectory()
          + "/googletest/test_runfiles/google3/third_party/java_src/android_libs/mobiledatadownload/javatests/com/google/android/libraries/mobiledatadownload/testdata/";

  // Note: Control Executor must not be a single thread executor.
  private static final ListeningExecutorService CONTROL_EXECUTOR =
      MoreExecutors.listeningDecorator(Executors.newCachedThreadPool());
  private static final ScheduledExecutorService DOWNLOAD_EXECUTOR =
      Executors.newScheduledThreadPool(2);

  private static final String FILE_ID_1 = "test-file-1";
  private static final Uri FILE_URI_1 =
      Uri.parse(
          FileUri.builder().setPath(TEST_DATA_ABSOLUTE_PATH + "odws1_empty").build().toString());
  private static final String FILE_CHECKSUM_1 = "a1cba9d87b1440f41ce9e7da38c43e1f6bd7d5df";
  private static final String FILE_URL_1 = "inlinefile:sha1:" + FILE_CHECKSUM_1;
  private static final int FILE_SIZE_1 = 554;
  private static final DataFile INLINE_DATA_FILE_1 =
      DataFile.newBuilder()
          .setFileId(FILE_ID_1)
          .setByteSize(FILE_SIZE_1)
          .setUrlToDownload(FILE_URL_1)
          .setChecksum(FILE_CHECKSUM_1)
          .build();

  private static final String FILE_ID_2 = "test-file-2";
  private static final Uri FILE_URI_2 =
      Uri.parse(
          FileUri.builder()
              .setPath(TEST_DATA_ABSOLUTE_PATH + "zip_test_folder.zip")
              .build()
              .toString());
  private static final String FILE_CHECKSUM_2 = "7024b6bcddf2b2897656e9353f7fc715df5ea986";
  private static final String FILE_URL_2 = "inlinefile:sha2:" + FILE_CHECKSUM_2;
  private static final int FILE_SIZE_2 = 373;
  private static final DataFile INLINE_DATA_FILE_2 =
      DataFile.newBuilder()
          .setFileId(FILE_ID_2)
          .setByteSize(FILE_SIZE_2)
          .setUrlToDownload(FILE_URL_2)
          .setChecksum(FILE_CHECKSUM_2)
          .build();

  private static final Context context = ApplicationProvider.getApplicationContext();

  @Mock private TaskScheduler mockTaskScheduler;
  @Mock private NetworkUsageMonitor mockNetworkUsageMonitor;
  @Mock private DownloadProgressMonitor mockDownloadProgressMonitor;

  private FakeFileBackend fakeFileBackend;
  private SynchronousFileStorage fileStorage;
  private Supplier<FileDownloader> multiSchemeFileDownloaderSupplier;
  private MobileDataDownload mobileDataDownload;

  private FileSource inlineFileSource1;
  private FileSource inlineFileSource2;

  private final TestFlags flags = new TestFlags();

  @Before
  public void setUp() throws Exception {

    fakeFileBackend = new FakeFileBackend(AndroidFileBackend.builder(context).build());
    fileStorage =
        new SynchronousFileStorage(
            /* backends= */ ImmutableList.of(fakeFileBackend, new JavaFileBackend()),
            /* transforms= */ ImmutableList.of(new CompressTransform()),
            /* monitors= */ ImmutableList.of(mockNetworkUsageMonitor, mockDownloadProgressMonitor));

    Supplier<FileDownloader> fileDownloaderSupplier =
        () ->
            BaseFileDownloaderModule.createOffroad2FileDownloader(
                context,
                DOWNLOAD_EXECUTOR,
                CONTROL_EXECUTOR,
                fileStorage,
                new SharedPreferencesDownloadMetadata(
                    context.getSharedPreferences("downloadmetadata", 0), CONTROL_EXECUTOR),
                Optional.of(mockDownloadProgressMonitor),
                /* urlEngineOptional= */ Optional.absent(),
                /* exceptionHandlerOptional= */ Optional.absent(),
                /* authTokenProviderOptional= */ Optional.absent(),
                /* trafficTag= */ Optional.absent(),
                flags);

    Supplier<FileDownloader> inlineFileDownloaderSupplier =
        () -> new InlineFileDownloader(fileStorage, DOWNLOAD_EXECUTOR);
    multiSchemeFileDownloaderSupplier =
        () ->
            MultiSchemeFileDownloader.builder()
                .addScheme("https", fileDownloaderSupplier.get())
                .addScheme("inlinefile", inlineFileDownloaderSupplier.get())
                .build();

    // Set up inline file sources
    try (InputStream fileStream1 = fileStorage.open(FILE_URI_1, ReadStreamOpener.create());
        InputStream fileStream2 = fileStorage.open(FILE_URI_2, ReadStreamOpener.create())) {
      inlineFileSource1 = FileSource.ofByteString(ByteString.readFrom(fileStream1));
      inlineFileSource2 = FileSource.ofByteString(ByteString.readFrom(fileStream2));
    }
  }

  @After
  public void tearDown() throws Exception {
    // Clear file group to ensure there is not cross-test pollination
    mobileDataDownload.clear().get();
    // Reset fake file backend
    fakeFileBackend.clearFailure(OperationType.ALL);
  }

  @Test
  public void importFiles_performsImport() throws Exception {
    createMobileDataDownload(multiSchemeFileDownloaderSupplier);

    DataFileGroup fileGroupWithInlineFile =
        DataFileGroup.newBuilder()
            .setGroupName(FILE_GROUP_NAME)
            .addFile(INLINE_DATA_FILE_1)
            .build();

    // Ensure that we add the file group successfully
    assertThat(
            mobileDataDownload
                .addFileGroup(
                    AddFileGroupRequest.newBuilder()
                        .setDataFileGroup(fileGroupWithInlineFile)
                        .build())
                .get())
        .isTrue();

    // Perform the import
    mobileDataDownload
        .importFiles(
            ImportFilesRequest.newBuilder()
                .setGroupName(FILE_GROUP_NAME)
                .setBuildId(fileGroupWithInlineFile.getBuildId())
                .setVariantId(fileGroupWithInlineFile.getVariantId())
                .setInlineFileMap(ImmutableMap.of(FILE_ID_1, inlineFileSource1))
                .build())
        .get();

    // Assert that the resulting group is downloaded and contains a reference to on device file
    ClientFileGroup importResult =
        mobileDataDownload
            .getFileGroup(GetFileGroupRequest.newBuilder().setGroupName(FILE_GROUP_NAME).build())
            .get();

    assertThat(importResult).isNotNull();
    assertThat(importResult.getGroupName()).isEqualTo(FILE_GROUP_NAME);
    assertThat(importResult.getFileCount()).isEqualTo(1);
    assertThat(importResult.getStatus()).isEqualTo(Status.DOWNLOADED);
    assertThat(importResult.getFile(0).getFileUri()).isNotEmpty();

    assertThat(fileStorage.exists(Uri.parse(importResult.getFile(0).getFileUri()))).isTrue();
  }

  @Test
  public void importFiles_whenImportingMultipleFiles_performsImport() throws Exception {
    createMobileDataDownload(multiSchemeFileDownloaderSupplier);

    DataFileGroup fileGroupWithInlineFile =
        DataFileGroup.newBuilder()
            .setGroupName(FILE_GROUP_NAME)
            .addFile(INLINE_DATA_FILE_1)
            .addFile(INLINE_DATA_FILE_2)
            .build();

    // Ensure that we add the file group successfully
    assertThat(
            mobileDataDownload
                .addFileGroup(
                    AddFileGroupRequest.newBuilder()
                        .setDataFileGroup(fileGroupWithInlineFile)
                        .build())
                .get())
        .isTrue();

    // Perform the import
    mobileDataDownload
        .importFiles(
            ImportFilesRequest.newBuilder()
                .setGroupName(FILE_GROUP_NAME)
                .setBuildId(fileGroupWithInlineFile.getBuildId())
                .setVariantId(fileGroupWithInlineFile.getVariantId())
                .setInlineFileMap(
                    ImmutableMap.of(FILE_ID_1, inlineFileSource1, FILE_ID_2, inlineFileSource2))
                .build())
        .get();

    // Assert that the resulting group is downloaded and contains a reference to on device file
    ClientFileGroup importResult =
        mobileDataDownload
            .getFileGroup(GetFileGroupRequest.newBuilder().setGroupName(FILE_GROUP_NAME).build())
            .get();

    assertThat(importResult).isNotNull();
    assertThat(importResult.getGroupName()).isEqualTo(FILE_GROUP_NAME);
    assertThat(importResult.getFileCount()).isEqualTo(2);
    assertThat(importResult.getStatus()).isEqualTo(Status.DOWNLOADED);
    assertThat(importResult.getFile(0).getFileUri()).isNotEmpty();
    assertThat(importResult.getFile(1).getFileUri()).isNotEmpty();

    assertThat(fileStorage.exists(Uri.parse(importResult.getFile(0).getFileUri()))).isTrue();
    assertThat(fileStorage.exists(Uri.parse(importResult.getFile(1).getFileUri()))).isTrue();
  }

  @Test
  public void importFiles_supportsMultipleCallsConcurrently() throws Exception {
    // Use BlockingFileDownloader to ensure both imports start around the same time.
    AtomicInteger fileDownloaderInvocationCount = new AtomicInteger(0);
    BlockingFileDownloader blockingFileDownloader =
        new BlockingFileDownloader(
            MoreExecutors.listeningDecorator(DOWNLOAD_EXECUTOR),
            new FileDownloader() {
              @Override
              public ListenableFuture<Void> startDownloading(DownloadRequest request) {
                fileDownloaderInvocationCount.addAndGet(1);
                return multiSchemeFileDownloaderSupplier.get().startDownloading(request);
              }
            });
    createMobileDataDownload(() -> blockingFileDownloader);

    DataFileGroup fileGroup1WithInlineFile =
        DataFileGroup.newBuilder()
            .setGroupName(FILE_GROUP_NAME)
            .addFile(INLINE_DATA_FILE_1)
            .build();

    DataFileGroup fileGroup2WithInlineFile =
        DataFileGroup.newBuilder()
            .setGroupName(FILE_GROUP_NAME + "2")
            .addFile(INLINE_DATA_FILE_2)
            .build();

    // Ensure that we add the file groups successfully
    assertThat(
            mobileDataDownload
                .addFileGroup(
                    AddFileGroupRequest.newBuilder()
                        .setDataFileGroup(fileGroup1WithInlineFile)
                        .build())
                .get())
        .isTrue();
    assertThat(
            mobileDataDownload
                .addFileGroup(
                    AddFileGroupRequest.newBuilder()
                        .setDataFileGroup(fileGroup2WithInlineFile)
                        .build())
                .get())
        .isTrue();

    // Perform the imports
    ListenableFuture<Void> importFuture1 =
        mobileDataDownload.importFiles(
            ImportFilesRequest.newBuilder()
                .setGroupName(FILE_GROUP_NAME)
                .setBuildId(fileGroup1WithInlineFile.getBuildId())
                .setVariantId(fileGroup1WithInlineFile.getVariantId())
                .setInlineFileMap(ImmutableMap.of(FILE_ID_1, inlineFileSource1))
                .build());

    ListenableFuture<Void> importFuture2 =
        mobileDataDownload.importFiles(
            ImportFilesRequest.newBuilder()
                .setGroupName(FILE_GROUP_NAME + "2")
                .setBuildId(fileGroup2WithInlineFile.getBuildId())
                .setVariantId(fileGroup2WithInlineFile.getVariantId())
                .setInlineFileMap(ImmutableMap.of(FILE_ID_2, inlineFileSource2))
                .build());

    // blocking file downloader should be waiting on the imports, block the test to ensure both
    // imports have started.
    blockingFileDownloader.waitForDownloadStarted();

    // unblock the imports so both happen concurrently.
    blockingFileDownloader.finishDownloading();

    // Wait for both futures to complete
    Futures.whenAllSucceed(importFuture1, importFuture2).call(() -> null, CONTROL_EXECUTOR).get();

    // Assert that the resulting group is downloaded and contains a reference to on device file
    ClientFileGroup importResult1 =
        mobileDataDownload
            .getFileGroup(GetFileGroupRequest.newBuilder().setGroupName(FILE_GROUP_NAME).build())
            .get();
    ClientFileGroup importResult2 =
        mobileDataDownload
            .getFileGroup(
                GetFileGroupRequest.newBuilder().setGroupName(FILE_GROUP_NAME + "2").build())
            .get();

    assertThat(importResult1).isNotNull();
    assertThat(importResult1.getFileCount()).isEqualTo(1);
    assertThat(importResult1.getStatus()).isEqualTo(Status.DOWNLOADED);
    assertThat(importResult1.getFile(0).getFileUri()).isNotEmpty();

    assertThat(importResult2).isNotNull();
    assertThat(importResult2.getFileCount()).isEqualTo(1);
    assertThat(importResult2.getStatus()).isEqualTo(Status.DOWNLOADED);
    assertThat(importResult2.getFile(0).getFileUri()).isNotEmpty();

    assertThat(fileStorage.exists(Uri.parse(importResult1.getFile(0).getFileUri()))).isTrue();
    assertThat(fileStorage.exists(Uri.parse(importResult2.getFile(0).getFileUri()))).isTrue();

    // assert that file downloader was called 2 times, 1 for each import.
    assertThat(fileDownloaderInvocationCount.get()).isEqualTo(2);
  }

  @Test
  public void importFiles_whenNewInlineFileSpecified_importsAndStoresFile() throws Exception {
    createMobileDataDownload(multiSchemeFileDownloaderSupplier);

    DataFileGroup fileGroupWithOneInlineFile =
        DataFileGroup.newBuilder()
            .setGroupName(FILE_GROUP_NAME)
            .addFile(INLINE_DATA_FILE_1)
            .build();
    ImmutableList<DataFile> updatedDataFileList = ImmutableList.of(INLINE_DATA_FILE_2);

    // Ensure that we add the file group successfully
    assertThat(
            mobileDataDownload
                .addFileGroup(
                    AddFileGroupRequest.newBuilder()
                        .setDataFileGroup(fileGroupWithOneInlineFile)
                        .build())
                .get())
        .isTrue();

    // Perform the import
    mobileDataDownload
        .importFiles(
            ImportFilesRequest.newBuilder()
                .setGroupName(FILE_GROUP_NAME)
                .setBuildId(fileGroupWithOneInlineFile.getBuildId())
                .setVariantId(fileGroupWithOneInlineFile.getVariantId())
                .setUpdatedDataFileList(updatedDataFileList)
                .setInlineFileMap(
                    ImmutableMap.of(FILE_ID_1, inlineFileSource1, FILE_ID_2, inlineFileSource2))
                .build())
        .get();

    // Assert that the resulting group is downloaded and contains both files
    ClientFileGroup importResult =
        mobileDataDownload
            .getFileGroup(GetFileGroupRequest.newBuilder().setGroupName(FILE_GROUP_NAME).build())
            .get();

    assertThat(importResult.getGroupName()).isEqualTo(FILE_GROUP_NAME);
    assertThat(importResult.getFileCount()).isEqualTo(2);
    assertThat(importResult.getStatus()).isEqualTo(Status.DOWNLOADED);
    assertThat(importResult.getFileList())
        .comparingElementsUsing(Correspondence.transforming(ClientFile::getFileId, "using file id"))
        .containsExactly(FILE_ID_1, FILE_ID_2);
    assertThat(importResult.getFile(0).getFileUri()).isNotEmpty();
    assertThat(importResult.getFile(1).getFileUri()).isNotEmpty();
  }

  @Test
  public void importFiles_whenNewInlineFileAddedToPendingGroup_importsAndStoresFile()
      throws Exception {
    createMobileDataDownload(multiSchemeFileDownloaderSupplier);

    DataFileGroup fileGroupWithStandardFile =
        DataFileGroup.newBuilder()
            .setGroupName(FILE_GROUP_NAME)
            .addFile(
                DataFile.newBuilder()
                    .setFileId(FILE_ID)
                    .setUrlToDownload(FILE_URL)
                    .setChecksum(FILE_CHECKSUM)
                    .setByteSize(FILE_SIZE)
                    .build())
            .build();
    ImmutableList<DataFile> updatedDataFileList = ImmutableList.of(INLINE_DATA_FILE_2);

    // Ensure that we add the file group successfully
    assertThat(
            mobileDataDownload
                .addFileGroup(
                    AddFileGroupRequest.newBuilder()
                        .setDataFileGroup(fileGroupWithStandardFile)
                        .build())
                .get())
        .isTrue();

    // Perform the import
    mobileDataDownload
        .importFiles(
            ImportFilesRequest.newBuilder()
                .setGroupName(FILE_GROUP_NAME)
                .setBuildId(fileGroupWithStandardFile.getBuildId())
                .setVariantId(fileGroupWithStandardFile.getVariantId())
                .setUpdatedDataFileList(updatedDataFileList)
                .setInlineFileMap(ImmutableMap.of(FILE_ID_2, inlineFileSource2))
                .build())
        .get();

    // Assert that the file is pending (does not return from getFileGroup)
    ClientFileGroup getFileGroupResult =
        mobileDataDownload
            .getFileGroup(GetFileGroupRequest.newBuilder().setGroupName(FILE_GROUP_NAME).build())
            .get();
    assertThat(getFileGroupResult).isNull();

    // Use getFileGroupsByFilter to get the file group
    ImmutableList<ClientFileGroup> allFileGroups =
        mobileDataDownload
            .getFileGroupsByFilter(
                GetFileGroupsByFilterRequest.newBuilder()
                    .setGroupNameOptional(Optional.of(FILE_GROUP_NAME))
                    .build())
            .get();

    // GetFileGroupsByFilter returns both downloaded and pending, so find the pending group.
    ClientFileGroup pendingInlineGroup = null;
    for (ClientFileGroup group : allFileGroups) {
      if (group.getStatus().equals(Status.PENDING)) {
        pendingInlineGroup = group;
        break;
      }
    }

    // Assert that the resulting group is pending and but contains imported file
    assertThat(pendingInlineGroup).isNotNull();
    assertThat(pendingInlineGroup.getGroupName()).isEqualTo(FILE_GROUP_NAME);
    assertThat(pendingInlineGroup.getFileCount()).isEqualTo(2);
    assertThat(pendingInlineGroup.getStatus()).isEqualTo(Status.PENDING);
    assertThat(pendingInlineGroup.getFileList())
        .comparingElementsUsing(Correspondence.transforming(ClientFile::getFileId, "using file id"))
        .containsExactly(FILE_ID, FILE_ID_2);
  }

  @Test
  public void importFiles_toNonExistentDataFileGroup_fails() throws Exception {
    createMobileDataDownload(multiSchemeFileDownloaderSupplier);

    FileSource inlineFileSource = FileSource.ofByteString(ByteString.copyFromUtf8("TEST_CONTENT"));

    // Perform the import
    ExecutionException ex =
        assertThrows(
            ExecutionException.class,
            () ->
                mobileDataDownload
                    .importFiles(
                        ImportFilesRequest.newBuilder()
                            .setGroupName(FILE_GROUP_NAME)
                            .setBuildId(0)
                            .setVariantId("")
                            .setInlineFileMap(ImmutableMap.of(FILE_ID_1, inlineFileSource))
                            .build())
                    .get());
    assertThat(ex).hasCauseThat().isInstanceOf(DownloadException.class);
    DownloadException dex = (DownloadException) ex.getCause();
    assertThat(dex.getDownloadResultCode()).isEqualTo(DownloadResultCode.GROUP_NOT_FOUND_ERROR);
  }

  @Test
  public void importFiles_whenMismatchedVersion_failToImport() throws Exception {
    createMobileDataDownload(multiSchemeFileDownloaderSupplier);

    DataFileGroup fileGroupWithInlineFile =
        DataFileGroup.newBuilder()
            .setGroupName(FILE_GROUP_NAME)
            .addFile(INLINE_DATA_FILE_1)
            .build();

    // Ensure that we add the file group successfully
    assertThat(
            mobileDataDownload
                .addFileGroup(
                    AddFileGroupRequest.newBuilder()
                        .setDataFileGroup(fileGroupWithInlineFile)
                        .build())
                .get())
        .isTrue();

    // Perform the import
    ExecutionException ex =
        assertThrows(
            ExecutionException.class,
            () ->
                mobileDataDownload
                    .importFiles(
                        ImportFilesRequest.newBuilder()
                            .setGroupName(FILE_GROUP_NAME)
                            .setBuildId(10)
                            .setVariantId("")
                            .setInlineFileMap(ImmutableMap.of(FILE_ID_1, inlineFileSource1))
                            .build())
                    .get());
    assertThat(ex).hasCauseThat().isInstanceOf(DownloadException.class);
    DownloadException dex = (DownloadException) ex.getCause();
    assertThat(dex.getDownloadResultCode()).isEqualTo(DownloadResultCode.GROUP_NOT_FOUND_ERROR);
  }

  @Test
  public void importFiles_whenImportFails_doesNotWriteUpdatedMetadata() throws Exception {
    createMobileDataDownload(multiSchemeFileDownloaderSupplier);

    // Create initial file group to import
    DataFileGroup initialFileGroup =
        DataFileGroup.newBuilder()
            .setGroupName(FILE_GROUP_NAME)
            .addFile(INLINE_DATA_FILE_1)
            .build();

    // Ensure that we add the file group successfully
    assertThat(
            mobileDataDownload
                .addFileGroup(
                    AddFileGroupRequest.newBuilder().setDataFileGroup(initialFileGroup).build())
                .get())
        .isTrue();

    // Perform the initial import
    mobileDataDownload
        .importFiles(
            ImportFilesRequest.newBuilder()
                .setGroupName(FILE_GROUP_NAME)
                .setBuildId(initialFileGroup.getBuildId())
                .setVariantId(initialFileGroup.getVariantId())
                .setInlineFileMap(ImmutableMap.of(FILE_ID_1, inlineFileSource1))
                .build())
        .get();

    // Assert that the resulting group is downloaded and contains a reference to on device file
    ClientFileGroup currentFileGroup =
        mobileDataDownload
            .getFileGroup(GetFileGroupRequest.newBuilder().setGroupName(FILE_GROUP_NAME).build())
            .get();

    assertThat(currentFileGroup).isNotNull();
    assertThat(currentFileGroup.getGroupName()).isEqualTo(FILE_GROUP_NAME);
    assertThat(currentFileGroup.getFileCount()).isEqualTo(1);
    assertThat(currentFileGroup.getStatus()).isEqualTo(Status.DOWNLOADED);
    assertThat(currentFileGroup.getFile(0).getFileUri()).isNotEmpty();

    // Use fake file backend to invoke a failure when importing another file
    fakeFileBackend.setFailure(OperationType.WRITE_STREAM, new IOException("test failure"));

    // Assert that importFiles fails due to failure importing file
    ExecutionException ex =
        assertThrows(
            ExecutionException.class,
            () ->
                mobileDataDownload
                    .importFiles(
                        ImportFilesRequest.newBuilder()
                            .setGroupName(FILE_GROUP_NAME)
                            .setBuildId(initialFileGroup.getBuildId())
                            .setVariantId(initialFileGroup.getVariantId())
                            .setUpdatedDataFileList(ImmutableList.of(INLINE_DATA_FILE_2))
                            .setInlineFileMap(ImmutableMap.of(FILE_ID_2, inlineFileSource2))
                            .build())
                    .get());
    assertThat(ex).hasCauseThat().isInstanceOf(AggregateException.class);
    AggregateException aex = (AggregateException) ex.getCause();
    assertThat(aex.getFailures()).hasSize(1);
    assertThat(aex.getFailures().get(0)).isInstanceOf(DownloadException.class);
    DownloadException dex = (DownloadException) aex.getFailures().get(0);
    assertThat(dex.getDownloadResultCode()).isEqualTo(DownloadResultCode.INLINE_FILE_IO_ERROR);

    // Get the file group again after the second import fails
    currentFileGroup =
        mobileDataDownload
            .getFileGroup(GetFileGroupRequest.newBuilder().setGroupName(FILE_GROUP_NAME).build())
            .get();

    // Assert that file group remains unchanged (no metadata change)
    assertThat(currentFileGroup).isNotNull();
    assertThat(currentFileGroup.getGroupName()).isEqualTo(FILE_GROUP_NAME);
    assertThat(currentFileGroup.getFileCount()).isEqualTo(1);
    assertThat(currentFileGroup.getStatus()).isEqualTo(Status.DOWNLOADED);
    assertThat(currentFileGroup.getFile(0).getFileUri()).isNotEmpty();
  }

  @Test
  public void importFiles_supportsDedup() throws Exception {
    // Use BlockingFileDownloader to block the import of a file indefinitely. This is used to ensure
    // a file import is in-progress before starting another import
    AtomicInteger fileDownloaderInvocationCount = new AtomicInteger(0);
    BlockingFileDownloader blockingFileDownloader =
        new BlockingFileDownloader(
            MoreExecutors.listeningDecorator(DOWNLOAD_EXECUTOR),
            new FileDownloader() {
              @Override
              public ListenableFuture<Void> startDownloading(DownloadRequest request) {
                fileDownloaderInvocationCount.addAndGet(1);
                return multiSchemeFileDownloaderSupplier.get().startDownloading(request);
              }
            });

    createMobileDataDownload(() -> blockingFileDownloader);

    DataFileGroup fileGroup1WithInlineFile =
        DataFileGroup.newBuilder()
            .setGroupName(FILE_GROUP_NAME)
            .addFile(INLINE_DATA_FILE_1)
            .build();

    DataFileGroup fileGroup2WithInlineFile =
        DataFileGroup.newBuilder()
            .setGroupName(FILE_GROUP_NAME + "2")
            .addFile(INLINE_DATA_FILE_1)
            .build();

    // Ensure that we add the file groups successfully
    assertThat(
            mobileDataDownload
                .addFileGroup(
                    AddFileGroupRequest.newBuilder()
                        .setDataFileGroup(fileGroup1WithInlineFile)
                        .build())
                .get())
        .isTrue();
    assertThat(
            mobileDataDownload
                .addFileGroup(
                    AddFileGroupRequest.newBuilder()
                        .setDataFileGroup(fileGroup2WithInlineFile)
                        .build())
                .get())
        .isTrue();

    // Start the first import and keep it in progress
    ListenableFuture<Void> importFilesFuture1 =
        mobileDataDownload.importFiles(
            ImportFilesRequest.newBuilder()
                .setGroupName(FILE_GROUP_NAME)
                .setBuildId(fileGroup1WithInlineFile.getBuildId())
                .setVariantId(fileGroup1WithInlineFile.getVariantId())
                .setInlineFileMap(ImmutableMap.of(FILE_ID_1, inlineFileSource1))
                .build());

    blockingFileDownloader.waitForDownloadStarted();

    // Start the second import after the first is already in-progress
    ListenableFuture<Void> importFilesFuture2 =
        mobileDataDownload.importFiles(
            ImportFilesRequest.newBuilder()
                .setGroupName(FILE_GROUP_NAME + "2")
                .setBuildId(fileGroup2WithInlineFile.getBuildId())
                .setVariantId(fileGroup2WithInlineFile.getVariantId())
                .setInlineFileMap(ImmutableMap.of(FILE_ID_1, inlineFileSource1))
                .build());

    // Allow the download to continue and trigger our delegate FileDownloader. If the future isn't
    // cancelled, the onSuccess callback should fail the test.
    blockingFileDownloader.finishDownloading();
    blockingFileDownloader.waitForDownloadCompleted();

    // wait for importFilesFuture2 to complete, check that importFiles1 is also complete
    importFilesFuture2.get();
    assertThat(importFilesFuture1.isDone()).isTrue();

    // Ensure that file downloader was only invoked once
    assertThat(fileDownloaderInvocationCount.get()).isEqualTo(1);

    mobileDataDownload.clear().get();
  }

  @Test
  public void importFiles_supportsCancellation() throws Exception {
    // Use BlockingFileDownloader to block the import of a file indefinitely. Check that the future
    // returned by importFiles fails with a cancellation exception
    BlockingFileDownloader blockingFileDownloader =
        new BlockingFileDownloader(
            MoreExecutors.listeningDecorator(DOWNLOAD_EXECUTOR),
            new FileDownloader() {
              @Override
              public ListenableFuture<Void> startDownloading(DownloadRequest downloadRequest) {
                ListenableFuture<Void> importTaskFuture = Futures.immediateVoidFuture();
                Futures.addCallback(
                    importTaskFuture,
                    new FutureCallback<Void>() {
                      @Override
                      public void onSuccess(Void result) {
                        // Should not get here since we will cancel the future.
                        fail();
                      }

                      @Override
                      public void onFailure(Throwable t) {
                        // Even though importTaskFuture was just created, this method should be
                        // invoked in the future chain that gets cancelled -- Ensure that the
                        // cancellation propagates to this future.
                        assertThat(importTaskFuture.isCancelled()).isTrue();
                      }
                    },
                    DOWNLOAD_EXECUTOR);
                return importTaskFuture;
              }
            });

    createMobileDataDownload(() -> blockingFileDownloader);

    DataFileGroup fileGroupWithInlineFile =
        DataFileGroup.newBuilder()
            .setGroupName(FILE_GROUP_NAME)
            .addFile(INLINE_DATA_FILE_1)
            .build();

    // Ensure that we add the file group successfully
    assertThat(
            mobileDataDownload
                .addFileGroup(
                    AddFileGroupRequest.newBuilder()
                        .setDataFileGroup(fileGroupWithInlineFile)
                        .build())
                .get())
        .isTrue();

    // Perform the import
    ListenableFuture<Void> importFilesFuture =
        mobileDataDownload.importFiles(
            ImportFilesRequest.newBuilder()
                .setGroupName(FILE_GROUP_NAME)
                .setBuildId(fileGroupWithInlineFile.getBuildId())
                .setVariantId(fileGroupWithInlineFile.getVariantId())
                .setInlineFileMap(ImmutableMap.of(FILE_ID_1, inlineFileSource1))
                .build());

    // Note: We could have a race condition when we call cancel() on the future, since the
    // FileDownloader's startDownloading() may not have been invoked yet. To prevent this, we first
    // wait for the file downloader to be invoked before performing the cancel.
    blockingFileDownloader.waitForDownloadStarted();

    importFilesFuture.cancel(/* mayInterruptIfRunning = */ true);

    // Allow the download to continue and trigger our delegate FileDownloader. If the future isn't
    // cancelled, the onSuccess callback should fail the test.
    blockingFileDownloader.finishDownloading();
    blockingFileDownloader.waitForDownloadCompleted();

    assertThat(importFilesFuture.isCancelled()).isTrue();

    mobileDataDownload.clear().get();
  }

  private void createMobileDataDownload(Supplier<FileDownloader> fileDownloaderSupplier) {
    mobileDataDownload =
        MobileDataDownloadBuilder.newBuilder()
            .setContext(context)
            .setControlExecutor(CONTROL_EXECUTOR)
            .setFileDownloaderSupplier(fileDownloaderSupplier)
            .setTaskScheduler(Optional.of(mockTaskScheduler))
            .setDeltaDecoderOptional(Optional.absent())
            .setFileStorage(fileStorage)
            .setNetworkUsageMonitor(mockNetworkUsageMonitor)
            .setDownloadMonitorOptional(Optional.of(mockDownloadProgressMonitor))
            .setFlagsOptional(Optional.of(flags))
            .build();
  }
}