Merge pull request Azure#1350 from jianghaolu/dstream

[Fixes #108813328] Turn on debug stream when terminating error is thrown

Author: markcowl

src/Common/Commands.Common/AzurePSCmdlet.cs

@@ -38,7 +38,7 @@ public abstract class AzurePSCmdlet : PSCmdlet, IDisposable
         protected readonly ConcurrentQueue<string> _debugMessages;
 
         private RecordingTracingInterceptor _httpTracingInterceptor;
-
+        
         private DebugStreamTraceListener _adalListener;
         protected static AzurePSDataCollectionProfile _dataCollectionProfile = null;
         protected static string _errorRecordFolderPath = null;
@@ -272,6 +272,12 @@ protected bool IsVerbose()
             base.WriteError(errorRecord);
         }
 
+        protected new void ThrowTerminatingError(ErrorRecord errorRecord)
+        {
+            FlushDebugMessages(IsDataCollectionAllowed());
+            base.ThrowTerminatingError(errorRecord);
+        }
+
         protected new void WriteObject(object sendToPipeline)
         {
             FlushDebugMessages();
@@ -515,6 +521,11 @@ protected virtual void Dispose(bool disposing)
 
         public void Dispose()
         {
+            try
+            {
+                FlushDebugMessages();
+            }
+            catch { }
             Dispose(true);
             GC.SuppressFinalize(this);
         }

src/ResourceManager/Resources/Commands.Resources.Test/Commands.Resources.Test.csproj

@@ -351,6 +351,9 @@
     <None Include="SessionRecords\Microsoft.Azure.Commands.Resources.Test.ScenarioTests.ResourceGroupTests\TestFindResourceGroup.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+    <None Include="SessionRecords\Microsoft.Azure.Commands.Resources.Test.ScenarioTests.ResourceGroupTests\TestGetNonExistingResourceGroupWithDebugStream.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
     <None Include="SessionRecords\Microsoft.Azure.Commands.Resources.Test.ScenarioTests.ResourceGroupTests\TestNewDeploymentAndProviderRegistration.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>

src/ResourceManager/Resources/Commands.Resources.Test/ScenarioTests/ResourceGroupTests.cs

@@ -87,5 +87,11 @@ public void TestRemoveDeployment()
         {
             ResourcesController.NewInstance.RunPsTest("Test-RemoveDeployment");
         }
+
+        [Fact]
+        public void TestGetNonExistingResourceGroupWithDebugStream()
+        {
+            ResourcesController.NewInstance.RunPsTest("Test-GetNonExistingResourceGroupWithDebugStream");
+        }
     }
 }

src/ResourceManager/Resources/Commands.Resources.Test/ScenarioTests/ResourceGroupTests.ps1

@@ -305,4 +305,16 @@ function Test-FindResourceGroup
         Clean-ResourceGroup $rgname
         Clean-ResourceGroup $rgname2
     }
+}
+
+<#
+.SYNOPSIS
+Tests remove non exist resource group and debug stream gets printed
+#>
+function Test-GetNonExistingResourceGroupWithDebugStream
+{
+    $ErrorActionPreference="Continue"
+    $output = $(Get-AzureRmResourceGroup -Name "InvalidNonExistRocks" -Debug) 2>&1 5>&1 | Out-String
+    $ErrorActionPreference="Stop"
+    Assert-True { $output -Like "*============================ HTTP RESPONSE ============================*" }
 }

src/ResourceManager/Resources/Commands.Resources.Test/SessionRecords/Microsoft.Azure.Commands.Resources.Test.ScenarioTests.ResourceGroupTests/TestGetNonExistingResourceGroupWithDebugStream.json

@@ -0,0 +1,61 @@
+{
+  "Entries": [
+    {
+      "RequestUri": "/subscriptions/3ca49042-782a-4cc9-89b5-ee1b487fe115/resourcegroups/InvalidNonExistRocks?api-version=2014-04-01-preview",
+      "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2NhNDkwNDItNzgyYS00Y2M5LTg5YjUtZWUxYjQ4N2ZlMTE1L3Jlc291cmNlZ3JvdXBzL0ludmFsaWROb25FeGlzdFJvY2tzP2FwaS12ZXJzaW9uPTIwMTQtMDQtMDEtcHJldmlldw==",
+      "RequestMethod": "GET",
+      "RequestBody": "",
+      "RequestHeaders": {
+        "User-Agent": [
+          "Microsoft.Azure.Management.Resources.ResourceManagementClient/2.0.0.0"
+        ]
+      },
+      "ResponseBody": "{\r\n  \"error\": {\r\n    \"code\": \"ResourceGroupNotFound\",\r\n    \"message\": \"Resource group 'InvalidNonExistRocks' could not be found.\"\r\n  }\r\n}",
+      "ResponseHeaders": {
+        "Content-Length": [
+          "112"
+        ],
+        "Content-Type": [
+          "application/json; charset=utf-8"
+        ],
+        "Expires": [
+          "-1"
+        ],
+        "Pragma": [
+          "no-cache"
+        ],
+        "x-ms-failure-cause": [
+          "gateway"
+        ],
+        "x-ms-ratelimit-remaining-subscription-reads": [
+          "14999"
+        ],
+        "x-ms-request-id": [
+          "3633e6fd-16ca-4f0d-830f-bfa2eacf42f9"
+        ],
+        "x-ms-correlation-request-id": [
+          "3633e6fd-16ca-4f0d-830f-bfa2eacf42f9"
+        ],
+        "x-ms-routing-request-id": [
+          "WESTUS:20151125T215815Z:3633e6fd-16ca-4f0d-830f-bfa2eacf42f9"
+        ],
+        "Strict-Transport-Security": [
+          "max-age=31536000; includeSubDomains"
+        ],
+        "Cache-Control": [
+          "no-cache"
+        ],
+        "Date": [
+          "Wed, 25 Nov 2015 21:58:14 GMT"
+        ]
+      },
+      "StatusCode": 404
+    }
+  ],
+  "Names": {},
+  "Variables": {
+    "SubscriptionId": "3ca49042-782a-4cc9-89b5-ee1b487fe115",
+    "TenantId": "1449d5b7-8a83-47db-ae4c-9b03e888bad0",
+    "Domain": "rbactest.onmicrosoft.com"
+  }
+}