Merge lp:~dreamhosters/txaws/921352-get-bucket-versioning-method into lp:txaws

[Arsene Rei]

Add GET Bucket versioning functionality

[Duncan McGreggor (oubiwann)]

[1] So, I was going to suggest not to use modeling for this one, since it's so simple... but it seems that Amazon has defined another element that needs to be added to the module: MfaDelete (self.mfa_delete is the attribute name I'd use).

I was going to suggest that you should only set the mfa_delete attr if root.findtext("MfaDelete") returned a value... but that would make working with this particular model more cumbersome. So:
 * mfa_delete = "Disabled" means the bucket has been configured with MfaDelete and it's disabled
 * mfa_delete = "Enabled" means the bucket has been configured with MfaDelete and it's enabled
 * mfa_delete = None means the bucket has not been configured with MfaDelete

That should probably go in the model's docstring ;-)

[2] For this, you'll want to add another payload example with "<MfaDelete>Enabled</MfaDelete>" in it. There's no need to also include an example Disabled in it, since no different/additional logic in the Python code is being exercised with that.

review: Needs Fixing

[lp:~dreamhosters/txaws/921352-get-bucket-versioning-method]

138. By Arsene Rei on 2012-01-28

remove test_get_bucket_versioning_config_suspended

As oubiwann pointed out, no additional logic in Python code is being exercised.

139. By Arsene Rei on 2012-01-28

add mfa_delete argument to VersioningConfiguration

* add corresponding test

140. By Arsene Rei on 2012-01-28

make pep8 fix

141. By Arsene Rei on 2012-01-28

update test docstring

[Duncan McGreggor (oubiwann)]

Looks good! +1

review: Approve

=== modified file 'txaws/s3/client.py'
--- txaws/s3/client.py	2012-01-27 19:54:27 +0000
+++ txaws/s3/client.py	2012-01-28 00:47:23 +0000
@@ -23,7 +23,7 @@
 from txaws.s3.model import (
     Bucket, BucketItem, BucketListing, ItemOwner, LifecycleConfiguration,
     LifecycleConfigurationRule, NotificationConfiguration, RequestPayment,
-    WebsiteConfiguration)
+    VersioningConfiguration, WebsiteConfiguration)
 from txaws.s3.exception import S3Error
 from txaws.service import AWSServiceEndpoint, S3_ENDPOINT
 from txaws.util import XML, calculate_md5
@@ -253,6 +253,26 @@
 
         return NotificationConfiguration(topic, event)
 
+    def get_bucket_versioning_config(self, bucket):
+        """
+        Get the versioning configuration of a bucket.
+
+        @param bucket: The name of the bucket.  @return: A C{Deferred} that
+        will request the bucket's versioning configuration.
+        """
+        query = self.query_factory(
+            action='GET', creds=self.creds, endpoint=self.endpoint,
+            bucket=bucket, object_name='?versioning')
+        return query.submit().addCallback(self._parse_versioning_config)
+
+    def _parse_versioning_config(self, xml_bytes):
+        """Parse a C{VersioningConfiguration} XML document."""
+        root = XML(xml_bytes)
+        mfa_delete = root.findtext("MfaDelete")
+        status = root.findtext("Status")
+
+        return VersioningConfiguration(mfa_delete=mfa_delete, status=status)
+
     def get_bucket_acl(self, bucket):
         """
         Get the access control policy for a bucket.

=== modified file 'txaws/s3/model.py'
--- txaws/s3/model.py	2012-01-27 19:47:22 +0000
+++ txaws/s3/model.py	2012-01-28 00:47:23 +0000
@@ -90,6 +90,25 @@
         self.event = event
 
 
+class VersioningConfiguration(object):
+    """
+    Container for the bucket versioning configuration.
+
+    According to Amazon:
+
+    C{MfaDelete}: This element is only returned if the bucket has been
+    configured with C{MfaDelete}. If the bucket has never been so configured,
+    this element is not returned. The possible values are None, "Disabled" or
+    "Enabled".
+
+    C{Status}: If the bucket has never been so configured, this element is not
+    returned. The possible values are None, "Suspended" or "Enabled".
+    """
+    def __init__(self, mfa_delete=None, status=None):
+        self.mfa_delete = mfa_delete
+        self.status = status
+
+
 class FileChunk(object):
     """
     An Amazon S3 file chunk.

=== modified file 'txaws/s3/tests/test_client.py'
--- txaws/s3/tests/test_client.py	2012-01-27 20:44:11 +0000
+++ txaws/s3/tests/test_client.py	2012-01-28 00:47:23 +0000
@@ -462,6 +462,116 @@
         d = s3.get_bucket_notification_config("mybucket")
         return d.addCallback(check_results)
 
