game-cards/addons/gut/test/unit/test_spy.gd

extends GutTest

class TestSpy:
	extends GutInternalTester

	var Simple = load('res://test/resources/spy_test_objects/simple.gd')

	var _spy = null

	func before_each():
		_spy = Spy.new()

	func test_has_logger():
		assert_has_logger(_spy)

	func test_can_add_call_to_method_on_path():
		_spy.add_call('nothing', 'method_name')
		pass_test("no errors, we are all good")

	func test_can_add_call_to_method_on_instance():
		var simple = Simple.new()
		_spy.add_call(simple, 'method_name')
		pass_test("no errors, we are all good")

	func test_was_called_returns_true_if_path_and_method_were_called():
		var simple = Simple.new()
		_spy.add_call(simple, 'method_name')
		assert_true(_spy.was_called(simple, 'method_name'))

	func test_can_check_if_instance_method_called():
		var simple = Simple.new()
		_spy.add_call(simple, 'method_name')
		assert_true(_spy.was_called(simple, 'method_name'))

	func test_if_method_was_not_called_then_was_called_returns_false():
		assert_false(_spy.was_called(Simple.new(), 'method_name'))

	func test_adding_second_call_does_not_overwrite_first():
		var simple = Simple.new()
		_spy.add_call(simple, 'method1')
		_spy.add_call(simple, 'method2')
		assert_true(_spy.was_called(simple, 'method1'))

	func test_was_called_with_no_parameters_returns_true_for_parameterized_calls():
		var simple = Simple.new()
		_spy.add_call(simple, 'method1', [1])
		_spy.add_call(simple, 'method1', [2])
		_spy.add_call(simple, 'method1', [3])
		assert_true(_spy.was_called(simple, 'method1'))

	func test_can_clear_spies():
		var simple1 = Simple.new()
		var simple2 = Simple.new()

		_spy.add_call(simple1, 'method1', [1])
		_spy.add_call(simple1, 'method2', [2])

		_spy.add_call(simple2, 'method1', [1])
		_spy.add_call(simple2, 'method2', [2])

		assert_eq(_spy._calls.keys().size(), 2, 'pre count')
		_spy.clear()
		assert_eq(_spy._calls.keys().size(), 0, 'post count')


class TestAddingCallsWithParameters:
	extends GutInternalTester

	var Simple = load('res://test/resources/spy_test_objects/simple.gd')

	var _spy = null

	func before_each():
		_spy = Spy.new()
		_spy.set_logger(GutLogger.new())


	func test_can_add_call_with_parameters():
		_spy.add_call(Simple.new(), 'method1', [1])
		pass_test("no errors, we are all good")

	func test_can_check_for_calls_with_parameters():
		var simple = Simple.new()
		_spy.add_call(simple, 'method1', [1])
		assert_true(_spy.was_called(simple, 'method1', [1]))

	func test_when_params_dont_match_was_called_is_false():
		var simple = Simple.new()
		_spy.add_call(simple, 'method1', [1])
		assert_false(_spy.was_called(simple, 'method1', [2]))

	func test_can_get_parameters_for_first_call():
		var simple = Simple.new()
		_spy.add_call(simple, 'method1', [1])
		assert_eq(_spy.get_call_parameters(simple, 'method1'), [1])

	func test_can_get_parameters_for_second_call():
		var simple = Simple.new()
		_spy.add_call(simple, 'method1', [1])
		_spy.add_call(simple, 'method1', [2])
		assert_eq(_spy.get_call_parameters(simple, 'method1'), [2])

	func test_when_method_was_not_called_get_call_parameters_returns_null():
		assert_eq(_spy.get_call_parameters(Simple.new(), 'method1'), null)

	func test_can_get_second_call_parameters_when_there_are_multiple_calls():
		var simple = Simple.new()
		for i in range(20):
			_spy.add_call(simple, 'method1', [i])
		assert_eq(_spy.get_call_parameters(simple, 'method1', 10), [10])

	func test_when_index_out_of_range_then_error_generated_and_null_returned():
		var simple = Simple.new()
		_spy.add_call(simple, 'method1')
		var p = _spy.get_call_parameters(simple, 'method1', 10)
		assert_eq(p, null, 'The returned parameters should be null')
		assert_eq(_spy.get_logger().get_errors().size(), 1, 'generates error')

	func test_performs_deep_compare_of_paramters():
		var params = [1, 2, {'a':1, 'b':2}]
		var simple = Simple.new()
		_spy.add_call(simple, 'method1', params.duplicate(true))
		assert_true(_spy.was_called(simple, 'method1', params))


class TestGetCallCount:
	extends GutTest

	var Spy = load('res://addons/gut/spy.gd')
	var Simple = load('res://test/resources/spy_test_objects/simple.gd')
	var _spy = null

	func before_each():
		_spy = Spy.new()

	func test_when_no_calls_found_call_count_returns_0():
		var count = _spy.call_count(Simple.new(), 'method1')
		assert_eq(count, 0)

	func test_when_has_been_called_one_returned():
		var simple = Simple.new()
		_spy.add_call(simple, 'method1')
		assert_eq(_spy.call_count(simple, 'method1'), 1)

	func test_when_called_multiple_times_the_right_count_is_returned():
		var simple = Simple.new()
		for _i in range(10):
			_spy.add_call(simple, 'method1')
		assert_eq(_spy.call_count(simple, 'method1'), 10)

	func test_can_get_count_called_with_parameters():
		var simple = Simple.new()
		_spy.add_call(simple, 'method1', [1])
		_spy.add_call(simple, 'method1', [1])
		_spy.add_call(simple, 'method1', [2])
		assert_eq(_spy.call_count(simple, 'method1', [1]), 2)

	func test_when_no_parameters_match_0_returned():
		var simple = Simple.new()
		_spy.add_call(simple, 'method1', [1])
		_spy.add_call(simple, 'method1', [2])
		assert_eq(_spy.call_count(simple, 'method1', [3]), 0)