Add PackageValidator tool for NuGet package inspection and validation

BUILDGUIDE.md

@@ -92,7 +92,7 @@ projects they depend on.
 | `BuildSqlClientWindows`       | Builds the Windows-specific implementation binaries of Microsoft.Data.SqlClient |
 | `BuildSqlServer`              | Builds Microsoft.SqlServer.Server                                               |
 | `BuildTests`                  | Builds all test projects for all supported OS combinations                      |
-| `BuildTools`                  | Builds auxiliary tool/app projects                                              |
+| `BuildTools`                  | Builds auxiliary tool/app projects and their test projects                      |
 | `Clean`                       | Removes build and test output directories                                       |
 
 A selection of parameters for build targets in `build.proj` can be found below:

build.proj

@@ -714,7 +714,7 @@
     </PropertyGroup>
     <Message Importance="High" Text=">>> Running manual tests for SqlClient"/>
     <Message Text="    Command: $(DotnetCommand)"/>
     <Exec ConsoleToMsBuild="true" Command="$(DotnetCommand)" />
   </Target>
 
   <!-- TestSqlClientUnit: Runs unit tests for SqlClient -->
@@ -743,7 +743,7 @@
     </PropertyGroup>
     <Message Importance="High" Text=">>> Running unit tests for SqlClient"/>
     <Message Text="    Command: $(DotnetCommand)"/>
     <Exec ConsoleToMsBuild="true" Command="$(DotnetCommand)" />
   </Target>
 
   <!-- ================================================================= -->
@@ -1474,10 +1474,15 @@
   <PropertyGroup>
     <AzureSqlConnectorProjectPath>$(RepoRoot)doc/apps/AzureSqlConnector/AzureSqlConnector.csproj</AzureSqlConnectorProjectPath>
     <PackageCompatibilityProjectPath>$(RepoRoot)tools/PackageCompatibility/src/PackageCompatibility.csproj</PackageCompatibilityProjectPath>
+    <PackageCompatibilityTestProjectPath>$(RepoRoot)tools/PackageCompatibility/test/PackageCompatibility.Test.csproj</PackageCompatibilityTestProjectPath>
+    <PackageCompatibilityDir>$(RepoRoot)tools/PackageCompatibility</PackageCompatibilityDir>
+    <PackageValidatorProjectPath>$(RepoRoot)tools/PackageValidator/src/PackageValidator.csproj</PackageValidatorProjectPath>
+    <PackageValidatorTestProjectPath>$(RepoRoot)tools/PackageValidator/test/PackageValidator.Test.csproj</PackageValidatorTestProjectPath>
+    <PackageValidatorDir>$(RepoRoot)tools/PackageValidator</PackageValidatorDir>
   </PropertyGroup>
 
-  <!-- BuildTools: Builds auxiliary tool/app projects. -->
-  <Target Name="BuildTools" DependsOnTargets="BuildAzureSqlConnector;BuildPackageCompatibility" />
+  <!-- BuildTools: Builds auxiliary tool/app projects (including their test projects). -->
+  <Target Name="BuildTools" DependsOnTargets="BuildAzureSqlConnector;BuildPackageCompatibility;BuildPackageCompatibilityTest;BuildPackageValidator;BuildPackageValidatorTest" />
 
   <!-- BuildAzureSqlConnector: Builds the AzureSqlConnector sample app. -->
   <Target Name="BuildAzureSqlConnector">
@@ -1507,4 +1512,84 @@
     <Exec ConsoleToMsBuild="true" Command="$(DotnetCommand)" />
   </Target>
 
