Fix error case handling for device details related cmdlets

rajsing · rajsing · commit af86129a47ee · 2015-03-25T17:16:04.000+05:30
diff --git a/src/ServiceManagement/StorSimple/Commands.StorSimple/Cmdlets/DeviceDetails/NewAzureStorSimpleNetworkConfig.cs b/src/ServiceManagement/StorSimple/Commands.StorSimple/Cmdlets/DeviceDetails/NewAzureStorSimpleNetworkConfig.cs
@@ -113,13 +113,9 @@ public class NewAzureStorSimpleNetworkConfig : StorSimpleCmdletBase
 
         public override void ExecuteCmdlet()
         {
-            if (!ProcessParameters())
-            {
-                WriteObject(null);
-                return;
-            }
             try
             {
+                ProcessParameters();
                 var netConfig = new NetworkConfig
                 {
                     IsIscsiEnabled = EnableIscsi,
@@ -144,12 +140,11 @@ public override void ExecuteCmdlet()
             }
         }
 
-        private bool ProcessParameters(){
+        private void ProcessParameters(){
             // parse interfaceAlias
             if (!Enum.TryParse<NetInterfaceId>(InterfaceAlias, out interfaceAlias))
             {
-                WriteVerbose(string.Format(Resources.InvalidInterfaceId, InterfaceAlias));
-                return false;
+                throw new ArgumentException(string.Format(Resources.InvalidInterfaceId, InterfaceAlias));
             }
 
             // Try and set all the IP address
@@ -166,23 +161,18 @@ private bool ProcessParameters(){
                 if(IPv4Address != null || IPv4Gateway != null || IPv4Netmask != null
                     && IPv6Gateway != null || IPv6Prefix != null || EnableCloud != null)
                 {
-                    WriteVerbose(Resources.NetworkConfigData0AllowedSettings);
-                    return false;
+                    throw new ArgumentException(Resources.NetworkConfigData0AllowedSettings);
                 }
             }
             // On other interfaces (non-Data0), Controller0 and Controller1 IP Addresses cannot be set
             else
             {
                 if (Controller0IPv4Address != null || Controller1IPv4Address != null)
                 {
-                    WriteVerbose(Resources.NetworkConfigControllerIPsNotAllowedOnOthers);
-                    return false;
+                    throw new ArgumentException(Resources.NetworkConfigControllerIPsNotAllowedOnOthers);
                 }
             }
-
-            return true;
         }
-
     }
 }
 
diff --git a/src/ServiceManagement/StorSimple/Commands.StorSimple/Cmdlets/DeviceDetails/SetAzureStorSimpleDevice.cs b/src/ServiceManagement/StorSimple/Commands.StorSimple/Cmdlets/DeviceDetails/SetAzureStorSimpleDevice.cs
@@ -82,35 +82,25 @@ public override void ExecuteCmdlet()
             try
             {
                 // Make sure params were supplied appropriately.
-                if (!ProcessParameters())
-                {
-                    return;
-                }
+                ProcessParameters();
 
                 // Get the current device details.
                 var deviceDetails = StorSimpleClient.GetDeviceDetails(DeviceId);
 
                 if (deviceDetails == null)
                 {
-                    WriteVerbose(string.Format(Resources.NoDeviceFoundWithGivenIdInResourceMessage, StorSimpleContext.ResourceName, DeviceId));
-                    WriteObject(null);
-                    return;
+                    throw new ArgumentException(string.Format(Resources.NoDeviceFoundWithGivenIdInResourceMessage, StorSimpleContext.ResourceName, DeviceId));
                 }
 
                 // If the device is being configured for the first time, validate that mandatory params 
                 // for first setup have been provided
                 if (!deviceDetails.DeviceProperties.IsConfigUpdated && !ValidParamsForFirstDeviceConfiguration(StorSimpleNetworkConfig, TimeZone, SecondaryDnsServer))
                 {
-                    WriteVerbose(Resources.MandatoryParamsMissingForInitialDeviceConfiguration);
-                    WriteObject(null);
-                    return;
-                }
-
-                if (!this.ValidateNetworkConfigs(deviceDetails, StorSimpleNetworkConfig))
-                {
-                    return;
+                    throw new ArgumentException(Resources.MandatoryParamsMissingForInitialDeviceConfiguration);
                 }
 
+                // Validate Network configs - this method throws an exception if any validation fails
+                ValidateNetworkConfigs(deviceDetails, StorSimpleNetworkConfig);
                 
                 WriteVerbose(string.Format(Resources.BeginningDeviceConfiguration, deviceDetails.DeviceProperties.FriendlyName));
 
@@ -133,22 +123,19 @@ public override void ExecuteCmdlet()
             }
         }
 
