Install-PSResource -RequiredResource with empty inner hashtable value bugfix (#1426)

Author: anamnavi

src/code/InstallPSResource.cs

@@ -245,6 +245,7 @@ private enum ResourceFileType
         private const string InputObjectParameterSet = "InputObjectParameterSet";
         private const string RequiredResourceFileParameterSet = "RequiredResourceFileParameterSet";
         private const string RequiredResourceParameterSet = "RequiredResourceParameterSet";
+        private const string CredentialKey = "credential";
         List<string> _pathsToInstallPkg;
         private string _requiredResourceFile;
         private string _requiredResourceJson;
@@ -426,50 +427,76 @@ protected override void ProcessRecord()
         private void RequiredResourceHelper(Hashtable reqResourceHash)
         {
             WriteDebug("In InstallPSResource::RequiredResourceHelper()");
-            var pkgNames = reqResourceHash.Keys;
-
-            foreach (string pkgName in pkgNames)
+            foreach (DictionaryEntry entry in reqResourceHash)
             {
-                var pkgParamInfo = reqResourceHash[pkgName];
+                InstallPkgParams pkgParams = new InstallPkgParams();
+                PSCredential pkgCredential = Credential;
 
-                // Format should now be a hashtable, whether the original input format was json or hashtable
-                if (!(pkgParamInfo is Hashtable pkgInstallInfo))
+                // The package name will be the key for the inner hashtable and is present for all scenarios,
+                // including the scenario where only package name is specified
+                // i.e Install-PSResource -RequiredResource @ { MyPackage = @{} }
+                string pkgName = entry.Key.ToString();
+                // check if pkgName is empty or whitespace
+                if (String.IsNullOrEmpty(pkgName.Trim()))
                 {
+                    var pkgNameEmptyOrWhitespaceError = new ErrorRecord(
+                        new ArgumentException($"The package name '{pkgName}' provided cannot be an empty string or whitespace."),
+                        "pkgNameEmptyOrWhitespaceError", 
+                        ErrorCategory.InvalidArgument,
+                        this);
+
+                    WriteError(pkgNameEmptyOrWhitespaceError);
                     return;
                 }
 
-                InstallPkgParams pkgParams = new InstallPkgParams();
-                var pkgParamNames = pkgInstallInfo.Keys;
+                string pkgVersion = String.Empty;
+                if (!(entry.Value is Hashtable pkgInstallInfo))
+                {
+                    var requiredResourceHashtableInputFormatError = new ErrorRecord(
+                        new ArgumentException($"The RequiredResource input with name '{pkgName}' does not have a valid value, the value must be a hashtable."),
+                        "RequiredResourceHashtableInputFormatError", 
+                        ErrorCategory.InvalidArgument,
+                        this);
 
-                PSCredential pkgCredential = Credential;
-                foreach (string paramName in pkgParamNames)
+                    WriteError(requiredResourceHashtableInputFormatError);
+                    return;
+                }
+
+                // scenario where package name and other parameters are provided:
+                // Install-PSResource -RequiredResource @ { MyPackage = @{ version = '1.2.3', repository = 'PSGallery' } }
+                if (pkgInstallInfo.Count != 0)
                 {
-                    if (string.Equals(paramName, "credential", StringComparison.InvariantCultureIgnoreCase))
-                    {
-                        WriteVerbose("Credential specified for required resource");
-                        pkgCredential = pkgInstallInfo[paramName] as PSCredential;
-                    }
+                    var pkgParamNames = pkgInstallInfo.Keys;
 
-                    pkgParams.SetProperty(paramName, pkgInstallInfo[paramName] as string, out ErrorRecord IncorrectVersionFormat);
+                    foreach (string paramName in pkgParamNames)
+                    {
+                        if (string.Equals(paramName, CredentialKey, StringComparison.InvariantCultureIgnoreCase))
+                        {
+                            WriteVerbose("Credential specified for required resource");
+                            pkgCredential = pkgInstallInfo[paramName] as PSCredential;
+                        }
 
-                    if (IncorrectVersionFormat != null)
+                        // for all parameters found, we try to add it to the InstallPkgParams object if it is valid.
+                        pkgParams.SetProperty(paramName, pkgInstallInfo[paramName] as string, out ErrorRecord ParameterParsingError);
+                        if (ParameterParsingError != null)
+                        {
+                            ThrowTerminatingError(ParameterParsingError);
+                        }
+                    }
+                        
+                    if (pkgParams.Scope == ScopeType.AllUsers)
                     {
-                        ThrowTerminatingError(IncorrectVersionFormat);
+                        _pathsToInstallPkg = Utils.GetAllInstallationPaths(this, pkgParams.Scope);
                     }
-                }
-                    
-                if (pkgParams.Scope == ScopeType.AllUsers)
-                {
-                    _pathsToInstallPkg = Utils.GetAllInstallationPaths(this, pkgParams.Scope);
-                }
 
-                string pkgVersion = pkgInstallInfo["version"] == null ? String.Empty : pkgInstallInfo["version"].ToString();
+                    pkgVersion = pkgInstallInfo["version"] == null ? String.Empty : pkgInstallInfo["version"].ToString();
+                }
 
                 ProcessInstallHelper(
                     pkgNames: new string[] { pkgName },
                     pkgVersion: pkgVersion,
                     pkgPrerelease: pkgParams.Prerelease,
-                    pkgRepository: new string[] { pkgParams.Repository },
+                    pkgRepository: pkgParams.Repository != null ? new string[] { pkgParams.Repository } : new string[]{},
                     pkgCredential: pkgCredential,
                     reqResourceParams: pkgParams);
             }

src/code/InstallPkgParams.cs

@@ -25,9 +25,18 @@ public class InstallPkgParams
 
     #region Private methods
 
-    public void SetProperty(string propertyName, string propertyValue, out ErrorRecord IncorrectVersionFormat)
+    public void SetProperty(string propertyName, string propertyValue, out ErrorRecord ParameterParsingError)
     {
-        IncorrectVersionFormat = null;
+        ParameterParsingError = null;
+        if (String.IsNullOrEmpty(propertyName.Trim()))
+        {
+            ParameterParsingError = new ErrorRecord(
+                new ArgumentException("Argument for parameter cannot be null or whitespace."),
+                "EmptyOrWhitespaceParameterKey", 
+                ErrorCategory.InvalidArgument,
+                this);
+        }
+
         switch (propertyName.ToLower())
         {
             case "name":
@@ -44,7 +53,7 @@ public void SetProperty(string propertyName, string propertyValue, out ErrorReco
                 }
                 else if (!Utils.TryParseVersionOrVersionRange(propertyValue, out versionTmp))
                 {
-                    IncorrectVersionFormat = new ErrorRecord(
+                    ParameterParsingError = new ErrorRecord(
                         new ArgumentException("Argument for Version parameter is not in the proper format."),
                         "IncorrectVersionFormat", 
                         ErrorCategory.InvalidArgument,
@@ -98,7 +107,11 @@ public void SetProperty(string propertyName, string propertyValue, out ErrorReco
                 break;
 
             default:
-                // write error
+                ParameterParsingError = new ErrorRecord(
+                    new ArgumentException($"The parameter '{propertyName}' provided is not a recognized or valid parameter. Allowed values include: Name, Version, Repository, AcceptLicense, Prerelease, Scope, Quiet, Reinstall, TrustRepository, NoClobber, and SkipDependencyCheck."),
+                    "IncorrectParameterError", 
+                    ErrorCategory.InvalidArgument,
+                    this);
                 break;
         }
     }

test/InstallPSResourceTests/InstallPSResourceV2Server.Tests.ps1

@@ -389,15 +389,13 @@ Describe 'Test Install-PSResource for V2 Server scenarios' -tags 'CI' {
                repository = $PSGalleryName
             }
 
-             test_module2 = @{
+            test_module2 = @{
                version = "[1.0.0,3.0.0)"
                repository = $PSGalleryName
                prerelease = "true"
             }
 
-             TestModule99 = @{
-                repository = $PSGalleryName
-            }
+            TestModule99 = @{}
           }
 
           Install-PSResource -RequiredResource $rrHash -TrustRepository