mod common;
use common::{TempDir, write};
use fmm_core::settings::{self, Settings};
use std::{collections::HashMap, fs, time::Duration};
fn data(dir: &TempDir) -> std::path::PathBuf {
let data = dir.0.join("user");
write(data.join("mods/mod-list.json"), r#"{"mods":[]}"#);
data
}
#[test]
fn missing_settings_use_defaults_without_creating_a_directory() {
let dir = TempDir::new();
let absent = dir.0.join("absent");
assert_eq!(settings::load(&absent).unwrap(), Settings::default());
assert!(settings::load(&absent).unwrap().verify_downloads);
assert!(!absent.exists());
}
#[test]
fn settings_replace_atomically_and_preserve_other_app_data() {
let dir = TempDir::new();
let data = data(&dir);
let install = dir.0.join("install");
write(
install.join("data/base/info.json"),
r#"{"version":"2.0.77"}"#,
);
write(dir.0.join("metadata/mod_1.json"), "durable");
let mut first =
Settings::from_inputs(data.to_str().unwrap(), install.to_str().unwrap()).unwrap();
settings::save(&dir.0, &first).unwrap();
assert_eq!(settings::load(&dir.0).unwrap(), first);
first.verify_downloads = false;
settings::save(&dir.0, &first).unwrap();
assert!(!settings::load(&dir.0).unwrap().verify_downloads);
assert_eq!(
fs::read_to_string(dir.0.join("metadata/mod_1.json")).unwrap(),
"durable"
);
assert!(
!fs::read_to_string(dir.0.join("settings.json"))
.unwrap()
.contains("catalogueRefresh")
);
assert!(
!fs::read_dir(&dir.0).unwrap().any(|p| p
.unwrap()
.file_name()
.to_string_lossy()
.contains(".tmp"))
);
}
#[test]
fn invalid_settings_never_replace_a_working_file() {
let dir = TempDir::new();
let data = data(&dir);
let valid = Settings::from_inputs(data.to_str().unwrap(), "").unwrap();
settings::save(&dir.0, &valid).unwrap();
let before = fs::read(dir.0.join("settings.json")).unwrap();
for path in ["", "relative", "C:relative"] {
assert!(Settings::from_inputs(path, "").is_err());
}
assert!(Settings::from_inputs(data.to_str().unwrap(), "missing").is_err());
let bad = Settings {
data_dir: Some(dir.0.join("missing")),
..Default::default()
};
assert!(settings::save(&dir.0, &bad).is_err());
write(data.join("mods/mod-list.json"), "broken json");
assert!(Settings::from_inputs(data.to_str().unwrap(), "").is_err());
assert_eq!(fs::read(dir.0.join("settings.json")).unwrap(), before);
}
#[test]
fn legacy_refresh_fields_are_ignored_and_corruption_is_reported_without_rewriting() {
let dir = TempDir::new();
for hours in ["0", "12", "8760", "null", "-1"] {
write(
dir.0.join("settings.json"),
format!(r#"{{"installDir":"","catalogueRefreshHours":{hours}}}"#),
);
let settings = settings::load(&dir.0).unwrap();
assert_eq!(settings.install_dir, None);
assert_eq!(settings.catalogue_ttl(), Duration::from_secs(6 * 3600));
assert!(settings.verify_downloads);
}
for bytes in [
"bad json",
r#"{"dataDir":42}"#,
r#"{"verifyDownloads":"no"}"#,
] {
write(dir.0.join("settings.json"), bytes);
assert!(settings::load(&dir.0).is_err());
assert_eq!(
fs::read_to_string(dir.0.join("settings.json")).unwrap(),
bytes
);
}
}
#[test]
fn environment_paths_and_explicit_data_do_not_use_process_environment() {
let dir = TempDir::new();
let mut env = HashMap::from([
("LOCALAPPDATA".into(), dir.0.to_string_lossy().into_owned()),
(
"XDG_CONFIG_HOME".into(),
dir.0.to_string_lossy().into_owned(),
),
(
"APPDATA".into(),
dir.0.join("roaming").to_string_lossy().into_owned(),
),
("HOME".into(), dir.0.to_string_lossy().into_owned()),
]);
assert_eq!(
settings::settings_dir_with_env(&env).unwrap(),
if cfg!(target_os = "macos") {
dir.0
.join("Library/Application Support/werry/factoriomodmanager")
} else {
dir.0.join("werry/factoriomodmanager")
}
);
let settings = Settings {
data_dir: Some(data(&dir)),
install_dir: Some(dir.0.join("saved-install")),
..Default::default()
};
assert_eq!(
settings.effective_data_dir(&env),
settings.data_dir.clone().unwrap()
);
assert_eq!(settings.effective_install_dir(&env), settings.install_dir);
env.insert(
"FACTORIO_DIR".into(),
dir.0.join("env-install").to_string_lossy().into_owned(),
);
assert_eq!(
settings.effective_install_dir(&env),
Some(dir.0.join("env-install"))
);
env.insert(
"FMM_SETTINGS_DIR".into(),
dir.0.join("settings").to_string_lossy().into_owned(),
);
assert_eq!(
settings::settings_dir_with_env(&env).unwrap(),
dir.0.join("settings")
);
assert!(settings::settings_dir_with_env(&HashMap::new()).is_err());
}
#[test]
fn explicit_data_loads_without_install_and_keeps_all_write_paths_inside_it() {
let dir = TempDir::new();
let data = data(&dir);
#[cfg(target_os = "linux")]
assert!(
fmm_core::store::load_snapshot_with_data(
Some(&dir.0.join("no-install")),
Some(&data),
&dir.0.join("cache")
)
.is_err()
);
#[cfg(target_os = "linux")]
let snapshot = fmm_core::store::load_snapshot_with_data_env(
None,
Some(&data),
&dir.0.join("cache"),
&HashMap::new(),
)
.unwrap();
#[cfg(not(target_os = "linux"))]
let snapshot = fmm_core::store::load_snapshot_with_data(
Some(&dir.0.join("no-install")),
Some(&data),
&dir.0.join("cache"),
)
.unwrap();
assert_eq!(snapshot.paths.user_dir, data);
assert_eq!(snapshot.paths.mods_dir, data.join("mods"));
assert_eq!(
snapshot.paths.mod_list_path,
data.join("mods/mod-list.json")
);
assert_eq!(snapshot.paths.game_version, "unknown");
assert!(snapshot.builtin.is_empty());
assert!(
fmm_core::store::load_snapshot_with_data(
None,
Some(&dir.0.join("missing")),
&dir.0.join("cache")
)
.is_err()
);
}
#[test]
fn ui_sounds_defaults_integer_bounds_types_and_persistence() {
let dir = TempDir::new();
let defaults = settings::load(&dir.0).unwrap();
assert!(defaults.ui_sounds_enabled);
assert_eq!(defaults.ui_sound_volume, 50);
for (json, expected) in [
("{}", 50),
(r#"{"uiSoundVolume":-30}"#, 0),
(r#"{"uiSoundVolume":140}"#, 100),
] {
write(dir.0.join("settings.json"), json);
assert_eq!(settings::load(&dir.0).unwrap().ui_sound_volume, expected);
}
for json in [
r#"{"uiSoundsEnabled":0}"#,
r#"{"uiSoundVolume":12.5}"#,
r#"{"uiSoundVolume":"50"}"#,
r#"{"uiSoundVolume":null}"#,
] {
write(dir.0.join("settings.json"), json);
assert!(settings::load(&dir.0).is_err());
assert_eq!(
fs::read_to_string(dir.0.join("settings.json")).unwrap(),
json
);
}
let saved = Settings {
data_dir: Some(data(&dir)),
ui_sounds_enabled: false,
ui_sound_volume: 27,
..Default::default()
};
settings::save(&dir.0, &saved).unwrap();
assert_eq!(settings::load(&dir.0).unwrap(), saved);
let json = fs::read_to_string(dir.0.join("settings.json")).unwrap();
assert!(json.contains("\"uiSoundsEnabled\": false"));
assert!(json.contains("\"uiSoundVolume\": 27"));
}