Create framework for testing Signals

2 files changed, 192 insertions, 4 deletions

diff --git a/tests/test_macros.h b/tests/test_macros.h
index 293c471990..bf1001fa67 100644
--- a/tests/test_macros.h
+++ b/tests/test_macros.h
@@ -31,6 +31,8 @@
 #ifndef TEST_MACROS_H
 #define TEST_MACROS_H
 
+#include "core/object/callable_method_pointer.h"
+#include "core/object/class_db.h"
 #include "core/templates/map.h"
 #include "core/variant/variant.h"
 
@@ -142,4 +144,173 @@ int register_test_command(String p_command, TestFunc p_function);
 		MessageQueue::get_singleton()->flush();                                                       \
 	}
 
+// Utility class / macros for testing signals
+//
+// Use SIGNAL_WATCH(*object, "signal_name") to start watching
+// Makes sure to call SIGNAL_UNWATCH(*object, "signal_name") to stop watching in cleanup, this is not done automatically.
+//
+// The SignalWatcher will capture all signals and their args sent between checks.
+//
+// Use SIGNAL_CHECK("signal_name"), Vector<Vector<Variant>>), to check the arguments of all fired signals.
+// The outer vector is each fired signal, the inner vector the list of arguments for that signal. Order does matter.
+//
+// Use SIGNAL_CHECK_FALSE("signal_name") to check if a signal was not fired.
+//
+// Use SIGNAL_DISCARD("signal_name") to discard records all of the given signal, use only in placed you don't need to check.
+//
+// All signals are automaticaly discared between test/sub test cases.
+
+class SignalWatcher : public Object {
+private:
+	inline static SignalWatcher *singleton;
+
+	/* Equal to: Map<String, Vector<Vector<Variant>>> */
+	Map<String, Array> _signals;
+	void _add_signal_entry(const Array &p_args, const String &p_name) {
+		if (!_signals.has(p_name)) {
+			_signals[p_name] = Array();
+		}
+		_signals[p_name].push_back(p_args);
+	}
+
+	void _signal_callback_zero(const String &p_name) {
+		Array args;
+		_add_signal_entry(args, p_name);
+	}
+
+	void _signal_callback_one(Variant p_arg1, const String &p_name) {
+		Array args;
+		args.push_back(p_arg1);
+		_add_signal_entry(args, p_name);
+	}
+
+	void _signal_callback_two(Variant p_arg1, Variant p_arg2, const String &p_name) {
+		Array args;
+		args.push_back(p_arg1);
+		args.push_back(p_arg2);
+		_add_signal_entry(args, p_name);
+	}
+
+	void _signal_callback_three(Variant p_arg1, Variant p_arg2, Variant p_arg3, const String &p_name) {
+		Array args;
+		args.push_back(p_arg1);
+		args.push_back(p_arg2);
+		args.push_back(p_arg3);
+		_add_signal_entry(args, p_name);
+	}
+
+public:
+	static SignalWatcher *get_singleton() { return singleton; }
+
+	void watch_signal(Object *p_object, const String &p_signal) {
+		Vector<Variant> args;
+		args.push_back(p_signal);
+		MethodInfo method_info;
+		ClassDB::get_signal(p_object->get_class(), p_signal, &method_info);
+		switch (method_info.arguments.size()) {
+			case 0: {
+				p_object->connect(p_signal, callable_mp(this, &SignalWatcher::_signal_callback_zero), args);
+			} break;
+			case 1: {
+				p_object->connect(p_signal, callable_mp(this, &SignalWatcher::_signal_callback_one), args);
+			} break;
+			case 2: {
+				p_object->connect(p_signal, callable_mp(this, &SignalWatcher::_signal_callback_two), args);
+			} break;
+			case 3: {
+				p_object->connect(p_signal, callable_mp(this, &SignalWatcher::_signal_callback_three), args);
+			} break;
+			default: {
+				MESSAGE("Signal ", p_signal, " arg count not supported.");
+			} break;
+		}
+	}
+
+	void unwatch_signal(Object *p_object, const String &p_signal) {
+		MethodInfo method_info;
+		ClassDB::get_signal(p_object->get_class(), p_signal, &method_info);
+		switch (method_info.arguments.size()) {
+			case 0: {
+				p_object->disconnect(p_signal, callable_mp(this, &SignalWatcher::_signal_callback_zero));
+			} break;
+			case 1: {
+				p_object->disconnect(p_signal, callable_mp(this, &SignalWatcher::_signal_callback_one));
+			} break;
+			case 2: {
+				p_object->disconnect(p_signal, callable_mp(this, &SignalWatcher::_signal_callback_two));
+			} break;
+			case 3: {
+				p_object->disconnect(p_signal, callable_mp(this, &SignalWatcher::_signal_callback_three));
+			} break;
+			default: {
+				MESSAGE("Signal ", p_signal, " arg count not supported.");
+			} break;
+		}
+	}
+
+	bool check(const String &p_name, const Array &p_args) {
+		if (!_signals.has(p_name)) {
+			MESSAGE("Signal ", p_name, " not emitted");
+			return false;
+		}
+
+		if (p_args.size() != _signals[p_name].size()) {
+			MESSAGE("Signal has " << _signals[p_name] << " expected " << p_args);
+			discard_signal(p_name);
+			return false;
+		}
+
+		bool match = true;
+		for (int i = 0; i < p_args.size(); i++) {
+			if (((Array)p_args[i]).size() != ((Array)_signals[p_name][i]).size()) {
+				MESSAGE("Signal has " << _signals[p_name][i] << " expected " << p_args[i]);
+				match = false;
+				continue;
+			}
+
+			for (int j = 0; j < ((Array)p_args[i]).size(); j++) {
+				if (((Array)p_args[i])[j] != ((Array)_signals[p_name][i])[j]) {
+					MESSAGE("Signal has " << _signals[p_name][i] << " expected " << p_args[i]);
+					match = false;
+					break;
+				}
+			}
+		}
+
+		discard_signal(p_name);
+		return match;
+	}
+
+	bool check_false(const String &p_name) {
+		bool has = _signals.has(p_name);
+		discard_signal(p_name);
+		return !has;
+	}
+
+	void discard_signal(const String &p_name) {
+		if (_signals.has(p_name)) {
+			_signals.erase(p_name);
+		}
+	}
+
+	void _clear_signals() {
+		_signals.clear();
+	}
+
+	SignalWatcher() {
+		singleton = this;
+	}
+
+	~SignalWatcher() {
+		singleton = nullptr;
+	}
+};
+
+#define SIGNAL_WATCH(m_object, m_signal) SignalWatcher::get_singleton()->watch_signal(m_object, m_signal);
+#define SIGNAL_UNWATCH(m_object, m_signal) SignalWatcher::get_singleton()->unwatch_signal(m_object, m_signal);
+
+#define SIGNAL_CHECK(m_signal, m_args) CHECK(SignalWatcher::get_singleton()->check(m_signal, m_args));
+#define SIGNAL_CHECK_FALSE(m_signal) CHECK(SignalWatcher::get_singleton()->check_false(m_signal));
+#define SIGNAL_DISCARD(m_signal) SignalWatcher::get_singleton()->discard_signal(m_signal);
+
 #endif // TEST_MACROS_H
