Add contact and termsOfService properties to API template (#851)

Co-authored-by: Farhad Alizada <falizada@microsoft.com>

Author: f-alizada

src/ArmTemplates/Common/Templates/Apis/ApiProperties.cs

@@ -52,5 +52,9 @@ public class ApiProperties
         public ApiTemplateWSDLSelector WsdlSelector { get; set; }
 
         public string ApiType { get; set; }
+
+        public string TermsOfServiceUrl { get; set; }
+
+        public ApiTemplateContact Contact { get; set; }
     }
 }

src/ArmTemplates/Common/Templates/Apis/ApiTemplateContact.cs

@@ -0,0 +1,16 @@
+// --------------------------------------------------------------------------
+//  Copyright (c) Microsoft Corporation. All rights reserved.
+//  Licensed under the MIT License.
+// --------------------------------------------------------------------------
+
+namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.Apis
+{
+    public class ApiTemplateContact
+    {
+        public string Email { get; set; }
+
+        public string Name { get; set; }    
+
+        public string Url { get; set; }
+    }
+}

tests/ArmTemplates.Tests/Extractor/Scenarios/ApiExtractorTests.cs

@@ -11,8 +11,10 @@
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Commands.Executors;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Constants;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.FileHandlers;
+using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.ApiOperations;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.Builders;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Extractor.EntityExtractors;
+using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Extractor.EntityExtractors.Abstractions;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Extractor.Models;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Tests.Extractor.Abstractions;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Tests.Moqs.ApiClients;
@@ -298,5 +300,65 @@ public async Task GenerateApiTemplateAsync_WebsocketApiTypeOperationsNotGenerate
             apiTemplate.TypedResources.ApiOperationsTags.Count().Should().Be(6);
             apiTemplate.TypedResources.ApiOperationsPolicies.Count().Should().Be(3);
         }
+
+        [Fact]
+        public async Task GenerateApiTemplateAsync_ContainsContactAndTermOfService_Information()
+        {
+            // arrange
+            var currentTestDirectory = Path.Combine(this.OutputDirectory, nameof(GenerateApiTemplateAsync_ContainsContactAndTermOfService_Information));
+
+            var extractorConfig = this.GetDefaultExtractorConsoleAppConfiguration(
+                multipleAPIs: string.Empty,
+                apiVersionSetName: string.Empty,
+                apiName: "apiName"
+            );
+
+            var extractorParameters = new ExtractorParameters(extractorConfig);
+
+            // mocked clients
+            var responseFileLocation = Path.Combine(MockClientUtils.ApiClientJsonResponsesPath, "ApiManagementGetApiContract_success_response.json");
+            var mockedApiClientAllCurrent = await MockApisClient.GetMockedHttpApiClient(new MockClientConfiguration(responseFileLocation: responseFileLocation));
+
+            // mocked extractors
+            var mockedDiagnosticExtractor = new Mock<IDiagnosticExtractor>(MockBehavior.Loose);
+            var mockedApiSchemaExtractor = new Mock<IApiSchemaExtractor>(MockBehavior.Loose);
+            var mockedPolicyExtractor = new Mock<IPolicyExtractor>(MockBehavior.Loose);
+            var mockedProductApisExtractor = new Mock<IProductApisExtractor>(MockBehavior.Loose);
+            var mockedTagExtractor = new Mock<ITagExtractor>(MockBehavior.Loose);
+            var mockedApiOperationExtractor = new Mock<IApiOperationExtractor>(MockBehavior.Loose);
+            mockedApiOperationExtractor.Setup(
+                    x => x.GenerateApiOperationsResourcesAsync(It.IsAny<string>(), It.IsAny<ExtractorParameters>())
+                ).ReturnsAsync(new List<ApiOperationTemplateResource>());
+                
+
+            var apiExtractor = new ApiExtractor(
+                this.GetTestLogger<ApiExtractor>(),
+                new TemplateBuilder(),
+                mockedApiClientAllCurrent,
+                mockedDiagnosticExtractor.Object,
+                mockedApiSchemaExtractor.Object,
+                mockedPolicyExtractor.Object,
+                mockedProductApisExtractor.Object,
+                mockedTagExtractor.Object,
+                mockedApiOperationExtractor.Object,
+                null
+                );
+
+            // act
+            var apiTemplate = await apiExtractor.GenerateSingleApiTemplateResourcesAsync(
+                singleApiName: "api-contract-and-terms",
+                currentTestDirectory,
+                extractorParameters);
+
+            // assert
+            apiTemplate.Apis.Should().NotBeNull();
+            apiTemplate.Apis.Count.Should().Be(1);
+            apiTemplate.Apis[0].Name.Contains("api-contract-and-terms").Should().BeTrue();
+            apiTemplate.Apis[0].Properties.Contact.Should().NotBeNull();
+            apiTemplate.Apis[0].Properties.Contact.Name.Should().Be("name-value");
+            apiTemplate.Apis[0].Properties.Contact.Email.Should().Be("email-value");
+            apiTemplate.Apis[0].Properties.Contact.Url.Should().Be("url-value");
+            apiTemplate.Apis[0].Properties.TermsOfServiceUrl.Should().Be("test-url-value");
+        }
     }
 }

tests/ArmTemplates.Tests/Resources/ApiClientJsonResponses/ApiManagementGetApiContract_success_response.json

@@ -0,0 +1,27 @@
+{
+  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/api-contract-and-terms",
+  "type": "Microsoft.ApiManagement/service/apis",
+  "name": "api-contract-and-terms",
+  "properties": {
+    "displayName": "Service",
+    "apiRevision": "1",
+    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
+    "path": "schulte",
+    "protocols": [
+      "https"
+    ],
+    "subscriptionKeyParameterNames": {
+      "header": "Ocp-Apim-Subscription-Key",
+      "query": "subscription-key"
+    },
+    "type": "soap",
+    "isCurrent": true,
+    "isOnline": true,
+    "contact": {
+      "email": "email-value",
+      "name": "name-value",
+      "url": "url-value"
+    },
+    "termsOfServiceUrl": "test-url-value"
+  }
+}