Fix S.D.DS version rule on .NET 7.0

CHANGELOG.md

@@ -21,6 +21,9 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h
 
 ### Fixed
 
+- Fixed Rule checking System.Diagnostics.DiagnosticSource version for net7.0
+  failing on correct configuration [#2950](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/issues/2950).
+
 ### Security
 
 ## [1.0.0](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/tag/v1.0.0)

build/Build.Steps.cs

@@ -558,18 +558,17 @@ DotNetBuildSettings BuildTestApplication(DotNetBuildSettings x) =>
         .Executes(() =>
         {
             var netPath = TracerHomeDirectory / "net";
-            var ruleEngineJsonFilePath = netPath / "ruleEngine.json";
-            var ruleEngineJsonNugetFilePath = RootDirectory / "nuget" / "OpenTelemetry.AutoInstrumentation" / "contentFiles" / "any" / "any" / "RuleEngine.json";
-            var fileInfoList = new List<object>();
             var files = Directory.GetFiles(netPath);
+            var fileInfoList = new List<object>(files.Length);
 
             foreach (string file in files)
             {
                 var fileName = Path.GetFileNameWithoutExtension(file);
-                var fileVersion = FileVersionInfo.GetVersionInfo(file).FileVersion;
 
-                if (fileName.StartsWith("OpenTelemetry.") && !fileName.StartsWith("OpenTelemetry.Api") && !fileName.StartsWith("OpenTelemetry.AutoInstrumentation"))
+                if (fileName == "System.Diagnostics.DiagnosticSource" ||
+                    (fileName.StartsWith("OpenTelemetry.") && !fileName.StartsWith("OpenTelemetry.Api") && !fileName.StartsWith("OpenTelemetry.AutoInstrumentation")))
                 {
+                    var fileVersion = FileVersionInfo.GetVersionInfo(file).FileVersion;
                     fileInfoList.Add(new
                     {
                         FileName = fileName,
@@ -580,7 +579,11 @@ DotNetBuildSettings BuildTestApplication(DotNetBuildSettings x) =>
 
             JsonSerializerOptions options = new JsonSerializerOptions { WriteIndented = true };
             string jsonContent = JsonSerializer.Serialize(fileInfoList, options);
+
+            var ruleEngineJsonFilePath = netPath / "ruleEngine.json";
             File.WriteAllText(ruleEngineJsonFilePath, jsonContent);
+
+            var ruleEngineJsonNugetFilePath = RootDirectory / "nuget" / "OpenTelemetry.AutoInstrumentation" / "contentFiles" / "any" / "any" / "RuleEngine.json";
             File.Delete(ruleEngineJsonNugetFilePath);
             File.Copy(ruleEngineJsonFilePath, ruleEngineJsonNugetFilePath);
         });

src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/InstrumentationAssemblyRule.cs → src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/AssemblyFileVersionRule.cs

@@ -1,4 +1,4 @@
-// <copyright file="InstrumentationAssemblyRule.cs" company="OpenTelemetry Authors">
+// <copyright file="AssemblyFileVersionRule.cs" company="OpenTelemetry Authors">
 // Copyright The OpenTelemetry Authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,14 +21,14 @@
 
 namespace OpenTelemetry.AutoInstrumentation.RulesEngine;
 
-internal class InstrumentationAssemblyRule : Rule
+internal class AssemblyFileVersionRule : Rule
 {
     private static readonly IOtelLogger Logger = OtelLogging.GetLogger("StartupHook");
 
-    public InstrumentationAssemblyRule()
+    public AssemblyFileVersionRule()
     {
-        Name = "Instrumentation Assembly Validator";
-        Description = "Ensure that the version of the OpenTelemetry Instrumentation libraries is not older than the version used by Automatic Instrumentation.";
+        Name = "Assembly File Version Validator";
+        Description = "Ensure that the version of key assemblies is not older than the version used by Automatic Instrumentation.";
     }
 
     internal override bool Evaluate()
@@ -63,19 +63,19 @@ internal override bool Evaluate()
                     if (appInstrumentationFileVersion < autoInstrumentationFileVersion)
                     {
                         result = false;
-                        Logger.Error($"Rule Engine: Application has direct or indirect reference to older version of Instrumentation library {ruleFileInfo.FileName} - {ruleFileInfo.FileVersion}.");
+                        Logger.Error($"Rule Engine: Application has direct or indirect reference to older version of assembly {ruleFileInfo.FileName} - {ruleFileInfo.FileVersion}.");
                     }
                     else
                     {
-                        Logger.Information($"Rule Engine: Application has reference to Instrumentation library {ruleFileInfo.FileName} and loaded successfully.");
+                        Logger.Information($"Rule Engine: Application has reference to assembly {ruleFileInfo.FileName} and loaded successfully.");
                     }
                 }
             }
         }
         catch (Exception ex)
         {
             // Exception in rule evaluation should not impact the result of the rule.
-            Logger.Warning($"Rule Engine:Couldn't evaluate OpenTelemetry Instrumentation Evaluation. Exception: {ex}");
+            Logger.Warning($"Rule Engine: Couldn't evaluate assembly reference file version. Exception: {ex}");
         }
 
         return result;

src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/RuleEngine.cs

@@ -31,8 +31,7 @@ internal class RuleEngine
     private readonly List<Rule> _otherRules = new()
     {
         new OpenTelemetrySdkMinimumVersionRule(),
-        new DiagnosticSourceRule(),
-        new InstrumentationAssemblyRule(),
+        new AssemblyFileVersionRule(),
         new NativeProfilerDiagnosticsRule()
     };