Merge lp:~alecu/ubuntu-sso-client/changed-secrets-spec into lp:ubuntu-sso-client

[Alejandro J. Cura]

Content_type field was added to the Secret DBus struct. (LP: #745540)

Content_type field was added to the Secret DBus struct. (LP: #745540)

[Alejandro J. Cura (alecu)]

To field test this branch, you should install the gnome-keyring from gnome3 ppa.

[Natalia Bidart (nataliabidart)]

Code looks good, current keyring secret dbus service still works as expected.

review: Approve

[Shane Fagan (shanepatrickfagan)]

looks good to me for code review

review: Approve

=== modified file 'ubuntu_sso/utils/tests/test_txsecrets.py'
--- ubuntu_sso/utils/tests/test_txsecrets.py	2011-04-12 14:16:56 +0000
+++ ubuntu_sso/utils/tests/test_txsecrets.py	2011-04-15 20:07:58 +0000
@@ -96,18 +96,6 @@
         return True
 
 
-class AltItemMock(ItemMock):
-    """The secret in this item has a content_type."""
-
-    @dbus.service.method(dbus_interface=txsecrets.ITEM_IFACE,
-                         in_signature="o", out_signature="(oayays)")
-    def GetSecret(self, session):
-        """Retrieve the secret for this item."""
-        if self.get_secret_fail:
-            raise SampleMiscException()
-        return (session, "", self.value, SAMPLE_CONTENT_TYPE)
-
-
 class PromptMock(dbus.service.Object):
     """A prompt necessary to complete an operation."""
 
@@ -130,8 +118,8 @@
         """The prompt and operation completed."""
 
 
-class CollectionMock(dbus.service.Object):
-    """A collection of items containing secrets."""
+class BaseCollectionMock(dbus.service.Object):
+    """Base collection of items containing secrets."""
     SUPPORTS_MULTIPLE_OBJECT_PATHS = True
     SUPPORTS_MULTIPLE_CONNECTIONS = True
     create_item_prompt = False
@@ -143,14 +131,11 @@
 
     def __init__(self, label, *args, **kwargs):
         """Initialize this instance."""
-        super(CollectionMock, self).__init__(*args, **kwargs)
+        super(BaseCollectionMock, self).__init__(*args, **kwargs)
         self.items = []
         self.label = label
 
-    @dbus.service.method(dbus_interface=txsecrets.COLLECTION_IFACE,
-                         in_signature="a{sv}(oayay)b", out_signature="oo",
-                         byte_arrays=True)
-    def CreateItem(self, properties, secret, replace):
+    def _create_item(self, properties, secret, replace):
         """Create an item with the given attributes, secret and label.
 
         If replace is set, then it replaces an item already present with the
@@ -162,7 +147,7 @@
             raise SampleMiscException(ERROR_CREATE_BUT_LOCKED)
         attributes = properties[txsecrets.ATTRIBUTES_PROPERTY]
         item_label = properties[txsecrets.LABEL_PROPERTY]
-        session, parameters, value = secret
+        value = secret[2]
         item_path = create_object_path(make_coll_path(self.label))
         item = self.dbus_publish(item_path, self.item_mock_class, self,
                                  item_label, attributes, value)
@@ -184,6 +169,18 @@
             return dbus.String(self.label)
 
 
+class CollectionMock(BaseCollectionMock):
+    """Collection of items containing secrets."""
+
+    @dbus.service.method(dbus_interface=txsecrets.COLLECTION_IFACE,
+                         in_signature="a{sv}(oayay)b", out_signature="oo",
+                         byte_arrays=True)
+    def CreateItem(self, properties, secret, replace):
+        """Expose the _create_item method on DBus."""
+        assert len(secret) == 3
+        return self._create_item(properties, secret, replace)
+
+
 class SessionMock(dbus.service.Object):
     """A session tracks state between the service and a client application."""
 
@@ -203,6 +200,7 @@
     create_collection_fail = False
     open_session_fail = False
     dismissed = False
+    collection_mock_class = CollectionMock
 
     def __init__(self, *args, **kwargs):
         """Initialize this instance."""
@@ -230,7 +228,8 @@
             raise SampleMiscException()
         label = str(properties[txsecrets.LABEL_PROPERTY])
         coll_path = make_coll_path(label)
-        collection = self.dbus_publish(coll_path, CollectionMock, label)
+        collection = self.dbus_publish(coll_path, self.collection_mock_class,
+                                       label)
         self.collections[label] = collection
 
         if self.create_collection_prompt:
@@ -319,6 +318,38 @@
             return dbus.Array(coll_paths, signature="o", variant_level=1)
 
 
+class AltItemMock(ItemMock):
+    """The secret in this item has a content_type."""
+
+    @dbus.service.method(dbus_interface=txsecrets.ITEM_IFACE,
+                         in_signature="o", out_signature="(oayays)")
+    def GetSecret2(self, session):
+        """Retrieve the secret for this item."""
+        if self.get_secret_fail:
+            raise SampleMiscException()
+        return (session, "", self.value, SAMPLE_CONTENT_TYPE)
+
+
+class AltCollectionMock(BaseCollectionMock):
+    """The secrets in this collection have a content_type field."""
+
+    item_mock_class = AltItemMock
+
+    @dbus.service.method(dbus_interface=txsecrets.COLLECTION_IFACE,
+                         in_signature="a{sv}(oayays)b", out_signature="oo",
+                         byte_arrays=True)
+    def CreateItem(self, properties, secret, replace):
+        """Expose the _create_item method on DBus."""
+        assert len(secret) == 4
+        return self._create_item(properties, secret, replace)
+
+
+class AltSecretServiceMock(SecretServiceMock):
+    """The secrets in this service have a content_type field."""
+
+    collection_mock_class = AltCollectionMock
+
+
 def create_object_path(base):
     """Create a random object path given a base path."""
     random = uuid.uuid4().hex
@@ -328,12 +359,13 @@
 class BaseTestCase(DBusTestCase):
     """Base class for DBus tests."""
     timeout = 10
+    secret_service_class = SecretServiceMock
 
     def setUp(self):
         super(BaseTestCase, self).setUp()
         self.session_bus = dbus.SessionBus()
         self.mock_service = self.dbus_publish(txsecrets.SECRETS_SERVICE,
-                                              SecretServiceMock)
+                                              self.secret_service_class)
         self.secretservice = txsecrets.SecretService()
 
     def dbus_publish(self, object_path, object_class, *args, **kwargs):
@@ -760,22 +792,6 @@
         self.assertEqual(value, sample_secret)
 
     @inlineCallbacks
-    def test_get_value_four_items_per_secret(self):
-        """The code works fine when the secret dbus struct has 4 items."""
-        yield self.secretservice.open_session()
-        collection_label = "sample_keyring"
-        coll = yield self.create_sample_collection(collection_label)
-        mock_coll = self.mock_service.collections[collection_label]
-        mock_coll.item_mock_class = AltItemMock
-        attr = {"key-type": "Ubuntu SSO credentials"}
-        sample_secret = "secret83!"
-        yield coll.create_item("Cucaracha", attr, sample_secret)
-        items = yield self.secretservice.search_items(attr)
-        self.assertEqual(len(items), 1)
-        value = yield items[0].get_value()
-        self.assertEqual(value, sample_secret)
-
-    @inlineCallbacks
     def test_get_value_throws_dbus_error(self):
         """The secret value is not retrieved if DBus fails."""
         yield self.secretservice.open_session()
@@ -853,3 +869,36 @@
         mock_item.delete_fail = True
         yield self.assertFailure(items[0].delete(),
                                  dbus.exceptions.DBusException)
+
+
+class AltItemTestCase(BaseTestCase):
+    """Test the Item class with 4 fields in the secret struct."""
+    secret_service_class = AltSecretServiceMock
+
+    @inlineCallbacks
+    def test_create_item_four_fields_per_secret(self):
+        """The collection creates an item when the dbus struct has 4 fields."""
+        yield self.secretservice.open_session()
+        collection_label = "sample_keyring"
+        yield self.create_sample_collection(collection_label)
+        coll = yield self.secretservice.get_default_collection()
+        mock_collection = self.mock_service.collections[collection_label]
+        attr = {"key-type": "Ubuntu 242 credentials"}
+        sample_secret = "secret!"
+        yield coll.create_item("Cucaracha", attr, sample_secret)
+        self.assertEqual(len(mock_collection.items), 1)
+        self.assertEqual(mock_collection.items[0].value, sample_secret)
+
+    @inlineCallbacks
+    def test_get_value_four_fields_per_secret(self):
+        """The code works fine when the secret dbus struct has 4 fields."""
+        yield self.secretservice.open_session()
+        collection_label = "sample_keyring"
+        coll = yield self.create_sample_collection(collection_label)
+        attr = {"key-type": "Ubuntu SSO credentials"}
+        sample_secret = "secret83!"
+        yield coll.create_item("Cucaracha", attr, sample_secret)
+        items = yield self.secretservice.search_items(attr)
+        self.assertEqual(len(items), 1)
+        value = yield items[0].get_value()
+        self.assertEqual(value, sample_secret)

=== modified file 'ubuntu_sso/utils/txsecrets.py'
--- ubuntu_sso/utils/txsecrets.py	2011-04-12 14:16:56 +0000
+++ ubuntu_sso/utils/txsecrets.py	2011-04-15 20:07:58 +0000
@@ -41,6 +41,7 @@
 SECRETS_SERVICE = "/org/freedesktop/secrets"
 DEFAULT_COLLECTION = "/org/freedesktop/secrets/aliases/default"
 SESSION_COLLECTION = "/org/freedesktop/secrets/collection/session"
+SECRET_CONTENT_TYPE = "application/octet-stream"
 
 ALGORITHM = "plain"
 ALGORITHM_PARAMS = ""
@@ -257,7 +258,8 @@
         """Initialize a new collection."""
         self.service = service
         self.object_path = object_path
-        collection_object = service.bus.get_object(BUS_NAME, object_path)
+        collection_object = service.bus.get_object(BUS_NAME, object_path,
+                                                   introspect=False)
         self.collection_iface = dbus.Interface(collection_object,
                                                dbus_interface=COLLECTION_IFACE)
         self.properties = dbus.Interface(collection_object,
@@ -285,16 +287,24 @@
             else:
                 d.callback(item)
 
+        def createitem_error(error):
+            """An error creating the item, try older signature."""
+            secret = (self.service.session, parameters, value_bytes)
+            self.collection_iface.CreateItem(properties, secret, replace,
+                                             reply_handler=createitem_handler,
+                                             error_handler=d.errback)
+
         properties = dbus.Dictionary(signature="sv")
         properties[LABEL_PROPERTY] = label
         attributes = dbus.Dictionary(attr, signature="ss")
         properties[ATTRIBUTES_PROPERTY] = attributes
         parameters = dbus.ByteArray(ALGORITHM_PARAMS)
         value_bytes = dbus.ByteArray(value)
-        secret = (self.service.session, parameters, value_bytes)
+        secret = (self.service.session, parameters, value_bytes,
+                  SECRET_CONTENT_TYPE)
         self.collection_iface.CreateItem(properties, secret, replace,
                                          reply_handler=createitem_handler,
-                                         error_handler=d.errback)
+                                         error_handler=createitem_error)
         return d