Add CA1872: Prefer 'Convert.ToHexString' over 'BitConverter.ToString'

[mpidash]

Fixes dotnet/runtime#81796.

This analyzer detects the usage of the pattern BitConverter.ToString(bytes).Replace("-", "") to convert an array of bytes to an uppercase hex string (without hyphens in between) and replaces it with a call to Convert.ToHexString(bytes).
The analyzer will also try to preserve chaining ToLower* in between (before and after string.Replace) for a lowercase hex string.

I have found 2 warnings in dotnet/runtime, 1 warning in dotnet/roslyn and no warnings in dotnet/aspnetcore and dotnet/roslyn-analyzers:

1. runtime\src\coreclr\tools\aot\ILCompiler.Compiler\Compiler\XmlObjectDumper.cs(73,20): info CA1872: Prefer 'System.Convert.ToHexString(byte[])' over 'System.BitConverter.ToString(byte[])'
2. runtime\src\coreclr\tools\Common\Compiler\NativeAotNameMangler.cs(125,38): warning CA1872: Prefer 'System.Convert.ToHexString(byte[])' over 'System.BitConverter.ToString(byte[])'
3. roslyn\src\Tools\BuildValidator\CompilationDiff.cs(404,46): info CA1872: Prefer 'System.Convert.ToHexString(byte[])' over 'System.BitConverter.ToString(byte[])

[codecov]

Codecov Report

Attention: Patch coverage is 98.25386% with 26 lines in your changes are missing coverage. Please review.

Project coverage is 96.47%. Comparing base (de3a920) to head (f3fee4a).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6967      +/-   ##
==========================================
- Coverage   96.47%   96.47%   -0.01%     
==========================================
  Files        1436     1439       +3     
  Lines      342881   344370    +1489     
  Branches    11292    11324      +32     
==========================================
+ Hits       330797   332230    +1433     
- Misses       9230     9272      +42     
- Partials     2854     2868      +14     

[mpidash]

@buyaa-n I've addressed your feedback and also tried to improve the messages, PTAL 😸.

Here are the findings with the new message template:

W:\roslyn\src\Tools\BuildValidator\CompilationDiff.cs(404,46): info CA1872: Prefer 'System.Convert.ToHexString(byte[])' over call chains based on 'System.BitConverter.ToString(byte[])'

W:\runtime\src\coreclr\tools\Common\Compiler\NativeAotNameMangler.cs(111,38): warning CA1872: Prefer 'System.Convert.ToHexString(byte[])' over call chains based on 'System.BitConverter.ToString(byte[])' (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1872) [W:\runtime\src\coreclr\tools\aot\ILCompiler.Compiler\ILCompiler.Compiler.csproj]
W:\runtime\src\coreclr\tools\aot\ILCompiler.Compiler\Compiler\XmlObjectDumper.cs(73,20): warning CA1872: Prefer 'System.Convert.ToHexStringLower(byte[])' over call chains based on 'System.BitConverter.ToString(byte[])' (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1872) [W:\runtime\src\coreclr\tools\aot\ILCompiler.Compiler\ILCompiler.Compiler.csproj]
W:\runtime\src\libraries\System.Private.Xml\tests\XmlNodeReader\System.Xml.XmlNodeReader.Tests\XmlNodeReaderReadTests.cs(183,41): warning CA1872: Prefer 'System.Convert.ToHexString(byte[])' over call chains based on 'System.BitConverter.ToString(byte[])' (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1872) [W:\runtime\src\libraries\System.Private.Xml\tests\System.Private.Xml.Tests.csproj]
W:\runtime\src\libraries\System.Private.Xml\tests\XmlNodeReader\System.Xml.XmlNodeReader.Tests\XmlNodeReaderReadTests.cs(233,46): warning CA1872: Prefer 'System.Convert.ToHexString(byte[])' over call chains based on 'System.BitConverter.ToString(byte[])' (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1872) [W:\runtime\src\libraries\System.Private.Xml\tests\System.Private.Xml.Tests.csproj]

And an example of an applied code fix:

@gewarren: It would be great if you could also take a look at the resource strings, thanks!

[gewarren]

I left some feedback on the resource strings. Thanks for tagging me!

[buyaa-n]

@buyaa-n I've addressed your feedback and also tried to improve the messages, PTAL 😸.

Thank you @mpidash, the messages and test coverage look great to me, functional testing worked well too, this time I looked into the code more and left few more feedback.

[mpidash]

Thanks for the review @buyaa-n! I've addressed your feedback, PTAL.

[buyaa-n]

Thank you @mpidash, LGTM.

It's good to go after the #6967 (comment) done