From 270c2b13a047d90c2050911e1232e00f0e7511a4 Mon Sep 17 00:00:00 2001
From: Bruce Forstall <brucefo@microsoft.com>
Date: Tue, 15 Oct 2024 11:45:20 -0700
Subject: [PATCH] Introduce a mechanism to disable CLR tests under SuperPMI
 collection (#108873)

It should be _extremely_ rare to need to disable a test during SuperPMI
collection. However, one case was found, so introduce the ability to do so.

Use `<SuperPmiCollectIncompatible>true</SuperPmiCollectIncompatible>` in
a test project file.

(which also requires `<RequiresProcessIsolation>true</RequiresProcessIsolation>`)

Fixes #108215
---
 src/tests/Common/CLRTest.Execute.Bash.targets      | 13 +++++++++++++
 src/tests/Common/CLRTest.Execute.Batch.targets     | 14 ++++++++++++++
 .../stackoverflow/stackoverflowtester.csproj       |  5 +++--
 3 files changed, 30 insertions(+), 2 deletions(-)

diff --git a/src/tests/Common/CLRTest.Execute.Bash.targets b/src/tests/Common/CLRTest.Execute.Bash.targets
index 23205302d972e..ab25c3e0b77ec 100644
--- a/src/tests/Common/CLRTest.Execute.Bash.targets
+++ b/src/tests/Common/CLRTest.Execute.Bash.targets
@@ -127,6 +127,19 @@ then
   exit $(IncompatibleTestBashScriptExitCode)
 fi
       ]]></BashCLRTestEnvironmentCompatibilityCheck>
+      <BashCLRTestEnvironmentCompatibilityCheck Condition="'$(SuperPmiCollectIncompatible)' == 'true'"><![CDATA[
+$(BashCLRTestEnvironmentCompatibilityCheck)
+if [ ! -z "$SuperPMIShimPath" ]
+then
+  echo SKIPPING EXECUTION BECAUSE SuperPMIShimPath IS SET
+  exit $(IncompatibleTestBashScriptExitCode)
+fi
+if [ ! -z "$spmi_enable_collection" ]
+then
+  echo SKIPPING EXECUTION BECAUSE spmi_enable_collection IS SET
+  exit $(IncompatibleTestBashScriptExitCode)
+fi
+      ]]></BashCLRTestEnvironmentCompatibilityCheck>
 
       <BashCLRTestExitCodePrep Condition="$(_CLRTestNeedsToRun)">
 <![CDATA[
diff --git a/src/tests/Common/CLRTest.Execute.Batch.targets b/src/tests/Common/CLRTest.Execute.Batch.targets
index 2002d3aff5ade..edbccd0ec6f19 100644
--- a/src/tests/Common/CLRTest.Execute.Batch.targets
+++ b/src/tests/Common/CLRTest.Execute.Batch.targets
@@ -134,6 +134,20 @@ IF NOT "%CrossGen2SynthesizePgo%"=="" (
 )
       ]]></BatchCLRTestEnvironmentCompatibilityCheck>
 
+      <BatchCLRTestEnvironmentCompatibilityCheck Condition="'$(SuperPmiCollectIncompatible)' == 'true'"><![CDATA[
+$(BatchCLRTestEnvironmentCompatibilityCheck)
+IF NOT "%SuperPMIShimPath%"=="" (
+  ECHO SKIPPING EXECUTION BECAUSE SuperPMIShimPath IS SET
+  popd
+  Exit /b 0
+)
+IF NOT "%spmi_enable_collection%"=="" (
+  ECHO SKIPPING EXECUTION BECAUSE spmi_enable_collection IS SET
+  popd
+  Exit /b 0
+)
+      ]]></BatchCLRTestEnvironmentCompatibilityCheck>
+
       <BatchCLRTestExitCodePrep Condition="$(_CLRTestNeedsToRun)">
         <![CDATA[
 set CLRTestExpectedExitCode=$(CLRTestExitCode)
diff --git a/src/tests/baseservices/exceptions/stackoverflow/stackoverflowtester.csproj b/src/tests/baseservices/exceptions/stackoverflow/stackoverflowtester.csproj
index eb0ae0ea4cd17..1083bc6ddc2cf 100644
--- a/src/tests/baseservices/exceptions/stackoverflow/stackoverflowtester.csproj
+++ b/src/tests/baseservices/exceptions/stackoverflow/stackoverflowtester.csproj
@@ -1,13 +1,14 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <!-- Needed for GCStressIncompatible -->
+    <!-- Needed for GCStressIncompatible, SuperPMICollectIncompatible -->
     <RequiresProcessIsolation>true</RequiresProcessIsolation>
     <Optimize>false</Optimize>
     <!-- Fails in many GCStress jobs. https://github.com/dotnet/runtime/issues/46279 -->
     <GCStressIncompatible>true</GCStressIncompatible>
+    <!-- Exception handling in this test is incompatible with SuperPMI collection. See https://github.com/dotnet/runtime/issues/108215. -->
+    <SuperPMICollectIncompatible>true</SuperPMICollectIncompatible>
   </PropertyGroup>
   <ItemGroup>
     <Compile Include="stackoverflowtester.cs" />
   </ItemGroup>
 </Project>
-