Merge lp:~robru/libfriends/dbusmock into lp:libfriends

[Robert Bruce Park]

Begin using the new ClearCalls/GetCalls dbusmock API in the libfriends testsuite.

Note that this commit introduces a hard dep on python-dbusmock 0.4.0, which is not yet released, but has been backported as the python-dbusmock package in the super-friends/daily PPA.

[Ken VanDine (ken-vandine)]

Looks and works great

review: Approve

=== modified file 'tests/vala/Makefile.am'
--- tests/vala/Makefile.am	2013-01-09 18:48:28 +0000
+++ tests/vala/Makefile.am	2013-01-17 09:19:21 +0000
@@ -34,14 +34,14 @@
 	dbusmock.vala \
 	test-utils.vala \
 	test-service.vala \
-	test-vala.vala 
+	test-vala.vala
 
 TESTS = test-runner
 
 test-runner: test-vala Makefile.am
 	@echo "#!/bin/sh" > $@
 	@echo export G_DEBUG=fatal_criticals >> $@
-	@echo xvfb-run $(DBUS_RUNNER) --task python3 -p -m -p dbusmock -p com.canonical.Friends.Service -p /com/canonical/friends/Service -p com.canonical.Friends.Service --task-name DBusService --ignore-return --task ./test-vala --wait-for com.canonical.Friends.Service --task-name Service >> $@
+	@echo xvfb-run $(DBUS_RUNNER) --task python3 -p -m -p dbusmock -p com.canonical.Friends.Service -p /com/canonical/friends/Service -p com.canonical.Friends.Service -p --logfile -p /dev/null --task-name DBusService --ignore-return --task ./test-vala --wait-for com.canonical.Friends.Service --task-name Service >> $@
 	@chmod +x $@
 
 CLEANFILES = \

=== modified file 'tests/vala/dbusmock.vala'
--- tests/vala/dbusmock.vala	2013-01-08 21:43:40 +0000
+++ tests/vala/dbusmock.vala	2013-01-17 09:19:21 +0000
@@ -17,9 +17,21 @@
  * Authored by Ken VaDine <[e-mail]>
  */
 
+/**
+ * This struct represents a particular call to a mocked method. The
+ * DBus type string corresponding to this struct is 'a(tsav)'.
+ */
+public struct CallSignature {
+    public uint64 timestamp;
+    public string method_name;
+    public Variant[] call_args;
+}
+
 [DBus (name = "org.freedesktop.DBus.Mock")]
 private interface DBusMockInterface : GLib.Object {
         public abstract void AddMethod (string iface, string method, string in_s, string out_s, string params) throws IOError;
+        public abstract CallSignature[] GetCalls () throws IOError;
+        public abstract void ClearCalls () throws IOError;
 }
 
 namespace Friends.Test
@@ -54,5 +66,25 @@
                 warning (e.message);
             }
         }
+
+        public CallSignature[] get_calls()
+        {
+            CallSignature[] calls = null;
+            try {
+                calls = dbusmock.GetCalls();
+            } catch (GLib.IOError e) {
+                warning (e.message);
+            }
+            return calls;
+        }
+
+        public void clear_calls()
+        {
+            try {
+                dbusmock.ClearCalls();
+            } catch (GLib.IOError e) {
+                warning (e.message);
+            }
+        }
     }
 }

