File: drive_skyvault_uploader_browsertest.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (422 lines) | stat: -rw-r--r-- 16,322 bytes parent folder | download | duplicates (6)
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
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/ash/policy/skyvault/drive_skyvault_uploader.h"

#include <memory>
#include <optional>

#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/functional/bind.h"
#include "base/test/bind.h"
#include "base/test/gmock_callback_support.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/test_future.h"
#include "base/threading/thread_restrictions.h"
#include "chrome/browser/ash/file_manager/io_task.h"
#include "chrome/browser/ash/policy/skyvault/local_files_migration_constants.h"
#include "chrome/browser/ash/policy/skyvault/policy_utils.h"
#include "chrome/browser/ash/policy/skyvault/test/skyvault_test_base.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/test/base/in_process_browser_test.h"
#include "chromeos/ash/components/drivefs/mojom/drivefs.mojom.h"
#include "components/drive/file_errors.h"
#include "content/public/test/browser_test.h"
#include "storage/browser/file_system/file_system_url.h"
#include "testing/gmock/include/gmock/gmock.h"

using storage::FileSystemURL;

namespace policy::local_user_files {

using ::base::test::RunOnceCallback;
using testing::_;

// Tests the Drive SkyVault upload workflow.
class DriveSkyvaultUploaderTest : public SkyvaultGoogleDriveTest {
 public:
  DriveSkyvaultUploaderTest() = default;

  DriveSkyvaultUploaderTest(const DriveSkyvaultUploaderTest&) = delete;
  DriveSkyvaultUploaderTest& operator=(const DriveSkyvaultUploaderTest&) =
      delete;

  // `Wait` will not complete until this is called.
  void OnUploadDone(std::optional<MigrationUploadError> error) {
    if (fail_sync_) {
      ASSERT_EQ(error, MigrationUploadError::kSyncFailed);
    } else {
      ASSERT_FALSE(error.has_value());
    }
    EndWait();
  }

  base::FilePath observed_relative_drive_path(const FileInfo& info) override {
    base::FilePath observed_relative_drive_path;
    drive_integration_service()->GetRelativeDrivePath(
        drive_root_dir()
            .Append(kUploadRootPrefix)
            .Append(info.local_relative_path_),
        &observed_relative_drive_path);
    return observed_relative_drive_path;
  }

 protected:
  base::HistogramTester histogram_tester_;
  bool add_metadata_ = true;
  bool fail_sync_ = false;
  // Overrides `fail_sync_`
  base::RepeatingClosure on_transfer_complete_callback_;
  // Called when the copy task is starting/ongoing
  base::RepeatingClosure on_copy_in_progress_callback_;

 private:
  // IOTaskController::Observer:
  void OnIOTaskStatus(
      const file_manager::io_task::ProgressStatus& status) override {
    auto it = source_files_.find(status.sources[0].url.path());
    if (status.type != file_manager::io_task::OperationType::kCopy ||
        status.sources.size() != 1 || it == source_files_.end()) {
      return;
    }

    // Invoke in progress callback if needed.
    if (status.state == file_manager::io_task::State::kQueued ||
        status.state == file_manager::io_task::State::kInProgress) {
      if (on_copy_in_progress_callback_) {
        on_copy_in_progress_callback_.Run();
        // The callback might stop the IOTask, which would invalidate the status
        // reference.
        base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
            FROM_HERE, std::move(on_copy_in_progress_callback_));
        return;
      }
    }
    // Wait for the copy task to complete before starting the Drive sync.
    if (status.state == file_manager::io_task::State::kSuccess) {
      if (on_transfer_complete_callback_) {
        on_transfer_complete_callback_.Run();
      } else if (fail_sync_) {
        SimulateDriveUploadFailure(it->second);
      } else {
        SimulateDriveUploadCompleted(it->second);
      }
    }
  }

