storage/browser/quota/quota_settings_unittest.cc

// Copyright 2019 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 <memory>
#include <utility>

#include "base/bind.h"
#include "base/callback.h"
#include "base/files/scoped_temp_dir.h"
#include "base/test/bind_test_util.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "storage/browser/quota/quota_device_info_helper.h"
#include "storage/browser/quota/quota_features.h"
#include "storage/browser/quota/quota_settings.h"
#include "testing/gmock/include/gmock/gmock.h"

using ::testing::_;

namespace {

constexpr int64_t kMBytes = 1024 * 1024;

// 10% is the non-experimental incognito pool size ratio
// as defined in storage/browser/quota/quota_settings.cc line 37.
constexpr double kIncognitoPoolSizeRatio = 0.1;

// 300 MB + 10% is the max incognito pool size as set in
// storage/browser/quota/quota_settings.cc line 48.
constexpr int64_t kMaxIncognitoPoolSize =
    (300 + 300 * kIncognitoPoolSizeRatio) * kMBytes;

}  // namespace

namespace storage {

class MockQuotaDeviceInfoHelper : public QuotaDeviceInfoHelper {
 public:
  MockQuotaDeviceInfoHelper() = default;
  MOCK_CONST_METHOD1(AmountOfTotalDiskSpace, int64_t(const base::FilePath&));
  MOCK_CONST_METHOD0(AmountOfPhysicalMemory, int64_t());
};

class QuotaSettingsTest : public testing::Test {
 public:
  QuotaSettingsTest() = default;
  void SetUp() override { ASSERT_TRUE(data_dir_.CreateUniqueTempDir()); }

 protected:
  base::test::ScopedFeatureList scoped_feature_list_;
  base::test::TaskEnvironment task_environment_;
  const base::FilePath& profile_path() const { return data_dir_.GetPath(); }

 private:
  base::ScopedTempDir data_dir_;
  QuotaSettings quota_settings_;
  DISALLOW_COPY_AND_ASSIGN(QuotaSettingsTest);
};

class QuotaSettingsIncognitoTest : public QuotaSettingsTest {
 public:
  QuotaSettingsIncognitoTest() = default;

 protected:
  void SetUpDeviceInfoHelper(const int expected_calls,
                             const int64_t physical_memory_amount) {
    ON_CALL(device_info_helper_, AmountOfPhysicalMemory())
        .WillByDefault(::testing::Return(physical_memory_amount));
    EXPECT_CALL(device_info_helper_, AmountOfPhysicalMemory())
        .Times(expected_calls);
  }

  void EnableFeature() {
    scoped_feature_list_.Reset();
    scoped_feature_list_.InitAndEnableFeatureWithParameters(
        features::kIncognitoDynamicQuota,
        {{"IncognitoQuotaRatioLowerBound", ratio_lower_bound_},
         {"IncognitoQuotaRatioUpperBound", ratio_upper_bound_}});
  }

  void DisableFeature() {
    scoped_feature_list_.Reset();
    scoped_feature_list_.InitAndDisableFeature(
        features::kIncognitoDynamicQuota);
  }

  void GetAndTestExperimentalSettings(const int64_t physical_memory_amount) {
    bool callback_executed = false;
    GetNominalDynamicSettings(
        profile_path(), true, device_info_helper(),
        base::BindLambdaForTesting([&](base::Optional<QuotaSettings> settings) {
          callback_executed = true;
          EXPECT_LE(physical_memory_amount * 0.2, settings->pool_size);
          EXPECT_GE(physical_memory_amount * 0.3, settings->pool_size);
        }));
    task_environment_.RunUntilIdle();
    EXPECT_TRUE(callback_executed);
  }

  void GetAndTestDefaultSettings() {
    bool callback_executed = false;
    GetNominalDynamicSettings(
        profile_path(), true, device_info_helper(),
        base::BindLambdaForTesting([&](base::Optional<QuotaSettings> settings) {
          callback_executed = true;
          EXPECT_GE(kMaxIncognitoPoolSize, settings->pool_size);
        }));
    task_environment_.RunUntilIdle();
    EXPECT_TRUE(callback_executed);
  }

  MockQuotaDeviceInfoHelper* device_info_helper() {
    return &device_info_helper_;
  }

