chef 13.12.14-universal-mingw32 → 14.0.190-universal-mingw32

data/lib/chef/resource/windows_printer_port.rb

@@ -0,0 +1,136 @@
+#
+# Author:: Doug Ireton <doug@1strategy.com>
+# Copyright:: 2012-2018, Nordstrom, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# See here for more info:
+# http://msdn.microsoft.com/en-us/library/windows/desktop/aa394492(v=vs.85).aspx
+
+require "chef/resource"
+
+class Chef
+  class Resource
+    class WindowsPrinterPort < Chef::Resource
+      require "resolv"
+
+      resource_name :windows_printer_port
+      provides :windows_printer_port
+
+      description "Use the windows_printer_port resource to create and delete TCP/IPv4 printer ports on Windows."
+      introduced "14.0"
+
+      property :ipv4_address, String,
+               name_property: true,
+               regex: Resolv::IPv4::Regex,
+               validation_message: "The ipv4_address property must be in the format of WWW.XXX.YYY.ZZZ!",
+               description: "The IPv4 address of the printer port."
+
+      property :port_name, String,
+               description: "The port name."
+
+      property :port_number, Integer,
+               description: "The port number.",
+               default: 9100
+
+      property :port_description, String,
+               description: "The description of the port."
+
+      property :snmp_enabled, [TrueClass, FalseClass],
+               description: "Should SNMP be enabled on the port.",
+               default: false
+
+      property :port_protocol, Integer,
+               description: "The printer port protocol, 1 (RAW), or 2 (LPR).",
+               validation_message: "port_protocol must be either 1 for RAW or 2 for LPR!",
+               default: 1, equal_to: [1, 2]
+
+      property :exists, [TrueClass, FalseClass],
+               desired_state: true
+
+      PORTS_REG_KEY = 'HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Print\Monitors\Standard TCP/IP Port\Ports\\'.freeze unless defined?(PORTS_REG_KEY)
+
+      def port_exists?(name)
+        port_reg_key = PORTS_REG_KEY + name
+
+        logger.trace "Checking to see if this reg key exists: '#{port_reg_key}'"
+        registry_key_exists?(port_reg_key)
+      end
+
+      # @todo Set @current_resource port properties from registry
+      load_current_value do |desired|
+        name desired.name
+        ipv4_address desired.ipv4_address
+        port_name desired.port_name || "IP_#{desired.ipv4_address}"
+        exists port_exists?(desired.port_name || "IP_#{desired.ipv4_address}")
+      end
+
+      action :create do
+        description "Create the new printer port if it does not already exist."
+
+        if current_resource.exists
+          Chef::Log.info "#{@new_resource} already exists - nothing to do."
+        else
+          converge_by("Create #{@new_resource}") do
+            create_printer_port
+          end
+        end
+      end
+
+      action :delete do
+        description "Delete an existing printer port."
+
+        if current_resource.exists
+          converge_by("Delete #{@new_resource}") do
+            delete_printer_port
+          end
+        else
+          Chef::Log.info "#{@current_resource} doesn't exist - can't delete."
+        end
+      end
+
+      action_class do
+        def create_printer_port
+          port_name = new_resource.port_name || "IP_#{new_resource.ipv4_address}"
+
+          # create the printer port using PowerShell
+          declare_resource(:powershell_script, "Creating printer port #{new_resource.port_name}") do
+            code <<-EOH
+
+              Set-WmiInstance -class Win32_TCPIPPrinterPort `
+                -EnableAllPrivileges `
+                -Argument @{ HostAddress = "#{new_resource.ipv4_address}";
+                            Name        = "#{port_name}";
+                            Description = "#{new_resource.port_description}";
+                            PortNumber  = "#{new_resource.port_number}";
+                            Protocol    = "#{new_resource.port_protocol}";
+                            SNMPEnabled = "$#{new_resource.snmp_enabled}";
+                          }
+            EOH
+          end
+        end
+
+        def delete_printer_port
+          port_name = new_resource.port_name || "IP_#{new_resource.ipv4_address}"
+
+          declare_resource(:powershell_script, "Deleting printer port: #{new_resource.port_name}") do
+            code <<-EOH
+              $port = Get-WMIObject -class Win32_TCPIPPrinterPort -EnableAllPrivileges -Filter "name = '#{port_name}'"
+              $port.Delete()
+            EOH
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/windows_service.rb

