eldbus: add test suite for eldbus (eldbus_signal_handler*)
authorMykola Solyanko <m.solyanko@samsung.com>
Mon, 5 Jun 2017 20:44:14 +0000 (13:44 -0700)
committerCedric BAIL <cedric@osg.samsung.com>
Mon, 5 Jun 2017 20:44:17 +0000 (13:44 -0700)
Summary:
add tests for next API:
eldbus_signal_handler_add()
eldbus_signal_handler_del()
eldbus_signal_handler_connection_get()
eldbus_signal_handler_interface_get()
eldbus_signal_handler_member_get()
eldbus_signal_handler_path_get()
eldbus_signal_handler_sender_get()
eldbus_signal_handler_ref()
eldbus_signal_handler_unref()
eldbus_signal_handler_free_cb_add()
eldbus_signal_handler_free_cb_del()

Reviewers: cedric, NikaWhite, myoungwoon, raster, artem.popov

Subscribers: jpeg

Differential Revision: https://phab.enlightenment.org/D4910

Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
src/Makefile_Eldbus.am
src/tests/eldbus/CMakeLists.txt
src/tests/eldbus/eldbus_suite.c
src/tests/eldbus/eldbus_suite.h
src/tests/eldbus/eldbus_test_eldbus_signal_handler.c [new file with mode: 0644]

index fe71705..988e892 100644 (file)
@@ -133,6 +133,7 @@ tests/eldbus/eldbus_test_eldbus_model_method.c \
 tests/eldbus/eldbus_test_eldbus_model_signal.c \
 tests/eldbus/eldbus_test_eldbus_object.c \
 tests/eldbus/eldbus_test_eldbus_message.c \
+tests/eldbus/eldbus_test_eldbus_signal_handler.c \
 tests/eldbus/eldbus_test_fake_server_eldbus_model_proxy.c \
 tests/eldbus/eldbus_fake_server.c \
 tests/eldbus/eldbus_suite.h
index 761f406..10f03d1 100644 (file)
@@ -13,6 +13,7 @@ set(SOURCES
   eldbus_test_eldbus_model_signal.c
   eldbus_test_eldbus_object.c
   eldbus_test_eldbus_message.c
+  eldbus_test_eldbus_signal_handler.c
   eldbus_test_fake_server_eldbus_model_proxy.c
 )
 
index d8d7d47..1e6fbc9 100644 (file)
@@ -16,6 +16,7 @@ static const Efl_Test_Case etc[] = {
   { "eldbus_model_signal", eldbus_test_eldbus_model_signal },
   { "eldbus_test_eldbus_object", eldbus_test_eldbus_object },
   { "eldbus_test_eldbus_message", eldbus_test_eldbus_message },
+  { "eldbus_test_eldbus_signal_handler", eldbus_test_eldbus_signal_handler },
   { NULL, NULL }
 };
 
index 7c005c7..dd26ce5 100644 (file)
@@ -13,5 +13,6 @@ void eldbus_test_eldbus_model_method(TCase *tc);
 void eldbus_test_eldbus_model_signal(TCase *tc);
 void eldbus_test_eldbus_object(TCase *tc);
 void eldbus_test_eldbus_message(TCase *tc);
+void eldbus_test_eldbus_signal_handler(TCase *tc);
 
 #endif