  // Simulates the upload of the file to Drive by sending a series of fake
  // signals to the DriveFs delegate.
  void SimulateDriveUploadCompleted(const FileInfo& info) {
    if (add_metadata_) {
      // Set file metadata for `drivefs::mojom::DriveFs::GetMetadata`.
      drivefs::FakeMetadata metadata;
      metadata.path = observed_relative_drive_path(info);
      metadata.mime_type =
          "application/"
          "vnd.openxmlformats-officedocument.wordprocessingml.document";
      metadata.original_name = info.test_file_name_;
      metadata.alternate_url =
          "https://docs.google.com/document/d/"
          "smalldocxid?rtpof=true&usp=drive_fs";
      fake_drivefs().SetMetadata(std::move(metadata));
    }
    // Simulate server sync events.
    drivefs::mojom::SyncingStatusPtr status =
        drivefs::mojom::SyncingStatus::New();
    status->item_events.emplace_back(
        std::in_place, 12, 34, observed_relative_drive_path(info).value(),
        drivefs::mojom::ItemEvent::State::kQueued, 123, 456,
        drivefs::mojom::ItemEventReason::kTransfer);
    drivefs_delegate()->OnSyncingStatusUpdate(status.Clone());
    drivefs_delegate().FlushForTesting();

    status = drivefs::mojom::SyncingStatus::New();
    status->item_events.emplace_back(
        std::in_place, 12, 34, observed_relative_drive_path(info).value(),
        drivefs::mojom::ItemEvent::State::kCompleted, 123, 456,
        drivefs::mojom::ItemEventReason::kTransfer);
    drivefs_delegate()->OnSyncingStatusUpdate(status.Clone());
    drivefs_delegate().FlushForTesting();
  }

  void SimulateDriveUploadFailure(const FileInfo& info) {
    // Simulate server sync events.
    drivefs::mojom::SyncingStatusPtr status =
        drivefs::mojom::SyncingStatus::New();
    status->item_events.emplace_back(
        std::in_place, 12, 34, observed_relative_drive_path(info).value(),
        drivefs::mojom::ItemEvent::State::kQueued, 123, 456,
        drivefs::mojom::ItemEventReason::kTransfer);
    drivefs_delegate()->OnSyncingStatusUpdate(status.Clone());
    drivefs_delegate().FlushForTesting();

    drivefs::mojom::SyncingStatusPtr fail_status =
        drivefs::mojom::SyncingStatus::New();
    fail_status->item_events.emplace_back(
        std::in_place, 12, 34, observed_relative_drive_path(info).value(),
        drivefs::mojom::ItemEvent::State::kFailed, 123, 456,
        drivefs::mojom::ItemEventReason::kTransfer);
    drivefs_delegate()->OnSyncingStatusUpdate(fail_status->Clone());
    drivefs_delegate().FlushForTesting();
  }
};

IN_PROC_BROWSER_TEST_F(DriveSkyvaultUploaderTest, SuccessfulUpload) {
  SetUpObservers();
  SetUpMyFiles();

  const std::string test_file_name = "text.docx";
  const std::string test_dir_name = "foo";
  const base::FilePath dir_path = CreateTestDir(test_dir_name, my_files_dir());
  const base::FilePath source_file =
      SetUpSourceFile(test_file_name, my_files_dir());

  EXPECT_CALL(fake_drivefs(), ImmediatelyUpload)
      .WillOnce(RunOnceCallback<1>(drive::FileError::FILE_ERROR_OK));

  base::test::TestFuture<std::optional<MigrationUploadError>, base::FilePath>
      future;
  auto drive_upload_handler = std::make_unique<DriveSkyvaultUploader>(
      profile(), source_file, base::FilePath(), kUploadRootPrefix,
      future.GetCallback());
  drive_upload_handler->Run();

  auto [error, upload_root_path] = future.Get();
  ASSERT_FALSE(error.has_value());
  EXPECT_EQ(drive_root_dir().Append(kUploadRootPrefix), upload_root_path);

  // Check that the source file has been moved to Drive.
  {
    base::ScopedAllowBlockingForTesting allow_blocking;
    EXPECT_FALSE(base::PathExists(source_file));
    CheckPathExistsOnDrive(
        observed_relative_drive_path(source_files_.find(source_file)->second));
  }

  histogram_tester_.ExpectBucketCount(
      "Enterprise.SkyVault.Migration.GoogleDrive.DeleteError", false, 1);
  histogram_tester_.ExpectBucketCount(
      "Enterprise.SkyVault.Migration.GoogleDrive.DeleteError", true, 0);
}

