fix(deployment): Added support for form deployment response

Client.UnitTests/DeploymentTest.cs

@@ -14,6 +14,7 @@ namespace Zeebe.Client
     public class DeploymentTest : BaseZeebeTest
     {
         private readonly string _demoProcessPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Resources", "demo-process.bpmn");
+        private readonly string _demoFormPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Resources", "demo-form.form");
 
         [Test]
         public async Task ShouldSendDeployResourceFileAsExpected()
@@ -240,16 +241,16 @@ public async Task ShouldSendMultipleDeployResourceAsExpected()
                     },
                     new Resource
                     {
-                        Content = ByteString.FromStream(File.OpenRead(_demoProcessPath)),
-                        Name = _demoProcessPath,
+                        Content = ByteString.FromStream(File.OpenRead(_demoFormPath)),
+                        Name = _demoFormPath,
                     }
                 }
             };
 
             // when
             await ZeebeClient.NewDeployCommand()
                 .AddResourceFile(_demoProcessPath)
-                .AddResourceStream(File.OpenRead(_demoProcessPath), _demoProcessPath)
+                .AddResourceStream(File.OpenRead(_demoFormPath), _demoFormPath)
                 .Send();
 
             // then
@@ -299,24 +300,36 @@ public async Task ShouldSendMultipleDeployResourceAndGetResponseAsExpected()
                             DmnDecisionRequirementsId = "id",
                             DmnDecisionRequirementsName = "nameRequirement"
                         }
+                    },
+                    new Deployment
+                    {
+                        Form = new FormMetadata
+                        {
+                            FormKey = 3,
+                            Version = 1,
+                            ResourceName = "form",
+                            FormId = "demoForm",
+                            TenantId = "formTenantId"
+                        }
                     }
                 }
             };
 
             TestService.AddRequestHandler(typeof(DeployResourceRequest), request => expectedResponse);
 
             // when
-            var fileContent = File.ReadAllText(_demoProcessPath);
+            var processFileContent = await File.ReadAllTextAsync(_demoProcessPath);
             var deployProcessResponse = await ZeebeClient.NewDeployCommand()
-                .AddResourceFile(_demoProcessPath)
-                .AddResourceString(fileContent, Encoding.UTF8, _demoProcessPath)
+                .AddResourceString(processFileContent, Encoding.UTF8, _demoProcessPath)
+                .AddResourceFile(_demoFormPath)
                 .Send();
 
             // then
             Assert.AreEqual(1, deployProcessResponse.Key);
             Assert.AreEqual(1, deployProcessResponse.Processes.Count);
             Assert.AreEqual(1, deployProcessResponse.Decisions.Count);
             Assert.AreEqual(1, deployProcessResponse.DecisionRequirements.Count);
+            Assert.AreEqual(1, deployProcessResponse.Forms.Count);
 
             var processMetadata = deployProcessResponse.Processes[0];
             Assert.AreEqual("process", processMetadata.BpmnProcessId);
@@ -338,6 +351,13 @@ public async Task ShouldSendMultipleDeployResourceAndGetResponseAsExpected()
             Assert.AreEqual("requirement", decisionRequirementsMetadata.ResourceName);
             Assert.AreEqual("nameRequirement", decisionRequirementsMetadata.DmnDecisionRequirementsName);
             Assert.AreEqual("id", decisionRequirementsMetadata.DmnDecisionRequirementsId);
+
+            var formMetadata = deployProcessResponse.Forms[0];
+            Assert.AreEqual(3, formMetadata.FormKey);
+            Assert.AreEqual(1, formMetadata.Version);
+            Assert.AreEqual("form", formMetadata.ResourceName);
+            Assert.AreEqual("demoForm", formMetadata.FormId);
+            Assert.AreEqual("formTenantId", formMetadata.TenantId);
         }
 
         [Test]

Client.UnitTests/Resources/demo-form.form

