Merge "Add find() method to CrudManager"

keystoneclient/base.py

@@ -271,6 +271,28 @@ class CrudManager(Manager):
         return self._delete(
             self.build_url(**kwargs))
 
+    def find(self, base_url=None, **kwargs):
+        """
+        Find a single item with attributes matching ``**kwargs``.
+        """
+        kwargs = self._filter_kwargs(kwargs)
+
+        rl = self._list(
+            '%(base_url)s%(query)s' % {
+                'base_url': self.build_url(base_url=base_url, **kwargs),
+                'query': '?%s' % urllib.urlencode(kwargs) if kwargs else '',
+            },
+            self.collection_key)
+        num = len(rl)
+
+        if num == 0:
+            msg = "No %s matching %s." % (self.resource_class.__name__, kwargs)
+            raise exceptions.NotFound(404, msg)
+        elif num > 1:
+            raise exceptions.NoUniqueMatch
+        else:
+            return rl[0]
+
 
 class Resource(object):
     """

tests/v3/utils.py

@@ -195,6 +195,34 @@ class CrudTests(testtools.TestCase):
         self.assertTrue(len(returned_list))
         [self.assertTrue(isinstance(r, self.model)) for r in returned_list]
 
+    def test_find(self, ref=None):
+        ref = ref or self.new_ref()
+        ref_list = [ref]
+        resp = TestResponse({
+            "status_code": 200,
+            "text": self.serialize(ref_list),
+        })
+
+        method = 'GET'
+        kwargs = copy.copy(self.TEST_REQUEST_BASE)
+        kwargs['headers'] = self.headers[method]
+        query = '?name=%s' % ref['name'] if hasattr(ref, 'name') else ''
+        requests.request(
+            method,
+            urlparse.urljoin(
+                self.TEST_URL,
+                'v3/%s%s' % (self.collection_key, query)),
+            **kwargs).AndReturn((resp))
+        self.mox.ReplayAll()
+
+        returned = self.manager.find(name=getattr(ref, 'name', None))
+        self.assertTrue(isinstance(returned, self.model))
+        for attr in ref:
+            self.assertEqual(
+                getattr(returned, attr),
+                ref[attr],
+                'Expected different %s' % attr)
+
     def test_update(self, ref=None):
         ref = ref or self.new_ref()
         req_ref = ref.copy()