Use g_warnings when the async methods of ProtocolRoster are called if there is no implementation

Wed, 19 Jul 2023 18:13:10 -0500

author
Gary Kramlich <grim@reaperworld.com>
date
Wed, 19 Jul 2023 18:13:10 -0500
changeset 42247
faf4b46f690c
parent 42246
3230f1a1fb8f
child 42248
4c20358e4c4e

Use g_warnings when the async methods of ProtocolRoster are called if there is no implementation

This is intended to help people figure out why stuff isn't working.

Testing Done:
Ran the unit tests and forced them to fail as well.

Reviewed at https://reviews.imfreedom.org/r/2524/

libpurple/purpleprotocolroster.c file | annotate | diff | comparison | revisions
libpurple/tests/test_protocol_roster.c file | annotate | diff | comparison | revisions
--- a/libpurple/purpleprotocolroster.c	Wed Jul 19 18:11:18 2023 -0500
+++ b/libpurple/purpleprotocolroster.c	Wed Jul 19 18:13:10 2023 -0500
@@ -23,7 +23,7 @@
 #include "purpleprotocolroster.h"
 
 /******************************************************************************
- * GObject Implementation
+ * GInterface Implementation
  *****************************************************************************/
 G_DEFINE_INTERFACE(PurpleProtocolRoster, purple_protocol_roster,
                    PURPLE_TYPE_PROTOCOL)
@@ -51,6 +51,9 @@
 	iface = PURPLE_PROTOCOL_ROSTER_GET_IFACE(roster);
 	if(iface != NULL && iface->add_async != NULL) {
 		iface->add_async(roster, contact, cancellable, callback, data);
+	} else {
+		g_warning("%s does not implement the add_async method",
+		          G_OBJECT_TYPE_NAME(roster));
 	}
 }
 
@@ -85,6 +88,9 @@
 	iface = PURPLE_PROTOCOL_ROSTER_GET_IFACE(roster);
 	if(iface != NULL && iface->update_async != NULL) {
 		iface->update_async(roster, contact, cancellable, callback, data);
+	} else {
+		g_warning("%s does not implement the update_async method",
+		          G_OBJECT_TYPE_NAME(roster));
 	}
 }
 
@@ -119,6 +125,9 @@
 	iface = PURPLE_PROTOCOL_ROSTER_GET_IFACE(roster);
 	if(iface != NULL && iface->remove_async != NULL) {
 		iface->remove_async(roster, contact, cancellable, callback, data);
+	} else {
+		g_warning("%s does not implement the remove_async method",
+		          G_OBJECT_TYPE_NAME(roster));
 	}
 }
 
