[ApiDiff] Implementation of the new ApiDiff that reuses GenAPI features #46425

carlossanlop · 2025-01-30T18:09:53Z

Follow up of #46424

This PR is part of the work needed to create an ApiDiff tool that reuses some of the code from Microsoft.DotNet.GenAPI. The idea is to make the larger PR smaller and make it easier to review: #45389

The proposed changes in this PR include:

Full implementation of the tool that can generate an API diff from two assemblies.

src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff.Tool/Microsoft.DotNet.ApiDiff.Tool.csproj

src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/Microsoft.DotNet.ApiDiff.csproj

test/Microsoft.DotNet.ApiDiff.Tests/Microsoft.DotNet.ApiDiff.Tests.csproj

src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff.Tool/Microsoft.DotNet.ApiDiff.Tool.csproj

src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff.Tool/Program.cs

src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/DiffConfiguration.cs

src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff.Tool/Program.cs

src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/DiffGenerator.cs

CODEOWNERS

carlossanlop · 2025-02-04T18:32:06Z

I added a very simple test that verifies the contents of a basic DLL before and after adding one API.
Unfortunately the DLLs triggered the error below, so I might have to add the DLL as an actual pair of projects (before and after), compile them as part of the SDK repo build, and then I hope the two DLLs can be compared (the restriction is that they need to have the same assembly name).

expand to see the full error
repo-projects\Directory.Build.targets(504,5): error MSB3073: The command "D:\a\_work\1\vmr\src\sdk\eng\common\build.cmd -restore -build -pack -publish -sign -ci -configuration Release -bl /p:DotNetBuildRepo=true /p:DotNetBuildOrchestrator=true /p:TargetRid=win-x64 /p:RestoreConfigFile=D:\a\_work\1\vmr\artifacts\obj\sdk\NuGet.config /p:ForceDryRunSigning=true /p:SourceBuiltAssetsDir=D:\a\_work\1\vmr\artifacts\assets\Release\ /p:SourceBuiltAssetManifestsDir=D:\a\_work\1\vmr\artifacts\obj\manifests\Release\sdk\ -nativeToolsOnMachine /p:PackageProjectUrl=https://github.com/dotnet/sdk /p:PortableRid=win-x64 -v minimal /p:NETCoreAppMaximumVersion=99.9 /p:PortableOSName= /p:Rid=win-x64 /p:Architecture=x64 /p:DOTNET_INSTALL_DIR=D:\a\_work\1\vmr\.dotnet\ /p:SkipBuildingInstallers=true /p:SkipBuildingSdkBundle=true /p:PublicBaseURL=file://D:\a\_work\1\vmr\artifacts\assets\Release\ /p:FallbackPublicBaseURL=https://dotnetbuilds.blob.core.windows.net/public/ /p:UsePortableLinuxSharedFramework=false
❌artifacts\source-built-sdks\Microsoft.DotNet.Arcade.Sdk\tools\Sign.proj(75,5): error SIGN004: Signing 3rd party library 'D:\a\_work\1\vmr\src\sdk\artifacts\tmp\Release\ContainerSigning\339\tools/net8.0/any/Argon.dll' with Microsoft certificate 'MicrosoftDotNet500'. The library is considered 3rd party library due to its copyright: 'Copyright 2024. All rights reserved'.
❌artifacts\source-built-sdks\Microsoft.DotNet.Arcade.Sdk\tools\Sign.proj(75,5): error SIGN004: Signing 3rd party library 'D:\a\_work\1\vmr\src\sdk\artifacts\tmp\Release\ContainerSigning\340\tools/net8.0/any/DiffEngine.dll' with Microsoft certificate 'MicrosoftDotNet500'. The library is considered 3rd party library due to its copyright: 'Copyright 2024. All rights reserved'.

carlossanlop · 2025-02-04T19:10:00Z

I just noticed I didn't implement the addition of the table of contents file. Working on that.

carlossanlop · 2025-02-06T03:11:48Z

Addressed most of the feedback. Still need to go through a few more comments.

carlossanlop · 2025-02-06T17:51:55Z

@MichaelSimons @ViktorHofer how do I exclude this src project from participating in SB?

