Update error handling in Uninstall-PSResource (#1215)

Author: alerickson

src/code/UninstallPSResource.cs

@@ -100,10 +100,11 @@ protected override void ProcessRecord()
                     }
                     else if (!Utils.TryParseVersionOrVersionRange(Version, out _versionRange))
                     {
-                        var exMessage = "Argument for -Version parameter is not in the proper format.";
-                        var ex = new ArgumentException(exMessage);
-                        var IncorrectVersionFormat = new ErrorRecord(ex, "IncorrectVersionFormat", ErrorCategory.InvalidArgument, null);
-                        ThrowTerminatingError(IncorrectVersionFormat);
+                        ThrowTerminatingError(new ErrorRecord(
+                            new ArgumentException("Argument for -Version parameter is not in the proper format."), 
+                            "IncorrectVersionFormat", 
+                            ErrorCategory.InvalidArgument, 
+                            this));
                     }
 
                     Name = Utils.ProcessNameWildcards(Name, removeWildcardEntries:false, out string[] errorMsgs, out bool _);
@@ -124,13 +125,12 @@ protected override void ProcessRecord()
                         return;
                     }
 
-                    if (!UninstallPkgHelper())
+                    if (!UninstallPkgHelper(out List<ErrorRecord> errRecords))
                     {
-                        // any errors should be caught lower in the stack
-                        var exMessage = "Did not successfully uninstall package";
-                        var ex = new Exception(exMessage);
-                        var UninstallPackageError = new ErrorRecord(ex, "UninstallResourceError", ErrorCategory.InvalidOperation, null);
-                        WriteError(UninstallPackageError);
+                        foreach (var err in errRecords)
+                        {
+                            WriteError(err);
+                        }
                     }
                     break;
 
@@ -142,20 +142,20 @@ protected override void ProcessRecord()
                             version: inputObjectVersion,
                             versionRange: out _versionRange))
                         {
-                            var exMessage = String.Format("Version '{0}' for resource '{1}' cannot be parsed.", inputObj.Version.ToString(), inputObj.Name);
-                            var ex = new ArgumentException(exMessage);
-                            var ErrorParsingVersion = new ErrorRecord(ex, "ErrorParsingVersion", ErrorCategory.ParserError, null);
-                            WriteError(ErrorParsingVersion);
+                            WriteError(new ErrorRecord(
+                                new ArgumentException($"Error parsing version '{inputObj.Version}' for resource '{inputObj.Name}'."), 
+                                "ErrorParsingVersion", 
+                                ErrorCategory.ParserError, 
+                                this));
                         }
 
                         Name = new string[] { inputObj.Name };
-                        if (!String.IsNullOrWhiteSpace(inputObj.Name) && !UninstallPkgHelper())
+                        if (!String.IsNullOrWhiteSpace(inputObj.Name) && !UninstallPkgHelper(out List<ErrorRecord> InputObjErrRecords))
                         {
-                            // specific errors will be displayed lower in the stack
-                            var exMessage = String.Format(string.Format("Did not successfully uninstall package {0}", inputObj.Name));
-                            var ex = new ArgumentException(exMessage);
-                            var UninstallResourceError = new ErrorRecord(ex, "UninstallResourceError", ErrorCategory.InvalidOperation, null);
-                                WriteError(UninstallResourceError);
+                            foreach (var err in InputObjErrRecords)
+                            { 
+                                WriteError(err); 
+                            }
                         }
                     }
                     break;
@@ -175,26 +175,40 @@ protected override void EndProcessing()
 
         #region Private methods
 
