Issue2394 multiple markdown exporters not possible even with different names (#2395)

bstordrup · web-flow · commit d058c7b6ff24 · 2023-08-10T11:40:23.000+02:00
* Merge exporters by exporter.Name instead of exporter.GetType()

* Added test that MarkdownExporter.GitHub and MarkdownExporter.Atlassian are both accepted in the merged configuration
diff --git a/src/BenchmarkDotNet/Configs/ImmutableConfigBuilder.cs b/src/BenchmarkDotNet/Configs/ImmutableConfigBuilder.cs
@@ -109,28 +109,28 @@ void AddWarning(string message)
                 configAnalyse.Add(conclusion);
             }
 
-            var mergeDictionary = new Dictionary<System.Type, IExporter>();
+            var mergeDictionary = new Dictionary<string, IExporter>();
 
             foreach (var exporter in exporters)
             {
-                var exporterType = exporter.GetType();
-                if (mergeDictionary.ContainsKey(exporterType))
+                var exporterName = exporter.Name;
+                if (mergeDictionary.ContainsKey(exporterName))
                 {
-                    AddWarning($"The exporter {exporterType} is already present in configuration. There may be unexpected results.");
+                    AddWarning($"The exporter {exporterName} is already present in configuration. There may be unexpected results.");
                 }
-                mergeDictionary[exporterType] = exporter;
+                mergeDictionary[exporterName] = exporter;
             }
 
 
             foreach (var diagnoser in uniqueDiagnosers)
                 foreach (var exporter in diagnoser.Exporters)
                 {
-                    var exporterType = exporter.GetType();
-                    if (mergeDictionary.ContainsKey(exporterType))
+                    var exporterName = exporter.Name;
+                    if (mergeDictionary.ContainsKey(exporterName))
                     {
-                        AddWarning($"The exporter {exporterType} of {diagnoser.GetType().Name} is already present in configuration. There may be unexpected results.");
+                        AddWarning($"The exporter {exporterName} of {diagnoser.GetType().Name} is already present in configuration. There may be unexpected results.");
                     }
-                    mergeDictionary[exporterType] = exporter;
+                    mergeDictionary[exporterName] = exporter;
                 }
 
             var result = mergeDictionary.Values.ToList();
@@ -143,7 +143,7 @@ void AddWarning(string message)
             if (hardwareCounterDiagnoser != default(IHardwareCountersDiagnoser) && disassemblyDiagnoser != default(DisassemblyDiagnoser))
                 result.Add(new InstructionPointerExporter(hardwareCounterDiagnoser, disassemblyDiagnoser));
 
-            for (int i = result.Count - 1; i >=0; i--)
+            for (int i = result.Count - 1; i >= 0; i--)
                 if (result[i] is IExporterDependencies exporterDependencies)
                     foreach (var dependency in exporterDependencies.Dependencies)
                         /*
@@ -165,7 +165,7 @@ void AddWarning(string message)
                          *  "The CsvMeasurementsExporter is already present in the configuration. There may be unexpected results of RPlotExporter.
                          *
                          */
-                        if (!result.Any(exporter=> exporter.GetType() == dependency.GetType()))
+                        if (!result.Any(exporter => exporter.GetType() == dependency.GetType()))
                             result.Insert(i, dependency); // All the exporter dependencies should be added before the exporter
                         else
                         {
@@ -186,9 +186,9 @@ private static ImmutableHashSet<IAnalyser> GetAnalysers(IEnumerable<IAnalyser> a
                     builder.Add(analyser);
 
             foreach (var diagnoser in uniqueDiagnosers)
-            foreach (var analyser in diagnoser.Analysers)
-                if (!builder.Contains(analyser))
-                    builder.Add(analyser);
+                foreach (var analyser in diagnoser.Analysers)
+                    if (!builder.Contains(analyser))
+                        builder.Add(analyser);
 
             return builder.ToImmutable();
         }
diff --git a/tests/BenchmarkDotNet.Tests/Configs/ImmutableConfigTests.cs b/tests/BenchmarkDotNet.Tests/Configs/ImmutableConfigTests.cs
@@ -143,6 +143,19 @@ public void DuplicateExportersAreExcluded()
             Assert.Same(MarkdownExporter.GitHub, final.GetExporters().Single());
         }
 
