Merge lp:~stolowski/libunity/video-props-in-extras into lp:libunity

[Paweł Stołowski]

Added tests for unity-extras (preview player interface).

Added tests for unity-extras (preview player interface), as requested in https://code.launchpad.net/~stolowski/libunity/video-props-in-extras/+merge/135904

[Michal Hruby (mhr3)]

179 + [DBus (name = "com.canonical.Unity.Lens.Music.PreviewPlayer")]
180 + public class PreviewPlayerServiceMock : Object

Please, make the class implement the *Service interface from extras instead.

283 + service.reset ();

Would be nicer if each test created its own ServiceMock instance, the less global state, the better.

284 + service.test_loop = new MainLoop ();

Why is this part of the service instance? Should be a separate variable, no?

Otherwise looking good.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:204
http://s-jenkins:8080/job/libunity-ci/11/
Executed test runs:
    SUCCESS: http://s-jenkins:8080/job/libunity-ci/./distribution=raring,flavor=amd64,label=pbuilder/11/console
    SUCCESS: http://s-jenkins:8080/job/libunity-ci/./distribution=raring,flavor=i386,label=pbuilder/11/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/libunity-ci/11//rebuild/?

review: Approve (continuous-integration)

[lp:~stolowski/libunity/video-props-in-extras]

205. By Paweł Stołowski on 2012-12-03

Generate unity-extras-internal{.vapi, .h}.

206. By Paweł Stołowski on 2012-12-03

Use Extras.PreviewPlayerService interface definition in the test.

207. By Paweł Stołowski on 2012-12-03

Made test_loop a global variable, not a membler of service mock.

208. By Paweł Stołowski on 2012-12-03

Create service mock instance in each test.

[Michal Hruby (mhr3)]

Nice! :)

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:208
http://s-jenkins:8080/job/libunity-ci/12/
Executed test runs:
    SUCCESS: http://s-jenkins:8080/job/libunity-ci/./distribution=raring,flavor=amd64,label=pbuilder/12/console
    SUCCESS: http://s-jenkins:8080/job/libunity-ci/./distribution=raring,flavor=i386,label=pbuilder/12/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/libunity-ci/12//rebuild/?

review: Approve (continuous-integration)

=== modified file 'extras/Makefile.am'
--- extras/Makefile.am	2012-10-17 12:05:12 +0000
+++ extras/Makefile.am	2012-12-03 12:55:31 +0000
@@ -22,7 +22,10 @@
   -H unity-extras.h \
   --gir=UnityExtras-@GIR_VERSION@.gir \
   --library unity-extras \
+  --internal-vapi=unity-extras-internal.vapi \
+  --internal-header=unity-extras-internal.h \
   --thread \
+  --use-header \
   --vapidir $(top_srcdir)/vapi \
   --vapidir $(top_builddir)/src \
   --vapidir $(top_builddir)/protocol \
@@ -68,7 +71,13 @@
 
 libunity_extras_la_GENERATED = \
   unity-extras.vapi \
-  UnityExtras-@GIR_VERSION@.gir
+  UnityExtras-@GIR_VERSION@.gir \
+  unity-extras-internal.h \
+  unity-extras-internal.vapi \
+  $(NULL)
+
+# Used by tests
+noinst_DATA = unity-extras-internal.h unity-extras-internal.vapi
 
 $(libunity_la_GENERATED): libunity_la_vala.stamp
 

=== modified file 'test/vala/Makefile.am'
--- test/vala/Makefile.am	2012-11-27 13:08:48 +0000
+++ test/vala/Makefile.am	2012-12-03 12:55:31 +0000
@@ -2,7 +2,7 @@
 
 DISTCHECK_CONFIGURE_FLAGS = --enable-integration-tests=no
 
-check_PROGRAMS = test-vala test-lens test-remote-scope test-blacklist-crash
+check_PROGRAMS = test-vala test-lens test-remote-scope test-blacklist-crash test-extras
 
 AM_CPPFLAGS = \
 	-I$(top_srcdir) \
@@ -31,7 +31,17 @@
 	--vapidir=$(top_srcdir)/test/vala \
 	--pkg unity-protocol \
 	--pkg unity-internal \
