Add tests for GUPnPMediaCollection

2 files changed, 463 insertions, 1 deletions

diff --git a/tests/gtest/Makefile.am b/tests/gtest/Makefile.am
index b28b6c6..2525023 100644
--- a/tests/gtest/Makefile.am
+++ b/tests/gtest/Makefile.am
@@ -3,10 +3,15 @@ TESTS_ENVIRONMENT = G_SLICE=debug-blocks \
 
 TESTS=$(check_PROGRAMS)
 
-check_PROGRAMS = test-regression
+check_PROGRAMS = \
+	test-regression \
+	test-media-collection
 
 test_regression_SOURCES = test-regression.c
 
+test_media_collection_SOURCES =  \
+	test-media-collection.c
+
 LDADD = \
 	$(top_builddir)/libgupnp-av/libgupnp-av-1.0.la \
 	$(LIBGUPNP_LIBS)
diff --git a/tests/gtest/test-media-collection.c b/tests/gtest/test-media-collection.c
new file mode 100644
index 0000000..8d00dcf
--- /dev/null
+++ b/tests/gtest/test-media-collection.c
@@ -0,0 +1,457 @@
+/*
+ * Copyright (C) 2012 Intel Corporation.
+ *
+ * Author: Jens Georg <jensg@openismus.com>
+ *
+ * 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 Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#include <libgupnp-av/gupnp-media-collection.h>
+
+/* Flat DIDL_S playlist */
+#define TEST_PARSE_COLLECTION_1 \
+"<?xml version=\"1.0\" encoding=\"UTF-8\"?>" \
+"<DIDL-Lite" \
+"    xmlns:dc=\"http://purl.org/dc/elements/1.1/\"" \
+"    xmlns=\"urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/\"" \
+"    xmlns:upnp=\"urn:schemas-upnp-org:metadata-1-0/upnp/\"" \
+"    xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"" \
+"    xsi:schemaLocation=\"urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/" \
+"        http://www.upnp.org/schemas/av/didl-lite-v2-20060531.xsd" \
+"      urn:schemas-upnp-org:metadata-1-0/upnp/" \
+"        http://www.upnp.org/schemas/av/upnp-v2-20060531.xsd\">" \
+"    <item id=\"\" parentID=\"0\" restricted=\"0\">" \
+"        <dc:title>Song1</dc:title>" \
+"        <upnp:class>object.item.audioItem</upnp:class>" \
+"        <res protocolInfo=\"*:*:*:*\" />" \
+"        <upnp:artist></upnp:artist>" \
+"    </item>" \
+"    <item id=\"\" parentID=\"0\" restricted=\"0\">" \
+"        <dc:title>Song2</dc:title>" \
+"        <upnp:class>object.item.audioItem</upnp:class>" \
+"        <res protocolInfo=\"*:*:*:*\" />" \
+"    </item>" \
+"    <item id=\"\" parentID=\"0\" restricted=\"0\">" \
+"        <dc:title>Song3</dc:title>" \
+"        <upnp:class>object.item.audioItem</upnp:class>" \
+"        <res protocolInfo=\"*:*:*:*\" />" \
+"    </item>" \
+"</DIDL-Lite>"
+
+/* Nested DIDL_S playlist */
+#define TEST_PARSE_COLLECTION_2 \
+"<?xml version=\"1.0\" encoding=\"UTF-8\"?>" \
+"<DIDL-Lite" \
+"    xmlns:dc=\"http://purl.org/dc/elements/1.1/\"" \
+"    xmlns=\"urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/\"" \
+"    xmlns:upnp=\"urn:schemas-upnp-org:metadata-1-0/upnp/\"" \
+"    xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"" \
+"    xsi:schemaLocation=\"urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/" \
+"        http://www.upnp.org/schemas/av/didl-lite-v2-20060531.xsd" \
+"      urn:schemas-upnp-org:metadata-1-0/upnp/" \
+"        http://www.upnp.org/schemas/av/upnp-v2-20060531.xsd\">" \
+"    <container id=\"1\" parentID=\"0\" restricted=\"0\">" \
+"        <dc:title>NonFlatCollection</dc:title>" \
+"        <dc:creator>NonFlatCollection Author</dc:creator>" \
+"        <item id=\"\" parentID=\"1\" restricted=\"0\">" \
+"            <dc:title>Song1</dc:title>" \
+"            <upnp:class>object.item.audioItem</upnp:class>" \
+"            <res protocolInfo=\"*:*:*:*\" />" \
+"            <upnp:artist></upnp:artist>" \
+"        </item>" \
+"        <item id=\"\" parentID=\"1\" restricted=\"0\">" \
+"            <dc:title>Song2</dc:title>" \
+"            <upnp:class>object.item.audioItem</upnp:class>" \
+"            <res protocolInfo=\"*:*:*:*\" />" \
+"        </item>" \
+"        <item id=\"\" parentID=\"1\" restricted=\"0\">" \
+"            <dc:title>Song3</dc:title>" \
+"            <upnp:class>object.item.audioItem</upnp:class>" \
+"        <res protocolInfo=\"*:*:*:*\" />" \
+"    </item>" \
+"    </container>" \
+"</DIDL-Lite>"
+
+#define TEST_CREATE_FLAT \
+"<DIDL-Lite " \
+        "xmlns:dc=\"http://purl.org/dc/elements/1.1/\" " \
+        "xmlns:upnp=\"urn:schemas-upnp-org:metadata-1-0/upnp/\" " \
+        "xmlns:dlna=\"urn:schemas-dlna-org:metadata-1-0/\" " \
+        "xmlns=\"urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/\">" \
+    "<item>" \
+      "<dc:title>Song1</dc:title>" \
+      "<upnp:class>object.item.audioItem</upnp:class>" \
+      "<res>http://example.com/song1.mp3</res>" \
+    "</item>" \
+    "<item>" \
+      "<dc:title>Song2</dc:title>" \
+      "<upnp:class>object.item.audioItem</upnp:class>" \
+      "<res>http://example.com/song2.mp3</res>" \
+    "</item>" \
+    "<item>" \
+      "<dc:title>Song3</dc:title>" \
+      "<upnp:class>object.item.audioItem</upnp:class>" \
+      "<res>http://example.com/song3.mp3</res>" \
+    "</item>" \
+"</DIDL-Lite>"
+
+#define TEST_CREATE_FULL \
+"<DIDL-Lite " \
+        "xmlns:dc=\"http://purl.org/dc/elements/1.1/\" " \
+        "xmlns:upnp=\"urn:schemas-upnp-org:metadata-1-0/upnp/\" " \
+        "xmlns:dlna=\"urn:schemas-dlna-org:metadata-1-0/\" " \
+        "xmlns=\"urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/\">" \
+    "<container>" \
+      "<dc:title>TestCollection1</dc:title>" \
+      "<dc:creator>TestCollection1Author</dc:creator>" \
+      "<item>" \
+        "<dc:title>Song1</dc:title>" \
+        "<upnp:class>object.item.audioItem</upnp:class>" \
+        "<res>http://example.com/song1.mp3</res>" \
+      "</item>" \
+      "<item>" \
+        "<dc:title>Song2</dc:title>" \
+        "<upnp:class>object.item.audioItem</upnp:class>" \
+        "<res>http://example.com/song2.mp3</res>" \
+      "</item>" \
+      "<item>" \
+        "<dc:title>Song3</dc:title>" \
+        "<upnp:class>object.item.audioItem</upnp:class>" \
+        "<res>http://example.com/song3.mp3</res>" \
+      "</item>" \
+    "</container>" \
+"</DIDL-Lite>"
+
+#define TEST_CREATE_FULL_REPARENT \
+"<DIDL-Lite " \
+        "xmlns:dc=\"http://purl.org/dc/elements/1.1/\" " \
+        "xmlns:upnp=\"urn:schemas-upnp-org:metadata-1-0/upnp/\" " \
+        "xmlns:dlna=\"urn:schemas-dlna-org:metadata-1-0/\" " \
+        "xmlns=\"urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/\">" \
+    "<container>" \
+      "<item>" \
+        "<dc:title>Song1</dc:title>" \
+        "<upnp:class>object.item.audioItem</upnp:class>" \
+        "<res>http://example.com/song1.mp3</res>" \
+      "</item>" \
+      "<item>" \
+        "<dc:title>Song2</dc:title>" \
+        "<upnp:class>object.item.audioItem</upnp:class>" \
+        "<res>http://example.com/song2.mp3</res>" \
+      "</item>" \
+      "<item>" \
+        "<dc:title>Song3</dc:title>" \
+        "<upnp:class>object.item.audioItem</upnp:class>" \
+        "<res>http://example.com/song3.mp3</res>" \
+      "</item>" \
+      "<dc:title>TestCollection1</dc:title>" \
+      "<dc:creator>TestCollection1Author</dc:creator>" \
+    "</container>" \
+"</DIDL-Lite>"
+
+
+void
+test_didl_collection_construction ()
+{
+        GUPnPMediaCollection *collection;
+
+        /* Check that a collection created via auxillary function is mutable */
+        collection = gupnp_media_collection_new ();
+        g_assert (gupnp_media_collection_get_mutable (collection));
+        g_object_unref (collection);
+
+        /* Check that a collection created via auxillary parse function is
+         * not mutable */
+        collection = gupnp_media_collection_new_from_string
+                                        (TEST_PARSE_COLLECTION_1);
+        g_assert (!gupnp_media_collection_get_mutable (collection));
+        g_object_unref (collection);
+
+        /* Check that creating a collection via g_object_new and title/author
+         * properties set is mutable */
+        collection = g_object_new (GUPNP_TYPE_MEDIA_COLLECTION,
+                                   "title", "test01collection",
+                                   "author", "test01author",
+                                   NULL);
+        g_assert (gupnp_media_collection_get_mutable (collection));
+        g_object_unref (collection);
+
+        /* Check that creating a collection via g_object_new and data is not
+         * mutable */
+        collection = g_object_new (GUPNP_TYPE_MEDIA_COLLECTION,
+                                   "data", TEST_PARSE_COLLECTION_1,
+                                   NULL);
+        g_assert (!gupnp_media_collection_get_mutable (collection));
+        g_object_unref (collection);
+
+        /* Check that creating a collection with all properties set will result
+         * in a collection that ignored "title" and "author" properties.
+         */
+        collection = g_object_new (GUPNP_TYPE_MEDIA_COLLECTION,
+                                   "title", "test01collection",
+                                   "author", "test01author",
+                                   "data", TEST_PARSE_COLLECTION_1,
+                                   NULL);
+        g_assert (!gupnp_media_collection_get_mutable (collection));
+        g_assert_cmpstr (gupnp_media_collection_get_author (collection), ==,
+                         NULL);
+        g_assert_cmpstr (gupnp_media_collection_get_title (collection), ==,
+                         NULL);
+        g_assert_cmpstr (gupnp_media_collection_get_string (collection), ==,
+                         TEST_PARSE_COLLECTION_1);
+        g_object_unref (collection);
+}
+
+void
+test_didl_collection_parse_flat ()
+{
+        GUPnPMediaCollection *collection;
+        GList *items, *it;
+
+        collection = gupnp_media_collection_new_from_string
+                                        (TEST_PARSE_COLLECTION_1);
+        g_assert_cmpstr (gupnp_media_collection_get_author (collection), ==,
+                         NULL);
+        g_assert_cmpstr (gupnp_media_collection_get_title (collection), ==,
+                         NULL);
+        g_assert_cmpstr (gupnp_media_collection_get_string (collection), ==,
+                         TEST_PARSE_COLLECTION_1);
+
+        it = items = gupnp_media_collection_get_items (collection);
+        g_assert_cmpint (g_list_length (items), ==, 3);
+        g_assert_cmpstr (gupnp_didl_lite_object_get_title (GUPNP_DIDL_LITE_OBJECT (it->data)), ==,
+                         "Song1");
+        it = it->next;
+        g_assert_cmpstr (gupnp_didl_lite_object_get_title (GUPNP_DIDL_LITE_OBJECT (it->data)), ==,
+                         "Song2");
+        it = it->next;
+        g_assert_cmpstr (gupnp_didl_lite_object_get_title (GUPNP_DIDL_LITE_OBJECT (it->data)), ==,
+                         "Song3");
+        g_list_free_full (items, (GDestroyNotify) g_object_unref);
+}
+
+void
+test_didl_collection_parse_full ()
+{
+        GUPnPMediaCollection *collection;
+        GList *items, *it;
+
+        collection = gupnp_media_collection_new_from_string
+                                        (TEST_PARSE_COLLECTION_2);
+        g_assert_cmpstr (gupnp_media_collection_get_author (collection), ==,
+                         "NonFlatCollection Author");
+        g_assert_cmpstr (gupnp_media_collection_get_title (collection), ==,
+                         "NonFlatCollection");
+        g_assert_cmpstr (gupnp_media_collection_get_string (collection), ==,
+                         TEST_PARSE_COLLECTION_2);
+
+        it = items = gupnp_media_collection_get_items (collection);
+        g_assert_cmpint (g_list_length (items), ==, 3);
+        g_assert_cmpstr (gupnp_didl_lite_object_get_title (GUPNP_DIDL_LITE_OBJECT (it->data)), ==,
+                         "Song1");
+        it = it->next;
+        g_assert_cmpstr (gupnp_didl_lite_object_get_title (GUPNP_DIDL_LITE_OBJECT (it->data)), ==,
+                         "Song2");
+        it = it->next;
+        g_assert_cmpstr (gupnp_didl_lite_object_get_title (GUPNP_DIDL_LITE_OBJECT (it->data)), ==,
+                         "Song3");
+        g_list_free_full (items, (GDestroyNotify) g_object_unref);
+}
+
+void
+test_didl_collection_create_flat ()
+{
+        GUPnPMediaCollection *collection;
+        GUPnPDIDLLiteItem *item;
+        GList *items, *it;
+        GUPnPDIDLLiteResource *res;
+
+        collection = gupnp_media_collection_new ();
+        item = gupnp_media_collection_add_item (collection);
+        gupnp_didl_lite_object_set_title (GUPNP_DIDL_LITE_OBJECT (item),
+                                          "Song1");
+        gupnp_didl_lite_object_set_upnp_class (GUPNP_DIDL_LITE_OBJECT (item),
+                                               "object.item.audioItem");
+        res = gupnp_didl_lite_object_add_resource (GUPNP_DIDL_LITE_OBJECT (item));
+        gupnp_didl_lite_resource_set_uri (res, "http://example.com/song1.mp3");
+        g_object_unref (res);
+        g_object_unref (item);
+        item = gupnp_media_collection_add_item (collection);
+        gupnp_didl_lite_object_set_title (GUPNP_DIDL_LITE_OBJECT (item),
+                                          "Song2");
+        gupnp_didl_lite_object_set_upnp_class (GUPNP_DIDL_LITE_OBJECT (item),
+                                               "object.item.audioItem");
+        res = gupnp_didl_lite_object_add_resource (GUPNP_DIDL_LITE_OBJECT (item));
+        gupnp_didl_lite_resource_set_uri (res, "http://example.com/song2.mp3");
+        g_object_unref (res);
+        g_object_unref (item);
+        item = gupnp_media_collection_add_item (collection);
+        gupnp_didl_lite_object_set_title (GUPNP_DIDL_LITE_OBJECT (item),
+                                          "Song3");
+        gupnp_didl_lite_object_set_upnp_class (GUPNP_DIDL_LITE_OBJECT (item),
+                                               "object.item.audioItem");
+        res = gupnp_didl_lite_object_add_resource (GUPNP_DIDL_LITE_OBJECT (item));
+        gupnp_didl_lite_resource_set_uri (res, "http://example.com/song3.mp3");
+        g_object_unref (res);
+        g_object_unref (item);
+        it = items = gupnp_media_collection_get_items (collection);
+        g_assert_cmpint (g_list_length (items), ==, 3);
+        g_assert_cmpstr (gupnp_didl_lite_object_get_title (GUPNP_DIDL_LITE_OBJECT (it->data)), ==,
+                         "Song1");
+        it = it->next;
+        g_assert_cmpstr (gupnp_didl_lite_object_get_title (GUPNP_DIDL_LITE_OBJECT (it->data)), ==,
+                         "Song2");
+        it = it->next;
+        g_assert_cmpstr (gupnp_didl_lite_object_get_title (GUPNP_DIDL_LITE_OBJECT (it->data)), ==,
+                         "Song3");
+        g_list_free_full (items, (GDestroyNotify) g_object_unref);
+        g_assert_cmpstr (gupnp_media_collection_get_string (collection), ==,
+                         TEST_CREATE_FLAT);
+}
+
+void
+test_didl_collection_create_full ()
+{
+        GUPnPMediaCollection *collection;
+        GUPnPDIDLLiteItem *item;
+        GList *items, *it;
+        GUPnPDIDLLiteResource *res;
+
+        collection = gupnp_media_collection_new ();
+        gupnp_media_collection_set_title (collection, "TestCollection1");
+        gupnp_media_collection_set_author (collection, "TestCollection1Author");
+
+        item = gupnp_media_collection_add_item (collection);
+        gupnp_didl_lite_object_set_title (GUPNP_DIDL_LITE_OBJECT (item),
+                                          "Song1");
+        gupnp_didl_lite_object_set_upnp_class (GUPNP_DIDL_LITE_OBJECT (item),
+                                               "object.item.audioItem");
+        res = gupnp_didl_lite_object_add_resource (GUPNP_DIDL_LITE_OBJECT (item));
+        gupnp_didl_lite_resource_set_uri (res, "http://example.com/song1.mp3");
+        g_object_unref (res);
+        g_object_unref (item);
+        item = gupnp_media_collection_add_item (collection);
+        gupnp_didl_lite_object_set_title (GUPNP_DIDL_LITE_OBJECT (item),
+                                          "Song2");
+        gupnp_didl_lite_object_set_upnp_class (GUPNP_DIDL_LITE_OBJECT (item),
+                                               "object.item.audioItem");
+        res = gupnp_didl_lite_object_add_resource (GUPNP_DIDL_LITE_OBJECT (item));
+        gupnp_didl_lite_resource_set_uri (res, "http://example.com/song2.mp3");
+        g_object_unref (res);
+        g_object_unref (item);
+        item = gupnp_media_collection_add_item (collection);
+        gupnp_didl_lite_object_set_title (GUPNP_DIDL_LITE_OBJECT (item),
+                                          "Song3");
+        gupnp_didl_lite_object_set_upnp_class (GUPNP_DIDL_LITE_OBJECT (item),
+                                               "object.item.audioItem");
+        res = gupnp_didl_lite_object_add_resource (GUPNP_DIDL_LITE_OBJECT (item));
+        gupnp_didl_lite_resource_set_uri (res, "http://example.com/song3.mp3");
+        g_object_unref (res);
+        g_object_unref (item);
+        it = items = gupnp_media_collection_get_items (collection);
+        g_assert_cmpint (g_list_length (items), ==, 3);
+        g_assert_cmpstr (gupnp_didl_lite_object_get_title (GUPNP_DIDL_LITE_OBJECT (it->data)), ==,
+                         "Song1");
+        it = it->next;
+        g_assert_cmpstr (gupnp_didl_lite_object_get_title (GUPNP_DIDL_LITE_OBJECT (it->data)), ==,
+                         "Song2");
+        it = it->next;
+        g_assert_cmpstr (gupnp_didl_lite_object_get_title (GUPNP_DIDL_LITE_OBJECT (it->data)), ==,
+                         "Song3");
+        g_list_free_full (items, (GDestroyNotify) g_object_unref);
+        g_assert_cmpstr (gupnp_media_collection_get_string (collection), ==,
+                         TEST_CREATE_FULL);
+}
+
+void
+test_didl_collection_create_reparent ()
+{
+        GUPnPMediaCollection *collection;
+        GUPnPDIDLLiteItem *item;
+        GList *items, *it;
+        GUPnPDIDLLiteResource *res;
+
+        collection = gupnp_media_collection_new ();
+
+        item = gupnp_media_collection_add_item (collection);
+        gupnp_didl_lite_object_set_title (GUPNP_DIDL_LITE_OBJECT (item),
+                                          "Song1");
+        gupnp_didl_lite_object_set_upnp_class (GUPNP_DIDL_LITE_OBJECT (item),
+                                               "object.item.audioItem");
+        res = gupnp_didl_lite_object_add_resource (GUPNP_DIDL_LITE_OBJECT (item));
+        gupnp_didl_lite_resource_set_uri (res, "http://example.com/song1.mp3");
+        g_object_unref (res);
+        g_object_unref (item);
+        item = gupnp_media_collection_add_item (collection);
+        gupnp_didl_lite_object_set_title (GUPNP_DIDL_LITE_OBJECT (item),
+                                          "Song2");
+        gupnp_didl_lite_object_set_upnp_class (GUPNP_DIDL_LITE_OBJECT (item),
+                                               "object.item.audioItem");
+        res = gupnp_didl_lite_object_add_resource (GUPNP_DIDL_LITE_OBJECT (item));
+        gupnp_didl_lite_resource_set_uri (res, "http://example.com/song2.mp3");
+        g_object_unref (res);
+        g_object_unref (item);
+        item = gupnp_media_collection_add_item (collection);
+        gupnp_didl_lite_object_set_title (GUPNP_DIDL_LITE_OBJECT (item),
+                                          "Song3");
+        gupnp_didl_lite_object_set_upnp_class (GUPNP_DIDL_LITE_OBJECT (item),
+                                               "object.item.audioItem");
+        res = gupnp_didl_lite_object_add_resource (GUPNP_DIDL_LITE_OBJECT (item));
+        gupnp_didl_lite_resource_set_uri (res, "http://example.com/song3.mp3");
+        g_object_unref (res);
+        g_object_unref (item);
+        it = items = gupnp_media_collection_get_items (collection);
+
+        /* Force reparenting of the items in the XML */
+        gupnp_media_collection_set_title (collection, "TestCollection1");
+        gupnp_media_collection_set_author (collection, "TestCollection1Author");
+
+        g_assert_cmpint (g_list_length (items), ==, 3);
+        g_assert_cmpstr (gupnp_didl_lite_object_get_title (GUPNP_DIDL_LITE_OBJECT (it->data)), ==,
+                         "Song1");
+        it = it->next;
+        g_assert_cmpstr (gupnp_didl_lite_object_get_title (GUPNP_DIDL_LITE_OBJECT (it->data)), ==,
+                         "Song2");
+        it = it->next;
+        g_assert_cmpstr (gupnp_didl_lite_object_get_title (GUPNP_DIDL_LITE_OBJECT (it->data)), ==,
+                         "Song3");
+        g_list_free_full (items, (GDestroyNotify) g_object_unref);
+
+        g_assert_cmpstr (gupnp_media_collection_get_string (collection), ==,
+                         TEST_CREATE_FULL_REPARENT);
+}
+
+int main (int argc, char *argv[])
+{
+        g_type_init ();
+        g_test_init (&argc, &argv, NULL);
+
+        g_test_add_func ("/didl/collection/construction",
+                         test_didl_collection_construction);
+        g_test_add_func ("/didl/collection/parse_flat",
+                         test_didl_collection_parse_flat);
+        g_test_add_func ("/didl/collection/parse_full",
+                         test_didl_collection_parse_full);
+
+        g_test_add_func ("/didl/collection/create_flat",
+                         test_didl_collection_create_flat);
+        g_test_add_func ("/didl/collection/create_full",
+                         test_didl_collection_create_full);
+        g_test_add_func ("/didl/collection/create_reparent",
+                         test_didl_collection_create_reparent);
+
+        return g_test_run ();
+}
\ No newline at end of file