// Test that when the sync to Drive fails, the file is not moved to Drive.
IN_PROC_BROWSER_TEST_F(DriveSkyvaultUploaderTest, FailedUpload) {
  fail_sync_ = true;
  SetUpObservers();
  SetUpMyFiles();

  const std::string test_file_name = "text.docx";
  const base::FilePath source_file =
      SetUpSourceFile(test_file_name, my_files_dir());

  EXPECT_CALL(fake_drivefs(), ImmediatelyUpload)
      .WillOnce(RunOnceCallback<1>(drive::FileError::FILE_ERROR_FAILED));

  base::test::TestFuture<std::optional<MigrationUploadError>, base::FilePath>
      future;
  auto drive_upload_handler = std::make_unique<DriveSkyvaultUploader>(
      profile(), source_file, base::FilePath(), kUploadRootPrefix,
      future.GetCallback());
  drive_upload_handler->Run();

  auto [error, upload_root_path] = future.Get();
  ASSERT_EQ(MigrationUploadError::kSyncFailed, error);
  EXPECT_EQ(drive_root_dir().Append(kUploadRootPrefix), upload_root_path);

  // Check that the source file has not been moved to Drive.
  {
    base::ScopedAllowBlockingForTesting allow_blocking;
    EXPECT_TRUE(base::PathExists(my_files_dir().AppendASCII(test_file_name)));
    CheckPathNotFoundOnDrive(
        observed_relative_drive_path(source_files_.find(source_file)->second));
  }

  histogram_tester_.ExpectBucketCount(
      "Enterprise.SkyVault.Migration.GoogleDrive.DeleteError", false, 1);
  histogram_tester_.ExpectBucketCount(
      "Enterprise.SkyVault.Migration.GoogleDrive.DeleteError", true, 0);
}

IN_PROC_BROWSER_TEST_F(DriveSkyvaultUploaderTest, FailedDelete) {
  SetUpObservers();
  SetUpMyFiles();

  const std::string test_file_name = "text.docx";
  const base::FilePath source_file =
      SetUpSourceFile(test_file_name, my_files_dir());

  EXPECT_CALL(fake_drivefs(), ImmediatelyUpload)
      .WillOnce(RunOnceCallback<1>(drive::FileError::FILE_ERROR_OK));

  base::test::TestFuture<std::optional<MigrationUploadError>, base::FilePath>
      future;
  auto drive_upload_handler = std::make_unique<DriveSkyvaultUploader>(
      profile(), source_file, base::FilePath(), kUploadRootPrefix,
      future.GetCallback());
  drive_upload_handler->SetFailDeleteForTesting(/*fail=*/true);
  drive_upload_handler->Run();

  auto [error, upload_root_path] = future.Get();
  ASSERT_EQ(MigrationUploadError::kDeleteFailed, error);
  EXPECT_EQ(drive_root_dir().Append(kUploadRootPrefix), upload_root_path);

  // Check that the source file has been moved to Drive.
  {
    base::ScopedAllowBlockingForTesting allow_blocking;
    EXPECT_FALSE(base::PathExists(my_files_dir().AppendASCII(test_file_name)));
    CheckPathExistsOnDrive(
        observed_relative_drive_path(source_files_.find(source_file)->second));
  }

  histogram_tester_.ExpectBucketCount(
      "Enterprise.SkyVault.Migration.GoogleDrive.DeleteError", false, 0);
  histogram_tester_.ExpectBucketCount(
      "Enterprise.SkyVault.Migration.GoogleDrive.DeleteError", true, 1);
}

// Test that when connection to Drive isn't available, the upload waits for
// the connection and continue successfully.
IN_PROC_BROWSER_TEST_F(DriveSkyvaultUploaderTest, WaitingWhenNoConnection) {
  SetUpObservers();
  SetUpMyFiles();
  SetDriveConnectionStatusForTesting(ConnectionStatus::kNoNetwork);

  const std::string test_file_name = "text.docx";
  const base::FilePath source_file =
      SetUpSourceFile(test_file_name, my_files_dir());

  EXPECT_CALL(fake_drivefs(), ImmediatelyUpload)
      .WillOnce(RunOnceCallback<1>(drive::FileError::FILE_ERROR_OK));

  base::test::TestFuture<std::optional<MigrationUploadError>, base::FilePath>
      future;
  auto drive_upload_handler = std::make_unique<DriveSkyvaultUploader>(
      profile(), source_file, base::FilePath(), kUploadRootPrefix,
      future.GetCallback());
  drive_upload_handler->Run();

  EXPECT_FALSE(future.IsReady());
  SetDriveConnectionStatusForTesting(ConnectionStatus::kConnected);
  drive_integration_service()->OnNetworkChanged();

  auto [error, upload_root_path] = future.Get();
  ASSERT_FALSE(error.has_value());
  EXPECT_EQ(drive_root_dir().Append(kUploadRootPrefix), upload_root_path);

  // Check that the source file has been moved to Drive.
  {
    base::ScopedAllowBlockingForTesting allow_blocking;
    EXPECT_FALSE(base::PathExists(source_file));
    CheckPathExistsOnDrive(
        observed_relative_drive_path(source_files_.find(source_file)->second));
  }

  histogram_tester_.ExpectBucketCount(
      "Enterprise.SkyVault.Migration.GoogleDrive.DeleteError", false, 1);
  histogram_tester_.ExpectBucketCount(
      "Enterprise.SkyVault.Migration.GoogleDrive.DeleteError", true, 0);
}

