Improve exception handling in Cortex cmdlets

anton-evseev · anton-evseev · commit e2956c87d197 · 2019-09-26T13:31:50.000-07:00
diff --git a/src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.CortexTests/TestCortexCRUD.json b/src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.CortexTests/TestCortexCRUD.json
diff --git a/src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.CortexTests/TestCortexExpressRouteCRUD.json b/src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.CortexTests/TestCortexExpressRouteCRUD.json
diff --git a/src/Network/Network/ChangeLog.md b/src/Network/Network/ChangeLog.md
@@ -19,6 +19,7 @@
 --->
 
 ## Upcoming Release
+* Improve handling of exceptions in Cortex cmdlets
 * Fix incorrect example in `New-AzApplicationGateway` reference documentation 
 * Add note in `Get-AzNetworkWatcherPacketCapture` reference documentation about retrieving all properties for a packet capture
 * Fixed example in `Test-AzNetworkWatcherIPFlow` reference documentation to correctly enumerate NICs
diff --git a/src/Network/Network/Common/NetworkBaseCmdlet.cs b/src/Network/Network/Common/NetworkBaseCmdlet.cs
@@ -81,5 +81,39 @@ public static string GetResourceGroup(string resourceId)
 
             return resourceId.Substring(startIndex, endIndex - startIndex);
         }
+
+        public static bool IsResourcePresent(Action fn)
+        {
+            try
+            {
+                fn();
+            }
+            catch (Rest.Azure.CloudException exception)
+            {
+                if (exception.Response.StatusCode == System.Net.HttpStatusCode.NotFound)
+                {
+                    return false;
+                }
+                throw;
+            }
+            catch (Microsoft.Azure.Management.Network.Models.ErrorException exception)
+            {
+                if (exception.Response.StatusCode == System.Net.HttpStatusCode.NotFound)
+                {
+                    return false;
+                }
+                throw;
+            }
+            catch (Microsoft.Azure.Management.Network.Models.ErrorResponseException exception)
+            {
+                if (exception.Response.StatusCode == System.Net.HttpStatusCode.NotFound)
+                {
+                    return false;
+                }
+                throw;
+            }
+
+            return true;
+        }
     }
 }
diff --git a/src/Network/Network/Cortex/HubVnetConnection/HubVnetConnectionBaseCmdlet.cs b/src/Network/Network/Cortex/HubVnetConnection/HubVnetConnectionBaseCmdlet.cs
@@ -65,20 +65,7 @@ public List<PSHubVirtualNetworkConnection> ListHubVnetConnections(string resourc
 
         public bool IsHubVnetConnectionPresent(string resourceGroupName, string parentHubName, string name)
         {
-            try
-            {
-                this.GetHubVirtualNetworkConnection(resourceGroupName, parentHubName, name);
-            }
-            catch (Microsoft.Azure.Management.Network.Models.ErrorException exception)
-            {
-                if (exception.Response.StatusCode == HttpStatusCode.NotFound)
-                {
-                    // Resource is not present
-                    return false;
-                }
-            }
-
-            return true;
+            return NetworkBaseCmdlet.IsResourcePresent(() => { GetHubVirtualNetworkConnection(resourceGroupName, parentHubName, name); });
         }
     }
 }
