[Infra-BuildScript] Add PowerShell Script to Enforce Shared Common.Dotnet.CsWinRT.props in all CSharp Projects under Src Sub-Folder (#37811)

* Add Powershell script to validate whether CSharp project correctly import shared props, update pipeline to enforce such validation, and fixed all projects that didn't import this shared props correctly

* add common props for fuzz test project

* update the path

* Only scans projects in src sub-folder

* Update .pipelines/verifyCommonProps.ps1

* Update csproj to include Common.Dotnet.CsWinRT.props

* Fix indentation in RegistryPreview.FuzzTests.csproj

* exclude TemplateCmdPalExtension.csproj in validation process

* exclude TemplateCmdPalExtension.csproj in validation process

---------

Co-authored-by: Leilei Zhang <leilzh@microsoft.com>
Co-authored-by: Jerry Xu <nxu@microsoft.com>

.pipelines/v2/templates/job-build-project.yml

@@ -344,6 +344,11 @@ jobs:
       flattenFolders: True
       OverWrite: True
 
+  # Check if all projects (located in src sub-folder) import common props
+  - pwsh: |-
+      & '.pipelines/verifyCommonProps.ps1' -sourceDir '$(build.sourcesdirectory)\src'
+    displayName: Audit shared common props for CSharp projects in src sub-folder
+
   # Check if deps.json files don't reference different dll versions.
   - pwsh: |-
       & '.pipelines/verifyDepsJsonLibraryVersions.ps1' -targetDir '$(build.sourcesdirectory)\$(BuildPlatform)\$(BuildConfiguration)'

.pipelines/verifyCommonProps.ps1

@@ -0,0 +1,54 @@
+[CmdletBinding()]
+Param(
+    [Parameter(Mandatory = $True, Position = 1)]
+    [string]$sourceDir
+)
+
+# scan all csharp project in the source directory
+function Get-CSharpProjects {
+    param (
+        [string]$path
+    )
+
+    # Get all .csproj files under the specified path
+    return Get-ChildItem -Path $path -Recurse -Filter *.csproj | Select-Object -ExpandProperty FullName
+}
+
+# Check if the project file imports 'Common.Dotnet.CsWinRT.props'
+function Test-ImportSharedCsWinRTProps {
+    param (
+        [string]$filePath
+    )
+
+    # Load the XML content of the .csproj file
+    [xml]$csprojContent = Get-Content -Path $filePath
+
+    
+    # Check if the Import element with Project attribute containing 'Common.Dotnet.CsWinRT.props' exists
+    return $csprojContent.Project.Import | Where-Object { $null -ne $_.Project -and $_.Project.EndsWith('Common.Dotnet.CsWinRT.props') }
+}
+
+# Call the function with the provided source directory
+$csprojFilesArray = Get-CSharpProjects -path $sourceDir
+
+$hasInvalidCsProj = $false
+
+# Enumerate the array of file paths and call Validate-ImportSharedCsWinRTProps for each file
+foreach ($csprojFile in $csprojFilesArray) {
+    # Skip if the file ends with 'TemplateCmdPalExtension.csproj'
+    if ($csprojFile -like '*TemplateCmdPalExtension.csproj') {
+        continue
+    }
+
+    $importExists = Test-ImportSharedCsWinRTProps -filePath $csprojFile
+    if (!$importExists) {
+        Write-Output "$csprojFile need to import 'Common.Dotnet.CsWinRT.props'."
+        $hasInvalidCsProj = $true
+    }
+}
+
+if ($hasInvalidCsProj) {
+    exit 1
+}
+
+exit 0

src/Common.Dotnet.FuzzTest.props

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Some items may be set in Directory.Build.props in root -->
+<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <!-- OneFuzz does not currently support testing with .NET 9.
+       As a temporary workaround, create a .NET 8 project and use file links 
+       to include the code that needs testing. -->
+  <PropertyGroup>
+    <TargetFramework>net8.0-windows10.0.19041.0</TargetFramework>
+  </PropertyGroup>
+</Project>

src/modules/AdvancedPaste/AdvancedPaste.FuzzTests/AdvancedPaste.FuzzTests.csproj

@@ -1,6 +1,8 @@
 <Project Sdk="Microsoft.NET.Sdk">
+	<!-- Look at Directory.Build.props in root for common stuff as well -->
+	<Import Project="..\..\..\Common.Dotnet.CsWinRT.props" />
+	<Import Project="..\..\..\Common.Dotnet.FuzzTest.props" />
 	<PropertyGroup>
-		<TargetFramework>net8.0-windows10.0.19041.0</TargetFramework>
 		<LangVersion>latest</LangVersion>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>

src/modules/Hosts/Hosts.FuzzTests/Hosts.FuzzTests.csproj

@@ -1,6 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk">
+	<!-- Look at Directory.Build.props in root for common stuff as well -->
+	<Import Project="..\..\..\Common.Dotnet.CsWinRT.props" />
+	<Import Project="..\..\..\Common.Dotnet.FuzzTest.props" />
+
 	<PropertyGroup>
-		<TargetFramework>net8.0-windows10.0.19041.0</TargetFramework>
 		<LangVersion>latest</LangVersion>
 		<ImplicitUsings>enable</ImplicitUsings>
 	</PropertyGroup>

src/modules/registrypreview/RegistryPreview.FuzzTests/RegistryPreview.FuzzTests.csproj

@@ -1,7 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk">
+  <!-- Look at Directory.Build.props in root for common stuff as well -->
+  <Import Project="..\..\..\Common.Dotnet.CsWinRT.props" />
+  <Import Project="..\..\..\Common.Dotnet.FuzzTest.props" />
 
   <PropertyGroup>
-    <TargetFramework>net8.0-windows10.0.19041.0</TargetFramework>
     <Platforms>x64;ARM64</Platforms>
     <LangVersion>latest</LangVersion>
     <ImplicitUsings>enable</ImplicitUsings>