+  <!-- BuildPackageValidator: Builds the PackageValidator tool. -->
+  <Target Name="BuildPackageValidator">
+    <PropertyGroup>
+      <DotnetCommand>
+        "$(DotnetPath)dotnet" build "$(PackageValidatorProjectPath)"
+        -p:Configuration=$(Configuration)
+      </DotnetCommand>
+      <DotnetCommand>$([System.Text.RegularExpressions.Regex]::Replace($(DotnetCommand), "\s+", " "))</DotnetCommand>
+    </PropertyGroup>
+    <Message Importance="High" Text=">>> Building PackageValidator"/>
+    <Message Text="    Command: $(DotnetCommand)"/>
+    <Exec ConsoleToMsBuild="true" Command="$(DotnetCommand)" />
+  </Target>
+
+  <!-- BuildPackageCompatibilityTest: Builds the PackageCompatibility test project. -->
+  <Target Name="BuildPackageCompatibilityTest">
+    <PropertyGroup>
+      <DotnetCommand>
+        "$(DotnetPath)dotnet" build "$(PackageCompatibilityTestProjectPath)"
+        -p:Configuration=$(Configuration)
+      </DotnetCommand>
+      <DotnetCommand>$([System.Text.RegularExpressions.Regex]::Replace($(DotnetCommand), "\s+", " "))</DotnetCommand>
+    </PropertyGroup>
+    <Message Importance="High" Text=">>> Building PackageCompatibility tests"/>
+    <Message Text="    Command: $(DotnetCommand)"/>
+    <Exec ConsoleToMsBuild="true" Command="$(DotnetCommand)" />
+  </Target>
+
+  <!-- BuildPackageValidatorTest: Builds the PackageValidator test project. -->
+  <Target Name="BuildPackageValidatorTest">
+    <PropertyGroup>
+      <DotnetCommand>
+        "$(DotnetPath)dotnet" build "$(PackageValidatorTestProjectPath)"
+        -p:Configuration=$(Configuration)
+      </DotnetCommand>
+      <DotnetCommand>$([System.Text.RegularExpressions.Regex]::Replace($(DotnetCommand), "\s+", " "))</DotnetCommand>
+    </PropertyGroup>
+    <Message Importance="High" Text=">>> Building PackageValidator tests"/>
+    <Message Text="    Command: $(DotnetCommand)"/>
+    <Exec ConsoleToMsBuild="true" Command="$(DotnetCommand)" />
+  </Target>
+
+  <!--
+    TestPackageCompatibility: Runs the PackageCompatibility tests.
+
+    The Exec runs from the tool directory so the tool's global.json (which opts the xUnit v3
+    test project into the Microsoft.Testing.Platform runner) is discovered.
+  -->
+  <Target Name="TestPackageCompatibility">
+    <PropertyGroup>
+      <DotnetCommand>
+        "$(DotnetPath)dotnet" test "$(PackageCompatibilityTestProjectPath)"
+        -p:Configuration=$(Configuration)
+      </DotnetCommand>
+      <DotnetCommand>$([System.Text.RegularExpressions.Regex]::Replace($(DotnetCommand), "\s+", " "))</DotnetCommand>
+    </PropertyGroup>
+    <Message Importance="High" Text=">>> Testing PackageCompatibility"/>
+    <Message Text="    Command: $(DotnetCommand)"/>
+    <Exec ConsoleToMsBuild="true" Command="$(DotnetCommand)" WorkingDirectory="$(PackageCompatibilityDir)" />
+  </Target>
+
+  <!--
+    TestPackageValidator: Runs the PackageValidator tests.
+
+    The Exec runs from the tool directory so the tool's global.json (which opts the xUnit v3
+    test project into the Microsoft.Testing.Platform runner) is discovered.
+  -->
+  <Target Name="TestPackageValidator">
+    <PropertyGroup>
+      <DotnetCommand>
+        "$(DotnetPath)dotnet" test "$(PackageValidatorTestProjectPath)"
+        -p:Configuration=$(Configuration)
+      </DotnetCommand>
+      <DotnetCommand>$([System.Text.RegularExpressions.Regex]::Replace($(DotnetCommand), "\s+", " "))</DotnetCommand>
+    </PropertyGroup>
+    <Message Importance="High" Text=">>> Testing PackageValidator"/>
+    <Message Text="    Command: $(DotnetCommand)"/>
+    <Exec ConsoleToMsBuild="true" Command="$(DotnetCommand)" WorkingDirectory="$(PackageValidatorDir)" />
+  </Target>
+
 </Project>

src/Microsoft.Data.SqlClient.slnx

@@ -214,6 +214,10 @@
     <Project Path="Microsoft.Data.SqlClient/tests/TestUdts/Shapes/Shapes.csproj" />
     <Project Path="Microsoft.Data.SqlClient/tests/TestUdts/Utf8String/Utf8String.csproj" />
   </Folder>
-  <Project Path="../tools/PackageCompatibility/src/PackageCompatibility.csproj" />
-  <Project Path="../tools/PackageCompatibility/test/PackageCompatibility.Test.csproj" />
+  <Folder Name="/tools/">
+    <Project Path="../tools/PackageCompatibility/src/PackageCompatibility.csproj" />
+    <Project Path="../tools/PackageCompatibility/test/PackageCompatibility.Test.csproj" />
+    <Project Path="../tools/PackageValidator/src/PackageValidator.csproj" />
+    <Project Path="../tools/PackageValidator/test/PackageValidator.Test.csproj" />
+  </Folder>
 </Solution>

tools/PackageValidator/Directory.Build.props

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+
+  <!-- We purposely do not include any parent Directory.Build.props files. -->
+
+  <PropertyGroup>
+    <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
+  </PropertyGroup>
+
+</Project>

tools/PackageValidator/Directory.Packages.props

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+
+  <!-- We purposely do not include any parent Directory.Packages.props files. -->
+
+  <ItemGroup>
+    <PackageVersion Include="System.CommandLine" Version="2.0.6" />
+    <PackageVersion Include="xunit.v3" Version="4.0.0-pre.81" />
+  </ItemGroup>
+
+</Project>

tools/PackageValidator/global.json

@@ -0,0 +1,15 @@
+{
+  "test": {
+    // xUnit v3 runs on Microsoft.Testing.Platform rather than the older VSTest runner.
+    // On .NET 10, dotnet test must therefore be opted into MTP mode for this test project.
+    "runner": "Microsoft.Testing.Platform"
+  },
+  "sdk": {
+    // global.json lookup stops at the nearest file and does not merge with the repo-root file.
+    // This subtree therefore needs to repeat the root SDK settings so commands run from
+    // tools/PackageValidator keep using the same SDK behavior.
+    "version": "10.0.300",
+    "rollForward": "patch",
+    "allowPrerelease": false
+  }
+}