Add groupsTemplate to the master template (#701)

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

Author: f-alizada

src/ArmTemplates/Commands/Executors/ExtractorExecutor.cs

@@ -437,7 +437,8 @@ public async Task<Template<MasterTemplateResources>> GenerateMasterTemplateAsync
            BackendTemplateResources backendsTemplateResources = null,
            AuthorizationServerTemplateResources authorizationServersTemplateResources = null,
            NamedValuesResources namedValuesTemplateResources = null,
-           TagTemplateResources tagTemplateResources = null)
+           TagTemplateResources tagTemplateResources = null,
+           GroupTemplateResources groupTemplateResources = null)
         {
             if (string.IsNullOrEmpty(this.extractorParameters.LinkedTemplatesBaseUrl))
             {
@@ -450,7 +451,8 @@ public async Task<Template<MasterTemplateResources>> GenerateMasterTemplateAsync
             var masterTemplate = this.masterTemplateExtractor.GenerateLinkedMasterTemplate(
                 this.extractorParameters, apiTemplateResources, policyTemplateResources, apiVersionSetTemplateResources,
                 productsTemplateResources, productApisTemplateResources, apiTagsTemplateResources, loggersTemplateResources,
-                backendsTemplateResources, authorizationServersTemplateResources, namedValuesTemplateResources, tagTemplateResources);
+                backendsTemplateResources, authorizationServersTemplateResources, namedValuesTemplateResources, tagTemplateResources, 
+                groupTemplateResources);
 
             if (masterTemplate?.HasResources() == true)
             {
@@ -872,7 +874,7 @@ async Task GenerateTemplates(
             var loggerTemplate = await this.GenerateLoggerTemplateAsync(apisToExtract, apiTemplate.TypedResources.GetAllPolicies(), baseFilesGenerationDirectory);
             var namedValueTemplate = await this.GenerateNamedValuesTemplateAsync(singleApiName, apiTemplate.TypedResources.GetAllPolicies(), loggerTemplate.TypedResources.Loggers, baseFilesGenerationDirectory);
             var backendTemplate = await this.GenerateBackendTemplateAsync(singleApiName, apiTemplate.TypedResources.GetAllPolicies(), namedValueTemplate.TypedResources.NamedValues, baseFilesGenerationDirectory);
-            await this.GenerateGroupsTemplateAsync(baseFilesGenerationDirectory);
+            var groupTemplate = await this.GenerateGroupsTemplateAsync(baseFilesGenerationDirectory);
             await this.GenerateGatewayTemplateAsync(singleApiName, baseFilesGenerationDirectory);
             await this.GenerateParametersTemplateAsync(apisToExtract, loggerTemplate.TypedResources, backendTemplate.TypedResources, namedValueTemplate.TypedResources, baseFilesGenerationDirectory);
 
@@ -888,7 +890,8 @@ await this.GenerateMasterTemplateAsync(
                 backendsTemplateResources: backendTemplate.TypedResources,
                 authorizationServersTemplateResources: authorizationServerTemplate.TypedResources,
                 namedValuesTemplateResources: namedValueTemplate.TypedResources,
-                tagTemplateResources: tagTemplate.TypedResources);
+                tagTemplateResources: tagTemplate.TypedResources,
+                groupTemplateResources: groupTemplate.TypedResources);
         }
 
 

src/ArmTemplates/Extractor/EntityExtractors/Abstractions/IMasterTemplateExtractor.cs

@@ -8,6 +8,7 @@
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.ApiVersionSet;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.AuthorizationServer;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.Backend;
+using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.Groups;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.Logger;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.Master;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.NamedValues;
@@ -34,6 +35,7 @@ Template<MasterTemplateResources> GenerateLinkedMasterTemplate(
            BackendTemplateResources backendsTemplateResources = null,
            AuthorizationServerTemplateResources authorizationServersTemplateResources = null,
            NamedValuesResources namedValuesTemplateResources = null,
-           TagTemplateResources tagTemplateResources = null);
+           TagTemplateResources tagTemplateResources = null,
+           GroupTemplateResources groupTemplateResources = null);
     }
 }

