Merge pull request #5 from hbuckle/powershell6

Powershell core support

Author: hbuckle

.rubocop.yml

@@ -14,7 +14,7 @@ Metrics/BlockLength:
   Max: 50
 
 Metrics/LineLength:
-  Max: 130
+  Max: 135
 
 EndOfLine:
   Enabled: false

Gemfile

@@ -6,6 +6,7 @@ gem 'metadata-json-lint'
 gem 'puppet', puppetversion
 gem 'puppet-lint', '>= 1.0.0'
 gem 'puppetlabs_spec_helper', '>= 1.0.0'
+gem 'semantic_puppet', '>= 1.0.0'
 
 # rspec must be v2 for ruby 1.8.7
 if RUBY_VERSION >= '1.8.7' && RUBY_VERSION < '1.9'

README.md

@@ -4,45 +4,101 @@
 
 1. [Description](#description)
 1. [Setup - The basics of getting started with powershellmodule](#setup)
-    * [Setup requirements](#setup-requirements)
+    * [Windows PowerShell](#windows-powershell)
+    * [PowerShell Core](#powershell-core)
 1. [Usage - Configuration options and additional functionality](#usage)
+    * [Windows PowerShell](#windows-powershell)
+    * [PowerShell Core](#powershell-core)
+    * [Side by side installation](#side-by-side-installation)
 1. [Limitations - OS compatibility, etc.](#limitations)
 1. [Development - Guide for contributing to the module](#development)
 
 ## Description
 
-This module adds a new type and provider for registering PowerShell repositories
-and a new package provider for installing PowerShell modules.
+This module allows PowerShell repositories to be registered as package sources
+and PowerShell modules to be installed using the Puppet Package type.
+
+The module supports Windows PowerShell (PowerShell 5) and PowerShell Core (PowerShell 6)
 
 ## Setup
 
-### Setup Requirements
+### Windows PowerShell
 
-The PowerShellGet PowerShell module must be installed as well as the NuGet package
-provider. PowerShellGet is included with WMF5 or can be installed for earlier
+For Windows PowerShell the PowerShellGet PowerShell module must be installed as well as
+the NuGet package provider. PowerShellGet is included with WMF5 or can be installed for earlier
 versions here http://go.microsoft.com/fwlink/?LinkID=746217&clcid=0x409
+
 NuGet can be installed by running
-Install-PackageProvider Nuget –Force
 
-### Beginning with powershellmodule
+`Install-PackageProvider Nuget –Force`
+
+### PowerShell Core
+
+PowerShellGet is included in PowerShell Core so no additional setup is necessary.
 
 ## Usage
 
-~~~ puppet
+### Windows PowerShell
+
+Windows users should remember that package names in Puppet are case sensitive.
+
+```puppet
 psrepository { 'my-internal-repo':
   ensure              => present,
   source_location     => 'http://myrepo.corp.com/api/nuget/powershell',
   installation_policy => 'trusted',
+  provider            => 'windowspowershell',
 }
-~~~
+```
 
-~~~ puppet
-package { 'pester':
+```puppet
+package { 'Pester':
   ensure   => '4.0.3',
   source   => 'PSGallery',
-  provider => 'psmodule',
+  provider => 'windowspowershell',
+}
+```
+
+### PowerShell Core
+
+```puppet
+psrepository { 'my-internal-repo':
+  ensure              => present,
+  source_location     => 'http://myrepo.corp.com/api/nuget/powershell',
+  installation_policy => 'trusted',
+  provider            => 'powershellcore',
+}
+```
+
+```puppet
+package { 'Pester':
+  ensure   => '4.0.3',
+  source   => 'PSGallery',
+  provider => 'powershellcore',
+}
+```
+
+### Side by side installation
+
+On Windows, PowerShell Core is installed along side Windows PowerShell and maintains its
+modules separately. To install the same module for both versions then use a unique resource
+title and specify the `name` property.
+
+```puppet
+package { 'PSExcel-wps':
+  ensure   => latest,
+  name     => 'PSExcel',
+  provider => 'windowspowershell',
+  source   => 'PSGallery',
+}
+
+package { 'PSExcel-psc':
+  ensure   => latest,
+  name     => 'PSExcel',
+  provider => 'powershellcore',
+  source   => 'PSGallery',
 }
-~~~
+```
 
 ## Limitations
 

examples/init.pp

@@ -17,6 +17,12 @@
 
 package { 'PSExcel':
   ensure   => latest,
-  provider => 'psmodule',
+  provider => 'windowspowershell',
   source   => 'PSGallery',
 }
+
+package { 'Pester':
+  ensure   => latest,
+  provider => 'powershellcore',
+  source   => 'PSGallery',
+}

lib/puppet/feature/powershellget.rb lib/puppet/feature/powershellgetwindows.rb

@@ -1,6 +1,6 @@
 require 'puppet/util/feature'
 
-Puppet.features.add(:powershellget) do
+Puppet.features.add(:powershellgetwindows) do
   command = '"Import-Module powershellget; $mod = Get-Module powershellget; $mod.Name"'
   output = `powershell.exe -noprofile -executionpolicy bypass -command #{command}`
   output.downcase.strip == 'powershellget'

lib/puppet/provider/package/psmodule.rb lib/puppet/provider/package/powershellcore.rb

@@ -1,26 +1,16 @@
 require 'puppet/provider/package'
 require 'json'
 
-Puppet::Type.type(:package).provide :psmodule, parent: Puppet::Provider::Package do
-  confine operatingsystem: :windows
-  confine feature: :powershellget
-
-  has_feature :installable
-  has_feature :uninstallable
-  has_feature :upgradeable
-  has_feature :versionable
-
-  commands powershell:
-              if File.exist?("#{ENV['SYSTEMROOT']}\\sysnative\\WindowsPowershell\\v1.0\\powershell.exe")
-                "#{ENV['SYSTEMROOT']}\\sysnative\\WindowsPowershell\\v1.0\\powershell.exe"
-              elsif File.exist?("#{ENV['SYSTEMROOT']}\\system32\\WindowsPowershell\\v1.0\\powershell.exe")
-                "#{ENV['SYSTEMROOT']}\\system32\\WindowsPowershell\\v1.0\\powershell.exe"
-              else
-                'powershell.exe'
-              end
+Puppet::Type.type(:package).provide :powershellcore, parent: Puppet::Provider::Package do
+  initvars
+  has_feature :installable, :uninstallable, :upgradeable, :versionable
+  commands pwsh: 'pwsh'
 
   def self.invoke_ps_command(command)
-    result = powershell(['-noprofile', '-executionpolicy', 'bypass', '-command', command])
+    # override_locale is necessary otherwise the Install-Module commands silently fails on Linux
+    result = Puppet::Util::Execution.execute(['pwsh', '-NoProfile', '-NonInteractive', '-NoLogo', '-Command',
+                                              "$ProgressPreference = 'SilentlyContinue'; $ErrorActionPreference = 'Stop'; #{command}"],
+                                             override_locale: false)
     result.lines
   end
 
@@ -62,15 +52,15 @@ def self.instances_command
       [ordered]@{
         'name' = $_.Name
         'ensure' = @(($_.Group).Version)
-        'provider' = 'psmodule'
+        'provider' = '#{name}'
       } | ConvertTo-Json -Depth 99 -Compress
     }
     COMMAND
   end
 
   def install_command
-    command = "Install-Module #{@resource[:name]} -Force"
-    command << " -RequiredVersion #{@resource[:ensure]}" unless [:present, :latest].include? @resource[:ensure]
+    command = "Install-Module #{@resource[:name]} -Scope AllUsers -Force"
+    command << " -RequiredVersion #{@resource[:ensure]}" unless %i[present latest].include? @resource[:ensure]
     command << " -Repository #{@resource[:source]}" if @resource[:source]
     command
   end
@@ -84,7 +74,7 @@ def latest_command
   end
 
   def update_command
-    command = "Install-Module #{@resource[:name]} -Force"
+    command = "Install-Module #{@resource[:name]} -Scope AllUsers -Force"
     command << " -Repository #{@resource[:source]}" if @resource[:source]
     command
   end

lib/puppet/provider/package/windowspowershell.rb

@@ -0,0 +1,12 @@
+Puppet::Type.type(:package).provide(:windowspowershell, parent: :powershellcore) do
+  initvars
+  confine operatingsystem: :windows
+  confine feature: :powershellgetwindows
+  commands powershell: 'powershell'
+
+  def self.invoke_ps_command(command)
+    result = powershell(['-NoProfile', '-ExecutionPolicy', 'Bypass', '-NonInteractive', '-NoLogo', '-Command',
+                         "$ProgressPreference = 'SilentlyContinue'; $ErrorActionPreference = 'Stop'; #{command}"])
+    result.lines
+  end
+end

lib/puppet/provider/psrepository/windows.rb lib/puppet/provider/psrepository/powershellcore.rb

@@ -1,16 +1,6 @@
-Puppet::Type.type(:psrepository).provide(:windows) do
-  confine operatingsystem: :windows
-  confine feature: :powershellget
-
-  commands powershell:
-              if File.exist?("#{ENV['SYSTEMROOT']}\\sysnative\\WindowsPowershell\\v1.0\\powershell.exe")
-                "#{ENV['SYSTEMROOT']}\\sysnative\\WindowsPowershell\\v1.0\\powershell.exe"
-              elsif File.exist?("#{ENV['SYSTEMROOT']}\\system32\\WindowsPowershell\\v1.0\\powershell.exe")
-                "#{ENV['SYSTEMROOT']}\\system32\\WindowsPowershell\\v1.0\\powershell.exe"
-              else
-                'powershell.exe'
-              end
-
+Puppet::Type.type(:psrepository).provide(:powershellcore) do
+  initvars
+  commands pwsh: 'pwsh'
   mk_resource_methods
 
   def initialize(value = {})
@@ -19,7 +9,9 @@ def initialize(value = {})
   end
 
   def self.invoke_ps_command(command)
-    result = powershell(['-noprofile', '-executionpolicy', 'bypass', '-command', command])
+    result = pwsh(['-NoProfile', '-NonInteractive', '-NoLogo', '-Command', "$ProgressPreference = 'SilentlyContinue'; #{command}"])
+    Puppet.debug result.exitstatus
+    Puppet.debug result.lines
     result.lines
   end
 

lib/puppet/provider/psrepository/windowspowershell.rb

@@ -0,0 +1,11 @@
+Puppet::Type.type(:psrepository).provide(:windowspowershell, parent: :powershellcore) do
+  initvars
+  confine operatingsystem: :windows
+  confine feature: :powershellgetwindows
+  commands powershell: 'powershell'
+
+  def self.invoke_ps_command(command)
+    result = powershell(['-noprofile', '-executionpolicy', 'bypass', '-command', command])
+    result.lines
+  end
+end

metadata.json

@@ -1,13 +1,17 @@
 {
   "name": "hbuckle-powershellmodule",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "author": "Henry Buckle",
   "summary": "Manage PowerShell modules and repositories",
   "license": "Apache-2.0",
   "source": "https://github.com/hbuckle/puppet-powershellmodule",
   "project_page": "https://github.com/hbuckle/puppet-powershellmodule",
   "issues_url": "https://github.com/hbuckle/puppet-powershellmodule/issues",
-  "tags": ["powershell", "microsoft", "package"],
+  "tags": [
+    "powershell",
+    "microsoft",
+    "package"
+  ],
   "dependencies": [],
   "operatingsystem_support": [
     {
@@ -22,7 +26,52 @@
         "8.1",
         "10"
       ]
+    },
+    {
+      "operatingsystem": "Debian",
+      "operatingsystemrelease": [
+        "8.7+",
+        "9"
+      ]
+    },
+    {
+      "operatingsystem": "CentOS",
+      "operatingsystemrelease": [
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "Ubuntu",
+      "operatingsystemrelease": [
+        "14.04",
+        "16.04",
+        "17.04"
+      ]
+    },
+    {
+      "operatingsystem": "RedHat",
+      "operatingsystemrelease": [
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "Fedora",
+      "operatingsystemrelease": [
+        "25",
+        "26"
+      ]
+    },
+    {
+      "operatingsystem": "openSUSE",
+      "operatingsystemrelease": [
+        "42.2"
+      ]
+    },
+    {
+      "operatingsystem": "OSX",
+      "operatingsystemrelease": [
+        "10.12+"
+      ]
     }
   ]
-}
-
+}

spec/unit/puppet/provider/psmodule_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-provider_class = Puppet::Type.type(:package).provider(:psmodule)
+provider_class = Puppet::Type.type(:package).provider(:windowspowershell)
 
 describe provider_class do
   before(:each) do
@@ -11,14 +11,14 @@
     allow(provider_class).to receive(:invoke_ps_command).with(
       provider_class.instances_command).and_return(
         [
-          '{"name":"PackageManagement","ensure":["1.1.6.0","1.1.7.0"],"provider":"psmodule"}',
-          '{"name":"Pester","ensure":["4.0.8"],"provider":"psmodule"}',
-          '{"name":"PowerShellGet","ensure":["1.5.0.0"],"provider":"psmodule"}'
+          '{"name":"PackageManagement","ensure":["1.1.6.0","1.1.7.0"],"provider":"windowspowershell"}',
+          '{"name":"Pester","ensure":["4.0.8"],"provider":"windowspowershell"}',
+          '{"name":"PowerShellGet","ensure":["1.5.0.0"],"provider":"windowspowershell"}'
         ]
       )
   end
   describe :instances do
-    specify 'returns an array of :psmodule providers' do
+    specify 'returns an array of :windowspowershell providers' do
       instances = provider_class.instances
       expect(instances.count).to eq(3)
       expect(instances).to all(be_instance_of(provider_class))