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
|
// 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
|