Handle duplicate key error in LoggerExtractor (#741)

f-alizada · Farhad Alizada · web-flow · commit 8f01a5ec0b42 · 2022-06-08T11:24:20.000+02:00
* Handle duplicate key error in LoggerExtractor

Co-authored-by: Farhad Alizada &lt;falizada@microsoft.com&gt;
diff --git a/src/ArmTemplates/Extractor/EntityExtractors/LoggerExtractor.cs b/src/ArmTemplates/Extractor/EntityExtractors/LoggerExtractor.cs
@@ -148,9 +148,11 @@ async Task LoadAllReferencedLoggers(
 
                 if (!diagnosticLoggerBindings.IsNullOrEmpty())
                 {
-                    this.Cache.ApiDiagnosticLoggerBindings.Add(
-                        NamingHelper.GenerateValidParameterName(curApiName, ParameterPrefix.Api), 
-                        diagnosticLoggerBindings);
+                    var diagnosticLoggerKey = NamingHelper.GenerateValidParameterName(curApiName, ParameterPrefix.Api);
+                    if (!this.Cache.ApiDiagnosticLoggerBindings.ContainsKey(diagnosticLoggerKey))
+                    {
+                        this.Cache.ApiDiagnosticLoggerBindings.Add(diagnosticLoggerKey, diagnosticLoggerBindings);
+                    }
                 }
             }
         }
diff --git a/tests/ArmTemplates.Tests/Extractor/Scenarios/LoggerExtractorTests.cs b/tests/ArmTemplates.Tests/Extractor/Scenarios/LoggerExtractorTests.cs
@@ -10,7 +10,9 @@
 using FluentAssertions;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Commands.Executors;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Constants;
+using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Extensions;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.Builders;
+using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.Logger.Cache;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.Policy;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Extractor.EntityExtractors;
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Extractor.Models;
@@ -70,5 +72,64 @@ public async Task GenerateLoggersTemplates_ProperlyLaysTheInformation()
             loggerTemplate.TypedResources.Loggers.First().Name.Should().Contain(MockLoggerClient.LoggerName);
             loggerTemplate.TypedResources.Loggers.First().Properties.LoggerType.Should().Be(MockDiagnosticClient.DefaultDiagnosticName);
         }
+
+        [Fact]
+        public async Task GenerateLoggersTemplates_ShouldPopulateCacheWithoutError_GivenItCalledMultipleTimes()
+        {
+            // arrange
+            var extractorConfig = this.GetDefaultExtractorConsoleAppConfiguration(
+                splitAPIs: "true",
+                paramApiLoggerId: "true",
+                apiName: string.Empty);
+            var extractorParameters = new ExtractorParameters(extractorConfig);
+
+            var mockedDiagnosticClient = MockDiagnosticClient.GetMockedApiClientWithDefaultValues();
+            var mockedLoggerClient = MockLoggerClient.GetMockedClientWithDiagnosticDependentValues();
+            var loggerExtractor = new LoggerExtractor(
+                this.GetTestLogger<LoggerExtractor>(),
+                new TemplateBuilder(),
+                mockedLoggerClient,
+                mockedDiagnosticClient);
+
+            var apisToTest = new List<string>() {
+                "echo-api",
+                "echo-api-2"
+            };
+
+            var diagnosticLoggerBinding = new DiagnosticLoggerBinding
+            {
+                DiagnosticName = NamingHelper.GenerateValidParameterName(MockDiagnosticClient.DefaultDiagnosticName, ParameterPrefix.Diagnostic),
+                LoggerId = MockDiagnosticClient.LoggerIdValue
+            };
+
+            var expectedApiDiagnosticLoggerBingingsValues = new Dictionary<string, ISet<DiagnosticLoggerBinding>>()
+            {
+                { 
+                    NamingHelper.GenerateValidParameterName("echo-api", ParameterPrefix.Api), 
+                    new HashSet<DiagnosticLoggerBinding>() { diagnosticLoggerBinding }  
+                },
+                { 
+                    NamingHelper.GenerateValidParameterName("echo-api-2", ParameterPrefix.Api),
+                    new HashSet<DiagnosticLoggerBinding>() { diagnosticLoggerBinding } 
+                }
+            };
+
+            // act
+            await loggerExtractor.GenerateLoggerTemplateAsync(apisToTest, null, extractorParameters);
+            foreach(var api in apisToTest)
+            {
+                await loggerExtractor.GenerateLoggerTemplateAsync(new List<string>() { api }, null, extractorParameters);
+            }
+
+            // assert
+            loggerExtractor.Cache.ServiceLevelDiagnosticLoggerBindings.Count.Should().Be(1);
+            loggerExtractor.Cache.ApiDiagnosticLoggerBindings.Count.Should().Be(2);
+            
+            foreach (var (apiName, diagnosticLoggerBindings) in expectedApiDiagnosticLoggerBingingsValues)
+            {
+                loggerExtractor.Cache.ApiDiagnosticLoggerBindings[apiName].Count.Should().Be(1);
+                loggerExtractor.Cache.ApiDiagnosticLoggerBindings[apiName].First().Equals(diagnosticLoggerBindings.First()).Should().BeTrue();
+            }
+        }
     }
 }