@@ -17,58 +17,99 @@
 #
 
 require "chef/resource/service"
+require "chef/win32_service_constants"
 
 class Chef
   class Resource
-    # Use the windows_service resource to manage a service on the Microsoft Windows platform.
-    #
-    # @since 12.0
     class WindowsService < Chef::Resource::Service
+      include Chef::Win32ServiceConstants
+
+      ALLOWED_START_TYPES = {
+        automatic: SERVICE_AUTO_START,
+        manual: SERVICE_DEMAND_START,
+        disabled: SERVICE_DISABLED,
+      }
 
       # Until #1773 is resolved, you need to manually specify the windows_service resource
       # to use action :configure_startup and attribute startup_type
 
-      provides :windows_service, os: "windows"
+      provides :windows_service
       provides :service, os: "windows"
 
-      allowed_actions :configure_startup
+      description "Use the windows_service resource to manage a service on the Microsoft Windows platform."
+      introduced "12.0"
 
-      identity_attr :service_name
+      allowed_actions :configure_startup, :create, :delete, :configure
 
       state_attrs :enabled, :running
 
-      def initialize(name, run_context = nil)
-        super
-        @startup_type = :automatic
-        @run_as_user = ""
-        @run_as_password = ""
-      end
-
-      def startup_type(arg = nil)
-        # Set-Service arguments are automatic and manual
-        # Win32::Service returns 'auto start' or 'demand start' respectively, which the provider currently uses
-        set_or_return(
-          :startup_type,
-          arg,
-          :equal_to => [ :automatic, :manual, :disabled ]
-        )
-      end
-
-      def run_as_user(arg = nil)
-        set_or_return(
-          :run_as_user,
-          arg,
-          :kind_of => [ String ]
-        )
-      end
-
-      def run_as_password(arg = nil)
-        set_or_return(
-          :run_as_password,
-          arg,
-          :kind_of => [ String ]
-        )
-      end
+      property :service_name, name_property: true, identity: true
+
+      # The display name to be used by user interface programs to identify the
+      # service. This string has a maximum length of 256 characters.
+      property :display_name, String, regex: /^.{1,256}$/
+
+      # https://github.com/djberg96/win32-service/blob/ffi/lib/win32/windows/constants.rb#L19-L29
+      property :desired_access, Integer, default: SERVICE_ALL_ACCESS
+
+      # https://github.com/djberg96/win32-service/blob/ffi/lib/win32/windows/constants.rb#L31-L41
+      property :service_type, Integer, default: SERVICE_WIN32_OWN_PROCESS
+
+      # Valid options:
+      #   - :automatic
+      #   - :manual
+      #   - :disabled
+      # Reference: https://github.com/djberg96/win32-service/blob/ffi/lib/win32/windows/constants.rb#L49-L54
+      property :startup_type, [Symbol], equal_to: [:automatic, :manual, :disabled], default: :automatic, coerce: proc { |x|
+        if x.is_a?(Integer)
+          ALLOWED_START_TYPES.invert.fetch(x) do
+            Chef::Log.warn("Unsupported startup_type #{x}, falling back to :automatic")
+            :automatic
+          end
+        elsif x.is_a?(String)
+          x.to_sym
+        else
+          x
+        end
+      }
+
+      # This only applies if startup_type is :automatic
+      # 1 == delayed start is enabled
+      # 0 == NO delayed start
+      property :delayed_start, [TrueClass, FalseClass], default: false, coerce: proc { |x|
+        if x.is_a?(Integer)
+          x == 0 ? false : true
+        else
+          x
+        end
+      }
+
+      # https://github.com/djberg96/win32-service/blob/ffi/lib/win32/windows/constants.rb#L43-L47
+      property :error_control, Integer, default: SERVICE_ERROR_NORMAL
+
+      # The fully qualified path to the service binary file. The path can also
+      # include arguments for an auto-start service.
+      #
+      # This is required for :create and :configure actions -- intentionally
+      # not setting required: true here to support other actions
+      property :binary_path_name, String
+
+      # The names of the load ordering group of which this service is a member.
+      # Specify nil or an empty string if the service does not belong to a group.
+      property :load_order_group, String
+
+      # A pointer to a double null-terminated array of null-separated names of
+      # services or load ordering groups that the system must start before this
+      # service. Specify nil or an empty string if the service has no
+      # dependencies. Dependency on a group means that this service can run if
+      # at least one member of the group is running after an attempt to start
+      # all members of the group.
+      property :dependencies, [String, Array]
+
+      property :description, String
+
+      property :run_as_user, String, default: "LocalSystem"
+      property :run_as_password, String, default: ""
     end
   end
 end

