[evolution-data-server/treitter-client-gdbus] Port the e-book 'getRequiredFields' method to gdbus and add a regression test

[Travis Reitter <treitter src gnome org>]

commit 3b80ab6bc74dcfc14be16ba67b787034304b1018
Author: Travis Reitter <treitter gmail com>
Date:   Wed Dec 9 16:30:04 2009 -0800

    Port the e-book 'getRequiredFields' method to gdbus and add a regression test

 addressbook/libebook/e-book.c                      |    9 ++-
 addressbook/libebook/e-data-book-gdbus-bindings.h  |   57 +++++++++++++++
 addressbook/tests/ebook/Makefile.am                |    3 +
 addressbook/tests/ebook/ebook-test-utils.c         |   58 +++++++++++++++
 addressbook/tests/ebook/ebook-test-utils.h         |   12 +++-
 .../tests/ebook/test-ebook-get-required-fields.c   |   75 ++++++++++++++++++++
 6 files changed, 209 insertions(+), 5 deletions(-)
---
diff --git a/addressbook/libebook/e-book.c b/addressbook/libebook/e-book.c
index feb6598..eb505a2 100644
--- a/addressbook/libebook/e-book.c
+++ b/addressbook/libebook/e-book.c
@@ -551,7 +551,7 @@ e_book_get_required_fields  (EBook            *book,
 	e_return_error_if_fail (book->priv->proxy, E_BOOK_ERROR_REPOSITORY_OFFLINE);
 
 	LOCK_CONN ();
-	org_gnome_evolution_dataserver_addressbook_Book_get_required_fields (book->priv->proxy, &list, &err);
+	e_data_book_gdbus_get_required_fields_sync (book->priv->gdbus_proxy, &list, &err);
 	UNLOCK_CONN ();
 	if (list) {
 		*fields = array_to_stringlist (list);
@@ -562,7 +562,10 @@ e_book_get_required_fields  (EBook            *book,
 }
 
 static void
-get_required_fields_reply(DBusGProxy *proxy, gchar **fields, GError *error, gpointer user_data)
+get_required_fields_reply (GDBusProxy  *proxy,
+			   gchar      **fields,
+			   GError      *error,
+			   gpointer     user_data)
 {
 	AsyncData *data = user_data;
 	EBookEListCallback cb = data->callback;
@@ -611,7 +614,7 @@ e_book_async_get_required_fields (EBook              *book,
 	data->closure = closure;
 
 	LOCK_CONN ();
-	org_gnome_evolution_dataserver_addressbook_Book_get_required_fields_async (book->priv->proxy, get_required_fields_reply, data);
+	e_data_book_gdbus_get_required_fields (book->priv->gdbus_proxy, get_required_fields_reply, data);
 	UNLOCK_CONN ();
 	return 0;
 }
diff --git a/addressbook/libebook/e-data-book-gdbus-bindings.h b/addressbook/libebook/e-data-book-gdbus-bindings.h
index db431d4..becaa6d 100644
--- a/addressbook/libebook/e-data-book-gdbus-bindings.h
+++ b/addressbook/libebook/e-data-book-gdbus-bindings.h
@@ -327,6 +327,63 @@ e_data_book_gdbus_get_contact_list (GDBusProxy                               *pr
 }
 
 static gboolean
+e_data_book_gdbus_get_required_fields_sync (GDBusProxy   *proxy,
+					    char       ***OUT_fields,
+					    GError      **error)
+{
+	GVariant *parameters;
+	GVariant *retvals;
+
+	parameters = g_variant_new ("()");
+	retvals = g_dbus_proxy_invoke_method_sync (proxy, "getRequiredFields", parameters, -1, NULL, error);
+
+	return demarshal_retvals__STRINGVECTOR (retvals, OUT_fields);
+}
+
+typedef void (*e_data_book_gdbus_get_required_fields_reply) (GDBusProxy  *proxy,
+							     char       **OUT_fields,
+							     GError      *error,
+							     gpointer     user_data);
+
+static void
+get_required_fields_cb (GDBusProxy   *proxy,
+			GAsyncResult *result,
+			gpointer      user_data)
+{
+        Closure *closure = user_data;
+        GVariant *retvals;
+        GError *error = NULL;
+        char **OUT_fields = NULL;
+
+        retvals = g_dbus_proxy_invoke_method_finish (proxy, result, &error);
+	if (retvals) {
+		if (!demarshal_retvals__STRINGVECTOR (retvals, &OUT_fields)) {
+			error = g_error_new (E_BOOK_ERROR, E_BOOK_ERROR_CORBA_EXCEPTION, "demarshalling results for Book method 'getRequiredFields'");
+		}
+	}
+
+	(*(e_data_book_gdbus_get_required_fields_reply) closure->cb) (proxy, OUT_fields, error, closure->user_data);
+	closure_free (closure);
+}
+
+static void
+e_data_book_gdbus_get_required_fields (GDBusProxy                                  *proxy,
+				       e_data_book_gdbus_get_required_fields_reply  callback,
+				       gpointer                                     user_data)
+{
+        GVariant *parameters;
+        Closure *closure;
+
+        parameters = g_variant_new ("()");
+
+        closure = g_slice_new (Closure);
+        closure->cb = G_CALLBACK (callback);
+        closure->user_data = user_data;
+
+        g_dbus_proxy_invoke_method (proxy, "getRequiredFields", parameters, -1, NULL, (GAsyncReadyCallback) get_required_fields_cb, closure);
+}
+
+static gboolean
 e_data_book_gdbus_add_contact_sync (GDBusProxy  *proxy,
 				    const char  *IN_vcard,
 				    char       **OUT_uid,
diff --git a/addressbook/tests/ebook/Makefile.am b/addressbook/tests/ebook/Makefile.am
index cc892a2..a0eb6ed 100644
--- a/addressbook/tests/ebook/Makefile.am
+++ b/addressbook/tests/ebook/Makefile.am
@@ -30,6 +30,7 @@ noinst_PROGRAMS = \
 	test-ebook-add-contact               \
 	test-ebook-commit-contact            \
 	test-ebook-get-contact               \
+	test-ebook-get-required-fields       \
 	test-ebook-get-static-capabilities   \
 	test-ebook-remove                    \
 	test-ebook-remove-contact            \
@@ -65,6 +66,8 @@ test_ebook_commit_contact_LDADD=$(TEST_LIBS)
 test_ebook_commit_contact_CPPFLAGS=$(TEST_CPPFLAGS)
 test_ebook_get_contact_LDADD=$(TEST_LIBS)
 test_ebook_get_contact_CPPFLAGS=$(TEST_CPPFLAGS)
+test_ebook_get_required_fields_LDADD=$(TEST_LIBS)
+test_ebook_get_required_fields_CPPFLAGS=$(TEST_CPPFLAGS)
 test_ebook_get_static_capabilities_LDADD=$(TEST_LIBS)
 test_ebook_get_static_capabilities_CPPFLAGS=$(TEST_CPPFLAGS)
 test_ebook_remove_LDADD=$(TEST_LIBS)
diff --git a/addressbook/tests/ebook/ebook-test-utils.c b/addressbook/tests/ebook/ebook-test-utils.c
index 634396a..0fee18d 100644
--- a/addressbook/tests/ebook/ebook-test-utils.c
+++ b/addressbook/tests/ebook/ebook-test-utils.c
@@ -260,6 +260,64 @@ ebook_test_utils_book_async_get_contact (EBook       *book,
         }
 }
 
+GList*
+ebook_test_utils_book_get_required_fields (EBook *book)
+{
+        GList *fields = NULL;
+        GError *error = NULL;
+
+        if (!e_book_get_required_fields (book, &fields, &error)) {
+                const char *uri;
+
+                uri = e_book_get_uri (book);
+                g_warning ("failed to get required fields for addressbook "
+                                "`%s': %s", uri, error->message);
+                exit(1);
+        }
+
+        return fields;
+}
+
+static void
+get_required_fields_cb (EBook            *book,
+                        EBookStatus       status,
+                        EList            *fields,
+                        EBookTestClosure *closure)
+{
+        if (status != E_BOOK_ERROR_OK) {
+                g_warning ("failed to asynchronously get the contact: "
+                                "status %d", status);
+                exit (1);
+        }
+
+        closure->list = fields;
+
+        g_print ("successfully asynchronously retrieved the required fields\n");
+
+        if (closure) {
+                (*closure->cb) (closure);
+                g_free (closure);
+        }
+}
+
+void
+ebook_test_utils_book_async_get_required_fields (EBook       *book,
+                                                 GSourceFunc  callback,
+                                                 gpointer     user_data)
+{
+        EBookTestClosure *closure;
+
+        closure = g_new0 (EBookTestClosure, 1);
+        closure->cb = callback;
+        closure->user_data = user_data;
+        if (e_book_async_get_required_fields (book,
+                                (EBookEListCallback) get_required_fields_cb,
+                                closure)) {
+                g_warning ("failed to set up async getRequiredFields");
+                exit(1);
+        }
+}
+
 const char*
 ebook_test_utils_book_get_static_capabilities (EBook *book)
 {
diff --git a/addressbook/tests/ebook/ebook-test-utils.h b/addressbook/tests/ebook/ebook-test-utils.h
index 3b0b963..02f8bc3 100644
--- a/addressbook/tests/ebook/ebook-test-utils.h
+++ b/addressbook/tests/ebook/ebook-test-utils.h
@@ -29,8 +29,9 @@
 #define EBOOK_TEST_UTILS_VCARDS_DIR "vcards"
 
 typedef struct {
-        GSourceFunc    cb;
-        gpointer       user_data;
+        GSourceFunc  cb;
+        gpointer     user_data;
+	EList       *list;
 } EBookTestClosure;
 
 gboolean
@@ -78,6 +79,13 @@ ebook_test_utils_book_async_get_contact (EBook       *book,
                                          GSourceFunc  callback,
                                          gpointer     user_data);
 
+GList*
+ebook_test_utils_book_get_required_fields (EBook *book);
+void
+ebook_test_utils_book_async_get_required_fields (EBook       *book,
+                                                 GSourceFunc  callback,
+                                                 gpointer     user_data);
+
 const char*
 ebook_test_utils_book_get_static_capabilities (EBook *book);
 
diff --git a/addressbook/tests/ebook/test-ebook-get-required-fields.c b/addressbook/tests/ebook/test-ebook-get-required-fields.c
new file mode 100644
index 0000000..d40cda5
--- /dev/null
+++ b/addressbook/tests/ebook/test-ebook-get-required-fields.c
@@ -0,0 +1,75 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
+
+#include <stdlib.h>
+#include <libebook/e-book.h>
+
+#include "ebook-test-utils.h"
+
+static void
+list_member_print_and_free (char     *member,
+		            gpointer  user_data)
+{
+	g_print ("    %s\n", member);
+	g_free (member);
+}
+
+static void
+get_required_fields_cb (EBookTestClosure *closure)
+{
+	/* XXX: assuming an empty list is valid, we'll just print out anything
+	 * we do get */
+	if (closure->list) {
+		EIterator *iter;
+		const char *field;
+
+		g_print ("required fields:\n");
+		iter = e_list_get_iterator (closure->list);
+		while ((field = e_iterator_get (iter))) {
+			g_print ("    %s\n", field);
+			e_iterator_next (iter);
+		}
+		g_print ("----------------\n");
+	}
+
+	g_object_unref (closure->list);
+
+        g_main_loop_quit ((GMainLoop*) (closure->user_data));
+}
+
+gint
+main (gint argc, gchar **argv)
+{
+	EBook *book;
+	GMainLoop *loop;
+	GList *fields;
+
+	g_type_init ();
+
+	/*
+	 * Setup
+	 */
+	book = ebook_test_utils_book_new_temp (NULL);
+	ebook_test_utils_book_open (book, FALSE);
+
+	/*
+	 * Sync version
+	 */
+	fields = ebook_test_utils_book_get_required_fields (book);
+
+	g_print ("successfully retrieved required fields:\n");
+	g_list_foreach (fields, (GFunc) list_member_print_and_free, NULL);
+	g_list_free (fields);
+
+	/*
+	 * Async version
+	 */
+	loop = g_main_loop_new (NULL, TRUE);
+	ebook_test_utils_book_async_get_required_fields (book,
+			(GSourceFunc) get_required_fields_cb, loop);
+
+	g_main_loop_run (loop);
+
+	ebook_test_utils_book_remove (book);
+
+	return 0;
+}