Save fullscreen and read server, password and debug from config.ini
The settings the game saves itself, the quiz settings and now fullscreen, move to settings.cfg (settings_debug.cfg in debug mode). config.ini in the same folder is edited by hand: the server to start with, the API password and debug mode. The game writes it with everything commented out when it is missing and never changes it after that. IniFile reads it: plain key = value lines, whole-line # or ; comments and optional quotes.
This commit is contained in:
Sansan committed
1 parent
92e3a66075
commit
d21b3e2ce0
13 files changed
+491
-163
No files matched your search
@@ -174,6 +174,6 @@ func test_changes_are_saved_at_once() -> void:
|
||||
_card.lower_winning_score_button.pressed.emit()
|
||||
|
||||
var saved: ConfigFile = ConfigFile.new()
|
||||
assert_int(saved.load(Settings.quiz_settings_path())).is_equal(OK)
|
||||
assert_int(saved.load(Settings.saved_settings_path())).is_equal(OK)
|
||||
assert_bool(saved.get_value("quiz", "hide_next_track")).is_false()
|
||||
assert_int(saved.get_value("quiz", "winning_score")).is_equal(19)
|
||||
@@ -35,10 +35,10 @@ func test_statistics_settings_are_not_saved_with_the_quiz_settings() -> void:
|
||||
Settings.add_to_stats = false
|
||||
Settings.use_low_played_mode = true
|
||||
|
||||
Settings.save_quiz_settings()
|
||||
Settings.save_settings()
|
||||
|
||||
var saved: ConfigFile = ConfigFile.new()
|
||||
assert_int(saved.load(Settings.quiz_settings_path())).is_equal(OK)
|
||||
assert_int(saved.load(Settings.saved_settings_path())).is_equal(OK)
|
||||
assert_bool(saved.has_section_key("quiz", "add_to_stats")).is_false()
|
||||
assert_bool(saved.has_section_key("quiz", "use_low_played_mode")).is_false()
|
||||
|
||||
|
||||
@@ -0,0 +1,74 @@
|
||||
extends GdUnitTestSuite
|
||||
## The small INI reader used for the hand-edited config file.
|
||||
|
||||
|
||||
func test_reads_sections_and_settings() -> void:
|
||||
var ini: IniFile = IniFile.parse("[server]\nurl = http://a:8080\n[game]\ndebug=true\n")
|
||||
|
||||
assert_str(ini.get_string("server", "url")).is_equal("http://a:8080")
|
||||
assert_bool(ini.get_bool("game", "debug", false)).is_true()
|
||||
assert_array(ini.get_sections()).contains_exactly(["server", "game"])
|
||||
|
||||
|
||||
func test_comment_lines_are_skipped() -> void:
|
||||
var ini: IniFile = IniFile.parse("; one\n# two\n[server]\n;url = a\n # url = b\n")
|
||||
|
||||
assert_bool(ini.has_value("server", "url")).is_false()
|
||||
assert_array(ini.get_sections()).is_empty()
|
||||
|
||||
|
||||
func test_values_keep_comment_characters() -> void:
|
||||
var ini: IniFile = IniFile.parse("[server]\npassword = a;b#c=d\n")
|
||||
|
||||
assert_str(ini.get_string("server", "password")).is_equal("a;b#c=d")
|
||||
|
||||
|
||||
func test_quotes_around_a_value_are_removed() -> void:
|
||||
var ini: IniFile = IniFile.parse("[a]\none = \"x y\"\ntwo = 'z'\nthree = \"half\n")
|
||||
|
||||
assert_str(ini.get_string("a", "one")).is_equal("x y")
|
||||
assert_str(ini.get_string("a", "two")).is_equal("z")
|
||||
assert_str(ini.get_string("a", "three")).is_equal("\"half")
|
||||
|
||||
|
||||
func test_names_are_not_case_sensitive() -> void:
|
||||
var ini: IniFile = IniFile.parse("[Server]\nURL = http://a\n")
|
||||
|
||||
assert_str(ini.get_string("server", "url")).is_equal("http://a")
|
||||
|
||||
|
||||
func test_empty_value_is_an_empty_string() -> void:
|
||||
var ini: IniFile = IniFile.parse("[server]\npassword =\n")
|
||||
|
||||
assert_bool(ini.has_value("server", "password")).is_true()
|
||||
assert_str(ini.get_string("server", "password", "default")).is_empty()
|
||||
|
||||
|
||||
func test_missing_setting_gives_the_default() -> void:
|
||||
var ini: IniFile = IniFile.parse("")
|
||||
|
||||
assert_str(ini.get_string("server", "url", "fallback")).is_equal("fallback")
|
||||
assert_bool(ini.get_bool("game", "debug", true)).is_true()
|
||||
|
||||
|
||||
func test_bool_words() -> void:
|
||||
var ini: IniFile = IniFile.parse("[a]\nb = Yes\nc = off\nd = 1\ne = maybe\n")
|
||||
|
||||
assert_bool(ini.get_bool("a", "b", false)).is_true()
|
||||
assert_bool(ini.get_bool("a", "c", true)).is_false()
|
||||
assert_bool(ini.get_bool("a", "d", false)).is_true()
|
||||
assert_bool(ini.get_bool("a", "e", false)).is_false()
|
||||
assert_bool(ini.get_bool("a", "e", true)).is_true()
|
||||
|
||||
|
||||
func test_windows_line_endings() -> void:
|
||||
var ini: IniFile = IniFile.parse("[server]\r\nurl = http://a\r\n")
|
||||
|
||||
assert_str(ini.get_string("server", "url")).is_equal("http://a")
|
||||
|
||||
|
||||
func test_lines_that_are_not_settings_are_skipped() -> void:
|
||||
var ini: IniFile = IniFile.parse("[a]\njust words\n= no key\nkey = value\n")
|
||||
|
||||
assert_str(ini.get_string("a", "key")).is_equal("value")
|
||||
assert_bool(ini.has_value("a", "just words")).is_false()
|
||||
@@ -0,0 +1 @@
|
||||
uid://cvc8j1xrxq8uo
|
||||
@@ -1,97 +0,0 @@
|
||||
extends GdUnitTestSuite
|
||||
## Saving the quiz settings to a file in the config folder and loading them back.
|
||||
|
||||
const SAVED_VALUES: Dictionary = {
|
||||
&"auto_repeat_song": false, &"stop_after_current": false, &"hide_next_track": false,
|
||||
&"hide_beginning": true, &"hide_for_seconds": 7.0, &"hide_length": true,
|
||||
&"hide_ticks": true, &"winning_score": 13, &"inspiration_list_speed": 4,
|
||||
}
|
||||
|
||||
var _snapshot: AutoloadSnapshot
|
||||
var _config_dir_before: String
|
||||
var _config_dir: String
|
||||
|
||||
|
||||
func before_test() -> void:
|
||||
_snapshot = AutoloadSnapshot.take([Settings])
|
||||
_config_dir_before = OS.get_environment(Settings.CONFIG_DIR_ENV)
|
||||
_config_dir = create_temp_dir("quiz_settings_file")
|
||||
OS.set_environment(Settings.CONFIG_DIR_ENV, _config_dir)
|
||||
DirAccess.remove_absolute(Settings.quiz_settings_path())
|
||||
|
||||
|
||||
func after_test() -> void:
|
||||
OS.set_environment(Settings.CONFIG_DIR_ENV, _config_dir_before)
|
||||
_snapshot.restore()
|
||||
|
||||
|
||||
func _set_settings(values: Dictionary) -> void:
|
||||
for setting: StringName in values:
|
||||
Settings.set(setting, values[setting])
|
||||
|
||||
|
||||
func test_saved_settings_load_back() -> void:
|
||||
_set_settings(SAVED_VALUES)
|
||||
Settings.save_quiz_settings()
|
||||
_snapshot.restore()
|
||||
|
||||
Settings.load_quiz_settings()
|
||||
|
||||
for setting: StringName in SAVED_VALUES:
|
||||
assert_that(Settings.get(setting)).override_failure_message(setting) \
|
||||
.is_equal(SAVED_VALUES[setting])
|
||||
|
||||
|
||||
func test_every_quiz_setting_is_saved() -> void:
|
||||
assert_array(Settings.QUIZ_SETTINGS).contains_exactly_in_any_order(SAVED_VALUES.keys())
|
||||
|
||||
|
||||
func test_missing_file_keeps_the_current_settings() -> void:
|
||||
Settings.winning_score = 9
|
||||
|
||||
Settings.load_quiz_settings()
|
||||
|
||||
assert_int(Settings.winning_score).is_equal(9)
|
||||
|
||||
|
||||
func test_value_of_the_wrong_type_is_ignored() -> void:
|
||||
var file: ConfigFile = ConfigFile.new()
|
||||
file.set_value("quiz", "winning_score", "lots")
|
||||
file.set_value("quiz", "hide_ticks", true)
|
||||
DirAccess.make_dir_recursive_absolute(Settings.quiz_settings_path().get_base_dir())
|
||||
file.save(Settings.quiz_settings_path())
|
||||
Settings.winning_score = 9
|
||||
Settings.hide_ticks = false
|
||||
|
||||
Settings.load_quiz_settings()
|
||||
|
||||
assert_int(Settings.winning_score).is_equal(9)
|
||||
assert_bool(Settings.hide_ticks).is_true()
|
||||
|
||||
|
||||
func test_statistics_settings_are_not_saved() -> void:
|
||||
Settings.save_quiz_settings()
|
||||
|
||||
var file: ConfigFile = ConfigFile.new()
|
||||
file.load(Settings.quiz_settings_path())
|
||||
assert_bool(file.has_section_key("quiz", "add_to_stats")).is_false()
|
||||
assert_bool(file.has_section_key("quiz", "use_low_played_mode")).is_false()
|
||||
|
||||
|
||||
func test_file_is_in_the_folder_from_the_environment() -> void:
|
||||
assert_str(Settings.quiz_settings_path().get_base_dir()).is_equal(_config_dir)
|
||||
|
||||
|
||||
func test_file_is_in_the_config_folder_without_the_environment() -> void:
|
||||
OS.unset_environment(Settings.CONFIG_DIR_ENV)
|
||||
|
||||
assert_str(Settings.quiz_settings_path().get_base_dir()) \
|
||||
.is_equal(OS.get_config_dir().path_join("MusicPlayer"))
|
||||
|
||||
|
||||
func test_debug_builds_use_a_file_of_their_own() -> void:
|
||||
Settings.is_debug = true
|
||||
var debug_path: String = Settings.quiz_settings_path()
|
||||
Settings.is_debug = false
|
||||
|
||||
assert_str(debug_path).is_not_equal(Settings.quiz_settings_path())
|
||||
@@ -0,0 +1,203 @@
|
||||
extends GdUnitTestSuite
|
||||
## The settings files in the config folder: the settings the game saves by itself, and the
|
||||
## config file with the server, password and debug mode that the user edits by hand.
|
||||
|
||||
const SAVED_VALUES: Dictionary = {
|
||||
&"auto_repeat_song": false, &"stop_after_current": false, &"hide_next_track": false,
|
||||
&"hide_beginning": true, &"hide_for_seconds": 7.0, &"hide_length": true,
|
||||
&"hide_ticks": true, &"winning_score": 13, &"inspiration_list_speed": 4,
|
||||
&"fullscreen": true,
|
||||
}
|
||||
|
||||
var _snapshot: AutoloadSnapshot
|
||||
var _config_dir_before: String
|
||||
var _config_dir: String
|
||||
|
||||
|
||||
func before_test() -> void:
|
||||
_snapshot = AutoloadSnapshot.take([Settings])
|
||||
_config_dir_before = OS.get_environment(Settings.CONFIG_DIR_ENV)
|
||||
_config_dir = create_temp_dir("settings_files")
|
||||
OS.set_environment(Settings.CONFIG_DIR_ENV, _config_dir)
|
||||
DirAccess.remove_absolute(Settings.saved_settings_path())
|
||||
DirAccess.remove_absolute(Settings.config_path())
|
||||
|
||||
|
||||
func after_test() -> void:
|
||||
OS.set_environment(Settings.CONFIG_DIR_ENV, _config_dir_before)
|
||||
_snapshot.restore()
|
||||
|
||||
|
||||
func _set_settings(values: Dictionary) -> void:
|
||||
for setting: StringName in values:
|
||||
Settings.set(setting, values[setting])
|
||||
|
||||
|
||||
func _write_config(text: String) -> void:
|
||||
var file: FileAccess = FileAccess.open(Settings.config_path(), FileAccess.WRITE)
|
||||
file.store_string(text)
|
||||
file.close()
|
||||
|
||||
|
||||
func _saved_file() -> ConfigFile:
|
||||
var file: ConfigFile = ConfigFile.new()
|
||||
assert_int(file.load(Settings.saved_settings_path())).is_equal(OK)
|
||||
return file
|
||||
|
||||
|
||||
func test_saved_settings_load_back() -> void:
|
||||
_set_settings(SAVED_VALUES)
|
||||
Settings.save_settings()
|
||||
_snapshot.restore()
|
||||
|
||||
Settings.load_saved_settings()
|
||||
|
||||
for setting: StringName in SAVED_VALUES:
|
||||
assert_that(Settings.get(setting)).override_failure_message(setting) \
|
||||
.is_equal(SAVED_VALUES[setting])
|
||||
|
||||
|
||||
func test_every_saved_setting_is_tested() -> void:
|
||||
var saved: Array = []
|
||||
for section: String in Settings.SAVED_SETTINGS:
|
||||
saved.append_array(Settings.SAVED_SETTINGS[section])
|
||||
|
||||
assert_array(saved).contains_exactly_in_any_order(SAVED_VALUES.keys())
|
||||
|
||||
|
||||
func test_missing_file_keeps_the_current_settings() -> void:
|
||||
Settings.winning_score = 9
|
||||
|
||||
Settings.load_saved_settings()
|
||||
|
||||
assert_int(Settings.winning_score).is_equal(9)
|
||||
|
||||
|
||||
func test_value_of_the_wrong_type_is_ignored() -> void:
|
||||
var file: ConfigFile = ConfigFile.new()
|
||||
file.set_value("quiz", "winning_score", "lots")
|
||||
file.set_value("quiz", "hide_ticks", true)
|
||||
file.save(Settings.saved_settings_path())
|
||||
Settings.winning_score = 9
|
||||
Settings.hide_ticks = false
|
||||
|
||||
Settings.load_saved_settings()
|
||||
|
||||
assert_int(Settings.winning_score).is_equal(9)
|
||||
assert_bool(Settings.hide_ticks).is_true()
|
||||
|
||||
|
||||
func test_statistics_settings_are_not_saved() -> void:
|
||||
Settings.save_settings()
|
||||
|
||||
var file: ConfigFile = _saved_file()
|
||||
assert_bool(file.has_section_key("quiz", "add_to_stats")).is_false()
|
||||
assert_bool(file.has_section_key("quiz", "use_low_played_mode")).is_false()
|
||||
|
||||
|
||||
func test_fullscreen_is_saved_when_it_changes() -> void:
|
||||
Settings.set_fullscreen(true)
|
||||
assert_bool(_saved_file().get_value("window", "fullscreen")).is_true()
|
||||
|
||||
Settings.set_fullscreen(false)
|
||||
assert_bool(_saved_file().get_value("window", "fullscreen")).is_false()
|
||||
|
||||
|
||||
func test_files_are_in_the_folder_from_the_environment() -> void:
|
||||
assert_str(Settings.saved_settings_path().get_base_dir()).is_equal(_config_dir)
|
||||
assert_str(Settings.config_path().get_base_dir()).is_equal(_config_dir)
|
||||
|
||||
|
||||
func test_files_are_in_the_config_folder_without_the_environment() -> void:
|
||||
OS.unset_environment(Settings.CONFIG_DIR_ENV)
|
||||
|
||||
assert_str(Settings.config_dir()).is_equal(OS.get_config_dir().path_join("MusicPlayer"))
|
||||
|
||||
|
||||
func test_debug_mode_saves_to_a_file_of_its_own() -> void:
|
||||
Settings.is_debug = true
|
||||
var debug_path: String = Settings.saved_settings_path()
|
||||
Settings.is_debug = false
|
||||
|
||||
assert_str(debug_path).is_not_equal(Settings.saved_settings_path())
|
||||
|
||||
|
||||
func test_missing_config_file_is_written_with_everything_commented_out() -> void:
|
||||
var config: IniFile = Settings.load_config()
|
||||
|
||||
assert_bool(FileAccess.file_exists(Settings.config_path())).is_true()
|
||||
assert_array(config.get_sections()).is_empty()
|
||||
var text: String = FileAccess.get_file_as_string(Settings.config_path())
|
||||
for setting: String in ["#url = ", "#password =", "#debug = "]:
|
||||
assert_str(text).contains(setting)
|
||||
|
||||
|
||||
func test_commented_out_config_gives_the_defaults() -> void:
|
||||
Settings.apply_config(Settings.load_config())
|
||||
|
||||
assert_bool(Settings.is_debug).is_equal(OS.has_feature("debug"))
|
||||
var server: String = Settings.DEBUG_SERVER if Settings.is_debug else Settings.SERVERS[0]
|
||||
assert_str(Settings.default_path).is_equal(server)
|
||||
assert_str(Settings.api_password).is_empty()
|
||||
|
||||
|
||||
func test_config_sets_server_password_and_debug() -> void:
|
||||
_write_config("[server]\nurl = https://tmusic.sanplex.xyz/\n"
|
||||
+ "password = secret\n[game]\ndebug = false\n")
|
||||
|
||||
Settings.apply_config(Settings.load_config())
|
||||
|
||||
assert_bool(Settings.is_debug).is_false()
|
||||
assert_str(Settings.default_path).is_equal("https://tmusic.sanplex.xyz")
|
||||
assert_int(Settings.selected_server).is_equal(1)
|
||||
assert_array(Settings.servers).is_equal(Settings.SERVERS)
|
||||
assert_str(Settings.api_password).is_equal("secret")
|
||||
|
||||
|
||||
func test_server_not_in_the_list_is_added_to_it() -> void:
|
||||
_write_config("[server]\nurl = http://music.home:9000\n")
|
||||
|
||||
Settings.apply_config(Settings.load_config())
|
||||
|
||||
assert_str(Settings.default_path).is_equal("http://music.home:9000")
|
||||
assert_str(Settings.servers[Settings.selected_server]).is_equal("http://music.home:9000")
|
||||
assert_int(Settings.servers.size()).is_equal(Settings.SERVERS.size() + 1)
|
||||
|
||||
|
||||
func test_debug_mode_from_the_config_uses_the_local_server() -> void:
|
||||
_write_config("[game]\ndebug = true\n")
|
||||
|
||||
Settings.apply_config(Settings.load_config())
|
||||
|
||||
assert_bool(Settings.is_debug).is_true()
|
||||
assert_str(Settings.default_path).is_equal(Settings.DEBUG_SERVER)
|
||||
assert_int(Settings.winning_score).is_equal(Settings.DEBUG_WINNING_SCORE)
|
||||
|
||||
|
||||
func test_both_comment_styles_work() -> void:
|
||||
_write_config("# hash comment\n[server]\n; semicolon comment\n#url = http://a\n"
|
||||
+ "password = pa;ss#word\n # indented\n[game]\ndebug = false\n")
|
||||
|
||||
Settings.apply_config(Settings.load_config())
|
||||
|
||||
assert_str(Settings.api_password).is_equal("pa;ss#word")
|
||||
assert_bool(Settings.is_debug).is_false()
|
||||
assert_str(Settings.default_path).is_equal(Settings.SERVERS[0])
|
||||
|
||||
|
||||
func test_config_value_of_the_wrong_type_is_ignored() -> void:
|
||||
_write_config("[game]\ndebug = maybe\n")
|
||||
|
||||
Settings.apply_config(Settings.load_config())
|
||||
|
||||
assert_bool(Settings.is_debug).is_equal(OS.has_feature("debug"))
|
||||
|
||||
|
||||
func test_config_file_is_never_overwritten() -> void:
|
||||
_write_config("; mine\n[server]\npassword = secret\n")
|
||||
|
||||
Settings.load_config()
|
||||
Settings.save_settings()
|
||||
|
||||
assert_str(FileAccess.get_file_as_string(Settings.config_path())) \
|
||||
.is_equal("; mine\n[server]\npassword = secret\n")
|
||||
File renamed without changes.
Reference in new issue
Block a user