Add new flags to asset stream manager (#10)

- Add --config-file option defining Json configuration file for asset stream manager
- Add log_dir flag for log folder
- Remove unused functions from SdkUtils
- Fix build issue in cdc_fuse_fs
This commit is contained in:
wurwunchik
2022-11-22 12:05:48 +01:00
committed by GitHub
parent 0252d51cc0
commit b2c011cc0d
6 changed files with 32 additions and 73 deletions

View File

@@ -12,7 +12,6 @@ cc_binary(
"//cdc_stream", "//cdc_stream",
"//common:log", "//common:log",
"//common:path", "//common:path",
"//common:sdk_util",
"//data_store:data_provider", "//data_store:data_provider",
], ],
) )

View File

@@ -24,7 +24,6 @@
#include "common/log.h" #include "common/log.h"
#include "common/path.h" #include "common/path.h"
#include "common/process.h" #include "common/process.h"
#include "common/sdk_util.h"
#include "common/status_macros.h" #include "common/status_macros.h"
#include "data_store/data_provider.h" #include "data_store/data_provider.h"
#include "data_store/disk_data_store.h" #include "data_store/disk_data_store.h"
@@ -67,14 +66,25 @@ absl::Status Run(const AssetStreamConfig& cfg) {
return absl::OkStatus(); return absl::OkStatus();
} }
void InitLogging(bool log_to_stdout, int verbosity) { std::string GetLogPath(const char* log_dir, const char* log_base_name) {
DefaultSystemClock* clock = DefaultSystemClock::GetInstance();
std::string timestamp_ext = clock->FormatNow(".%Y%m%d-%H%M%S.log", false);
return path::Join(log_dir, log_base_name + timestamp_ext);
}
void InitLogging(std::string& log_dir, bool log_to_stdout, int verbosity) {
LogLevel level = cdc_ft::Log::VerbosityToLogLevel(verbosity); LogLevel level = cdc_ft::Log::VerbosityToLogLevel(verbosity);
if (log_to_stdout) { if (log_to_stdout) {
cdc_ft::Log::Initialize(std::make_unique<cdc_ft::ConsoleLog>(level)); cdc_ft::Log::Initialize(std::make_unique<cdc_ft::ConsoleLog>(level));
} else { } else {
SdkUtil util; if (path::ExpandPathVariables(&log_dir).ok() &&
path::CreateDirRec(log_dir).ok()) {
cdc_ft::Log::Initialize(std::make_unique<cdc_ft::FileLog>( cdc_ft::Log::Initialize(std::make_unique<cdc_ft::FileLog>(
level, util.GetLogPath("assets_stream_manager_v3").c_str())); level, GetLogPath(log_dir.c_str(), "assets_stream_manager").c_str()));
} else {
LOG_ERROR("Failed to create log directory '%s'", log_dir);
exit(1);
}
} }
} }
@@ -113,17 +123,22 @@ ABSL_FLAG(int, manifest_updater_threads, 4,
"Number of threads used to compute file hashes on the workstation."); "Number of threads used to compute file hashes on the workstation.");
ABSL_FLAG(int, file_change_wait_duration_ms, 500, ABSL_FLAG(int, file_change_wait_duration_ms, 500,
"Time in milliseconds to wait until pushing a file change to the " "Time in milliseconds to wait until pushing a file change to the "
"instance after detecting it."); "instance after detecting it");
ABSL_FLAG(bool, check, false, "Check FUSE consistency and log check results"); ABSL_FLAG(bool, check, false, "Check FUSE consistency and log check results");
ABSL_FLAG(bool, log_to_stdout, false, "Log to stdout instead of to a file"); ABSL_FLAG(bool, log_to_stdout, false, "Log to stdout instead of to a file");
ABSL_FLAG(cdc_ft::JedecSize, cache_capacity, ABSL_FLAG(cdc_ft::JedecSize, cache_capacity,
cdc_ft::JedecSize(cdc_ft::DiskDataStore::kDefaultCapacity), cdc_ft::JedecSize(cdc_ft::DiskDataStore::kDefaultCapacity),
"Cache capacity. Supports common unit suffixes K, M, G."); "Cache capacity. Supports common unit suffixes K, M, G");
ABSL_FLAG(uint32_t, cleanup_timeout, cdc_ft::DataProvider::kCleanupTimeoutSec, ABSL_FLAG(uint32_t, cleanup_timeout, cdc_ft::DataProvider::kCleanupTimeoutSec,
"Period in seconds at which instance cache cleanups are run"); "Period in seconds at which instance cache cleanups are run");
ABSL_FLAG(uint32_t, access_idle_timeout, cdc_ft::DataProvider::kAccessIdleSec, ABSL_FLAG(uint32_t, access_idle_timeout, cdc_ft::DataProvider::kAccessIdleSec,
"Do not run instance cache cleanups for this many seconds after the " "Do not run instance cache cleanups for this many seconds after the "
"last file access"); "last file access");
ABSL_FLAG(std::string, config_file,
"%APPDATA%\\cdc-file-transfer\\assets_stream_manager.json",
"Json configuration file for asset stream manager");
ABSL_FLAG(std::string, log_dir, "%APPDATA%\\cdc-file-transfer\\logs",
"Directory to store log files for asset stream manager");
// Development args. // Development args.
ABSL_FLAG(std::string, dev_src_dir, "", ABSL_FLAG(std::string, dev_src_dir, "",
@@ -150,21 +165,22 @@ ABSL_FLAG(std::string, dev_mount_dir, "",
int main(int argc, char* argv[]) { int main(int argc, char* argv[]) {
absl::ParseCommandLine(argc, argv); absl::ParseCommandLine(argc, argv);
// Set up config. Allow overriding this config with // Set up config. Allow overriding this config |config_file|.
// %APPDATA%\GGP\services\assets_stream_manager_v3.json.
cdc_ft::SdkUtil sdk_util;
const std::string config_path = cdc_ft::path::Join(
sdk_util.GetServicesConfigPath(), "assets_stream_manager_v3.json");
cdc_ft::AssetStreamConfig cfg; cdc_ft::AssetStreamConfig cfg;
absl::Status cfg_load_status = cfg.LoadFromFile(config_path); std::string config_file = absl::GetFlag(FLAGS_config_file);
absl::Status cfg_load_status =
cdc_ft::path::ExpandPathVariables(&config_file);
cfg_load_status.Update(cfg.LoadFromFile(config_file));
cdc_ft::InitLogging(cfg.log_to_stdout(), cfg.session_cfg().verbosity); std::string log_dir = absl::GetFlag(FLAGS_log_dir);
cdc_ft::InitLogging(log_dir, cfg.log_to_stdout(),
cfg.session_cfg().verbosity);
// Log status of loaded configuration. Errors are not critical. // Log status of loaded configuration. Errors are not critical.
if (cfg_load_status.ok()) { if (cfg_load_status.ok()) {
LOG_INFO("Successfully loaded configuration file at '%s'", config_path); LOG_INFO("Successfully loaded configuration file at '%s'", config_file);
} else if (absl::IsNotFound(cfg_load_status)) { } else if (absl::IsNotFound(cfg_load_status)) {
LOG_INFO("No configuration file found at '%s'", config_path); LOG_INFO("No configuration file found at '%s'", config_file);
} else { } else {
LOG_ERROR("%s", cfg_load_status.message()); LOG_ERROR("%s", cfg_load_status.message());
} }

View File

@@ -91,7 +91,6 @@ cc_library(
"//common:port_manager", "//common:port_manager",
"//common:process", "//common:process",
"//common:remote_util", "//common:remote_util",
"//common:sdk_util",
"//common:status", "//common:status",
"//common:status_macros", "//common:status_macros",
"//common:threadpool", "//common:threadpool",

View File

@@ -35,21 +35,6 @@ SdkUtil::SdkUtil() {
SdkUtil::~SdkUtil() = default; SdkUtil::~SdkUtil() = default;
std::string SdkUtil::GetUserConfigPath() const {
assert(init_status_.ok());
return path::Join(roaming_appdata_path_, "GGP");
}
std::string SdkUtil::GetServicesConfigPath() const {
return path::Join(GetUserConfigPath(), "services");
}
std::string SdkUtil::GetLogPath(const char* log_base_name) const {
DefaultSystemClock clock;
std::string timestamp_ext = clock.FormatNow(".%Y%m%d-%H%M%S.log", false);
return path::Join(GetUserConfigPath(), "logs", log_base_name + timestamp_ext);
}
std::string SdkUtil::GetDevBinPath() const { std::string SdkUtil::GetDevBinPath() const {
return path::Join(ggp_sdk_path_env_, "dev", "bin"); return path::Join(ggp_sdk_path_env_, "dev", "bin");
} }

View File

@@ -35,22 +35,6 @@ class SdkUtil {
SdkUtil(); SdkUtil();
~SdkUtil(); ~SdkUtil();
// Returns the initialization status. Should be OK unless in case of some rare
// internal error. Should be checked before accessing any members.
const absl::Status& GetInitStatus() const { return init_status_; }
// Returns the path of the SDK user configuration, e.g.
// %APPDATA%\GGP.
std::string GetUserConfigPath() const;
// Returns the path of the SDK services configuration, e.g.
// %APPDATA%\GGP\services.
std::string GetServicesConfigPath() const;
// Returns the path of a log file with given |log_base_name|, e.g.
// %APPDATA%\GGP\logs\log_base_name.20210729-125930.log.
std::string GetLogPath(const char* log_base_name) const;
// Returns the path of the dev tools that ship with the SDK, e.g. // Returns the path of the dev tools that ship with the SDK, e.g.
// C:\Program Files\GGP SDK\dev\bin. // C:\Program Files\GGP SDK\dev\bin.
std::string GetDevBinPath() const; std::string GetDevBinPath() const;

View File

@@ -63,19 +63,6 @@ class SdkUtilTest : public ::testing::Test {
std::vector<std::string> test_created_directories_; std::vector<std::string> test_created_directories_;
}; };
TEST_F(SdkUtilTest, CheckRoamingAppDataPaths) {
SdkUtil sdk_util;
EXPECT_OK(sdk_util.GetInitStatus());
std::string appdata_dir;
EXPECT_OK(
path::GetKnownFolderPath(path::FolderId::kRoamingAppData, &appdata_dir));
const std::string ggp_path = path::Join(appdata_dir, "GGP");
EXPECT_EQ(sdk_util.GetUserConfigPath(), ggp_path);
EXPECT_EQ(sdk_util.GetServicesConfigPath(), path::Join(ggp_path, "services"));
}
TEST_F(SdkUtilTest, CheckSdkPathsWithoutGgpSdkPathEnv) { TEST_F(SdkUtilTest, CheckSdkPathsWithoutGgpSdkPathEnv) {
// Clear environment variable and figure out default SDK dir. // Clear environment variable and figure out default SDK dir.
EXPECT_OK(path::SetEnv("GGP_SDK_PATH", "")); EXPECT_OK(path::SetEnv("GGP_SDK_PATH", ""));
@@ -85,17 +72,6 @@ TEST_F(SdkUtilTest, CheckSdkPathsWithoutGgpSdkPathEnv) {
const std::string sdk_dir = path::Join(program_files_dir, "GGP SDK"); const std::string sdk_dir = path::Join(program_files_dir, "GGP SDK");
SdkUtil sdk_util; SdkUtil sdk_util;
EXPECT_OK(sdk_util.GetInitStatus());
CheckSdkPaths(sdk_util, sdk_dir);
}
TEST_F(SdkUtilTest, CheckSdkPathsWithGgpSdkPathEnv) {
// Set a path with unicode character.
std::string sdk_dir = u8"C:\\I\\\\GGP SDK\\";
EXPECT_OK(path::SetEnv("GGP_SDK_PATH", sdk_dir));
SdkUtil sdk_util;
EXPECT_OK(sdk_util.GetInitStatus());
CheckSdkPaths(sdk_util, sdk_dir); CheckSdkPaths(sdk_util, sdk_dir);
} }