chef 16.18.30 → 17.10.163

data/lib/chef/resource/windows_pagefile.rb

@@ -39,16 +39,26 @@ class Chef
 
       ```ruby
       windows_pagefile 'Delete the pagefile' do
-        path 'C:\pagefile.sys'
+        path 'C'
         action :delete
       end
       ```
 
+      **Switch to system managed pagefiles**:
+
+      ```ruby
+      windows_pagefile 'Change the pagefile to System Managed' do
+        path 'E:\'
+        system_managed true
+        action :set
+      end
+      ```
+
       **Create a pagefile with an initial and maximum size**:
 
       ```ruby
-      windows_pagefile 'create the pagefile' do
-        path 'C:\pagefile.sys'
+      windows_pagefile 'create the pagefile with these sizes' do
+        path 'f:\'
         initial_size 100
         maximum_size 200
       end
@@ -56,7 +66,7 @@ class Chef
       DOC
 
       property :path, String,
-        coerce: proc { |x| x.tr("/", '\\') },
+        coerce: proc { |x| x.tr("/", "\\") },
         description: "An optional property to set the pagefile name if it differs from the resource block's name.",
         name_property: true
 
@@ -64,8 +74,7 @@ class Chef
         description: "Configures whether the system manages the pagefile size."
 
       property :automatic_managed, [TrueClass, FalseClass],
-        description: "Enable automatic management of pagefile initial and maximum size. Setting this to true ignores `initial_size` and `maximum_size` properties.",
-        default: false
+        description: "Enable automatic management of pagefile initial and maximum size. Setting this to true ignores `initial_size` and `maximum_size` properties."
 
       property :initial_size, Integer,
         description: "Initial size of the pagefile in megabytes."
@@ -73,25 +82,26 @@ class Chef
       property :maximum_size, Integer,
         description: "Maximum size of the pagefile in megabytes."
 
-      action :set do
-        description "Configures the default pagefile, creating if it doesn't exist."
-
-        pagefile = new_resource.path
-        initial_size = new_resource.initial_size
-        maximum_size = new_resource.maximum_size
-        system_managed = new_resource.system_managed
+      action :set, description: "Configures the default pagefile, creating if it doesn't exist." do
         automatic_managed = new_resource.automatic_managed
 
         if automatic_managed
           set_automatic_managed unless automatic_managed?
+        elsif automatic_managed == false
+          unset_automatic_managed
         else
-          unset_automatic_managed if automatic_managed?
+          pagefile = clarify_pagefile_name
+          initial_size = new_resource.initial_size
+          maximum_size = new_resource.maximum_size
+          system_managed = new_resource.system_managed
 
-          # Check that the resource is not just trying to unset automatic managed, if it is do nothing more
-          if (initial_size && maximum_size) || system_managed
-            validate_name
-            create(pagefile) unless exists?(pagefile)
+          # the method below is designed to raise an exception if the drive you are trying to create a pagefile for doesn't exist.
+          # PowerShell will happily let you create a pagefile called h:\pagefile.sys even though you don't have an H:\ drive.
+
+          pagefile_drive_exist?(pagefile)
+          create(pagefile) unless exists?(pagefile)
 
+          if (initial_size && maximum_size) || system_managed
             if system_managed
               set_system_managed(pagefile) unless max_and_min_set?(pagefile, 0, 0)
             else
@@ -103,23 +113,33 @@ class Chef
         end
       end
 
-      action :delete do
-        description "Deletes the specified pagefile."
-
-        validate_name
-        delete(new_resource.path) if exists?(new_resource.path)
+      action :delete, description: "Deletes the specified pagefile." do
+        pagefile = clarify_pagefile_name
+        delete(pagefile) if exists?(pagefile)
       end
 
       action_class do
         private
 
-        # make sure the provided name property matches the appropriate format
-        # we do this here and not in the property itself because if automatic_managed
-        # is set then this validation is not necessary / doesn't make sense at all
-        def validate_name
-          return if /^.:.*.sys/.match?(new_resource.path)
+        # We are adding support for a number of possibilities for how users will express the drive and location they want the pagefile written to.
+        def clarify_pagefile_name
+          case new_resource.path
+          # user enters C, C:, C:\, C:\\
+          when /^[a-zA-Z]/
+            new_resource.path[0] + ":\\pagefile.sys"
+          # user enters C:\pagefile.sys OR c:\foo\bar\pagefile.sys as the path
+          when /^[a-zA-Z]:.*.sys/
+            new_resource.path
+          else
+            raise "#{new_resource.path} does not match the format DRIVE:\\path\\pagefile.sys for pagefiles. Example: C:\\pagefile.sys"
+          end
+        end
 
-          raise "#{new_resource.path} does not match the format DRIVE:\\path\\file.sys for pagefiles. Example: C:\\pagefile.sys"
+        # raise an exception if the target drive location is invalid
+        def pagefile_drive_exist?(pagefile)
+          if ::Dir.exist?(pagefile[0] + ":\\") == false
+            raise "You are trying to create a pagefile on a drive that does not exist!"
+          end
         end
 
         # See if the pagefile exists
@@ -128,9 +148,13 @@ class Chef
         # @return [Boolean]
         def exists?(pagefile)
           @exists ||= begin
-            logger.trace("Checking if #{pagefile} exists by running: wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" list /format:list")
-            cmd = shell_out("wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" list /format:list", returns: [0])
-            cmd.stderr.empty? && (cmd.stdout =~ /SettingID=#{get_setting_id(pagefile)}/i)
+            logger.trace("Checking if #{pagefile} exists by running: Get-CimInstance Win32_PagefileSetting | Where-Object { $_.name -eq $($pagefile)} ")
+            powershell_code = <<~CODE
+              $page_file_name = '#{pagefile}';
+              $pagefile = Get-CimInstance Win32_PagefileSetting | Where-Object { $_.name -eq $($page_file_name)}
+              if ([string]::IsNullOrEmpty($pagefile)) { return $false } else { return $true }
+            CODE
+            powershell_exec!(powershell_code).result
           end
         end
 
@@ -141,11 +165,18 @@ class Chef
         # @param [String] max the minimum size of the pagefile
         # @return [Boolean]
         def max_and_min_set?(pagefile, min, max)
-          @max_and_min_set ||= begin
-            logger.trace("Checking if #{pagefile} min: #{min} and max #{max} are set")
-            cmd = shell_out("wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" list /format:list", returns: [0])
-            cmd.stderr.empty? && (cmd.stdout =~ /InitialSize=#{min}/i) && (cmd.stdout =~ /MaximumSize=#{max}/i)
-          end
+          logger.trace("Checking if #{pagefile} has max and initial disk size values set")
+
+          powershell_code = <<-CODE
+            $page_file = '#{pagefile}';
+            $driveLetter = $page_file.split(':')[0];
+            $page_file_settings = Get-CimInstance -ClassName Win32_PageFileSetting -Filter "SettingID='pagefile.sys @ $($driveLetter):'" -Property * -ErrorAction Stop;
+            if ($page_file_settings.InitialSize -eq #{min} -and $page_file_settings.MaximumSize -eq #{max})
+              { return $true }
+            else
+              { return $false }
+          CODE
+          powershell_exec!(powershell_code).result
         end
 
         # create a pagefile
@@ -153,9 +184,10 @@ class Chef
         # @param [String] pagefile path to the pagefile
         def create(pagefile)
           converge_by("create pagefile #{pagefile}") do
-            logger.trace("Running wmic.exe pagefileset create name=\"#{pagefile}\"")
-            cmd = shell_out("wmic.exe pagefileset create name=\"#{pagefile}\"")
-            check_for_errors(cmd.stderr)
+            logger.trace("Running New-CimInstance -ClassName Win32_PageFileSetting to create new pagefile : #{pagefile}")
+            powershell_exec! <<~ELM
+              New-CimInstance -ClassName Win32_PageFileSetting -Property  @{Name = "#{pagefile}"}
+            ELM
           end
         end
 
@@ -164,9 +196,13 @@ class Chef
         # @param [String] pagefile path to the pagefile
         def delete(pagefile)
           converge_by("remove pagefile #{pagefile}") do
-            logger.trace("Running wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" delete")
-            cmd = shell_out("wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" delete")
-            check_for_errors(cmd.stderr)
+            logger.trace("Running Remove-CimInstance for pagefile : #{pagefile}")
+            powershell_exec! <<~EOL
+              $page_file = "#{pagefile}"
+              $driveLetter = $page_file.split(':')[0]
+              $PageFile = (Get-CimInstance -ClassName Win32_PageFileSetting -Filter "SettingID='pagefile.sys @ $($driveLetter):'" -ErrorAction Stop)
+              $null = ($PageFile | Remove-CimInstance -ErrorAction SilentlyContinue)
+            EOL
           end
         end
 
@@ -176,26 +212,33 @@ class Chef
         def automatic_managed?
           @automatic_managed ||= begin
             logger.trace("Checking if pagefiles are automatically managed")
-            cmd = shell_out("wmic.exe computersystem where name=\"%computername%\" get AutomaticManagedPagefile /format:list")
-            cmd.stderr.empty? && (cmd.stdout =~ /AutomaticManagedPagefile=TRUE/i)
+            cmd = "$sys = Get-CimInstance Win32_ComputerSystem -Property *;"
+            cmd << "return $sys.AutomaticManagedPagefile"
+            powershell_exec!(cmd).result
           end
         end
 
         # turn on automatic management of all pagefiles by Windows
         def set_automatic_managed
-          converge_by("set pagefile to Automatic Managed") do
-            logger.trace("Running wmic.exe computersystem where name=\"%computername%\" set AutomaticManagedPagefile=True")
-            cmd = shell_out("wmic.exe computersystem where name=\"%computername%\" set AutomaticManagedPagefile=True")
-            check_for_errors(cmd.stderr)
+          converge_by("Set pagefile to Automatic Managed") do
+            logger.trace("Running Set-CimInstance -InputObject $sys -Property @{AutomaticManagedPagefile=$true} -PassThru")
+            powershell_exec! <<~EOH
+              $sys = Get-CimInstance Win32_ComputerSystem -Property *
+              Set-CimInstance -InputObject $sys -Property @{AutomaticManagedPagefile=$true} -PassThru
+            EOH
           end
         end
 
         # turn off automatic management of all pagefiles by Windows
         def unset_automatic_managed
-          converge_by("set pagefile to User Managed") do
-            logger.trace("Running wmic.exe computersystem where name=\"%computername%\" set AutomaticManagedPagefile=False")
-            cmd = shell_out("wmic.exe computersystem where name=\"%computername%\" set AutomaticManagedPagefile=False")
-            check_for_errors(cmd.stderr)
+          if automatic_managed?
+            converge_by("Turn off Automatically Managed on pagefiles") do
+              logger.trace("Running Set-CimInstance -InputObject $sys -Property @{AutomaticManagedPagefile=$false} -PassThru")
+              powershell_exec! <<~EOH
+                $sys = Get-CimInstance Win32_ComputerSystem -Property *
+                Set-CimInstance -InputObject $sys -Property @{AutomaticManagedPagefile=$false} -PassThru
+              EOH
+            end
           end
         end
 
@@ -205,10 +248,14 @@ class Chef
         # @param [String] min the minimum size of the pagefile
         # @param [String] max the minimum size of the pagefile
         def set_custom_size(pagefile, min, max)
+          unset_automatic_managed
           converge_by("set #{pagefile} to InitialSize=#{min} & MaximumSize=#{max}") do
-            logger.trace("Running wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" set InitialSize=#{min},MaximumSize=#{max}")
-            cmd = shell_out("wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" set InitialSize=#{min},MaximumSize=#{max}", returns: [0])
-            check_for_errors(cmd.stderr)
+            logger.trace("Set-CimInstance -Property @{InitialSize = #{min} MaximumSize = #{max}")
+            powershell_exec! <<~EOD
+              $page_file = "#{pagefile}"
+              $driveLetter = $page_file.split(':')[0]
+              Get-CimInstance -ClassName Win32_PageFileSetting -Filter "SettingID='pagefile.sys @ $($driveLetter):'" -ErrorAction Stop | Set-CimInstance -Property @{InitialSize = #{min}; MaximumSize = #{max};}
+            EOD
           end
         end
 
@@ -217,21 +264,16 @@ class Chef
         # @param [String] pagefile path to the pagefile
         def set_system_managed(pagefile)
           converge_by("set #{pagefile} to System Managed") do
-            logger.trace("Running wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" set InitialSize=0,MaximumSize=0")
-            cmd = shell_out("wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" set InitialSize=0,MaximumSize=0", returns: [0])
-            check_for_errors(cmd.stderr)
+            logger.trace("Running ")
+            powershell_exec! <<~EOM
+              $page_file = "#{pagefile}"
+              $driveLetter = $page_file.split(':')[0]
+              Get-CimInstance -ClassName Win32_PageFileSetting -Filter "SettingID='pagefile.sys @ $($driveLetter):'" -ErrorAction Stop | Set-CimInstance -Property @{
+              InitialSize = 0
+              MaximumSize = 0}
+            EOM
           end
         end
-
-        def get_setting_id(pagefile)
-          split_path = pagefile.split('\\')
-          "#{split_path[1]} @ #{split_path[0]}"
-        end
-
-        # raise if there's an error on stderr on a shellout
-        def check_for_errors(stderr)
-          raise stderr.chomp unless stderr.empty?
-        end
       end
     end
   end

data/lib/chef/resource/windows_path.rb

@@ -64,7 +64,7 @@ class Chef
         end
       end
 
-      action :add do
+      action :add, description: "Add an item to the system path." do
         # The windows Env provider does not correctly expand variables in
         # the PATH environment variable. Ruby expects these to be expanded.
         #
@@ -72,11 +72,11 @@ class Chef
         env "path" do
           action :modify
           delim ::File::PATH_SEPARATOR
-          value path.tr("/", '\\')
+          value path.tr("/", "\\")
         end
       end
 
-      action :remove do
+      action :remove, description: "Remove an item from the system path." do
         # The windows Env provider does not correctly expand variables in
         # the PATH environment variable. Ruby expects these to be expanded.
         #
@@ -84,7 +84,7 @@ class Chef
         env "path" do
           action :delete
           delim ::File::PATH_SEPARATOR
-          value path.tr("/", '\\')
+          value path.tr("/", "\\")
         end
       end
     end

data/lib/chef/resource/windows_printer.rb

@@ -1,6 +1,7 @@
 #
 # Author:: Doug Ireton (<doug@1strategy.com>)
 # Copyright:: 2012-2018, Nordstrom, Inc.
+# Copyright:: Chef Software, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,6 +22,10 @@ require_relative "../resource"
 
 class Chef
   class Resource
+    # @todo
+    # 1. Allow updating the printer properties
+    # 2. Fail with a warning if the port can't be found and create_port is false
+    # 3. Fail with helpful messaging if the printer driver can't be installed
     class WindowsPrinter < Chef::Resource
       unified_mode true
 
@@ -28,7 +33,7 @@ class Chef
 
       provides(:windows_printer) { true }
 
-      description "Use the **windows_printer** resource to setup Windows printers. Note that this doesn't currently install a printer driver. You must already have the driver installed on the system."
+      description "Use the **windows_printer** resource to setup Windows printers. This resource will automatically install the driver specified in the `driver_name` property and will automatically create a printer port using either the `ipv4_address` property or the `port_name` property."
       introduced "14.0"
       examples <<~DOC
       **Create a printer**:
@@ -49,6 +54,23 @@ class Chef
         action :delete
       end
       ```
