Initial infrastructure for code cleanup

src/Credfeto.DotNet.Repo.Tools.CleanUp.Tests/Services/ProjectXmlRewriterTests.cs

@@ -0,0 +1,250 @@
+using System.Diagnostics.CodeAnalysis;
+using System.IO;
+using System.Threading.Tasks;
+using System.Xml;
+using Credfeto.DotNet.Repo.Tools.CleanUp.Services;
+using FunFair.Test.Common;
+using Xunit;
+
+namespace Credfeto.DotNet.Repo.Tools.CleanUp.Tests.Services;
+
+[SuppressMessage(category: "Meziantou.Analyzer", checkId: "MA0051: Method is too long", Justification = "Unit tests")]
+public sealed class ProjectXmlRewriterTests : TestBase
+{
+    private readonly IProjectXmlRewriter _projectXmlRewriter;
+
+    public ProjectXmlRewriterTests()
+    {
+        this._projectXmlRewriter = new ProjectXmlRewriter();
+    }
+
+    [Fact]
+    public Task ReOrderPropertieShouldNotChangeAnythingsAsync()
+    {
+        const string originalXml = @"<Project Sdk=""Microsoft.NET.Sdk"">
+  <PropertyGroup>
+    <DisableImplicitNuGetFallbackFolder>true</DisableImplicitNuGetFallbackFolder>
+    <EnablePackageValidation>true</EnablePackageValidation>
+    <EnableTrimAnalyzer>false</EnableTrimAnalyzer>
+    <Features>strict;flow-analysis</Features>
+    <GenerateNeutralResourcesLanguageAttribute>true</GenerateNeutralResourcesLanguageAttribute>
+    <ImplicitUsings>disable</ImplicitUsings>
+    <IncludeOpenAPIAnalyzers>true</IncludeOpenAPIAnalyzers>
+    <IsPackable>true</IsPackable>
+    <IsPublishable>false</IsPublishable>
+    <IsTrimmable>false</IsTrimmable>
+    <LangVersion>latest</LangVersion>
+    <NoWarn />
+    <Nullable>enable</Nullable>
+    <OutputType>Library</OutputType>
+    <RunAOTCompilation>false</RunAOTCompilation>
+    <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
+    <TieredCompilation>true</TieredCompilation>
+    <TreatSpecificWarningsAsErrors />
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <WarningsAsErrors />
+    <EnableMicrosoftExtensionsConfigurationBinderSourceGenerator>true</EnableMicrosoftExtensionsConfigurationBinderSourceGenerator>
+    <JsonSerializerIsReflectionEnabledByDefault>false</JsonSerializerIsReflectionEnabledByDefault>
+    <OptimizationPreference>speed</OptimizationPreference>
+    <IsTrimmable>true</IsTrimmable>
+    <EnableTrimAnalyzer>true</EnableTrimAnalyzer>
+    <!-- Dotnet 7 features -->
+    <TieredPGO>true</TieredPGO>
+    <UseSystemResourceKeys>true</UseSystemResourceKeys>
+    <IlcOptimizationPreference>Size</IlcOptimizationPreference>
+    <IlcGenerateStackTraceData>false</IlcGenerateStackTraceData>
+    <DebuggerSupport>true</DebuggerSupport>
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <NuGetAudit>true</NuGetAudit>
+  </PropertyGroup>
+  <PropertyGroup>
+    <AnalysisLevel>latest</AnalysisLevel>
+    <AnalysisMode>AllEnabledByDefault</AnalysisMode>
+    <CodeAnalysisRuleSet>$(SolutionDir)\CodeAnalysis.ruleset</CodeAnalysisRuleSet>
+    <CodeAnalysisTreatWarningsAsErrors>true</CodeAnalysisTreatWarningsAsErrors>
+    <EnableNETAnalyzers>true</EnableNETAnalyzers>
+    <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
+    <EnforceExtendedAnalyzerRules>false</EnforceExtendedAnalyzerRules>
+  </PropertyGroup>
+  <PropertyGroup>
+    <Authors>Mark Ridgwell</Authors>
+    <Company>Mark Ridgwell</Company>
+    <Copyright>Mark Ridgwell</Copyright>
+    <Description>Dotnet Repository Update tools</Description>
+    <NeutralLanguage>en-GB</NeutralLanguage>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageReleaseNotes>$(ReleaseNotes)</PackageReleaseNotes>
+    <PackageTags>Nuget;update;tool;packages</PackageTags>
+    <Product>Repository Update Tool</Product>
+    <RepositoryType>git</RepositoryType>
+    <RepositoryUrl>https://github.com/credfeto/credfeto-dotnet-repo-tools</RepositoryUrl>
+  </PropertyGroup>
+  <ItemGroup>
+    <ProjectReference Include=""..\Credfeto.DotNet.Repo.Tools.CleanUp.Interfaces\Credfeto.DotNet.Repo.Tools.CleanUp.Interfaces.csproj"" />
+    <ProjectReference Include=""..\Credfeto.DotNet.Repo.Tools.Packages.Interfaces\Credfeto.DotNet.Repo.Tools.Packages.Interfaces.csproj""/>
+    <ProjectReference Include=""..\Credfeto.DotNet.Repo.Tools.Release.Interfaces\Credfeto.DotNet.Repo.Tools.Release.Interfaces.csproj""/>
+    <ProjectReference Include=""..\Credfeto.DotNet.Repo.Tracking.Interfaces\Credfeto.DotNet.Repo.Tracking.Interfaces.csproj""/>
+  </ItemGroup>
+  <ItemGroup>
+    <PackageReference Include=""Credfeto.ChangeLog"" Version=""1.10.19.111""/>
+    <PackageReference Include=""Microsoft.Extensions.DependencyInjection.Abstractions"" Version=""8.0.1"" />
+    <PackageReference Include=""Microsoft.Extensions.Logging.Abstractions"" Version=""8.0.1""/>
+  </ItemGroup>
+  <ItemGroup>
+    <PackageReference Include=""AsyncFixer"" Version=""1.6.0"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""codecracker.CSharp"" Version=""1.1.0"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""Credfeto.Enumeration.Source.Generation"" Version=""1.1.6.354"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""CSharpIsNullAnalyzer"" Version=""0.1.495"" PrivateAssets=""all"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""FunFair.CodeAnalysis"" Version=""7.0.14.369"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""Meziantou.Analyzer"" Version=""2.0.149"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""Microsoft.VisualStudio.Threading.Analyzers"" Version=""17.9.28"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""Nullable.Extended.Analyzer"" Version=""1.15.6169"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""Philips.CodeAnalysis.DuplicateCodeAnalyzer"" Version=""1.1.7"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""Philips.CodeAnalysis.MaintainabilityAnalyzers"" Version=""1.5.0"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""Roslynator.Analyzers"" Version=""4.12.1"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""SecurityCodeScan.VS2019"" Version=""5.6.7"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""SmartAnalyzers.CSharpExtensions.Annotations"" Version=""4.2.11"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""SonarAnalyzer.CSharp"" Version=""9.24.0.89429"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""SourceLink.Create.CommandLine"" Version=""2.8.3"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""ToStringWithoutOverrideAnalyzer"" Version=""0.6.0"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+  </ItemGroup>
+</Project>";
+
+        const string expectedXml = @"<Project Sdk=""Microsoft.NET.Sdk"">
+  <PropertyGroup>
+    <DisableImplicitNuGetFallbackFolder>true</DisableImplicitNuGetFallbackFolder>
+    <EnablePackageValidation>true</EnablePackageValidation>
+    <EnableTrimAnalyzer>false</EnableTrimAnalyzer>
+    <Features>strict;flow-analysis</Features>
+    <GenerateNeutralResourcesLanguageAttribute>true</GenerateNeutralResourcesLanguageAttribute>
+    <ImplicitUsings>disable</ImplicitUsings>
+    <IncludeOpenAPIAnalyzers>true</IncludeOpenAPIAnalyzers>
+    <IsPackable>true</IsPackable>
+    <IsPublishable>false</IsPublishable>
+    <IsTrimmable>false</IsTrimmable>
+    <LangVersion>latest</LangVersion>
+    <NoWarn />
+    <Nullable>enable</Nullable>
+    <OutputType>Library</OutputType>
+    <RunAOTCompilation>false</RunAOTCompilation>
+    <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
+    <TieredCompilation>true</TieredCompilation>
+    <TreatSpecificWarningsAsErrors />
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <WarningsAsErrors />
+    <EnableMicrosoftExtensionsConfigurationBinderSourceGenerator>true</EnableMicrosoftExtensionsConfigurationBinderSourceGenerator>
+    <JsonSerializerIsReflectionEnabledByDefault>false</JsonSerializerIsReflectionEnabledByDefault>
+    <OptimizationPreference>speed</OptimizationPreference>
+    <IsTrimmable>true</IsTrimmable>
+    <EnableTrimAnalyzer>true</EnableTrimAnalyzer>
+    <!-- Dotnet 7 features -->
+    <TieredPGO>true</TieredPGO>
+    <UseSystemResourceKeys>true</UseSystemResourceKeys>
+    <IlcOptimizationPreference>Size</IlcOptimizationPreference>
+    <IlcGenerateStackTraceData>false</IlcGenerateStackTraceData>
+    <DebuggerSupport>true</DebuggerSupport>
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <NuGetAudit>true</NuGetAudit>
+  </PropertyGroup>
+  <PropertyGroup>
+    <AnalysisLevel>latest</AnalysisLevel>
+    <AnalysisMode>AllEnabledByDefault</AnalysisMode>
+    <CodeAnalysisRuleSet>$(SolutionDir)\CodeAnalysis.ruleset</CodeAnalysisRuleSet>
+    <CodeAnalysisTreatWarningsAsErrors>true</CodeAnalysisTreatWarningsAsErrors>
+    <EnableNETAnalyzers>true</EnableNETAnalyzers>
+    <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
+    <EnforceExtendedAnalyzerRules>false</EnforceExtendedAnalyzerRules>
+  </PropertyGroup>
+  <PropertyGroup>
+    <Authors>Mark Ridgwell</Authors>
+    <Company>Mark Ridgwell</Company>
+    <Copyright>Mark Ridgwell</Copyright>
+    <Description>Dotnet Repository Update tools</Description>
+    <NeutralLanguage>en-GB</NeutralLanguage>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageReleaseNotes>$(ReleaseNotes)</PackageReleaseNotes>
+    <PackageTags>Nuget;update;tool;packages</PackageTags>
+    <Product>Repository Update Tool</Product>
+    <RepositoryType>git</RepositoryType>
+    <RepositoryUrl>https://github.com/credfeto/credfeto-dotnet-repo-tools</RepositoryUrl>
+  </PropertyGroup>
+  <ItemGroup>
+    <ProjectReference Include=""..\Credfeto.DotNet.Repo.Tools.CleanUp.Interfaces\Credfeto.DotNet.Repo.Tools.CleanUp.Interfaces.csproj"" />
+    <ProjectReference Include=""..\Credfeto.DotNet.Repo.Tools.Packages.Interfaces\Credfeto.DotNet.Repo.Tools.Packages.Interfaces.csproj""/>
+    <ProjectReference Include=""..\Credfeto.DotNet.Repo.Tools.Release.Interfaces\Credfeto.DotNet.Repo.Tools.Release.Interfaces.csproj""/>
+    <ProjectReference Include=""..\Credfeto.DotNet.Repo.Tracking.Interfaces\Credfeto.DotNet.Repo.Tracking.Interfaces.csproj""/>
+  </ItemGroup>
+  <ItemGroup>
+    <PackageReference Include=""Credfeto.ChangeLog"" Version=""1.10.19.111""/>
+    <PackageReference Include=""Microsoft.Extensions.DependencyInjection.Abstractions"" Version=""8.0.1"" />
+    <PackageReference Include=""Microsoft.Extensions.Logging.Abstractions"" Version=""8.0.1""/>
+  </ItemGroup>
+  <ItemGroup>
+    <PackageReference Include=""AsyncFixer"" Version=""1.6.0"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""codecracker.CSharp"" Version=""1.1.0"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""Credfeto.Enumeration.Source.Generation"" Version=""1.1.6.354"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""CSharpIsNullAnalyzer"" Version=""0.1.495"" PrivateAssets=""all"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""FunFair.CodeAnalysis"" Version=""7.0.14.369"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""Meziantou.Analyzer"" Version=""2.0.149"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""Microsoft.VisualStudio.Threading.Analyzers"" Version=""17.9.28"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""Nullable.Extended.Analyzer"" Version=""1.15.6169"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""Philips.CodeAnalysis.DuplicateCodeAnalyzer"" Version=""1.1.7"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""Philips.CodeAnalysis.MaintainabilityAnalyzers"" Version=""1.5.0"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""Roslynator.Analyzers"" Version=""4.12.1"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""SecurityCodeScan.VS2019"" Version=""5.6.7"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""SmartAnalyzers.CSharpExtensions.Annotations"" Version=""4.2.11"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""SonarAnalyzer.CSharp"" Version=""9.24.0.89429"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""SourceLink.Create.CommandLine"" Version=""2.8.3"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+    <PackageReference Include=""ToStringWithoutOverrideAnalyzer"" Version=""0.6.0"" PrivateAssets=""All"" ExcludeAssets=""runtime"" />
+  </ItemGroup>
+</Project>";
+
+        return this.DoReporderPropertiesAsync(expectedXml: expectedXml, originalXml: originalXml);
+    }
+
+    private async Task DoReporderPropertiesAsync(string expectedXml, string originalXml)
+    {
+        XmlDocument docExpected = LoadXml(expectedXml);
+        string txtExpected = await SaveDocAsync(docExpected);
+
+        XmlDocument doc = LoadXml(originalXml);
+
+        this._projectXmlRewriter.ReOrderPropertyGroups(projectDocument: doc, filename: "test.csproj");
+
+        string actual = await SaveDocAsync(doc);
+        Assert.Equal(expected: txtExpected, actual: actual);
+    }
+
+    private static XmlDocument LoadXml(string expectedXml)
+    {
+        XmlDocument docExpected = new();
+        docExpected.LoadXml(expectedXml);
+
+        return docExpected;
+    }
+
+    private static async ValueTask<string> SaveDocAsync(XmlDocument doc)
+    {
+        XmlWriterSettings settings = new()
+                                     {
+                                         Indent = true,
+                                         IndentChars = "  ",
+                                         NewLineOnAttributes = false,
+                                         OmitXmlDeclaration = true,
+                                         Async = true
+                                     };
+
+        StringWriter sw = new();
+
+        // ReSharper disable once UseAwaitUsing
+        await using (XmlWriter xmlWriter = XmlWriter.Create(output: sw, settings: settings))
+        {
+            doc.Save(xmlWriter);
+            await ValueTask.CompletedTask;
+        }
+
+        return sw.ToString();
+    }
+}

