Merge pull request #2 from EncoreTechnologies/bugfix/CLOUD-1860_powercli_install_failures

[WIP] Various bug fixes

Author: nmaludy

CHANGELOG.md

@@ -1,3 +1,17 @@
+## Development
+
+BUG FIXES:
+
+`psrepository` fixes:
+- Fixes the inability to register psrepoositorys when none are registered on the node prior to puppet due to bug in `instances_command` expecting a returned hashtable.
+- Many fixes around the default powershell gallery repo due to the `flush` command attempting to set the source_location of the repo:
+  - Fixes the inability to change the installation policy of a pre-existing powershell gallery repo
+  - Fixes the inability to register the powershell gallery repo
+
+`package` fixes:
+-  Fixes the inability to upgrade previously installed modules with -AllowClobber. This would previously fail with an error if a cmdlet was moved to a new module. Powershell would error stating the cmdlet exists in the system already within a module and you need to specific -AllowClobber to install the new one.
+
+
 ## 2.0.1 (September 6, 2018)
 
 BUG FIXES:
@@ -17,4 +31,4 @@ IMPROVEMENTS:
 BUG FIXES:
 
 * `package` - add :versionable to windowspowershell provider ([#12](https://github.com/hbuckle/puppet-powershellmodule/issues/12))
-* `psrepository` - make source_location case sensitive ([#11](https://github.com/hbuckle/puppet-powershellmodule/issues/11))
+* `psrepository` - make source_location case sensitive ([#11](https://github.com/hbuckle/puppet-powershellmodule/issues/11))

lib/puppet/provider/package/powershellcore.rb

@@ -84,6 +84,7 @@ def self.instances_command
     COMMAND
   end
 
+  # Command used to install powershell modules
   def install_command
     command = "Install-Module #{@resource[:name]} -Scope AllUsers -Force"
     command << " -RequiredVersion #{@resource[:ensure]}" unless [:present, :latest].include? @resource[:ensure]
@@ -92,16 +93,22 @@ def install_command
     command
   end
 
+  # Command to unisntall powershell modules
   def uninstall_command
     "Uninstall-Module #{@resource[:name]} -AllVersions -Force"
   end
 
+  # Command to fetch latest version of powershell modules
   def latest_command
     "$mod = Find-Module #{@resource[:name]} -Repository #{@resource[:source]}; $mod.Version.ToString()"
   end
 
+  # Command to update powershell modules
   def update_command
-    command = "Install-Module #{@resource[:name]} -Scope AllUsers -Force"
+    # The -AllowClobber here is needed because this command will fail with an error like:
+    # "This cmdlet exists on the system and could cause a conflict, use -allowclobber to install"
+    # I believe this is due to a cmdlet moving from one module to another, seen in powercli modules
+    command = "Install-Module #{@resource[:name]} -Scope AllUsers -Force -AllowClobber"
     command << " -Repository #{@resource[:source]}" if @resource[:source]
     command << " #{install_options(@resource[:install_options])}" if @resource[:install_options]
     command

lib/puppet/provider/psrepository/powershellcore.rb

@@ -46,34 +46,58 @@ def destroy
     @property_hash.clear
   end
 
+  # The source location for existing psrepos
+  # You cannot define this for the default psgallery repo
   def source_location=(value)
     @property_flush[:sourcelocation] = value
   end
 
+  # The installation policy for existing psrepos
   def installation_policy=(value)
     @property_flush[:installationpolicy] = value
   end
 
+  # Sets any pre-existing psrepo to have the proper attributes. Source location, install policy, etc.
   def flush
+    # If any psrepos existed on the system...
     unless @property_flush.empty?
+      # Base block of the command which will be used to true-up psrepos
       flush_command = "Set-PSRepository #{@resource[:name]}"
+      # For each attribute on the psrepos..
       @property_flush.each do |key, value|
+        # If the repo we is powershell gallery, then DROP the source_location key
+        # If you specify source_location for the PSGallery default repo, it will fail
+        next if @resource[:name].downcase == 'psgallery' && key == :sourcelocation
+        
+        # Append that attribute to the true-up command
         flush_command << " -#{key} '#{value}'"
       end
+      # launch pwsh to true-up any pre-existing repo with proper settings
       self.class.invoke_ps_command flush_command
     end
     @property_hash = @resource.to_hash
   end
 
+  # Expected return example when an actual repo is registered:
+  # {"name":"PSGallery","source_location":"https://www.powershellgallery.com/api/v2","installation_policy":"trusted"}
+  # When no ps repos are registered it returns:
+  # WARNING: Unable to find module repositories
+  # The try, catch here gets around the issue of having no repos
   def self.instances_command
     <<-COMMAND
-    @(Get-PSRepository -WarningAction SilentlyContinue).foreach({
-      [ordered]@{
-        'name' = $_.Name
-        'source_location' = $_.SourceLocation
-        'installation_policy' = $_.InstallationPolicy.ToLower()
-      } | ConvertTo-Json -Depth 99 -Compress
-    })
+    try{ 
+        @(Get-PSRepository -ErrorAction Stop -WarningAction Stop 3>$null).foreach({
+            [ordered]@{
+            'name' = $_.Name
+            'source_location' = $_.SourceLocation
+            'installation_policy' = $_.InstallationPolicy.ToLower()
+            } | ConvertTo-Json -Depth 99 -Compress
+        }) 
+    }
+    # If no repos were registered
+    catch {
+      exit 0
+    }
     COMMAND
   end
 
@@ -84,7 +108,18 @@ def create_command
       SourceLocation = '#{@resource[:source_location]}'
       InstallationPolicy = '#{@resource[:installation_policy]}'
     }
-    Register-PSRepository @params
+
+    # Detecting if this is Powershell Gallery repo or not
+    if($params.Name -eq 'PSGallery' -or $params.SourceLocation -match 'powershellgallery'){
+      # Trim these params or the splatting will fail
+      $params.Remove('Name')
+      $params.Remove('SourceLocation')
+      Register-PSRepository -Default @params
+    }
+    # For all non-PSGallery repos..
+    else{
+      Register-PSRepository @params
+    }
     COMMAND
   end