chef 16.1.16 → 16.18.30

data/lib/chef/resource/windows_service.rb

@@ -23,6 +23,7 @@ class Chef
   class Resource
     class WindowsService < Chef::Resource::Service
       include Chef::Win32ServiceConstants
+      unified_mode true
 
       ALLOWED_START_TYPES = {
         automatic: SERVICE_AUTO_START,
@@ -38,6 +39,113 @@ class Chef
 
       description "Use the **windows_service** resource to create, delete, or manage a service on the Microsoft Windows platform."
       introduced "12.0"
+      examples <<~DOC
+      **Starting Services**
+
+      Start a service with a `manual` startup type:
+
+      ```ruby
+      windows_service 'BITS' do
+        action :configure_startup
+        startup_type :manual
+      end
+      ```
+
+      **Creating Services**
+
+      Create a service named chef-client:
+
+      ```ruby
+      windows_service 'chef-client' do
+        action :create
+        binary_path_name "C:\\opscode\\chef\\bin"
+      end
+      ```
+
+      Create a service with `service_name` and `display_name`:
+
+      ```ruby
+      windows_service 'Setup chef-client as a service' do
+        action :create
+        display_name 'CHEF-CLIENT'
+        service_name 'chef-client'
+        binary_path_name "C:\\opscode\\chef\\bin"
+      end
+      ```
+
+      Create a service with the `manual` startup type:
+
+      ```ruby
+      windows_service 'chef-client' do
+        action :create
+        binary_path_name "C:\\opscode\\chef\\bin"
+        startup_type :manual
+      end
+      ```
+
+      Create a service with the `disabled` startup type:
+
+      ```ruby
+      windows_service 'chef-client' do
+        action :create
+        binary_path_name "C:\\opscode\\chef\\bin"
+        startup_type :disabled
+      end
+      ```
+
+      Create a service with the `automatic` startup type and delayed start enabled:
+
+      ```ruby
+      windows_service 'chef-client' do
+        action :create
+        binary_path_name "C:\\opscode\\chef\\bin"
+        startup_type :automatic
+        delayed_start true
+      end
+      ```
+
+      Create a service with a description:
+
+      ```ruby
+      windows_service 'chef-client' do
+        action :create
+        binary_path_name "C:\\opscode\\chef\\bin"
+        startup_type :automatic
+        description "Chef client as service"
+      end
+      ```
+
+      **Deleting Services**
+
+      Delete a service named chef-client:
+
+      ```ruby
+      windows_service 'chef-client' do
+        action :delete
+      end
+      ```
+
+      Delete a service with the `service_name` property:
+
+      ```ruby
+      windows_service 'Delete chef client' do
+        action :delete
+        service_name 'chef-client'
+      end
+      ```
+
+      **Configuring Services**
+
+      Change an existing service from automatic to manual startup:
+
+      ```ruby
+      windows_service 'chef-client' do
+        action :configure
+        binary_path_name "C:\\opscode\\chef\\bin"
+        startup_type :manual
+      end
+      ```
+      DOC
 
       allowed_actions :configure_startup, :create, :delete, :configure
 

data/lib/chef/resource/windows_share.rb

@@ -20,12 +20,13 @@
 #
 
 require_relative "../resource"
-require_relative "../json_compat"
 require_relative "../util/path_helper"
 
 class Chef
   class Resource
     class WindowsShare < Chef::Resource
+      unified_mode true
+
       provides :windows_share
 
       description "Use the **windows_share** resource to create, modify and remove Windows shares."
@@ -59,7 +60,7 @@ class Chef
       # Specifies the path of the location of the folder to share. The path must be fully qualified. Relative paths or paths that contain wildcard characters are not permitted.
       property :path, String,
         description: "The path of the folder to share. Required when creating. If the share already exists on a different path then it is deleted and re-created.",
-        coerce: proc { |p| p.gsub(%r{/}, "\\") || p }
+        coerce: proc { |p| p.tr("/", "\\") || p }
 
       # Specifies an optional description of the SMB share. A description of the share is displayed by running the Get-SmbShare cmdlet. The description may not contain more than 256 characters.
       property :description, String,
@@ -117,25 +118,23 @@ class Chef
       # Specifies which files and folders in the SMB share are visible to users. AccessBased: SMB does not the display the files and folders for a share to a user unless that user has rights to access the files and folders. By default, access-based enumeration is disabled for new SMB shares. Unrestricted: SMB displays files and folders to a user even when the user does not have permission to access the items.
       # property :folder_enumeration_mode, String, equal_to: %(AccessBased Unrestricted)
 
-      include Chef::Mixin::PowershellOut
-
       load_current_value do |desired|
         # this command selects individual objects because EncryptData & CachingMode have underlying
         # types that get converted to their Integer values by ConvertTo-Json & we need to make sure
         # those get written out as strings
-        share_state_cmd = "Get-SmbShare -Name '#{desired.share_name}' | Select-Object Name,Path, Description, Temporary, CATimeout, ContinuouslyAvailable, ConcurrentUserLimit, EncryptData | ConvertTo-Json -Compress"
+        share_state_cmd = "Get-SmbShare -Name '#{desired.share_name}' | Select-Object Name,Path, Description, Temporary, CATimeout, ContinuouslyAvailable, ConcurrentUserLimit, EncryptData"
 
         Chef::Log.debug("Running '#{share_state_cmd}' to determine share state'")
-        ps_results = powershell_out(share_state_cmd)
+        ps_results = powershell_exec(share_state_cmd)
 
         # detect a failure without raising and then set current_resource to nil
         if ps_results.error?
-          Chef::Log.debug("Error fetching share state: #{ps_results.stderr}")
+          Chef::Log.debug("Error fetching share state: #{ps_results.errors}")
           current_value_does_not_exist!
         end
 
-        Chef::Log.debug("The Get-SmbShare results were #{ps_results.stdout}")
-        results = Chef::JSONCompat.from_json(ps_results.stdout)
+        Chef::Log.debug("The Get-SmbShare results were #{ps_results.result}")
+        results = ps_results.result
 
         path results["Path"]
         description results["Description"]
@@ -147,18 +146,18 @@ class Chef
         encrypt_data results["EncryptData"]
         # folder_enumeration_mode results['FolderEnumerationMode']
 
-        perm_state_cmd = %{Get-SmbShareAccess -Name "#{desired.share_name}" | Select-Object AccountName,AccessControlType,AccessRight | ConvertTo-Json -Compress}
+        perm_state_cmd = %{Get-SmbShareAccess -Name "#{desired.share_name}" | Select-Object AccountName,AccessControlType,AccessRight}
 
         Chef::Log.debug("Running '#{perm_state_cmd}' to determine share permissions state'")
-        ps_perm_results = powershell_out(perm_state_cmd)
+        ps_perm_results = powershell_exec(perm_state_cmd)
 
         # we raise here instead of warning like above because we'd only get here if the above Get-SmbShare
         # command was successful and that continuing would leave us with 1/2 known state
         raise "Could not determine #{desired.share_name} share permissions by running '#{perm_state_cmd}'" if ps_perm_results.error?
 
-        Chef::Log.debug("The Get-SmbShareAccess results were #{ps_perm_results.stdout}")
+        Chef::Log.debug("The Get-SmbShareAccess results were #{ps_perm_results.result}")
 
-        f_users, c_users, r_users = parse_permissions(ps_perm_results.stdout)
+        f_users, c_users, r_users = parse_permissions(ps_perm_results.result)
 
         full_users f_users
         change_users c_users
@@ -167,8 +166,7 @@ class Chef
 
       # given the string output of Get-SmbShareAccess parse out
       # arrays of full access users, change users, and read only users
-      def parse_permissions(results_string)
-        json_results = Chef::JSONCompat.from_json(results_string)
+      def parse_permissions(json_results)
         json_results = [json_results] unless json_results.is_a?(Array) # single result is not an array
 
         f_users = []
@@ -233,6 +231,8 @@ class Chef
       end
 
       action_class do
+        private
+
         def different_path?
           return false if current_resource.nil? # going from nil to something isn't different for our concerns
           return false if current_resource.path == Chef::Util::PathHelper.cleanpath(new_resource.path)
@@ -244,14 +244,16 @@ class Chef
           delete_command = "Remove-SmbShare -Name '#{new_resource.share_name}' -Force"
 
           Chef::Log.debug("Running '#{delete_command}' to remove the share")
-          powershell_out!(delete_command)
+          powershell_exec!(delete_command)
         end
 
         def update_share
-          update_command = "Set-SmbShare -Name '#{new_resource.share_name}' -Description '#{new_resource.description}' -Force"
+          update_command = "Set-SmbShare -Name '#{new_resource.share_name}' -Description '#{new_resource.description}'  -ConcurrentUserLimit #{new_resource.concurrent_user_limit} -CATimeout #{new_resource.ca_timeout} -EncryptData:#{bool_string(new_resource.encrypt_data)} -ContinuouslyAvailable:#{bool_string(new_resource.continuously_available)} -Force"
+          update_command << " -ScopeName #{new_resource.scope_name}" unless new_resource.scope_name == "*" # passing * causes the command to fail
+          update_command << " -Temporary:#{bool_string(new_resource.temporary)}" if new_resource.temporary # only set true
 
           Chef::Log.debug("Running '#{update_command}' to update the share")
-          powershell_out!(update_command)
+          powershell_exec!(update_command)
         end
 
         def create_share
@@ -262,7 +264,7 @@ class Chef
           share_cmd << " -Temporary:#{bool_string(new_resource.temporary)}" if new_resource.temporary # only set true
 
           Chef::Log.debug("Running '#{share_cmd}' to create the share")
-          powershell_out!(share_cmd)
+          powershell_exec!(share_cmd)
 
           # New-SmbShare adds the "Everyone" user with read access no matter what so we need to remove it
           # before we add our permissions
@@ -297,7 +299,7 @@ class Chef
             grant_command = "Grant-SmbShareAccess -Name '#{new_resource.share_name}' -AccountName \"#{new_resource.send("#{perm_type}_users").join('","')}\" -Force -AccessRight #{perm_type}"
 
             Chef::Log.debug("Running '#{grant_command}' to update the share permissions")
-            powershell_out!(grant_command)
+            powershell_exec!(grant_command)
           end
         end
 
@@ -328,7 +330,7 @@ class Chef
         def revoke_user_permissions(users)
           revoke_command = "Revoke-SmbShareAccess -Name '#{new_resource.share_name}' -AccountName \"#{users.join('","')}\" -Force"
           Chef::Log.debug("Running '#{revoke_command}' to revoke share permissions")
-          powershell_out!(revoke_command)
+          powershell_exec!(revoke_command)
         end
 
         # convert True/False into "$True" & "$False"

data/lib/chef/resource/windows_shortcut.rb

@@ -21,6 +21,8 @@ require_relative "../resource"
 class Chef
   class Resource
     class WindowsShortcut < Chef::Resource
+      unified_mode true
+
       provides(:windows_shortcut) { true }
 
       description "Use the **windows_shortcut** resource to create shortcut files on Windows."
@@ -34,7 +36,6 @@ class Chef
         description 'Make a shortcut to C:\\original_dir'
       end
       ```
-
       DOC
 
       property :shortcut_name, String,
@@ -57,7 +58,7 @@ class Chef
         description: "Icon to use for the shortcut. Accepts the format of `path, index`, where index is the icon file to use. See Microsoft's [documentation](https://msdn.microsoft.com/en-us/library/3s9bx7at.aspx) for details"
 
       load_current_value do |desired|
-        require "win32ole" if RUBY_PLATFORM =~ /mswin|mingw32|windows/
+        require "win32ole" if RUBY_PLATFORM.match?(/mswin|mingw32|windows/)
 
         link = WIN32OLE.new("WScript.Shell").CreateShortcut(desired.shortcut_name)
         name desired.shortcut_name