straywild/tests/surface_drawing_multiplayer_validation.gd

451 lines
16 KiB
GDScript

extends SceneTree
const MainScene: PackedScene = preload("res://main/main.tscn")
const TEST_PORT: int = 18133
const WAIT_MSEC: int = 60000
func _initialize() -> void:
call_deferred("_run")
func _run() -> void:
var arguments: PackedStringArray = OS.get_cmdline_user_args()
if arguments.has("host"):
await _run_host()
return
if arguments.has("client"):
await _run_client()
return
push_error("Surface drawing multiplayer validation needs host or client mode.")
quit(1)
func _run_host() -> void:
var main: Node = await _create_initialized_main()
var session := main.get_node("%NetworkSession") as NetworkSession
assert(bool(main.call(
"_apply_world", WorldLayout.STARTER_ISLAND, 1, true
)))
assert(bool(main.call(
"_prepare_host_world", WorldLayout.STARTER_ISLAND, 1
)))
var save_manager := main.get("_save_manager") as PlayerSaveManager
assert(save_manager.initialize_new_game(1, WorldLayout.STARTER_ISLAND))
assert(session.start_private_host(TEST_PORT))
main.call("_enter_gameplay")
await physics_frame
await physics_frame
var player := main.get("_player") as Player
assert(player.bag.add_item(&"art_kit", 1))
assert(player.hotbar.assign_item(0, &"art_kit"))
assert(player.hotbar.select_slot(0))
assert(player.art_unlocks.restore_mask(PlayerArtUnlocks.ALL_UNLOCK_MASK))
var service := main.get_node(
"%NetworkSurfaceDrawingService"
) as NetworkSurfaceDrawingService
var surface: Dictionary = _surface_below_local_player(main)
assert(not surface.is_empty())
assert(service.request_canvas_at_surface(
surface["position"], surface["normal"], Vector3.RIGHT
))
var canvas_id: String = service.get_canvas_ids()[0]
assert(service.request_cell_edits(canvas_id, [{
"x": 7,
"y": 7,
"color_id": "coral",
}]))
assert(session.set_host_open(true))
var remote_peer_id: int = await _wait_for_remote_peer(session)
assert(remote_peer_id > 1)
var remote_record: PeerRegistry.PeerRecord = session.get_peer_record(
remote_peer_id
)
assert(remote_record != null)
var network_home := main.get_node(
"%NetworkHomeService"
) as NetworkHomeService
var home_world := main.get_node("%HomeWorldService") as HomeWorldService
var spawn_service := main.get_node(
"%PlayerSpawnService"
) as PlayerSpawnService
assert(await _wait_for_home(
network_home, remote_record.identity_fingerprint
))
var remote_avatar: Player = spawn_service.get_avatar(remote_peer_id)
assert(remote_avatar != null)
var exterior_spawn: Transform3D = home_world.get_exterior_spawn_transform(
remote_record.identity_fingerprint
)
var exterior_deadline: int = Time.get_ticks_msec() + 5000
while (
Time.get_ticks_msec() < exterior_deadline
and remote_avatar.global_position.distance_to(exterior_spawn.origin) > 0.25
):
await physics_frame
assert(remote_avatar.global_position.distance_to(exterior_spawn.origin) <= 0.25)
var canvas_state: Dictionary = service.get_canvas_state(canvas_id)
var canvas_origin: Vector3 = SurfaceDrawingProtocol.array_to_vector(
canvas_state["origin"]
)
remote_avatar.global_position = Vector3(
canvas_origin.x + 1.0,
player.global_position.y,
canvas_origin.z,
)
session.publish_authoritative_teleport(remote_peer_id)
for _frame: int in 4:
await physics_frame
assert(session.peer_supports_capability(
remote_peer_id, SurfaceDrawingProtocol.CAPABILITY
))
var overwrite_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while Time.get_ticks_msec() < overwrite_deadline:
await process_frame
var state: Dictionary = service.get_canvas_state(canvas_id)
if int(state.get("revision", 0)) < 2:
continue
var cell: Dictionary = _find_cell(state, 7, 7)
if (
str(cell.get("color_id", "")) == "blue"
and str(cell.get("author_fingerprint", ""))
== remote_record.identity_fingerprint
):
break
var overwritten_state: Dictionary = service.get_canvas_state(canvas_id)
assert(int(overwritten_state["revision"]) >= 2)
var overwritten_cell: Dictionary = _find_cell(overwritten_state, 7, 7)
assert(str(overwritten_cell["color_id"]) == "blue")
assert(
str(overwritten_cell["author_fingerprint"])
== remote_record.identity_fingerprint
)
assert(
remote_record.identity_fingerprint
in overwritten_state.get("participant_fingerprints", [])
)
assert(service.request_cell_edits(canvas_id, [{
"x": 8,
"y": 7,
"color_id": "sunny",
}]))
var undo_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while Time.get_ticks_msec() < undo_deadline:
await process_frame
var state: Dictionary = service.get_canvas_state(canvas_id)
if str(_find_cell(state, 7, 7).get("color_id", "")) == "coral":
break
assert(
str(_find_cell(service.get_canvas_state(canvas_id), 7, 7)["color_id"])
== "coral"
)
var guide_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while Time.get_ticks_msec() < guide_deadline:
await process_frame
if not bool(service.get_canvas_state(canvas_id).get("guide_visible", true)):
break
assert(not bool(service.get_canvas_state(canvas_id)["guide_visible"]))
# Keep the shared hidden state observable before publishing the restore.
await create_timer(1.0).timeout
assert(service.request_guide_visibility(canvas_id, true))
await create_timer(1.0).timeout
assert(service.request_guide_visibility(canvas_id, false, true))
await create_timer(1.0).timeout
assert(service.clear_session_artwork())
var stamp_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while (
Time.get_ticks_msec() < stamp_deadline
and service.get_canvas_ids().is_empty()
):
await process_frame
assert(service.get_canvas_ids().size() == 1)
var stamp_id: String = service.get_canvas_ids()[0]
var stamp_state: Dictionary = service.get_canvas_state(stamp_id)
assert(bool(stamp_state.get("stamp", false)))
assert(bool(stamp_state["finalized"]))
assert((stamp_state["cells"] as Array).size() == 1)
assert(str(stamp_state["cells"][0]["color_id"]) == "coral")
assert(
stamp_state.get("participant_fingerprints", [])
== [remote_record.identity_fingerprint]
)
# Give the client a full observation window before the authoritative clear.
await create_timer(1.0).timeout
assert(
service.clear_artwork_by_fingerprint(
remote_record.identity_fingerprint
) == 1
)
assert(service.get_canvas_ids().is_empty())
var second_stamp_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while (
Time.get_ticks_msec() < second_stamp_deadline
and service.get_canvas_ids().is_empty()
):
await process_frame
assert(service.get_canvas_ids().size() == 1)
# Keep the second stamp observable on the client before the ban removes all
# artwork carrying that participant fingerprint.
await create_timer(1.0).timeout
var player_list := main.get_node(
"%NetworkPlayerListService"
) as NetworkPlayerListService
var remote_entry: PlayerListEntry = null
for entry: PlayerListEntry in player_list.get_entries():
if entry.peer_id == remote_peer_id:
remote_entry = entry
break
assert(remote_entry != null and remote_entry.can_ban)
assert(player_list.ban(
remote_peer_id,
remote_record.identity_fingerprint,
remote_record.display_name,
remote_entry.revision,
))
assert(service.get_canvas_ids().is_empty())
var removed_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while (
Time.get_ticks_msec() < removed_deadline
and session.is_authenticated_peer(remote_peer_id)
):
await process_frame
assert(not session.is_authenticated_peer(remote_peer_id))
print("Surface drawing multiplayer host validation: PASS")
session.disconnect_session("")
main.queue_free()
for _frame: int in 4:
await process_frame
await create_timer(0.1).timeout
quit()
func _run_client() -> void:
var main: Node = await _create_initialized_main()
main.call(
"_on_title_join_game_requested",
"127.0.0.1:%d" % TEST_PORT,
)
var session := main.get_node("%NetworkSession") as NetworkSession
var join_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while Time.get_ticks_msec() < join_deadline:
await process_frame
if session.state == NetworkSession.State.VERIFYING_SERVER_IDENTITY:
main.call("_confirm_server_trust")
if session.is_joined_client() and bool(main.get("_gameplay_started")):
break
assert(session.is_joined_client())
assert(session.supports_server_capability(
SurfaceDrawingProtocol.CAPABILITY
))
var player := main.get("_player") as Player
assert(player.bag.add_item(&"art_kit", 1))
assert(player.hotbar.assign_item(0, &"art_kit"))
assert(player.hotbar.select_slot(0))
assert(player.art_unlocks.restore_mask(PlayerArtUnlocks.ALL_UNLOCK_MASK))
var service := main.get_node(
"%NetworkSurfaceDrawingService"
) as NetworkSurfaceDrawingService
var snapshot_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while (
Time.get_ticks_msec() < snapshot_deadline
and service.get_canvas_ids().is_empty()
):
await process_frame
assert(service.get_canvas_ids().size() == 1)
var canvas_id: String = service.get_canvas_ids()[0]
var snapshot: Dictionary = service.get_canvas_state(canvas_id)
assert(str(_find_cell(snapshot, 7, 7).get("color_id", "")) == "coral")
var canvas_origin: Vector3 = SurfaceDrawingProtocol.array_to_vector(
snapshot["origin"]
)
var placement_deadline: int = Time.get_ticks_msec() + 10000
while (
Time.get_ticks_msec() < placement_deadline
and player.global_position.distance_to(canvas_origin)
> NetworkSurfaceDrawingService.MAX_DRAW_DISTANCE + 2.0
):
await physics_frame
assert(
player.global_position.distance_to(canvas_origin)
<= NetworkSurfaceDrawingService.MAX_DRAW_DISTANCE + 2.0
)
assert(service.request_cell_edits(canvas_id, [{
"x": 7,
"y": 7,
"color_id": "blue",
}]))
var shared_edit_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while Time.get_ticks_msec() < shared_edit_deadline:
await process_frame
var state: Dictionary = service.get_canvas_state(canvas_id)
if str(_find_cell(state, 8, 7).get("color_id", "")) == "sunny":
break
var final_state: Dictionary = service.get_canvas_state(canvas_id)
assert(str(_find_cell(final_state, 7, 7)["color_id"]) == "blue")
assert(str(_find_cell(final_state, 8, 7)["color_id"]) == "sunny")
assert(service.request_undo_last_stroke())
var undo_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while Time.get_ticks_msec() < undo_deadline:
await process_frame
var state: Dictionary = service.get_canvas_state(canvas_id)
if str(_find_cell(state, 7, 7).get("color_id", "")) == "coral":
break
assert(
str(_find_cell(service.get_canvas_state(canvas_id), 7, 7)["color_id"])
== "coral"
)
assert(service.request_guide_visibility(canvas_id, false))
var guide_hidden_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while Time.get_ticks_msec() < guide_hidden_deadline:
await process_frame
if not bool(service.get_canvas_state(canvas_id).get("guide_visible", true)):
break
assert(not bool(service.get_canvas_state(canvas_id)["guide_visible"]))
var guide_restored_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while Time.get_ticks_msec() < guide_restored_deadline:
await process_frame
if bool(service.get_canvas_state(canvas_id).get("guide_visible", false)):
break
assert(bool(service.get_canvas_state(canvas_id)["guide_visible"]))
var finalized_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while Time.get_ticks_msec() < finalized_deadline:
await process_frame
if bool(service.get_canvas_state(canvas_id).get("finalized", false)):
break
assert(bool(service.get_canvas_state(canvas_id)["finalized"]))
var reset_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while Time.get_ticks_msec() < reset_deadline:
await process_frame
if service.get_canvas_ids().is_empty():
break
assert(service.get_canvas_ids().is_empty())
var data_root := main.get("_data_root") as PlayerDataRoot
var stamp_directory: String = data_root.root_path.path_join("artwork")
assert(DirAccess.make_dir_recursive_absolute(stamp_directory) == OK)
var stamp_path: String = stamp_directory.path_join("multiplayer-stamp.png")
var stamp_image := Image.create(16, 16, false, Image.FORMAT_RGBA8)
stamp_image.fill(Color.TRANSPARENT)
stamp_image.set_pixel(3, 11, SurfaceDrawingPalette.get_color(&"coral"))
assert(stamp_image.save_png(stamp_path) == OK)
assert(service.select_saved_stamp(stamp_path))
var stamp_surface: Dictionary = _surface_below_local_player(main)
assert(not stamp_surface.is_empty())
assert(service.request_stamp_at_surface(
stamp_surface["position"], stamp_surface["normal"], Vector3.RIGHT
))
var shared_stamp_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while (
Time.get_ticks_msec() < shared_stamp_deadline
and service.get_canvas_ids().is_empty()
):
await process_frame
assert(service.get_canvas_ids().size() == 1)
var stamp_state: Dictionary = service.get_canvas_state(
service.get_canvas_ids()[0]
)
assert(bool(stamp_state.get("stamp", false)))
assert(bool(stamp_state["finalized"]))
assert(str(stamp_state["cells"][0]["color_id"]) == "coral")
assert(
session.get_local_identity_fingerprint()
in stamp_state.get("participant_fingerprints", [])
)
var clear_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while (
Time.get_ticks_msec() < clear_deadline
and not service.get_canvas_ids().is_empty()
):
await process_frame
assert(service.get_canvas_ids().is_empty())
assert(service.request_stamp_at_surface(
stamp_surface["position"], stamp_surface["normal"], Vector3.RIGHT
))
var second_stamp_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while (
Time.get_ticks_msec() < second_stamp_deadline
and service.get_canvas_ids().is_empty()
):
await process_frame
assert(service.get_canvas_ids().size() == 1)
var ban_deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while (
Time.get_ticks_msec() < ban_deadline
and session.state != NetworkSession.State.SERVER_LOST
):
await process_frame
assert(session.state == NetworkSession.State.SERVER_LOST)
assert(service.get_canvas_ids().is_empty())
print("Surface drawing multiplayer client validation: PASS")
main.queue_free()
for _frame: int in 4:
await process_frame
await create_timer(0.1).timeout
quit()
func _surface_below_local_player(main: Node) -> Dictionary:
var player := main.get("_player") as Player
var query := PhysicsRayQueryParameters3D.create(
player.global_position + Vector3.UP * 3.0,
player.global_position + Vector3.DOWN * 6.0,
1,
)
query.collide_with_areas = false
query.collide_with_bodies = true
query.exclude = [player.get_rid()]
return player.get_world_3d().direct_space_state.intersect_ray(query)
func _wait_for_remote_peer(session: NetworkSession) -> int:
var deadline: int = Time.get_ticks_msec() + WAIT_MSEC
while Time.get_ticks_msec() < deadline:
await process_frame
for peer_id: int in session.get_authenticated_peer_ids():
if peer_id != session.get_local_peer_id():
return peer_id
return 0
func _find_cell(state: Dictionary, x: int, y: int) -> Dictionary:
for value: Variant in state.get("cells", []):
if typeof(value) != TYPE_DICTIONARY:
continue
var cell: Dictionary = value
if int(cell.get("x", -1)) == x and int(cell.get("y", -1)) == y:
return cell
return {}
func _create_initialized_main() -> Node:
root.size = Vector2i(1280, 720)
var main: Node = MainScene.instantiate()
root.add_child(main)
for _frame: int in 4:
await process_frame
if not bool(main.get("_application_initialized")):
main.call("_activate_selected_data_path", "", true)
for _frame: int in 8:
await process_frame
assert(bool(main.get("_application_initialized")))
return main
func _wait_for_home(
network_home: NetworkHomeService,
fingerprint: String,
) -> bool:
var deadline: int = Time.get_ticks_msec() + 10000
while Time.get_ticks_msec() < deadline:
await process_frame
var manifests: Dictionary = network_home.get(
"_manifests_by_fingerprint"
)
if manifests.has(fingerprint):
return true
return false