diff --git a/tests/test_main.cpp b/tests/test_main.cpp
index ec32bfa18d..805380a9aa 100644
--- a/tests/test_main.cpp
+++ b/tests/test_main.cpp
@@ -156,12 +156,16 @@ int test_main(int argc, char *argv[]) {
 struct GodotTestCaseListener : public doctest::IReporter {
 	GodotTestCaseListener(const doctest::ContextOptions &p_in) {}
 
+	SignalWatcher *signal_watcher = nullptr;
+
 	PhysicsServer3D *physics_3d_server = nullptr;
 	PhysicsServer2D *physics_2d_server = nullptr;
 	NavigationServer3D *navigation_3d_server = nullptr;
 	NavigationServer2D *navigation_2d_server = nullptr;
 
 	void test_case_start(const doctest::TestCaseData &p_in) override {
+		SignalWatcher::get_singleton()->_clear_signals();
+
 		String name = String(p_in.m_name);
 
 		if (name.find("[SceneTree]") != -1) {
@@ -266,13 +270,26 @@ struct GodotTestCaseListener : public doctest::IReporter {
 		}
 	}
 
+	void test_run_start() override {
+		signal_watcher = memnew(SignalWatcher);
+	}
+
+	void test_run_end(const doctest::TestRunStats &) override {
+		memdelete(signal_watcher);
+	}
+
+	void test_case_reenter(const doctest::TestCaseData &) override {
+		SignalWatcher::get_singleton()->_clear_signals();
+	}
+
+	void subcase_start(const doctest::SubcaseSignature &) override {
+		SignalWatcher::get_singleton()->_clear_signals();
+	}
+
 	void report_query(const doctest::QueryData &) override {}
-	void test_run_start() override {}
-	void test_run_end(const doctest::TestRunStats &) override {}
-	void test_case_reenter(const doctest::TestCaseData &) override {}
 	void test_case_exception(const doctest::TestCaseException &) override {}
-	void subcase_start(const doctest::SubcaseSignature &) override {}
 	void subcase_end() override {}
+
 	void log_assert(const doctest::AssertData &in) override {}
 	void log_message(const doctest::MessageData &) override {}
 	void test_case_skipped(const doctest::TestCaseData &) override {}