+        [Fact]
+        public void MultipleExportersOfSameTypeWithDifferentNamesAreAccepted()
+        {
+            var mutable = ManualConfig.CreateEmpty();
+
+            mutable.AddExporter(MarkdownExporter.GitHub);
+            mutable.AddExporter(MarkdownExporter.Atlassian);
+
+            var final = ImmutableConfigBuilder.Create(mutable);
+
+            Assert.Equal(2, final.GetExporters().Count());
+        }
+
         [Fact]
         public void DuplicateAnalyzersAreExcluded()
         {
@@ -380,7 +393,7 @@ private static ImmutableConfig[] AddLeftToTheRightAndRightToTheLef(ManualConfig
             var leftAddedToTheRight = ManualConfig.Create(right);
             leftAddedToTheRight.Add(left);
 
-            return new[]{ rightAddedToLeft.CreateImmutableConfig(), leftAddedToTheRight.CreateImmutableConfig() };
+            return new[] { rightAddedToLeft.CreateImmutableConfig(), leftAddedToTheRight.CreateImmutableConfig() };
         }
 
         public class TestExporter : IExporter, IExporterDependencies

Original file line number	Diff line number	Diff line change
`@@ -109,28 +109,28 @@ void AddWarning(string message)`
`109`	`109`	`configAnalyse.Add(conclusion);`
`110`	`110`	`}`
`111`	`111`
`112`		`- var mergeDictionary = new Dictionary<System.Type, IExporter>();`
	`112`	`+ var mergeDictionary = new Dictionary<string, IExporter>();`
`113`	`113`
`114`	`114`	`foreach (var exporter in exporters)`
`115`	`115`	`{`
`116`		`- var exporterType = exporter.GetType();`
`117`		`- if (mergeDictionary.ContainsKey(exporterType))`
	`116`	`+ var exporterName = exporter.Name;`
	`117`	`+ if (mergeDictionary.ContainsKey(exporterName))`
`118`	`118`	`{`
`119`		`- AddWarning($"The exporter {exporterType} is already present in configuration. There may be unexpected results.");`
	`119`	`+ AddWarning($"The exporter {exporterName} is already present in configuration. There may be unexpected results.");`
`120`	`120`	`}`
`121`		`- mergeDictionary[exporterType] = exporter;`
	`121`	`+ mergeDictionary[exporterName] = exporter;`
`122`	`122`	`}`
`123`	`123`
`124`	`124`
`125`	`125`	`foreach (var diagnoser in uniqueDiagnosers)`
`126`	`126`	`foreach (var exporter in diagnoser.Exporters)`
`127`	`127`	`{`
`128`		`- var exporterType = exporter.GetType();`
`129`		`- if (mergeDictionary.ContainsKey(exporterType))`
	`128`	`+ var exporterName = exporter.Name;`
	`129`	`+ if (mergeDictionary.ContainsKey(exporterName))`
`130`	`130`	`{`
`131`		`- AddWarning($"The exporter {exporterType} of {diagnoser.GetType().Name} is already present in configuration. There may be unexpected results.");`
	`131`	`+ AddWarning($"The exporter {exporterName} of {diagnoser.GetType().Name} is already present in configuration. There may be unexpected results.");`
`132`	`132`	`}`
`133`		`- mergeDictionary[exporterType] = exporter;`
	`133`	`+ mergeDictionary[exporterName] = exporter;`
`134`	`134`	`}`
`135`	`135`
`136`	`136`	`var result = mergeDictionary.Values.ToList();`
`@@ -143,7 +143,7 @@ void AddWarning(string message)`
`143`	`143`	`if (hardwareCounterDiagnoser != default(IHardwareCountersDiagnoser) && disassemblyDiagnoser != default(DisassemblyDiagnoser))`
`144`	`144`	`result.Add(new InstructionPointerExporter(hardwareCounterDiagnoser, disassemblyDiagnoser));`
`145`	`145`
`146`		`- for (int i = result.Count - 1; i >=0; i--)`
	`146`	`+ for (int i = result.Count - 1; i >= 0; i--)`
`147`	`147`	`if (result[i] is IExporterDependencies exporterDependencies)`
`148`	`148`	`foreach (var dependency in exporterDependencies.Dependencies)`
`149`	`149`	`/*`
`@@ -165,7 +165,7 @@ void AddWarning(string message)`
`165`	`165`	`* "The CsvMeasurementsExporter is already present in the configuration. There may be unexpected results of RPlotExporter.`
`166`	`166`	`*`
`167`	`167`	`*/`
`168`		`- if (!result.Any(exporter=> exporter.GetType() == dependency.GetType()))`
	`168`	`+ if (!result.Any(exporter => exporter.GetType() == dependency.GetType()))`
`169`	`169`	`result.Insert(i, dependency); // All the exporter dependencies should be added before the exporter`
`170`	`170`	`else`
`171`	`171`	`{`
`@@ -186,9 +186,9 @@ private static ImmutableHashSet<IAnalyser> GetAnalysers(IEnumerable<IAnalyser> a`
`186`	`186`	`builder.Add(analyser);`
`187`	`187`
`188`	`188`	`foreach (var diagnoser in uniqueDiagnosers)`
`189`		`- foreach (var analyser in diagnoser.Analysers)`
`190`		`- if (!builder.Contains(analyser))`
`191`		`- builder.Add(analyser);`
	`189`	`+ foreach (var analyser in diagnoser.Analysers)`
	`190`	`+ if (!builder.Contains(analyser))`
	`191`	`+ builder.Add(analyser);`
`192`	`192`
`193`	`193`	`return builder.ToImmutable();`
`194`	`194`	`}`