data/lib/chef/resource/windows_shortcut.rb

@@ -0,0 +1,79 @@
+#
+# Author:: Doug MacEachern <dougm@vmware.com>
+# Copyright:: 2010-2018, VMware, Inc.
+# Copyright:: 2017-2018, 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.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "chef/resource"
+
+class Chef
+  class Resource
+    class WindowsShortcut < Chef::Resource
+      resource_name :windows_shortcut
+      provides :windows_shortcut
+
+      description "Use the windows_shortcut resource to create shortcut files on Windows"
+      introduced "14.0"
+
+      property :shortcut_name, String,
+               description: "The name for the shortcut if it differs from the resource name.",
+               name_property: true
+
+      property :target, String,
+               description: "Where the shortcut links to."
+
+      property :arguments, String,
+               description: "Arguments to pass to the target when the shortcut is executed."
+
+      property :description, String,
+               description: "The description of the shortcut"
+
+      property :cwd, String,
+               description: "Working directory to use when the target is executed."
+
+      property :iconlocation, String,
+               description: "Icon to use for the shortcut, in the format of 'path, index'. Index is the icon file to use. See https://msdn.microsoft.com/en-us/library/3s9bx7at.aspx for details"
+
+      load_current_value do |desired|
+        require "win32ole" if RUBY_PLATFORM =~ /mswin|mingw32|windows/
+
+        link = WIN32OLE.new("WScript.Shell").CreateShortcut(desired.shortcut_name)
+        name desired.shortcut_name
+        target(link.TargetPath)
+        arguments(link.Arguments)
+        description(link.Description)
+        cwd(link.WorkingDirectory)
+        iconlocation(link.IconLocation)
+      end
+
+      action :create do
+        description "Create or modify a Windows shortcut."
+
+        converge_if_changed do
+          converge_by "creating shortcut #{new_resource.shortcut_name}" do
+            link = WIN32OLE.new("WScript.Shell").CreateShortcut(new_resource.shortcut_name)
+            link.TargetPath = new_resource.target unless new_resource.target.nil?
+            link.Arguments = new_resource.arguments unless new_resource.arguments.nil?
+            link.Description = new_resource.description unless new_resource.description.nil?
+            link.WorkingDirectory = new_resource.cwd unless new_resource.cwd.nil?
+            link.IconLocation = new_resource.iconlocation unless new_resource.iconlocation.nil?
+            # ignoring: WindowStyle, Hotkey
+            link.Save
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/windows_task.rb

@@ -20,13 +20,13 @@ require "chef/resource"
 
 class Chef
   class Resource
-    # Use the windows_task resource to create, delete or run a Windows scheduled task. Requires Windows Server 2008
-    # or later due to API usage.
-    # @since 13.0
     class WindowsTask < Chef::Resource
