nearby/internal/platform/implementation/linux/preferences_repository_test.cc

// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include <filesystem>  // NOLINT(build/c++17)
#include <fstream>
#include <optional>

#include "gtest/gtest.h"
#include "internal/platform/implementation/device_info.h"
#include "internal/platform/implementation/platform.h"
#include "nlohmann/json.hpp"
#include "nlohmann/json_fwd.hpp"
#include "internal/platform/implementation/linux/preferences_repository.h"

namespace nearby {
namespace linux {
namespace {

using json = ::nlohmann::json;

constexpr char kPreferencesFileName[] = "preferences.json";
constexpr char kPreferencesBackupFileName[] = "preferences_bak.json";
constexpr char kPreferencesPath[] = "Google/Nearby/Sharing";

TEST(PreferencesRepository, LoadWithBadPath) {
  PreferencesRepository preferences_repository{"c:\\users\\a\\b\\c\\d\\e\\f"};
  json result = preferences_repository.LoadPreferences();
  EXPECT_TRUE(result.empty());
}

TEST(PreferencesRepository, RecoverFromBadPreferences) {
  std::optional<std::filesystem::path> app_data_path =
      api::ImplementationPlatform::CreateDeviceInfo()->GetLocalAppDataPath();
  ASSERT_TRUE(app_data_path.has_value());
  std::filesystem::path full_path = *app_data_path / kPreferencesPath;
  std::filesystem::path full_name = full_path / kPreferencesFileName;

  if (std::filesystem::exists(full_name)) {
    std::filesystem::remove(full_name);
  }

  std::ofstream pref_file(full_name.c_str());
  pref_file << "\"Bad top level object\"";
  pref_file.close();

  PreferencesRepository preferences_repository{full_path.string()};
  EXPECT_EQ(preferences_repository.LoadPreferences(), json::object());
}

TEST(PreferencesRepository, SaveAndLoadPreferences) {
  std::optional<std::filesystem::path> app_data_path =
      api::ImplementationPlatform::CreateDeviceInfo()->GetLocalAppDataPath();
  ASSERT_TRUE(app_data_path.has_value());
  std::filesystem::path full_path = *app_data_path / kPreferencesPath;
  std::filesystem::path full_name = full_path / kPreferencesFileName;

  if (std::filesystem::exists(full_name)) {
    std::filesystem::remove(full_name);
  }

  PreferencesRepository preferences_repository{full_path.string()};
  json data;
  data["key1"] = "value1";
  data["key2"] = "value2";
  EXPECT_TRUE(preferences_repository.SavePreferences(data));
  json result = preferences_repository.LoadPreferences();
  EXPECT_EQ(result.size(), 2);
  EXPECT_EQ(result["key1"], "value1");
  EXPECT_EQ(result["key2"], "value2");
  std::filesystem::remove(full_name);
}

TEST(PreferencesRepository, LoadFromBackup) {
  std::optional<std::filesystem::path> app_data_path =
      api::ImplementationPlatform::CreateDeviceInfo()->GetLocalAppDataPath();
  ASSERT_TRUE(app_data_path.has_value());
  std::filesystem::path full_path = *app_data_path / kPreferencesPath;
  std::filesystem::path full_name = full_path / kPreferencesFileName;
  std::filesystem::path full_name_backup =
      full_path / kPreferencesBackupFileName;

  if (std::filesystem::exists(full_name)) {
    std::filesystem::remove(full_name);
  }

  if (std::filesystem::exists(full_name_backup)) {
    std::filesystem::remove(full_name_backup);
  }

  PreferencesRepository preferences_repository{full_path.string()};
  json data;
  data["key1"] = "value1";
  data["key2"] = "value2";

  std::ofstream backup_file(full_name_backup.c_str());
  backup_file << data;
  backup_file.close();

  std::optional<json> result;
  result = preferences_repository.AttemptLoad();
  EXPECT_FALSE(result.has_value());
  result = preferences_repository.RestoreFromBackup();
  EXPECT_TRUE(result.has_value());
  EXPECT_EQ(result.value()["key1"], "value1");
  EXPECT_EQ(result.value()["key2"], "value2");
  std::filesystem::remove(full_name);
  EXPECT_FALSE(std::filesystem::exists(full_name_backup));
}

TEST(PreferencesRepository, RecoverFromCorruption) {
  std::optional<std::filesystem::path> app_data_path =
      api::ImplementationPlatform::CreateDeviceInfo()->GetLocalAppDataPath();
  ASSERT_TRUE(app_data_path.has_value());
  std::filesystem::path full_path = *app_data_path / kPreferencesPath;
  std::filesystem::path full_name = full_path / kPreferencesFileName;
  std::filesystem::path full_name_backup =
      full_path / kPreferencesBackupFileName;

  if (std::filesystem::exists(full_name)) {
    std::filesystem::remove(full_name);
  }

  if (std::filesystem::exists(full_name_backup)) {
    std::filesystem::remove(full_name_backup);
  }

  PreferencesRepository preferences_repository{full_path.string()};
  json data;
  data["key1"] = "value1";
  data["key2"] = "value2";

  std::ofstream preferences_file(full_name_backup.c_str());
  preferences_file << data;
  preferences_file.close();

  std::ofstream backup_file(full_name.c_str());
  backup_file << "[BAD JSON FILE]";
  backup_file.close();

  std::optional<json> result = preferences_repository.LoadPreferences();
  EXPECT_EQ(result.value()["key1"], "value1");
  EXPECT_EQ(result.value()["key2"], "value2");
  std::filesystem::remove(full_name);
  EXPECT_FALSE(std::filesystem::exists(full_name_backup));
}

}  // namespace
}  // namespace linux
}  // namespace nearby