godot-xterm/test/test_rendering.gd

# SPDX-FileCopyrightText: 2024 Leroy Hopson <godot-xterm@leroy.nix.nz>
# SPDX-License-Identifier: MIT

class_name RenderingTest extends GodotXtermTest


func get_described_class():
	return Terminal


# Return the color in the center of the given cell.
func pick_cell_color(cell := Vector2i(0, 0)) -> Color:
	var cell_size = subject.get_cell_size()
	var pixelv = Vector2(cell) * cell_size + (cell_size / 2)
	return get_viewport().get_texture().get_image().get_pixelv(pixelv)


func before_each():
	subject = described_class.new()
	subject.add_theme_font_override(
		"normal_font", preload("res://addons/godot_xterm/themes/fonts/regular.tres")
	)
	subject.set_anchors_and_offsets_preset(Control.PRESET_FULL_RECT)
	watch_signals(subject)
	call_deferred("add_child_autofree", subject)
	await wait_for_signal(subject.ready, 5)


class TestRendering:
	extends RenderingTest

	# Fill the terminal with colored blocks.
	func fill_color(color = Color.BLACK, rows: int = subject.get_rows()):
		subject.write("\u001b[38;2;%d;%d;%dm" % [color.r8, color.g8, color.b8])
		subject.write("█".repeat(subject.get_cols() * rows))

	func test_render():
		fill_color(Color.BLUE)
		await wait_for_signal(subject.draw, 3)
		await wait_frames(15)
		var cell_color = pick_cell_color()
		assert_eq(cell_color, Color.BLUE)

	func test_update():
		fill_color(Color.RED)
		await get_tree().physics_frame
		subject.queue_redraw()
		await wait_for_signal(subject.draw, 3)
		await wait_frames(15)
		var cell_color = pick_cell_color(Vector2i(0, 0))
		assert_eq(cell_color, Color.RED)

	func test_clear_clears_all_but_the_first_row():
		await wait_frames(15)
		var cell = Vector2i(0, 1)  # Pick a cell not on the first row.
		var original_color = pick_cell_color(cell)
		call_deferred("fill_color", Color.CYAN)
		await wait_for_signal(subject.draw, 3)
		await wait_frames(15)
		subject.clear()
		await wait_for_signal(subject.draw, 3)
		await wait_frames(15)
		var cell_color = pick_cell_color(cell)
		assert_eq(cell_color, original_color)

	func test_clear_keeps_the_last_row():
		fill_color(Color.GREEN)
		fill_color(Color.ORANGE, 1)
		await wait_for_signal(subject.draw, 3)
		await wait_frames(15)
		subject.clear()
		await wait_for_signal(subject.draw, 3)
		await wait_frames(15)
		var cell_color = pick_cell_color(Vector2i(0, 0))
		assert_eq(cell_color, Color.ORANGE)


class TestKeyPressed:
	extends RenderingTest

	var input_event: InputEventKey

	func before_each():
		await super.before_each()

		subject.grab_focus()

		input_event = InputEventKey.new()
		input_event.pressed = true
		Input.call_deferred("parse_input_event", input_event)

	func test_key_pressed_emitted_on_key_input():
		input_event.keycode = KEY_A
		input_event.unicode = "a".unicode_at(0)

		await wait_for_signal(subject.key_pressed, 1)
		assert_signal_emitted(subject, "key_pressed")

	func test_key_pressed_emitted_only_once_per_key_input():
		input_event.keycode = KEY_B
		input_event.unicode = "b".unicode_at(0)

		await wait_for_signal(subject.key_pressed, 1)
		assert_signal_emit_count(subject, "key_pressed", 1)

	func test_key_pressed_emits_interpreted_key_input_as_first_param():
		input_event.keycode = KEY_UP
		input_event.unicode = 0

		await wait_for_signal(subject.key_pressed, 1)

		var signal_parameters = get_signal_parameters(subject, "key_pressed", 0)
		assert_eq(signal_parameters[0], "\u001b[A")

	func test_key_pressed_emits_original_input_event_as_second_param():
		input_event.keycode = KEY_L
		input_event.unicode = "l".unicode_at(0)

		await wait_for_signal(subject.key_pressed, 1)

		var signal_parameters = get_signal_parameters(subject, "key_pressed", 0)
		assert_eq(signal_parameters[1], input_event)

	func test_key_pressed_not_emitted_when_writing_to_subject():
		subject.write("a")
		await wait_frames(1)
		assert_signal_emit_count(subject, "key_pressed", 0)

	func test_key_pressed_not_emitted_by_other_input_type():
		var mouse_input = InputEventMouseButton.new()
		mouse_input.button_index = MOUSE_BUTTON_LEFT
		mouse_input.pressed = true
		Input.call_deferred("parse_input_event", mouse_input)

		await wait_for_signal(subject.gui_input, 1)
		assert_signal_emit_count(subject, "key_pressed", 0)