// Copyright 2022 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/guest_os/public/guest_os_mount_provider.h"
#include <memory>
#include "base/files/file_path.h"
#include "base/functional/bind.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/strings/stringprintf.h"
#include "base/test/bind.h"
#include "chrome/browser/ash/file_manager/volume_manager.h"
#include "chrome/browser/ash/file_manager/volume_manager_factory.h"
#include "chrome/browser/ash/file_manager/volume_manager_observer.h"
#include "chrome/browser/ash/guest_os/guest_id.h"
#include "chrome/browser/ash/guest_os/guest_os_test_helpers.h"
#include "chrome/test/base/testing_profile.h"
#include "chromeos/ash/components/dbus/cros_disks/cros_disks_client.h"
#include "chromeos/ash/components/disks/disk_mount_manager.h"
#include "chromeos/ash/components/disks/mock_disk_mount_manager.h"
#include "components/keyed_service/content/browser_context_keyed_service_factory.h"
#include "content/public/browser/browser_context.h"
#include "content/public/test/browser_task_environment.h"
#include "storage/browser/file_system/external_mount_points.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using ::ash::disks::DiskMountManager;
using testing::_;
namespace {
// Creates a new VolumeManager for tests.
// By default, VolumeManager KeyedService is null for testing.
std::unique_ptr<KeyedService> BuildVolumeManager(
content::BrowserContext* context) {
return std::make_unique<file_manager::VolumeManager>(
Profile::FromBrowserContext(context),
nullptr /* drive_integration_service */,
nullptr /* power_manager_client */, DiskMountManager::GetInstance(),
nullptr /* file_system_provider_service */,
file_manager::VolumeManager::GetMtpStorageInfoCallback());
}
class MockVolumeManagerObserver : public file_manager::VolumeManagerObserver {
public:
MockVolumeManagerObserver() = default;
~MockVolumeManagerObserver() override = default;
MOCK_METHOD(void,
OnVolumeMounted,
(ash::MountError error_code, const file_manager::Volume& volume),
(override));
};
} // namespace
namespace guest_os {
class GuestOsMountProviderTest : public testing::Test {
public:
GuestOsMountProviderTest() {
profile_ = std::make_unique<TestingProfile>();
// DiskMountManager::InitializeForTesting takes ownership and works with
// a raw pointer, hence the new with no matching delete.
disk_manager_ = new ash::disks::MockDiskMountManager;
provider_ = std::make_unique<MockMountProvider>(profile_.get(), kGuestId);
file_manager::VolumeManagerFactory::GetInstance()->SetTestingFactory(
profile_.get(), base::BindRepeating(&BuildVolumeManager));
DiskMountManager::InitializeForTesting(disk_manager_);
volume_manager_ = file_manager::VolumeManagerFactory::Get(profile_.get());
volume_manager_observer_ = std::make_unique<MockVolumeManagerObserver>();
volume_manager_->AddObserver(volume_manager_observer_.get());
}
GuestOsMountProviderTest(const GuestOsMountProviderTest&) = delete;
GuestOsMountProviderTest& operator=(const GuestOsMountProviderTest&) = delete;
~GuestOsMountProviderTest() override {
storage::ExternalMountPoints::GetSystemInstance()->RevokeFileSystem(
kMountName);
// Set an empty factory to shut down our testing factory.
file_manager::VolumeManagerFactory::GetInstance()->SetTestingFactory(
profile_.get(), BrowserContextKeyedServiceFactory::TestingFactory{});
DiskMountManager::Shutdown();
provider_.reset();
profile_.reset();
}
protected:
void NotifyMountEvent(
const std::string& source_path,
const std::string& source_format,
const std::string& mount_label,
const std::vector<std::string>& mount_options,
ash::MountType type,
ash::MountAccessMode access_mode,
ash::disks::DiskMountManager::MountPathCallback callback) {
auto event = DiskMountManager::MountEvent::MOUNTING;
auto code = ash::MountError::kSuccess;
auto info = DiskMountManager::MountPoint{
base::StringPrintf("sftp://%d:%d", cid_, port_),
"/media/fuse/" + kMountName, ash::MountType::kNetworkStorage};
disk_manager_->NotifyMountEvent(event, code, info);
std::move(callback).Run(code, info);
}
void ExpectMountCalls(int n) {
std::vector<std::string> default_mount_options;
EXPECT_CALL(*disk_manager_,
MountPath(base::StringPrintf("sftp://%d:%d", cid_, port_), "",
kMountName, default_mount_options,
ash::MountType::kNetworkStorage,
ash::MountAccessMode::kReadWrite, _))
.Times(n)
.WillRepeatedly(
Invoke(this, &GuestOsMountProviderTest::NotifyMountEvent));
EXPECT_CALL(*volume_manager_observer_, OnVolumeMounted).Times(n);
}
// Use VmType::BRUSCHETTA because TERMINA (Crostini) is special-cased to
// use GetCrostiniMountPointName.
//
// Expect the mount point name to be:
// guestos_${UserHash}_${encode(kGuestId.ToString())}
// Note that UserHash is an empty string in these tests.
const guest_os::GuestId kGuestId =
guest_os::GuestId(guest_os::VmType::BRUSCHETTA, "cow", "ptery/daccy");
const std::string kMountName = std::string{"guestos++cow+ptery%2Fdaccy"};
content::BrowserTaskEnvironment task_environment_;
raw_ptr<ash::disks::MockDiskMountManager, DanglingUntriaged> disk_manager_;
std::unique_ptr<TestingProfile> profile_;
raw_ptr<file_manager::VolumeManager, DanglingUntriaged> volume_manager_;
std::unique_ptr<MockVolumeManagerObserver> volume_manager_observer_;
std::unique_ptr<MockMountProvider> provider_;
int cid_ = 41; // Default set in MockMountProvider
int port_ = 1234; // Default set in MockMountProvider
};
TEST_F(GuestOsMountProviderTest, MountDiskMountsDisk) {
ExpectMountCalls(1);
bool result = false;
provider_->Mount(
base::BindLambdaForTesting([&result](bool res) { result = res; }));
task_environment_.RunUntilIdle();
EXPECT_TRUE(result);
base::FilePath path;
EXPECT_TRUE(
storage::ExternalMountPoints::GetSystemInstance()->GetRegisteredPath(
kMountName, &path));
EXPECT_EQ(base::FilePath("/media/fuse/" + kMountName), path);
auto volume = volume_manager_->FindVolumeById("guest_os:" + kMountName);
ASSERT_TRUE(volume);
EXPECT_EQ(volume->type(), file_manager::VOLUME_TYPE_GUEST_OS);
EXPECT_EQ(volume->volume_label(), provider_->DisplayName());
EXPECT_EQ(volume->vm_type(), provider_->vm_type());
}
TEST_F(GuestOsMountProviderTest, MultipleCallsAreQueuedAndOnlyMountOnce) {
ExpectMountCalls(1);
int successes = 0;
provider_->Mount(base::BindLambdaForTesting(
[&successes](bool result) { successes += result; }));
provider_->Mount(base::BindLambdaForTesting(
[&successes](bool result) { successes += result; }));
task_environment_.RunUntilIdle();
provider_->Mount(base::BindLambdaForTesting(
[&successes](bool result) { successes += result; }));
task_environment_.RunUntilIdle();
EXPECT_EQ(successes, 3);
base::FilePath path;
EXPECT_TRUE(
storage::ExternalMountPoints::GetSystemInstance()->GetRegisteredPath(
kMountName, &path));
EXPECT_EQ(base::FilePath("/media/fuse/" + kMountName), path);
}
TEST_F(GuestOsMountProviderTest, CanRemountAfterUnmount) {
ExpectMountCalls(2);
EXPECT_CALL(*disk_manager_, UnmountPath)
.WillOnce(testing::Invoke(
[this](const std::string& mount_path,
DiskMountManager::UnmountPathCallback callback) {
EXPECT_EQ(mount_path, "/media/fuse/" + kMountName);
std::move(callback).Run(ash::MountError::kSuccess);
}));
provider_->Mount(
base::BindLambdaForTesting([](bool res) { EXPECT_TRUE(res); }));
task_environment_.RunUntilIdle();
provider_->Unmount();
task_environment_.RunUntilIdle();
provider_->Mount(
base::BindLambdaForTesting([](bool res) { EXPECT_TRUE(res); }));
task_environment_.RunUntilIdle();
base::FilePath path;
EXPECT_TRUE(
storage::ExternalMountPoints::GetSystemInstance()->GetRegisteredPath(
kMountName, &path));
EXPECT_EQ(base::FilePath("/media/fuse/" + kMountName), path);
}
class FailMountProvider : public MockMountProvider {
public:
FailMountProvider(Profile* profile, guest_os::GuestId guest_id)
: MockMountProvider(profile, guest_id) {}
void Prepare(PrepareCallback callback) override {
std::move(callback).Run(false, 0, 0, base::FilePath());
}
};
TEST_F(GuestOsMountProviderTest, PrepareFailureFailsMounting) {
auto fail_provider = FailMountProvider(profile_.get(), kGuestId);
ExpectMountCalls(0);
bool result = true;
fail_provider.Mount(
base::BindLambdaForTesting([&result](bool res) { result = res; }));
task_environment_.RunUntilIdle();
EXPECT_FALSE(result);
}
} // namespace guest_os