Mitigate breaking build using SaveDebugRecordingsOnFailure (Azure#16599)

Tested with debug and release builds with and without SYSTEM_TEAMPROJECTID defined (used in a few projects for detecting AzDO). Doing this in the setter works when set in either a fixture's constructor or in a test method, while doing so in SetUp is too early, and in TearDown doesn't propagate.

Author: heaths

sdk/core/Azure.Core.TestFramework/src/RecordedTestBase.cs

@@ -34,16 +34,27 @@ public abstract class RecordedTestBase : ClientTestBase
             (char)31, ':', '*', '?', '\\', '/'
         });
 
-#if DEBUG
         /// <summary>
         /// Flag you can (temporarily) enable to save failed test recordings
         /// and debug/re-run at the point of failure without re-running
         /// potentially lengthy live tests.  This should never be checked in
-        /// and will be compiled out of release builds to help make that easier
+        /// and will throw an exception from CI builds to help make that easier
         /// to spot.
         /// </summary>
-        public bool SaveDebugRecordingsOnFailure { get; set; } = false;
-#endif
+        public bool SaveDebugRecordingsOnFailure
+        {
+            get => _saveDebugRecordingsOnFailure;
+            set
+            {
+                if (value && !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("SYSTEM_TEAMPROJECTID")))
+                {
+                    throw new AssertionException($"Setting {nameof(SaveDebugRecordingsOnFailure)} must not be merged");
+                }
+
+                _saveDebugRecordingsOnFailure = value;
+            }
+        }
+        private bool _saveDebugRecordingsOnFailure;
 
         protected RecordedTestBase(bool isAsync) : this(isAsync, RecordedTestUtilities.GetModeFromEnvironment())
         {

sdk/synapse/Azure.Analytics.Synapse.AccessControl/tests/AccessControlClientTestBase.cs

@@ -16,9 +16,6 @@ public abstract class AccessControlClientTestBase : RecordedTestBase<SynapseTest
 
         protected AccessControlClientTestBase(bool isAsync) : base(isAsync)
         {
-#if DEBUG
-            SaveDebugRecordingsOnFailure = true;
-#endif
         }
 
         public override void StartTestRecording()

sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/ArtifactsClientTestBase.cs

@@ -26,9 +26,6 @@ public abstract class ArtifactsClientTestBase : RecordedTestBase<SynapseTestEnvi
 
         protected ArtifactsClientTestBase(bool isAsync) : base(isAsync)
         {
-#if DEBUG
-            SaveDebugRecordingsOnFailure = true;
-#endif
         }
 
         public override void StartTestRecording()

sdk/synapse/Azure.Analytics.Synapse.ManagedPrivateEndpoints/tests/ManagedPrivateEndpointsClientTestBase.cs

@@ -16,9 +16,6 @@ public abstract class ManagedPrivateEndpointsClientTestBase : RecordedTestBase<S
 
         protected ManagedPrivateEndpointsClientTestBase(bool isAsync) : base(isAsync)
         {
-#if DEBUG
-            SaveDebugRecordingsOnFailure = true;
-#endif
         }
 
         public override void StartTestRecording()

sdk/synapse/Azure.Analytics.Synapse.Monitoring/tests/MonitoringClientTestBase.cs

@@ -16,9 +16,6 @@ public abstract class MonitoringClientTestBase : RecordedTestBase<SynapseTestEnv
 
         protected MonitoringClientTestBase(bool isAsync) : base(isAsync)
         {
-#if DEBUG
-            SaveDebugRecordingsOnFailure = true;
-#endif
         }
 
         public override void StartTestRecording()

sdk/synapse/Azure.Analytics.Synapse.Spark/tests/SparkClientTestBase.cs

@@ -19,9 +19,6 @@ public abstract class SparkClientTestBase : RecordedTestBase<SynapseTestEnvironm
 
         protected SparkClientTestBase(bool isAsync) : base(isAsync)
         {
-#if DEBUG
-            SaveDebugRecordingsOnFailure = true;
-#endif
         }
 
         public override void StartTestRecording()