Fetch resource policy instead of policies (#842)

* Fetch resource policy instead of policies

* Typos and spaces fixed

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

Author: f-alizada

src/ArmTemplates/Common/API/Clients/Policy/PolicyClient.cs

@@ -4,6 +4,7 @@
 // --------------------------------------------------------------------------
 
 using System.Linq;
+using System.Net;
 using System.Net.Http;
 using System.Threading.Tasks;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Clients.Abstractions;
@@ -16,9 +17,9 @@ namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Clien
     public class PolicyClient : ApiClientBase, IPolicyClient
     {
         const string GetGlobalServicePolicyRequest = "{0}/subscriptions/{1}/resourceGroups/{2}/providers/Microsoft.ApiManagement/service/{3}/policies/policy?api-version={4}&format=rawxml";
-        const string GetPolicyLinkedToProductRequest = "{0}/subscriptions/{1}/resourceGroups/{2}/providers/Microsoft.ApiManagement/service/{3}/products/{4}/policies?api-version={5}&format=rawxml";
-        const string GetPolicyLinkedToApiRequest = "{0}/subscriptions/{1}/resourceGroups/{2}/providers/Microsoft.ApiManagement/service/{3}/apis/{4}/policies?api-version={5}&format=rawxml";
-        const string GetPolicyLinkedToApiOperationRequest = "{0}/subscriptions/{1}/resourceGroups/{2}/providers/Microsoft.ApiManagement/service/{3}/apis/{4}/operations/{5}/policies?api-version={6}&format=rawxml";
+        const string GetPolicyLinkedToProductRequest = "{0}/subscriptions/{1}/resourceGroups/{2}/providers/Microsoft.ApiManagement/service/{3}/products/{4}/policies/policy?api-version={5}&format=rawxml";
+        const string GetPolicyLinkedToApiRequest = "{0}/subscriptions/{1}/resourceGroups/{2}/providers/Microsoft.ApiManagement/service/{3}/apis/{4}/policies/policy?api-version={5}&format=rawxml";
+        const string GetPolicyLinkedToApiOperationRequest = "{0}/subscriptions/{1}/resourceGroups/{2}/providers/Microsoft.ApiManagement/service/{3}/apis/{4}/operations/{5}/policies/policy?api-version={6}&format=rawxml";
 
         public PolicyClient(IHttpClientFactory httpClientFactory) : base(httpClientFactory)
         {
@@ -41,8 +42,7 @@ public async Task<PolicyTemplateResource> GetPolicyLinkedToProductAsync(string p
             string requestUrl = string.Format(GetPolicyLinkedToProductRequest,
                this.BaseUrl, azSubId, extractorParameters.ResourceGroup, extractorParameters.SourceApimName, productName, GlobalConstants.ApiVersion);
 
-            var policies = await this.GetPagedResponseAsync<PolicyTemplateResource>(azToken, requestUrl);
-            return policies.FirstOrDefault();
+            return await this.FetchResourcePolicyTemplateAsync(azToken, requestUrl);
         }
 
         public async Task<PolicyTemplateResource> GetPolicyLinkedToApiAsync(string apiName, ExtractorParameters extractorParameters)
@@ -52,8 +52,7 @@ public async Task<PolicyTemplateResource> GetPolicyLinkedToApiAsync(string apiNa
             string requestUrl = string.Format(GetPolicyLinkedToApiRequest,
                 this.BaseUrl, azSubId, extractorParameters.ResourceGroup, extractorParameters.SourceApimName, apiName, GlobalConstants.ApiVersion);
 
-            var policies = await this.GetPagedResponseAsync<PolicyTemplateResource>(azToken, requestUrl);
-            return policies.FirstOrDefault();
+            return await this.FetchResourcePolicyTemplateAsync(azToken, requestUrl);
         }
 
         public async Task<PolicyTemplateResource> GetPolicyLinkedToApiOperationAsync(string apiName, string operationName, ExtractorParameters extractorParameters)
@@ -63,8 +62,25 @@ public async Task<PolicyTemplateResource> GetPolicyLinkedToApiOperationAsync(str
             string requestUrl = string.Format(GetPolicyLinkedToApiOperationRequest,
                this.BaseUrl, azSubId, extractorParameters.ResourceGroup, extractorParameters.SourceApimName, apiName, operationName, GlobalConstants.ApiVersion);
 
-            var policies = await this.GetPagedResponseAsync<PolicyTemplateResource>(azToken, requestUrl);
-            return policies.FirstOrDefault();
+            return await this.FetchResourcePolicyTemplateAsync(azToken, requestUrl);
+        }
+
+        async Task<PolicyTemplateResource> FetchResourcePolicyTemplateAsync(string azToken, string requestUrl)
+        {
+            PolicyTemplateResource policy = null;
+            try
+            {
+                policy = await this.GetResponseAsync<PolicyTemplateResource>(azToken, requestUrl);
+            }
+            catch (HttpRequestException ex)
+            {
+                // It is expected that entity will not have policy if it was not set after creation
+                if (ex.StatusCode != HttpStatusCode.NotFound)
+                {
+                    throw;
+                }
+            }
+            return policy;
         }
     }
 }

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

@@ -63,7 +63,7 @@ public async Task GenerateApiManagementService_ProperlyParsesJsonResponse()
 
             string fileLocation = Path.Combine(MockClientUtils.ApiClientJsonResponsesPath, "ApiManagementGetInstance_success_response.json");
             var expectedApiManagementService = await MockClientUtils.DeserializeFileContent<ApiManagementServiceResource>(fileLocation);
-            var mockedApiManagementServiceClient = await MockApiManagementServiceClient.GetMockedHttpApiManagementServiceClient(fileLocation);
+            var mockedApiManagementServiceClient = await MockApiManagementServiceClient.GetMockedHttpApiManagementServiceClient(new MockClientConfiguration(responseFileLocation: fileLocation));
             var mockedApiManagementServiceExtractor = new ApiManagementServiceExtractor(this.GetTestLogger<ApiManagementServiceExtractor>(), new TemplateBuilder(), mockedApiManagementServiceClient);
 
             var extractorExecutor = ExtractorExecutor.BuildExtractorExecutor(

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

@@ -30,7 +30,7 @@ public async Task GenerateApiOperationsResourcesAsync_ProperlyParsesResponse()
                 apiName: "apiName");
             var extractorParameters = new ExtractorParameters(extractorConfig);
             var fileLocation = Path.Combine(MockClientUtils.ApiClientJsonResponsesPath, "ApiManagementListApiOperations_success_response.json");
-            var mockedClient = await MockApiOperationClient.GetMockedHttpApiOperationClient(fileLocation);
+            var mockedClient = await MockApiOperationClient.GetMockedHttpApiOperationClient(new MockClientConfiguration(responseFileLocation: fileLocation));
             var apiOperationExtractor = new ApiOperationExtractor(this.GetTestLogger<ApiOperationExtractor>(), mockedClient);
 
             // act

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

@@ -64,7 +64,7 @@ public async Task GenerateAllCurrentApiReleaseTemplateAsync_ProperlyCreatesTempl
             var responseFileLocation = Path.Combine(MockClientUtils.ApiClientJsonResponsesPath, "ApiManagementListApis_success_response.json");
             var currentTestDirectory = Path.Combine(this.OutputDirectory, nameof(GenerateAllCurrentApiReleaseTemplateAsync_ProperlyCreatesTemplate));
 
-            var mockedApiClientAllCurrent = await MockApisClient.GetMockedHttpApiClient(responseFileLocation);
+            var mockedApiClientAllCurrent = await MockApisClient.GetMockedHttpApiClient(new MockClientConfiguration(responseFileLocation: responseFileLocation));
 
             var extractorConfig = this.GetDefaultExtractorConsoleAppConfiguration(
                 apiName: string.Empty);

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

@@ -32,7 +32,7 @@ public async Task GenerateApiTemplates_ProperlyParsesTheInformation()
             var extractorConfig = this.GetDefaultExtractorConsoleAppConfiguration();
             var extractorParameters = new ExtractorParameters(extractorConfig);
 
-            var mockedApiSchemaClient = await MockApiSchemaClient.GetMockedHttpApiSchemaClient(responseFileLocation);
+            var mockedApiSchemaClient = await MockApiSchemaClient.GetMockedHttpApiSchemaClient(new MockClientConfiguration(responseFileLocation: responseFileLocation));
             var mockedApiSchemaExtractor = new ApiSchemaExtractor(this.GetTestLogger<ApiSchemaExtractor>(), mockedApiSchemaClient);
 
             // act

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

@@ -97,7 +97,7 @@ public async Task GenerateBackendTemplate_ProperlyParsesAndGeneratesTemplate()
             var responseFileLocation = Path.Combine(MockClientUtils.ApiClientJsonResponsesPath, "ApiManagementListBackends_success_response.json");
             var currentTestDirectory = Path.Combine(this.OutputDirectory, nameof(GenerateBackendTemplate_ProperlyParsesAndGeneratesTemplate));
 
-            var mockedClient = await MockBackendClient.GetMockedHttpApiClient(responseFileLocation);
+            var mockedClient = await MockBackendClient.GetMockedHttpApiClient(new MockClientConfiguration(responseFileLocation: responseFileLocation));
 
             var extractorConfig = this.GetDefaultExtractorConsoleAppConfiguration(
                 apiName: string.Empty,

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

@@ -76,7 +76,7 @@ public async Task GenerateGroupsTemplates_ProperlyParsesResponse()
             var extractorConfig = this.GetDefaultExtractorConsoleAppConfiguration();
             var extractorParameters = new ExtractorParameters(extractorConfig);
             var fileLocation = Path.Combine(MockClientUtils.ApiClientJsonResponsesPath, "ApiManagementListGroups_success_response.json");
-            var mockedGroupsClient = await MockGroupsClient.GetMockedHttpGroupClient(fileLocation);
+            var mockedGroupsClient = await MockGroupsClient.GetMockedHttpGroupClient(new MockClientConfiguration(responseFileLocation: fileLocation));
             var groupExtractor = new GroupExtractor(this.GetTestLogger<GroupExtractor>(), new TemplateBuilder(), mockedGroupsClient);
 
             var extractorExecutor = ExtractorExecutor.BuildExtractorExecutor(

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

@@ -81,7 +81,7 @@ public async Task GenerateOpenIdConnectProviderTemplates_ProperlyParsesResponse(
             var extractorConfig = this.GetDefaultExtractorConsoleAppConfiguration();
             var extractorParameters = new ExtractorParameters(extractorConfig);
             var fileLocation = Path.Combine(MockClientUtils.ApiClientJsonResponsesPath, "ApiManagementListOpenIdConnectProviders_success_response.json");
-            var mockedOpenIdConnectProviderClient = await MockOpenIdConnectProviderClient.GetMockedHttpOpenIdConnectProviderClient(fileLocation);
+            var mockedOpenIdConnectProviderClient = await MockOpenIdConnectProviderClient.GetMockedHttpOpenIdConnectProviderClient(new MockClientConfiguration(responseFileLocation: fileLocation));
             var openIdConnectExtractor = new OpenIdConnectProviderExtractor(this.GetTestLogger<OpenIdConnectProviderExtractor>(), new TemplateBuilder(), mockedOpenIdConnectProviderClient);
 
             var extractorExecutor = ExtractorExecutor.BuildExtractorExecutor(