File: multipart_uploader_unittest.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 (492 lines) | stat: -rw-r--r-- 19,263 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
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
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/390223051): Remove C-library calls to fix the errors.
#pragma allow_unsafe_libc_calls
#endif

#include "chrome/browser/safe_browsing/cloud_content_scanning/multipart_uploader.h"

#include <memory>

#include "base/containers/span.h"
#include "base/files/file_path.h"
#include "base/files/scoped_temp_dir.h"
#include "base/functional/callback_helpers.h"
#include "base/memory/read_only_shared_memory_region.h"
#include "base/memory/scoped_refptr.h"
#include "base/run_loop.h"
#include "base/test/bind.h"
#include "base/test/gmock_callback_support.h"
#include "base/test/metrics/histogram_tester.h"
#include "chrome/browser/enterprise/connectors/test/uploader_test_utils.h"
#include "components/file_access/test/mock_scoped_file_access_delegate.h"
#include "content/public/test/browser_task_environment.h"
#include "net/base/net_errors.h"
#include "net/http/http_status_code.h"
#include "net/traffic_annotation/network_traffic_annotation_test_helper.h"
#include "services/network/public/cpp/resource_request.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
#include "services/network/public/cpp/weak_wrapper_shared_url_loader_factory.h"
#include "services/network/test/test_url_loader_factory.h"
#include "services/network/test/test_utils.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace safe_browsing {

using ::testing::_;
using ::testing::Invoke;

class MultipartUploadRequestTest : public testing::Test {
 public:
  MultipartUploadRequestTest()
      : task_environment_(base::test::TaskEnvironment::TimeSource::MOCK_TIME) {}

  void SetUp() override {
    testing::Test::SetUp();

    test_shared_loader_factory_ =
        base::MakeRefCounted<network::WeakWrapperSharedURLLoaderFactory>(
            &test_url_loader_factory_);
  }

  base::FilePath CreateFile(const std::string& file_name,
                            const std::string& content) {
    if (!temp_dir_.IsValid())
      EXPECT_TRUE(temp_dir_.CreateUniqueTempDir());

    base::FilePath path = temp_dir_.GetPath().AppendASCII(file_name);
    base::File file(path, base::File::FLAG_CREATE_ALWAYS |
                              base::File::FLAG_READ | base::File::FLAG_WRITE);
    file.WriteAtCurrentPos(base::as_byte_span(content));
    return path;
  }

  base::ReadOnlySharedMemoryRegion CreatePage(const std::string& content) {
    base::MappedReadOnlyRegion region =
        base::ReadOnlySharedMemoryRegion::Create(content.size());
    EXPECT_TRUE(region.IsValid());
    std::memcpy(region.mapping.memory(), content.data(), content.size());
    return std::move(region.region);
  }

 protected:
  content::BrowserTaskEnvironment task_environment_;
  network::TestURLLoaderFactory test_url_loader_factory_;
  scoped_refptr<network::SharedURLLoaderFactory> test_shared_loader_factory_;
  base::ScopedTempDir temp_dir_;
};

class MockMultipartUploadRequest : public MultipartUploadRequest {
 public:
  MockMultipartUploadRequest()
      : MultipartUploadRequest(nullptr,
                               GURL(),
                               "",
                               "",
                               "",
                               TRAFFIC_ANNOTATION_FOR_TESTS,
                               base::DoNothing()) {}

  MOCK_METHOD0(SendRequest, void());
};

class MockMultipartUploadDataPipeRequest : public MultipartUploadRequest {
 public:
  MockMultipartUploadDataPipeRequest(const base::FilePath& path,
                                     MultipartUploadRequest::Callback callback)
      : MultipartUploadRequest(nullptr,
                               GURL(),
                               "metadata",
                               path,
                               123,
                               false,
                               "histogram_suffix",
                               TRAFFIC_ANNOTATION_FOR_TESTS,
                               std::move(callback)) {}