+
+      **Create a printer port and a printer that uses that port (new in 17.3)**
+
+      ```ruby
+      windows_printer_port '10.4.64.39' do
+        port_name 'My awesome printer port'
+        snmp_enabled true
+        port_protocol 2
+      end
+
+      windows_printer 'HP LaserJet 5th Floor' do
+        driver_name 'HP LaserJet 4100 Series PCL6'
+        port_name 'My awesome printer port'
+        ipv4_address '10.4.64.38'
+        create_port false
+      end
+      ```
       DOC
 
       property :device_id, String,
@@ -83,82 +105,79 @@ class Chef
             proc { |v| v.match(Resolv::IPv4::Regex) },
         }
 
-      PRINTERS_REG_KEY = 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Print\Printers\\'.freeze unless defined?(PRINTERS_REG_KEY)
+      property :create_port, [TrueClass, FalseClass],
+        description: "Create a printer port for the printer. Set this to false and specify the `port_name` property if using the `windows_printer_port` resource to create the port instead.",
+        introduced: "17.3",
+        default: true, desired_state: false
 
-      # @todo Set @current_resource printer properties from registry
-      load_current_value do |desired|
-        name desired.name
-      end
+      property :port_name, String,
+        description: "The port name.",
+        default: lazy { |x| "IP_#{x.ipv4_address}" },
+        introduced: "17.3",
+        default_description: "The resource block name or the ipv4_address prepended with IP_."
 