src/ArmTemplates/Extractor/EntityExtractors/MasterTemplateExtractor.cs

@@ -23,6 +23,7 @@
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.Logger;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.Backend;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.NamedValues;
+using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.Groups;
 
 namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates.Extractor.EntityExtractors
 {
@@ -51,7 +52,8 @@ public Template<MasterTemplateResources> GenerateLinkedMasterTemplate(
             BackendTemplateResources backendsTemplateResources = null,
             AuthorizationServerTemplateResources authorizationServersTemplateResources = null,
             NamedValuesResources namedValuesTemplateResources = null,
-            TagTemplateResources tagTemplateResources = null)
+            TagTemplateResources tagTemplateResources = null,
+            GroupTemplateResources groupTemplateResources = null)
         {
             var masterTemplate = this.templateBuilder
                                         .GenerateEmptyTemplate()
@@ -228,7 +230,18 @@ public Template<MasterTemplateResources> GenerateLinkedMasterTemplate(
 
                 masterResources.DeploymentResources.Add(apiTagsDeployment);
             }
-            
+
+            if (groupTemplateResources?.HasContent() == true)
+            {
+                this.logger.LogDebug("Adding groups to master template");
+                const string GroupsTemplate = "groupsTemplate";
+
+                var groupsUri = this.GenerateLinkedTemplateUri(fileNames.Groups, extractorParameters);
+                var groupsDeployment = CreateLinkedMasterTemplateResource(GroupsTemplate, groupsUri, Array.Empty<string>());
+
+                masterResources.DeploymentResources.Add(groupsDeployment);
+            }
+
             return masterTemplate;
         }
 

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

@@ -14,6 +14,7 @@
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Constants;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.Builders;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.Tags;
+using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.Groups;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Extractor.EntityExtractors;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Extractor.Models;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Tests.Extractor.Abstractions;
@@ -62,10 +63,30 @@ public async Task GenerateMasterTemplates_ProperlyLaysTheInformation()
                 }
             };
 
+            var groupTemplateResources = new GroupTemplateResources()
+            {
+                Groups = new()
+                {
+                    new GroupTemplateResource()
+                    {
+                        Name = "test-group",
+                        Properties = new() {
+                            DisplayName = "group-display-name",
+                            Description = "group-description",
+                            Type = "group-type",
+                            ExternalId = "group-external-id",
+                            BuiltIn = false
+                        }
+                    }
+                }
+            };
+
+
             // act
             var masterTemplate = await extractorExecutor.GenerateMasterTemplateAsync(
                 currentTestDirectory,
-                tagTemplateResources: tagTemplateResources);
+                tagTemplateResources: tagTemplateResources,
+                groupTemplateResources: groupTemplateResources);
 
             File.Exists(Path.Combine(currentTestDirectory, extractorParameters.FileNames.LinkedMaster)).Should().BeTrue();
 
@@ -80,13 +101,13 @@ public async Task GenerateMasterTemplates_ProperlyLaysTheInformation()
             masterTemplate.Parameters.Should().ContainKey(ParameterNames.NamedValueKeyVaultSecrets);
             masterTemplate.Parameters.Should().ContainKey(ParameterNames.BackendSettings);
 
-            masterTemplate.TypedResources.DeploymentResources.Should().HaveCount(1);
-            masterTemplate.Resources.Should().HaveCount(1);
-
-            var tagDeployment = masterTemplate.TypedResources.DeploymentResources.First();
+            masterTemplate.TypedResources.DeploymentResources.Should().HaveCount(2);
+            masterTemplate.Resources.Should().HaveCount(2);
 
-            tagDeployment.Type.Should().Be(ResourceTypeConstants.ArmDeployments);
-            tagDeployment.Properties.Should().NotBeNull();
+            foreach(var deploymentResource in masterTemplate.TypedResources.DeploymentResources) {
+                deploymentResource.Type.Should().Be(ResourceTypeConstants.ArmDeployments);
+                deploymentResource.Properties.Should().NotBeNull();
+            }
         }
     }
 }