-        private bool UninstallPkgHelper()
+        private bool UninstallPkgHelper(out List<ErrorRecord> errRecords)
         {
             var successfullyUninstalled = false;
-
             GetHelper getHelper = new GetHelper(this);
             List<string>  dirsToDelete = getHelper.FilterPkgPathsByName(Name, _pathsToSearch);
             int totalDirs = dirsToDelete.Count;
+            errRecords = new List<ErrorRecord>();
+
+            if (totalDirs == 0) {
+                string message = Version == null || Version.Trim().Equals("*") ?
+                    string.Format("Cannot uninstall resource '{0}' because it does not exist", String.Join(", ", Name)) :
+
+                    string.Format("Cannot uninstall verison '{0}' of resource '{1}' because it does not exist", Version, String.Join(", ", Name));
 
-            // Checking if module or script
-            // a module path will look like:
+
+                errRecords.Add(new ErrorRecord(
+                    new PackageNotFoundException(message),
+                    "ResourceNotInstalled",
+                    ErrorCategory.ObjectNotFound,
+                    this));
+
+                return successfullyUninstalled;
+            }
+
+            // A module path will look like:
             // ./Modules/TestModule/0.0.1
             // note that the xml file is located in this path, eg: ./Modules/TestModule/0.0.1/PSModuleInfo.xml
-            // a script path will look like:
+            // A script path will look like:
             // ./Scripts/TestScript.ps1
-            // note that the xml file is located in ./Scripts/InstalledScriptInfos, eg: ./Scripts/InstalledScriptInfos/TestScript_InstalledScriptInfo.xml
-
-            string pkgName;
+            // Note that the xml file is located in ./Scripts/InstalledScriptInfos, eg: ./Scripts/InstalledScriptInfos/TestScript_InstalledScriptInfo.xml
 
             // Counter for tracking current dir out of total
             int currentUninstalledDirCount = 0;
+            string pkgName;
             foreach (string pkgPath in getHelper.FilterPkgPathsByVersion(_versionRange, dirsToDelete, selectPrereleaseOnly: Prerelease))
             {
                 currentUninstalledDirCount++;
@@ -210,10 +224,18 @@ private bool UninstallPkgHelper()
                 if (pkgPath.EndsWith(PSScriptFileExt))
                 {
                     successfullyUninstalled = UninstallScriptHelper(pkgPath, pkgName, out errRecord);
+                    if (errRecord != null)
+                    {
+                        errRecords.Add(errRecord);
+                    }
                 }
                 else
                 {
                     successfullyUninstalled = UninstallModuleHelper(pkgPath, pkgName, out errRecord);
+                    if (errRecord != null)
+                    {
+                        errRecords.Add(errRecord);
+                    }
                 }
 
                 // if we can't find the resource, write non-terminating error and return
@@ -222,17 +244,19 @@ private bool UninstallPkgHelper()
                     if (errRecord == null)
                     {
                         string message = Version == null || Version.Trim().Equals("*") ?
-                            string.Format("Could not find any version of the resource '{0}' in any path", pkgName) :
-                            string.Format("Could not find verison '{0}' of the resource '{1}' in any path", Version, pkgName);
+                            string.Format("Cannot uninstall resource '{0}' because it does not exist.", pkgName) :
+
+                            string.Format("Cannot uninstall version '{0}' of resource '{1}' because it does not exist.", Version, pkgName);
 
-                        errRecord = new ErrorRecord(
+
+                        errRecords.Add(new ErrorRecord(
                             new PSInvalidOperationException(message),
                             "ErrorRetrievingSpecifiedResource",
                             ErrorCategory.ObjectNotFound,
-                            this);
+                            this));
                     }
 
-                    WriteError(errRecord);
+                    return successfullyUninstalled;
                 }
             }
 
@@ -266,7 +290,7 @@ private bool UninstallModuleHelper(string pkgPath, string pkgName, out ErrorReco
             try
             {
                 Utils.DeleteDirectory(pkgPath);
-                WriteVerbose(string.Format("Successfully uninstalled '{0}' from path '{1}'", pkgName, dir.FullName));
+                WriteVerbose(string.Format("Successfully uninstalled '{0}' from path '{1}'.", pkgName, dir.FullName));
 
                 successfullyUninstalledPkg = true;
 
@@ -280,20 +304,20 @@ private bool UninstallModuleHelper(string pkgPath, string pkgName, out ErrorReco
                 }
                 catch (Exception e)
                 {
-                    // write error
-                    var exMessage = String.Format("Parent directory '{0}' could not be deleted: {1}", dir.Parent.FullName, e.Message);
-                    var ex = new ArgumentException(exMessage);
-                    var ErrorDeletingParentDirectory = new ErrorRecord(ex, "ErrorDeletingParentDirectory", ErrorCategory.InvalidArgument, null);
-                    errRecord = ErrorDeletingParentDirectory;
+                    errRecord = new ErrorRecord(
+                        new ArgumentException($"Parent directory '{dir.Parent.FullName}' could not be deleted: {e.Message}"), 
+                        "ErrorDeletingParentDirectory", 
+                        ErrorCategory.InvalidArgument, 
+                        this);
                 }
             }
             catch (Exception err)
             {
-                // write error
-                var exMessage = String.Format("Directory '{0}' could not be deleted: {1}", dir.FullName, err.Message);
-                var ex = new ArgumentException(exMessage);
-                var ErrorDeletingDirectory = new ErrorRecord(ex, "ErrorDeletingDirectory", ErrorCategory.PermissionDenied, null);
-                errRecord = ErrorDeletingDirectory;
+                errRecord = new ErrorRecord(
+                    new ArgumentException($"Parent directory '{dir.FullName}' could not be deleted: {err.Message}"), 
+                    "ErrorDeletingDirectory", 
+                    ErrorCategory.PermissionDenied, 
+                    null);
             }
 
             return successfullyUninstalledPkg;
@@ -331,18 +355,20 @@ private bool UninstallScriptHelper(string pkgPath, string pkgName, out ErrorReco
                 }
                 catch (Exception e)
                 {
-                    var exMessage = String.Format("Script metadata file '{0}' could not be deleted: {1}", scriptXML, e.Message);
-                    var ex = new ArgumentException(exMessage);
-                    var ErrorDeletingScriptMetadataFile = new ErrorRecord(ex, "ErrorDeletingScriptMetadataFile", ErrorCategory.PermissionDenied, null);
-                    errRecord = ErrorDeletingScriptMetadataFile;
+                    errRecord = new ErrorRecord(
+                        new ArgumentException($"Script metadata file '{scriptXML}' could not be deleted: {e.Message}"), 
+                        "ErrorDeletingScriptMetadataFile", 
+                        ErrorCategory.PermissionDenied, 
+                        this);
                 }
             }
             catch (Exception err)
             {
-                var exMessage = String.Format("Script '{0}' could not be deleted: {1}", pkgPath, err.Message);
-                var ex = new ArgumentException(exMessage);
-                var ErrorDeletingScript = new ErrorRecord(ex, "ErrorDeletingScript", ErrorCategory.PermissionDenied, null);
-                errRecord = ErrorDeletingScript;
+                errRecord = new ErrorRecord(
+                    new ArgumentException($"Script '{pkgPath}' could not be deleted: {err.Message}"), 
+                    "ErrorDeletingScript", 
+                    ErrorCategory.PermissionDenied,
+                    this);
             }
 
             return successfullyUninstalledPkg;
