// Copyright 2014 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/file_system_provider/operations/get_metadata.h"
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "base/files/file.h"
#include "base/files/file_path.h"
#include "base/functional/bind.h"
#include "base/json/json_reader.h"
#include "base/time/time.h"
#include "base/values.h"
#include "chrome/browser/ash/file_system_provider/icon_set.h"
#include "chrome/browser/ash/file_system_provider/operations/test_util.h"
#include "chrome/browser/ash/file_system_provider/provided_file_system_interface.h"
#include "chrome/common/extensions/api/file_system_provider.h"
#include "chrome/common/extensions/api/file_system_provider_capabilities/file_system_provider_capabilities_handler.h"
#include "chrome/common/extensions/api/file_system_provider_internal.h"
#include "extensions/browser/event_router.h"
#include "storage/browser/file_system/async_file_util.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace ash::file_system_provider::operations {
namespace {
const char kExtensionId[] = "mbflcebpggnecokmikipoihdbecnjfoj";
const char kFileSystemId[] = "testing-file-system";
const char kMimeType[] = "text/plain";
const int kRequestId = 2;
const base::FilePath::CharType kDirectoryPath[] =
FILE_PATH_LITERAL("/directory");
// URLs are case insensitive, so it should pass the sanity check.
const char kThumbnail[] = "DaTa:ImAgE/pNg;base64,";
// Returns the request value as |result| in case of successful parse.
void CreateRequestValueFromJSON(const std::string& json, RequestValue* result) {
using extensions::api::file_system_provider_internal::
GetMetadataRequestedSuccess::Params;
auto parsed_json = base::JSONReader::ReadAndReturnValueWithError(json);
ASSERT_TRUE(parsed_json.has_value()) << parsed_json.error().message;
ASSERT_TRUE(parsed_json->is_list());
std::optional<Params> params = Params::Create(parsed_json->GetList());
ASSERT_TRUE(params.has_value());
*result = RequestValue::CreateForGetMetadataSuccess(std::move(*params));
ASSERT_TRUE(result->is_valid());
}
// Callback invocation logger. Acts as a fileapi end-point.
class CallbackLogger {
public:
class Event {
public:
Event(std::unique_ptr<EntryMetadata> metadata, base::File::Error result)
: metadata_(std::move(metadata)), result_(result) {}
Event(const Event&) = delete;
Event& operator=(const Event&) = delete;
virtual ~Event() = default;
const EntryMetadata* metadata() const { return metadata_.get(); }
base::File::Error result() const { return result_; }
private:
std::unique_ptr<EntryMetadata> metadata_;
base::File::Error result_;
};
CallbackLogger() = default;
CallbackLogger(const CallbackLogger&) = delete;
CallbackLogger& operator=(const CallbackLogger&) = delete;
virtual ~CallbackLogger() = default;
void OnGetMetadata(std::unique_ptr<EntryMetadata> metadata,
base::File::Error result) {
events_.push_back(std::make_unique<Event>(std::move(metadata), result));
}
const std::vector<std::unique_ptr<Event>>& events() const { return events_; }
private:
std::vector<std::unique_ptr<Event>> events_;
};
} // namespace
using ModificationTime =
extensions::api::file_system_provider::EntryMetadata::ModificationTime;
class FileSystemProviderOperationsGetMetadataTest : public testing::Test {
protected:
FileSystemProviderOperationsGetMetadataTest() = default;
~FileSystemProviderOperationsGetMetadataTest() override = default;
void SetUp() override {
file_system_info_ = ProvidedFileSystemInfo(
kExtensionId, MountOptions(kFileSystemId, /*display_name=*/""),
base::FilePath(), /*configurable=*/false, /*watchable=*/true,
extensions::SOURCE_FILE, IconSet());
}
ProvidedFileSystemInfo file_system_info_;
};
TEST_F(FileSystemProviderOperationsGetMetadataTest, ValidateName) {
EXPECT_TRUE(ValidateName("hello-world!@#$%^&*()-_=+\"':,.<>?[]{}|\\",
/*root_entry=*/false));
EXPECT_FALSE(ValidateName("hello-world!@#$%^&*()-_=+\"':,.<>?[]{}|\\",
/*root_entry=*/true));
EXPECT_FALSE(ValidateName("", /*root_entry=*/false));
EXPECT_TRUE(ValidateName("", /*root_entry=*/true));
EXPECT_FALSE(ValidateName("hello/world", /*root_entry=*/false));
EXPECT_FALSE(ValidateName("hello/world", /*root_entry=*/true));
}
TEST_F(FileSystemProviderOperationsGetMetadataTest, ValidateIDLEntryMetadata) {
using extensions::api::file_system_provider::EntryMetadata;
const std::string kValidFileName = "hello-world";
const std::string kValidThumbnailUrl = "data:something";
// Correct metadata for non-root.
{
EntryMetadata metadata;
metadata.name = kValidFileName;
metadata.modification_time.emplace();
metadata.modification_time->additional_properties.Set(
"value", "invalid-date-time"); // Invalid modification time is OK.
metadata.thumbnail = kValidThumbnailUrl;
EXPECT_TRUE(ValidateIDLEntryMetadata(
metadata,
ProvidedFileSystemInterface::METADATA_FIELD_NAME |
ProvidedFileSystemInterface::METADATA_FIELD_MODIFICATION_TIME |
ProvidedFileSystemInterface::METADATA_FIELD_THUMBNAIL,
/*root_entry=*/false));
}
// Correct metadata for non-root (without thumbnail).
{
EntryMetadata metadata;
metadata.name = kValidFileName;
metadata.modification_time.emplace();
metadata.modification_time->additional_properties.Set(
"value", "invalid-date-time"); // Invalid modification time is OK.
EXPECT_TRUE(ValidateIDLEntryMetadata(
metadata,
ProvidedFileSystemInterface::METADATA_FIELD_NAME |
ProvidedFileSystemInterface::METADATA_FIELD_MODIFICATION_TIME |
ProvidedFileSystemInterface::METADATA_FIELD_THUMBNAIL,
/*root_entry=*/false));
}
// Correct metadata for root.
{
EntryMetadata metadata;
metadata.name.emplace();
metadata.modification_time.emplace();
metadata.modification_time->additional_properties.Set(
"value", "invalid-date-time"); // Invalid modification time is OK.
EXPECT_TRUE(ValidateIDLEntryMetadata(
metadata,
ProvidedFileSystemInterface::METADATA_FIELD_NAME |
ProvidedFileSystemInterface::METADATA_FIELD_MODIFICATION_TIME |
ProvidedFileSystemInterface::METADATA_FIELD_THUMBNAIL,
/*root_entry=*/true));
}
// Invalid characters in the name.
{
EntryMetadata metadata;
metadata.name = "hello/world";
EXPECT_FALSE(ValidateIDLEntryMetadata(
metadata, ProvidedFileSystemInterface::METADATA_FIELD_NAME,
/*root_entry=*/false));
}
// Empty name for non-root.
{
EntryMetadata metadata;
metadata.name.emplace();
EXPECT_FALSE(ValidateIDLEntryMetadata(
metadata, ProvidedFileSystemInterface::METADATA_FIELD_NAME,
/*root_entry=*/false));
}
// Missing `is_directory`.
{
EntryMetadata metadata;
EXPECT_FALSE(ValidateIDLEntryMetadata(
metadata, ProvidedFileSystemInterface::METADATA_FIELD_IS_DIRECTORY,
/*root_entry=*/false));
}
// Missing `size`.
{
EntryMetadata metadata;
EXPECT_FALSE(ValidateIDLEntryMetadata(
metadata, ProvidedFileSystemInterface::METADATA_FIELD_SIZE,
/*root_entry=*/false));
}
// Missing last modification time.
{
EntryMetadata metadata;
EXPECT_FALSE(ValidateIDLEntryMetadata(
metadata, ProvidedFileSystemInterface::METADATA_FIELD_MODIFICATION_TIME,
/*root_entry=*/false));
}
// Invalid thumbnail.
{
EntryMetadata metadata;
metadata.thumbnail = "http://invalid-scheme";
EXPECT_FALSE(ValidateIDLEntryMetadata(
metadata, ProvidedFileSystemInterface::METADATA_FIELD_THUMBNAIL,
/*root_entry=*/false));
}
// Empty string for thumbnail.
{
EntryMetadata metadata;
metadata.thumbnail.emplace();
EXPECT_FALSE(ValidateIDLEntryMetadata(
metadata, ProvidedFileSystemInterface::METADATA_FIELD_THUMBNAIL,
/*root_entry=*/false));
}
// Missing cloud identifier
{
EntryMetadata metadata;
EXPECT_FALSE(ValidateIDLEntryMetadata(
metadata, ProvidedFileSystemInterface::METADATA_FIELD_CLOUD_IDENTIFIER,
/*root_entry=*/false));
}
// Empty string for cloud identifier's ID.
{
EntryMetadata metadata;
metadata.cloud_identifier.emplace();
metadata.cloud_identifier->provider_name = "provider-name";
metadata.cloud_identifier->id = "";
EXPECT_FALSE(ValidateIDLEntryMetadata(
metadata, ProvidedFileSystemInterface::METADATA_FIELD_CLOUD_IDENTIFIER,
/*root_entry=*/false));
}
// Empty string for cloud identifier's provider name.
{
EntryMetadata metadata;
metadata.cloud_identifier.emplace();
metadata.cloud_identifier->provider_name = "";
metadata.cloud_identifier->id = "id";
EXPECT_FALSE(ValidateIDLEntryMetadata(
metadata, ProvidedFileSystemInterface::METADATA_FIELD_CLOUD_IDENTIFIER,
/*root_entry=*/false));
}
}
TEST_F(FileSystemProviderOperationsGetMetadataTest, Execute) {
using extensions::api::file_system_provider::GetMetadataRequestedOptions;
util::LoggingDispatchEventImpl dispatcher(/*dispatch_reply=*/true);
CallbackLogger callback_logger;
GetMetadata get_metadata(
&dispatcher, file_system_info_, base::FilePath(kDirectoryPath),
ProvidedFileSystemInterface::METADATA_FIELD_THUMBNAIL,
base::BindOnce(&CallbackLogger::OnGetMetadata,
base::Unretained(&callback_logger)));
EXPECT_TRUE(get_metadata.Execute(kRequestId));
ASSERT_EQ(1u, dispatcher.events().size());
extensions::Event* event = dispatcher.events()[0].get();
EXPECT_EQ(
extensions::api::file_system_provider::OnGetMetadataRequested::kEventName,
event->event_name);
const base::Value::List& event_args = event->event_args;
ASSERT_EQ(1u, event_args.size());
const base::Value* options_as_value = &event_args[0];
ASSERT_TRUE(options_as_value->is_dict());
auto options =
GetMetadataRequestedOptions::FromValue(options_as_value->GetDict());
ASSERT_TRUE(options);
EXPECT_EQ(kFileSystemId, options->file_system_id);
EXPECT_EQ(kRequestId, options->request_id);
EXPECT_EQ(kDirectoryPath, options->entry_path);
EXPECT_TRUE(options->thumbnail);
}
TEST_F(FileSystemProviderOperationsGetMetadataTest, Execute_NoListener) {
util::LoggingDispatchEventImpl dispatcher(/*dispatch_reply=*/false);
CallbackLogger callback_logger;
GetMetadata get_metadata(
&dispatcher, file_system_info_, base::FilePath(kDirectoryPath),
ProvidedFileSystemInterface::METADATA_FIELD_THUMBNAIL,
base::BindOnce(&CallbackLogger::OnGetMetadata,
base::Unretained(&callback_logger)));
EXPECT_FALSE(get_metadata.Execute(kRequestId));
}
TEST_F(FileSystemProviderOperationsGetMetadataTest, OnSuccess) {
util::LoggingDispatchEventImpl dispatcher(/*dispatch_reply=*/true);
CallbackLogger callback_logger;
GetMetadata get_metadata(
&dispatcher, file_system_info_, base::FilePath(kDirectoryPath),
ProvidedFileSystemInterface::METADATA_FIELD_IS_DIRECTORY |
ProvidedFileSystemInterface::METADATA_FIELD_NAME |
ProvidedFileSystemInterface::METADATA_FIELD_SIZE |
ProvidedFileSystemInterface::METADATA_FIELD_MODIFICATION_TIME |
ProvidedFileSystemInterface::METADATA_FIELD_MIME_TYPE |
ProvidedFileSystemInterface::METADATA_FIELD_THUMBNAIL |
ProvidedFileSystemInterface::METADATA_FIELD_CLOUD_IDENTIFIER |
ProvidedFileSystemInterface::METADATA_FIELD_CLOUD_FILE_INFO,
base::BindOnce(&CallbackLogger::OnGetMetadata,
base::Unretained(&callback_logger)));
EXPECT_TRUE(get_metadata.Execute(kRequestId));
// Sample input as JSON. Keep in sync with file_system_provider_api.idl.
// As for now, it is impossible to create *::Params class directly, not from
// base::Value.
const std::string input =
"[\n"
" \"testing-file-system\",\n" // kFileSystemId
" 2,\n" // kRequestId
" {\n"
" \"isDirectory\": false,\n"
" \"name\": \"blueberries.txt\",\n"
" \"size\": 4096,\n"
" \"modificationTime\": {\n"
" \"value\": \"Thu Apr 24 00:46:52 UTC 2014\"\n"
" },\n"
" \"mimeType\": \"text/plain\",\n" // kMimeType
" \"thumbnail\": \"DaTa:ImAgE/pNg;base64,\",\n" // kThumbnail
" \"cloudIdentifier\": {\n"
" \"providerName\": \"provider-name\",\n"
" \"id\": \"abc123\"\n"
" },\n"
" \"cloudFileInfo\": {\n"
" \"versionTag\": \"aYzpFNjgwQ0QxNTg5QjI0NTAyITI0NC4yNTg\""
" }\n"
" },\n"
" 0\n" // execution_time
"]\n";
RequestValue request_value;
ASSERT_NO_FATAL_FAILURE(CreateRequestValueFromJSON(input, &request_value));
const bool has_more = false;
get_metadata.OnSuccess(kRequestId, std::move(request_value), has_more);
ASSERT_EQ(1u, callback_logger.events().size());
CallbackLogger::Event* event = callback_logger.events()[0].get();
EXPECT_EQ(base::File::FILE_OK, event->result());
const EntryMetadata* metadata = event->metadata();
EXPECT_FALSE(*metadata->is_directory);
EXPECT_EQ(4096, *metadata->size);
base::Time expected_time;
EXPECT_TRUE(
base::Time::FromString("Thu Apr 24 00:46:52 UTC 2014", &expected_time));
EXPECT_EQ(expected_time, *metadata->modification_time);
EXPECT_EQ(kMimeType, *metadata->mime_type);
EXPECT_EQ(kThumbnail, *metadata->thumbnail);
EXPECT_EQ(CloudIdentifier("provider-name", "abc123"),
*metadata->cloud_identifier);
EXPECT_EQ(CloudFileInfo("aYzpFNjgwQ0QxNTg5QjI0NTAyITI0NC4yNTg"),
*metadata->cloud_file_info);
}
TEST_F(FileSystemProviderOperationsGetMetadataTest, OnSuccess_InvalidMetadata) {
util::LoggingDispatchEventImpl dispatcher(/*dispatch_reply=*/true);
CallbackLogger callback_logger;
GetMetadata get_metadata(
&dispatcher, file_system_info_, base::FilePath(kDirectoryPath),
ProvidedFileSystemInterface::METADATA_FIELD_IS_DIRECTORY |
ProvidedFileSystemInterface::METADATA_FIELD_NAME |
ProvidedFileSystemInterface::METADATA_FIELD_SIZE |
ProvidedFileSystemInterface::METADATA_FIELD_MODIFICATION_TIME |
ProvidedFileSystemInterface::METADATA_FIELD_MIME_TYPE |
ProvidedFileSystemInterface::METADATA_FIELD_THUMBNAIL |
ProvidedFileSystemInterface::METADATA_FIELD_CLOUD_IDENTIFIER |
ProvidedFileSystemInterface::METADATA_FIELD_CLOUD_FILE_INFO,
base::BindOnce(&CallbackLogger::OnGetMetadata,
base::Unretained(&callback_logger)));
EXPECT_TRUE(get_metadata.Execute(kRequestId));
// Sample input as JSON. Keep in sync with file_system_provider_api.idl.
// As for now, it is impossible to create *::Params class directly, not from
// base::Value.
const std::string input =
"[\n"
" \"testing-file-system\",\n" // kFileSystemId
" 2,\n" // kRequestId
" {\n"
" \"isDirectory\": false,\n"
" \"name\": \"blue/berries.txt\",\n"
" \"size\": 4096,\n"
" \"modificationTime\": {\n"
" \"value\": \"Thu Apr 24 00:46:52 UTC 2014\"\n"
" },\n"
" \"mimeType\": \"text/plain\",\n" // kMimeType
" \"thumbnail\": \"http://www.foobar.com/evil\",\n" // kThumbnail
" \"cloudIdentifier\": {\n"
" \"providerName\": \"provider-name\",\n"
" \"id\": \"abc123\"\n"
" },\n"
" \"cloudFileInfo\": {\n"
" \"versionTag\": \"aYzpFNjgwQ0QxNTg5QjI0NTAyITI0NC4yNTg\""
" }\n"
" },\n"
" 0\n" // execution_time
"]\n";
RequestValue request_value;
ASSERT_NO_FATAL_FAILURE(CreateRequestValueFromJSON(input, &request_value));
const bool has_more = false;
get_metadata.OnSuccess(kRequestId, std::move(request_value), has_more);
ASSERT_EQ(1u, callback_logger.events().size());
CallbackLogger::Event* event = callback_logger.events()[0].get();
EXPECT_EQ(base::File::FILE_ERROR_IO, event->result());
const EntryMetadata* metadata = event->metadata();
EXPECT_FALSE(metadata);
}
TEST_F(FileSystemProviderOperationsGetMetadataTest, OnError) {
util::LoggingDispatchEventImpl dispatcher(/*dispatch_reply=*/true);
CallbackLogger callback_logger;
GetMetadata get_metadata(
&dispatcher, file_system_info_, base::FilePath(kDirectoryPath),
ProvidedFileSystemInterface::METADATA_FIELD_THUMBNAIL,
base::BindOnce(&CallbackLogger::OnGetMetadata,
base::Unretained(&callback_logger)));
EXPECT_TRUE(get_metadata.Execute(kRequestId));
get_metadata.OnError(kRequestId, RequestValue(),
base::File::FILE_ERROR_TOO_MANY_OPENED);
ASSERT_EQ(1u, callback_logger.events().size());
CallbackLogger::Event* event = callback_logger.events()[0].get();
EXPECT_EQ(base::File::FILE_ERROR_TOO_MANY_OPENED, event->result());
}
} // namespace ash::file_system_provider::operations
Codebase Browser
chromium