/* GStreamer
*
* unit test for GstObject
*
* Copyright (C) <2004> Thomas Vander Stichele <thomas at apestaart dot org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <gst/check/gstcheck.h>
/*
Create a fake subclass
*/
typedef struct _GstFakeObjectClass GstFakeObjectClass;
typedef struct _GstFakeObject GstFakeObject;
struct _GstFakeObject
{
GstObject object;
};
struct _GstFakeObjectClass
{
GstObjectClass parent_class;
};
//static GstObjectClass *parent_class = NULL;
//static guint gst_fake_object_signals[LAST_SIGNAL] = { 0 };
static GType
gst_fake_object_get_type (void)
{
static volatile gsize fake_object_type = 0;
if (g_once_init_enter (&fake_object_type)) {
GType type;
static const GTypeInfo fake_object_info = {
sizeof (GstFakeObjectClass),
NULL, //gst_fake_object_base_class_init,
NULL, //gst_fake_object_base_class_finalize,
NULL, //(GClassInitFunc) gst_fake_object_class_init,
NULL,
NULL,
sizeof (GstFakeObject),
0,
NULL, //(GInstanceInitFunc) gst_fake_object_init,
NULL
};
type = g_type_register_static (GST_TYPE_OBJECT,
"GstFakeObject", &fake_object_info, 0);
g_once_init_leave (&fake_object_type, type);
}
return fake_object_type;
}
/* g_object_new on GstFakeObject should succeed */
GST_START_TEST (test_fake_object_new)
{
GstObject *object;
object = g_object_new (gst_fake_object_get_type (), NULL);
fail_if (object == NULL, "Failed to create instance of GstFakeObject");
fail_unless (GST_IS_OBJECT (object),
"GstFakeObject instance is not a GstObject");
gst_object_unref (object);
}
GST_END_TEST;
static void
notify_name (GObject * object, GParamSpec * pspec, gint * out_count)
{
*out_count += 1;
}
/* GstFakeObject name tests */
GST_START_TEST (test_fake_object_initial_name)
{
GstObject *object;
gchar *name;
object = g_object_new (gst_fake_object_get_type (), NULL);
name = gst_object_get_name (object);
fail_if (name == NULL, "Newly created object has no name");
fail_if (strncmp (name, "fakeobject", 10) != 0,
"Random name %s does not start with 'fakeobject'", name);
g_free (name);
gst_object_unref (object);
}
GST_END_TEST;
GST_START_TEST (test_fake_object_reset_name)
{
GstObject *object;
gchar *name;
gint count = 0;
object = g_object_new (gst_fake_object_get_type (), NULL);
g_signal_connect (object, "notify::name", G_CALLBACK (notify_name), &count);
/* give a random name by setting with NULL;
* GstFakeObject class -> fakeobject%d */
fail_unless (gst_object_set_name (object, NULL), "Could not set name");
name = gst_object_get_name (object);
fail_if (name == NULL, "Random name was not assigned");
fail_if (strncmp (name, "fakeobject", 10) != 0,
"Random name %s does not start with 'fakeobject'", name);
g_free (name);
fail_unless (count == 1, "Name change was not notified");
gst_object_unref (object);
}
GST_END_TEST;
GST_START_TEST (test_fake_object_set_name_via_property)
{
GstObject *object;
gchar *name;
gint count = 0;
object = g_object_new (gst_fake_object_get_type (), NULL);
g_signal_connect (object, "notify::name", G_CALLBACK (notify_name), &count);
/* also test the property code path */
g_object_set (object, "name", "fake", NULL);
name = gst_object_get_name (object);
fail_if (name == NULL, "Failed to get name of GstFakeObject");
fail_if (strcmp (name, "fake") != 0, "Name of GstFakeObject is not 'fake'");
g_free (name);
fail_if (count > 1, "Name change was notified multiple time");
fail_unless (count == 1, "Name change was not notified");
gst_object_unref (object);
}
GST_END_TEST;
GST_START_TEST (test_fake_object_get_name_returns_copy)
{
GstObject *object;
gchar *name1, *name2;
object = g_object_new (gst_fake_object_get_type (), NULL);
/* change the gotten name to see that it's a copy and not the original */
name1 = gst_object_get_name (object);
name1[0] = 'm';
name2 = gst_object_get_name (object);
fail_if (strncmp (name2, "fakeobject", 10) != 0,
"Copy of object name affected actual object name");
g_free (name1);
g_free (name2);
gst_object_unref (object);
}
GST_END_TEST;
GST_START_TEST (test_fake_object_set_name_when_parented)
{
GstObject *object, *parent;
object = g_object_new (gst_fake_object_get_type (), NULL);
/* add a parent and ensure name cannot be changed */
parent = g_object_new (gst_fake_object_get_type (), NULL);
gst_object_set_parent (object, parent);
fail_if (gst_object_set_name (object, "broken"),
"Could set name on parented object");
gst_object_unparent (object);
gst_object_unref (parent);
}
GST_END_TEST;
/* thread function for threaded name change test */
static gpointer
thread_name_object (GstObject * object)
{
gchar *thread_id = g_strdup_printf ("%p", g_thread_self ());
THREAD_START ();
/* give main thread a head start */
g_usleep (100000);
/* write our name repeatedly */
g_message ("THREAD %s: starting loop", thread_id);
while (THREAD_TEST_RUNNING ()) {
gst_object_set_name (object, thread_id);
/* a minimal sleep invokes a thread switch */
THREAD_SWITCH ();
}
/* thread is done, so let's return */
g_message ("THREAD %s: set name", thread_id);
g_free (thread_id);
return NULL;
}
#if 0
GST_START_TEST (test_fake_object_name_threaded_wrong)
{
GstObject *object;
gchar *name;
gint i;
gboolean expected_failure = FALSE;
g_message ("\nTEST: set/get without lock");
object = g_object_new (gst_fake_object_get_type (), NULL);
gst_object_set_name (object, "main");
MAIN_START_THREADS (5, thread_name_object, object);
/* start looping and set/get name repeatedly */
for (i = 0; i < 1000; ++i) {
gst_object_set_name (object, "main");
THREAD_SWITCH ();
name = gst_object_get_name (object);
if (strcmp (name, "main") != 0) {
g_message ("MAIN: expected failure during run %d", i);
expected_failure = TRUE;
g_free (name);
break;
}
g_free (name);
}
MAIN_STOP_THREADS ();
gst_object_unref (object);
fail_unless (expected_failure, "name did not get changed");
}
GST_END_TEST;
#endif
/*
* main thread sets and gets name directly on struct inside the object lock
* succeed because lock is held during set/get, and threads are locked out
*/
GST_START_TEST (test_fake_object_name_threaded_right)
{
GstObject *object;
gchar *name;
gint i;
g_message ("\nTEST: set/get inside lock");
object = g_object_new (gst_fake_object_get_type (), NULL);
gst_object_set_name (object, "main");
MAIN_START_THREADS (5, thread_name_object, object);
/* start looping and set/get name repeatedly */
for (i = 0; i < 1000; ++i) {
GST_OBJECT_LOCK (object);
g_free (GST_OBJECT_NAME (object));
GST_OBJECT_NAME (object) = g_strdup ("main");
THREAD_SWITCH ();
name = g_strdup (GST_OBJECT_NAME (object));
GST_OBJECT_UNLOCK (object);
fail_unless (strcmp (name, "main") == 0,
"Name got changed while lock held during run %d", i);
g_free (name);
}
MAIN_STOP_THREADS ();
gst_object_unref (object);
}
GST_END_TEST;
/*
* main thread creates lots of objects
* child threads sets default names on objects
* then main thread checks uniqueness of object names
*/
static GList *object_list = NULL;
static gint num_objects = 1000;
static gint num_threads = 5;
/* thread function for threaded default name change test */
static gpointer
thread_name_object_default (int *i)
{
int j;
THREAD_START ();
for (j = *i; j < num_objects; j += num_threads) {
GstObject *o = GST_OBJECT (g_list_nth_data (object_list, j));
/* g_message ("THREAD %p: setting default name on object %d",
g_thread_self (), j); */
gst_object_set_name (o, NULL);
THREAD_SWITCH ();
}
/* thread is done, so let's return */
g_message ("THREAD %p: set name", g_thread_self ());
g_free (i);
return NULL;
}
static gint
gst_object_name_compare (GstObject * o, GstObject * p)
{
gint result;
GST_OBJECT_LOCK (o);
GST_OBJECT_LOCK (p);
if (o->name == NULL && p->name == NULL) {
result = 0;
} else if (o->name == NULL) {
result = -1;
} else if (p->name == NULL) {
result = 1;
} else {
result = strcmp (o->name, p->name);
}
GST_OBJECT_UNLOCK (p);
GST_OBJECT_UNLOCK (o);
return result;
}
GST_START_TEST (test_fake_object_name_threaded_unique)
{
GstObject *object;
gint i;
gint *ip;
gchar *name1, *name2;
GList *l;
g_message ("\nTEST: uniqueness of default names");
for (i = 0; i < num_objects; ++i) {
object = g_object_new (gst_fake_object_get_type (), NULL);
object_list = g_list_append (object_list, object);
}
MAIN_INIT ();
mark_point ();
for (i = 0; i < num_threads; ++i) {
ip = g_new (gint, 1);
*ip = i;
MAIN_START_THREAD_FUNCTION (i, thread_name_object_default, ip);
}
mark_point ();
MAIN_SYNCHRONIZE ();
mark_point ();
MAIN_STOP_THREADS ();
/* sort GList based on object name */
/* FIXME: sort and test */
object_list =
g_list_sort (object_list, (GCompareFunc) gst_object_name_compare);
name1 = gst_object_get_name (GST_OBJECT (object_list->data));
for (l = object_list->next; l->next; l = l->next) {
g_message ("object with name %s", name1);
name2 = gst_object_get_name (GST_OBJECT (l->data));
fail_if (strcmp (name1, name2) == 0, "Two objects with name %s", name2);
g_free (name1);
name1 = name2;
}
g_free (name1);
/* free stuff */
g_list_foreach (object_list, (GFunc) g_object_unref, NULL);
}
GST_END_TEST;
/* parentage test on GstFakeObject */
GST_START_TEST (test_fake_object_parentage)
{
GstObject *object1, *object2;
GstObject *parent;
gboolean result;
/* create new object */
object1 = g_object_new (gst_fake_object_get_type (), NULL);
fail_if (object1 == NULL, "Failed to create instance of GstFakeObject");
fail_unless (GST_IS_OBJECT (object1),
"GstFakeObject instance is not a GstObject");
fail_unless (g_object_is_floating (object1),
"GstFakeObject instance is not floating");
/* check the parent */
parent = gst_object_get_parent (object1);
fail_if (parent != NULL, "GstFakeObject has parent");
/* try to set a NULL parent, this should give a warning */
result = FALSE;
ASSERT_CRITICAL (result = gst_object_set_parent (object1, NULL));
fail_if (result, "GstFakeObject accepted NULL parent");
/* try to set itself as parent, we expect a warning here */
ASSERT_CRITICAL (result = gst_object_set_parent (object1, object1));
fail_if (result, "GstFakeObject accepted itself as parent");
/* _has_parent always returns FALSE if there is no parent */
fail_if (gst_object_has_as_parent (object1, NULL));
fail_if (gst_object_has_as_parent (NULL, object1));
fail_if (gst_object_has_as_parent (object1, object1));
/* should still be floating */
fail_unless (g_object_is_floating (object1),
"GstFakeObject instance is not floating");
/* create another object */
object2 = g_object_new (gst_fake_object_get_type (), NULL);
fail_if (object2 == NULL,
"Failed to create another instance of GstFakeObject");
fail_unless (GST_IS_OBJECT (object2),
"second GstFakeObject instance is not a GstObject");
fail_unless (g_object_is_floating (object1),
"GstFakeObject instance is not floating");
result = gst_object_has_as_parent (object1, object2);
fail_if (result, "GstFakeObject has a parent");
/* try to set other object as parent */
result = gst_object_set_parent (object1, object2);
fail_unless (result, "GstFakeObject could not accept other object as parent");
/* should not be floating anymore */
fail_if (g_object_is_floating (object1),
"GstFakeObject instance is still floating");
/* parent should still be floating */
fail_unless (g_object_is_floating (object2),
"GstFakeObject instance is not floating");
/* check the parent */
fail_unless (gst_object_has_as_parent (object1, object2));
/* any other combination is invalid */
fail_if (gst_object_has_as_parent (object2, object1));
fail_if (gst_object_has_as_parent (object1, NULL));
fail_if (gst_object_has_as_parent (object2, NULL));
fail_if (gst_object_has_as_parent (NULL, object1));
fail_if (gst_object_has_as_parent (NULL, object2));
fail_if (gst_object_has_as_parent (object1, object1));
fail_if (gst_object_has_as_parent (object2, object2));
/* try to set other object as parent again */
result = gst_object_set_parent (object1, object2);
fail_if (result, "GstFakeObject could set parent twice");
/* ref before unparenting */
gst_object_ref (object1);
/* clear parent of object */
gst_object_unparent (object1);
/* check the parent */
parent = gst_object_get_parent (object1);
fail_if (parent != NULL, "GstFakeObject has parent");
/* object should not be floating */
fail_if (g_object_is_floating (object1),
"GstFakeObject instance is floating again");
gst_object_unref (object1);
gst_object_unref (object2);
}
GST_END_TEST;
/* parentage test dispose on GstFakeObject, since our testcase
* does not handle the parent relation completely, the parent does
* not hold a ref to the child, we cannot dispose the parent to
* dipose the child as well. This test needs to be run with DEBUG
* info to check if the finalize methods are called correctly. */
GST_START_TEST (test_fake_object_parentage_dispose)
{
GstObject *object1, *object2;
gboolean result;
object1 = g_object_new (gst_fake_object_get_type (), NULL);
fail_if (object1 == NULL, "Failed to create instance of GstFakeObject");
object2 = g_object_new (gst_fake_object_get_type (), NULL);
fail_if (object2 == NULL, "Failed to create instance of GstFakeObject");
/* try to set other object as parent */
result = gst_object_set_parent (object1, object2);
fail_unless (result, "GstFakeObject could not accept other object as parent");
/* clear parent of object */
gst_object_unparent (object1);
/* now dispose parent */
gst_object_unref (object2);
}
GST_END_TEST;
GST_START_TEST (test_fake_object_has_as_ancestor)
{
GstObject *object1, *object2, *object3, *object4;
gboolean result;
object1 = g_object_new (gst_fake_object_get_type (), NULL);
fail_if (object1 == NULL, "Failed to create instance of GstFakeObject");
object2 = g_object_new (gst_fake_object_get_type (), NULL);
fail_if (object2 == NULL, "Failed to create instance of GstFakeObject");
object3 = g_object_new (gst_fake_object_get_type (), NULL);
fail_if (object3 == NULL, "Failed to create instance of GstFakeObject");
object4 = g_object_new (gst_fake_object_get_type (), NULL);
fail_if (object4 == NULL, "Failed to create instance of GstFakeObject");
/* try to set other object as parent */
result = gst_object_set_parent (object1, object3);
fail_unless (result, "GstFakeObject could not accept other object as parent");
result = gst_object_set_parent (object2, object3);
fail_unless (result, "GstFakeObject could not accept other object as parent");
result = gst_object_set_parent (object3, object4);
fail_unless (result, "GstFakeObject could not accept other object as parent");
/* Hierarchy:
* object4
* `- object3
* |- object2
* `- object1
*/
/* An object isn't its own parent, but it is its own ancestor */
fail_if (gst_object_has_as_parent (object1, object1));
fail_unless (gst_object_has_as_ancestor (object1, object1));
fail_if (gst_object_has_as_parent (object4, object4));
fail_unless (gst_object_has_as_ancestor (object4, object4));
/* direct parents */
fail_unless (gst_object_has_as_parent (object1, object3));
fail_unless (gst_object_has_as_ancestor (object1, object3));
fail_unless (gst_object_has_as_parent (object2, object3));
fail_unless (gst_object_has_as_ancestor (object2, object3));
fail_unless (gst_object_has_as_parent (object3, object4));
fail_unless (gst_object_has_as_ancestor (object3, object4));
/* grandparents */
fail_if (gst_object_has_as_parent (object1, object4));
fail_unless (gst_object_has_as_ancestor (object1, object4));
fail_if (gst_object_has_as_parent (object2, object4));
fail_unless (gst_object_has_as_ancestor (object2, object4));
/* not ancestors */
fail_if (gst_object_has_as_parent (object1, object2));
fail_if (gst_object_has_as_ancestor (object1, object2));
fail_if (gst_object_has_as_parent (object3, object1));
fail_if (gst_object_has_as_ancestor (object3, object1));
fail_if (gst_object_has_as_parent (object4, object1));
fail_if (gst_object_has_as_ancestor (object4, object1));
fail_if (gst_object_has_as_parent (object4, object3));
fail_if (gst_object_has_as_ancestor (object4, object3));
/* unparent everything */
gst_object_unparent (object3);
gst_object_unparent (object2);
gst_object_unparent (object1);
/* now dispose objects */
gst_object_unref (object4);
}
GST_END_TEST;
/* test: try renaming a parented object, make sure it fails */
static Suite *
gst_object_suite (void)
{
Suite *s = suite_create ("GstObject");
TCase *tc_chain = tcase_create ("general");
/* turn off timeout */
tcase_set_timeout (tc_chain, 60);
suite_add_tcase (s, tc_chain);
tcase_add_test (tc_chain, test_fake_object_new);
tcase_add_test (tc_chain, test_fake_object_initial_name);
tcase_add_test (tc_chain, test_fake_object_reset_name);
tcase_add_test (tc_chain, test_fake_object_set_name_via_property);
tcase_add_test (tc_chain, test_fake_object_get_name_returns_copy);
tcase_add_test (tc_chain, test_fake_object_set_name_when_parented);
#if 0
tcase_add_test (tc_chain, test_fake_object_name_threaded_wrong);
#endif
tcase_add_test (tc_chain, test_fake_object_name_threaded_right);
tcase_add_test (tc_chain, test_fake_object_name_threaded_unique);
tcase_add_test (tc_chain, test_fake_object_parentage);
tcase_add_test (tc_chain, test_fake_object_parentage_dispose);
tcase_add_test (tc_chain, test_fake_object_has_as_ancestor);
//tcase_add_checked_fixture (tc_chain, setup, teardown);
return s;
}
GST_CHECK_MAIN (gst_object);