blob: 613353dd8666a7da99a0fa13cce6c22f0fe28726 [file] [log] [blame]
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "net/url_request/url_request_file_job.h"
#include <memory>
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/logging.h"
#include "base/run_loop.h"
#include "base/strings/stringprintf.h"
#include "base/threading/sequenced_worker_pool.h"
#include "base/threading/thread_task_runner_handle.h"
#include "net/base/filename_util.h"
#include "net/url_request/url_request.h"
#include "net/url_request/url_request_test_util.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace net {
namespace {
// A URLRequestFileJob for testing values passed to OnSeekComplete and
// OnReadComplete.
class TestURLRequestFileJob : public URLRequestFileJob {
// |seek_position| will be set to the value passed in to OnSeekComplete.
// |observed_content| will be set to the concatenated data from all calls to
// OnReadComplete.
TestURLRequestFileJob(URLRequest* request,
NetworkDelegate* network_delegate,
const base::FilePath& file_path,
const scoped_refptr<base::TaskRunner>& file_task_runner,
int64_t* seek_position,
std::string* observed_content)
: URLRequestFileJob(request,
observed_content_(observed_content) {
*seek_position_ = 0;
~TestURLRequestFileJob() override {}
void OnSeekComplete(int64_t result) override {
ASSERT_EQ(*seek_position_, 0);
*seek_position_ = result;
void OnReadComplete(IOBuffer* buf, int result) override {
observed_content_->append(std::string(buf->data(), result));
int64_t* const seek_position_;
std::string* const observed_content_;
// A URLRequestJobFactory that will return TestURLRequestFileJob instances for
// file:// scheme URLs. Can only be used to create a single job.
class TestJobFactory : public URLRequestJobFactory {
TestJobFactory(const base::FilePath& path,
int64_t* seek_position,
std::string* observed_content)
: path_(path),
observed_content_(observed_content) {
~TestJobFactory() override {}
URLRequestJob* MaybeCreateJobWithProtocolHandler(
const std::string& scheme,
URLRequest* request,
NetworkDelegate* network_delegate) const override {
URLRequestJob* job = new TestURLRequestFileJob(
request, network_delegate, path_, base::ThreadTaskRunnerHandle::Get(),
seek_position_, observed_content_);
seek_position_ = nullptr;
observed_content_ = nullptr;
return job;
URLRequestJob* MaybeInterceptRedirect(URLRequest* request,
NetworkDelegate* network_delegate,
const GURL& location) const override {
return nullptr;
URLRequestJob* MaybeInterceptResponse(
URLRequest* request,
NetworkDelegate* network_delegate) const override {
return nullptr;
bool IsHandledProtocol(const std::string& scheme) const override {
return scheme == "file";
bool IsHandledURL(const GURL& url) const override {
return IsHandledProtocol(url.scheme());
bool IsSafeRedirectTarget(const GURL& location) const override {
return false;
const base::FilePath path_;
// These are mutable because MaybeCreateJobWithProtocolHandler is const.
mutable int64_t* seek_position_;
mutable std::string* observed_content_;
// Helper function to create a file at |path| filled with |content|.
// Returns true on success.
bool CreateFileWithContent(const std::string& content,
const base::FilePath& path) {
return base::WriteFile(path, content.c_str(), content.length());
// A simple holder for start/end used in http range requests.
struct Range {
int start;
int end;
Range() {
start = 0;
end = 0;
Range(int start, int end) {
this->start = start;
this->end = end;
// A superclass for tests of the OnSeekComplete / OnReadComplete functions of
// URLRequestFileJob.
class URLRequestFileJobEventsTest : public testing::Test {
// This creates a file with |content| as the contents, and then creates and
// runs a URLRequestFileJobWithCallbacks job to get the contents out of it,
// and makes sure that the callbacks observed the correct bytes. If a Range
// is provided, this function will add the appropriate Range http header to
// the request and verify that only the bytes in that range (inclusive) were
// observed.
void RunRequest(const std::string& content, const Range* range);
// This is the same as the method above it, except that it will make sure
// the content matches |expected_content| and allow caller to specify the
// extension of the filename in |file_extension|.
void RunRequest(const std::string& content,
const std::string& expected_content,
const base::FilePath::StringPieceType& file_extension,
const Range* range);
TestURLRequestContext context_;
TestDelegate delegate_;
URLRequestFileJobEventsTest::URLRequestFileJobEventsTest() {}
void URLRequestFileJobEventsTest::RunRequest(const std::string& content,
const Range* range) {
RunRequest(content, content, FILE_PATH_LITERAL(""), range);
void URLRequestFileJobEventsTest::RunRequest(
const std::string& raw_content,
const std::string& expected_content,
const base::FilePath::StringPieceType& file_extension,
const Range* range) {
base::ScopedTempDir directory;
base::FilePath path = directory.GetPath().Append(FILE_PATH_LITERAL("test"));
if (!file_extension.empty())
path = path.AddExtension(file_extension);
ASSERT_TRUE(CreateFileWithContent(raw_content, path));
int64_t seek_position;
std::string observed_content;
TestJobFactory factory(path, &seek_position, &observed_content);
std::unique_ptr<URLRequest> request(context_.CreateRequest(
FilePathToFileURL(path), DEFAULT_PRIORITY, &delegate_));
if (range) {
ASSERT_GE(range->start, 0);
ASSERT_GE(range->end, 0);
ASSERT_LE(range->start, range->end);
ASSERT_LT(static_cast<unsigned int>(range->end),
std::string range_value =
base::StringPrintf("bytes=%d-%d", range->start, range->end);
range_value, true /*overwrite*/);
int expected_length =
range ? (range->end - range->start + 1) : expected_content.length();
EXPECT_EQ(delegate_.bytes_received(), expected_length);
std::string expected_data_received;
if (range) {
expected_data_received.insert(0, expected_content, range->start,
EXPECT_EQ(expected_data_received, observed_content);
} else {
expected_data_received = expected_content;
EXPECT_EQ(raw_content, observed_content);
EXPECT_EQ(expected_data_received, delegate_.data_received());
EXPECT_EQ(seek_position, range ? range->start : 0);
// Helper function to make a character array filled with |size| bytes of
// test content.
std::string MakeContentOfSize(int size) {
EXPECT_GE(size, 0);
std::string result;
for (int i = 0; i < size; i++) {
result.append(1, static_cast<char>(i % 256));
return result;
TEST_F(URLRequestFileJobEventsTest, TinyFile) {
RunRequest(std::string("hello world"), NULL);
TEST_F(URLRequestFileJobEventsTest, SmallFile) {
RunRequest(MakeContentOfSize(17 * 1024), NULL);
TEST_F(URLRequestFileJobEventsTest, BigFile) {
RunRequest(MakeContentOfSize(3 * 1024 * 1024), NULL);
TEST_F(URLRequestFileJobEventsTest, Range) {
// Use a 15KB content file and read a range chosen somewhat arbitrarily but
// not aligned on any likely page boundaries.
int size = 15 * 1024;
Range range(1701, (6 * 1024) + 3);
RunRequest(MakeContentOfSize(size), &range);
TEST_F(URLRequestFileJobEventsTest, DecodeSvgzFile) {
std::string expected_content("Hello, World!");
unsigned char gzip_data[] = {
// From:
// echo -n 'Hello, World!' | gzip | xxd -i | sed -e 's/^/ /'
0x1f, 0x8b, 0x08, 0x00, 0x2b, 0x02, 0x84, 0x55, 0x00, 0x03, 0xf3,
0x48, 0xcd, 0xc9, 0xc9, 0xd7, 0x51, 0x08, 0xcf, 0x2f, 0xca, 0x49,
0x51, 0x04, 0x00, 0xd0, 0xc3, 0x4a, 0xec, 0x0d, 0x00, 0x00, 0x00};
RunRequest(std::string(reinterpret_cast<char*>(gzip_data), sizeof(gzip_data)),
expected_content, FILE_PATH_LITERAL("svgz"), nullptr);
} // namespace
} // namespace net