 private:
  MockQuotaDeviceInfoHelper device_info_helper_;
  std::string ratio_lower_bound_ = "0.2";
  std::string ratio_upper_bound_ = "0.3";
};

TEST_F(QuotaSettingsTest, Default) {
  MockQuotaDeviceInfoHelper device_info_helper;
  ON_CALL(device_info_helper, AmountOfTotalDiskSpace(_))
      .WillByDefault(::testing::Return(2000));

  bool callback_executed = false;
  GetNominalDynamicSettings(
      profile_path(), false, &device_info_helper,
      base::BindLambdaForTesting([&](base::Optional<QuotaSettings> settings) {
        callback_executed = true;
        ASSERT_NE(settings, base::nullopt);
        // 1600 = 2000 * default PoolSizeRatio (0.8)
        EXPECT_EQ(settings->pool_size, 1600);
        // 1200 = 1600 * default PerHostRatio (.75)
        EXPECT_EQ(settings->per_host_quota, 1200);
      }));
  task_environment_.RunUntilIdle();
  EXPECT_TRUE(callback_executed);
}

TEST_F(QuotaSettingsTest, ExpandedTempPool) {
  MockQuotaDeviceInfoHelper device_info_helper;
  ON_CALL(device_info_helper, AmountOfTotalDiskSpace(_))
      .WillByDefault(::testing::Return(2000));
  scoped_feature_list_.InitAndEnableFeatureWithParameters(
      features::kQuotaExpandPoolSize,
      {{"PoolSizeRatio", "0.75"}, {"PerHostRatio", "0.5"}});

  bool callback_executed = false;
  GetNominalDynamicSettings(
      profile_path(), false, &device_info_helper,
      base::BindLambdaForTesting([&](base::Optional<QuotaSettings> settings) {
        callback_executed = true;
        ASSERT_NE(settings, base::nullopt);
        // 1500 = 2000 * PoolSizeRatio
        EXPECT_EQ(settings->pool_size, 1500);
        // 750 = 1500 * PerHostRatio
        EXPECT_EQ(settings->per_host_quota, 750);
      }));
  task_environment_.RunUntilIdle();
  EXPECT_TRUE(callback_executed);
}

TEST_F(QuotaSettingsTest, UnlimitedTempPool) {
  MockQuotaDeviceInfoHelper device_info_helper;
  ON_CALL(device_info_helper, AmountOfTotalDiskSpace(_))
      .WillByDefault(::testing::Return(2000));
  scoped_feature_list_.InitAndEnableFeature(features::kQuotaUnlimitedPoolSize);

  bool callback_executed = false;
  GetNominalDynamicSettings(
      profile_path(), false, &device_info_helper,
      base::BindLambdaForTesting([&](base::Optional<QuotaSettings> settings) {
        callback_executed = true;
        ASSERT_NE(settings, base::nullopt);
        EXPECT_EQ(settings->pool_size, 2000);
        EXPECT_EQ(settings->per_host_quota, 2000);
      }));
  task_environment_.RunUntilIdle();
  EXPECT_TRUE(callback_executed);
}

TEST_F(QuotaSettingsTest, IncognitoQuotaCapped) {
  MockQuotaDeviceInfoHelper device_info_helper;
  EXPECT_CALL(device_info_helper, AmountOfPhysicalMemory()).Times(1);
  ON_CALL(device_info_helper, AmountOfPhysicalMemory())
      .WillByDefault(::testing::Return(kMaxIncognitoPoolSize));

  scoped_feature_list_.InitAndDisableFeature(features::kIncognitoDynamicQuota);
  bool callback_executed = false;
  GetNominalDynamicSettings(
      profile_path(), true, &device_info_helper,
      base::BindLambdaForTesting([&](base::Optional<QuotaSettings> settings) {
        callback_executed = true;
        EXPECT_GE(kMaxIncognitoPoolSize, settings->pool_size);
      }));
  task_environment_.RunUntilIdle();
  EXPECT_TRUE(callback_executed);
}

TEST_F(QuotaSettingsIncognitoTest, IncognitoDynamicQuota_BelowStaticLimit) {
  const int expected_device_info_calls = 2;
  const int64_t physical_memory_amount = 1000 * kMBytes;
  static_assert(
      physical_memory_amount * kIncognitoPoolSizeRatio < kMaxIncognitoPoolSize,
      "10% of physical_memory_amount should be less than "
      "kMaxIncognitoPoolSize");

  SetUpDeviceInfoHelper(expected_device_info_calls, physical_memory_amount);
  EnableFeature();
  GetAndTestExperimentalSettings(physical_memory_amount);
  DisableFeature();
  GetAndTestDefaultSettings();
}

TEST_F(QuotaSettingsIncognitoTest, IncognitoDynamicQuota_AtStaticLimit) {
  const int expected_device_info_calls = 2;
  const int64_t physical_memory_amount = 3300 * kMBytes;
  static_assert(physical_memory_amount * 0.1 == kMaxIncognitoPoolSize,
                "10% of physical_memory_amount should be equal to "
                "kMaxIncognitoPoolSize");

  SetUpDeviceInfoHelper(expected_device_info_calls, physical_memory_amount);
  EnableFeature();
  GetAndTestExperimentalSettings(physical_memory_amount);
  DisableFeature();
  GetAndTestDefaultSettings();
}

TEST_F(QuotaSettingsIncognitoTest, IncognitoDynamicQuota_AboveStaticLimit) {
  const int expected_device_info_calls = 1;
  const int64_t physical_memory_amount = 10000 * kMBytes;
  static_assert(
      physical_memory_amount * kIncognitoPoolSizeRatio > kMaxIncognitoPoolSize,
      "10% of physical_memory_amount should "
      "be greater than kMaxIncognitoPoolSize");

  SetUpDeviceInfoHelper(expected_device_info_calls, physical_memory_amount);
  EnableFeature();
  GetAndTestExperimentalSettings(physical_memory_amount);
}

}  // namespace storage