Merge lp:~mikemc/unity-scope-click/fix-1263807 into lp:unity-scope-click

[Mike McCracken]

- Check for download progress when building default preview (LP: #1263807)

- Check for download progress when building default preview (LP: #1263807)

Adds checking for download progress source and using install*ING* preview when generating default preview, to cover cases where a new app preview is requested directly by the dash (not by the apps preview) while the app is still downloading

Also adds tests for build_default_preview.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:98
http://jenkins.qa.ubuntu.com/job/unity-scope-click-ci/137/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-amd64-ci/35
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-armhf-ci/35

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scope-click-ci/137/rebuild

review: Approve (continuous-integration)

[Roberto Alsina (ralsina)]

review: Approve

[dobey (dobey)]

The empty lines after returns inside the if blocks are a bit weird, but otherwise this looks fine.

review: Approve

=== modified file 'src/click-scope.vala'
--- src/click-scope.vala	2013-12-19 23:29:56 +0000
+++ src/click-scope.vala	2013-12-24 00:48:16 +0000
@@ -131,11 +131,11 @@
     }
   }
 
-    bool uri_is_click_install (string uri) {
+    public virtual bool uri_is_click_install (string uri) {
         return uri.has_prefix (App.CLICK_INSTALL_SCHEMA);
     }
 
-    async Unity.Preview build_uninstalled_preview (Unity.ScopeResult result) {
+    public async virtual Unity.Preview build_uninstalled_preview (Unity.ScopeResult result) {
         var price = result.metadata.get(METADATA_PRICE).get_double();
         Unity.Preview preview = yield build_app_preview (result);
         if (!(preview is Unity.GenericPreview)) {
@@ -148,7 +148,7 @@
         return preview;
     }
 
-    public async Unity.Preview build_installed_preview (Unity.ScopeResult result, string application_uri) {
+    public async virtual Unity.Preview build_installed_preview (Unity.ScopeResult result, string application_uri) {
         var app_id = result.metadata.get(METADATA_APP_ID).get_string();
         Unity.Preview preview = yield build_app_preview (result);
         preview.add_action (new Unity.PreviewAction (ACTION_OPEN_CLICK + ":" + application_uri, ("Open"), null));
@@ -189,8 +189,15 @@
     }
 
     public async Unity.Preview build_default_preview (Unity.ScopeResult result) {
-        if (uri_is_click_install(result.uri)) {
+        var app_id = result.metadata.get(METADATA_APP_ID).get_string();
+        var progress_source = get_progress_source(app_id);
+
+        if (progress_source != null) {
+            return yield build_installing_preview (result, progress_source);
+
+        } else if (uri_is_click_install(result.uri)) {
             return yield build_uninstalled_preview (result);
+
         } else {
             return yield build_installed_preview (result, result.uri);
         }

=== modified file 'src/test-click-webservice.vala'
--- src/test-click-webservice.vala	2013-12-20 19:56:47 +0000
+++ src/test-click-webservice.vala	2013-12-24 00:48:16 +0000
@@ -523,6 +523,83 @@
         assert (scope.preview_is_installing);
     }
 
+    class FakeClickScopeForBuildDefaultTest : ClickScope {
+        public bool finds_progress = false;
+        public bool is_installable = false;
+
+        public bool build_installing_called = false;
+        public bool build_uninstalled_called = false;
+        public bool build_installed_called = false;
+
+        protected async override Unity.Preview build_installing_preview (Unity.ScopeResult result, string progress_source) {
+            build_installing_called = true;
+            return new Unity.ApplicationPreview ("fake_title", "fake_subtitle", "fake_description", null, null);
+        }
+
+        protected async override Unity.Preview build_uninstalled_preview (Unity.ScopeResult result) {
+            build_uninstalled_called = true;
+            return new Unity.ApplicationPreview ("fake_title", "fake_subtitle", "fake_description", null, null);
+        }
+
+        protected async override Unity.Preview build_installed_preview (Unity.ScopeResult result, string application_uri) {
+            build_installed_called = true;
+            return new Unity.ApplicationPreview ("fake_title", "fake_subtitle", "fake_description", null, null);
+        }
+
+        internal override string? get_progress_source(string app_id) {
+            if (finds_progress) {
+                return "fake_progress_source";
+            }
+            return null;
+        }
+
+        protected override bool uri_is_click_install (string uri) {
+            return is_installable;
+        }
+    }
+
+    public static void test_scope_build_default_preview_finds_progress_not_installable ()
+    {
+        do_test_scope_build_default_preview (true, false);
+    }
+
+    public static void test_scope_build_default_preview_no_progress_source_not_installable ()
+    {
+        do_test_scope_build_default_preview (false, false);
+    }
+
+    public static void test_scope_build_default_preview_finds_progress_is_installable ()
+    {
+        do_test_scope_build_default_preview (true, true);
+    }
+
+    public static void test_scope_build_default_preview_no_progress_source_is_installable ()
+    {
+        do_test_scope_build_default_preview (false, true);
+    }
+
+    public static void do_test_scope_build_default_preview (bool finds_progress, bool is_installable)
+    {    
+        MainLoop mainloop = new MainLoop ();
+        var scope = new FakeClickScopeForBuildDefaultTest ();
+        scope.finds_progress = finds_progress;
+        scope.is_installable = is_installable;
+        var result = create_fake_result ();
+        var metadata = new Unity.SearchMetadata();
+
+        scope.build_default_preview.begin(result, (obj, res) => {
+            mainloop.quit ();
+            try {
+                var response = scope.build_default_preview.end (res);
+            } catch (GLib.Error e) {
+                error ("Failure in activate_async: %s", e.message);
+            }
+        });
+        assert (run_with_timeout (mainloop, 10000));
+        assert (scope.build_installing_called == finds_progress);
+        assert (scope.build_uninstalled_called == (!finds_progress && is_installable));
+        assert (scope.build_installed_called == (!is_installable && !finds_progress));
+    }
 
     public static int main (string[] args)
     {
@@ -546,6 +623,14 @@
         Test.add_data_func ("/Unit/ClickChecker/Test_Scope_Build_Installed_Preview_Without_Uninstall", 
                             test_scope_build_installed_preview_without_uninstall);
         Test.add_data_func ("/Unit/ClickChecker/Test_Scope_InProgress", test_scope_in_progress);
+        Test.add_data_func ("/Unit/ClickChecker/Test_Scope_Build_Default_Preview_No_Progress_Is_Installable",
+                            test_scope_build_default_preview_no_progress_source_is_installable);
+        Test.add_data_func ("/Unit/ClickChecker/Test_Scope_Build_Default_Preview_No_Progress_Not_Installable",
+                            test_scope_build_default_preview_no_progress_source_not_installable);
+        Test.add_data_func ("/Unit/ClickChecker/Test_Scope_Build_Default_Preview_Finds_Progress_Is_Installable",
+                            test_scope_build_default_preview_finds_progress_is_installable);
+        Test.add_data_func ("/Unit/ClickChecker/Test_Scope_Build_Default_Preview_Finds_Progress_Not_Installable",
+                            test_scope_build_default_preview_finds_progress_not_installable);
         return Test.run ();
     }
 }