-        private bool ProcessParameters()
+        private void ProcessParameters()
         {
             // Make sure that the DeviceId property has the appropriate value irrespective of the parameter set
             if (ParameterSetName == StorSimpleCmdletParameterSet.IdentifyByName)
             {
                 var deviceId = StorSimpleClient.GetDeviceId(DeviceName);
                 if (deviceId == null)
                 {
-                    WriteVerbose(string.Format(Resources.NoDeviceFoundWithGivenNameInResourceMessage, StorSimpleContext.ResourceName, DeviceName));
-                    WriteObject(null);
-                    return false;
+                    throw new ArgumentException(string.Format(Resources.NoDeviceFoundWithGivenNameInResourceMessage, StorSimpleContext.ResourceName, DeviceName));
                 }
                 DeviceId = deviceId;
             }
             TrySetIPAddress(SecondaryDnsServer, out secondaryDnsServer, "SecondaryDnsServer");
-            return true;
         }
     }
 }
diff --git a/src/ServiceManagement/StorSimple/Commands.StorSimple/Cmdlets/DeviceDetails/SetAzureStorSimpleVirtualDevice.cs b/src/ServiceManagement/StorSimple/Commands.StorSimple/Cmdlets/DeviceDetails/SetAzureStorSimpleVirtualDevice.cs
@@ -61,9 +61,7 @@ public override void ExecuteCmdlet()
                 var deviceId = StorSimpleClient.GetDeviceId(DeviceName);
                 if (deviceId == null)
                 {
-                    WriteVerbose(string.Format(Resources.NoDeviceFoundWithGivenNameInResourceMessage, StorSimpleContext.ResourceName, DeviceName));
-                    WriteObject(null);
-                    return;
+                    throw new ArgumentException(string.Format(Resources.NoDeviceFoundWithGivenNameInResourceMessage, StorSimpleContext.ResourceName, DeviceName));
                 }
 
                 // Get the current device details. ( If we found id from the name, this call is bound to succeed)
