Some code clean-up and refactoring (#800)

Moved the code clean-up and refactoring done in #794 to here.
microsoft · Mar 16, 2021 · 141fdc8 · 141fdc8
1 parent 327ab68
commit 141fdc8
Show file tree

Hide file tree

Showing 27 changed files with 200 additions and 286 deletions.
diff --git a/TestFx.sln b/TestFx.sln
@@ -21,6 +21,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MSTest.Core", "src\TestFram
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PlatformServices.Desktop", "src\Adapter\PlatformServices.Desktop\PlatformServices.Desktop.csproj", "{B0FCE474-14BC-449A-91EA-A433342C0D63}"
 EndProject
+Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "PlatformServices.Shared", "src\Adapter\PlatformServices.Shared\PlatformServices.Shared.shproj", "{2177C273-AE07-43B3-B87A-443E47A23C5A}"
+EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Extension.Desktop", "src\TestFramework\Extension.Desktop\Extension.Desktop.csproj", "{A7EA583B-A2B0-47DA-A058-458F247C7575}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Extension.Core", "src\TestFramework\Extension.Core\Extension.Core.csproj", "{6C9FE494-8315-4667-B3F6-75DC62A62319}"
@@ -189,6 +191,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "NetCore", "NetCore", "{D11C
 EndProject
 Global
 	GlobalSection(SharedMSBuildProjectFiles) = preSolution
+		src\Adapter\PlatformServices.Shared\PlatformServices.Shared.projitems*{2177c273-ae07-43b3-b87a-443e47a23c5a}*SharedItemsImports = 13
 		src\TestFramework\Extension.Shared\Extension.Shared.projitems*{272ca5e1-8e81-4825-9e47-86cce02f700d}*SharedItemsImports = 13
 		src\TestFramework\Extension.Shared\Extension.Shared.projitems*{df131865-84ee-4540-8112-e88acebdea09}*SharedItemsImports = 4
 	EndGlobalSection
@@ -1180,6 +1183,7 @@ Global
 		{E48AC786-E150-4F41-9A16-32F02E4493D8} = {FF8B1B72-55A1-4FFE-809E-7B79323ED8D0}
 		{7252D9E3-267D-442C-96BC-C73AEF3241D6} = {E48AC786-E150-4F41-9A16-32F02E4493D8}
 		{B0FCE474-14BC-449A-91EA-A433342C0D63} = {24088844-2107-4DB2-8F3F-CBCA94FC4B28}
+		{2177C273-AE07-43B3-B87A-443E47A23C5A} = {24088844-2107-4DB2-8F3F-CBCA94FC4B28}
 		{A7EA583B-A2B0-47DA-A058-458F247C7575} = {E48AC786-E150-4F41-9A16-32F02E4493D8}
 		{6C9FE494-8315-4667-B3F6-75DC62A62319} = {E48AC786-E150-4F41-9A16-32F02E4493D8}
 		{F2D0BF2C-38F2-4244-80E3-4AAD1C3F4C89} = {A9596292-7E67-4566-9096-143DDAA4E8D8}

diff --git a/scripts/build/TestFx.Settings.targets b/scripts/build/TestFx.Settings.targets
@@ -2,9 +2,11 @@
 <Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <TestFxRoot Condition="$(TestFxRoot) == ''">..\..\</TestFxRoot>
-    <RepoRoot>..\..\</RepoRoot>
+    <RepoRoot Condition="$(RepoRoot) == ''">$(TestFxRoot)</RepoRoot>
+    <IncludeMicrosoftCommon Condition="$(IncludeMicrosoftCommon) == ''">true</IncludeMicrosoftCommon>
   </PropertyGroup>
-  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props') and $(FrameworkIdentifier) != 'NetCore'" />
+
+  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props') and $(FrameworkIdentifier) != 'NetCore' and $(IncludeMicrosoftCommon) == 'true'" />
   <!-- Import props/targets with $(RepoRoot) since msbuild takes the relative path based on settings.targets and not with respect to the project. -->
   <Import Project="$(RepoRoot)packages\MicroBuild.Core.0.2.0\build\MicroBuild.Core.props" Condition="Exists('$(RepoRoot)packages\MicroBuild.Core.0.2.0\build\MicroBuild.Core.props')" />
   <Import Project="TestFx.Versions.targets" />

diff --git a/scripts/build/TestFx.targets b/scripts/build/TestFx.targets
@@ -2,7 +2,7 @@
 <Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <Import Project="$(MSBuildExtensionsPath32)\Microsoft\Portable\$(TargetFrameworkVersion)\Microsoft.Portable.CSharp.targets" Condition="$(TargetFrameworkProfile) == 'Profile259'" />
   <Import Project="$(MSBuildExtensionsPath)\Microsoft\WindowsXaml\v$(VisualStudioVersion)\Microsoft.Windows.UI.Xaml.CSharp.targets" Condition="$(TargetPlatformIdentifier) == 'UAP'" />
-  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" Condition="($(TargetFrameworkProfile) == '' or $(TargetFrameworkProfile) != 'Profile259') and $(TargetPlatformIdentifier) != 'UAP' and $(FrameworkIdentifier) != 'NetCore'"/>
+  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" Condition="($(TargetFrameworkProfile) == '' or $(TargetFrameworkProfile) != 'Profile259') and $(TargetPlatformIdentifier) != 'UAP' and $(FrameworkIdentifier) != 'NetCore' and $(IncludeMicrosoftCommon) == 'true'"/>
 
   <PropertyGroup>
     <TestFxRoot Condition="$(TestFxRoot) == ''">..\..\</TestFxRoot>
@@ -84,12 +84,12 @@
     </AssemblyVersionAttribute>
   </ItemGroup>
   <Target Name="GenerateAssemblyInfoFile">
-    <WriteCodeFragment AssemblyAttributes="@(AssemblyVersionAttribute)" Language="C#" OutputFile="$(MSBuildProjectDirectory)\GlobalAssemblyInfo.cs">
+    <WriteCodeFragment AssemblyAttributes="@(AssemblyVersionAttribute)" Language="C#" OutputFile="$(MSBuildProjectDirectory)\GlobalAssemblyInfo.cs" Condition="$(SkipAppendingVersion) != 'true'">
       <Output TaskParameter="OutputFile" ItemName="Compile" />
       <Output TaskParameter="OutputFile" ItemName="FileWrites" />
     </WriteCodeFragment>
   </Target>
   <PropertyGroup>
     <CompileDependsOn>GenerateAssemblyInfoFile;$(CompileDependsOn)</CompileDependsOn>
   </PropertyGroup>
-</Project>
+</Project>
diff --git a/scripts/common.lib.ps1 b/scripts/common.lib.ps1
@@ -22,7 +22,7 @@ $env:TF_PACKAGES_DIR = Join-Path $env:TF_ROOT_DIR "packages"
 
 $TF_VERSIONS_FILE = "$PSScriptRoot\build\TestFx.Versions.targets"
 if ([String]::IsNullOrWhiteSpace($TestPlatformVersion)) {
-    $TestPlatformVersion = (([XML](Get-Content $TF_VERSIONS_FILE)).Project.PropertyGroup.TestPlatformVersion).InnerText
+  $TestPlatformVersion = (([XML](Get-Content $TF_VERSIONS_FILE)).Project.PropertyGroup.TestPlatformVersion).InnerText
 }
 
 function Create-Directory([string[]] $path) {
@@ -180,64 +180,64 @@ function Write-Log ([string] $message, $messageColor = "Green") {
   $Host.UI.RawUI.ForegroundColor = $currentColor
 }
 
-function Install-DotNetCli
-{
-    Write-Log "Install-DotNetCli: Get dotnet-install.ps1 script..."
-    $dotnetInstallRemoteScript = "https://raw.githubusercontent.com/dotnet/cli/master/scripts/obtain/dotnet-install.ps1"
-    $dotnetInstallScript = Join-Path $env:TF_TOOLS_DIR "dotnet-install.ps1"
-    if (-not (Test-Path $env:TF_TOOLS_DIR)) {
-        New-Item $env:TF_TOOLS_DIR -Type Directory | Out-Null
-    }
+function Install-DotNetCli {
+  Write-Log "Install-DotNetCli: Get dotnet-install.ps1 script..."
+  $dotnetInstallRemoteScript = "https://raw.githubusercontent.com/dotnet/cli/master/scripts/obtain/dotnet-install.ps1"
+  $dotnetInstallScript = Join-Path $env:TF_TOOLS_DIR "dotnet-install.ps1"
+  if (-not (Test-Path $env:TF_TOOLS_DIR)) {
+    New-Item $env:TF_TOOLS_DIR -Type Directory | Out-Null
+  }
 
-    $dotnet_dir= Join-Path $env:TF_TOOLS_DIR "dotnet"
+  $dotnet_dir = Join-Path $env:TF_TOOLS_DIR "dotnet"
 
-    if (-not (Test-Path $dotnet_dir)) {
-        New-Item $dotnet_dir -Type Directory | Out-Null
-    }
+  if (-not (Test-Path $dotnet_dir)) {
+    New-Item $dotnet_dir -Type Directory | Out-Null
+  }
 
-    (New-Object System.Net.WebClient).DownloadFile($dotnetInstallRemoteScript, $dotnetInstallScript)
+  (New-Object System.Net.WebClient).DownloadFile($dotnetInstallRemoteScript, $dotnetInstallScript)
 
-    if (-not (Test-Path $dotnetInstallScript)) {
-        Write-Error "Failed to download dotnet install script."
-    }
+  if (-not (Test-Path $dotnetInstallScript)) {
+    Write-Error "Failed to download dotnet install script."
+  }
 
-    Unblock-File $dotnetInstallScript
+  Unblock-File $dotnetInstallScript
 
-    Write-Log "Install-DotNetCli: Get the latest dotnet cli toolset..."
-    $dotnetInstallPath = Join-Path $env:TF_TOOLS_DIR "dotnet"
-    New-Item -ItemType directory -Path $dotnetInstallPath -Force | Out-Null
-    & $dotnetInstallScript -Channel "master" -InstallDir $dotnetInstallPath -Version $env:DOTNET_CLI_VERSION
+  Write-Log "Install-DotNetCli: Get the latest dotnet cli toolset..."
+  $dotnetInstallPath = Join-Path $env:TF_TOOLS_DIR "dotnet"
+  New-Item -ItemType directory -Path $dotnetInstallPath -Force | Out-Null
+  & $dotnetInstallScript -Channel "master" -InstallDir $dotnetInstallPath -Version $env:DOTNET_CLI_VERSION
 
-    & $dotnetInstallScript -InstallDir "$dotnetInstallPath" -Runtime 'dotnet' -Version '2.1.0' -Channel '2.1.0' -Architecture x64 -NoPath
-    $env:DOTNET_ROOT= $dotnetInstallPath
+  & $dotnetInstallScript -InstallDir "$dotnetInstallPath" -Runtime 'dotnet' -Version '2.1.0' -Channel '2.1.0' -Architecture x64 -NoPath
+  $env:DOTNET_ROOT = $dotnetInstallPath
 
-    & $dotnetInstallScript -InstallDir "${dotnetInstallPath}_x86" -Runtime 'dotnet' -Version '2.1.0' -Channel '2.1.0' -Architecture x86 -NoPath
-    ${env:DOTNET_ROOT(x86)} = "${dotnetInstallPath}_x86"
+  & $dotnetInstallScript -InstallDir "${dotnetInstallPath}_x86" -Runtime 'dotnet' -Version '2.1.0' -Channel '2.1.0' -Architecture x86 -NoPath
+  ${env:DOTNET_ROOT(x86)} = "${dotnetInstallPath}_x86"
 
-    & $dotnetInstallScript -InstallDir "$dotnetInstallPath" -Runtime 'dotnet' -Version '3.1.0' -Channel '3.1.0' -Architecture x64 -NoPath
-    $env:DOTNET_ROOT= $dotnetInstallPath
+  & $dotnetInstallScript -InstallDir "$dotnetInstallPath" -Runtime 'dotnet' -Version '3.1.0' -Channel '3.1.0' -Architecture x64 -NoPath
+  $env:DOTNET_ROOT = $dotnetInstallPath
 
-    & $dotnetInstallScript -InstallDir "${dotnetInstallPath}_x86" -Runtime 'dotnet' -Version '3.1.0' -Channel '3.1.0' -Architecture x86 -NoPath
-    ${env:DOTNET_ROOT(x86)} = "${dotnetInstallPath}_x86"
+  & $dotnetInstallScript -InstallDir "${dotnetInstallPath}_x86" -Runtime 'dotnet' -Version '3.1.0' -Channel '3.1.0' -Architecture x86 -NoPath
+  ${env:DOTNET_ROOT(x86)} = "${dotnetInstallPath}_x86"
 
-    & $dotnetInstallScript -InstallDir "$dotnetInstallPath" -Runtime 'dotnet' -Version '5.0.1' -Channel '5.0.1' -Architecture x64 -NoPath
-    $env:DOTNET_ROOT= $dotnetInstallPath
+  & $dotnetInstallScript -InstallDir "$dotnetInstallPath" -Runtime 'dotnet' -Version '5.0.1' -Channel '5.0.1' -Architecture x64 -NoPath
+  $env:DOTNET_ROOT = $dotnetInstallPath
 
-    & $dotnetInstallScript -InstallDir "${dotnetInstallPath}_x86" -Runtime 'dotnet' -Version '5.0.1' -Channel '5.0.1' -Architecture x86 -NoPath
-    ${env:DOTNET_ROOT(x86)} = "${dotnetInstallPath}_x86"
+  & $dotnetInstallScript -InstallDir "${dotnetInstallPath}_x86" -Runtime 'dotnet' -Version '5.0.1' -Channel '5.0.1' -Architecture x86 -NoPath
+  ${env:DOTNET_ROOT(x86)} = "${dotnetInstallPath}_x86"
 
-    $env:DOTNET_MULTILEVEL_LOOKUP=0
+  $env:DOTNET_MULTILEVEL_LOOKUP = 0
 
-    "---- dotnet environment variables"
-    Get-ChildItem "Env:\dotnet_*"
+  "---- dotnet environment variables"
+  Get-ChildItem "Env:\dotnet_*"
 
-    "`n`n---- x64 dotnet"
-    & "$env:DOTNET_ROOT\dotnet.exe" --info
-
-    "`n`n---- x86 dotnet"
-    # avoid erroring out because we don't have the sdk for x86 that global.json requires
-    try {
-        & "${env:DOTNET_ROOT(x86)}\dotnet.exe" --info 2> $null
-    } catch {}
-    Write-Log "Install-DotNetCli: Complete."
+  "`n`n---- x64 dotnet"
+  & "$env:DOTNET_ROOT\dotnet.exe" --info
+
+  "`n`n---- x86 dotnet"
+  # avoid erroring out because we don't have the sdk for x86 that global.json requires
+  try {
+    & "${env:DOTNET_ROOT(x86)}\dotnet.exe" --info 2> $null
+  }
+  catch {}
+  Write-Log "Install-DotNetCli: Complete."
 }
diff --git a/src/Adapter/MSTest.CoreAdapter/Constants.cs b/src/Adapter/MSTest.CoreAdapter/Constants.cs
@@ -29,7 +29,6 @@ internal static class Constants
         internal static readonly Uri ExecutorUri = new Uri(ExecutorUriString);
 
         #region Test Property registration
-
         internal static readonly TestProperty DescriptionProperty = TestProperty.Register("Description", DescriptionLabel, typeof(string), TestPropertyAttributes.Hidden, typeof(TestCase));
 
         internal static readonly TestProperty WorkItemIdsProperty = TestProperty.Register("WorkItemIds", WorkItemIdsLabel, typeof(string[]), TestPropertyAttributes.Hidden, typeof(TestCase));

diff --git a/src/Adapter/MSTest.CoreAdapter/Discovery/AssemblyEnumerator.cs b/src/Adapter/MSTest.CoreAdapter/Discovery/AssemblyEnumerator.cs
@@ -55,10 +55,9 @@ public override object InitializeLifetimeService()
         /// <summary>
         /// Enumerates through all types in the assembly in search of valid test methods.
         /// </summary>
-        /// <param name="assemblyFileName"> The assembly file name. </param>
-        /// <param name="warnings"> Contains warnings if any, that need to be passed back to the caller. </param>
-        /// <returns> A collection of Test Elements. </returns>
-        [SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Justification = "Catching a generic exception since it is a requirement to not abort discovery in case of any errors.")]
+        /// <param name="assemblyFileName">The assembly file name.</param>
+        /// <param name="warnings">Contains warnings if any, that need to be passed back to the caller.</param>
+        /// <returns>A collection of Test Elements.</returns>
         internal ICollection<UnitTestElement> EnumerateAssembly(string assemblyFileName, out ICollection<string> warnings)
         {
             Debug.Assert(!string.IsNullOrWhiteSpace(assemblyFileName), "Invalid assembly file name.");
@@ -73,9 +72,7 @@ internal ICollection<UnitTestElement> EnumerateAssembly(string assemblyFileName,
                 // For normal test assemblies continue loading it in the default context since:
                 // 1. There isn't much benefit in terms of Performance loading the assembly in a Reflection Only context during discovery.
                 // 2. Loading it in Reflection only context entails a bunch of custom logic to identify custom attributes which is over-kill for normal desktop users.
-                assembly = PlatformServiceProvider.Instance.FileOperations.LoadAssembly(
-                    assemblyFileName,
-                    isReflectionOnly: true);
+                assembly = PlatformServiceProvider.Instance.FileOperations.LoadAssembly(assemblyFileName, isReflectionOnly: true);
             }
             else
             {