0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add a unit test for wesnoth.current.synced_state

Browse source 
The edge-case of calling evaluate_single within an unsynced event was
surprising, and I'm not sure it's correct. However, as we're about to
release the 1.16 branch I think it's better to include that as a test
that the API doesn't change during the stable branch.

(cherry picked from commit f9fc806fd2)
This commit is contained in:
Steve Cotton 2021-07-05 12:31:15 +02:00 • committed by Steve Cotton
parent b4b0c73acb
commit d23f072597
2 changed files with 95 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

90
data/test/scenarios/test_synced_state.cfg Normal file
View file

@ -0,0 +1,90 @@
# wmllint: no translatables
# Check that wesnoth.current.synced_state works as documented, and that a subset of the standard events match the docs
# in https://wiki.wesnoth.org/EventWML#Multiplayer_safety
{GENERIC_UNIT_TEST "test_synced_state" (
[event]
name = preload
[lua]
code =<<
unit_test.assert_equal(wesnoth.current.synced_state, 'preload', 'preload should have its own state')
>>
[/lua]
[/event]
[event]
name = start
[lua]
code =<<
unit_test.assert_equal(wesnoth.current.synced_state, 'synced', 'start should be synchronised')
local result = wesnoth.sync.evaluate_single(
function()
unit_test.assert_equal(wesnoth.current.synced_state, 'local_choice', 'expected value to be local_choice, within synced event')
return { value = wesnoth.current.synced_state }
end)
unit_test.assert_equal(result.value, 'local_choice', 'wrong value returned, within synced event')
>>
[/lua]
[/event]
[event]
name=turn 1
[lua]
code =<<
unit_test.assert_equal(wesnoth.current.synced_state, 'synced', '“turn X” should be synced')
>>
[/lua]
# Trigger the events below. The order that they're triggered in is checked in events-test_victory.cfg.
[kill]
side=2
[/kill]
[/event]
[event]
name=enemies defeated
[lua]
code =<<
unit_test.assert_equal(wesnoth.current.synced_state, 'synced', 'enemies_defeated should be synced')
>>
[/lua]
[/event]
[event]
name=local_victory
[lua]
code =<<
unit_test.assert_equal(wesnoth.current.synced_state, 'unsynced', 'local_victory should be unsynced')
-- evaluate_single a.k.a. synchronize_choice (for a single side) doesn't sync when called in an unsynced state.
-- In 1.13.0 (commit 3b86c955616c), that changed from generating an error to a comment in the C++ that it "doesn't cause problems".
-- In the same commit, the multiple-side version was left generating an error.
-- This doesn't give me confidence that the behavior is replay-safe, but let's at least check that the behavior is consistent.
local result = wesnoth.sync.evaluate_single(
function()
unit_test.assert_equal(wesnoth.current.synced_state, 'unsynced', 'within unsynced event')
return { value = wesnoth.current.synced_state }
end)
unit_test.assert_equal(result.value, 'unsynced', 'wrong value returned, within unsynced event')
>>
[/lua]
[/event]
[event]
name=victory
[lua]
code =<<
unit_test.assert_equal(wesnoth.current.synced_state, 'synced', 'victory should be synced')
>>
[/lua]
[/event]
[event]
name=scenario_end
[lua]
code =<<
unit_test.assert_equal(wesnoth.current.synced_state, 'synced', 'scenario_end should be synced')
>>
[/lua]
{SUCCEED}
[/event]
)}

6
wml_test_schedule
View file

@ -33,9 +33,13 @@
0 test_lua_assert_errors8
1 test_lua_assert_errors9
2 empty_test
0 test_end_turn
#
# The synchronisation mechanism
#
4 break_replay_with_lua_random
0 fixed_lua_random_replay_with_sync_choice
0 test_end_turn
0 test_synced_state
#
# Security test
#