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

data/lib/chef/resource/rpm_package.rb

@@ -17,14 +17,14 @@
 #
 
 require "chef/resource/package"
-require "chef/provider/package/rpm"
 
 class Chef
   class Resource
-    # Use the rpm_package resource to manage packages for the RPM Package Manager platform.
     class RpmPackage < Chef::Resource::Package
       resource_name :rpm_package
-      provides :rpm_package, os: %w{linux aix}
+      provides :rpm_package
+
+      description "Use the rpm_package resource to manage packages for the RPM Package Manager platform."
 
       property :allow_downgrade, [ true, false ], default: false, desired_state: false
 

data/lib/chef/resource/ruby.rb

@@ -21,11 +21,13 @@ require "chef/provider/script"
 
 class Chef
   class Resource
-    # Use the ruby resource to execute scripts using the Ruby interpreter. This resource may also use any of the actions
-    # and properties that are available to the execute resource. Commands that are executed with this resource are (by
-    # their nature) not idempotent, as they are typically unique to the environment in which they are run. Use not_if and
-    # only_if to guard this resource for idempotence.
     class Ruby < Chef::Resource::Script
+      description "Use the ruby resource to execute scripts using the Ruby interpreter. This"\
+                  " resource may also use any of the actions and properties that are available"\
+                  " to the execute resource. Commands that are executed with this resource are (by"\
+                  " their nature) not idempotent, as they are typically unique to the environment"\
+                  " in which they are run. Use not_if and only_if to guard this resource for idempotence."
+
       def initialize(name, run_context = nil)
         super
         @interpreter = "ruby"

data/lib/chef/resource/ruby_block.rb

@@ -22,20 +22,15 @@ require "chef/provider/ruby_block"
 
 class Chef
   class Resource
-    # Use the ruby_block resource to execute Ruby code during a chef-client run. Ruby code in the ruby_block resource is
-    # evaluated with other resources during convergence, whereas Ruby code outside of a ruby_block resource is evaluated
-    # before other resources, as the recipe is compiled.
     class RubyBlock < Chef::Resource
+      description "Use the ruby_block resource to execute Ruby code during a chef-client run."\
+                  " Ruby code in the ruby_block resource is evaluated with other resources during"\
+                  " convergence, whereas Ruby code outside of a ruby_block resource is evaluated"\
+                  " before other resources, as the recipe is compiled."
+
       default_action :run
       allowed_actions :create, :run
 
-      identity_attr :block_name
-
-      def initialize(name, run_context = nil)
-        super
-        @block_name = name
-      end
-
       def block(&block)
         if block_given? && block
           @block = block
@@ -44,13 +39,7 @@ class Chef
         end
       end
 
-      def block_name(arg = nil)
-        set_or_return(
-          :block_name,
-          arg,
-          :kind_of => String
-        )
-      end
+      property :block_name, String, name_property: true, identity: true
     end
   end
 end

data/lib/chef/resource/scm.rb

@@ -21,157 +21,25 @@ require "chef/resource"
 class Chef
   class Resource
     class Scm < Chef::Resource
-      identity_attr :destination
-
-      state_attrs :revision
-
       default_action :sync
       allowed_actions :checkout, :export, :sync, :diff, :log
 
