Fetch by version set name approach changed (#848)

f-alizada · Farhad Alizada · web-flow · commit 1f30504aeb1a · 2022-12-20T11:43:37.000+01:00
* Fetch by version set name approach changed
* Add functionality to fetch name of version sets for grouping
Co-authored-by: Farhad Alizada &lt;falizada@microsoft.com&gt;
diff --git a/src/ArmTemplates/Commands/Executors/ExtractorExecutor.cs b/src/ArmTemplates/Commands/Executors/ExtractorExecutor.cs
@@ -5,6 +5,7 @@
 
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Commands.Configurations;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Clients.Abstractions;
+using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Utils;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Constants;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Exceptions;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Extensions;
@@ -48,6 +49,7 @@ public class ExtractorExecutor
 
         readonly ILogger<ExtractorExecutor> logger;
         readonly IApisClient apisClient;
+        readonly IApiClientUtils apiClientUtils;
 
         readonly IApiExtractor apiExtractor;
         readonly IApiVersionSetExtractor apiVersionSetExtractor;
@@ -98,7 +100,8 @@ public ExtractorExecutor(
             ISchemaExtractor schemaExtractor,
             IOpenIdConnectProviderExtractor openIdConnectProviderExtractor,
             IPolicyFragmentsExtractor policyFragmentsExtractor,
-            IApiReleaseExtractor apiReleaseExtractor)
+            IApiReleaseExtractor apiReleaseExtractor,
+            IApiClientUtils apiClientUtils)
         {
             this.logger = logger;
             this.apisClient = apisClient;
@@ -125,6 +128,7 @@ public ExtractorExecutor(
             this.openIdConnectProviderExtractor = openIdConnectProviderExtractor;
             this.policyFragmentsExtractor = policyFragmentsExtractor;
             this.apiReleaseExtractor = apiReleaseExtractor;
+            this.apiClientUtils = apiClientUtils;
         }
 
         /// <summary>
@@ -156,7 +160,8 @@ public static ExtractorExecutor BuildExtractorExecutor(
             ISchemaExtractor schemaExtractor = null,
             IOpenIdConnectProviderExtractor openIdConnectProviderExtractor = null,
             IPolicyFragmentsExtractor policyFragmentsExtractor = null,
-            IApiReleaseExtractor apiReleaseExtractor = null)
+            IApiReleaseExtractor apiReleaseExtractor = null,
+            IApiClientUtils apiClientUtils = null)
         => new ExtractorExecutor(
                 logger,
                 apisClient,
@@ -182,7 +187,8 @@ public static ExtractorExecutor BuildExtractorExecutor(
                 schemaExtractor,
                 openIdConnectProviderExtractor,
                 policyFragmentsExtractor,
-                apiReleaseExtractor);
+                apiReleaseExtractor,
+                apiClientUtils);
 
         public void SetExtractorParameters(ExtractorParameters extractorParameters)
         {
@@ -1031,13 +1037,13 @@ async Task GenerateSplitAPITemplates()
         /// <summary>
         /// Generates master template for each API within this version set and an extra master template to link these apis
         /// </summary>
-        async Task GenerateAPIVersionSetTemplates()
+        public async Task GenerateAPIVersionSetTemplates()
         {
             // get api dictionary and check api version set
-            var apiDictionary = await this.GetAllAPIsDictionary(this.extractorParameters);
+            var apiDictionary = await this.apiClientUtils.GetAllAPIsDictionaryByVersionSetName(this.extractorParameters);
             if (!apiDictionary.ContainsKey(this.extractorParameters.ApiVersionSetName))
             {
-                throw new NoApiVersionSetWithSuchNameFoundException("API Version Set with this name doesn't exist");
+                throw new NoApiVersionSetWithSuchNameFoundException(ErrorMessages.ApiVersionDoesNotExistErrorMessage);
             }
             else
             {
@@ -1052,7 +1058,7 @@ async Task GenerateAPIVersionSetTemplates()
                 }
 
                 // create master templates for this apiVersionSet 
-                string versionSetFolder = string.Concat(this.extractorParameters.FilesGenerationRootDirectory, this.extractorParameters.FileNames.VersionSetMasterFolder);
+                string versionSetFolder = Path.Combine(this.extractorParameters.FilesGenerationRootDirectory, this.extractorParameters.FileNames.VersionSetMasterFolder);
                 Directory.CreateDirectory(versionSetFolder);
                 await this.GenerateTemplates(versionSetFolder, multipleApiNames: apiDictionary[this.extractorParameters.ApiVersionSetName]);
 
diff --git a/src/ArmTemplates/Common/API/Clients/Abstractions/IApisClient.cs b/src/ArmTemplates/Common/API/Clients/Abstractions/IApisClient.cs
@@ -14,7 +14,7 @@ public interface IApisClient
     {
         Task<ApiTemplateResource> GetSingleAsync(string apiName, ExtractorParameters extractorParameters);
 
-        Task<List<ApiTemplateResource>> GetAllAsync(ExtractorParameters extractorParameters);
+        Task<List<ApiTemplateResource>> GetAllAsync(ExtractorParameters extractorParameters, bool expandVersionSet = false);
 
         Task<List<ApiTemplateResource>> GetAllCurrentAsync(ExtractorParameters extractorParameters);
 
diff --git a/src/ArmTemplates/Common/API/Clients/Apis/ApisClient.cs b/src/ArmTemplates/Common/API/Clients/Apis/ApisClient.cs
@@ -17,7 +17,7 @@ namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Clien
     public class ApisClient : ApiClientBase, IApisClient
     {
         const string GetSingleApiRequest = "{0}/subscriptions/{1}/resourceGroups/{2}/providers/Microsoft.ApiManagement/service/{3}/apis/{4}?api-version={5}";
-        const string GetAllApisRequest = "{0}/subscriptions/{1}/resourceGroups/{2}/providers/Microsoft.ApiManagement/service/{3}/apis?api-version={4}";
+        const string GetAllApisRequest = "{0}/subscriptions/{1}/resourceGroups/{2}/providers/Microsoft.ApiManagement/service/{3}/apis?api-version={4}&expandApiVersionSet={5}";
         const string GetAllCurrentApisRequest = "{0}/subscriptions/{1}/resourceGroups/{2}/providers/Microsoft.ApiManagement/service/{3}/apis?api-version={4}&$filter=isCurrent";
         const string GetAllApisLinkedToProductRequest = "{0}/subscriptions/{1}/resourceGroups/{2}/providers/Microsoft.ApiManagement/service/{3}/products/{4}/apis?api-version={5}";
         const string GetApisLinkedToGatewayRequest = "{0}/subscriptions/{1}/resourceGroups/{2}/providers/Microsoft.ApiManagement/service/{3}/gateways/{4}/apis?api-version={5}";
@@ -41,12 +41,12 @@ public async Task<ApiTemplateResource> GetSingleAsync(string apiName, ExtractorP
             return api;
         }
 
-        public async Task<List<ApiTemplateResource>> GetAllAsync(ExtractorParameters extractorParameters)
+        public async Task<List<ApiTemplateResource>> GetAllAsync(ExtractorParameters extractorParameters, bool expandVersionSet = false)
         {
             var (azToken, azSubId) = await this.Auth.GetAccessToken();
             
             string requestUrl = string.Format(GetAllApisRequest,
-                this.BaseUrl, azSubId, extractorParameters.ResourceGroup, extractorParameters.SourceApimName, GlobalConstants.ApiVersion);
+                this.BaseUrl, azSubId, extractorParameters.ResourceGroup, extractorParameters.SourceApimName, GlobalConstants.ApiVersion, expandVersionSet);
 
             var apis = await this.GetPagedResponseAsync<ApiTemplateResource>(azToken, requestUrl);
             this.apiDataProcessor.ProcessData(apis);
diff --git a/src/ArmTemplates/Common/API/Utils/ApiClientUtils.cs b/src/ArmTemplates/Common/API/Utils/ApiClientUtils.cs
@@ -0,0 +1,56 @@
+﻿// --------------------------------------------------------------------------
+//  Copyright (c) Microsoft Corporation. All rights reserved.
+//  Licensed under the MIT License.
+// --------------------------------------------------------------------------
+
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Clients.Abstractions;
+using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Extractor.Models;
+
+namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Utils
+{
+    public class ApiClientUtils: IApiClientUtils
+    {
+        readonly IApisClient apisClient;
+        
+        public ApiClientUtils(IApisClient apisClient)
+        {
+            this.apisClient = apisClient;
+        }
+
+        public async Task<Dictionary<string, List<string>>> GetAllAPIsDictionaryByVersionSetName(ExtractorParameters extractorParameters)
+        {
+            // pull all apis from service
+            var apis = await this.apisClient.GetAllAsync(extractorParameters, expandVersionSet: true);
+
+            // Generate apis dictionary based on all apiversionset
+            var apiDictionary = new Dictionary<string, List<string>>();
+
+            foreach (var api in apis)
+            {
+                string apiVersionSetName = api.Properties.ApiVersionSet?.Name;
+
+                if (string.IsNullOrEmpty(apiVersionSetName))
+                {
+                    continue;
+                }
+
+                if (!apiDictionary.ContainsKey(apiVersionSetName))
+                {
+                    var apiVersionSet = new List<string>
+                    {
+                        api.Name
+                    };
+                    apiDictionary[apiVersionSetName] = apiVersionSet;
+                }
+                else
+                {
+                    apiDictionary[apiVersionSetName].Add(api.Name);
+                }
+            }
+
+            return apiDictionary;
+        }
+    }
+}
diff --git a/src/ArmTemplates/Common/API/Utils/IApiClientUtils.cs b/src/ArmTemplates/Common/API/Utils/IApiClientUtils.cs
@@ -0,0 +1,16 @@
+﻿// --------------------------------------------------------------------------
+//  Copyright (c) Microsoft Corporation. All rights reserved.
+//  Licensed under the MIT License.
+// --------------------------------------------------------------------------
+
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Extractor.Models;
+
+namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Utils
+{
+    public interface IApiClientUtils
+    {
+        Task<Dictionary<string, List<string>>> GetAllAPIsDictionaryByVersionSetName(ExtractorParameters extractorParameters);
+    }
+}
diff --git a/src/ArmTemplates/Common/Constants/ErrorMessages.cs b/src/ArmTemplates/Common/Constants/ErrorMessages.cs
@@ -9,5 +9,6 @@ public static class ErrorMessages
     {
         public const string DuplicateTagResourceNameErrorMessage = "Duplicate tag resource name found during sanitizing the display name. Please consider renaming tags: {0}, {1}. Both resulted resource name to be equal to: {2}";
         public const string EmptyResourceNameAfterSanitizingErrorMessage = "Sanitizing the display name '{0}' resulted empty string";
+        public const string ApiVersionDoesNotExistErrorMessage = "API Version Set with this name doesn't exist";
     }
 }
diff --git a/src/ArmTemplates/Common/FileHandlers/FileNameGenerator.cs b/src/ArmTemplates/Common/FileHandlers/FileNameGenerator.cs
@@ -64,7 +64,7 @@ public static FileNames GenerateFileNames(string baseFileName)
                 LinkedMaster = $@"{baseFileName}master.template.json",
                 Apis = "/Apis",
                 SplitAPIs = "/SplitAPIs",
-                VersionSetMasterFolder = "/VersionSetMasterFolder",
+                VersionSetMasterFolder = "VersionSetMasterFolder",
                 RevisionMasterFolder = "/RevisionMasterFolder",
                 GroupAPIsMasterFolder = "/MultipleApisMasterFolder",
                 Groups = $"{baseFileName}groups.template.json",
diff --git a/src/ArmTemplates/ServiceExtensions.cs b/src/ArmTemplates/ServiceExtensions.cs
@@ -39,6 +39,7 @@
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Clients.Schemas;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Clients.OpenIdConnectProviders;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Clients.PolicyFragments;
+using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Utils;
 
 namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates
 {
@@ -65,6 +66,7 @@ public static void AddArmTemplatesServices(this IServiceCollection services, ILo
             SetupExtractors(services);
             SetupCreators(services);
             SetupDataProcessors(services);
+            SetupApiClientsUtils(services);
         }
 
         static void SetupDataProcessors(IServiceCollection services)
@@ -169,5 +171,10 @@ static void SetupApiClients(IServiceCollection services)
             services.AddScoped<IOpenIdConnectProvidersClient, OpenIdConnectProviderClient>();
             services.AddScoped<IPolicyFragmentsClient, PolicyFragmentsClient>();
         }
+
+        static void SetupApiClientsUtils(IServiceCollection services)
+        {
+            services.AddScoped<IApiClientUtils, ApiClientUtils>();
+        }
     }
 }
diff --git a/tests/ArmTemplates.Tests/Extractor/Scenarios/ApiExtractorByVersionSetNameTests.cs b/tests/ArmTemplates.Tests/Extractor/Scenarios/ApiExtractorByVersionSetNameTests.cs
diff --git a/tests/ArmTemplates.Tests/Moqs/ApiClients/MockApisClient.cs b/tests/ArmTemplates.Tests/Moqs/ApiClients/MockApisClient.cs
diff --git a/tests/ArmTemplates.Tests/Resources/ApiClientJsonResponses/ApiManagementListApis_ExpandVersionSet_success_response.json b/tests/ArmTemplates.Tests/Resources/ApiClientJsonResponses/ApiManagementListApis_ExpandVersionSet_success_response.json

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public interface IApisClient`
`14`	`14`	`{`
`15`	`15`	`Task<ApiTemplateResource> GetSingleAsync(string apiName, ExtractorParameters extractorParameters);`
`16`	`16`
`17`		`- Task<List<ApiTemplateResource>> GetAllAsync(ExtractorParameters extractorParameters);`
	`17`	`+ Task<List<ApiTemplateResource>> GetAllAsync(ExtractorParameters extractorParameters, bool expandVersionSet = false);`
`18`	`18`
`19`	`19`	`Task<List<ApiTemplateResource>> GetAllCurrentAsync(ExtractorParameters extractorParameters);`
`20`	`20`
Original file line number	Diff line number	Diff line change
`@@ -9,5 +9,6 @@ public static class ErrorMessages`
`9`	`9`	`{`
`10`	`10`	`public const string DuplicateTagResourceNameErrorMessage = "Duplicate tag resource name found during sanitizing the display name. Please consider renaming tags: {0}, {1}. Both resulted resource name to be equal to: {2}";`
`11`	`11`	`public const string EmptyResourceNameAfterSanitizingErrorMessage = "Sanitizing the display name '{0}' resulted empty string";`
	`12`	`+ public const string ApiVersionDoesNotExistErrorMessage = "API Version Set with this name doesn't exist";`
`12`	`13`	`}`
`13`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@`
`39`	`39`	`using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Clients.Schemas;`
`40`	`40`	`using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Clients.OpenIdConnectProviders;`
`41`	`41`	`using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Clients.PolicyFragments;`
	`42`	`+using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.API.Utils;`
`42`	`43`
`43`	`44`	`namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates`
`44`	`45`	`{`
`@@ -65,6 +66,7 @@ public static void AddArmTemplatesServices(this IServiceCollection services, ILo`
`65`	`66`	`SetupExtractors(services);`
`66`	`67`	`SetupCreators(services);`
`67`	`68`	`SetupDataProcessors(services);`
	`69`	`+ SetupApiClientsUtils(services);`
`68`	`70`	`}`
`69`	`71`
`70`	`72`	`static void SetupDataProcessors(IServiceCollection services)`
`@@ -169,5 +171,10 @@ static void SetupApiClients(IServiceCollection services)`
`169`	`171`	`services.AddScoped<IOpenIdConnectProvidersClient, OpenIdConnectProviderClient>();`
`170`	`172`	`services.AddScoped<IPolicyFragmentsClient, PolicyFragmentsClient>();`
`171`	`173`	`}`
	`174`	`+`
	`175`	`+ static void SetupApiClientsUtils(IServiceCollection services)`
	`176`	`+ {`
	`177`	`+ services.AddScoped<IApiClientUtils, ApiClientUtils>();`
	`178`	`+ }`
`172`	`179`	`}`
`173`	`180`	`}`