I suspect that's the root cause of the failure saying that we are trying to sign the external dependency Verify.DiffPlex with a Microsoft certificate.

Note that Verify.DiffPlex is already used in many test projects in the sdk repo, which as we know, don't participate in SB. It seems this is the first src project that consumes Verify.DiffPlex.

Do I just add <DotNetBuildSourceOnly>false</DotNetBuildSourceOnly> to the csprojs?

MichaelSimons · 2025-02-06T18:13:42Z

@MichaelSimons @ViktorHofer how do I exclude this src project from participating in SB?

I suspect that's the root cause of the failure saying that we are trying to sign the external dependency Verify.DiffPlex with a Microsoft certificate.

Note that Verify.DiffPlex is already used in many test projects in the sdk repo, which as we know, don't participate in SB. It seems this is the first src project that consumes Verify.DiffPlex.

Do I just add <DotNetBuildSourceOnly>false</DotNetBuildSourceOnly> to the csprojs?

This appears to be affecting the linux unified build leg as well so excluding it from SB will not be enough. From sdk-unified-build (VMR Vertical Build Validation Ubuntu2404_DevVersions_x64)

    /__w/1/vmr/artifacts/source-built-sdks/Microsoft.DotNet.Arcade.Sdk/tools/Sign.proj(75,5): error SIGN004: Signing 3rd party library '/__w/1/vmr/src/sdk/artifacts/tmp/Release/ContainerSigning/339/tools/net8.0/any/Argon.dll' with Microsoft certificate 'MicrosoftDotNet500'. The library is considered 3rd party library due to its copyright: 'Copyright 2024. All rights reserved'.
    /__w/1/vmr/artifacts/source-built-sdks/Microsoft.DotNet.Arcade.Sdk/tools/Sign.proj(75,5): error SIGN004: Signing 3rd party library '/__w/1/vmr/src/sdk/artifacts/tmp/Release/ContainerSigning/340/tools/net8.0/any/DiffEngine.dll' with Microsoft certificate 'MicrosoftDotNet500'. The library is considered 3rd party library due to its copyright: 'Copyright 2024. All rights reserved'.
    /__w/1/vmr/artifacts/source-built-sdks/Microsoft.DotNet.Arcade.Sdk/tools/Sign.proj(75,5): error SIGN004: Signing 3rd party library '/__w/1/vmr/src/sdk/artifacts/tmp/Release/ContainerSigning/341/tools/net8.0/any/DiffPlex.dll' with Microsoft certificate 'MicrosoftDotNet500'. The library is considered 3rd party library due to its copyright: ''.
    /__w/1/vmr/artifacts/source-built-sdks/Microsoft.DotNet.Arcade.Sdk/tools/Sign.proj(75,5): error SIGN004: Signing 3rd party library '/__w/1/vmr/src/sdk/artifacts/tmp/Release/ContainerSigning/342/tools/net8.0/any/EmptyFiles.dll' with Microsoft certificate 'MicrosoftDotNet500'. The library is considered 3rd party library due to its copyright: 'Copyright 2024. All rights reserved'.
    /__w/1/vmr/artifacts/source-built-sdks/Microsoft.DotNet.Arcade.Sdk/tools/Sign.proj(75,5): error SIGN004: Signing 3rd party library '/__w/1/vmr/src/sdk/artifacts/tmp/Release/ContainerSigning/347/tools/net8.0/any/SimpleInfoName.dll' with Microsoft certificate 'MicrosoftDotNet500'. The library is considered 3rd party library due to its copyright: 'Copyright 2023. All rights reserved'.
    /__w/1/vmr/artifacts/source-built-sdks/Microsoft.DotNet.Arcade.Sdk/tools/Sign.proj(75,5): error SIGN004: Signing 3rd party library '/__w/1/vmr/src/sdk/artifacts/tmp/Release/ContainerSigning/358/tools/net8.0/any/Verify.dll' with Microsoft certificate 'MicrosoftDotNet500'. The library is considered 3rd party library due to its copyright: 'Copyright 2024. All rights reserved'.
    /__w/1/vmr/artifacts/source-built-sdks/Microsoft.DotNet.Arcade.Sdk/tools/Sign.proj(75,5): error SIGN004: Signing 3rd party library '/__w/1/vmr/src/sdk/artifacts/tmp/Release/ContainerSigning/359/tools/net8.0/any/Verify.DiffPlex.dll' with Microsoft certificate 'MicrosoftDotNet500'. The library is considered 3rd party library due to its copyright: 'Copyright 2024. All rights reserved'.

