Merge lp:~stolowski/unity-scope-home/fix-1220630 into lp:unity-scope-home

[Paweł Stołowski]

Check if "images" member exists in metadata column to avoid assertion warnings.

Check if "images" member exists in metadata column to avoid assertion warnings; the results from searchin-scopes.scope have empty metadata.

[lp:~stolowski/unity-scope-home/fix-1220630]

165. By Paweł Stołowski on 2013-09-19

Added a comment.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:165
http://jenkins.qa.ubuntu.com/job/unity-scope-home-ci/87/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-home-saucy-amd64-ci/51
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-home-saucy-armhf-ci/51
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-home-saucy-i386-ci/51

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-scope-home-ci/87/rebuild

review: Approve (continuous-integration)

[lp:~stolowski/unity-scope-home/fix-1220630]

166. By Paweł Stołowski on 2013-09-19

Added test cases.

[Michal Hruby (mhr3)]

Great. +1

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:166
http://jenkins.qa.ubuntu.com/job/unity-scope-home-ci/88/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-home-saucy-amd64-ci/52
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-home-saucy-armhf-ci/52
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-home-saucy-i386-ci/52

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-scope-home-ci/88/rebuild

review: Approve (continuous-integration)

=== modified file 'src/smart-scopes-default-parser.vala'
--- src/smart-scopes-default-parser.vala	2013-09-11 15:36:37 +0000
+++ src/smart-scopes-default-parser.vala	2013-09-19 13:40:46 +0000
@@ -46,9 +46,13 @@
       Variant? metadata_var = null;
       try
       {
-        var image_obj = metadata.get_object_member ("images");
-        if (image_obj == null)
-          metadata_node.get_object ().remove_member ("images");
+        if (metadata.has_member("images"))
+        {
+            var image_obj = metadata.get_object_member ("images");
+            // protect against "images":null
+            if (image_obj == null)
+                metadata_node.get_object ().remove_member ("images");
+        }
         // the binding is wrong, deserialize returns floating variant
         metadata_var = json_gvariant_deserialize (metadata_node, "a{sv}");
       }

=== modified file 'tests/unit/test-home-scope.vala'
--- tests/unit/test-home-scope.vala	2013-09-04 10:28:06 +0000
+++ tests/unit/test-home-scope.vala	2013-09-19 13:40:46 +0000
@@ -96,6 +96,7 @@
 
     Test.add_data_func ("/Unit/SmartScopes/Parse", Fixture.create<SmartScopesUtilTester> (SmartScopesUtilTester.test_smart_scopes_parse));
     Test.add_data_func ("/Unit/SmartScopes/ParseErrors", Fixture.create<SmartScopesUtilTester> (SmartScopesUtilTester.test_smart_scopes_parse_errors));
+    Test.add_data_func ("/Unit/SmartScopes/ParseMissingOptionalFields", Fixture.create<SmartScopesUtilTester> (SmartScopesUtilTester.test_smart_scopes_parse_missing_optional_fields));
     Test.add_data_func ("/Unit/SmartScopes/SearchString", Fixture.create<SmartScopesUtilTester> (SmartScopesUtilTester.test_smart_scopes_search_string));
     Test.add_data_func ("/Unit/SmartScopes/OnChunkData", Fixture.create<SmartScopesUtilTester> (SmartScopesUtilTester.test_smart_scopes_on_chunk_data));
     Test.add_data_func ("/Unit/SmartScopes/Metrics", Fixture.create<SmartScopesUtilTester> (SmartScopesUtilTester.test_smart_scopes_metrics));
@@ -702,6 +703,33 @@
       catch (SmartScopes.ParseError e) { got_excp = true; }
     }
 
+    internal void test_smart_scopes_parse_missing_optional_fields ()
+    {
+      int row_count = 0;
+      var search_handler = new SmartScopes.SearchResponseHandler ();
+
+      // missing or null 'images' in the metadata
+      search_handler.parse_results_line ("""{"info": {"searchin-scope.scope": [{"title": "search in foursquare...", "icon_hint": "file:///usr/share/icons/unity-icon-theme/places/svg/group-info.svg", "uri": "scopes-query://foursquare:drink", "metadata": {"images":null}}, {"title": "search in recipepuppy...", "icon_hint": "file:///usr/share/icons/unity-icon-theme/places/svg/group-recipes.svg", "uri": "scopes-query://recipepuppy:drink", "metadata": {}}, {"title": "search in grooveshark...", "icon_hint": "file:///usr/share/icons/unity-icon-theme/places/svg/service-grooveshark.svg", "uri": "scopes-query://grooveshark:drink", "metadata": {}}, {"title": "search in ebay...", "icon_hint": "file:///usr/share/icons/unity-icon-theme/places/svg/service-ebay.svg", "uri": "scopes-query://ebay:drink", "metadata": {}}, {"title": "search in songkick...", "icon_hint": "file:///usr/share/icons/unity-icon-theme/places/svg/group-music.svg", "uri": "scopes-query://songkick:drink", "metadata": {}}]}, "type": "results"}""",
+            (scope_id, row) => {
+              assert (scope_id == "searchin-scope.scope");
+              if (row_count == 0) {
+                  assert (row[0].get_string () == "x-unity-no-preview-scopes-query://foursquare:drink"); // uri
+                  assert (row[1].get_string () == "file:///usr/share/icons/unity-icon-theme/places/svg/group-info.svg"); // icon hint
+                  assert (row[2].get_uint32 () == 0); // category
+                  assert (row[3].get_uint32 () == Unity.ResultType.DEFAULT); // result type
+                  assert (row[4].get_string () == "text/html"); // mimetype
+                  assert (row[5].get_string () == "search in foursquare..."); // title
+                  assert (row[6].get_string () == ""); // comment
+                  assert (row[7].get_string () == "x-unity-no-preview-scopes-query://foursquare:drink"); // dnd uri
+                  assert (row[8].is_of_type (new VariantType ("a{sv}")) && row[8].n_children () == 0); // metadata
+              }
+              row_count++;
+            },
+            (recommend) => { assert_not_reached (); });
+
+      assert (row_count == 5);
+    }
+
     const string SERVER_URI = "https://foobar.ubuntu.com";
     const string SEARCH_URI_PREFIX = SERVER_URI + "/smartscopes/v1/search";