src/Credfeto.DotNet.Repo.Tools.CleanUp/CleanUpSetup.cs

@@ -8,6 +8,7 @@ public static class CleanUpSetup
 {
     public static IServiceCollection AddCleanUp(this IServiceCollection services)
     {
-        return services.AddSingleton<IBulkCodeCleanUp, BulkCodeCleanUp>();
+        return services.AddSingleton<IBulkCodeCleanUp, BulkCodeCleanUp>()
+                       .AddSingleton<IProjectXmlRewriter, ProjectXmlRewriter>();
     }
 }

src/Credfeto.DotNet.Repo.Tools.CleanUp/CleanupUpdateContext.cs

@@ -0,0 +1,8 @@
+using System.Diagnostics;
+using Credfeto.DotNet.Repo.Tools.DotNet.Interfaces;
+using Credfeto.DotNet.Repo.Tools.Release.Interfaces;
+
+namespace Credfeto.DotNet.Repo.Tools.CleanUp;
+
+[DebuggerDisplay("Work: {WorkFolder}")]
+public readonly record struct CleanupUpdateContext(string WorkFolder, string TrackingFileName, DotNetVersionSettings DotNetSettings, ReleaseConfig ReleaseConfig);

src/Credfeto.DotNet.Repo.Tools.CleanUp/Credfeto.DotNet.Repo.Tools.CleanUp.csproj