diff --git a/src/tests/eldbus/eldbus_test_eldbus_signal_handler.c b/src/tests/eldbus/eldbus_test_eldbus_signal_handler.c
new file mode 100644 (file)
index 0000000..255dd97
--- /dev/null
@@ -0,0 +1,483 @@
+#include <Eldbus.h>
+#include <Ecore.h>
+#include <string.h>
+#include <stdio.h>
+#include <Eina.h>
+
+#include "eldbus_suite.h"
+
+static const char *bus = "org.freedesktop.DBus";
+static const char *path = "/org/freedesktop/DBus";
+static const char *interface = "org.freedesktop.DBus";
+static const char *signal_name = "NameOwnerChanged";
+
+static int cb_data = 5;
+
+static Eina_Bool is_success_cb = EINA_FALSE;
+
+static Ecore_Timer *timeout = NULL;
+
+/**
+* @addtogroup eldbus
+* @{
+* @defgroup eldbus_signal_handler
+*
+* @precondition
+* @step 1 Initialize ecore with ecore_init()
+* @step 2 Initialize eldbus with eldbus_init()
+*/
+
+static void
+_setup(void)
+{
+   ecore_init();
+   int ret = eldbus_init();
+   ck_assert_int_ge(ret, 1);
+}
+
+static void
+_teardown(void)
+{
+   ecore_shutdown();
+   int ret = eldbus_shutdown();
+   ck_assert_int_eq(ret, 0);
+}
+
+static Eina_Bool
+_ecore_loop_close(void *data EINA_UNUSED)
+{
+   ecore_main_loop_quit();
+
+   return ECORE_CALLBACK_CANCEL;
+}
+
+static void
+_signal_name_owner_changed(void *data, const Eldbus_Message *msg)
+{
+   const char *errname, *errmsg;
+   int *user_data = data;
+
+   if (timeout != NULL)
+     {
+        ecore_timer_del(timeout);
+        timeout = NULL;
+     }
+
+   if ((user_data) && (*user_data == cb_data))
+     {
+        if (!eldbus_message_error_get(msg, &errname, &errmsg))
+          {
+             is_success_cb = EINA_TRUE;
+          }
+     }
+
+   ecore_main_loop_quit();
+}
+
+static void
+_response_message_cb(void *data EINA_UNUSED, const Eldbus_Message *msg EINA_UNUSED, Eldbus_Pending *pending EINA_UNUSED)
+{
+}
+
+static void
+_signal_handler_free_cb(void *data, const void *deadptr EINA_UNUSED)
+{
+   int *user_data = data;
+
+   if (timeout != NULL)
+     {
+        ecore_timer_del(timeout);
+        timeout = NULL;
+     }
+
+   if ((user_data) && (*user_data == cb_data))
+     is_success_cb = EINA_TRUE;
+
+   ecore_main_loop_quit();
+}
+
+static Eldbus_Signal_Handler *
+_signal_handler_get(Eldbus_Connection *conn)
+{
+   is_success_cb = EINA_FALSE;
+
+   Eldbus_Signal_Handler *signal_handler = eldbus_signal_handler_add(conn, NULL, path, interface,
+                                                                     signal_name, _signal_name_owner_changed, &cb_data);
+
+   if (!signal_handler)
+     {
+        return NULL;
+     }
+
+   timeout = ecore_timer_add(1.5, _ecore_loop_close, NULL);
+   if (!timeout)
+     {
+        eldbus_signal_handler_unref(signal_handler);
+        return NULL;
+     }
+
+   return signal_handler;
+}
+
+/**
+ * @addtogroup eldbus_signal_handler
+ * @{
+ * @defgroup eldbus_signal_handler_add eldbus_signal_handler_add()
+ * @{
+ * @objective Positive test case checks that function add a signal handler without error.
+ *
+ * @n Input Data:
+ * @li the conn connection object
+ * @li the msg message connection object
+ * @li callback function to be called
+ * @li data passed to callback
+ *
+ * @procedure
+ * @step 1 Get eldbus connection object and check on NULL
+ * @step 2 Call eldbus_signal_handler_add with callback function and data
+ * to be called when this signal is received.
+ * @step 3 Check returned signal handler object on NULL.
+ * @step 4 Call eldbus_message_signal_new to create a new signal message.
+ * @step 5 Check returned message object on NULL.
+ * @step 6 Call eldbus_connection_send to send a signal a dbus object.
+ * @step 7 Check returned pending object on NULL.
+ * @step 8 Set timer for preschedule termination of main loop if tested callback wasn't executed.
+ * @step 9 Start of main loop and wait for tested response in callback executing.
+ * @step 10 Check static variables named is_success_cb.
+ * If are equals 1, that callback was executed and signal is received without error.
+ * In other cases error.
+ * @step 11 Call eldbus_message_unref function to delete message object
+ * @step 12 Call eldbus_signal_handler_unref function to delete signal handler object
+ * @step 13 Call eldbus_connection_unref function to delete connection object
+ *
+ * @passcondition Variables named is_success_cb must equals 1, and there is no segmentation fault.
+ * @}
+ * @}
+ */
+START_TEST(utc_eldbus_signal_handler_add_p)
+{
+   is_success_cb = EINA_FALSE;
+
+   Eldbus_Connection *conn = eldbus_connection_get(ELDBUS_CONNECTION_TYPE_SYSTEM);
+   ck_assert_ptr_ne(NULL, conn);
+
+   Eldbus_Signal_Handler *signal_handler = eldbus_signal_handler_add(conn, NULL, path, interface,
+                                                                     signal_name, _signal_name_owner_changed, &cb_data);
+
+   ck_assert_ptr_ne(NULL, signal_handler);
+
+   Eldbus_Message *msg = eldbus_message_signal_new(path, interface, signal_name);
+   ck_assert_ptr_ne(NULL, signal_handler);
+
+   Eldbus_Pending *pending = eldbus_connection_send(conn, msg, _response_message_cb, NULL, -1);
+   ck_assert_ptr_ne(NULL, pending);
+
+   timeout = ecore_timer_add(1.5, _ecore_loop_close, NULL);
+   ck_assert_ptr_ne(NULL, timeout);
+
+   ecore_main_loop_begin();
+
+   ck_assert_msg(is_success_cb, "Signal %s is not call", signal_name);
+
+   eldbus_message_unref(msg);
+   eldbus_signal_handler_unref(signal_handler);
+   eldbus_connection_unref(conn);
+}
+END_TEST
+
+/**
+ * @addtogroup eldbus_signal_handler
+ * @{
+ * @defgroup eldbus_signal_handler_del eldbus_signal_handler_del()
+ * @{
+ * @objective Positive test case checks that function add and delete a signal handler without error.
+ *
+ * @n Input Data:
+ * @li the conn connection object
+ * @li the msg message connection object
+ * @li callback function to be called
+ * @li data passed to callback
+ *
+ * @procedure
+ * @step 1 Get eldbus connection object and check on NULL
+ * @step 2 Call eldbus_signal_handler_add with callback function and data
+ * to be called when this signal is received.
+ * @step 3 Check returned signal handler object on NULL.
+ * @step 4 Call eldbus_signal_handler_del the signal handler will stop listening to signals.
+ * @step 5 Call eldbus_message_signal_new to create a new signal message.
+ * @step 6 Check returned message object on NULL.
+ * @step 7 Call eldbus_connection_send to send a signal a dbus object.
+ * @step 8 Check returned pending object on NULL.
+ * @step 9 Set timer for preschedule termination of main loop if tested callback wasn't executed.
+ * @step 10 Start of main loop and wait for tested response in callback executing.
+ * @step 11 Check static variables named is_success_cb.
+ * If is equal 1, that callback was executed and this is error.
+ * @step 12 Call eldbus_message_unref function to delete message object
+ * @step 13 Call eldbus_signal_handler_unref function to delete signal handler object
+ * @step 14 Call eldbus_connection_unref function to delete connection object
+ *
+ * @passcondition Variables named is_success_cb must equals 0
+ * and eldbus_signal_handler_del must be delete registered callback, and there is no segmentation fault.
+ * @}
+ * @}
+ */
+START_TEST(utc_eldbus_signal_handler_del_p)
+{
+   is_success_cb = EINA_FALSE;
+
+   Eldbus_Connection *conn = eldbus_connection_get(ELDBUS_CONNECTION_TYPE_SYSTEM);
+   ck_assert_ptr_ne(NULL, conn);
+
+   Eldbus_Signal_Handler *signal_handler = eldbus_signal_handler_add(conn, NULL, path, interface,
+                                                                     signal_name, _signal_name_owner_changed, &cb_data);
+
+   ck_assert_ptr_ne(NULL, signal_handler);
+
+   eldbus_signal_handler_del(signal_handler);
+
+   Eldbus_Message *msg = eldbus_message_signal_new(path, interface, signal_name);
+   ck_assert_ptr_ne(NULL, msg);
+
+   Eldbus_Pending *pending = eldbus_connection_send(conn, msg, _response_message_cb, NULL, -1);
+   ck_assert_ptr_ne(NULL, pending);
+
+   timeout = ecore_timer_add(1.5, _ecore_loop_close, NULL);
+   ck_assert_ptr_ne(NULL, timeout);
+
+   ecore_main_loop_begin();
+
+   ck_assert_msg(!is_success_cb, "Signal %s was called", signal_name);
+
+   eldbus_message_unref(msg);
+   eldbus_signal_handler_unref(signal_handler);
+   eldbus_connection_unref(conn);
+}
+END_TEST
+
+/**
+ * @addtogroup eldbus_signal_handler
+ * @{
+ * @defgroup eldbus_signal_handler_get
+ * @li eldbus_signal_handler_connection_get()
+ * @li eldbus_signal_handler_interface_get()
+ * @li eldbus_signal_handler_member_get()
+ * @li eldbus_signal_handler_path_get()
+ * @li eldbus_signal_handler_sender_get()
+ * @{
+ * @objective Positive test case checks those functions return valid expected value.
+ *
+ * @n Input Data:
+ * @li the conn connection object
+ * @li the path to bus interface
+ * @li the sender bus name
+ * @li the interface bus interface
+ * @li the signal_name bus signal name
+ *
+ * @procedure
+ * @step 1 Get eldbus connection object and check on NULL
+ * @step 2 Call eldbus_signal_handler_add with callback function and data
+ * to be called when this signal is received.
+ * @step 3 Check returned signal handler object on NULL.
+ * @step 4 Call eldbus_signal_handler_connection_get and check on expected value.
+ * @step 5 Call eldbus_signal_handler_path_get and check on expected value.
+ * @step 6 Call eldbus_signal_handler_sender_get and check on expected value.
+ * @step 7 Call eldbus_signal_handler_interface_get and check on expected value.
+ * @step 8 Call eldbus_signal_handler_member_get and check on expected value.
+ * @step 9 Call eldbus_connection_unref function to delete signal handler object
+ * @step 10 Call eldbus_connection_unref function to delete connection object
+ *
+ * @passcondition Functions should returns valid expected value and without segmentation fault.
+ * @}
+ * @}
+ */
+START_TEST(utc_eldbus_signal_handler_get_p)
+{
+   Eldbus_Connection *conn = eldbus_connection_get(ELDBUS_CONNECTION_TYPE_SYSTEM);
+   ck_assert_ptr_ne(NULL, conn);
+
+   Eldbus_Signal_Handler *signal_handler = eldbus_signal_handler_add(conn, bus, path, interface,
+                                                                     signal_name, _signal_name_owner_changed, &cb_data);
+   ck_assert_ptr_ne(NULL, signal_handler);
+
+   Eldbus_Connection *conn_get = eldbus_signal_handler_connection_get(signal_handler);
+   ck_assert_msg((conn_get == conn), "Connection objects are different");
+
+   const char *signal_path = eldbus_signal_handler_path_get(signal_handler);
+   ck_assert_msg(NULL != signal_path, "Signal path is null");
+   ck_assert_msg((!strcmp(signal_path, path)), "Signal path is different than original");
+
+   const char *signal_sender = eldbus_signal_handler_sender_get(signal_handler);
+   ck_assert_msg(NULL != signal_sender, "Signal sender is null");
+   ck_assert_msg((!strcmp(signal_sender, bus)), "Signal sender is different than original");
+
+   const char *signal_interface = eldbus_signal_handler_interface_get(signal_handler);
+   ck_assert_msg(NULL != signal_interface, "Signal interface is null");
+   ck_assert_msg((!strcmp(signal_interface, interface)), "Signal interface is different than original");
+
+   const char *signal_handler_name = eldbus_signal_handler_member_get(signal_handler);
+   ck_assert_msg(NULL != signal_handler_name, "Signal name is null");
+   ck_assert_msg((!strcmp(signal_handler_name, signal_name)), "Signal name is different than original");
+
+   eldbus_signal_handler_unref(signal_handler);
+   eldbus_connection_unref(conn);
+}
+END_TEST
+
+/**
+ * @addtogroup eldbus_signal_handler
+ * @{
+ * @defgroup eldbus_signal_handler_ref_unref
+ * @li eldbus_signal_handler_ref()
+ * @li eldbus_signal_handler_unref()
+ * @{
+ * @objective Positive test case checks that function increase, Decrease signal handler reference without error.
+ *
+ * @n Input Data:
+ * @li the conn connection object
+ * @li the signal_handler signal handler object
+ *
+ * @procedure
+ * @step 1 Get eldbus connection object and check on NULL
+ * @step 2 Call eldbus_signal_handler_add with callback function and data
+ * to be called when this signal is received.
+ * @step 3 Check returned signal handler object on NULL.
+ * @step 4 Call eldbus_signal_handler_ref the increase signal handler reference.
+ * @step 5 Check returned signal ref handler object with original signal handler object.
+ * @step 6 Call eldbus_signal_handler_unref function decrease reference signal handler reference
+ * @step 7 Call eldbus_signal_handler_unref function decrease original signal handler reference
+ * @step 8 Call eldbus_message_signal_new to create a new signal message.
+ * @step 9 Check returned message object on NULL.
+ * @step 10 Call eldbus_connection_send to send a signal a dbus object.
+ * @step 11 Check returned pending object on NULL.
+ * @step 12 Set timer for preschedule termination of main loop if tested callback wasn't executed.
+ * @step 13 Start of main loop and wait for tested response in callback executing.
+ * @step 14 Check static variables named is_success_cb.
+ * If is equal 1, that callback was executed and this is error.
+ * @step 15 Call eldbus_message_unref function to delete message object
+ * @step 16 Call eldbus_connection_unref function to delete connection object
+ *
+ * @passcondition Variables named is_success_cb must equals 0
+ * and eldbus_signal_handler_unref must be decrease signal handler reference, and there is no segmentation fault.
+ * @}
+ * @}
+ */
+
+START_TEST(utc_eldbus_signal_handler_ref_unref_p)
+{
+   is_success_cb = EINA_FALSE;
+
+   Eldbus_Connection *conn = eldbus_connection_get(ELDBUS_CONNECTION_TYPE_SYSTEM);
+   ck_assert_ptr_ne(NULL, conn);
+
+   Eldbus_Signal_Handler *signal_handler = eldbus_signal_handler_add(conn, NULL, path, interface,
+                                                                     signal_name, _signal_name_owner_changed, &cb_data);
+   ck_assert_ptr_ne(NULL, signal_handler);
+
+   Eldbus_Signal_Handler* signal_ref = eldbus_signal_handler_ref(signal_handler);
+   ck_assert_msg((signal_ref == signal_handler), "Signal references are different");
+
+   eldbus_signal_handler_unref(signal_ref);
+   eldbus_signal_handler_unref(signal_handler);
+
+   Eldbus_Message *msg = eldbus_message_signal_new(path, interface, signal_name);
+   ck_assert_ptr_ne(NULL, msg);
+
+   Eldbus_Pending *pending = eldbus_connection_send(conn, msg, _response_message_cb, NULL, -1);
+   ck_assert_ptr_ne(NULL, pending);
+
+   timeout = ecore_timer_add(1.5, _ecore_loop_close, NULL);
+   ck_assert_ptr_ne(NULL, timeout);
+
+   ecore_main_loop_begin();
+
+   ck_assert_msg(!is_success_cb, "Signal %s was called", signal_name);
+
+   eldbus_message_unref(msg);
+   eldbus_connection_unref(conn);
+}
+END_TEST
+
+/**
+ * @addtogroup eldbus_signal_handler
+ * @{
+ * @defgroup eldbus_signal_handler_free_cb
+ * @li eldbus_signal_handler_free_cb_add()
+ * @li eldbus_signal_handler_free_cb_del()
+ * @{
+ * @objective Positive test case checks that function add and delete a callback function without error.
+ *
+ * @n Input Data:
+ * @li the conn connection object
+ * @li the signal_handler signal handler object
+ *
+ * @procedure
+ * @step 1 Get eldbus connection object and check on NULL
+ * @step 2 Get signal handler object and check on NULL.
+ * @step 3 Call eldbus_signal_handler_free_cb_add to add a callback function
+ * to be called when signal handler will be freed.
+ * @step 4 Call eldbus_signal_handler_unref function decrease reference signal handler reference
+ * @step 5 Start of main loop and wait for tested response in callback executing.
+ * @step 6 Check static variables named is_success_cb.
+ * If is equal 1, that callback was executed ignal handler was freed is received without error.
+
+ * @step 7 Get signal handler object and check on NULL.
+ * @step 8 Call eldbus_signal_handler_free_cb_add to add a callback function
+ * to be called when signal handler will be freed.
+ * @step 9 Call eldbus_signal_handler_free_cb_del to remove callback registered
+ * in eldbus_signal_handler_free_cb_add().
+ * @step 10 Call eldbus_signal_handler_unref function decrease reference signal handler reference
+ * @step 11 Check static variables named is_success_cb.
+ * If is equal 1, that callback was executed and this is error.
+ * @step 12 Call eldbus_connection_unref function to delete connection object
+ *
+ * @passcondition The function should add and delete registered callback function,
+ * and there is no segmentation fault.
+ * @}
+ * @}
+ */
+
+START_TEST(utc_eldbus_signal_handler_free_cb_add_del_p)
+{
+   Eldbus_Connection *conn = eldbus_connection_get(ELDBUS_CONNECTION_TYPE_SYSTEM);
+   ck_assert_ptr_ne(NULL, conn);
+
+   Eldbus_Signal_Handler *signal_handler = _signal_handler_get(conn);
+   ck_assert_ptr_ne(NULL, signal_handler);
+
+   eldbus_signal_handler_free_cb_add(signal_handler, _signal_handler_free_cb, &cb_data);
+
+   eldbus_signal_handler_unref(signal_handler);
+
+   ecore_main_loop_begin();
+
+   ck_assert_msg(is_success_cb, "Callback is not called");
+
+   signal_handler = _signal_handler_get(conn);
+   ck_assert_ptr_ne(NULL, signal_handler);
+
+   eldbus_signal_handler_free_cb_add(signal_handler, _signal_handler_free_cb, &cb_data);
+   eldbus_signal_handler_free_cb_del(signal_handler, _signal_handler_free_cb, &cb_data);
+
+   eldbus_signal_handler_unref(signal_handler);
+
+   ecore_main_loop_begin();
+
+   ck_assert_msg(!is_success_cb, "Callback was called");
+
+   eldbus_connection_unref(conn);
+}
+END_TEST
+
+/**
+ *@}
+ */
+void
+eldbus_test_eldbus_signal_handler(TCase *tc)
+{
+   tcase_add_checked_fixture(tc, _setup, _teardown);
+   tcase_add_test(tc, utc_eldbus_signal_handler_add_p);
+   tcase_add_test(tc, utc_eldbus_signal_handler_del_p);
+   tcase_add_test(tc, utc_eldbus_signal_handler_get_p);
+   tcase_add_test(tc, utc_eldbus_signal_handler_ref_unref_p);
+   tcase_add_test(tc, utc_eldbus_signal_handler_free_cb_add_del_p);
+}
\ No newline at end of file