-
       resource_name :windows_task
-      provides :windows_task, os: "windows"
+      provides :windows_task
+
+      description "Use the windows_task resource to create, delete or run a Windows"\
+                  " scheduled task. Requires Windows Server 2008 or later due to API usage."
+      introduced "13.0"
 
       allowed_actions :create, :delete, :run, :end, :enable, :disable
       default_action :create

data/lib/chef/resource/yum_package.rb

@@ -1,6 +1,6 @@
 #
 # Author:: AJ Christensen (<aj@chef.io>)
-# Copyright:: Copyright 2008-2017, Chef Software Inc.
+# Copyright:: Copyright 2008-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,7 +22,13 @@ class Chef
   class Resource
     class YumPackage < Chef::Resource::Package
       resource_name :yum_package
-      provides :package, os: "linux", platform_family: %w{rhel fedora amazon}
+      provides :package, platform_family: %w{rhel fedora amazon}
+
+      description "Use the yum_package resource to install, upgrade, and remove packages with Yum"\
+                  " for the Red Hat and CentOS platforms. The yum_package resource is able to resolve"\
+                  " provides data for packages much like Yum can do when it is run from the command line."\
+                  " This allows a variety of options for installing packages, like minimum versions,"\
+                  " virtual provides, and library names."
 
       # XXX: the coercions here are due to the provider promiscuously updating the properties on the
       # new_resource which causes immutable modification exceptions when passed an immutable node array.

data/lib/chef/resource/yum_repository.rb

@@ -20,14 +20,16 @@ require "chef/resource"
 
 class Chef
   class Resource
-    # Use the yum_repository resource to manage a Yum repository configuration file located at /etc/yum.repos.d/repositoryid.repo
-    # on the local machine. This configuration file specifies which repositories to reference, how to handle cached data, etc.
-    #
-    # @since 12.14
     class YumRepository < Chef::Resource
       resource_name :yum_repository
       provides :yum_repository
 
+      description "Use the yum_repository resource to manage a Yum repository configuration"\
+                  " file located at /etc/yum.repos.d/repositoryid.repo on the local machine."\
+                  " This configuration file specifies which repositories to reference, how to"\
+                  " handle cached data, etc."
+      introduced "12.14"
+
       # http://linux.die.net/man/5/yum.conf as well as
       # http://dnf.readthedocs.io/en/latest/conf_ref.html
       property :baseurl, [String, Array]
@@ -63,7 +65,12 @@ class Chef
       property :proxy, String
       property :repo_gpgcheck, [TrueClass, FalseClass]
       property :report_instanceid, [TrueClass, FalseClass]
-      property :repositoryid, String, name_property: true
+
+      property :repositoryid, String,
+               regex: [/^[^\/]+$/],
+               validation_message: "repositoryid property cannot contain a forward slash '/'",
+               name_property: true
+
       property :skip_if_unavailable, [TrueClass, FalseClass]
       property :source, String
       property :sslcacert, String

data/lib/chef/resource/zypper_package.rb

@@ -20,14 +20,16 @@ require "chef/resource/package"
 
 class Chef
   class Resource
-    # Use the zypper_package resource to install, upgrade, and remove packages with Zypper for the SUSE Enterprise and
-    # OpenSUSE platforms.
+
     class ZypperPackage < Chef::Resource::Package
       resource_name :zypper_package
       provides :package, platform_family: "suse"
 
+      description "Use the zypper_package resource to install, upgrade, and remove"\
+                  " packages with Zypper for the SUSE Enterprise and OpenSUSE platforms."
+
       property :gpg_check, [ TrueClass, FalseClass ], default: lazy { Chef::Config[:zypper_check_gpg] }
-      property :allow_downgrade, [ true, false ], default: false
+      property :allow_downgrade, [ TrueClass, FalseClass ], default: false
     end
   end
 end