chef 13.12.14 → 14.0.190

data/lib/chef/resource/support/sudoer.erb

@@ -0,0 +1,18 @@
+# This file is managed by Chef.
+# Do NOT modify this file directly.
+
+<% @command_aliases.each do |a| -%>
+Cmnd_Alias <%= a[:name].upcase %> = <%= a[:command_list].join(', ') %>
+<% end -%>
+<% @env_keep_add.each do |env_keep| -%>
+Defaults    env_keep += "<%= env_keep %>"
+<% end -%>
+<% @env_keep_subtract.each do |env_keep| -%>
+Defaults    env_keep -= "<%= env_keep %>"
+<% end -%>
+<% @commands.each do |command| -%>
+<% unless @sudoer.empty? %><%= @sudoer %> <%= @host %>=(<%= @runas %>) <%= 'NOEXEC:' if @noexec %><%= 'NOPASSWD:' if @nopasswd.to_s == 'true' %><%= 'SETENV:' if @setenv.to_s == 'true' %><%= command %><% end -%>
+<% end -%>
+<% unless @defaults.empty? %>
+Defaults:<%= @sudoer %> <%= @defaults.join(',') %>
+<% end -%>

data/lib/chef/resource/swap_file.rb

@@ -0,0 +1,209 @@
+#
+# Copyright 2012-2018, Seth Vargo
+# 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 SwapFile < Chef::Resource
+      resource_name :swap_file
+      provides :swap_file
+
+      description "Use the swap_file resource to create or delete swap files on Linux systems, and optionally to manage the swappiness configuration for a host."
+      introduced "14.0"
+
+      property :path, String,
+               description: "The path to put the swap file on the system.",
+               name_property: true
+
+      property :size, Integer,
+               description: "The size (in MBs) for the swap file."
+
+      property :persist, [TrueClass, FalseClass],
+               description: "Persist the swapon.",
+               default: false
+
+      property :timeout, Integer,
+               description: "Timeout for dd/fallocate.",
+               default: 600
+
+      property :swappiness, Integer,
+               description: "The swappiness value to set on the system."
+
+      action :create do
+        description "Create a swapfile."
+
+        if swap_enabled?
+          Chef::Log.debug("#{new_resource} already created - nothing to do")
+        else
+          begin
+            Chef::Log.info "starting first create: #{node['virtualization']['system']}"
+            do_create(swap_creation_command)
+          rescue Mixlib::ShellOut::ShellCommandFailed => e
+            Chef::Log.warn("#{new_resource} Rescuing failed swapfile creation for #{new_resource.path}")
+            Chef::Log.debug("#{new_resource} Exception when creating swapfile #{new_resource.path}: #{e}")
+            do_create(dd_command)
+          end
+        end
+        if new_resource.swappiness
+          declare_resource(:sysctl, "vm.swappiness") do
+            value new_resource.swappiness
+          end
+        end
+      end
+
+      action :remove do
+        description "Remove a swapfile and disable swap."
+
+        swapoff if swap_enabled?
+        remove_swapfile if ::File.exist?(new_resource.path)
+      end
+
+      action_class do
+        def do_create(command)
+          create_swapfile(command)
+          set_permissions
+          mkswap
+          swapon
+          persist if persist?
+        end
+
+        def create_swapfile(command)
+          converge_by "create empty swapfile at #{new_resource.path}" do # ~FC054
+            shell_out!(command, timeout: new_resource.timeout)
+          end
+        end
+
+        def set_permissions
+          permissions = "600"
+          converge_by "set permissions on #{new_resource.path} to #{permissions}" do
+            shell_out!("chmod #{permissions} #{new_resource.path}")
+          end
+        end
+
+        def mkswap
+          converge_by "make #{new_resource.path} swappable" do
+            shell_out!("mkswap -f #{new_resource.path}")
+          end
+        end
+
+        def swapon
+          converge_by "enable swap for #{new_resource.path}" do
+            shell_out!("swapon #{new_resource.path}")
+          end
+        end
+
+        def swapoff
+          converge_by "turn off swap for #{new_resource.path}" do
+            shell_out!("swapoff #{new_resource.path}")
+          end
+        end
+
+        def remove_swapfile
+          converge_by "remove swap file #{new_resource.path}" do
+            ::FileUtils.rm(new_resource.path)
+          end
+        end
+
+        def swap_enabled?
+          enabled_swapfiles = shell_out("swapon --summary").stdout
+          # Regex for our resource path and only our resource path
+          # It will terminate on whitespace after the path it match
+          # /testswapfile would match
+          # /testswapfiledir/someotherfile will not
+          swapfile_regex = Regexp.new("^#{new_resource.path}[\\s\\t\\n\\f]+")
+          !swapfile_regex.match(enabled_swapfiles).nil?
+        end
+
+        def swap_creation_command
+          command = if compatible_filesystem? && compatible_kernel && !docker?
+                      fallocate_command
+                    else
+                      dd_command
+                    end
+          Chef::Log.debug("#{new_resource} swap creation command is '#{command}'")
+          command
+        end
+
+        def fallback_swap_creation_command
+          command = dd_command
+          Chef::Log.debug("#{new_resource} fallback swap creation command is '#{command}'")
+          command
+        end
+
+        # The block size (1MB)
+        def block_size
+          1_048_576
+        end
+
+        def fallocate_size
+          size = block_size * new_resource.size
+          Chef::Log.debug("#{new_resource} fallocate size is #{size}")
+          size
+        end
+
+        def fallocate_command
+          size = fallocate_size
+          command = "fallocate -l #{size} #{new_resource.path}"
+          Chef::Log.debug("#{new_resource} fallocate command is '#{command}'")
+          command
+        end
+
+        def dd_command
+          command = "dd if=/dev/zero of=#{new_resource.path} bs=#{block_size} count=#{new_resource.size}"
+          Chef::Log.debug("#{new_resource} dd command is '#{command}'")
+          command
+        end
+
+        def compatible_kernel
+          fallocate_location = shell_out("which fallocate").stdout
+          Chef::Log.debug("#{new_resource} fallocate location is '#{fallocate_location}'")
+          ::File.exist?(fallocate_location.chomp)
+        end
+
+        def compatible_filesystem?
+          compatible_filesystems = %w{xfs ext4}
+          parent_directory = ::File.dirname(new_resource.path)
+          # Get FS info, get second line as first is column headings
+          command = "df -PT #{parent_directory} | awk 'NR==2 {print $2}'"
+          result = shell_out(command).stdout
+          Chef::Log.debug("#{new_resource} filesystem listing is '#{result}'")
+          compatible_filesystems.any? { |fs| result.include? fs }
+        end
+
+        def persist?
+          !!new_resource.persist
+        end
+
+        def persist
+          fstab = "/etc/fstab"
+          contents = ::File.readlines(fstab)
+          addition = "#{new_resource.path} swap swap defaults 0 0"
+
+          if contents.any? { |line| line.strip == addition }
+            Chef::Log.debug("#{new_resource} already added to /etc/fstab - skipping")
+          else
+            Chef::Log.info("#{new_resource} adding entry to #{fstab} for #{new_resource.path}")
+
+            contents << "#{addition}\n"
+            ::File.open(fstab, "w") { |f| f.write(contents.join("")) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/sysctl.rb

@@ -0,0 +1,111 @@
+#
+# Copyright:: 2018, Webb Agile Solutions Ltd.
+# Copyright:: 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 Sysctl < Chef::Resource
+      resource_name :sysctl
+      provides :sysctl
+      provides :sysctl_param
+
+      description "Use the sysctl resource to set kernel parameters using the sysctl"\
+                  " command line tool and configuration files in the system's sysctl.d directory."\
+                  "Configuration files managed by this resource are named 99-chef-KEYNAME.conf. If"\
+                  " an existing value was already set for the value it will be backed up to the node"\
+                  " and restored if the :remove action is used later."
+
+      introduced "14.0"
+
+      property :key, String,
+               description: "The kernel parameter key in dotted format.",
+               name_property: true
+
+      property :ignore_error, [TrueClass, FalseClass],
+               description: "Ignore any errors when setting the value on the command line.",
+               default: false
+
+      property :value, [Array, String, Integer, Float],
+               description: "The value to set.",
+               coerce: proc { |v| coerce_value(v) },
+               required: true
+
+      property :conf_dir, String,
+               description: "The configuration directory to write the config to.",
+               default: "/etc/sysctl.d"
+
+      def after_created
+        raise "The systctl resource requires Linux as it needs sysctl and the systctl.d directory functionality." unless node["os"] == "linux"
+        raise "The systctl resource does not support SLES releases less than 12 as it requires a systctl.d directory" if platform_family?("suse") && node["platform_version"].to_i < 12
+      end
+
+      def coerce_value(v)
+        case v
+        when Array
+          v.join(" ")
+        else
+          v.to_s
+        end
+      end
+
+      def get_sysctl_value(key)
+        o = shell_out("sysctl -n -e #{key}")
+        raise "Unknown sysctl key #{key}!" if o.error?
+        o.stdout.to_s.tr("\t", " ").strip
+      end
+
+      load_current_value do
+        value get_sysctl_value(key)
+      end
+
+      action :apply do
+        converge_if_changed do
+          # set it temporarily
+          set_sysctl_param(new_resource.key, new_resource.value)
+
+          directory new_resource.conf_dir
+
+          file "#{new_resource.conf_dir}/99-chef-#{new_resource.key}.conf" do
+            content "#{new_resource.key} = #{new_resource.value}"
+          end
+
+          execute "sysctl -p"
+        end
+      end
+
+      action :remove do
+        # only converge the resource if the file actually exists to delete
+        if ::File.exist?("#{new_resource.conf_dir}/99-chef-#{new_resource.key}.conf")
+          converge_by "removing systctl config at #{new_resource.conf_dir}/99-chef-#{new_resource.key}.conf" do
+            file "#{new_resource.conf_dir}/99-chef-#{new_resource.key}.conf" do
+              action :delete
+            end
+
+            execute "sysctl -p"
+          end
+        end
+      end
+
+      action_class do
+        def set_sysctl_param(key, value)
+          shell_out!("sysctl #{'-e ' if new_resource.ignore_error}-w \"#{key}=#{value}\"")
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/systemd_unit.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Nathan Williams (<nath.e.will@gmail.com>)
-# Copyright:: Copyright 2016, Nathan Williams
+# Copyright:: Copyright 2016-2018, Nathan Williams
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,15 +21,16 @@ require "iniparse"
 
 class Chef
   class Resource
-    # Use the systemd_unit resource to create, manage, and run systemd units.
-    #
-    # @since 12.11
     class SystemdUnit < Chef::Resource
       resource_name :systemd_unit
 
+      description "Use the systemd_unit resource to create, manage, and run systemd units."
+      introduced "12.11"
+
       default_action :nothing
       allowed_actions :create, :delete,
-                      :enable, :disable,
+                      :preset, :revert,
+                      :enable, :disable, :reenable,
                       :mask, :unmask,
                       :start, :stop,
                       :restart, :reload,

data/lib/chef/resource/template.rb

@@ -19,7 +19,6 @@
 #
 
 require "chef/resource/file"
-require "chef/provider/template"
 require "chef/mixin/securable"
 
 class Chef
@@ -34,6 +33,9 @@ class Chef
     # chef-client. This resource includes actions and properties from the file resource. Template files managed by the
     # template resource follow the same file specificity rules as the remote_file and file resources.
     class Template < Chef::Resource::File
+      resource_name :template
+      provides :template
+
       include Chef::Mixin::Securable
 
       attr_reader :inline_helper_blocks
@@ -42,9 +44,6 @@ class Chef
       def initialize(name, run_context = nil)
         super
         @source = "#{::File.basename(name)}.erb"
-        @cookbook = nil
-        @local = false
-        @variables = Hash.new
         @inline_helper_blocks = {}
         @inline_helper_modules = []
         @helper_modules = []
@@ -58,29 +57,9 @@ class Chef
         )
       end
 