--- a/libpurple/tests/test_protocol_roster.c	Wed Jul 19 18:11:18 2023 -0500
+++ b/libpurple/tests/test_protocol_roster.c	Wed Jul 19 18:13:10 2023 -0500
@@ -50,6 +50,113 @@
 }
 
 /******************************************************************************
+ * TestProtocolRosterEmpty implementation
+ *****************************************************************************/
+G_DECLARE_FINAL_TYPE(TestPurpleProtocolRosterEmpty,
+                     test_purple_protocol_roster_empty,
+                     TEST_PURPLE, PROTOCOL_ROSTER_EMPTY, PurpleProtocol)
+
+struct _TestPurpleProtocolRosterEmpty {
+	PurpleProtocol parent;
+};
+
+static void
+test_purple_protocol_roster_empty_iface_init(G_GNUC_UNUSED PurpleProtocolRosterInterface *iface)
+{
+}
+
+G_DEFINE_TYPE_WITH_CODE(TestPurpleProtocolRosterEmpty,
+                        test_purple_protocol_roster_empty,
+                        PURPLE_TYPE_PROTOCOL,
+                        G_IMPLEMENT_INTERFACE(PURPLE_TYPE_PROTOCOL_ROSTER,
+                                              test_purple_protocol_roster_empty_iface_init))
+
+static void
+test_purple_protocol_roster_empty_init(G_GNUC_UNUSED TestPurpleProtocolRosterEmpty *empty)
+{
+}
+
+static void
+test_purple_protocol_roster_empty_class_init(G_GNUC_UNUSED TestPurpleProtocolRosterEmptyClass *klass)
+{
+}
+
+/******************************************************************************
+ * TestProtocolRosterEmpty Tests
+ *****************************************************************************/
+static void
+test_purple_protocol_roster_empty_add(void) {
+	if(g_test_subprocess()) {
+		PurpleAccount *account = NULL;
+		PurpleContact *contact = NULL;
+		PurpleProtocolRoster *roster = NULL;
+
+		roster = g_object_new(test_purple_protocol_roster_empty_get_type(),
+		                      NULL);
+
+		account = purple_account_new("test", "test");
+		contact = purple_contact_new(account, NULL);
+		g_clear_object(&account);
+
+		purple_protocol_roster_add_async(roster, contact, NULL, NULL, NULL);
+
+		g_clear_object(&roster);
+		g_clear_object(&contact);
+	}
+
+	g_test_trap_subprocess(NULL, 0, 0);
+	g_test_trap_assert_stderr("*Purple-WARNING*TestPurpleProtocolRosterEmpty*add_async*");
+}
+
+static void
+test_purple_protocol_roster_empty_update(void) {
+	if(g_test_subprocess()) {
+		PurpleAccount *account = NULL;
+		PurpleContact *contact = NULL;
+		PurpleProtocolRoster *roster = NULL;
+
+		roster = g_object_new(test_purple_protocol_roster_empty_get_type(),
+		                      NULL);
+
+		account = purple_account_new("test", "test");
+		contact = purple_contact_new(account, NULL);
+		g_clear_object(&account);
+
+		purple_protocol_roster_update_async(roster, contact, NULL, NULL, NULL);
+
+		g_clear_object(&roster);
+		g_clear_object(&contact);
+	}
+
+	g_test_trap_subprocess(NULL, 0, 0);
+	g_test_trap_assert_stderr("*Purple-WARNING*TestPurpleProtocolRosterEmpty*update_async*");
+}
+
+static void
+test_purple_protocol_roster_empty_remove(void) {
+	if(g_test_subprocess()) {
+		PurpleAccount *account = NULL;
+		PurpleContact *contact = NULL;
+		PurpleProtocolRoster *roster = NULL;
+
+		roster = g_object_new(test_purple_protocol_roster_empty_get_type(),
+		                      NULL);
+
+		account = purple_account_new("test", "test");
+		contact = purple_contact_new(account, NULL);
+		g_clear_object(&account);
+
+		purple_protocol_roster_remove_async(roster, contact, NULL, NULL, NULL);
+
+		g_clear_object(&roster);
+		g_clear_object(&contact);
+	}
+
+	g_test_trap_subprocess(NULL, 0, 0);
+	g_test_trap_assert_stderr("*Purple-WARNING*TestPurpleProtocolRosterEmpty*remove_async*");
+}
+
+/******************************************************************************
  * TestProtocolRoster implementation
  *****************************************************************************/
 G_DECLARE_FINAL_TYPE(TestPurpleProtocolRoster, test_purple_protocol_roster,
@@ -199,7 +306,7 @@
 }
 
 /******************************************************************************
- * Add test
+ * TestProtocolRoster Add test
  *****************************************************************************/
 static void
 test_purple_protocol_roster_add_cb(GObject *obj, GAsyncResult *res,
@@ -287,7 +394,7 @@
 ;}
 
 /******************************************************************************
- * Update test
+ * TestProtocolRoster Update test
  *****************************************************************************/
 static void
 test_purple_protocol_roster_update_cb(GObject *obj, GAsyncResult *res,
@@ -375,7 +482,7 @@
 ;}
 
 /******************************************************************************
- * Remove test
+ * TestProtocolRoster Remove test
  *****************************************************************************/
 static void
 test_purple_protocol_roster_remove_cb(GObject *obj, GAsyncResult *res,
@@ -475,6 +582,13 @@
 
 	loop = g_main_loop_new(NULL, FALSE);
 
+	g_test_add_func("/protocol-roster/empty/add",
+	                test_purple_protocol_roster_empty_add);
+	g_test_add_func("/protocol-roster/empty/update",
+	                test_purple_protocol_roster_empty_update);
+	g_test_add_func("/protocol-roster/empty/remove",
+	                test_purple_protocol_roster_empty_remove);
+
 	g_test_add_func("/protocol-roster/add", test_purple_protocol_roster_add);
 	g_test_add_func("/protocol-roster/add-error",
 	                test_purple_protocol_roster_add_error);

mercurial