@@ -388,8 +414,7 @@ private bool CheckIfDependency(string pkgName, out ErrorRecord errorRecord)
             catch (Exception e)
             {
                 errorRecord = new ErrorRecord(
-                    new PSInvalidOperationException(
-                        $"Error checking if resource is a dependency: {e.Message}."),
+                    new PSInvalidOperationException($"Error checking if resource is a dependency: {e.Message}."),
                     "UninstallPSResourceDependencyCheckError",
                     ErrorCategory.InvalidOperation,
                     null);
@@ -401,7 +426,8 @@ private bool CheckIfDependency(string pkgName, out ErrorRecord errorRecord)
 
                 errorRecord = new ErrorRecord(
                     new PSInvalidOperationException(
-                        $"Cannot uninstall '{pkgName}'. The following package(s) take a dependency on this package: {strUniquePkgNames}. If you would still like to uninstall, rerun the command with -SkipDependencyCheck"),
+                        $"Cannot uninstall '{pkgName}'. This package depends on the following package(s): '{strUniquePkgNames}'. If you would still like to uninstall, re-run the command with -SkipDependencyCheck."),
+
                     "UninstallPSResourcePackageIsaDependency",
                     ErrorCategory.InvalidOperation,
                     null);

test/UninstallPSResourceTests/UninstallPSResource.Tests.ps1

@@ -257,7 +257,7 @@ Describe 'Test Uninstall-PSResource for Modules' -tags 'CI' {
         $pkg = Get-InstalledPSResource "RequiredModule1"
         $pkg | Should -Not -Be $null
 
-        $ev.FullyQualifiedErrorId | Should -BeExactly 'UninstallPSResourcePackageIsaDependency,Microsoft.PowerShell.PSResourceGet.Cmdlets.UninstallPSResource', 'UninstallResourceError,Microsoft.PowerShell.PSResourceGet.Cmdlets.UninstallPSResource'
+        $ev.FullyQualifiedErrorId | Should -BeExactly 'UninstallPSResourcePackageIsaDependency,Microsoft.PowerShell.PSResourceGet.Cmdlets.UninstallPSResource'
     }
 
     It "Uninstall module that is a dependency for another module using -SkipDependencyCheck" {
@@ -296,7 +296,7 @@ Describe 'Test Uninstall-PSResource for Modules' -tags 'CI' {
 
     It "Uninstall module that is not installed should throw error" {
         Uninstall-PSResource -Name "NonInstalledModule" -ErrorVariable ev -ErrorAction SilentlyContinue -SkipDependencyCheck
-        $ev.FullyQualifiedErrorId | Should -BeExactly 'UninstallResourceError,Microsoft.PowerShell.PSResourceGet.Cmdlets.UninstallPSResource'
+        $ev.FullyQualifiedErrorId | Should -BeExactly 'ResourceNotInstalled,Microsoft.PowerShell.PSResourceGet.Cmdlets.UninstallPSResource'
     }
 
     # Windows only