fix(PH2155): Address review feedback - update documentation examples, fix duplicate code, add constants for literals, and rename cache file

Co-authored-by: bcollamore <57269455+bcollamore@users.noreply.github.com>

Author: Copilot

Documentation/Diagnostics/PH2155.md

@@ -214,9 +214,9 @@ For packages that are not automatically accepted, use the secure combined format
 ```text
 # Allowed.Licenses.txt - Combined format examples
 # Combined package + license entries for packages not automatically accepted
-Newtonsoft.Json MIT
-Microsoft.EntityFrameworkCore Apache-2.0
-SomeCommercialPackage CommercialLicense-2024
+SomeThirdPartyPackage Custom-License-v2
+MyCompany.PrivateLibrary Proprietary
+CommercialTool CommercialLicense-2024
 OldLegacyPackage LICENSE.txt
 
 # Examples for different license sources:

Philips.CodeAnalysis.SecurityAnalyzers/LicenseAnalyzer.cs

@@ -34,8 +34,9 @@ public class LicenseAnalyzer : DiagnosticAnalyzer
 										   @"reviewed before use to ensure compliance with project requirements.";
 
 		public const string AllowedLicensesFileName = @"Allowed.Licenses.txt";
-		public const string LicensesCacheFileName = @"licenses.cache";
+		public const string LicensesCacheFileName = @"ph2155_licenses.cache";
 		private const string ProjectAssetsFileName = @"project.assets.json";
+		private const string UnknownValue = "unknown";
 
 		// Default acceptable licenses (permissive licenses)
 		private static readonly HashSet<string> DefaultAcceptableLicenses =
@@ -89,20 +90,14 @@ public override void Initialize(AnalysisContext context)
 		private void ReportDebugDiagnostic(CompilationAnalysisContext context, string message)
 		{
 			var helper = new Helper(context.Options, context.Compilation);
-			if (helper.ForAdditionalFiles.IsDebugLoggingEnabled("PH2155"))
+			var shouldReport = helper.ForAdditionalFiles.IsDebugLoggingEnabled("PH2155") ||
+				message.Contains("License = ") || message.Contains("not acceptable") || message.Contains("acceptable");
+
+			if (shouldReport)
 			{
 				var diagnostic = Diagnostic.Create(DebugDiagnostic, Location.None, message);
 				context.ReportDiagnostic(diagnostic);
 			}
-			else
-			{
-				// Always show critical debugging information for troubleshooting license issues
-				if (message.Contains("License = ") || message.Contains("not acceptable") || message.Contains("acceptable"))
-				{
-					var diagnostic = Diagnostic.Create(DebugDiagnostic, Location.None, message);
-					context.ReportDiagnostic(diagnostic);
-				}
-			}
 		}
 
 		private void AnalyzeProject(CompilationAnalysisContext context)
@@ -173,26 +168,26 @@ private void AnalyzePackagesFromAssetsFile(CompilationAnalysisContext context, H
 				var license = licenseInfo?.License;
 				var projectUrl = licenseInfo?.ProjectUrl;
 
-				var displayLicense = string.IsNullOrEmpty(license) ? "unknown" : license;
+				var displayLicense = string.IsNullOrEmpty(license) ? UnknownValue : license;
 				var displayProjectUrl = string.IsNullOrEmpty(projectUrl) ? "none" : projectUrl;
 
-				ReportDebugDiagnostic(context, $"Package {package.Name} {package.Version ?? "unknown"}: License = {displayLicense}, ProjectUrl = {displayProjectUrl}");
+				ReportDebugDiagnostic(context, $"Package {package.Name} {package.Version ?? UnknownValue}: License = {displayLicense}, ProjectUrl = {displayProjectUrl}");
 
 				if (!string.IsNullOrEmpty(license) && !IsLicenseAcceptable(context, license, package.Name, allowedLicenses))
 				{
-					ReportDebugDiagnostic(context, $"Package {package.Name} {package.Version ?? "unknown"}: License '{license}' is NOT acceptable - triggering finding");
+					ReportDebugDiagnostic(context, $"Package {package.Name} {package.Version ?? UnknownValue}: License '{license}' is NOT acceptable - triggering finding");
 					var diagnostic = Diagnostic.Create(
 						Rule,
 						Location.None,
 						package.Name,
-						package.Version ?? "unknown",
+						package.Version ?? UnknownValue,
 						license);
 
 					context.ReportDiagnostic(diagnostic);
 				}
 				else if (!string.IsNullOrEmpty(license))
 				{
-					ReportDebugDiagnostic(context, $"Package {package.Name} {package.Version ?? "unknown"}: License '{license}' is acceptable - no finding");
+					ReportDebugDiagnostic(context, $"Package {package.Name} {package.Version ?? UnknownValue}: License '{license}' is acceptable - no finding");
 				}
 			}
 

Philips.CodeAnalysis.Test/Security/LicenseAnalyzerTest.cs

@@ -420,11 +420,12 @@ public void LicenseAnalyzerMessageFormatIsWellFormed()
 		[TestCategory(TestDefinitions.UnitTests)]
 		public void LicenseAnalyzerCacheFileNameConstant()
 		{
-			// Verify the cache file name constant has a proper value
+			// Verify the cache file name constant has a proper value with PH2155 prefix
 			var fileName = LicenseAnalyzer.LicensesCacheFileName;
 			Assert.IsFalse(string.IsNullOrEmpty(fileName));
 			Assert.EndsWith(".cache", fileName);
-			Assert.AreEqual("licenses.cache", fileName);
+			Assert.AreEqual("ph2155_licenses.cache", fileName);
+			Assert.StartsWith("ph2155_", fileName);
 		}
 
 		[TestMethod]