Add headers parameter to CreateContainer (fixes #167); add TestVersionedContainer

Author: sharwell

src/corelib/Core/Providers/IObjectStorageProvider.cs

@@ -48,6 +48,7 @@ public interface IObjectStorageProvider
         /// Creates a container if it does not already exist.
         /// </summary>
         /// <param name="container">The container name.</param>
+        /// <param name="headers">A collection of custom HTTP headers to associate with the container (see <see cref="GetContainerHeader"/>).</param>
         /// <param name="region">The region in which to execute this action. If not specified, the user's default region will be used.</param>
         /// <param name="useInternalUrl"><c>true</c> to use the endpoint's <see cref="Endpoint.InternalURL"/>; otherwise <c>false</c> to use the endpoint's <see cref="Endpoint.PublicURL"/>.</param>
         /// <param name="identity">The cloud identity to use for this request. If not specified, the default identity for the current provider instance will be used.</param>
@@ -60,7 +61,11 @@ public interface IObjectStorageProvider
         /// </list>
         /// </returns>
         /// <exception cref="ArgumentNullException">If <paramref name="container"/> is <c>null</c>.</exception>
-        /// <exception cref="ArgumentException">If <paramref name="container"/> is empty.</exception>
+        /// <exception cref="ArgumentException">
+        /// If <paramref name="container"/> is empty.
+        /// <para>-or-</para>
+        /// <para>If <paramref name="headers"/> contains two equivalent keys when compared using <see cref="StringComparer.OrdinalIgnoreCase"/>.</para>
+        /// </exception>
         /// <exception cref="ContainerNameException">If <paramref name="container"/> is not a valid container name.</exception>
         /// <exception cref="NotSupportedException">
         /// If the provider does not support the given <paramref name="identity"/> type.
@@ -76,7 +81,7 @@ public interface IObjectStorageProvider
         /// </exception>
         /// <exception cref="ResponseException">If the REST API request failed.</exception>
         /// <seealso href="http://docs.openstack.org/api/openstack-object-storage/1.0/content/create-container.html">Create Container (OpenStack Object Storage API v1 Reference)</seealso>
-        ObjectStore CreateContainer(string container, string region = null, bool useInternalUrl = false, CloudIdentity identity = null);
+        ObjectStore CreateContainer(string container, Dictionary<string, string> headers = null, string region = null, bool useInternalUrl = false, CloudIdentity identity = null);
 
         /// <summary>
         /// Deletes a container, and optionally all objects stored in the container.

src/corelib/Providers/Rackspace/CloudFilesProvider.cs

@@ -234,11 +234,10 @@ public IEnumerable<Container> ListContainers(int? limit = null, string marker =
                 return null;
 
             return response.Data;
-
         }
 
         /// <inheritdoc />
-        public ObjectStore CreateContainer(string container, string region = null, bool useInternalUrl = false, CloudIdentity identity = null)
+        public ObjectStore CreateContainer(string container, Dictionary<string, string> headers = null, string region = null, bool useInternalUrl = false, CloudIdentity identity = null)
         {
             if (container == null)
                 throw new ArgumentNullException("container");
@@ -249,7 +248,7 @@ public ObjectStore CreateContainer(string container, string region = null, bool
             _cloudFilesValidator.ValidateContainerName(container);
             var urlPath = new Uri(string.Format("{0}/{1}", GetServiceEndpointCloudFiles(identity, region, useInternalUrl), _encodeDecodeProvider.UrlEncode(container)));
 
-            var response = ExecuteRESTRequest(identity, urlPath, HttpMethod.PUT);
+            var response = ExecuteRESTRequest(identity, urlPath, HttpMethod.PUT, headers: headers);
 
             switch (response.StatusCode)
             {

src/testing/integration/Providers/Rackspace/UserObjectStorageTests.cs

@@ -247,6 +247,76 @@ public void TestCreateContainer()
             provider.DeleteContainer(containerName, deleteObjects: true);
         }
 
+        [TestMethod]
+        [TestCategory(TestCategories.User)]
+        [TestCategory(TestCategories.ObjectStorage)]
+        public void TestVersionedContainer()
+        {
+            IObjectStorageProvider provider = new CloudFilesProvider(Bootstrapper.Settings.TestIdentity);
+            string containerName = TestContainerPrefix + Path.GetRandomFileName();
+            string versionsContainerName = TestContainerPrefix + Path.GetRandomFileName();
+
+            ObjectStore result = provider.CreateContainer(versionsContainerName);
+            Assert.AreEqual(ObjectStore.ContainerCreated, result);
+
+            result = provider.CreateContainer(containerName, new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase) { { CloudFilesProvider.VersionsLocation, versionsContainerName } });
+            Assert.AreEqual(ObjectStore.ContainerCreated, result);
+
+            Dictionary<string, string> headers = provider.GetContainerHeader(containerName);
+            string location;
+            Assert.IsTrue(headers.TryGetValue(CloudFilesProvider.VersionsLocation, out location));
+            Assert.AreEqual(versionsContainerName, location);
+
+            string objectName = Path.GetRandomFileName();
+            string fileData1 = "first-content";
+            string fileData2 = "second-content";
+
+            using (MemoryStream uploadStream = new MemoryStream(Encoding.UTF8.GetBytes(fileData1)))
+            {
+                provider.CreateObject(containerName, uploadStream, objectName);
+            }
+
+            using (MemoryStream downloadStream = new MemoryStream())
+            {
+                provider.GetObject(containerName, objectName, downloadStream);
+
+                downloadStream.Position = 0;
+                StreamReader reader = new StreamReader(downloadStream, Encoding.UTF8);
+                string actualData = reader.ReadToEnd();
+                Assert.AreEqual(fileData1, actualData);
+            }
+
+            using (MemoryStream uploadStream = new MemoryStream(Encoding.UTF8.GetBytes(fileData2)))
+            {
+                provider.CreateObject(containerName, uploadStream, objectName);
+            }
+
+            using (MemoryStream downloadStream = new MemoryStream())
+            {
+                provider.GetObject(containerName, objectName, downloadStream);
+
+                downloadStream.Position = 0;
+                StreamReader reader = new StreamReader(downloadStream, Encoding.UTF8);
+                string actualData = reader.ReadToEnd();
+                Assert.AreEqual(fileData2, actualData);
+            }
+
+            provider.DeleteObject(containerName, objectName);
+
+            using (MemoryStream downloadStream = new MemoryStream())
+            {
+                provider.GetObject(containerName, objectName, downloadStream);
+
+                downloadStream.Position = 0;
+                StreamReader reader = new StreamReader(downloadStream, Encoding.UTF8);
+                string actualData = reader.ReadToEnd();
+                Assert.AreEqual(fileData1, actualData);
+            }
+
+            provider.DeleteContainer(versionsContainerName, deleteObjects: true);
+            provider.DeleteContainer(containerName, deleteObjects: true);
+        }
+
         [TestMethod]
         [TestCategory(TestCategories.User)]
         [TestCategory(TestCategories.ObjectStorage)]