carlossanlop · 2025-02-06T18:17:41Z

This appears to be affecting the linux unified build leg as well so excluding it from SB will not be enough.

Unsure what to do then. I don't know how long it would take me to write our own diffing tool. Or maybe we could duplicate the diffplex source code if the license permits it.

ViktorHofer · 2025-02-06T18:21:19Z

I think you just need to update Signing.props in this repo and tell the signing infrastructure how to sign the external assembly. This is by design afaik. @mmitche has more knowledge on this.

carlossanlop · 2025-02-06T18:26:14Z

I think you just need to update Signing.props in this repo and tell the signing infrastructure how to sign the external assembly. This is by design afaik. @mmitche has more knowledge on this.

Here!

sdk/eng/Signing.props

Lines 28 to 29 in b513b97

    
           <!-- Third party DLLs used by tests --> 
        
           <FileSignInfo Include="Castle.Core.dll" CertificateName="None" />

carlossanlop · 2025-02-06T18:30:47Z

@mmitche do I sign the packages like I did in this commit? 8a94049

Or do I sign them using $(ExternalCertificateId) as indicated here?

sdk/eng/Signing.props

Lines 55 to 60 in b513b97

    
             <!-- 
        
               These are third party libraries that we use in Arcade. We need to sign them even if they 
        
               are already signed. However, they must be signed with a 3rd party certificate. 
        
             --> 
        
             <ItemGroup> 
        
               <FileSignInfo Include="MessagePack.Annotations.dll" CertificateName="$(ExternalCertificateId)" />

carlossanlop · 2025-02-06T18:39:32Z

Do I just add <DotNetBuildSourceOnly>false</DotNetBuildSourceOnly> to the csprojs?

@ViktorHofer @MichaelSimons assuming we can take care of the signing problem of DiffPlex, is this the right way to exclude a src project from source-build?

MichaelSimons · 2025-02-06T20:16:04Z

Do I just add <DotNetBuildSourceOnly>false</DotNetBuildSourceOnly> to the csprojs?

@ViktorHofer @MichaelSimons assuming we can take care of the signing problem of DiffPlex, is this the right way to exclude a src project from source-build?

Yes - This is documented here

carlossanlop · 2025-02-06T21:09:49Z

Progress: setting DiffPlex resources to use no certificate got rid of the failure (pending confirming if it's the right choice, or if using $(ExternalCertificateId) is preferred, @mmitche).

The new failures are now related to the ApiDiff tool itself. Seems that the tests fail in Linux due to the wrong NewLine chars being used.

…method that reads/writes to disk works.

Disallow empty table of contents. Add more file handling tests. Add innerException when syntaxGenerator.Declaration does not work.

Add a DISABLED test for explicit checked operator.

carlossanlop · 2025-02-07T01:59:49Z

test/Microsoft.DotNet.ApiDiff.Tests/Diff.Operators.Tests.cs

+    }
+
+    [Fact]
+    public void TestExplicitOperator()


@ericstj this test passes in my local machine (should pass in the CI too, I just pushed it).

It's the next test (explicit checked) that fails.

carlossanlop added the DO NOT MERGE label Jan 30, 2025

carlossanlop self-assigned this Jan 30, 2025

dotnet-issue-labeler bot added Area-Infrastructure untriaged Request triage from a team member labels Jan 30, 2025

build-analysis bot mentioned this pull request Jan 30, 2025

Template engine tests hitting known parallelism issue in GetVisualStudioInstances #44878

Open

carlossanlop force-pushed the ApiDiff branch 2 times, most recently from d8da8db to 519ac72 Compare February 1, 2025 02:33

carlossanlop removed the DO NOT MERGE label Feb 1, 2025

carlossanlop requested a review from michaelgsharp February 1, 2025 02:33

carlossanlop marked this pull request as ready for review February 1, 2025 02:33

carlossanlop requested a review from a team as a code owner February 1, 2025 02:33