-      def initialize(name, run_context = nil)
-        super
-        @destination = name
-        @enable_submodules = false
-        @enable_checkout = true
-        @revision = "HEAD"
-        @remote = "origin"
-        @ssh_wrapper = nil
-        @depth = nil
-        @checkout_branch = "deploy"
-        @environment = nil
-      end
-
-      def destination(arg = nil)
-        set_or_return(
-          :destination,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def repository(arg = nil)
-        set_or_return(
-          :repository,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def revision(arg = nil)
-        set_or_return(
-          :revision,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def user(arg = nil)
-        set_or_return(
-          :user,
-          arg,
-          :kind_of => [String, Integer]
-        )
-      end
-
-      def group(arg = nil)
-        set_or_return(
-          :group,
-          arg,
-          :kind_of => [String, Integer]
-        )
-      end
-
-      def svn_username(arg = nil)
-        set_or_return(
-          :svn_username,
-          arg,
-          :kind_of => String
-        )
-      end
-
+      property :destination, String, name_property: true, identity: true
+      property :repository, String
+      property :revision, String, default: "HEAD"
+      property :user, [String, Integer]
+      property :group, [String, Integer]
+      property :svn_username, String
       property :svn_password, String, sensitive: true, desired_state: false
-
-      def svn_arguments(arg = nil)
-        @svn_arguments, arg = nil, nil if arg == false
-        set_or_return(
-          :svn_arguments,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def svn_info_args(arg = nil)
-        @svn_info_args, arg = nil, nil if arg == false
-        set_or_return(
-          :svn_info_args,
-          arg,
-          :kind_of => String)
-      end
-
       # Capistrano and git-deploy use ``shallow clone''
-      def depth(arg = nil)
-        set_or_return(
-          :depth,
-          arg,
-          :kind_of => Integer
-        )
-      end
-
-      def enable_submodules(arg = nil)
-        set_or_return(
-          :enable_submodules,
-          arg,
-          :kind_of => [TrueClass, FalseClass]
-        )
-      end
-
-      def enable_checkout(arg = nil)
-        set_or_return(
-          :enable_checkout,
-          arg,
-          :kind_of => [TrueClass, FalseClass]
-        )
-      end
-
-      def remote(arg = nil)
-        set_or_return(
-          :remote,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def ssh_wrapper(arg = nil)
-        set_or_return(
-          :ssh_wrapper,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def timeout(arg = nil)
-        set_or_return(
-          :timeout,
-          arg,
-          :kind_of => Integer
-        )
-      end
-
-      def checkout_branch(arg = nil)
-        set_or_return(
-          :checkout_branch,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def environment(arg = nil)
-        set_or_return(
-          :environment,
-          arg,
-          :kind_of => [ Hash ]
-        )
-      end
+      property :depth, Integer
+      property :enable_submodules, [TrueClass, FalseClass], default: false
+      property :enable_checkout, [TrueClass, FalseClass], default: true
+      property :remote, String, default: "origin"
+      property :ssh_wrapper, String
+      property :timeout, Integer
+      property :checkout_branch, String, default: "deploy"
+      property :environment, [Hash, nil], default: nil
 
       alias :env :environment
     end

data/lib/chef/resource/script.rb

@@ -18,17 +18,19 @@
 #
 
 require "chef/resource/execute"
-require "chef/provider/script"
 
 class Chef
   class Resource
-    # Use the script resource to execute scripts using a specified interpreter, such as Bash, csh, Perl, Python, or Ruby.
-    # This resource may also use any of the actions and properties that are available to the execute resource. Commands
-    # that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the
-    # environment in which they are run. Use not_if and only_if to guard this resource for idempotence.
     class Script < Chef::Resource::Execute
+      resource_name :script
+
       identity_attr :name
 
+      description "Use the script resource to execute scripts using a specified interpreter, such as Bash, csh, Perl, Python, or Ruby."\
+                  " This resource may also use any of the actions and properties that are available to the execute resource. Commands"\
+                  " that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the"\
+                  " environment in which they are run. Use not_if and only_if to guard this resource for idempotence."
+
       def initialize(name, run_context = nil)
         super
         @command = nil

data/lib/chef/resource/service.rb

@@ -22,12 +22,13 @@ require "shellwords"
 
 class Chef
   class Resource
-    # Use the service resource to manage a service.
     class Service < Chef::Resource
       identity_attr :service_name
 
       state_attrs :enabled, :running, :masked
 
+      description "Use the service resource to manage a service."
+
       default_action :nothing
       allowed_actions :enable, :disable, :start, :stop, :restart, :reload,
                       :mask, :unmask

data/lib/chef/resource/smartos_package.rb

@@ -17,14 +17,15 @@
 #
 
 require "chef/resource/package"
-require "chef/provider/package/smartos"
 
 class Chef
   class Resource
-    # Use the smartos_package resource to manage packages for the SmartOS platform.
     class SmartosPackage < Chef::Resource::Package
       resource_name :smartos_package
-      provides :package, os: "solaris2", platform_family: "smartos"
+      provides :smartos_package
+      provides :package, platform_family: "smartos"
+
+      description "Use the smartos_package resource to manage packages for the SmartOS platform."
     end
   end
 end

data/lib/chef/resource/solaris_package.rb

@@ -18,15 +18,16 @@
 #
 
 require "chef/resource/package"
-require "chef/provider/package/solaris"
 
 class Chef
   class Resource
-    # The solaris_package resource is used to manage packages for the Solaris platform.
     class SolarisPackage < Chef::Resource::Package
       resource_name :solaris_package
+      provides :solaris_package
       provides :package, os: "solaris2", platform_family: "nexentacore"
       provides :package, os: "solaris2", platform_family: "solaris2", platform_version: "<= 5.10"
+
+      description "The solaris_package resource is used to manage packages for the Solaris platform."
     end
   end
 end

data/lib/chef/resource/subversion.rb

@@ -21,15 +21,16 @@ require "chef/resource/scm"
 
 class Chef
   class Resource
-    # Use the subversion resource to manage source control resources that exist in a Subversion repository.
     class Subversion < Chef::Resource::Scm
+      description "Use the subversion resource to manage source control resources that"\
+                  " exist in a Subversion repository."
+
       allowed_actions :force_export
 
       def initialize(name, run_context = nil)
         super
         @svn_arguments = "--no-auth-cache"
         @svn_info_args = "--no-auth-cache"
-        @svn_binary = nil
       end
 
       # Override exception to strip password if any, so it won't appear in logs and different Chef notifications
@@ -37,9 +38,24 @@ class Chef
         "#{self} (#{defined_at}) had an error: #{e.class.name}: #{svn_password ? e.message.gsub(svn_password, "[hidden_password]") : e.message}"
       end
 
-      def svn_binary(arg = nil)
-        set_or_return(:svn_binary, arg, :kind_of => [String])
+      def svn_arguments(arg = nil)
+        @svn_arguments, arg = nil, nil if arg == false
+        set_or_return(
+          :svn_arguments,
+          arg,
+          :kind_of => String
+        )
+      end
+
+      def svn_info_args(arg = nil)
+        @svn_info_args, arg = nil, nil if arg == false
+        set_or_return(
+          :svn_info_args,
+          arg,
+          :kind_of => String)
       end
+
+      property :svn_binary, String
     end
   end
 end

data/lib/chef/resource/sudo.rb

@@ -0,0 +1,231 @@
+#
+# Author:: Bryan W. Berry (<bryan.berry@gmail.com>)
+# Author:: Seth Vargo (<sethvargo@gmail.com>)
+#
+# Copyright:: 2011-2018, Bryan w. Berry
+# Copyright:: 2012-2018, Seth Vargo
+# Copyright:: 2015-2018, Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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 Sudo < Chef::Resource
+      resource_name "sudo"
+      provides "sudo"
+
+      description "Use the sudo resource to add or remove individual sudo entries using sudoers.d files."\
+                  " Sudo version 1.7.2 or newer is required to use the sudo resource, as it relies on the"\
+                  " '#includedir' directive introduced in version 1.7.2. This resource does not enforce"\
+                  " installation of the required sudo version. Supported releases of Ubuntu, SuSE, Debian,"\
+                  " and RHEL (6+) all support this feature."
+      introduced "14.0"
+
+      # acording to the sudo man pages sudo will ignore files in an include dir that have a `.` or `~`
+      # We convert either to `__`
+      property :filename, String,
+               description: "The name of the sudoers.d file",
+               name_property: true,
+               coerce: proc { |x| x.gsub(/[\.~]/, "__") }
+
+      property :users, [String, Array],
+               description: "User(s) to provide sudo privileges to. This accepts either an array or a comma separated.",
+               default: lazy { [] },
+               coerce: proc { |x| x.is_a?(Array) ? x : x.split(/\s*,\s*/) }
+
+      property :groups, [String, Array],
+               description: "Group(s) to provide sudo privileges to. This accepts either an array or a comma separated list. Leading % on group names is optional.",
+               default: lazy { [] },
+               coerce: proc { |x| coerce_groups(x) }
+
+      property :commands, Array,
+               description: "An array of commands this sudoer can execute.",
+               default: ["ALL"]
+
+      property :host, String,
+               description: "The host to set in the sudo config.",
+               default: "ALL"
+
+      property :runas, String,
+               description: "User the command(s) can be run as",
+               default: "ALL"
+
+      property :nopasswd, [TrueClass, FalseClass],
+               description: "Allow running sudo without specifying a password sudo",
+               default: false
+
+      property :noexec, [TrueClass, FalseClass],
+               description: "Prevent commands from shelling out.",
+               default: false
+
+      property :template, String,
+               description: "The name of the erb template in your cookbook if you wish to supply your own template."
+
+      property :variables, [Hash, nil],
+               description: "The variables to pass to the custom template. Ignored if not using a custom template.",
+               default: nil
+
+      property :defaults, Array,
+               description: "An array of defaults for the user/group.",
+               default: lazy { [] }
+
+      property :command_aliases, Array,
+               description: "Command aliases that can be used as allowed commands later in the config",
+               default: lazy { [] }
+
+      property :setenv, [TrueClass, FalseClass],
+               description: "Whether to permit the preserving of environment with sudo -E.",
+               default: false
+
+      property :env_keep_add, Array,
+               description: "An array of strings to add to env_keep.",
+               default: lazy { [] }
+
+      property :env_keep_subtract, Array,
+               description: "An array of strings to remove from env_keep.",
+               default: lazy { [] }
+
+      property :visudo_path, String,
+               description: "Deprecated property. Do not use."
+
+      property :visudo_binary, String,
+               description: "The path to visudo for config verification.",
+               default: "/usr/sbin/visudo"
+
+      property :config_prefix, String,
+               description: "The directory containing the sudoers config file.",
+               default: lazy { platform_config_prefix }
+
+      # handle legacy cookbook property
+      def after_created
+        raise "The 'visudo_path' property from the sudo cookbook has been replaced with the 'visudo_binary' property. The path is now more intelligently determined and for most users specifying the path should no longer be necessary. If this resource still cannot determine the path to visudo then provide the full path to the binary with the 'visudo_binary' property." if visudo_path
+      end
+
+      # VERY old legacy properties
+      alias_method :user, :users
+      alias_method :group, :groups
+
+      # make sure each group starts with a %
+      def coerce_groups(x)
+        # split strings on the commas with optional spaces on either side
+        groups = x.is_a?(Array) ? x : x.split(/\s*,\s*/)
+
+        # make sure all the groups start with %
+        groups.map { |g| g[0] == "%" ? g : "%#{g}" }
+      end
+
+      # default config prefix paths based on platform
+      # @return [String]
+      def platform_config_prefix
+        case node["platform_family"]
+        when "smartos"
+          "/opt/local/etc"
+        when "mac_os_x"
+          "/private/etc"
+        when "freebsd"
+          "/usr/local/etc"
+        else
+          "/etc"
+        end
+      end
+
+      action :create do
+        description "Create a single sudoers config in the sudoers.d directory"
+
+        validate_properties
+
+        if docker? # don't even put this into resource collection unless we're in docker
+          declare_resource(:package, "sudo") do
+            action :nothing
+            not_if "which sudo"
+          end.run_action(:install)
+        end
+
+        target = "#{new_resource.config_prefix}/sudoers.d/"
+        declare_resource(:directory, target) unless ::File.exist?(target)
+
+        Chef::Log.warn("#{new_resource.filename} will be rendered, but will not take effect because the #{new_resource.config_prefix}/sudoers config lacks the includedir directive that loads configs from #{new_resource.config_prefix}/sudoers.d/!") if ::File.readlines("#{new_resource.config_prefix}/sudoers").grep(/includedir/).empty?
+
+        if new_resource.template
+          logger.trace("Template property provided, all other properties ignored.")
+
+          declare_resource(:template, "#{target}#{new_resource.filename}") do
+            source new_resource.template
+            mode "0440"
+            variables new_resource.variables
+            verify "#{new_resource.visudo_binary} -cf %{path}" if visudo_present?
+            action :create
+          end
+        else
+          declare_resource(:template, "#{target}#{new_resource.filename}") do
+            source "sudoer.erb"
+            source ::File.expand_path("../support/sudoer.erb", __FILE__)
+            local true
+            mode "0440"
+            variables sudoer:            (new_resource.groups + new_resource.users).join(","),
+                      host:               new_resource.host,
+                      runas:              new_resource.runas,
+                      nopasswd:           new_resource.nopasswd,
+                      noexec:             new_resource.noexec,
+                      commands:           new_resource.commands,
+                      command_aliases:    new_resource.command_aliases,
+                      defaults:           new_resource.defaults,
+                      setenv:             new_resource.setenv,
+                      env_keep_add:       new_resource.env_keep_add,
+                      env_keep_subtract:  new_resource.env_keep_subtract
+            verify "#{new_resource.visudo_binary} -cf %{path}" if visudo_present?
+            action :create
+          end
+        end
+      end
+
+      action :install do
+        Chef::Log.warn("The sudo :install action has been renamed :create. Please update your cookbook code for the new action")
+        action_create
+      end
+
+      action :remove do
+        Chef::Log.warn("The sudo :remove action has been renamed :delete. Please update your cookbook code for the new action")
+        action_delete
+      end
+
+      # Removes a user from the sudoers group
+      action :delete do
+        description "Remove a sudoers config from the sudoers.d directory"
+
+        file "#{new_resource.config_prefix}/sudoers.d/#{new_resource.filename}" do
+          action :delete
+        end
+      end
+
+      action_class do
+        # Ensure that the inputs are valid (we cannot just use the resource for this)
+        def validate_properties
+          # if group, user, env_keep_add, env_keep_subtract and template are nil, throw an exception
+          raise "You must specify users, groups, env_keep_add, env_keep_subtract, or template properties!" if new_resource.users.empty? && new_resource.groups.empty? && new_resource.template.nil? && new_resource.env_keep_add.empty? && new_resource.env_keep_subtract.empty?
+
+          # if specifying user or group and template at the same time fail
+          raise "You cannot specify users or groups properties and also specify a template. To use your own template pass in all template variables using the variables property." if (!new_resource.users.empty? || !new_resource.groups.empty?) && !new_resource.template.nil?
+        end
+
+        def visudo_present?
+          return true if ::File.exist?(new_resource.visudo_binary)
+          Chef::Log.warn("The visudo binary cannot be found at '#{new_resource.visudo_binary}'. Skipping sudoer file validation. If visudo is on this system you can specify the path using the 'visudo_binary' property.")
+        end
+      end
+    end
+  end
+end