  MockMultipartUploadDataPipeRequest(
      base::ReadOnlySharedMemoryRegion page_region,
      MultipartUploadRequest::Callback callback)
      : MultipartUploadRequest(nullptr,
                               GURL(),
                               "metadata",
                               std::move(page_region),
                               "histogram_suffix",
                               TRAFFIC_ANNOTATION_FOR_TESTS,
                               std::move(callback)) {}

  MOCK_METHOD1(CompleteSendRequest,
               void(std::unique_ptr<network::ResourceRequest> request));
};

TEST_F(MultipartUploadRequestTest, GeneratesCorrectBody) {
  auto connector_request = MultipartUploadRequest::CreateStringRequest(
      nullptr, GURL(), "metadata", "data", "histogram_suffix",
      TRAFFIC_ANNOTATION_FOR_TESTS, base::DoNothing());
  auto* request = static_cast<MultipartUploadRequest*>(connector_request.get());

  std::string expected_body =
      "--boundary\r\n"
      "Content-Type: application/octet-stream\r\n"
      "\r\n"
      "metadata\r\n"
      "--boundary\r\n"
      "Content-Type: application/octet-stream\r\n"
      "\r\n"
      "file data\r\n"
      "--boundary--\r\n";

  request->set_boundary("boundary");
  EXPECT_EQ(request->GenerateRequestBody("metadata", "file data"),
            expected_body);
}

TEST_F(MultipartUploadRequestTest, RetriesCorrectly) {
  {
    MockMultipartUploadRequest mock_request;

    EXPECT_CALL(mock_request, SendRequest())
        .Times(1)
        .WillRepeatedly(Invoke([&mock_request]() {
          mock_request.RetryOrFinish(net::OK, net::HTTP_BAD_REQUEST,
                                     "response");
        }));
    mock_request.Start();
    task_environment_.FastForwardUntilNoTasksRemain();
  }
  {
    MockMultipartUploadRequest mock_request;

    EXPECT_CALL(mock_request, SendRequest())
        .Times(3)
        .WillRepeatedly(Invoke([&mock_request]() {
          mock_request.RetryOrFinish(net::OK, net::HTTP_SERVICE_UNAVAILABLE,
                                     "response");
        }));
    mock_request.Start();
    task_environment_.FastForwardUntilNoTasksRemain();
  }
}

class MultipartUploadDataPipeRequestTest
    : public MultipartUploadRequestTest,
      public testing::WithParamInterface<bool> {
 public:
  bool is_file_request() { return GetParam(); }

  std::unique_ptr<MockMultipartUploadDataPipeRequest> CreateRequest(
      const std::string& content,
      base::OnceCallback<void(bool success,
                              int http_status,
                              const std::string& response_data)> callback) {
    if (is_file_request()) {
      return std::make_unique<MockMultipartUploadDataPipeRequest>(
          CreateFile("text.txt", content), std::move(callback));
    } else {
      return std::make_unique<MockMultipartUploadDataPipeRequest>(
          CreatePage(content), std::move(callback));
    }
  }
};

INSTANTIATE_TEST_SUITE_P(, MultipartUploadDataPipeRequestTest, testing::Bool());

