Merge lp:~rharding/charmworld/bundle-metadata3 into lp:~juju-jitsu/charmworld/trunk

[Richard Harding]

Update the search & interesting calls to include the bundle file/charm_metadata.

Brings up to match the bundle details call.

Update the search and interesting calls to include the bundle file/charm_metadata added to the details call.

- Added a path in the item_results to call a _bundle_result just as it does for _charm_result.
- _bundle_result does the work sharing the methods to find the list of files and the charm details for the bundle before adding to the result list.
- Drive by fixing a bug where the series was pulled from the wrong place in the bundle json. Made sure a functional test in the search results verified that the name/series combo works for finding charms that are promulgated.
- Only added tests to search since they share the same code paths and the interesting already has tests that bundles go through the interesting call.

QA:

Perform a search for wiki and verify that the bundle results have the two added fields of metadata.

http://charmworld:2464/api/3/search/?text=wiki

[lp:~rharding/charmworld/bundle-metadata3]

417. By Richard Harding on 2013-10-07

Sync with trunk

[Benji York (benji)]

The branch looks good.

The _bundle_result class method could use a docstring (and perhaps a different name, but I can't think of an improvement right now). Also, how about "bundle_metadata" instead of "bundle_built"?

review: Approve

[lp:~rharding/charmworld/bundle-metadata3]

418. By Richard Harding on 2013-10-07

Update per review

[Juju Gui Bot (juju-gui-bot)]

review: Approve (continuous-integration)

=== modified file 'charmworld/views/api.py'
--- charmworld/views/api.py	2013-10-07 12:10:22 +0000
+++ charmworld/views/api.py	2013-10-07 19:56:38 +0000
@@ -182,6 +182,18 @@
             }
         }
 
+    @classmethod
+    def _bundle_result(cls, bundle, db):
+        """Build standard metadata around a bundle search result."""
+        bundle_obj = Bundle(bundle)
+        bundle_metadata = cls._build_bundle_metadata(bundle_obj, db)
+        return {
+            'bundle': bundle_metadata,
+            'metadata': {
+                'doctype': BUNDLE,
+            }
+        }
+
     def _related_charms(self, charm_data):
         charm = Charm(charm_data)
         charms_provide = set(charm.i_provides)
@@ -428,21 +440,23 @@
                 query, sort=[('store_data.revision', pymongo.DESCENDING)])
         return charm_id, trailing, charm
 
-    def _build_bundle_metadata(self, bundle, db):
+    @classmethod
+    def _build_bundle_metadata(cls, bundle, db):
         bundle_dict = dict(bundle)
         # Add the list of files in the bundle.
         bundle_dict['files'] = bundle.get_file_list(db)
         bundle_dict['charm_metadata'] = {}
+        service_data = bundle_dict.get('data')
         # Now load the charm information we require for the services in the
         # bundle.
         for service, data in bundle.data['services'].iteritems():
             charm = resolve_charm_from_bundle_info(
                 db,
                 data,
-                bundle_dict.get('series')
+                service_data.get('series')
             )
             if charm:
-                formatted = self._format_charm(Charm(charm))
+                formatted = cls._format_charm(Charm(charm))
                 bundle_dict['charm_metadata'][service] = formatted
 
         return bundle_dict
@@ -656,12 +670,9 @@
         results = []
         for item in items:
             if item['doctype'] == BUNDLE:
-                result = {
-                    'bundle': Bundle(item['data'])._representation,
-                    'metadata': {
-                        'doctype': BUNDLE,
-                    }
-                }
+                result = self._bundle_result(
+                    Bundle(item['data'])._representation,
+                    self.request.db)
             else:
                 result = self._charm_result(Charm(item['data']))
             results.append(result)

=== modified file 'charmworld/views/tests/test_api.py'
--- charmworld/views/tests/test_api.py	2013-10-07 14:23:34 +0000
+++ charmworld/views/tests/test_api.py	2013-10-07 19:56:38 +0000
@@ -1528,10 +1528,39 @@
         found_bundle = result[0]
         self.assertEqual(BUNDLE, found_bundle['metadata']['doctype'])
         self.assertEqual(bundle.name, found_bundle['bundle']['name'])
+        # Bundles have been adjusted to include filenames
+        self.assertEqual([], found_bundle['bundle']['files'])
+        # Bundles also include charm metadata
+        self.assertEqual({}, found_bundle['bundle']['charm_metadata'])
+
         found_charm = result[1]
         self.assertEqual(CHARM, found_charm['metadata']['doctype'])
         self.assertEqual(charm['store_url'], found_charm['charm']['url'])
 
+    def test_search_result_bundles_includes_metadata(self):
+        self.use_index_client()
+        _id, charm = factory.makeCharm(self.db, promulgated=True)
+        services = {
+            u'charm': {
+                u'charm': charm['name']
+            }
+        }
+        bundle = self.make_indexed_bundle(
+            series=charm['series'],
+            services=services,
+            with_basket=True)
+
+        factory.make_bundle_file(self.db, bundle, u'README', 'Test Content')
+        result = self.get_response(self.search_endpoint).json_body['result']
+        self.assertEqual(1, len(result))
+        found_bundle = result[0]['bundle']
+        self.assertEqual(['README'], found_bundle['files'])
+        self.assertTrue(found_bundle['charm_metadata']['charm'])
+        self.assertEqual(
+            charm['name'],
+            found_bundle['charm_metadata']['charm']['name']
+        )
+
     def test_charm_wrong_revision(self):
         """Retrieving a charm does not work if the revision is wrong."""
         self.use_index_client()