Add extractIdentityProvider Parameter (#783)

* Add extractIdentityProviderParameter, to extract identityProviders

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

Author: f-alizada

src/ArmTemplates/Commands/Configurations/ExtractorConsoleAppConfiguration.cs

@@ -103,6 +103,9 @@ public class ExtractorConsoleAppConfiguration
         [Option(longName: "extractSecrets", HelpText = "Extract secrets from the services if applies")]
         public string ExtractSecrets { get; set; }
 
+        [Option(longName: "extractIdentityProviders", HelpText = "Extract identity providers from the service if applies")]
+        public string ExtractIdentityProviders { get; set; }
+
         /// <summary>
         /// Api parameter properties for overriding Api OAuth2 scope or/and Service urloverride. Available via extractor-config file only.
         /// </summary>

src/ArmTemplates/Commands/Executors/ExtractorExecutor.cs

@@ -708,6 +708,12 @@ await FileWriter.SaveAsJsonAsync(
         /// <returns>generated identity provider template</returns>
         public async Task<Template<IdentityProviderResources>> GenerateIdentityProviderTemplateAsync(string baseFilesGenerationDirectory)
         {
+            if (!this.extractorParameters.ExtractIdentityProviders)
+            {
+                this.logger.LogInformation($"Skipping identityProvider extraction due to the setting parameter");
+                return Template<IdentityProviderResources>.Empty;
+            }
+
             this.logger.LogInformation("Started generation of identity provider template...");
 
             var identityProviderTemplate = await this.identityProviderExtractor.GenerateIdentityProvidersTemplateAsync(this.extractorParameters);

src/ArmTemplates/Common/Templates/Abstractions/Template.Generic.cs

@@ -36,5 +36,10 @@ public class Template<TTemplateResources> : Template
 
             return this.TypedResources.HasContent();
         }
+
+        public static Template<TTemplateResources> Empty => new Template<TTemplateResources>()
+        {
+            TypedResources = new TTemplateResources()
+        };
     }
 }

src/ArmTemplates/Extractor/Models/ExtractorParameters.cs

@@ -88,6 +88,8 @@ public record ExtractorParameters
 
         public bool ExtractSecrets { get; set; }
 
+        public bool ExtractIdentityProviders { get; set; }
+
         public Dictionary<string, ApiParameterProperty> ApiParameters { get; private set; }
 
         public ExtractorParameters(ExtractorConsoleAppConfiguration extractorConfig)
@@ -122,6 +124,7 @@ public ExtractorParameters(ExtractorConsoleAppConfiguration extractorConfig)
             this.ParameterizeServiceUrl = extractorConfig.ParamServiceUrl != null && extractorConfig.ParamServiceUrl.Equals("true", StringComparison.OrdinalIgnoreCase) || (extractorConfig.ApiParameters != null && extractorConfig.ApiParameters.Any(x => x.Value.ServiceUrl is not null));
             this.ParametrizeApiOauth2Scope = (extractorConfig.ParamApiOauth2Scope != null && extractorConfig.ParamApiOauth2Scope.Equals("true", StringComparison.OrdinalIgnoreCase)) || (extractorConfig.ApiParameters != null && extractorConfig.ApiParameters.Any(x => x.Value.Oauth2Scope is not null));
             this.ExtractSecrets = extractorConfig.ExtractSecrets != null && extractorConfig.ExtractSecrets.Equals("true", StringComparison.OrdinalIgnoreCase);
+            this.ExtractIdentityProviders = extractorConfig.ExtractIdentityProviders != null && extractorConfig.ExtractIdentityProviders.Equals("true", StringComparison.OrdinalIgnoreCase);
         }
 
         public ExtractorParameters OverrideConfiguration(ExtractorConsoleAppConfiguration overridingConfig)
@@ -155,6 +158,7 @@ public ExtractorParameters OverrideConfiguration(ExtractorConsoleAppConfiguratio
             this.IncludeAllRevisions = !string.IsNullOrEmpty(overridingConfig.IncludeAllRevisions) ? overridingConfig.IncludeAllRevisions.Equals("true", StringComparison.OrdinalIgnoreCase) : this.IncludeAllRevisions;
             this.ExtractGateways = !string.IsNullOrEmpty(overridingConfig.ExtractGateways) ? overridingConfig.ExtractGateways.Equals("true", StringComparison.OrdinalIgnoreCase) : this.ExtractGateways;
             this.ParametrizeApiOauth2Scope = !string.IsNullOrEmpty(overridingConfig.ParamApiOauth2Scope) ? overridingConfig.ParamApiOauth2Scope.Equals("true", StringComparison.OrdinalIgnoreCase) : this.ParametrizeApiOauth2Scope;
+            this.ExtractIdentityProviders = !string.IsNullOrEmpty(overridingConfig.ExtractIdentityProviders) ? overridingConfig.ExtractIdentityProviders.Equals("true", StringComparison.OrdinalIgnoreCase) : this.ExtractIdentityProviders;
 
             if (!string.IsNullOrEmpty(overridingConfig.BaseFileName))
             {

src/README.md

@@ -446,6 +446,7 @@ You have two choices when specifying your settings:
 | paramApiOauth2Scope | No | Set to true will parametrize the scope values for APIs in which User authorization setting set to OAuth 2.0. |
 | apiParameters  | No                    | Parameterize api parameters (Oauth2 Scope/Service Url) values for APIs in advance.  |
 | exctractSecrets  | No                    | By default false. If set to "true" secrets will be extracted as well and parameters templated will be supplied with actual secret values. Currently applies to identityProvider service.  |
+| extractIdentityProviders | No | By default false. Set to true will attempt to extract the identity providers from service. |
 
 
 #### Note

tests/ArmTemplates.Tests/Extractor/Abstractions/ExtractorMockerTestsBase.cs

@@ -111,7 +111,8 @@ protected ExtractorConsoleAppConfiguration GetDefaultExtractorConsoleAppConfigur
                string overrideProductGuids = null,
                string paramApiOauth2Scope = null,
                Dictionary<string, ApiParameterProperty> apiParameters = null,
-               string extractSecrets = null
+               string extractSecrets = null,
+               string extractIdentityProviders = null
          )
         {
 
@@ -146,7 +147,8 @@ protected ExtractorConsoleAppConfiguration GetDefaultExtractorConsoleAppConfigur
                 OverrideProductGuids = overrideProductGuids,
                 ParamApiOauth2Scope = paramApiOauth2Scope,
                 ApiParameters = apiParameters,
-                ExtractSecrets = extractSecrets
+                ExtractSecrets = extractSecrets,
+                ExtractIdentityProviders = extractIdentityProviders
             };
         }
     }

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

@@ -32,7 +32,8 @@ public async Task GenerateIdentityProviderTemplates_ProperlyLaysTheInformation()
             // arrange
             var currentTestDirectory = Path.Combine(this.OutputDirectory, nameof(GenerateIdentityProviderTemplates_ProperlyLaysTheInformation));
 
-            var extractorConfig = this.GetDefaultExtractorConsoleAppConfiguration();
+            var extractorConfig = this.GetDefaultExtractorConsoleAppConfiguration(
+                extractIdentityProviders: "true");
             var extractorParameters = new ExtractorParameters(extractorConfig);
 
             var identityProviderNames = new List<string>()