-      action :create do
-        description "Create a new printer and a printer port if one doesn't already exist."
+      load_current_value do |new_resource|
+        printer_data = powershell_exec(%Q{Get-WmiObject -Class Win32_Printer -Filter "Name='#{new_resource.device_id}'"}).result
 
-        if printer_exists?
-          Chef::Log.info "#{@new_resource} already exists - nothing to do."
+        if printer_data.empty?
+          current_value_does_not_exist!
         else
-          converge_by("Create #{@new_resource}") do
-            create_printer
+          device_id new_resource.device_id
+          comment printer_data["Comment"]
+          default printer_data["Default"]
+          location printer_data["Location"]
+          shared printer_data["Shared"]
+          share_name printer_data["ShareName"]
+          port_name printer_data["PortName"]
+
+          driver_data = powershell_exec(%Q{Get-PrinterDriver -Name="#{new_resource.driver_name}"}).result
+          unless driver_data.empty?
+            driver_name new_resource.driver_name
           end
         end
       end
 
-      action :delete do
-        description "Delete an existing printer. Note this does not delete the associated printer port."
-
-        if printer_exists?
-          converge_by("Delete #{@new_resource}") do
-            delete_printer
-          end
+      action :create, description: "Create a new printer and printer port, if one doesn't already." do
+        if current_resource
+          Chef::Log.info "#{@new_resource} already exists - nothing to do."
         else