=== modified file 'tests/vala/test-service.vala'
--- tests/vala/test-service.vala	2013-01-14 18:06:20 +0000
+++ tests/vala/test-service.vala	2013-01-17 09:19:21 +0000
@@ -23,9 +23,11 @@
 {
     public class ServiceSuite
     {
+        public static DBusMock dbusmock;
+
         public ServiceSuite ()
         {
-            var dbusmock = new DBusMock ();
+            dbusmock = new DBusMock ();
             /* Add mock methods to the dbus interface for testing
              * python-dbusmock docs can be found at
              * http://bazaar.launchpad.net/~pitti/python-dbusmock/trunk/view/head:/README.rst
@@ -63,6 +65,7 @@
 
         static Friends.Service? get_service ()
         {
+            dbusmock.clear_calls ();
             Friends.Service service = null;
             try {
                 service = new Friends.Service ();
@@ -74,40 +77,45 @@
 
         internal static void test_refresh ()
         {
+            dbusmock.clear_calls ();
             var service = get_service ();
-            bool success = false;
             try
             {
                 service.refresh ();
-                success = true;
             }
             catch (GLib.IOError e)
             {
                 warning ("Failed to refresh - %s", e.message);
             }
-            assert (success == true);
-
+            CallSignature[] calls = dbusmock.get_calls();
+            assert (calls.length == 1);
+            assert (calls[0].timestamp > 10000);
+            assert (calls[0].method_name == "Refresh");
+            assert (calls[0].call_args.length == 0);
         }
 
         internal static void test_quit ()
         {
+            dbusmock.clear_calls ();
             var service = get_service ();
-            bool success = false;
             try
             {
                 service.quit ();
-                success = true;
             }
             catch (GLib.IOError e)
             {
                 warning ("Failed to shutdown - %s", e.message);
             }
-            assert (success == true);
-
+            CallSignature[] calls = dbusmock.get_calls();
+            assert (calls.length == 1);
+            assert (calls[0].timestamp > 10000);
+            assert (calls[0].method_name == "Quit");
+            assert (calls[0].call_args.length == 0);
         }
 
         internal static void test_features ()
         {
+            dbusmock.clear_calls ();
             var service = get_service ();
             string[] features = null;
             try
@@ -120,10 +128,17 @@
             }
             assert (features != null);
             assert ("send" in features);
+            CallSignature[] calls = dbusmock.get_calls();
+            assert (calls.length == 1);
+            assert (calls[0].timestamp > 10000);
+            assert (calls[0].method_name == "GetFeatures");
+            assert (calls[0].call_args.length == 1);
+            assert (calls[0].call_args[0].get_string() == "twitter");
         }
 
         internal static void test_upload ()
         {
+            dbusmock.clear_calls ();
             var service = get_service ();
             uint acct = 1;
             string uri = "file:///tmp/foo.png";
@@ -141,77 +156,97 @@
 
         internal static void test_send_message ()
         {
+            dbusmock.clear_calls ();
             var service = get_service ();
             uint? acct = null;
             string msg = "A message";
-            bool success = false;
             try
             {
                 service.send_message (acct, msg);
-                success = true;
             }
             catch (GLib.IOError e)
             {
                 warning ("Failed to SendMessage - %s", e.message);
             }
-            assert (success == true);
+            CallSignature[] calls = dbusmock.get_calls();
+            assert (calls.length == 1);
+            assert (calls[0].timestamp > 10000);
+            assert (calls[0].method_name == "SendMessage");
+            assert (calls[0].call_args.length == 1);
+            assert (calls[0].call_args[0].get_string() == "A message");
         }
 
         internal static void test_send_message_with_account ()
         {
+            dbusmock.clear_calls ();
             var service = get_service ();
             uint acct = 1;
             string msg = "A message";
-            bool success = false;
             try
             {
                 service.send_message (acct, msg);
-                success = true;
             }
             catch (GLib.IOError e)
             {
                 warning ("Failed to SendMessage - %s", e.message);
             }
-            assert (success == true);
+            CallSignature[] calls = dbusmock.get_calls();
+            assert (calls.length == 1);
+            assert (calls[0].timestamp > 10000);
+            assert (calls[0].method_name == "Do");
+            assert (calls[0].call_args.length == 3);
+            assert (calls[0].call_args[0].get_string() == "send");
+            assert (calls[0].call_args[1].get_string() == "1");
+            assert (calls[0].call_args[2].get_string() == "A message");
         }
 
         internal static void test_send_reply ()
         {
+            dbusmock.clear_calls ();
             var service = get_service ();
             uint acct = 1;
             string msg = "A message";
             string msg_id = "100";
-            bool success = false;
             try
             {
                 service.send_reply (acct, msg_id, msg);
-                success = true;
             }
             catch (GLib.IOError e)
             {
                 warning ("Failed to SendReply - %s", e.message);
             }
-            assert (success == true);
+            CallSignature[] calls = dbusmock.get_calls();
+            assert (calls.length == 1);
+            assert (calls[0].timestamp > 10000);
+            assert (calls[0].method_name == "SendReply");
+            assert (calls[0].call_args.length == 3);
+            assert (calls[0].call_args[0].get_string() == "A message");
+            assert (calls[0].call_args[1].get_string() == "1");
+            assert (calls[0].call_args[2].get_string() == "100");
         }
 
         internal static void test_clear_indicators ()
         {
+            dbusmock.clear_calls ();
             var service = get_service ();
-            bool success = false;
             try
             {
                 service.messaging_menu_clear ();
-                success = true;
             }
             catch (GLib.IOError e)
             {
                 warning ("Failed to clear indicators - %s", e.message);
             }
-            assert (success == true);
+            CallSignature[] calls = dbusmock.get_calls();
+            assert (calls.length == 1);
+            assert (calls[0].timestamp > 10000);
+            assert (calls[0].method_name == "ClearIndicators");
+            assert (calls[0].call_args.length == 0);
         }
 
         internal static void test_url_shorten ()
         {
+            dbusmock.clear_calls ();
             var service = get_service ();
             string result = "";
             try
@@ -223,6 +258,13 @@
                 warning ("Failed to shorten URL - %s", e.message);
             }
             assert (result == "http://is.gd/short");
+            CallSignature[] calls = dbusmock.get_calls();
+            assert (calls.length == 1);
+            assert (calls[0].timestamp > 10000);
+            assert (calls[0].method_name == "URLShorten");
+            assert (calls[0].call_args.length == 1);
+            assert (calls[0].call_args[0].get_string() ==
+                    "http://example.com/really/really/long");
         }
     }
 }