// Test that when connection to Drive fails during upload, the file is not
// moved to Drive.
IN_PROC_BROWSER_TEST_F(DriveSkyvaultUploaderTest, ConnectionLostDuringUpload) {
  SetUpObservers();
  SetUpMyFiles();

  const std::string test_file_name = "text.docx";
  const base::FilePath source_file =
      SetUpSourceFile(test_file_name, my_files_dir());

  on_transfer_complete_callback_ = base::BindLambdaForTesting([this] {
    SetDriveConnectionStatusForTesting(ConnectionStatus::kNoNetwork);
    drive_integration_service()->OnNetworkChanged();
  });

  base::test::TestFuture<std::optional<MigrationUploadError>, base::FilePath>
      future;
  auto drive_upload_handler = std::make_unique<DriveSkyvaultUploader>(
      profile(), source_file, base::FilePath(), kUploadRootPrefix,
      future.GetCallback());
  drive_upload_handler->Run();

  auto [error, upload_root_path] = future.Get();
  ASSERT_EQ(MigrationUploadError::kNetworkError, error);
  EXPECT_EQ(drive_root_dir().Append(kUploadRootPrefix), upload_root_path);

  // Check that the source file has not been moved to Drive.
  {
    base::ScopedAllowBlockingForTesting allow_blocking;
    EXPECT_TRUE(base::PathExists(my_files_dir().AppendASCII(test_file_name)));
    CheckPathNotFoundOnDrive(
        observed_relative_drive_path(source_files_.find(source_file)->second));
  }
}

// Test that the upload can be cancelled after Run.
IN_PROC_BROWSER_TEST_F(DriveSkyvaultUploaderTest, Cancel) {
  SetUpObservers();
  SetUpMyFiles();

  const std::string test_file_name = "text.docx";
  const base::FilePath source_file =
      SetUpSourceFile(test_file_name, my_files_dir());

  base::test::TestFuture<std::optional<MigrationUploadError>, base::FilePath>
      future;
  auto drive_upload_handler = std::make_unique<DriveSkyvaultUploader>(
      profile(), source_file, base::FilePath(), kUploadRootPrefix,
      future.GetCallback());
  drive_upload_handler->Run();
  drive_upload_handler->Cancel();

  auto [error, upload_root_path] = future.Get();
  ASSERT_EQ(MigrationUploadError::kCancelled, error);
  EXPECT_EQ(drive_root_dir().Append(kUploadRootPrefix), upload_root_path);

  // Check that the source file has not been moved to Drive.
  {
    base::ScopedAllowBlockingForTesting allow_blocking;
    EXPECT_TRUE(base::PathExists(my_files_dir().AppendASCII(test_file_name)));
    CheckPathNotFoundOnDrive(
        observed_relative_drive_path(source_files_.find(source_file)->second));
  }
}

// Test that the upload can be cancelled after the copy task already started.
IN_PROC_BROWSER_TEST_F(DriveSkyvaultUploaderTest, CancelAfterCopyStarts) {
  SetUpObservers();
  SetUpMyFiles();

  const std::string test_file_name = "text.docx";
  const base::FilePath source_file =
      SetUpSourceFile(test_file_name, my_files_dir());

  base::test::TestFuture<std::optional<MigrationUploadError>, base::FilePath>
      future;
  auto drive_upload_handler = std::make_unique<DriveSkyvaultUploader>(
      profile(), source_file, base::FilePath(), kUploadRootPrefix,
      future.GetCallback());

  on_copy_in_progress_callback_ = base::BindLambdaForTesting(
      [&drive_upload_handler] { drive_upload_handler->Cancel(); });

  drive_upload_handler->Run();

  auto [error, upload_root_path] = future.Get();
  ASSERT_EQ(MigrationUploadError::kCancelled, error);
  EXPECT_EQ(drive_root_dir().Append(kUploadRootPrefix), upload_root_path);

  // Check that the source file has not been deleted.
  {
    base::ScopedAllowBlockingForTesting allow_blocking;
    EXPECT_TRUE(base::PathExists(my_files_dir().AppendASCII(test_file_name)));
    CheckPathNotFoundOnDrive(
        observed_relative_drive_path(source_files_.find(source_file)->second));
  }
}

}  // namespace policy::local_user_files