-      def variables(args = nil)
-        set_or_return(
-          :variables,
-          args,
-          :kind_of => [ Hash ]
-        )
-      end
-
-      def cookbook(args = nil)
-        set_or_return(
-          :cookbook,
-          args,
-          :kind_of => [ String ]
-        )
-      end
-
-      def local(args = nil)
-        set_or_return(
-          :local,
-          args,
-          :kind_of => [ TrueClass, FalseClass ]
-        )
-      end
+      property :variables, Hash, default: lazy { Hash.new }
+      property :cookbook, String
+      property :local, [ TrueClass, FalseClass ], default: false
 
       # Declares a helper method to be defined in the template context when
       # rendering.

data/lib/chef/resource/windows_ad_join.rb

@@ -0,0 +1,92 @@
+#
+# Author:: John Snow (<jsnow@chef.io>)
+# Copyright:: 2016-2018, John Snow
+#
+# 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"
+require "chef/mixin/powershell_out"
+
+class Chef
+  class Resource
+    class WindowsAdJoin < Chef::Resource
+      resource_name :windows_ad_join
+      provides :windows_ad_join
+
+      include Chef::Mixin::PowershellOut
+
+      description "Use the windows_ad_join resource to join a Windows Active Directory domain."
+      introduced "14.0"
+
+      property :domain_name, String,
+               description: "The FQDN of the AD domain to join.",
+               validation_message: "The 'domain_name' property must be a FQDN.",
+               regex: /.\../, # anything.anything
+               name_property: true
+
+      property :domain_user, String,
+               description: "The domain user to use to join the host to the domain.",
+               required: true
+
+      property :domain_password, String,
+               description: "The password for the domain user.",
+               required: true
+
+      property :ou_path, String,
+               description: "The path to the OU where you would like to place the host."
+
+      property :reboot, Symbol,
+               equal_to: [:immediate, :delayed, :never],
+               validation_message: "The reboot property accepts :immediate (reboot as soon as the resource completes), :delayed (reboot once the Chef run completes), and :never (Don't reboot)",
+               description: "Controls the system reboot behavior post domain joining. Reboot immediately, after the Chef run completes, or never. Note that a reboot is necessary for changes to take effect.",
+               default: :immediate
+
+      # define this again so we can default it to true. Otherwise failures print the password
+      property :sensitive, [TrueClass, FalseClass],
+               default: true
+
+      action :join do
+        description "Join the Active Directory domain."
+
+        unless on_domain?
+          cmd = "$pswd = ConvertTo-SecureString \'#{new_resource.domain_password}\' -AsPlainText -Force;"
+          cmd << "$credential = New-Object System.Management.Automation.PSCredential (\"#{new_resource.domain_user}\",$pswd);"
+          cmd << "Add-Computer -DomainName #{new_resource.domain_name} -Credential $credential"
+          cmd << " -OUPath \"#{new_resource.ou_path}\"" if new_resource.ou_path
+          cmd << " -Force"
+
+          converge_by("join Active Directory domain #{new_resource.domain_name}") do
+            ps_run = powershell_out(cmd)
+            raise "Failed to join the domain #{new_resource.domain_name}: #{ps_run.stderr}}" if ps_run.error?
+
+            unless new_resource.reboot == :never
+              declare_resource(:reboot, "Reboot to join domain #{new_resource.domain_name}") do
+                action new_resource.reboot
+                reason "Reboot to join domain #{new_resource.domain_name}"
+              end
+            end
+          end
+        end
+      end
+
+      action_class do
+        def on_domain?
+          node_domain = powershell_out!("(Get-WmiObject Win32_ComputerSystem).Domain")
+          raise "Failed to check if the system is joined to the domain #{new_resource.domain_name}: #{node_domain.stderr}}" if node_domain.error?
+          node_domain.stdout.downcase.strip == new_resource.domain_name.downcase
+        end
+      end
+    end
+  end
+end