-          Chef::Log.info "#{@current_resource} doesn't exist - can't delete."
-        end
-      end
+          # Create the printer port first unless the property is set to false
+          if new_resource.create_port
+            windows_printer_port new_resource.port_name do
+              ipv4_address new_resource.ipv4_address
+              port_name new_resource.port_name
+            end
+          end
 
-      action_class do
-        private
-
-        # does the printer exist
-        #
-        # @param [String] name the name of the printer
-        # @return [Boolean]
-        def printer_exists?
-          printer_reg_key = PRINTERS_REG_KEY + new_resource.name
-          logger.trace "Checking to see if this reg key exists: '#{printer_reg_key}'"
-          registry_key_exists?(printer_reg_key)
-        end
+          converge_by("install driver #{new_resource.driver_name}") do
+            powershell_exec!("Add-PrinterDriver -Name '#{new_resource.driver_name}'")
+          end
 
-        # creates the printer port and then the printer
-        def create_printer
-          # Create the printer port first
-          windows_printer_port new_resource.ipv4_address
-
-          port_name = "IP_#{new_resource.ipv4_address}"
-
-          declare_resource(:powershell_script, "Creating printer: #{new_resource.device_id}") do
-            code <<-EOH
-
-              Set-WmiInstance -class Win32_Printer `
-                -EnableAllPrivileges `
-                -Argument @{ DeviceID   = "#{new_resource.device_id}";
-                            Comment    = "#{new_resource.comment}";
-                            Default    = "$#{new_resource.default}";
-                            DriverName = "#{new_resource.driver_name}";
-                            Location   = "#{new_resource.location}";
-                            PortName   = "#{port_name}";
-                            Shared     = "$#{new_resource.shared}";
-                            ShareName  = "#{new_resource.share_name}";
-                          }
+          converge_by("create #{@new_resource.device_id}") do
+            powershell_exec! <<-EOH
+            Set-WmiInstance -class Win32_Printer `
+              -EnableAllPrivileges `
+              -Argument @{ DeviceID   = "#{new_resource.device_id}";
+                          Comment    = "#{new_resource.comment}";
+                          Default    = "$#{new_resource.default}";
+                          DriverName = "#{new_resource.driver_name}";
+                          Location   = "#{new_resource.location}";
+                          PortName   = "#{new_resource.port_name}";
+                          Shared     = "$#{new_resource.shared}";
+                          ShareName  = "#{new_resource.share_name}";
+                        }
             EOH
           end
         end
+      end
 
-        def delete_printer
-          declare_resource(:powershell_script, "Deleting printer: #{new_resource.device_id}") do
-            code <<-EOH
-              $printer = Get-WMIObject -class Win32_Printer -EnableAllPrivileges -Filter "name = '#{new_resource.device_id}'"
-              $printer.Delete()
-            EOH
+      action :delete, description: "Delete an existing printer. Note that this resource does not delete the associated printer port." do
+        if current_resource
+          converge_by("Delete #{new_resource.device_id}") do
+            powershell_exec!("Remove-Printer -Name '#{new_resource.device_id}'")
           end
+        else
+          Chef::Log.info "#{new_resource.device_id} doesn't exist - can't delete."
         end
       end
     end