@@ -0,0 +1,23 @@
+{
+  "components": [
+    {
+      "label": "Demo checkbox",
+      "type": "checkbox",
+      "layout": {
+        "row": "Row_0b67lfv",
+        "columns": null
+      },
+      "id": "Field_18jrp23",
+      "key": "demoCheckbox"
+    }
+  ],
+  "type": "default",
+  "id": "demoForm",
+  "executionPlatform": "Camunda Cloud",
+  "executionPlatformVersion": "8.4.0",
+  "exporter": {
+    "name": "Camunda Modeler",
+    "version": "5.19.0"
+  },
+  "schemaVersion": 14
+}

Client/Api/Responses/IDeployResourceResponse.cs

@@ -15,5 +15,8 @@ public interface IDeployResourceResponse
 
         /// <returns>the decision requirements which are deployed </returns>
         IList<IDecisionRequirementsMetadata> DecisionRequirements { get; }
+
+        /// <returns>the forms which are deployed</returns>
+        IList<IFormMetadata> Forms { get; }
     }
 }

Client/Api/Responses/IFormMetadata.cs

@@ -0,0 +1,19 @@
+namespace Zeebe.Client.Api.Responses;
+
+public interface IFormMetadata
+{
+    /// <returns>the form ID of the deployed form.</returns>
+    string FormId { get; }
+
+    /// <returns>the version of the deployed form.</returns>
+    int Version { get; }
+
+    /// <returns>the key of the deployed form.</returns>
+    long FormKey { get; }
+
+    /// <returns>the name of the deployment resource which contains the form.</returns>
+    string ResourceName { get; }
+
+    /// <returns>the tenant ID of the deployed form.</returns>
+    string TenantId { get; }
+}

Client/Impl/Responses/DeployResourceResponse.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
 using GatewayProtocol;
 using Zeebe.Client.Api.Responses;
 
@@ -12,13 +11,15 @@ public class DeployResourceResponse : IDeployResourceResponse
         public IList<IProcessMetadata> Processes { get; }
         public IList<IDecisionMetadata> Decisions { get; }
         public IList<IDecisionRequirementsMetadata> DecisionRequirements { get; }
+        public IList<IFormMetadata> Forms { get; }
 
         public DeployResourceResponse(GatewayProtocol.DeployResourceResponse response)
         {
             Key = response.Key;
             Processes = new List<IProcessMetadata>();
             Decisions = new List<IDecisionMetadata>();
             DecisionRequirements = new List<IDecisionRequirementsMetadata>();
+            Forms = new List<IFormMetadata>();
 
             foreach (var deployment in response.Deployments)
             {
@@ -33,6 +34,9 @@ public DeployResourceResponse(GatewayProtocol.DeployResourceResponse response)
                     case Deployment.MetadataOneofCase.DecisionRequirements:
                         DecisionRequirements.Add(new DecisionRequirementsMetadata(deployment.DecisionRequirements));
                         break;
+                    case Deployment.MetadataOneofCase.Form:
+                        Forms.Add(new FormMetadata(deployment.Form));
+                        break;
                     default:
                         throw new NotImplementedException("Got deployment response for unexpected type: " +
                                                           deployment.MetadataCase);

Client/Impl/Responses/FormMetadata.cs

@@ -0,0 +1,21 @@
+using Zeebe.Client.Api.Responses;
+
+namespace Zeebe.Client.Impl.Responses;
+
+public class FormMetadata : IFormMetadata
+{
+    public string FormId { get; }
+    public int Version { get; }
+    public long FormKey { get; }
+    public string ResourceName { get; }
+    public string TenantId { get; }
+
+    public FormMetadata(GatewayProtocol.FormMetadata metadata)
+    {
+        FormId = metadata.FormId;
+        Version = metadata.Version;
+        FormKey = metadata.FormKey;
+        ResourceName = metadata.ResourceName;
+        TenantId = metadata.TenantId;
+    }
+}