diff --git a/src/Network/Network/Cortex/VirtualHub/VirtualHubBaseCmdlet.cs b/src/Network/Network/Cortex/VirtualHub/VirtualHubBaseCmdlet.cs
@@ -45,24 +45,23 @@ public PSVirtualHub ToPsVirtualHub(Management.Network.Models.VirtualHub virtualH
 
         public PSVirtualHub GetVirtualHub(string resourceGroupName, string name)
         {
-            MNM.VirtualHub virtualHub = null;
-            PSVirtualHub psVirtualHub = null;
-
             try
             {
                 //// The following code will throw if resource is not found
-                virtualHub = this.VirtualHubClient.Get(resourceGroupName, name);
+                MNM.VirtualHub virtualHub = this.VirtualHubClient.Get(resourceGroupName, name);
 
-                psVirtualHub = ToPsVirtualHub(virtualHub);
+                PSVirtualHub psVirtualHub = ToPsVirtualHub(virtualHub);
                 psVirtualHub.ResourceGroupName = resourceGroupName;
+                return psVirtualHub;
             }
-            catch (Microsoft.Azure.Management.Network.Models.ErrorException)
+            catch (Exception ex)
             {
-                    // Resource is not present
-                    return psVirtualHub;
+                if (ex is Microsoft.Azure.Management.Network.Models.ErrorException || ex is Rest.Azure.CloudException)
+                {
+                    return null;
+                }
+                throw;
             }
-
-            return psVirtualHub;
         }
 
         public bool IsVirtualHubPresent(string resourceGroupName, string name)
diff --git a/src/Network/Network/Cortex/VirtualWan/VirtualWanBaseCmdlet.cs b/src/Network/Network/Cortex/VirtualWan/VirtualWanBaseCmdlet.cs
@@ -107,20 +107,7 @@ public List<PSVirtualWan> ListVirtualWans(string resourceGroupName)
 
         public bool IsVirtualWanPresent(string resourceGroupName, string name)
         {
-            try
-            {
-                GetVirtualWan(resourceGroupName, name);
-            }
-            catch (Microsoft.Azure.Management.Network.Models.ErrorException exception)
-            {
-                if (exception.Response.StatusCode == HttpStatusCode.NotFound)
-                {
-                    // Resource is not present
-                    return false;
-                }
-            }
-
-            return true;
+            return NetworkBaseCmdlet.IsResourcePresent(() => { GetVirtualWan(resourceGroupName, name); });
         }
     }
 }
diff --git a/src/Network/Network/Cortex/VpnConnection/VpnConnectionBaseCmdlet.cs b/src/Network/Network/Cortex/VpnConnection/VpnConnectionBaseCmdlet.cs
@@ -63,20 +63,7 @@ public List<PSVpnConnection> ListVpnConnections(string resourceGroupName, string
 
         public bool IsVpnConnectionPresent(string resourceGroupName, string parentVpnGatewayName, string name)
         {
-            try
-            {
-                this.GetVpnConnection(resourceGroupName, parentVpnGatewayName, name);
-            }
-            catch (Microsoft.Azure.Management.Network.Models.ErrorException exception)
-            {
-                if (exception.Response.StatusCode == HttpStatusCode.NotFound)
-                {
-                    // Resource is not present
-                    return false;
-                }
-            }
-
-            return true;
+            return NetworkBaseCmdlet.IsResourcePresent(() => { GetVpnConnection(resourceGroupName, parentVpnGatewayName, name); });
         }
     }
 }
diff --git a/src/Network/Network/Cortex/VpnGateway/VpnGatewayBaseCmdlet.cs b/src/Network/Network/Cortex/VpnGateway/VpnGatewayBaseCmdlet.cs
@@ -86,20 +86,7 @@ public PSVpnGateway CreateOrUpdateVpnGateway(string resourceGroupName, string vp
 
         public bool IsVpnGatewayPresent(string resourceGroupName, string name)
         {
-            try
-            {
-                GetVpnGateway(resourceGroupName, name);
-            }
-            catch (Microsoft.Azure.Management.Network.Models.ErrorException exception)
-            {
-                if (exception.Response.StatusCode == HttpStatusCode.NotFound)
-                {
-                    // Resource is not present
-                    return false;
-                }
-            }
-
-            return true;
+            return NetworkBaseCmdlet.IsResourcePresent(() => { GetVpnGateway(resourceGroupName, name); });
         }
     }
 }
