Adding CreateIfNotExistsAsync to container builder (#592)

* Adding CreateIfNotExistsAsync to container builder * Updating changelog * Updating contract change
Azure · Jul 24, 2019 · a88e516 · a88e516
1 parent ab3bce0
commit a88e516
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 19 deletions.
diff --git a/Microsoft.Azure.Cosmos/src/Fluent/Settings/ContainerBuilder.cs b/Microsoft.Azure.Cosmos/src/Fluent/Settings/ContainerBuilder.cs
@@ -74,6 +74,21 @@ public async Task<ContainerResponse> CreateAsync(int? throughput = null)
             return await this.database.CreateContainerAsync(containerProperties, throughput);
         }
 
+        /// <summary>
+        /// Creates a container if it does not exist with the current fluent definition.
+        /// </summary>
+        /// <param name="throughput">Desired throughput for the container expressed in Request Units per second.</param>
+        /// <returns>An asynchronous Task representing the creation of a <see cref="Container"/> based on the Fluent definition.</returns>
+        /// <remarks>
+        /// <seealso href="https://docs.microsoft.com/azure/cosmos-db/request-units"/> for details on provision throughput.
+        /// </remarks>
+        public async Task<ContainerResponse> CreateIfNotExistsAsync(int? throughput = null)
+        {
+            ContainerProperties containerProperties = this.Build();
+
+            return await this.database.CreateContainerIfNotExistsAsync(containerProperties, throughput);
+        }
+
         /// <summary>
         /// Applies the current Fluent definition and creates a container configuration.
         /// </summary>

diff --git a/Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.EmulatorTests/CosmosContainerTests.cs b/Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.EmulatorTests/CosmosContainerTests.cs
@@ -50,28 +50,20 @@ public async Task TestCleanup()
         public async Task ContainerContractTest()
         {
             ContainerResponse response = await this.cosmosDatabase.CreateContainerAsync(new Guid().ToString(), "/id");
-            Assert.IsNotNull(response);
-            Assert.IsTrue(response.RequestCharge > 0);
-            Assert.IsNotNull(response.Headers);
-            Assert.IsNotNull(response.Headers.ActivityId);
-
-            ContainerProperties containerSettings = response.Resource;
-            Assert.IsNotNull(containerSettings.Id);
-            Assert.IsNotNull(containerSettings.ResourceId);
-            Assert.IsNotNull(containerSettings.ETag);
-            Assert.IsTrue(containerSettings.LastModified.HasValue);
+            ValidateCreateContainerResponseContract(response);
+        }
 
-            Assert.IsNotNull(containerSettings.PartitionKeyPath);
-            Assert.IsNotNull(containerSettings.PartitionKeyPathTokens);
-            Assert.AreEqual(1, containerSettings.PartitionKeyPathTokens.Length);
-            Assert.AreEqual("id", containerSettings.PartitionKeyPathTokens[0]);
+        [TestMethod]
+        public async Task ContainerBuilderContractTest()
+        {
+            ContainerResponse response = await this.cosmosDatabase.DefineContainer(new Guid().ToString(), "/id").CreateAsync();
+            ValidateCreateContainerResponseContract(response);
 
-            ContainerCore containerCore = response.Container as ContainerCore;
-            Assert.IsNotNull(containerCore);
-            Assert.IsNotNull(containerCore.LinkUri);
-            Assert.IsFalse(containerCore.LinkUri.ToString().StartsWith("/"));
+            response = await this.cosmosDatabase.DefineContainer(new Guid().ToString(), "/id").CreateIfNotExistsAsync();
+            ValidateCreateContainerResponseContract(response);
 
-            Assert.IsTrue(containerSettings.LastModified.Value > new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc), containerSettings.LastModified.Value.ToString());
+            response = await this.cosmosDatabase.DefineContainer(response.Container.Id, "/id").CreateIfNotExistsAsync();
+            ValidateCreateContainerResponseContract(response);
         }
 
         [Ignore]
@@ -577,5 +569,31 @@ public async Task TimeToLivePropertyPath()
             containerResponse = await container.DeleteContainerAsync();
             Assert.AreEqual(HttpStatusCode.NoContent, containerResponse.StatusCode);
         }
+
+        private void ValidateCreateContainerResponseContract(ContainerResponse containerResponse)
+        {
+            Assert.IsNotNull(containerResponse);
+            Assert.IsTrue(containerResponse.RequestCharge > 0);
+            Assert.IsNotNull(containerResponse.Headers);
+            Assert.IsNotNull(containerResponse.Headers.ActivityId);
+
+            ContainerProperties containerSettings = containerResponse.Resource;
+            Assert.IsNotNull(containerSettings.Id);
+            Assert.IsNotNull(containerSettings.ResourceId);
+            Assert.IsNotNull(containerSettings.ETag);
+            Assert.IsTrue(containerSettings.LastModified.HasValue);
+
+            Assert.IsNotNull(containerSettings.PartitionKeyPath);
+            Assert.IsNotNull(containerSettings.PartitionKeyPathTokens);
+            Assert.AreEqual(1, containerSettings.PartitionKeyPathTokens.Length);
+            Assert.AreEqual("id", containerSettings.PartitionKeyPathTokens[0]);
+
+            ContainerCore containerCore = containerResponse.Container as ContainerCore;
+            Assert.IsNotNull(containerCore);
+            Assert.IsNotNull(containerCore.LinkUri);
+            Assert.IsFalse(containerCore.LinkUri.ToString().StartsWith("/"));
+
+            Assert.IsTrue(containerSettings.LastModified.Value > new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc), containerSettings.LastModified.Value.ToString());
+        }
     }
 }
diff --git a/Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.Tests/DotNetSDKAPI.json b/Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.Tests/DotNetSDKAPI.json
@@ -2109,6 +2109,13 @@
           ],
           "MethodInfo": "System.Threading.Tasks.Task`1[Microsoft.Azure.Cosmos.ContainerResponse] CreateAsync(System.Nullable`1[System.Int32])"
         },
+        "System.Threading.Tasks.Task`1[Microsoft.Azure.Cosmos.ContainerResponse] CreateIfNotExistsAsync(System.Nullable`1[System.Int32])[System.Runtime.CompilerServices.AsyncStateMachineAttribute(typeof(Microsoft.Azure.Cosmos.Fluent.ContainerBuilder+<CreateIfNotExistsAsync>d__10))]": {
+          "Type": "Method",
+          "Attributes": [
+            "AsyncStateMachineAttribute"
+          ],
+          "MethodInfo": "System.Threading.Tasks.Task`1[Microsoft.Azure.Cosmos.ContainerResponse] CreateIfNotExistsAsync(System.Nullable`1[System.Int32])"
+        },
         "Void .ctor()": {
           "Type": "Constructor",
           "Attributes": [],

diff --git a/changelog.md b/changelog.md
@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [#544](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/544) Added continuation token support for LINQ
 - [#557](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/557) Added trigger options to item request options
 - [#571](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/571) Added a default JSON.net serializer with optional settings
+- [#592](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/592) Added CreateIfNotExistsAsync to container builder
 
 ### Fixed