// Disabled due to flakiness on Windows https://crbug.com/1286638
#if BUILDFLAG(IS_WIN)
#define MAYBE_Retries DISABLED_Retries
#else
#define MAYBE_Retries Retries
#endif
TEST_P(MultipartUploadDataPipeRequestTest, MAYBE_Retries) {
  std::string expected_body =
      "--boundary\r\n"
      "Content-Type: application/octet-stream\r\n"
      "\r\n"
      "metadata\r\n"
      "--boundary\r\n"
      "Content-Type: application/octet-stream\r\n"
      "\r\n"
      "file content\r\n"
      "--boundary--\r\n";
  {
    base::RunLoop run_loop;
    std::unique_ptr<MockMultipartUploadDataPipeRequest> mock_request =
        CreateRequest("file content",
                      base::BindLambdaForTesting(
                          [&run_loop](bool success, int http_status,
                                      const std::string& response_data) {
                            EXPECT_TRUE(success);
                            EXPECT_EQ(net::HTTP_OK, http_status);
                            EXPECT_EQ("response", response_data);
                            run_loop.Quit();
                          }));
    mock_request->set_boundary("boundary");

    EXPECT_CALL(*mock_request, CompleteSendRequest(_))
        .WillOnce([&mock_request, &expected_body](
                      std::unique_ptr<network::ResourceRequest> request) {
          EXPECT_EQ(expected_body,
                    enterprise_connectors::test::GetBodyFromFileOrPageRequest(
                        mock_request->data_pipe_getter_for_testing()));
          mock_request->RetryOrFinish(net::OK, net::HTTP_OK, "response");
          mock_request->MarkScanAsCompleteForTesting();
        });
    mock_request->Start();
    task_environment_.FastForwardUntilNoTasksRemain();
    run_loop.Run();
    EXPECT_EQ(mock_request->GetUploadInfo(), "Multipart - Complete");
  }
  {
    int retry_count = 0;
    base::RunLoop run_loop;
    std::unique_ptr<MockMultipartUploadDataPipeRequest> mock_request =
        CreateRequest(
            "file content",
            base::BindLambdaForTesting(
                [&run_loop, &retry_count](bool success, int http_status,
                                          const std::string& response_data) {
                  EXPECT_TRUE(success);
                  EXPECT_EQ(net::HTTP_OK, http_status);
                  EXPECT_EQ("response", response_data);
                  EXPECT_EQ(3, retry_count);
                  run_loop.Quit();
                }));
    mock_request->set_boundary("boundary");

    EXPECT_CALL(*mock_request, CompleteSendRequest(_))
        .Times(3)
        .WillRepeatedly([&mock_request, &expected_body, &retry_count](
                            std::unique_ptr<network::ResourceRequest> request) {
          // Every call to CompleteSendRequest should be able to get the
          // same body from the request's data pipe getter.
          EXPECT_EQ(expected_body,
                    enterprise_connectors::test::GetBodyFromFileOrPageRequest(
                        mock_request->data_pipe_getter_for_testing()));

          ++retry_count;
          mock_request->RetryOrFinish(
              net::OK,
              retry_count < 3 ? net::HTTP_SERVICE_UNAVAILABLE : net::HTTP_OK,
              "response");
          if (retry_count == 3) {
            mock_request->MarkScanAsCompleteForTesting();
          }
        });
    mock_request->Start();
    task_environment_.FastForwardUntilNoTasksRemain();
    run_loop.Run();
    EXPECT_EQ(mock_request->GetUploadInfo(), "Multipart - Complete");
  }
}

TEST_P(MultipartUploadDataPipeRequestTest, DataControls) {
  std::string expected_body =
      "--boundary\r\n"
      "Content-Type: application/octet-stream\r\n"
      "\r\n"
      "metadata\r\n"
      "--boundary\r\n"
      "Content-Type: application/octet-stream\r\n"
      "\r\n"
      "file content\r\n"
      "--boundary--\r\n";
  file_access::MockScopedFileAccessDelegate scoped_files_access_delegate;

  if (is_file_request()) {
    EXPECT_CALL(scoped_files_access_delegate, RequestFilesAccessForSystem)
        .WillOnce(base::test::RunOnceCallback<1>(
            file_access::ScopedFileAccess::Allowed()));
  } else {
    EXPECT_CALL(scoped_files_access_delegate, RequestFilesAccessForSystem)
        .Times(0);
  }

  base::RunLoop run_loop;
  std::unique_ptr<MockMultipartUploadDataPipeRequest> mock_request =
      CreateRequest("file content",
                    base::BindLambdaForTesting(
                        [&run_loop](bool success, int http_status,
                                    const std::string& response_data) {
                          EXPECT_TRUE(success);
                          EXPECT_EQ(net::HTTP_OK, http_status);
                          EXPECT_EQ("response", response_data);
                          run_loop.Quit();
                        }));
  mock_request->set_boundary("boundary");

  EXPECT_CALL(*mock_request, CompleteSendRequest(_))
      .WillOnce([&mock_request, &expected_body](
                    std::unique_ptr<network::ResourceRequest> request) {
        EXPECT_EQ(expected_body,
                  enterprise_connectors::test::GetBodyFromFileOrPageRequest(
                      mock_request->data_pipe_getter_for_testing()));
        mock_request->RetryOrFinish(net::OK, net::HTTP_OK, "response");
        mock_request->MarkScanAsCompleteForTesting();
      });
  mock_request->Start();
  task_environment_.FastForwardUntilNoTasksRemain();
  run_loop.Run();
  EXPECT_EQ(mock_request->GetUploadInfo(), "Multipart - Complete");
}