diff --git a/src/Network/Network/Cortex/VpnSite/VpnSiteBaseCmdlet.cs b/src/Network/Network/Cortex/VpnSite/VpnSiteBaseCmdlet.cs
@@ -113,20 +113,7 @@ public List<PSVpnSite> ListVpnSites(string resourceGroupName)
 
         public bool IsVpnSitePresent(string resourceGroupName, string name)
         {
-            try
-            {
-                GetVpnSite(resourceGroupName, name);
-            }
-            catch (Microsoft.Azure.Management.Network.Models.ErrorException exception)
-            {
-                if (exception.Response.StatusCode == HttpStatusCode.NotFound)
-                {
-                    // Resource is not present
-                    return false;
-                }
-            }
-
-            return true;
+            return NetworkBaseCmdlet.IsResourcePresent( () => { GetVpnSite(resourceGroupName, name); } );
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -65,20 +65,7 @@ public List<PSHubVirtualNetworkConnection> ListHubVnetConnections(string resourc`
`65`	`65`
`66`	`66`	`public bool IsHubVnetConnectionPresent(string resourceGroupName, string parentHubName, string name)`
`67`	`67`	`{`
`68`		`- try`
`69`		`- {`
`70`		`- this.GetHubVirtualNetworkConnection(resourceGroupName, parentHubName, name);`
`71`		`- }`
`72`		`- catch (Microsoft.Azure.Management.Network.Models.ErrorException exception)`
`73`		`- {`
`74`		`- if (exception.Response.StatusCode == HttpStatusCode.NotFound)`
`75`		`- {`
`76`		`- // Resource is not present`
`77`		`- return false;`
`78`		`- }`
`79`		`- }`
`80`		`-`
`81`		`- return true;`
	`68`	`+ return NetworkBaseCmdlet.IsResourcePresent(() => { GetHubVirtualNetworkConnection(resourceGroupName, parentHubName, name); });`
`82`	`69`	`}`
`83`	`70`	`}`
`84`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,24 +45,23 @@ public PSVirtualHub ToPsVirtualHub(Management.Network.Models.VirtualHub virtualH`
`45`	`45`
`46`	`46`	`public PSVirtualHub GetVirtualHub(string resourceGroupName, string name)`
`47`	`47`	`{`
`48`		`- MNM.VirtualHub virtualHub = null;`
`49`		`- PSVirtualHub psVirtualHub = null;`
`50`		`-`
`51`	`48`	`try`
`52`	`49`	`{`
`53`	`50`	`//// The following code will throw if resource is not found`
`54`		`- virtualHub = this.VirtualHubClient.Get(resourceGroupName, name);`
	`51`	`+ MNM.VirtualHub virtualHub = this.VirtualHubClient.Get(resourceGroupName, name);`
`55`	`52`
`56`		`- psVirtualHub = ToPsVirtualHub(virtualHub);`
	`53`	`+ PSVirtualHub psVirtualHub = ToPsVirtualHub(virtualHub);`
`57`	`54`	`psVirtualHub.ResourceGroupName = resourceGroupName;`
	`55`	`+ return psVirtualHub;`
`58`	`56`	`}`
`59`		`- catch (Microsoft.Azure.Management.Network.Models.ErrorException)`
	`57`	`+ catch (Exception ex)`
`60`	`58`	`{`
`61`		`- // Resource is not present`
`62`		`- return psVirtualHub;`
	`59`	`+ if (ex is Microsoft.Azure.Management.Network.Models.ErrorException \|\| ex is Rest.Azure.CloudException)`
	`60`	`+ {`
	`61`	`+ return null;`
	`62`	`+ }`
	`63`	`+ throw;`
`63`	`64`	`}`
`64`		`-`
`65`		`- return psVirtualHub;`
`66`	`65`	`}`
`67`	`66`
`68`	`67`	`public bool IsVirtualHubPresent(string resourceGroupName, string name)`
Original file line number	Diff line number	Diff line change
`@@ -107,20 +107,7 @@ public List<PSVirtualWan> ListVirtualWans(string resourceGroupName)`
`107`	`107`
`108`	`108`	`public bool IsVirtualWanPresent(string resourceGroupName, string name)`
`109`	`109`	`{`
`110`		`- try`
`111`		`- {`
`112`		`- GetVirtualWan(resourceGroupName, name);`
`113`		`- }`
`114`		`- catch (Microsoft.Azure.Management.Network.Models.ErrorException exception)`
`115`		`- {`
`116`		`- if (exception.Response.StatusCode == HttpStatusCode.NotFound)`
`117`		`- {`
`118`		`- // Resource is not present`
`119`		`- return false;`
`120`		`- }`
`121`		`- }`
`122`		`-`
`123`		`- return true;`
	`110`	`+ return NetworkBaseCmdlet.IsResourcePresent(() => { GetVirtualWan(resourceGroupName, name); });`
`124`	`111`	`}`
`125`	`112`	`}`
`126`	`113`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,20 +63,7 @@ public List<PSVpnConnection> ListVpnConnections(string resourceGroupName, string`
`63`	`63`
`64`	`64`	`public bool IsVpnConnectionPresent(string resourceGroupName, string parentVpnGatewayName, string name)`
`65`	`65`	`{`
`66`		`- try`
`67`		`- {`
`68`		`- this.GetVpnConnection(resourceGroupName, parentVpnGatewayName, name);`
`69`		`- }`
`70`		`- catch (Microsoft.Azure.Management.Network.Models.ErrorException exception)`
`71`		`- {`
`72`		`- if (exception.Response.StatusCode == HttpStatusCode.NotFound)`
`73`		`- {`
`74`		`- // Resource is not present`
`75`		`- return false;`
`76`		`- }`
`77`		`- }`
`78`		`-`
`79`		`- return true;`
	`66`	`+ return NetworkBaseCmdlet.IsResourcePresent(() => { GetVpnConnection(resourceGroupName, parentVpnGatewayName, name); });`
`80`	`67`	`}`
`81`	`68`	`}`
`82`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -86,20 +86,7 @@ public PSVpnGateway CreateOrUpdateVpnGateway(string resourceGroupName, string vp`
`86`	`86`
`87`	`87`	`public bool IsVpnGatewayPresent(string resourceGroupName, string name)`
`88`	`88`	`{`
`89`		`- try`
`90`		`- {`
`91`		`- GetVpnGateway(resourceGroupName, name);`
`92`		`- }`
`93`		`- catch (Microsoft.Azure.Management.Network.Models.ErrorException exception)`
`94`		`- {`
`95`		`- if (exception.Response.StatusCode == HttpStatusCode.NotFound)`
`96`		`- {`
`97`		`- // Resource is not present`
`98`		`- return false;`
`99`		`- }`
`100`		`- }`
`101`		`-`
`102`		`- return true;`
	`89`	`+ return NetworkBaseCmdlet.IsResourcePresent(() => { GetVpnGateway(resourceGroupName, name); });`
`103`	`90`	`}`
`104`	`91`	`}`
`105`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -113,20 +113,7 @@ public List<PSVpnSite> ListVpnSites(string resourceGroupName)`
`113`	`113`
`114`	`114`	`public bool IsVpnSitePresent(string resourceGroupName, string name)`
`115`	`115`	`{`
`116`		`- try`
`117`		`- {`
`118`		`- GetVpnSite(resourceGroupName, name);`
`119`		`- }`
`120`		`- catch (Microsoft.Azure.Management.Network.Models.ErrorException exception)`
`121`		`- {`
`122`		`- if (exception.Response.StatusCode == HttpStatusCode.NotFound)`
`123`		`- {`
`124`		`- // Resource is not present`
`125`		`- return false;`
`126`		`- }`
`127`		`- }`
`128`		`-`
`129`		`- return true;`
	`116`	`+ return NetworkBaseCmdlet.IsResourcePresent( () => { GetVpnSite(resourceGroupName, name); } );`
`130`	`117`	`}`
`131`	`118`	`}`
`132`	`119`	`}`