Deduplicate and standarize reusable code into shared library: logging, file utils, etc.

[konrad-jamrozik]

A lot of our tools implement one-off abstractions, like logging or file system utilities. This leads to duplication and lack of consistency.

This work item is about building a case for deduplicating all such code into one reusable library per language, with initial focus on .NET. The benefits include less code to maintain and established conventions to follow.

.NET deduplication candidates

Below follows a list of candidate code to be deduplicated; if you find more, please add a comment in this issue, and I will incorporate it in this list!

• Per my chat with @benbp and @weshaggard, we should deduplicate our logging, by establishing logging conventions. For example, right now, some of our tools use Console.Out (e.g. CODEOWNERS interpreter), some of them use the .NET AddSimpleConsole (e.g. notification-creator), and we also have custom code like SimplerConsoleFormatter written by @hallipr (in the secret rotation tool).
• CodeOwnersParser.FileHelpers is a candidate for reuse.
• Azure.Sdk.Tools.SecretRotation.Configuration.PlanConfiguration.GetFileContents
• NUnit vs xUnit (NUnit!)
• Which command line tool to use. See discussion on Azure.Sdk.Tools.SecretRotation.Cli.csproj by @hallipr. Candidate: https://github.com/commandlineparser/commandline
• GetHashCode that supports enumerables: https://github.com/Azure/azure-sdk-tools/pull/5636
• Diff tool for git, etc. We have tons of implementations of it. (added 3/29/2023 during discussion about openapi-alps)

[weshaggard]

FYI @benbp

[benbp]

On the logging topic I've had a good experience with Serilog. It makes it easy to configure output formats and create nested property contexts.

[benbp]

Also to add to this list: we will benefit from standardizing our argument parsing library (so there is plenty of prior art to copy from or re-use when writing tools), whether that's CommandLineParser or the new System.CommandLine.