Save the quiz and continue it after a restart; load characters from a folder
The quiz is saved to current_quiz.json in the config folder after every change, and the game goes on where it was when it starts again: the players with their points and characters, every song with who got a point for it and whether it was played, answered or is playing, and the songs downloaded ahead with their files. The song that was playing is ready to play again. Songs whose files are gone are downloaded again. On a server, the saved songs are checked against the server's playlist. If it changed, e.g. after a sync, or another server is used, the quiz starts over with the same players. A quiz from a music folder continues offline, including how far a prepared quiz has come. A new game is saved like any other change, and a file that can't be read starts a new quiz. Characters can be read from a folder picked in Settings instead of the server, for this session. A music folder with a characters folder brings its own characters, e.g. for a themed quiz; that folder is not counted as a soundtrack. When the characters come from somewhere else, players pick their characters again. Closes #11, closes #44
This commit is contained in:
Sansan committed
1 parent
4a934840f6
commit
e4352a9f34
33 files changed
+2886
-499
No files matched your search
+1022
-455
File diff suppressed because it is too large.
Load diff
@@ -20,6 +20,10 @@ func before_test() -> void:
|
||||
Playlist.first_song_played = false
|
||||
Playlist.is_song_downloading = false
|
||||
Settings.player_array.clear()
|
||||
Settings.music_folder = null
|
||||
Settings.character_folder = ""
|
||||
# Every test starts a new quiz, unless it saves one in _before_window_starts()
|
||||
QuizSave.delete()
|
||||
Settings.add_to_stats = true
|
||||
Settings.hide_next_track = true
|
||||
Settings.use_low_played_mode = false
|
||||
@@ -55,6 +59,7 @@ func _before_window_starts() -> void:
|
||||
func after_test() -> void:
|
||||
# Let nodes queued for deletion by the window be freed before orphans are counted
|
||||
await await_idle_frame()
|
||||
QuizSave.delete()
|
||||
_server.uninstall()
|
||||
_snapshot.restore()
|
||||
|
||||
|
||||
@@ -163,6 +163,10 @@ static func prepare_autoloads() -> void:
|
||||
Playlist.first_song_played = false
|
||||
Playlist.is_song_downloading = false
|
||||
Settings.player_array.clear()
|
||||
Settings.music_folder = null
|
||||
Settings.character_folder = ""
|
||||
# A quiz saved by an earlier run would be continued
|
||||
QuizSave.delete()
|
||||
Settings.edit_players = false
|
||||
Settings.currently_syncing = false
|
||||
Settings.character_select_open = false
|
||||
@@ -198,7 +202,8 @@ func run(on_state: Callable) -> void:
|
||||
var picture: Image = Image.new()
|
||||
picture.load_png_from_buffer(
|
||||
FileAccess.get_file_as_bytes(CHARACTERS_DIR.path_join(character_names()[0])))
|
||||
_player_row(0).new_character_selected(ImageTexture.create_from_image(picture))
|
||||
_player_row(0).new_character_selected(ImageTexture.create_from_image(picture),
|
||||
character_names()[0])
|
||||
_player_row(0).add_point()
|
||||
_player_row(0).add_point()
|
||||
_player_row(1).add_point()
|
||||
|
||||
@@ -0,0 +1,192 @@
|
||||
extends MainWindowTestSuite
|
||||
## Characters from a folder on this computer: one picked in the settings, or the
|
||||
## characters folder of the music folder played. Players pick again when the characters
|
||||
## change.
|
||||
|
||||
var _settings: SettingsPopup
|
||||
var _mp3: PackedByteArray = FileAccess.get_file_as_bytes("res://tests/data/short.mp3")
|
||||
|
||||
|
||||
func _before_window_starts() -> void:
|
||||
var png: PackedByteArray = Image.create(8, 4, false, Image.FORMAT_RGB8).save_png_to_buffer()
|
||||
_server.respond_json("/character/list", ["Crono.png", "Frog.png"])
|
||||
_server.respond_bytes("/character?name=Crono.png", png)
|
||||
_server.respond_bytes("/character?name=Frog.png", png)
|
||||
|
||||
|
||||
func before_test() -> void:
|
||||
super()
|
||||
_settings = _window.settings_popup
|
||||
await _runner.simulate_frames(2)
|
||||
|
||||
|
||||
func _folder(pictures: Array[String], songs: Array[String] = []) -> String:
|
||||
var root: String = create_temp_dir("character_folders_%d" % randi())
|
||||
for file_name: String in pictures:
|
||||
var path: String = root.path_join(file_name)
|
||||
DirAccess.make_dir_recursive_absolute(path.get_base_dir())
|
||||
FileAccess.open(path, FileAccess.WRITE).store_buffer(
|
||||
Image.create(16, 8, false, Image.FORMAT_RGB8).save_png_to_buffer())
|
||||
for file_name: String in songs:
|
||||
FileAccess.open(root.path_join(file_name), FileAccess.WRITE).store_buffer(_mp3)
|
||||
return root
|
||||
|
||||
|
||||
func _card_names() -> Array[String]:
|
||||
var names: Array[String] = []
|
||||
for card: CharacterCard in _quiz.character_select_popup.character_grid.get_children():
|
||||
if !card.is_queued_for_deletion():
|
||||
names.append(card.character_name)
|
||||
return names
|
||||
|
||||
|
||||
func _pick(player: PlayerObject, character_name: String) -> void:
|
||||
_player_row(player).change_character()
|
||||
await _runner.simulate_frames(1)
|
||||
for card: CharacterCard in _quiz.character_select_popup.character_grid.get_children():
|
||||
if card.character_name == character_name:
|
||||
await _click_at(card.get_global_rect().get_center())
|
||||
return
|
||||
fail("No card for " + character_name)
|
||||
|
||||
|
||||
func test_server_characters_are_shown_at_first() -> void:
|
||||
assert_array(_card_names()).contains_exactly(["Crono.png", "Frog.png"])
|
||||
assert_str(_settings.characters_label.text).is_equal("From the server")
|
||||
assert_bool(_settings.use_server_characters_button.visible).is_false()
|
||||
|
||||
|
||||
func test_picking_a_folder_shows_its_characters() -> void:
|
||||
var folder: String = _folder(["Santa.png", "Elf.jpg"])
|
||||
|
||||
_settings.use_character_folder(folder)
|
||||
await _runner.simulate_frames(1)
|
||||
|
||||
assert_array(_card_names()).contains_exactly(["Elf.jpg", "Santa.png"])
|
||||
assert_str(_settings.characters_label.text).is_equal(folder.get_file())
|
||||
assert_bool(_settings.use_server_characters_button.visible).is_true()
|
||||
|
||||
|
||||
func test_character_from_a_folder_is_picked_with_its_picture_and_name() -> void:
|
||||
_settings.use_character_folder(_folder(["Santa.png"]))
|
||||
var crono: PlayerObject = _add_player("Crono")
|
||||
await _runner.simulate_frames(1)
|
||||
|
||||
await _pick(crono, "Santa.png")
|
||||
|
||||
assert_str(crono.character_name).is_equal("Santa.png")
|
||||
assert_vector(crono.character.get_size()).is_equal(Vector2(16, 8))
|
||||
|
||||
|
||||
func test_picking_a_folder_resets_the_players_characters() -> void:
|
||||
var crono: PlayerObject = _add_player("Crono")
|
||||
await _pick(crono, "Frog.png")
|
||||
assert_str(crono.character_name).is_equal("Frog.png")
|
||||
|
||||
_settings.use_character_folder(_folder(["Santa.png"]))
|
||||
await _runner.simulate_frames(1)
|
||||
|
||||
assert_str(crono.character_name).is_empty()
|
||||
assert_str(crono.character.resource_path).is_equal(PlayerObject.NO_CHARACTER_PATH)
|
||||
assert_object(_player_row(crono).character.texture_normal).is_same(crono.character)
|
||||
|
||||
|
||||
func test_folder_without_pictures_is_not_used() -> void:
|
||||
var crono: PlayerObject = _add_player("Crono")
|
||||
await _pick(crono, "Frog.png")
|
||||
|
||||
_settings.use_character_folder(_folder([], ["01. Song.mp3"]))
|
||||
|
||||
assert_bool(_settings.characters_error_label.visible).is_true()
|
||||
assert_str(_settings.characters_error_label.text).starts_with("No pictures found in")
|
||||
assert_str(Settings.character_folder).is_empty()
|
||||
assert_array(_card_names()).contains_exactly(["Crono.png", "Frog.png"])
|
||||
assert_str(crono.character_name).is_equal("Frog.png")
|
||||
|
||||
|
||||
func test_use_server_goes_back_to_the_server_characters() -> void:
|
||||
_settings.use_character_folder(_folder(["Santa.png"]))
|
||||
var crono: PlayerObject = _add_player("Crono")
|
||||
await _pick(crono, "Santa.png")
|
||||
|
||||
_settings.use_server_characters()
|
||||
await _runner.simulate_frames(1)
|
||||
|
||||
assert_array(_card_names()).contains_exactly(["Crono.png", "Frog.png"])
|
||||
assert_str(_settings.characters_label.text).is_equal("From the server")
|
||||
assert_bool(_settings.use_server_characters_button.visible).is_false()
|
||||
assert_str(crono.character_name).is_empty()
|
||||
|
||||
|
||||
func test_music_folder_with_characters_brings_its_own() -> void:
|
||||
var folder: String = _folder(["characters/Santa.png", "characters/Elf.png"],
|
||||
["01. Jingle Bells.mp3"])
|
||||
var crono: PlayerObject = _add_player("Crono")
|
||||
await _pick(crono, "Frog.png")
|
||||
|
||||
_settings.use_music_folder(folder)
|
||||
await _runner.simulate_frames(2)
|
||||
|
||||
assert_array(_card_names()).contains_exactly(["Elf.png", "Santa.png"])
|
||||
assert_str(_settings.characters_label.text).is_equal("From " + folder.get_file())
|
||||
assert_str(crono.character_name).is_empty()
|
||||
# A prepared quiz with characters is still a prepared quiz
|
||||
assert_bool(Settings.is_prepared_quiz()).is_true()
|
||||
|
||||
|
||||
func test_music_folder_without_characters_keeps_the_server_characters() -> void:
|
||||
var crono: PlayerObject = _add_player("Crono")
|
||||
await _pick(crono, "Frog.png")
|
||||
|
||||
_settings.use_music_folder(_folder([], ["01. Song.mp3"]))
|
||||
await _runner.simulate_frames(2)
|
||||
|
||||
assert_array(_card_names()).contains_exactly(["Crono.png", "Frog.png"])
|
||||
assert_str(crono.character_name).is_equal("Frog.png")
|
||||
|
||||
|
||||
func test_leaving_a_music_folder_with_characters_goes_back_to_the_server() -> void:
|
||||
_settings.use_music_folder(_folder(["characters/Santa.png"], ["01. Song.mp3"]))
|
||||
await _runner.simulate_frames(2)
|
||||
var crono: PlayerObject = _add_player("Crono")
|
||||
await _pick(crono, "Santa.png")
|
||||
|
||||
_settings.use_server()
|
||||
await _runner.simulate_frames(2)
|
||||
|
||||
assert_array(_card_names()).contains_exactly(["Crono.png", "Frog.png"])
|
||||
assert_str(crono.character_name).is_empty()
|
||||
|
||||
|
||||
func test_picked_folder_is_used_before_the_music_folders_characters() -> void:
|
||||
var picked: String = _folder(["Snowman.png"])
|
||||
_settings.use_character_folder(picked)
|
||||
await _runner.simulate_frames(1)
|
||||
|
||||
_settings.use_music_folder(_folder(["characters/Santa.png"], ["01. Song.mp3"]))
|
||||
await _runner.simulate_frames(2)
|
||||
|
||||
assert_array(_card_names()).contains_exactly(["Snowman.png"])
|
||||
assert_str(_settings.characters_label.text).is_equal(picked.get_file())
|
||||
|
||||
|
||||
func test_loading_the_same_characters_again_keeps_the_players_characters() -> void:
|
||||
var crono: PlayerObject = _add_player("Crono")
|
||||
await _pick(crono, "Frog.png")
|
||||
|
||||
# A sync reloads the characters from the same server
|
||||
_quiz.on_sync_finished()
|
||||
await _runner.simulate_frames(2)
|
||||
|
||||
assert_str(crono.character_name).is_equal("Frog.png")
|
||||
|
||||
|
||||
func test_the_characters_folder_is_kept_for_this_session_only() -> void:
|
||||
_settings.use_character_folder(_folder(["Santa.png"]))
|
||||
Settings.save_settings()
|
||||
|
||||
var saved: ConfigFile = ConfigFile.new()
|
||||
saved.load(Settings.saved_settings_path())
|
||||
|
||||
for section: String in saved.get_sections():
|
||||
assert_bool(saved.has_section_key(section, "character_folder")).is_false()
|
||||
@@ -0,0 +1 @@
|
||||
uid://dcjuwndgpwled
|
||||
@@ -24,7 +24,8 @@ func before_test() -> void:
|
||||
super()
|
||||
_picked.clear()
|
||||
_popup = _quiz.get_node("CharacterSelectPopup")
|
||||
_popup.character_selected.connect(func(texture: Texture2D) -> void: _picked.append(texture))
|
||||
_popup.character_selected.connect(
|
||||
func(texture: Texture2D, _name: String) -> void: _picked.append(texture))
|
||||
# Opened from the player's row, like clicking the player's picture
|
||||
_crono = _add_player("Crono")
|
||||
_player_row(_crono).change_character()
|
||||
|
||||
@@ -0,0 +1,413 @@
|
||||
extends MainWindowTestSuite
|
||||
## The quiz is saved after every change and goes on where it was when the game starts
|
||||
## again: players, points, characters and songs, from the server or a music folder. A new
|
||||
## game, a changed server playlist or a file that can't be read start over.
|
||||
|
||||
const SECOND_SONG: Dictionary = {"SongNo": 1, "Soundtrack": "Final Fantasy VI",
|
||||
"Song": "Dancing Mad"}
|
||||
|
||||
var _mp3: PackedByteArray = FileAccess.get_file_as_bytes("res://tests/data/short.mp3")
|
||||
|
||||
|
||||
func _saved() -> QuizSave:
|
||||
# Saving waits until the end of the frame
|
||||
await _runner.simulate_frames(1)
|
||||
return QuizSave.read()
|
||||
|
||||
|
||||
## Closes the game and starts it again, like the user does: everything in memory is gone
|
||||
## and only the files are left. The server answers with [param server_songs] as its
|
||||
## playlist, the songs it handed out before.
|
||||
func _restart_game(server_songs: Array = SONG_INFO) -> void:
|
||||
await _runner.simulate_frames(1)
|
||||
_window.free()
|
||||
Settings.player_array.clear()
|
||||
Settings.music_folder = null
|
||||
Settings.character_folder = ""
|
||||
Settings.add_to_stats = true
|
||||
Playlist.song_object_array.clear()
|
||||
Playlist.currently_playing_song = -1
|
||||
Playlist.latest_played_song = 0
|
||||
Playlist.game_start_song = 0
|
||||
Playlist.first_song_played = false
|
||||
Playlist.is_song_downloading = false
|
||||
Playlist._song_files_written = 0
|
||||
_server.respond_json("/music/list", server_songs)
|
||||
_server.requested_paths.clear()
|
||||
_runner = scene_runner("res://main/MainWindow.tscn")
|
||||
_window = _runner.scene()
|
||||
_quiz = _window.get_node("Quiz")
|
||||
await _runner.simulate_frames(3)
|
||||
|
||||
|
||||
# Crono and Marle play the first song; Crono gets the point and the answer is shown. The
|
||||
# second song is downloaded ahead.
|
||||
func _play_a_little() -> Array[PlayerObject]:
|
||||
var crono: PlayerObject = _add_player("Crono")
|
||||
var marle: PlayerObject = _add_player("Marle")
|
||||
_next_song_is(SECOND_SONG)
|
||||
await _play_first_song()
|
||||
await _give_point_with_keybind(1)
|
||||
_press("SongControls/ShowAnswerButton")
|
||||
await _runner.simulate_frames(2)
|
||||
return [crono, marle]
|
||||
|
||||
|
||||
func _now_playing() -> Array[String]:
|
||||
var now_playing: Node = _quiz.get_node("NowPlaying")
|
||||
return [(now_playing.get_node("SoundtrackLabel") as Label).text,
|
||||
(now_playing.get_node("SongLabel") as Label).text]
|
||||
|
||||
|
||||
# Saving
|
||||
|
||||
func test_players_points_and_songs_are_saved_as_the_quiz_goes_on() -> void:
|
||||
var players: Array[PlayerObject] = await _play_a_little()
|
||||
|
||||
var saved: QuizSave = await _saved()
|
||||
|
||||
assert_array(saved.players.map(func(p: PlayerObject) -> String: return p.player_name)) \
|
||||
.contains_exactly(["Crono", "Marle"])
|
||||
assert_int(saved.players[0].player_score).is_equal(1)
|
||||
assert_int(saved.songs.size()).is_equal(2)
|
||||
assert_array(saved.songs[0].players_given_point).contains_exactly([players[0].id])
|
||||
assert_bool(saved.songs[0].is_answered).is_true()
|
||||
assert_bool(saved.songs[0].is_playing).is_true()
|
||||
assert_bool(saved.songs[1].has_played).is_false()
|
||||
assert_int(saved.currently_playing_song).is_equal(0)
|
||||
|
||||
|
||||
func test_taking_a_point_is_saved() -> void:
|
||||
await _play_a_little()
|
||||
|
||||
await _take_point_with_keybind(1)
|
||||
|
||||
var saved: QuizSave = await _saved()
|
||||
assert_int(saved.players[0].player_score).is_equal(0)
|
||||
assert_array(saved.songs[0].players_given_point).is_empty()
|
||||
|
||||
|
||||
func test_picking_a_character_is_saved() -> void:
|
||||
var crono: PlayerObject = _add_player("Crono")
|
||||
_player_row(crono).change_character()
|
||||
var texture: ImageTexture = ImageTexture.create_from_image(
|
||||
Image.create(4, 4, false, Image.FORMAT_RGB8))
|
||||
|
||||
_quiz.character_select_popup.character_selected.emit(texture, "Frog.png")
|
||||
|
||||
assert_str((await _saved()).players[0].character_name).is_equal("Frog.png")
|
||||
|
||||
|
||||
func test_removing_a_player_is_saved() -> void:
|
||||
var players: Array[PlayerObject] = await _play_a_little()
|
||||
|
||||
await _remove_player(players[0])
|
||||
|
||||
var saved: QuizSave = await _saved()
|
||||
assert_int(saved.players.size()).is_equal(1)
|
||||
assert_array(saved.songs[0].players_given_point).is_empty()
|
||||
|
||||
|
||||
func test_reset_points_saves_a_new_game() -> void:
|
||||
await _play_a_little()
|
||||
|
||||
_press("QuizToolbar/ResetPointsButton")
|
||||
|
||||
var saved: QuizSave = await _saved()
|
||||
assert_int(saved.players.size()).is_equal(2)
|
||||
assert_int(saved.players[0].player_score).is_equal(0)
|
||||
assert_array(saved.songs[0].players_given_point).is_empty()
|
||||
assert_int(saved.game_start_song).is_equal(1)
|
||||
|
||||
|
||||
func test_a_sync_saves_a_new_game() -> void:
|
||||
await _play_a_little()
|
||||
|
||||
_quiz.on_sync_finished()
|
||||
await _runner.simulate_frames(3)
|
||||
|
||||
var saved: QuizSave = await _saved()
|
||||
assert_int(saved.players[0].player_score).is_equal(0)
|
||||
assert_str(saved.players[0].player_name).is_equal("Crono")
|
||||
|
||||
|
||||
func test_winning_is_saved_with_statistics_off() -> void:
|
||||
Settings.winning_score = 1
|
||||
await _play_a_little()
|
||||
|
||||
assert_bool((await _saved()).stats_paused_by_win).is_true()
|
||||
|
||||
|
||||
# Continuing after a restart
|
||||
|
||||
func test_quiz_goes_on_after_a_restart() -> void:
|
||||
var before: Array[PlayerObject] = await _play_a_little()
|
||||
|
||||
await _restart_game([SONG_INFO[0], SECOND_SONG])
|
||||
|
||||
assert_int(Settings.player_array.size()).is_equal(2)
|
||||
var crono: PlayerObject = Settings.player_array[0]
|
||||
assert_str(crono.player_name).is_equal("Crono")
|
||||
assert_str(crono.id).is_equal(before[0].id)
|
||||
assert_int(crono.player_score).is_equal(1)
|
||||
assert_bool(crono.is_first_point).is_false()
|
||||
assert_int(Playlist.song_object_array.size()).is_equal(2)
|
||||
assert_array(Playlist.song_object_array[0].players_given_point).contains_exactly([crono.id])
|
||||
assert_bool(Playlist.song_object_array[0].is_answered).is_true()
|
||||
assert_bool(Playlist.song_object_array[1].has_played).is_false()
|
||||
assert_int(Playlist.currently_playing_song).is_equal(0)
|
||||
assert_array(_now_playing()).contains_exactly(["Chrono Trigger", "Corridors of Time"])
|
||||
# The server's playlist was kept, not reset
|
||||
assert_int(_server.count("/music/reset")).is_equal(0)
|
||||
|
||||
|
||||
func test_players_rows_show_the_saved_scores() -> void:
|
||||
await _play_a_little()
|
||||
|
||||
await _restart_game([SONG_INFO[0], SECOND_SONG])
|
||||
|
||||
var row: PlayerRow = _player_row(Settings.player_array[0])
|
||||
assert_str(row.player_name_field.text).ends_with("Crono: 1")
|
||||
|
||||
|
||||
func test_song_downloaded_ahead_is_kept_and_not_downloaded_again() -> void:
|
||||
await _play_a_little()
|
||||
var file: String = (await _saved()).songs[1].song_path
|
||||
|
||||
await _restart_game([SONG_INFO[0], SECOND_SONG])
|
||||
|
||||
assert_bool(FileAccess.file_exists(file)).is_true()
|
||||
assert_int(_server.count("/music/rand")).is_equal(0)
|
||||
assert_bool((_quiz.get_node("SongControls/NextButton") as Button).disabled).is_false()
|
||||
|
||||
|
||||
func test_next_plays_the_song_downloaded_before_the_restart() -> void:
|
||||
await _play_a_little()
|
||||
await _restart_game([SONG_INFO[0], SECOND_SONG])
|
||||
|
||||
_press("SongControls/NextButton")
|
||||
await await_millis(700)
|
||||
|
||||
assert_int(Playlist.currently_playing_song).is_equal(1)
|
||||
assert_bool(_quiz.music_player.audio_player.playing).is_true()
|
||||
|
||||
|
||||
func test_song_that_was_playing_is_ready_to_play_again() -> void:
|
||||
await _play_a_little()
|
||||
await _restart_game([SONG_INFO[0], SECOND_SONG])
|
||||
var player: MusicPlayer = _quiz.music_player
|
||||
|
||||
assert_object(player.audio_player.stream).is_not_null()
|
||||
assert_bool(player.audio_player.playing).is_false()
|
||||
assert_bool(player.shows_playing()).is_false()
|
||||
|
||||
player.play_or_pause()
|
||||
|
||||
assert_bool(player.audio_player.playing).is_true()
|
||||
|
||||
|
||||
func test_keybinds_give_points_after_a_restart() -> void:
|
||||
await _play_a_little()
|
||||
await _restart_game([SONG_INFO[0], SECOND_SONG])
|
||||
|
||||
await _give_point_with_keybind(2)
|
||||
|
||||
assert_array(_scores()).contains_exactly([1, 1])
|
||||
assert_int((await _saved()).players[1].player_score).is_equal(1)
|
||||
|
||||
|
||||
func test_song_files_that_are_gone_are_downloaded_again() -> void:
|
||||
await _play_a_little()
|
||||
var saved: QuizSave = await _saved()
|
||||
for song_object: SongObject in saved.songs:
|
||||
DirAccess.remove_absolute(song_object.song_path)
|
||||
_server.respond_bytes("/music?song=0", _mp3)
|
||||
_server.respond_bytes("/music?song=1", _mp3)
|
||||
|
||||
await _restart_game([SONG_INFO[0], SECOND_SONG])
|
||||
|
||||
# The song that was playing and the one downloaded ahead
|
||||
assert_int(_server.count("/music?song=0")).is_equal(1)
|
||||
assert_int(_server.count("/music?song=1")).is_equal(1)
|
||||
assert_object(Playlist.get_song(1)).is_not_null()
|
||||
|
||||
|
||||
func test_unused_song_files_are_deleted_at_start() -> void:
|
||||
await _play_a_little()
|
||||
var stray: String = Playlist.songs_folder().path_join("left_over.mp3")
|
||||
FileAccess.open(stray, FileAccess.WRITE).store_buffer(_mp3)
|
||||
|
||||
await _restart_game([SONG_INFO[0], SECOND_SONG])
|
||||
|
||||
assert_bool(FileAccess.file_exists(stray)).is_false()
|
||||
assert_int(DirAccess.get_files_at(Playlist.songs_folder()).size()).is_equal(2)
|
||||
|
||||
|
||||
func test_changed_server_playlist_starts_over_with_the_same_players() -> void:
|
||||
await _play_a_little()
|
||||
|
||||
# The server's playlist was reset, e.g. by a sync from another computer
|
||||
await _restart_game([{"SongNo": 0, "Soundtrack": "Terranigma", "Song": "Underworld"}])
|
||||
|
||||
assert_array(Settings.player_array.map(func(p: PlayerObject) -> String:
|
||||
return p.player_name)).contains_exactly(["Crono", "Marle"])
|
||||
assert_array(_scores()).contains_exactly([0, 0])
|
||||
assert_str(Playlist.song_object_array[0].soundtrack_title).is_equal("Terranigma")
|
||||
assert_bool(Playlist.song_object_array[0].has_played).is_true()
|
||||
|
||||
|
||||
func test_songs_the_server_added_after_the_save_are_kept_as_played() -> void:
|
||||
await _play_a_little()
|
||||
var third: Dictionary = {"SongNo": 2, "Soundtrack": "Terranigma", "Song": "Underworld"}
|
||||
|
||||
await _restart_game([SONG_INFO[0], SECOND_SONG, third])
|
||||
|
||||
assert_int(Playlist.song_object_array.size()).is_equal(3)
|
||||
assert_int(Settings.player_array[0].player_score).is_equal(1)
|
||||
assert_bool(Playlist.song_object_array[2].has_played).is_true()
|
||||
|
||||
|
||||
func test_another_server_starts_over_with_the_same_players() -> void:
|
||||
await _play_a_little()
|
||||
var server_before: String = Settings.default_path
|
||||
Settings.default_path = "https://other.example.com"
|
||||
|
||||
await _restart_game([SONG_INFO[0], SECOND_SONG])
|
||||
|
||||
Settings.default_path = server_before
|
||||
assert_int(Settings.player_array.size()).is_equal(2)
|
||||
assert_array(_scores()).contains_exactly([0, 0])
|
||||
|
||||
|
||||
func test_file_that_cannot_be_read_starts_a_new_quiz() -> void:
|
||||
await _play_a_little()
|
||||
await _runner.simulate_frames(1)
|
||||
FileAccess.open(QuizSave.path(), FileAccess.WRITE).store_string("{ half a fi")
|
||||
|
||||
await _restart_game([SONG_INFO[0], SECOND_SONG])
|
||||
|
||||
assert_array(Settings.player_array).is_empty()
|
||||
# Like any start without a saved quiz: the server's songs count as played, and a new
|
||||
# one is downloaded ahead
|
||||
assert_bool(Playlist.song_object_array[0].has_played).is_true()
|
||||
assert_bool(Playlist.song_object_array[1].has_played).is_true()
|
||||
assert_int(Playlist.song_object_array.size()).is_equal(3)
|
||||
# The broken file is replaced by the new quiz
|
||||
assert_object(await _saved()).is_not_null()
|
||||
|
||||
|
||||
func test_statistics_stay_off_after_a_won_game() -> void:
|
||||
Settings.winning_score = 1
|
||||
await _play_a_little()
|
||||
|
||||
await _restart_game([SONG_INFO[0], SECOND_SONG])
|
||||
|
||||
assert_bool(Settings.add_to_stats).is_false()
|
||||
_press("QuizToolbar/ResetPointsButton")
|
||||
assert_bool(Settings.add_to_stats).is_true()
|
||||
|
||||
|
||||
func test_nothing_is_saved_before_the_saved_songs_are_back() -> void:
|
||||
await _play_a_little()
|
||||
_server.hold("/music/list")
|
||||
await _restart_game([SONG_INFO[0], SECOND_SONG])
|
||||
var file_before: String = FileAccess.get_file_as_string(QuizSave.path())
|
||||
|
||||
# A player added while the server has not answered yet
|
||||
_add_player("Lucca")
|
||||
await _runner.simulate_frames(2)
|
||||
|
||||
assert_str(FileAccess.get_file_as_string(QuizSave.path())).is_equal(file_before)
|
||||
_server.release("/music/list")
|
||||
await _runner.simulate_frames(2)
|
||||
assert_int((await _saved()).players.size()).is_equal(3)
|
||||
assert_int((await _saved()).songs.size()).is_equal(2)
|
||||
|
||||
|
||||
# Characters
|
||||
|
||||
func test_character_picture_comes_back_after_a_restart() -> void:
|
||||
var picture: Image = Image.create(20, 10, false, Image.FORMAT_RGB8)
|
||||
_server.respond_bytes("/character?name=Frog.png", picture.save_png_to_buffer())
|
||||
var crono: PlayerObject = _add_player("Crono")
|
||||
_player_row(crono).new_character_selected(ImageTexture.create_from_image(picture),
|
||||
"Frog.png")
|
||||
_quiz.save_soon()
|
||||
|
||||
await _restart_game()
|
||||
|
||||
crono = Settings.player_array[0]
|
||||
assert_str(crono.character_name).is_equal("Frog.png")
|
||||
assert_vector(crono.character.get_size()).is_equal(Vector2(20, 10))
|
||||
assert_object(_player_row(crono).character.texture_normal).is_same(crono.character)
|
||||
|
||||
|
||||
func test_characters_from_a_folder_picked_for_the_session_are_reset_after_a_restart() -> void:
|
||||
var folder: String = create_temp_dir("session_characters_%d" % randi())
|
||||
FileAccess.open(folder.path_join("Santa.png"), FileAccess.WRITE).store_buffer(
|
||||
Image.create(8, 4, false, Image.FORMAT_RGB8).save_png_to_buffer())
|
||||
_window.settings_popup.use_character_folder(folder)
|
||||
var crono: PlayerObject = _add_player("Crono")
|
||||
_player_row(crono).new_character_selected(ImageTexture.create_from_image(
|
||||
Image.create(8, 4, false, Image.FORMAT_RGB8)), "Santa.png")
|
||||
_quiz.save_soon()
|
||||
|
||||
# The folder is only used until the game is closed
|
||||
await _restart_game()
|
||||
|
||||
assert_str(Settings.player_array[0].character_name).is_empty()
|
||||
assert_str(Settings.player_array[0].character.resource_path) \
|
||||
.is_equal(PlayerObject.NO_CHARACTER_PATH)
|
||||
|
||||
|
||||
# A music folder
|
||||
|
||||
func _prepared_quiz_folder() -> String:
|
||||
var root: String = create_temp_dir("continue_offline_%d" % randi())
|
||||
for file_name: String in ["01. Opening.mp3", "02. Jingle Bells.mp3", "03. Finale.mp3"]:
|
||||
FileAccess.open(root.path_join(file_name), FileAccess.WRITE).store_buffer(_mp3)
|
||||
return root
|
||||
|
||||
|
||||
func test_quiz_from_a_music_folder_goes_on_offline() -> void:
|
||||
var folder: String = _prepared_quiz_folder()
|
||||
_window.settings_popup.use_music_folder(folder)
|
||||
await _runner.simulate_frames(2)
|
||||
_add_player("Crono")
|
||||
_press("SongControls/NextButton")
|
||||
await await_millis(700)
|
||||
await _give_point_with_keybind(1)
|
||||
|
||||
await _restart_game()
|
||||
|
||||
assert_bool(Settings.is_offline()).is_true()
|
||||
assert_str(Settings.music_folder.path).is_equal(folder)
|
||||
assert_bool(_window.top_bar.offline_label.visible).is_true()
|
||||
assert_int(Settings.player_array[0].player_score).is_equal(1)
|
||||
assert_str(Playlist.song_object_array[0].song_title).is_equal("01. Opening")
|
||||
assert_array(_server.requested_paths.filter(func(path: String) -> bool:
|
||||
return path.begins_with("/music"))).is_empty()
|
||||
|
||||
_press("SongControls/NextButton")
|
||||
await await_millis(700)
|
||||
assert_str(Playlist.song_object_array[Playlist.currently_playing_song].song_title) \
|
||||
.is_equal("02. Jingle Bells")
|
||||
|
||||
|
||||
func test_music_folder_that_is_gone_starts_over_with_the_server() -> void:
|
||||
var folder: String = _prepared_quiz_folder()
|
||||
_window.settings_popup.use_music_folder(folder)
|
||||
await _runner.simulate_frames(2)
|
||||
_add_player("Crono")
|
||||
_press("SongControls/NextButton")
|
||||
await await_millis(700)
|
||||
await _give_point_with_keybind(1)
|
||||
for file_name: String in DirAccess.get_files_at(folder):
|
||||
DirAccess.remove_absolute(folder.path_join(file_name))
|
||||
|
||||
await _restart_game()
|
||||
|
||||
assert_bool(Settings.is_offline()).is_false()
|
||||
assert_int(Settings.player_array.size()).is_equal(1)
|
||||
assert_array(_scores()).contains_exactly([0])
|
||||
assert_str(Playlist.song_object_array[0].soundtrack_title).is_equal("Chrono Trigger")
|
||||
@@ -0,0 +1 @@
|
||||
uid://dgxvnsquk18ud
|
||||
@@ -165,8 +165,9 @@ func test_character_button_in_the_player_list_picks_a_new_character() -> void:
|
||||
assert_bool(character_select.visible).is_true()
|
||||
var texture: ImageTexture = ImageTexture.create_from_image(
|
||||
Image.create(4, 4, false, Image.FORMAT_RGBA8))
|
||||
character_select.character_selected.emit(texture)
|
||||
character_select.character_selected.emit(texture, "Frog.png")
|
||||
assert_object(crono.character).is_same(texture)
|
||||
assert_str(crono.character_name).is_equal("Frog.png")
|
||||
|
||||
|
||||
func test_sound_test_button_fetches_the_sound_test_song() -> void:
|
||||
|
||||
@@ -0,0 +1,94 @@
|
||||
extends GdUnitTestSuite
|
||||
## Characters read from a folder on this computer instead of the server.
|
||||
|
||||
var _root: String
|
||||
|
||||
|
||||
func before_test() -> void:
|
||||
_root = create_temp_dir("folder_characters_%d" % randi())
|
||||
|
||||
|
||||
func _picture(file_name: String, size: Vector2i = Vector2i(8, 4)) -> Image:
|
||||
var image: Image = Image.create(size.x, size.y, false, Image.FORMAT_RGB8)
|
||||
image.fill(Color.FIREBRICK)
|
||||
var bytes: PackedByteArray
|
||||
match file_name.get_extension().to_lower():
|
||||
"png":
|
||||
bytes = image.save_png_to_buffer()
|
||||
"jpg", "jpeg":
|
||||
bytes = image.save_jpg_to_buffer()
|
||||
"webp":
|
||||
bytes = image.save_webp_to_buffer()
|
||||
_file(file_name, bytes)
|
||||
return image
|
||||
|
||||
|
||||
func _file(file_name: String, bytes: PackedByteArray) -> void:
|
||||
FileAccess.open(_root.path_join(file_name), FileAccess.WRITE).store_buffer(bytes)
|
||||
|
||||
|
||||
func test_every_picture_is_a_character_in_natural_order() -> void:
|
||||
for file_name: String in ["Santa10.png", "Santa2.jpg", "elf.webp", "Rudolph.JPEG"]:
|
||||
_picture(file_name)
|
||||
|
||||
assert_array(FolderCharacters.picture_names(_root)).contains_exactly(
|
||||
["elf.webp", "Rudolph.JPEG", "Santa2.jpg", "Santa10.png"])
|
||||
|
||||
|
||||
func test_other_and_hidden_files_are_left_out() -> void:
|
||||
_picture("Santa.png")
|
||||
_picture(".hidden.png")
|
||||
_file("notes.txt", "hello".to_utf8_buffer())
|
||||
_file("song.mp3", PackedByteArray([1, 2, 3]))
|
||||
DirAccess.make_dir_absolute(_root.path_join("more.png"))
|
||||
|
||||
assert_array(FolderCharacters.picture_names(_root)).contains_exactly(["Santa.png"])
|
||||
|
||||
|
||||
func test_missing_folder_has_no_characters() -> void:
|
||||
assert_array(FolderCharacters.picture_names(_root.path_join("gone"))).is_empty()
|
||||
|
||||
|
||||
func test_load_list_gives_the_names() -> void:
|
||||
_picture("Santa.png")
|
||||
_picture("Elf.png")
|
||||
var names: Array = []
|
||||
|
||||
FolderCharacters.new(_root).load_list(func(list: Array[String]) -> void: names.assign(list))
|
||||
|
||||
assert_array(names).contains_exactly(["Elf.png", "Santa.png"])
|
||||
|
||||
|
||||
func test_fetch_image_reads_the_picture() -> void:
|
||||
_picture("Santa.webp", Vector2i(20, 10))
|
||||
var pictures: Array[Image] = []
|
||||
|
||||
FolderCharacters.new(_root).fetch_image("Santa.webp",
|
||||
func(picture: Image) -> void: pictures.append(picture))
|
||||
|
||||
assert_int(pictures.size()).is_equal(1)
|
||||
assert_vector(Vector2(pictures[0].get_size())).is_equal(Vector2(20, 10))
|
||||
|
||||
|
||||
func test_fetch_image_of_a_missing_or_broken_picture_gives_nothing() -> void:
|
||||
_file("Broken.png", "not a picture".to_utf8_buffer())
|
||||
var pictures: Array[Image] = []
|
||||
var characters: FolderCharacters = FolderCharacters.new(_root)
|
||||
|
||||
characters.fetch_image("Gone.png", func(picture: Image) -> void: pictures.append(picture))
|
||||
characters.fetch_image("Broken.png", func(picture: Image) -> void: pictures.append(picture))
|
||||
|
||||
assert_array(pictures).is_empty()
|
||||
|
||||
|
||||
func test_names_cannot_reach_outside_the_folder() -> void:
|
||||
var outside: String = _root.get_base_dir().path_join("outside_%d.png" % randi())
|
||||
FileAccess.open(outside, FileAccess.WRITE).store_buffer(
|
||||
Image.create(4, 4, false, Image.FORMAT_RGB8).save_png_to_buffer())
|
||||
var pictures: Array[Image] = []
|
||||
|
||||
FolderCharacters.new(_root).fetch_image("../" + outside.get_file(),
|
||||
func(picture: Image) -> void: pictures.append(picture))
|
||||
|
||||
DirAccess.remove_absolute(outside)
|
||||
assert_array(pictures).is_empty()
|
||||
@@ -0,0 +1 @@
|
||||
uid://du26d6jxqs6gf
|
||||
@@ -200,3 +200,124 @@ func test_display_name_is_the_folder_name() -> void:
|
||||
var folder: MusicFolder = _folder("Musiktävling 2025/")
|
||||
|
||||
assert_str(folder.display_name()).is_equal("Musiktävling 2025")
|
||||
|
||||
|
||||
# A quiz's own characters
|
||||
|
||||
func _picture(relative_path: String) -> void:
|
||||
_file(relative_path, Image.create(8, 4, false, Image.FORMAT_RGB8).save_png_to_buffer())
|
||||
|
||||
|
||||
func test_prepared_quiz_with_a_characters_folder_is_still_a_prepared_quiz() -> void:
|
||||
_song("01. Jingle Bells.mp3")
|
||||
_song("02. Last Christmas.mp3")
|
||||
_picture("characters/Santa.png")
|
||||
|
||||
var folder: MusicFolder = _folder()
|
||||
|
||||
assert_int(folder.kind).is_equal(MusicFolder.Kind.PREPARED_QUIZ)
|
||||
assert_int(folder.quiz_size()).is_equal(2)
|
||||
assert_str(folder.characters_path).is_equal(_root.path_join("characters"))
|
||||
|
||||
|
||||
func test_characters_folder_is_not_a_soundtrack() -> void:
|
||||
_song("Chrono Trigger/Corridors of Time.mp3")
|
||||
_picture("Characters/Frog.png")
|
||||
|
||||
var folder: MusicFolder = _folder()
|
||||
|
||||
assert_int(folder.kind).is_equal(MusicFolder.Kind.SOUNDTRACKS)
|
||||
assert_array(folder.soundtrack_names()).contains_exactly(["Chrono Trigger"])
|
||||
assert_str(folder.characters_path).is_equal(_root.path_join("Characters"))
|
||||
|
||||
|
||||
func test_characters_folder_without_pictures_is_not_used() -> void:
|
||||
_song("01. Opening.mp3")
|
||||
_file("characters/notes.txt", "not a picture".to_utf8_buffer())
|
||||
|
||||
var folder: MusicFolder = _folder()
|
||||
|
||||
assert_int(folder.kind).is_equal(MusicFolder.Kind.PREPARED_QUIZ)
|
||||
assert_str(folder.characters_path).is_empty()
|
||||
|
||||
|
||||
func test_only_a_characters_folder_is_nothing_to_play() -> void:
|
||||
_picture("characters/Santa.png")
|
||||
|
||||
assert_int(_folder().kind).is_equal(MusicFolder.Kind.EMPTY)
|
||||
|
||||
|
||||
func test_folder_without_characters_has_no_characters_path() -> void:
|
||||
_song("Chrono Trigger/Corridors of Time.mp3")
|
||||
|
||||
assert_str(_folder().characters_path).is_empty()
|
||||
|
||||
|
||||
# Continuing a prepared quiz
|
||||
|
||||
func _prepared_quiz(songs: int) -> MusicFolder:
|
||||
for i: int in songs:
|
||||
_song("%02d. Song.mp3" % (i + 1))
|
||||
return _folder()
|
||||
|
||||
|
||||
func test_prepared_quiz_continues_where_it_was() -> void:
|
||||
var folder: MusicFolder = _prepared_quiz(4)
|
||||
folder.next_song()
|
||||
folder.next_song()
|
||||
|
||||
var again: MusicFolder = _folder()
|
||||
assert_bool(again.restore_progress(folder.progress())).is_true()
|
||||
|
||||
assert_str(again.next_song().song_title).is_equal("03. Song")
|
||||
assert_str(again.next_song().song_title).is_equal("04. Song")
|
||||
assert_object(again.next_song()).is_null()
|
||||
|
||||
|
||||
func test_random_prepared_quiz_continues_in_the_same_order() -> void:
|
||||
var folder: MusicFolder = _prepared_quiz(8)
|
||||
folder.set_play_order(MusicFolder.PlayOrder.RANDOM)
|
||||
folder.next_song()
|
||||
var saved: Dictionary = JSON.parse_string(JSON.stringify(folder.progress()))
|
||||
var expected: Array[String] = []
|
||||
for i: int in 7:
|
||||
expected.append(folder.next_song().song_title)
|
||||
|
||||
var again: MusicFolder = _folder()
|
||||
again.restore_progress(saved)
|
||||
|
||||
assert_int(again.play_order).is_equal(MusicFolder.PlayOrder.RANDOM)
|
||||
var titles: Array[String] = []
|
||||
for i: int in 7:
|
||||
titles.append(again.next_song().song_title)
|
||||
assert_array(titles).contains_exactly(expected)
|
||||
|
||||
|
||||
func test_songs_removed_from_the_folder_are_left_out_when_continuing() -> void:
|
||||
var folder: MusicFolder = _prepared_quiz(4)
|
||||
folder.next_song()
|
||||
folder.next_song()
|
||||
var saved: Dictionary = folder.progress()
|
||||
# One played song and one still to play are gone
|
||||
DirAccess.remove_absolute(_root.path_join("01. Song.mp3"))
|
||||
DirAccess.remove_absolute(_root.path_join("04. Song.mp3"))
|
||||
|
||||
var again: MusicFolder = _folder()
|
||||
again.restore_progress(saved)
|
||||
|
||||
assert_str(again.next_song().song_title).is_equal("03. Song")
|
||||
assert_object(again.next_song()).is_null()
|
||||
|
||||
|
||||
func test_progress_that_does_not_fit_changes_nothing() -> void:
|
||||
var folder: MusicFolder = _prepared_quiz(2)
|
||||
|
||||
assert_bool(folder.restore_progress({})).is_false()
|
||||
assert_bool(folder.restore_progress({"queue": "nope", "next": 1})).is_false()
|
||||
assert_str(folder.next_song().song_title).is_equal("01. Song")
|
||||
|
||||
|
||||
func test_soundtrack_folder_has_no_progress_to_continue() -> void:
|
||||
_song("Chrono Trigger/Corridors of Time.mp3")
|
||||
|
||||
assert_bool(_folder().restore_progress({"queue": [], "next": 0})).is_false()
|
||||
@@ -0,0 +1,302 @@
|
||||
extends GdUnitTestSuite
|
||||
## The saved quiz: what is saved from the game, writing and reading the file, and files
|
||||
## that can't be used.
|
||||
|
||||
var _snapshot: AutoloadSnapshot
|
||||
var _config_dir_before: String
|
||||
|
||||
|
||||
func before_test() -> void:
|
||||
_snapshot = AutoloadSnapshot.take([Settings, Playlist])
|
||||
_config_dir_before = OS.get_environment(Settings.CONFIG_DIR_ENV)
|
||||
OS.set_environment(Settings.CONFIG_DIR_ENV, create_temp_dir("quiz_save_%d" % randi()))
|
||||
Settings.is_debug = false
|
||||
Settings.music_folder = null
|
||||
Settings.character_folder = ""
|
||||
Settings.default_path = "https://music.example.com"
|
||||
Settings.player_array.clear()
|
||||
Playlist.song_object_array.clear()
|
||||
|
||||
|
||||
func after_test() -> void:
|
||||
OS.set_environment(Settings.CONFIG_DIR_ENV, _config_dir_before)
|
||||
_snapshot.restore()
|
||||
|
||||
|
||||
func _player(player_name: String, score: int, character: String = "") -> PlayerObject:
|
||||
var player: PlayerObject = PlayerObject.new(player_name)
|
||||
player.player_score = score
|
||||
player.is_first_point = score == 0
|
||||
player.character_name = character
|
||||
Settings.player_array.append(player)
|
||||
return player
|
||||
|
||||
|
||||
func _song(number: int, played: bool, points: Array[String] = []) -> SongObject:
|
||||
var song_object: SongObject = SongObject.new()
|
||||
song_object.song_number = number
|
||||
song_object.soundtrack_title = "Soundtrack %d" % number
|
||||
song_object.song_title = "Song %d" % number
|
||||
song_object.has_played = played
|
||||
song_object.is_answered = played
|
||||
song_object.song_path = "/songs/song_%d.mp3" % number
|
||||
for player_id: String in points:
|
||||
song_object.add_point(player_id)
|
||||
Playlist.song_object_array.append(song_object)
|
||||
return song_object
|
||||
|
||||
|
||||
# A quiz with two players, two played songs and one downloaded ahead
|
||||
func _quiz() -> void:
|
||||
var crono: PlayerObject = _player("Crono", 2, "Crono.png")
|
||||
var marle: PlayerObject = _player("Marle", 1)
|
||||
_song(0, true, [crono.id])
|
||||
_song(1, true, [crono.id, marle.id])
|
||||
_song(2, false)
|
||||
Playlist.song_object_array[1].is_playing = true
|
||||
Playlist.currently_playing_song = 1
|
||||
Playlist.latest_played_song = 1
|
||||
Playlist.game_start_song = 0
|
||||
Playlist.first_song_played = true
|
||||
|
||||
|
||||
func _read_back() -> QuizSave:
|
||||
assert_bool(QuizSave.capture(false).write()).is_true()
|
||||
return QuizSave.read()
|
||||
|
||||
|
||||
# What is saved
|
||||
|
||||
func test_players_are_saved_with_points_and_characters() -> void:
|
||||
_quiz()
|
||||
|
||||
var players: Array[PlayerObject] = _read_back().players
|
||||
|
||||
assert_int(players.size()).is_equal(2)
|
||||
assert_str(players[0].player_name).is_equal("Crono")
|
||||
assert_str(players[0].id).is_equal(Settings.player_array[0].id)
|
||||
assert_int(players[0].player_score).is_equal(2)
|
||||
assert_bool(players[0].is_first_point).is_false()
|
||||
assert_str(players[0].character_name).is_equal("Crono.png")
|
||||
assert_str(players[1].character_name).is_empty()
|
||||
|
||||
|
||||
func test_songs_are_saved_with_who_got_points_and_how_far_they_came() -> void:
|
||||
_quiz()
|
||||
|
||||
var songs: Array[SongObject] = _read_back().songs
|
||||
|
||||
assert_int(songs.size()).is_equal(3)
|
||||
var crono: String = Settings.player_array[0].id
|
||||
var marle: String = Settings.player_array[1].id
|
||||
assert_array(songs[0].players_given_point).contains_exactly([crono])
|
||||
assert_array(songs[1].players_given_point).contains_exactly([crono, marle])
|
||||
assert_bool(songs[1].is_playing).is_true()
|
||||
assert_bool(songs[1].has_played).is_true()
|
||||
assert_bool(songs[2].has_played).is_false()
|
||||
assert_bool(songs[2].is_answered).is_false()
|
||||
assert_str(songs[2].song_title).is_equal("Song 2")
|
||||
assert_str(songs[2].soundtrack_title).is_equal("Soundtrack 2")
|
||||
assert_str(songs[2].song_path).is_equal("/songs/song_2.mp3")
|
||||
|
||||
|
||||
func test_playlist_positions_are_saved() -> void:
|
||||
_quiz()
|
||||
|
||||
var save: QuizSave = _read_back()
|
||||
|
||||
assert_int(save.currently_playing_song).is_equal(1)
|
||||
assert_int(save.latest_played_song).is_equal(1)
|
||||
assert_int(save.game_start_song).is_equal(0)
|
||||
assert_bool(save.first_song_played).is_true()
|
||||
|
||||
|
||||
func test_where_the_songs_and_characters_came_from_is_saved() -> void:
|
||||
_quiz()
|
||||
Settings.character_folder = "/home/me/Christmas characters"
|
||||
assert_bool(QuizSave.capture(true).write()).is_true()
|
||||
|
||||
var save: QuizSave = QuizSave.read()
|
||||
|
||||
assert_str(save.server).is_equal("https://music.example.com")
|
||||
assert_str(save.music_folder_path).is_empty()
|
||||
assert_str(save.characters_dir).is_equal("/home/me/Christmas characters")
|
||||
assert_bool(save.stats_paused_by_win).is_true()
|
||||
|
||||
|
||||
func test_a_music_folder_is_saved_with_how_far_its_quiz_has_come() -> void:
|
||||
var root: String = create_temp_dir("quiz_save_folder_%d" % randi())
|
||||
for file_name: String in ["01. One.mp3", "02. Two.mp3"]:
|
||||
FileAccess.open(root.path_join(file_name), FileAccess.WRITE).store_buffer(
|
||||
FileAccess.get_file_as_bytes("res://tests/data/short.mp3"))
|
||||
Settings.music_folder = MusicFolder.scan(root)
|
||||
Settings.music_folder.next_song()
|
||||
|
||||
var save: QuizSave = _read_back()
|
||||
|
||||
assert_str(save.server).is_empty()
|
||||
assert_str(save.music_folder_path).is_equal(root)
|
||||
assert_int(int(save.music_folder_progress.next)).is_equal(1)
|
||||
|
||||
|
||||
func test_song_files_are_the_saved_songs_files() -> void:
|
||||
_quiz()
|
||||
Playlist.song_object_array[0].song_path = ""
|
||||
|
||||
assert_array(_read_back().song_files()).contains_exactly(
|
||||
["/songs/song_1.mp3", "/songs/song_2.mp3"])
|
||||
|
||||
|
||||
# The file
|
||||
|
||||
func test_quiz_is_saved_next_to_the_settings_and_apart_in_debug_mode() -> void:
|
||||
assert_str(QuizSave.path()).is_equal(Settings.config_dir().path_join("current_quiz.json"))
|
||||
|
||||
Settings.is_debug = true
|
||||
|
||||
assert_str(QuizSave.path()).is_equal(
|
||||
Settings.config_dir().path_join("current_quiz_debug.json"))
|
||||
|
||||
|
||||
func test_no_file_means_no_saved_quiz() -> void:
|
||||
assert_object(QuizSave.read()).is_null()
|
||||
|
||||
|
||||
func test_saving_leaves_no_temporary_file() -> void:
|
||||
_quiz()
|
||||
|
||||
QuizSave.capture(false).write()
|
||||
|
||||
assert_array(DirAccess.get_files_at(Settings.config_dir())).contains_exactly(
|
||||
["current_quiz.json"])
|
||||
|
||||
|
||||
func test_saving_again_replaces_the_quiz() -> void:
|
||||
_quiz()
|
||||
QuizSave.capture(false).write()
|
||||
Settings.player_array[0].player_score = 5
|
||||
|
||||
assert_int(_read_back().players[0].player_score).is_equal(5)
|
||||
|
||||
|
||||
func test_delete_removes_the_saved_quiz() -> void:
|
||||
_quiz()
|
||||
QuizSave.capture(false).write()
|
||||
|
||||
QuizSave.delete()
|
||||
|
||||
assert_object(QuizSave.read()).is_null()
|
||||
|
||||
|
||||
func test_file_that_is_not_a_quiz_is_ignored() -> void:
|
||||
for text: String in ["", "not json {", "[1, 2]", '{"version": 1}',
|
||||
'{"players": [], "songs": []}', '{"version": 99, "players": [], "songs": []}']:
|
||||
FileAccess.open(QuizSave.path(), FileAccess.WRITE).store_string(text)
|
||||
|
||||
assert_object(QuizSave.read()).override_failure_message(text).is_null()
|
||||
|
||||
|
||||
func test_players_that_cannot_be_read_are_left_out() -> void:
|
||||
_quiz()
|
||||
var data: Dictionary = QuizSave.capture(false).to_dict()
|
||||
data.players.append({"name": 3})
|
||||
data.players.append("Lucca")
|
||||
|
||||
var save: QuizSave = QuizSave.from_dict(data)
|
||||
|
||||
assert_int(save.players.size()).is_equal(2)
|
||||
|
||||
|
||||
func test_songs_are_dropped_together_if_one_cannot_be_read() -> void:
|
||||
_quiz()
|
||||
var data: Dictionary = QuizSave.capture(false).to_dict()
|
||||
data.songs[1] = {"song": "no number"}
|
||||
|
||||
var save: QuizSave = QuizSave.from_dict(data)
|
||||
|
||||
# A song's place in the list is its number, so the others can't be kept without it
|
||||
assert_array(save.songs).is_empty()
|
||||
assert_int(save.currently_playing_song).is_equal(-1)
|
||||
assert_int(save.players.size()).is_equal(2)
|
||||
|
||||
|
||||
func test_positions_outside_the_songs_are_kept_inside() -> void:
|
||||
_quiz()
|
||||
var data: Dictionary = QuizSave.capture(false).to_dict()
|
||||
data.currently_playing_song = 40
|
||||
data.latest_played_song = -3
|
||||
data.game_start_song = 99
|
||||
|
||||
var save: QuizSave = QuizSave.from_dict(data)
|
||||
|
||||
assert_int(save.currently_playing_song).is_equal(2)
|
||||
assert_int(save.latest_played_song).is_equal(0)
|
||||
assert_int(save.game_start_song).is_equal(3)
|
||||
|
||||
|
||||
func test_no_more_players_than_the_game_allows() -> void:
|
||||
var data: Dictionary = QuizSave.new().to_dict()
|
||||
for i: int in Settings.MAX_NUMBER_OF_PLAYERS + 3:
|
||||
data.players.append(PlayerObject.new("Player %d" % i).to_dict())
|
||||
|
||||
assert_int(QuizSave.from_dict(data).players.size()).is_equal(Settings.MAX_NUMBER_OF_PLAYERS)
|
||||
|
||||
|
||||
func test_drop_songs_keeps_the_players_without_points() -> void:
|
||||
_quiz()
|
||||
var save: QuizSave = _read_back()
|
||||
|
||||
save.drop_songs()
|
||||
|
||||
assert_array(save.songs).is_empty()
|
||||
assert_int(save.currently_playing_song).is_equal(-1)
|
||||
assert_int(save.players.size()).is_equal(2)
|
||||
assert_int(save.players[0].player_score).is_equal(0)
|
||||
assert_bool(save.players[0].is_first_point).is_true()
|
||||
assert_str(save.players[0].character_name).is_equal("Crono.png")
|
||||
|
||||
|
||||
# Players and songs on their own
|
||||
|
||||
func test_player_round_trip() -> void:
|
||||
var player: PlayerObject = _player("Lucca", 3, "Lucca.png")
|
||||
|
||||
var again: PlayerObject = PlayerObject.from_dict(
|
||||
JSON.parse_string(JSON.stringify(player.to_dict())))
|
||||
|
||||
assert_str(again.id).is_equal(player.id)
|
||||
assert_str(again.player_name).is_equal("Lucca")
|
||||
assert_int(again.player_score).is_equal(3)
|
||||
assert_str(again.character_name).is_equal("Lucca.png")
|
||||
# The picture is found again by name later
|
||||
assert_str(again.character.resource_path).is_equal(PlayerObject.NO_CHARACTER_PATH)
|
||||
|
||||
|
||||
func test_song_round_trip() -> void:
|
||||
var song_object: SongObject = _song(7, true, ["a", "b"])
|
||||
song_object.is_playing = true
|
||||
|
||||
var again: SongObject = SongObject.from_dict(
|
||||
JSON.parse_string(JSON.stringify(song_object.to_dict())))
|
||||
|
||||
assert_int(again.song_number).is_equal(7)
|
||||
assert_str(again.soundtrack_title).is_equal("Soundtrack 7")
|
||||
assert_str(again.song_title).is_equal("Song 7")
|
||||
assert_array(again.players_given_point).contains_exactly(["a", "b"])
|
||||
assert_bool(again.has_played).is_true()
|
||||
assert_bool(again.is_answered).is_true()
|
||||
assert_bool(again.is_playing).is_true()
|
||||
assert_str(again.song_path).is_equal("/songs/song_7.mp3")
|
||||
|
||||
|
||||
func test_clear_character_goes_back_to_no_character() -> void:
|
||||
var player: PlayerObject = _player("Crono", 0)
|
||||
var texture: ImageTexture = ImageTexture.create_from_image(
|
||||
Image.create(4, 4, false, Image.FORMAT_RGB8))
|
||||
player.set_character(texture, "Crono.png")
|
||||
assert_object(player.character).is_same(texture)
|
||||
|
||||
player.clear_character()
|
||||
|
||||
assert_str(player.character_name).is_empty()
|
||||
assert_str(player.character.resource_path).is_equal(PlayerObject.NO_CHARACTER_PATH)
|
||||
@@ -0,0 +1 @@
|
||||
uid://5mphqqq032dx
|
||||
@@ -83,3 +83,27 @@ func test_song_stays_in_memory_when_it_cannot_be_saved() -> void:
|
||||
|
||||
assert_str(song_object.song_path).is_empty()
|
||||
assert_object(Playlist.get_song(0)).is_instanceof(AudioStreamMP3)
|
||||
|
||||
|
||||
func test_new_songs_never_write_over_files_kept_from_a_saved_quiz() -> void:
|
||||
var kept: SongObject = _add_song()
|
||||
var kept_bytes: PackedByteArray = FileAccess.get_file_as_bytes(kept.song_path)
|
||||
# As after a restart: the count of files written starts over
|
||||
Playlist._song_files_written = 0
|
||||
|
||||
var new_song: SongObject = _add_song()
|
||||
|
||||
assert_str(new_song.song_path).is_not_equal(kept.song_path)
|
||||
assert_array(FileAccess.get_file_as_bytes(kept.song_path)).is_equal(kept_bytes)
|
||||
assert_array(DirAccess.get_files_at(Playlist.songs_folder())).has_size(2)
|
||||
|
||||
|
||||
func test_clearing_can_keep_the_files_a_saved_quiz_uses() -> void:
|
||||
var kept: SongObject = _add_song()
|
||||
var dropped: SongObject = _add_song()
|
||||
|
||||
Playlist.clear_song_files(PackedStringArray([kept.song_path]))
|
||||
|
||||
assert_bool(FileAccess.file_exists(kept.song_path)).is_true()
|
||||
assert_bool(FileAccess.file_exists(dropped.song_path)).is_false()
|
||||
|
||||
Reference in new issue
Block a user