-	--pkg unity-extras \
+	--pkg config \
+	$(LIBUNITY_PACKAGES) \
+	$(MAINTAINER_VALAFLAGS) \
+	$(NULL)
+
+test_extras_AM_VALAFLAGS = \
+	--vapidir=$(top_builddir)/src \
+	--vapidir=$(top_builddir)/extras \
+	--vapidir=$(top_srcdir)/test/vala \
+	--pkg unity \
+	--pkg unity-extras-internal \
 	--pkg config \
 	$(LIBUNITY_PACKAGES) \
 	$(MAINTAINER_VALAFLAGS) \
@@ -43,7 +53,7 @@
 	$(top_builddir)/extras/libunity-extras.la \
 	$(LIBUNITY_LIBS)
 
-TEST_PROGS += test-vala test-lens test-blacklist-crash
+TEST_PROGS += test-vala test-lens test-blacklist-crash test-extras
 
 test_vala_LDADD = $(test_libs)
 
@@ -57,7 +67,6 @@
 	test-previews.vala \
 	test-scope-signals.vala \
 	test-vala.vala \
-	test-utils.vala \
 	$(NULL)
 nodist_test_vala_SOURCES = $(test_vala_VALASOURCES:.vala=.c)
 
@@ -73,11 +82,22 @@
 test_blacklist_crash_VALASOURCES = blacklist-crash-1029949-test-case.vala
 nodist_test_blacklist_crash_SOURCES = $(test_blacklist_crash_VALASOURCES:.vala=.c)
 
+test_extras_LDADD = $(test_libs)
+test_extras_VALASOURCES = \
+	test-preview-player-iface.vala \
+	test-utils.vala \
+	common.vala \
+	test-extras.vala \
+	$(NULL)
+
+nodist_test_extras_SOURCES = $(test_extras_VALASOURCES:.vala=.c)
+
 BUILT_SOURCES = \
 	test-vala.vala.stamp \
 	test-lens.vala.stamp \
 	test-remote-scope.vala.stamp \
 	test-blacklist-crash.vala.stamp \
+	test-extras.vala.stamp \
 	$(NULL)
 
 test-vala.vala.stamp: $(test_vala_VALASOURCES)
@@ -96,6 +116,10 @@
 	$(AM_V_GEN)$(VALAC) -C $(AM_VALAFLAGS) $(VALAFLAGS) $^
 	@touch $@
 
+test-extras.vala.stamp: $(test_extras_VALASOURCES)
+	$(AM_V_GEN)$(VALAC) -C $(test_extras_AM_VALAFLAGS) $(VALAFLAGS) $^
+	@touch $@
+
 include Makefile.integration_tests
 
 EXTRA_DIST += \
@@ -103,6 +127,7 @@
 	$(test_lens_VALASOURCES) \
 	$(test_remote_scope_VALASOURCES) \
 	$(test_blacklist_crash_VALASOURCES) \
+	$(test_extras_VALASOURCES) \
 	config.vapi \
 	$(NULL)
 
@@ -112,4 +137,5 @@
 	$(test_lens_VALASOURCES:.vala=.c) \
 	$(test_remote_scope_VALASOURCES:.vala=.c) \
 	$(test_blacklist_crash_VALASOURCES:.vala=.c) \
+	$(test_extras_VALASOURCES:.vala=.c) \
 	$(NULL)

=== added file 'test/vala/test-extras.vala'
--- test/vala/test-extras.vala	1970-01-01 00:00:00 +0000
+++ test/vala/test-extras.vala	2012-12-03 12:55:31 +0000
@@ -0,0 +1,52 @@
+/*
+ * Copyright (C) 2010 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by Pawel Stolowski <[e-mail]>
+ *
+ */
+
+using Unity.Test;
+
+public class Main
+{
+  public static int main (string[] args)
+  {
+    UtilsTestSuite utils_suite;
+    PreviewPlayerIfaceTestSuite preview_player_suite;
+
+    string gsettings_schema_dir = Config.BUILDDIR+"/data";
+
+    Environment.set_variable ("XDG_DATA_HOME", Config.TESTDIR+"/data", true);
+    Environment.set_variable ("GSETTINGS_SCHEMA_DIR", gsettings_schema_dir, true);
+    Environment.set_variable ("GSETTINGS_BACKEND", "memory", true);
+    try {
+      Process.spawn_command_line_sync ("glib-compile-schemas " + gsettings_schema_dir);
+    } catch (SpawnError e) {
+      stderr.printf ("%s\n", e.message);
+      return 1;
+    }
+    Test.init (ref args);
+
+    /* Extra-utils test suite */
+    utils_suite = new UtilsTestSuite ();
+
+    /* Preview player interface test suite */
+    preview_player_suite = new PreviewPlayerIfaceTestSuite ();
+
+    Test.run ();
+
+    return 0;
+  }
+}