TEST_P(MultipartUploadDataPipeRequestTest, EquivalentToStringRequest) {
  // The request body should be identical when obtained through a string request
  // and a data pipe request with equivalent content.
  std::unique_ptr<MockMultipartUploadDataPipeRequest> data_pipe_request =
      CreateRequest("data", base::DoNothing());
  data_pipe_request->set_boundary("boundary");

  // Start the data pipe request to initialize the internal data pipe getter.
  ASSERT_FALSE(data_pipe_request->data_pipe_getter_for_testing());
  EXPECT_CALL(*data_pipe_request, CompleteSendRequest(_)).Times(1);
  data_pipe_request->Start();
  task_environment_.FastForwardUntilNoTasksRemain();
  ASSERT_TRUE(data_pipe_request->data_pipe_getter_for_testing());

  MockMultipartUploadRequest string_request;
  string_request.set_boundary("boundary");

  std::string expected_body =
      "--boundary\r\n"
      "Content-Type: application/octet-stream\r\n"
      "\r\n"
      "metadata\r\n"
      "--boundary\r\n"
      "Content-Type: application/octet-stream\r\n"
      "\r\n"
      "data\r\n"
      "--boundary--\r\n";

  EXPECT_EQ(expected_body,
            string_request.GenerateRequestBody("metadata", "data"));
  EXPECT_EQ(expected_body,
            enterprise_connectors::test::GetBodyFromFileOrPageRequest(
                data_pipe_request->data_pipe_getter_for_testing()));
}

TEST_F(MultipartUploadRequestTest, GeneratesCorrectHeaders_StringRequest) {
  network::ResourceRequest resource_request;

  auto connector_request = MultipartUploadRequest::CreateStringRequest(
      nullptr, GURL(), "metadata", "data", "histogram_suffix",
      TRAFFIC_ANNOTATION_FOR_TESTS, base::DoNothing());
  auto* request = static_cast<MultipartUploadRequest*>(connector_request.get());

  request->SetRequestHeaders(&resource_request);
  ASSERT_TRUE(resource_request.headers.HasHeader("X-Goog-Upload-Protocol"));
  ASSERT_THAT(resource_request.headers.GetHeader("X-Goog-Upload-Protocol"),
              testing::Optional(std::string("multipart")));
  ASSERT_TRUE(resource_request.headers.HasHeader(
      "X-Goog-Upload-Header-Content-Length"));
  ASSERT_THAT(
      resource_request.headers.GetHeader("X-Goog-Upload-Header-Content-Length"),
      testing::Optional(std::string("4")));
  EXPECT_EQ(request->GetUploadInfo(), "Multipart - Pending");
}

TEST_F(MultipartUploadRequestTest, GeneratesCorrectHeaders_FileRequest) {
  network::ResourceRequest resource_request;

  auto connector_request = MultipartUploadRequest::CreateFileRequest(
      nullptr, GURL(), "metadata", CreateFile("my_file_name.foo", "file_data"),
      9, false, "histogram_suffix", TRAFFIC_ANNOTATION_FOR_TESTS,
      base::DoNothing());
  auto* request = static_cast<MultipartUploadRequest*>(connector_request.get());

  request->SetRequestHeaders(&resource_request);
  ASSERT_TRUE(resource_request.headers.HasHeader("X-Goog-Upload-Protocol"));
  ASSERT_THAT(resource_request.headers.GetHeader("X-Goog-Upload-Protocol"),
              testing::Optional(std::string("multipart")));
  ASSERT_TRUE(resource_request.headers.HasHeader(
      "X-Goog-Upload-Header-Content-Length"));
  ASSERT_THAT(
      resource_request.headers.GetHeader("X-Goog-Upload-Header-Content-Length"),
      testing::Optional(std::string("9")));
  EXPECT_EQ(request->GetUploadInfo(), "Multipart - Pending");
}