diff --git a/tests/ArmTemplates.Tests/Moqs/ApiClients/MockDiagnosticClient.cs b/tests/ArmTemplates.Tests/Moqs/ApiClients/MockDiagnosticClient.cs
@@ -15,6 +15,7 @@ public class MockDiagnosticClient
     {
         public const string DiagnosticName = "diagnostic";
         public const string DefaultDiagnosticName = "default-diagnostic";
+        public const string LoggerIdValue = "logger-id";
 
         public static IDiagnosticClient GetMockedClientWithApiDependentValues()
         {
@@ -29,7 +30,7 @@ public static IDiagnosticClient GetMockedClientWithApiDependentValues()
                         Name = DiagnosticName,
                         Properties = new DiagnosticTemplateProperties()
                         {
-                            LoggerId = "logger-id"
+                            LoggerId = LoggerIdValue
                         }
                     }
                 });
@@ -43,7 +44,7 @@ public static IDiagnosticClient GetMockedClientWithApiDependentValues()
                         Name = $"{apiName}-{DiagnosticName}",
                         Properties = new DiagnosticTemplateProperties()
                         {
-                            LoggerId = "logger-id"
+                            LoggerId = LoggerIdValue
                         }
                     }
                 });
@@ -64,7 +65,7 @@ public static IDiagnosticClient GetMockedApiClientWithDefaultValues()
                         Name = DefaultDiagnosticName,
                         Properties = new DiagnosticTemplateProperties()
                         {
-                            LoggerId = "logger-id"
+                            LoggerId = LoggerIdValue
                         }
                     }
                 });
@@ -78,7 +79,7 @@ public static IDiagnosticClient GetMockedApiClientWithDefaultValues()
                         Name = DefaultDiagnosticName,
                         Properties = new DiagnosticTemplateProperties()
                         {
-                            LoggerId = "logger-id"
+                            LoggerId = LoggerIdValue
                         }
                     }
                 });

Original file line number	Diff line number	Diff line change
`@@ -148,9 +148,11 @@ async Task LoadAllReferencedLoggers(`
`148`	`148`
`149`	`149`	`if (!diagnosticLoggerBindings.IsNullOrEmpty())`
`150`	`150`	`{`
`151`		`- this.Cache.ApiDiagnosticLoggerBindings.Add(`
`152`		`- NamingHelper.GenerateValidParameterName(curApiName, ParameterPrefix.Api),`
`153`		`- diagnosticLoggerBindings);`
	`151`	`+ var diagnosticLoggerKey = NamingHelper.GenerateValidParameterName(curApiName, ParameterPrefix.Api);`
	`152`	`+ if (!this.Cache.ApiDiagnosticLoggerBindings.ContainsKey(diagnosticLoggerKey))`
	`153`	`+ {`
	`154`	`+ this.Cache.ApiDiagnosticLoggerBindings.Add(diagnosticLoggerKey, diagnosticLoggerBindings);`
	`155`	`+ }`
`154`	`156`	`}`
`155`	`157`	`}`
`156`	`158`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ public class MockDiagnosticClient`
`15`	`15`	`{`
`16`	`16`	`public const string DiagnosticName = "diagnostic";`
`17`	`17`	`public const string DefaultDiagnosticName = "default-diagnostic";`
	`18`	`+ public const string LoggerIdValue = "logger-id";`
`18`	`19`
`19`	`20`	`public static IDiagnosticClient GetMockedClientWithApiDependentValues()`
`20`	`21`	`{`
`@@ -29,7 +30,7 @@ public static IDiagnosticClient GetMockedClientWithApiDependentValues()`
`29`	`30`	`Name = DiagnosticName,`
`30`	`31`	`Properties = new DiagnosticTemplateProperties()`
`31`	`32`	`{`
`32`		`- LoggerId = "logger-id"`
	`33`	`+ LoggerId = LoggerIdValue`
`33`	`34`	`}`
`34`	`35`	`}`
`35`	`36`	`});`
`@@ -43,7 +44,7 @@ public static IDiagnosticClient GetMockedClientWithApiDependentValues()`
`43`	`44`	`Name = $"{apiName}-{DiagnosticName}",`
`44`	`45`	`Properties = new DiagnosticTemplateProperties()`
`45`	`46`	`{`
`46`		`- LoggerId = "logger-id"`
	`47`	`+ LoggerId = LoggerIdValue`
`47`	`48`	`}`
`48`	`49`	`}`
`49`	`50`	`});`
`@@ -64,7 +65,7 @@ public static IDiagnosticClient GetMockedApiClientWithDefaultValues()`
`64`	`65`	`Name = DefaultDiagnosticName,`
`65`	`66`	`Properties = new DiagnosticTemplateProperties()`
`66`	`67`	`{`
`67`		`- LoggerId = "logger-id"`
	`68`	`+ LoggerId = LoggerIdValue`
`68`	`69`	`}`
`69`	`70`	`}`
`70`	`71`	`});`
`@@ -78,7 +79,7 @@ public static IDiagnosticClient GetMockedApiClientWithDefaultValues()`
`78`	`79`	`Name = DefaultDiagnosticName,`
`79`	`80`	`Properties = new DiagnosticTemplateProperties()`
`80`	`81`	`{`
`81`		`- LoggerId = "logger-id"`
	`82`	`+ LoggerId = LoggerIdValue`
`82`	`83`	`}`
`83`	`84`	`}`
`84`	`85`	`});`