=== added file 'test/vala/test-preview-player-iface.vala'
--- test/vala/test-preview-player-iface.vala	1970-01-01 00:00:00 +0000
+++ test/vala/test-preview-player-iface.vala	2012-12-03 12:55:31 +0000
@@ -0,0 +1,323 @@
+/*
+ * Copyright (C) 2012 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by Pawel Stolowski <[e-mail]>
+ *
+ */
+using Unity;
+
+namespace Unity.Test
+{
+  public GLib.MainLoop test_loop;
+
+  internal class PreviewPlayerServiceMock : Extras.PreviewPlayerService, GLib.Object
+  {
+    public string got_play_uri;
+    public string got_video_properties_uri;
+    public bool got_close;
+    public bool got_stop;
+    public bool got_pause;
+    public bool got_resume;
+    public bool got_pause_resume;
+
+    public PreviewPlayerServiceMock ()
+    {
+      reset ();
+    }
+
+    public void reset ()
+    {
+      got_play_uri = "";
+      got_video_properties_uri = "";
+      got_close = false;
+      got_stop = false;
+      got_pause = false;
+      got_pause_resume = false;
+      got_resume = false;
+    }
+
+    public async void play (string uri) throws Error
+    {
+      got_play_uri = uri;
+      Unity.Test.test_loop.quit ();
+    }
+
+    public async void pause () throws Error
+    {
+      got_pause = true;
+      Unity.Test.test_loop.quit ();
+    }
+
+    public async void resume () throws Error
+    {
+      got_resume = true;
+      Unity.Test.test_loop.quit ();
+    }
+
+    public async void pause_resume () throws Error
+    {
+      got_pause_resume = true;
+      test_loop.quit ();
+    }
+
+    public async void stop () throws Error
+    {
+      got_stop = true;
+      test_loop.quit ();
+    }
+
+    public async void close () throws Error
+    {
+      got_close = true;
+      Unity.Test.test_loop.quit ();
+    }
+
+    public async HashTable<string, Variant> video_properties (string uri) throws Error
+    {
+      got_video_properties_uri = uri;
+      var res = new HashTable<string, Variant> (str_hash, str_equal);
+      res.insert ("got_uri", new GLib.Variant.string (uri));
+      return res;
+    }
+  }
+
+  public class PreviewPlayerIfaceTestSuite
+  {
+    private static Unity.Extras.PreviewPlayer preview_player;
+    private static DBusConnection conn;
+
+    public PreviewPlayerIfaceTestSuite ()
+    {
+      // create fake preview player service that will get all test requests via DBus
+      conn = GLib.Bus.get_sync (BusType.SESSION, null);
+      GLib.Bus.own_name (BusType.SESSION, "com.canonical.Unity.Lens.Music.PreviewPlayer", 0);
+
+      // create preview player proxy object that interacts with fake player service
+      preview_player = new Unity.Extras.PreviewPlayer ();
+
+      GLib.Test.add_data_func ("/Unit/Utils/PreviewPlayerPlay", PreviewPlayerIfaceTestSuite.test_preview_player_play);
+      GLib.Test.add_data_func ("/Unit/Utils/PreviewPlayerPause", PreviewPlayerIfaceTestSuite.test_preview_player_pause);
+      GLib.Test.add_data_func ("/Unit/Utils/PreviewPlayerResume", PreviewPlayerIfaceTestSuite.test_preview_player_resume);
+      GLib.Test.add_data_func ("/Unit/Utils/PreviewPlayerPauseResume", PreviewPlayerIfaceTestSuite.test_preview_player_pause_resume);
+      GLib.Test.add_data_func ("/Unit/Utils/PreviewPlayerStop", PreviewPlayerIfaceTestSuite.test_preview_player_stop);
+      GLib.Test.add_data_func ("/Unit/Utils/PreviewPlayerClose", PreviewPlayerIfaceTestSuite.test_preview_player_close);
+      GLib.Test.add_data_func ("/Unit/Utils/PreviewPlayerVideoProperties", PreviewPlayerIfaceTestSuite.test_preview_player_video_properties);
+      GLib.Test.add_data_func ("/Unit/Utils/PreviewPlayerProgressSignal", PreviewPlayerIfaceTestSuite.test_preview_player_progress_signal);
+    }
+
+    internal static PreviewPlayerServiceMock create_service_mock (out uint id)
+    {
+      PreviewPlayerServiceMock service = new PreviewPlayerServiceMock ();
+      id = conn.register_object<Extras.PreviewPlayerService> ("/com/canonical/Unity/Lens/Music/PreviewPlayer", service);
+      return service;
+    }
+
+    internal static void unregister_service_mock (uint id)
+    {
+      conn.unregister_object (id);
+    }
+
+    internal static void test_preview_player_play ()
+    {
+      uint id;
+      var service = create_service_mock (out id);
+      test_loop = new MainLoop ();
+
+      preview_player.play ("bar");
+
+      run_with_timeout (test_loop, 5000);
+
+      assert (service.got_play_uri == "bar");
+      assert (service.got_pause == false);
+      assert (service.got_resume == false);
+      assert (service.got_pause_resume == false);
+      assert (service.got_stop == false);
+      assert (service.got_video_properties_uri == "");
+      assert (service.got_close == false);
+
+      unregister_service_mock (id);
+    }
+
+    internal static void test_preview_player_pause ()
+    {
+      uint id;
+      var service = create_service_mock (out id);
+      test_loop = new MainLoop ();
+
+      preview_player.pause ();
+
+      run_with_timeout (test_loop, 5000);
+
+      assert (service.got_play_uri == "");
+      assert (service.got_pause == true);
+      assert (service.got_resume == false);
+      assert (service.got_pause_resume == false);
+      assert (service.got_stop == false);
+      assert (service.got_video_properties_uri == "");
+      assert (service.got_close == false);
+
+      unregister_service_mock (id);
+    }
+
+    internal static void test_preview_player_resume ()
+    {
+      uint id;
+      var service = create_service_mock (out id);
+      test_loop = new MainLoop ();
+
+      preview_player.resume ();
+
+      run_with_timeout (test_loop, 5000);
+
+      assert (service.got_play_uri == "");
+      assert (service.got_pause == false);
+      assert (service.got_resume == true);
+      assert (service.got_pause_resume == false);
+      assert (service.got_stop == false);
+      assert (service.got_video_properties_uri == "");
+      assert (service.got_close == false);
+
+      unregister_service_mock (id);
+    }
+
+    internal static void test_preview_player_pause_resume ()
+    {
+      uint id;
+      var service = create_service_mock (out id);
+      test_loop = new MainLoop ();
+
+      preview_player.pause_resume ();
+
+      run_with_timeout (test_loop, 5000);
+
+      assert (service.got_play_uri == "");
+      assert (service.got_pause == false);
+      assert (service.got_resume == false);
+      assert (service.got_pause_resume == true);
+      assert (service.got_stop == false);
+      assert (service.got_video_properties_uri == "");
+      assert (service.got_close == false);
+
+      unregister_service_mock (id);
+    }
+
+    internal static void test_preview_player_stop ()
+    {
+      uint id;
+      var service = create_service_mock (out id);
+      test_loop = new MainLoop ();
+
+      preview_player.stop ();
+
+      run_with_timeout (test_loop, 5000);
+
+      assert (service.got_play_uri == "");
+      assert (service.got_pause == false);
+      assert (service.got_resume == false);
+      assert (service.got_pause_resume == false);
+      assert (service.got_stop == true);
+      assert (service.got_video_properties_uri == "");
+      assert (service.got_close == false);
+
+      unregister_service_mock (id);
+    }
+
+    internal static void test_preview_player_close ()
+    {
+      uint id;
+      var service = create_service_mock (out id);
+      test_loop = new MainLoop ();
+
+      preview_player.close ();
+
+      run_with_timeout (test_loop, 5000);
+
+      assert (service.got_play_uri == "");
+      assert (service.got_pause == false);
+      assert (service.got_resume == false);
+      assert (service.got_pause_resume == false);
+      assert (service.got_stop == false);
+      assert (service.got_video_properties_uri == "");
+      assert (service.got_close == true);
+
+      unregister_service_mock (id);
+    }
+
+    internal static void test_preview_player_video_properties ()
+    {
+      uint id;
+      var service = create_service_mock (out id);
+      test_loop = new MainLoop ();
+
+      HashTable<string, Variant> props = null;
+
+      preview_player.video_properties.begin ("foo", (obj, res) =>
+      {
+        props = preview_player.video_properties.end (res);
+      });
+
+      run_with_timeout (test_loop, 5000);
+
+      assert (props != null);
+      assert (props["got_uri"].get_string () == "foo");
+      assert (service.got_play_uri == "");
+      assert (service.got_pause == false);
+      assert (service.got_resume == false);
+      assert (service.got_pause_resume == false);
+      assert (service.got_stop == false);
+      assert (service.got_video_properties_uri == "foo");
+      assert (service.got_close == false);
+
+      unregister_service_mock (id);
+    }
+
+    internal static void test_preview_player_progress_signal ()
+    {
+      uint id;
+      var service = create_service_mock (out id);
+      test_loop = new MainLoop ();
+
+      string got_progress_uri = "";
+      Unity.MusicPreview.TrackState got_progress_state = Unity.MusicPreview.TrackState.STOPPED;
+      double got_progress_value = 0.0f;
+
+      preview_player.progress.connect ((uri, state, value) =>
+      {
+        got_progress_uri = uri;
+        got_progress_state = state;
+        got_progress_value = value;
+        test_loop.quit ();
+        });
+
+      service.progress ("foouri", 1, 0.5f);
+
+      run_with_timeout (test_loop, 1000);
+
+      assert (got_progress_uri == "foouri");
+      assert (got_progress_state == MusicPreview.TrackState.PLAYING);
+      assert (got_progress_value == 0.5f);
+
+      assert (service.got_play_uri == "");
+      assert (service.got_pause == false);
+      assert (service.got_resume == false);
+      assert (service.got_pause_resume == false);
+      assert (service.got_stop == false);
+      assert (service.got_video_properties_uri == "");
+      assert (service.got_close == false);
+
+      unregister_service_mock (id);
+    }
+  }
+}
\ No newline at end of file