+    def test_get_bucket_versioning_config(self):
+        """
+        L{S3Client.get_bucket_versioning_configuration} creates a L{Query} to
+        get a bucket's versioning status.  It parses the returned
+        C{VersioningConfiguration} XML document and returns a C{Deferred} that
+        requests the bucket's versioning configuration.
+        """
+
+        class StubQuery(client.Query):
+
+            def __init__(query, action, creds, endpoint, bucket=None,
+                         object_name=None):
+                super(StubQuery, query).__init__(action=action, creds=creds,
+                                                 bucket=bucket,
+                                                 object_name=object_name)
+                self.assertEquals(action, "GET")
+                self.assertEqual(creds.access_key, "foo")
+                self.assertEqual(creds.secret_key, "bar")
+                self.assertEqual(query.bucket, "mybucket")
+                self.assertEqual(query.object_name, "?versioning")
+                self.assertEqual(query.data, "")
+                self.assertEqual(query.metadata, {})
+                self.assertEqual(query.amz_headers, {})
+
+            def submit(query, url_context=None):
+                return succeed(payload.sample_s3_get_bucket_versioning_result)
+
+        def check_results(versioning_config):
+            self.assertEquals(versioning_config.status, None)
+
+        creds = AWSCredentials("foo", "bar")
+        s3 = client.S3Client(creds, query_factory=StubQuery)
+        d = s3.get_bucket_versioning_config("mybucket")
+        return d.addCallback(check_results)
+
+    def test_get_bucket_versioning_config_enabled(self):
+        """
+        L{S3Client.get_bucket_versioning_config} creates a L{Query} to get a
+        bucket's versioning configuration.  It parses the returned
+        C{VersioningConfiguration} XML document and returns a C{Deferred} that
+        requests the bucket's versioning configuration that has a enabled
+        C{Status}.
+        """
+
+        class StubQuery(client.Query):
+
+            def __init__(query, action, creds, endpoint, bucket=None,
+                         object_name=None):
+                super(StubQuery, query).__init__(action=action, creds=creds,
+                                                 bucket=bucket,
+                                                 object_name=object_name)
+                self.assertEquals(action, "GET")
+                self.assertEqual(creds.access_key, "foo")
+                self.assertEqual(creds.secret_key, "bar")
+                self.assertEqual(query.bucket, "mybucket")
+                self.assertEqual(query.object_name, "?versioning")
+                self.assertEqual(query.data, "")
+                self.assertEqual(query.metadata, {})
+                self.assertEqual(query.amz_headers, {})
+
+            def submit(query, url_context=None):
+                return succeed(payload.
+                               sample_s3_get_bucket_versioning_enabled_result)
+
+        def check_results(versioning_config):
+            self.assertEquals(versioning_config.status, 'Enabled')
+
+        creds = AWSCredentials("foo", "bar")
+        s3 = client.S3Client(creds, query_factory=StubQuery)
+        d = s3.get_bucket_versioning_config("mybucket")
+        return d.addCallback(check_results)
+
+    def test_get_bucket_versioning_config_mfa_disabled(self):
+        """
+        L{S3Client.get_bucket_versioning_config} creates a L{Query} to get a
+        bucket's versioning configuration.  It parses the returned
+        C{VersioningConfiguration} XML document and returns a C{Deferred} that
+        requests the bucket's versioning configuration that has a disabled
+        C{MfaDelete}.
+        """
+
+        class StubQuery(client.Query):
+
+            def __init__(query, action, creds, endpoint, bucket=None,
+                         object_name=None):
+                super(StubQuery, query).__init__(action=action, creds=creds,
+                                                 bucket=bucket,
+                                                 object_name=object_name)
+                self.assertEquals(action, "GET")
+                self.assertEqual(creds.access_key, "foo")
+                self.assertEqual(creds.secret_key, "bar")
+                self.assertEqual(query.bucket, "mybucket")
+                self.assertEqual(query.object_name, "?versioning")
+                self.assertEqual(query.data, "")
+                self.assertEqual(query.metadata, {})
+                self.assertEqual(query.amz_headers, {})
+
+            def submit(query, url_context=None):
+                return succeed(
+                    payload.
+                        sample_s3_get_bucket_versioning_mfa_disabled_result)
+
+        def check_results(versioning_config):
+            self.assertEquals(versioning_config.mfa_delete, 'Disabled')
+
+        creds = AWSCredentials("foo", "bar")
+        s3 = client.S3Client(creds, query_factory=StubQuery)
+        d = s3.get_bucket_versioning_config("mybucket")
+        return d.addCallback(check_results)
+
     def test_delete_bucket(self):
 
         class StubQuery(client.Query):

=== modified file 'txaws/testing/payload.py'
--- txaws/testing/payload.py	2012-01-27 20:08:20 +0000
+++ txaws/testing/payload.py	2012-01-28 00:47:23 +0000
@@ -1071,3 +1071,17 @@
        <Event>s3:ReducedRedundancyLostObject</Event>
    </TopicConfiguration>
 </NotificationConfiguration>"""
+
+sample_s3_get_bucket_versioning_result = """\
+<VersioningConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"/>"""
+
+sample_s3_get_bucket_versioning_enabled_result = """\
+<VersioningConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
+  <Status>Enabled</Status>
+</VersioningConfiguration>"""
+
+sample_s3_get_bucket_versioning_mfa_disabled_result = """\
+<VersioningConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
+  <Status>Enabled</Status>
+  <MfaDelete>Disabled</MfaDelete>
+</VersioningConfiguration>"""