diff --git a/src/ServiceManagement/StorSimple/Commands.StorSimple/StorSimpleCmdletBase.cs b/src/ServiceManagement/StorSimple/Commands.StorSimple/StorSimpleCmdletBase.cs
@@ -414,12 +414,11 @@ internal Exception GetGenericException(string exceptionMessage, Exception innerE
         /// Its mandatory to provide either (IPv4 Address and netmask) or IPv6 orefix for an interface that
         /// is being enabled. ( Was previously disabled and is now being configured)
         /// </summary>
-        /// <returns></returns>
-        internal bool ValidateNetworkConfigs(DeviceDetails details, NetworkConfig[] StorSimpleNetworkConfig)
+        internal void ValidateNetworkConfigs(DeviceDetails details, NetworkConfig[] StorSimpleNetworkConfig)
         {
             if (StorSimpleNetworkConfig == null)
             {
-                return true;
+                return;
             }
             foreach (var netConfig in StorSimpleNetworkConfig)
             {
@@ -431,13 +430,10 @@ internal bool ValidateNetworkConfigs(DeviceDetails details, NetworkConfig[] Stor
                     // If its not an enabled interface either IPv6(prefix) or IPv4(address and mask) must be provided.
                     if ((netConfig.IPv4Address == null || netConfig.IPv4Netmask == null) && netConfig.IPv6Prefix == null)
                     {
-                        WriteVerbose(string.Format(Resources.IPAddressesNotProvidedForNetInterfaceBeingEnabled, StorSimpleContext.ResourceName, details.DeviceProperties.DeviceId));
-                        WriteObject(null);
-                        return false;
+                        throw new ArgumentException(string.Format(Resources.IPAddressesNotProvidedForNetInterfaceBeingEnabled, StorSimpleContext.ResourceName, details.DeviceProperties.DeviceId));
                     }
                 }
             }
-            return true;
         }
 
         /// <summary>
@@ -451,6 +447,7 @@ internal void TrySetIPAddress(string data, out IPAddress ipAddress, string param
             if (data == null)
             {
                 ipAddress = null;
+                return;
             }
             try
             {

Original file line number	Diff line number	Diff line change
`@@ -113,13 +113,9 @@ public class NewAzureStorSimpleNetworkConfig : StorSimpleCmdletBase`
`113`	`113`
`114`	`114`	`public override void ExecuteCmdlet()`
`115`	`115`	`{`
`116`		`- if (!ProcessParameters())`
`117`		`- {`
`118`		`- WriteObject(null);`
`119`		`- return;`
`120`		`- }`
`121`	`116`	`try`
`122`	`117`	`{`
	`118`	`+ ProcessParameters();`
`123`	`119`	`var netConfig = new NetworkConfig`
`124`	`120`	`{`
`125`	`121`	`IsIscsiEnabled = EnableIscsi,`
`@@ -144,12 +140,11 @@ public override void ExecuteCmdlet()`
`144`	`140`	`}`
`145`	`141`	`}`
`146`	`142`
`147`		`- private bool ProcessParameters(){`
	`143`	`+ private void ProcessParameters(){`
`148`	`144`	`// parse interfaceAlias`
`149`	`145`	`if (!Enum.TryParse<NetInterfaceId>(InterfaceAlias, out interfaceAlias))`
`150`	`146`	`{`
`151`		`- WriteVerbose(string.Format(Resources.InvalidInterfaceId, InterfaceAlias));`
`152`		`- return false;`
	`147`	`+ throw new ArgumentException(string.Format(Resources.InvalidInterfaceId, InterfaceAlias));`
`153`	`148`	`}`
`154`	`149`
`155`	`150`	`// Try and set all the IP address`
`@@ -166,23 +161,18 @@ private bool ProcessParameters(){`
`166`	`161`	`if(IPv4Address != null \|\| IPv4Gateway != null \|\| IPv4Netmask != null`
`167`	`162`	`&& IPv6Gateway != null \|\| IPv6Prefix != null \|\| EnableCloud != null)`
`168`	`163`	`{`
`169`		`- WriteVerbose(Resources.NetworkConfigData0AllowedSettings);`
`170`		`- return false;`
	`164`	`+ throw new ArgumentException(Resources.NetworkConfigData0AllowedSettings);`
`171`	`165`	`}`
`172`	`166`	`}`
`173`	`167`	`// On other interfaces (non-Data0), Controller0 and Controller1 IP Addresses cannot be set`
`174`	`168`	`else`
`175`	`169`	`{`
`176`	`170`	`if (Controller0IPv4Address != null \|\| Controller1IPv4Address != null)`
`177`	`171`	`{`
`178`		`- WriteVerbose(Resources.NetworkConfigControllerIPsNotAllowedOnOthers);`
`179`		`- return false;`
	`172`	`+ throw new ArgumentException(Resources.NetworkConfigControllerIPsNotAllowedOnOthers);`
`180`	`173`	`}`
`181`	`174`	`}`
`182`		`-`
`183`		`- return true;`
`184`	`175`	`}`
`185`		`-`
`186`	`176`	`}`
`187`	`177`	`}`
`188`	`178`
Original file line number	Diff line number	Diff line change
`@@ -82,35 +82,25 @@ public override void ExecuteCmdlet()`
`82`	`82`	`try`
`83`	`83`	`{`
`84`	`84`	`// Make sure params were supplied appropriately.`
`85`		`- if (!ProcessParameters())`
`86`		`- {`
`87`		`- return;`
`88`		`- }`
	`85`	`+ ProcessParameters();`
`89`	`86`
`90`	`87`	`// Get the current device details.`
`91`	`88`	`var deviceDetails = StorSimpleClient.GetDeviceDetails(DeviceId);`
`92`	`89`
`93`	`90`	`if (deviceDetails == null)`
`94`	`91`	`{`
`95`		`- WriteVerbose(string.Format(Resources.NoDeviceFoundWithGivenIdInResourceMessage, StorSimpleContext.ResourceName, DeviceId));`
`96`		`- WriteObject(null);`
`97`		`- return;`
	`92`	`+ throw new ArgumentException(string.Format(Resources.NoDeviceFoundWithGivenIdInResourceMessage, StorSimpleContext.ResourceName, DeviceId));`
`98`	`93`	`}`
`99`	`94`
`100`	`95`	`// If the device is being configured for the first time, validate that mandatory params`
`101`	`96`	`// for first setup have been provided`
`102`	`97`	`if (!deviceDetails.DeviceProperties.IsConfigUpdated && !ValidParamsForFirstDeviceConfiguration(StorSimpleNetworkConfig, TimeZone, SecondaryDnsServer))`
`103`	`98`	`{`
`104`		`- WriteVerbose(Resources.MandatoryParamsMissingForInitialDeviceConfiguration);`
`105`		`- WriteObject(null);`
`106`		`- return;`
`107`		`- }`
`108`		`-`
`109`		`- if (!this.ValidateNetworkConfigs(deviceDetails, StorSimpleNetworkConfig))`
`110`		`- {`
`111`		`- return;`
	`99`	`+ throw new ArgumentException(Resources.MandatoryParamsMissingForInitialDeviceConfiguration);`
`112`	`100`	`}`
`113`	`101`
	`102`	`+ // Validate Network configs - this method throws an exception if any validation fails`
	`103`	`+ ValidateNetworkConfigs(deviceDetails, StorSimpleNetworkConfig);`
`114`	`104`
`115`	`105`	`WriteVerbose(string.Format(Resources.BeginningDeviceConfiguration, deviceDetails.DeviceProperties.FriendlyName));`
`116`	`106`
`@@ -133,22 +123,19 @@ public override void ExecuteCmdlet()`
`133`	`123`	`}`
`134`	`124`	`}`
`135`	`125`
`136`		`- private bool ProcessParameters()`
	`126`	`+ private void ProcessParameters()`
`137`	`127`	`{`
`138`	`128`	`// Make sure that the DeviceId property has the appropriate value irrespective of the parameter set`
`139`	`129`	`if (ParameterSetName == StorSimpleCmdletParameterSet.IdentifyByName)`
`140`	`130`	`{`
`141`	`131`	`var deviceId = StorSimpleClient.GetDeviceId(DeviceName);`
`142`	`132`	`if (deviceId == null)`
`143`	`133`	`{`
`144`		`- WriteVerbose(string.Format(Resources.NoDeviceFoundWithGivenNameInResourceMessage, StorSimpleContext.ResourceName, DeviceName));`
`145`		`- WriteObject(null);`
`146`		`- return false;`
	`134`	`+ throw new ArgumentException(string.Format(Resources.NoDeviceFoundWithGivenNameInResourceMessage, StorSimpleContext.ResourceName, DeviceName));`
`147`	`135`	`}`
`148`	`136`	`DeviceId = deviceId;`
`149`	`137`	`}`
`150`	`138`	`TrySetIPAddress(SecondaryDnsServer, out secondaryDnsServer, "SecondaryDnsServer");`
`151`		`- return true;`
`152`	`139`	`}`
`153`	`140`	`}`
`154`	`141`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,9 +61,7 @@ public override void ExecuteCmdlet()`
`61`	`61`	`var deviceId = StorSimpleClient.GetDeviceId(DeviceName);`
`62`	`62`	`if (deviceId == null)`
`63`	`63`	`{`
`64`		`- WriteVerbose(string.Format(Resources.NoDeviceFoundWithGivenNameInResourceMessage, StorSimpleContext.ResourceName, DeviceName));`
`65`		`- WriteObject(null);`
`66`		`- return;`
	`64`	`+ throw new ArgumentException(string.Format(Resources.NoDeviceFoundWithGivenNameInResourceMessage, StorSimpleContext.ResourceName, DeviceName));`
`67`	`65`	`}`
`68`	`66`
`69`	`67`	`// Get the current device details. ( If we found id from the name, this call is bound to succeed)`
Original file line number	Diff line number	Diff line change
`@@ -414,12 +414,11 @@ internal Exception GetGenericException(string exceptionMessage, Exception innerE`
`414`	`414`	`/// Its mandatory to provide either (IPv4 Address and netmask) or IPv6 orefix for an interface that`
`415`	`415`	`/// is being enabled. ( Was previously disabled and is now being configured)`
`416`	`416`	`/// </summary>`
`417`		`- /// <returns></returns>`
`418`		`- internal bool ValidateNetworkConfigs(DeviceDetails details, NetworkConfig[] StorSimpleNetworkConfig)`
	`417`	`+ internal void ValidateNetworkConfigs(DeviceDetails details, NetworkConfig[] StorSimpleNetworkConfig)`
`419`	`418`	`{`
`420`	`419`	`if (StorSimpleNetworkConfig == null)`
`421`	`420`	`{`
`422`		`- return true;`
	`421`	`+ return;`
`423`	`422`	`}`
`424`	`423`	`foreach (var netConfig in StorSimpleNetworkConfig)`
`425`	`424`	`{`
`@@ -431,13 +430,10 @@ internal bool ValidateNetworkConfigs(DeviceDetails details, NetworkConfig[] Stor`
`431`	`430`	`// If its not an enabled interface either IPv6(prefix) or IPv4(address and mask) must be provided.`
`432`	`431`	`if ((netConfig.IPv4Address == null \|\| netConfig.IPv4Netmask == null) && netConfig.IPv6Prefix == null)`
`433`	`432`	`{`
`434`		`- WriteVerbose(string.Format(Resources.IPAddressesNotProvidedForNetInterfaceBeingEnabled, StorSimpleContext.ResourceName, details.DeviceProperties.DeviceId));`
`435`		`- WriteObject(null);`
`436`		`- return false;`
	`433`	`+ throw new ArgumentException(string.Format(Resources.IPAddressesNotProvidedForNetInterfaceBeingEnabled, StorSimpleContext.ResourceName, details.DeviceProperties.DeviceId));`
`437`	`434`	`}`
`438`	`435`	`}`
`439`	`436`	`}`
`440`		`- return true;`
`441`	`437`	`}`
`442`	`438`
`443`	`439`	`/// <summary>`
`@@ -451,6 +447,7 @@ internal void TrySetIPAddress(string data, out IPAddress ipAddress, string param`
`451`	`447`	`if (data == null)`
`452`	`448`	`{`
`453`	`449`	`ipAddress = null;`
	`450`	`+ return;`
`454`	`451`	`}`
`455`	`452`	`try`
`456`	`453`	`{`