=== modified file 'test/vala/test-utils.vala'
--- test/vala/test-utils.vala	2012-11-27 13:40:58 +0000
+++ test/vala/test-utils.vala	2012-12-03 12:55:31 +0000
@@ -24,8 +24,8 @@
   {
     public UtilsTestSuite ()
     {
-      GLib.Test.add_data_func ("/Unit/Utils/Allocation", UtilsTestSuite.test_dbus_name_has_owner);
-      GLib.Test.add_data_func ("/Unit/Utils/Allocation", UtilsTestSuite.test_dbus_own_name);
+      GLib.Test.add_data_func ("/Unit/Utils/DbusNameHasOwner", UtilsTestSuite.test_dbus_name_has_owner);
+      GLib.Test.add_data_func ("/Unit/Utils/DbusOwnName", UtilsTestSuite.test_dbus_own_name);
     }
 
     internal static void test_dbus_name_has_owner ()

=== modified file 'test/vala/test-vala.vala'
--- test/vala/test-vala.vala	2012-11-27 13:08:48 +0000
+++ test/vala/test-vala.vala	2012-12-03 12:55:31 +0000
@@ -25,12 +25,12 @@
   {
     IOSuite io;
     AppInfoManagerSuite appinfo_manager;
-    UtilsTestSuite utils_suite;
     LauncherSuite launcher;
     FilterSuite filter_suite;
     PreferencesSuite preferences_suite;
     PreviewSuite preview_suite;
     ScopeSuite scope_suite;
+
     string gsettings_schema_dir = Config.BUILDDIR+"/data";
 
     Environment.set_variable ("XDG_DATA_HOME", Config.TESTDIR+"/data", true);
@@ -62,9 +62,6 @@
     /* Scope test suite */
     scope_suite = new ScopeSuite ();
 
-    /* Extra-utils test suite */
-    utils_suite = new UtilsTestSuite ();
-
     Test.run ();
 
     return 0;