TEST_F(MultipartUploadRequestTest, GeneratesCorrectHeaders_PageRequest) {
  network::ResourceRequest resource_request;

  auto connector_request = MultipartUploadRequest::CreatePageRequest(
      nullptr, GURL(), "metadata", CreatePage("print_data"), "histogram_suffix",
      TRAFFIC_ANNOTATION_FOR_TESTS, base::DoNothing());
  auto* request = static_cast<MultipartUploadRequest*>(connector_request.get());

  request->SetRequestHeaders(&resource_request);
  ASSERT_TRUE(resource_request.headers.HasHeader("X-Goog-Upload-Protocol"));
  ASSERT_THAT(resource_request.headers.GetHeader("X-Goog-Upload-Protocol"),
              testing::Optional(std::string("multipart")));
  ASSERT_TRUE(resource_request.headers.HasHeader(
      "X-Goog-Upload-Header-Content-Length"));
  ASSERT_THAT(
      resource_request.headers.GetHeader("X-Goog-Upload-Header-Content-Length"),
      testing::Optional(std::string("10")));
  EXPECT_EQ(request->GetUploadInfo(), "Multipart - Pending");
}

TEST_F(MultipartUploadRequestTest, StringRequest_Failure) {
  base::HistogramTester histogram_tester;
  auto dummy_upload_url = GURL("https://google.com");

  base::RunLoop run_loop;
  auto callback =
      base::BindLambdaForTesting([&run_loop](bool success, int http_status,
                                             const std::string& response_data) {
        EXPECT_FALSE(success);
        run_loop.Quit();
      });

  test_url_loader_factory_.AddResponse(
      dummy_upload_url, network::CreateURLResponseHead(net::HTTP_UNAUTHORIZED),
      "", network::URLLoaderCompletionStatus(net::OK));

  auto connector_request = MultipartUploadRequest::CreateStringRequest(
      test_shared_loader_factory_, dummy_upload_url, "metadata", "data",
      "DummySuffix", TRAFFIC_ANNOTATION_FOR_TESTS, std::move(callback));
  auto* request = static_cast<MultipartUploadRequest*>(connector_request.get());

  request->Start();
  run_loop.Run();

  histogram_tester.ExpectUniqueSample(
      /*name=*/"SafeBrowsing.MultipartUploader.NetworkResult.DummySuffix",
      /*sample=*/net::HTTP_UNAUTHORIZED,
      /*expected_bucket_count=*/1);
}

TEST_F(MultipartUploadRequestTest, StringRequest_Success) {
  base::HistogramTester histogram_tester;
  auto dummy_upload_url = GURL("https://google.com");

  base::RunLoop run_loop;
  auto callback =
      base::BindLambdaForTesting([&run_loop](bool success, int http_status,
                                             const std::string& response_data) {
        EXPECT_TRUE(success);
        run_loop.Quit();
      });

  test_url_loader_factory_.AddResponse(
      dummy_upload_url, network::CreateURLResponseHead(net::HTTP_OK), "",
      network::URLLoaderCompletionStatus(net::OK));

  auto connector_request = MultipartUploadRequest::CreateStringRequest(
      test_shared_loader_factory_, dummy_upload_url, "metadata", "data",
      "DummySuffix", TRAFFIC_ANNOTATION_FOR_TESTS, std::move(callback));
  auto* request = static_cast<MultipartUploadRequest*>(connector_request.get());

  request->Start();
  run_loop.Run();

  histogram_tester.ExpectUniqueSample(
      /*name=*/"SafeBrowsing.MultipartUploader.NetworkResult.DummySuffix",
      /*sample=*/net::HTTP_OK,
      /*expected_bucket_count=*/1);
}

}  // namespace safe_browsing