@@ -59,9 +59,14 @@
   </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="..\Credfeto.DotNet.Repo.Tools.CleanUp.Interfaces\Credfeto.DotNet.Repo.Tools.CleanUp.Interfaces.csproj" />
+    <ProjectReference Include="..\Credfeto.DotNet.Repo.Tools.Packages.Interfaces\Credfeto.DotNet.Repo.Tools.Packages.Interfaces.csproj"/>
+    <ProjectReference Include="..\Credfeto.DotNet.Repo.Tools.Release.Interfaces\Credfeto.DotNet.Repo.Tools.Release.Interfaces.csproj"/>
+    <ProjectReference Include="..\Credfeto.DotNet.Repo.Tracking.Interfaces\Credfeto.DotNet.Repo.Tracking.Interfaces.csproj"/>
   </ItemGroup>
   <ItemGroup>
+    <PackageReference Include="Credfeto.ChangeLog" Version="1.10.19.111"/>
     <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.1" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.1"/>
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="AsyncFixer" Version="1.6.0" PrivateAssets="All" ExcludeAssets="runtime" />

src/Credfeto.DotNet.Repo.Tools.CleanUp/IProjectXmlRewriter.cs

@@ -0,0 +1,10 @@
+using System.Xml;
+
+namespace Credfeto.DotNet.Repo.Tools.CleanUp;
+
+public interface IProjectXmlRewriter
+{
+    void ReOrderPropertyGroups(XmlDocument projectDocument, string filename);
+
+    void ReOrderIncludes(XmlDocument projectDocument);
+}