chef 16.1.16 → 16.18.30

data/lib/chef/resource/apt_repository.rb

@@ -19,7 +19,9 @@
 require_relative "../resource"
 require_relative "../http/simple"
 require "tmpdir" unless defined?(Dir.mktmpdir)
-require "addressable" unless defined?(Addressable)
+module Addressable
+  autoload :URI, "addressable/uri"
+end
 
 class Chef
   class Resource
@@ -60,15 +62,14 @@ class Chef
         end
         ```
 
-        **Add the JuJu PPA, grab the key from the keyserver, and add source repo**:
+        **Add the JuJu PPA, grab the key from the Ubuntu keyserver, and add source repo**:
 
         ```ruby
         apt_repository 'juju' do
-          uri 'http://ppa.launchpad.net/juju/stable/ubuntu'
+          uri 'ppa:juju/stable'
           components ['main']
           distribution 'xenial'
           key 'C8068B11'
-          keyserver 'keyserver.ubuntu.com'
           action :add
           deb_src true
         end
@@ -168,7 +169,7 @@ class Chef
         # is the provided ID a key ID from a keyserver. Looks at length and HEX only values
         # @param [String] id the key value passed by the user that *may* be an ID
         def is_key_id?(id)
-          id = id[2..-1] if id.start_with?("0x")
+          id = id[2..] if id.start_with?("0x")
           id =~ /^\h+$/ && [8, 16, 40].include?(id.length)
         end
 
@@ -192,16 +193,7 @@ class Chef
         #
         # @return [Boolean] is the key valid or not
         def key_is_valid?(key)
-          valid = true
-
-          so = shell_out("apt-key", "list")
-          so.stdout.split(/\n/).map do |t|
-            if t =~ %r{^\/#{key}.*\[expired: .*\]$}
-              logger.debug "Found expired key: #{t}"
-              valid = false
-              break
-            end
-          end
+          valid = shell_out("apt-key", "list").stdout.each_line.none?(%r{^\/#{key}.*\[expired: .*\]$})
 
           logger.debug "key #{key} #{valid ? "is valid" : "is not valid"}"
           valid

data/lib/chef/resource/archive_file.rb

@@ -19,6 +19,13 @@
 #
 
 require_relative "../resource"
+require "fileutils" unless defined?(FileUtils)
+begin
+  # ffi-libarchive must be eager loaded see: https://github.com/chef/chef/issues/12228
+  require "ffi-libarchive" unless defined?(Archive::Reader)
+rescue LoadError
+  STDERR.puts "ffi-libarchive could not be loaded, libarchive is probably not installed on system, archive_file will not be available"
+end
 
 class Chef
   class Resource
@@ -39,6 +46,18 @@ class Chef
           destination '/srv/files'
         end
         ```
+
+        **Set specific permissions on the extracted files**:
+
+        ```ruby
+        archive_file 'Precompiled.zip' do
+          owner 'tsmith'
+          group 'staff'
+          mode '700'
+          path '/tmp/Precompiled.zip'
+          destination '/srv/files'
+        end
+        ```
       DOC
 
       property :path, String,
@@ -53,7 +72,7 @@ class Chef
         description: "The group of the extracted files."
 
       property :mode, [String, Integer],
-        description: "The mode of the extracted files.",
+        description: "The mode of the extracted files. Integer values are deprecated as octal values (ex. 0755) would not be interpreted correctly.",
         default: "755"
 
       property :destination, String,
@@ -72,8 +91,6 @@ class Chef
       alias_method :extract_options, :options
       alias_method :extract_to, :destination
 
-      require "fileutils" unless defined?(FileUtils)
-
       action :extract do
         description "Extract and archive file."
 
@@ -85,7 +102,8 @@ class Chef
           Chef::Log.trace("File or directory does not exist at destination path: #{new_resource.destination}")
 
           converge_by("create directory #{new_resource.destination}") do
-            FileUtils.mkdir_p(new_resource.destination, mode: new_resource.mode.to_i)
+            # @todo when we remove the ability for mode to be an int we can remove the .to_s below
+            FileUtils.mkdir_p(new_resource.destination, mode: new_resource.mode.to_s.to_i(8))
           end
 
           extract(new_resource.path, new_resource.destination, Array(new_resource.options))
@@ -113,6 +131,12 @@ class Chef
       end
 
       action_class do
+        def define_resource_requirements
+          if new_resource.mode.is_a?(Integer)
+            Chef.deprecated(:archive_file_integer_file_mode, "The mode property should be passed to archive_file resources as a String and not an Integer to ensure the value is properly interpreted.")
+          end
+        end
+
         # This can't be a constant since we might not have required 'ffi-libarchive' yet.
         def extract_option_map
           {
@@ -136,8 +160,6 @@ class Chef
         #
         # @return [Boolean]
         def archive_differs_from_disk?(src, dest)
-          require "ffi-libarchive"
-
           modified = false
           Dir.chdir(dest) do
             archive = Archive::Reader.open_filename(src)
@@ -164,8 +186,6 @@ class Chef
         #
         # @return [void]
         def extract(src, dest, options = [])
-          require "ffi-libarchive"
-
           converge_by("extract #{src} to #{dest}") do
             flags = [options].flatten.map { |option| extract_option_map[option] }.compact.reduce(:|)
 

data/lib/chef/resource/bash.rb

@@ -17,7 +17,6 @@
 #
 
 require_relative "script"
-require_relative "../provider/script"
 
 class Chef
   class Resource
@@ -26,7 +25,125 @@ class Chef
 
       provides :bash
 
-      description "Use the **bash** resource to execute scripts using the Bash 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."
+      description "Use the **bash** resource to execute scripts using the Bash 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."
+      examples <<~'DOC'
+      **Compile an application**
+
+      ```ruby
+      bash 'install_something' do
+        user 'root'
+        cwd '/tmp'
+        code <<-EOH
+          wget http://www.example.com/tarball.tar.gz
+          tar -zxf tarball.tar.gz
+          cd tarball
+          ./configure
+          make
+          make install
+        EOH
+      end
+      ```
+
+      **Install a file from a remote location**
+
+      The following is an example of how to install the foo123 module for Nginx. This module adds shell-style functionality to an Nginx configuration file and does the following:
+
+        - Declares three variables
+        - Gets the Nginx file from a remote location
+        - Installs the file using Bash to the path specified by the `src_filepath` variable
+
+      ```ruby
+      src_filename = "foo123-nginx-module-v#{node['nginx']['foo123']['version']}.tar.gz"
+      src_filepath = "#{Chef::Config['file_cache_path']}/#{src_filename}"
+      extract_path = "#{Chef::Config['file_cache_path']}/nginx_foo123_module/#{node['nginx']['foo123']['checksum']}"
+
+      remote_file 'src_filepath' do
+        source node['nginx']['foo123']['url']
+        checksum node['nginx']['foo123']['checksum']
+        owner 'root'
+        group 'root'
+        mode '0755'
+      end
+
+      bash 'extract_module' do
+        cwd ::File.dirname(src_filepath)
+        code <<-EOH
+          mkdir -p #{extract_path}
+          tar xzf #{src_filename} -C #{extract_path}
+          mv #{extract_path}/*/* #{extract_path}/
+        EOH
+        not_if { ::File.exist?(extract_path) }
+      end
+      ```
+
+      **Install an application from git**
+
+      ```ruby
+      git "#{Chef::Config[:file_cache_path]}/ruby-build" do
+        repository 'git://github.com/rbenv/ruby-build.git'
+        revision 'master'
+        action :sync
+      end
+
+      bash 'install_ruby_build' do
+        cwd "#{Chef::Config[:file_cache_path]}/ruby-build"
+        user 'rbenv'
+        group 'rbenv'
+        code <<-EOH
+          ./install.sh
+        EOH
+        environment 'PREFIX' => '/usr/local'
+      end
+      ```
+
+      **Using Attributes in Bash Code**
+
+      The following recipe shows how an attributes file can be used to store certain settings. An attributes file is located in the `attributes/`` directory in the same cookbook as the recipe which calls the attributes file. In this example, the attributes file specifies certain settings for Python that are then used across all nodes against which this recipe will run.
+
+      Python packages have versions, installation directories, URLs, and checksum files. An attributes file that exists to support this type of recipe would include settings like the following:
+
+      ```ruby
+      default['python']['version'] = '2.7.1'
+
+      if python['install_method'] == 'package'
+        default['python']['prefix_dir'] = '/usr'
+      else
+        default['python']['prefix_dir'] = '/usr/local'
+      end
+
+      default['python']['url'] = 'http://www.python.org/ftp/python'
+      default['python']['checksum'] = '80e387...85fd61'
+      ```
+
+      and then the methods in the recipe may refer to these values. A recipe that is used to install Python will need to do the following:
+
+        - Identify each package to be installed (implied in this example, not shown)
+        - Define variables for the package `version` and the `install_path`
+        - Get the package from a remote location, but only if the package does not already exist on the target system
+        - Use the **bash** resource to install the package on the node, but only when the package is not already installed
+
+      ```ruby
+      version = node['python']['version']
+      install_path = "#{node['python']['prefix_dir']}/lib/python#{version.split(/(^\d+\.\d+)/)[1]}"
+
+      remote_file "#{Chef::Config[:file_cache_path]}/Python-#{version}.tar.bz2" do
+        source "#{node['python']['url']}/#{version}/Python-#{version}.tar.bz2"
+        checksum node['python']['checksum']
+        mode '0755'
+        not_if { ::File.exist?(install_path) }
+      end
+
+      bash 'build-and-install-python' do
+        cwd Chef::Config[:file_cache_path]
+        code <<-EOF
+          tar -jxvf Python-#{version}.tar.bz2
+          (cd Python-#{version} && ./configure #{configure_options})
+          (cd Python-#{version} && make && make install)
+        EOF
+        not_if { ::File.exist?(install_path) }
+      end
+      ```
+      DOC
 
       def initialize(name, run_context = nil)
         super

data/lib/chef/resource/batch.rb

@@ -25,10 +25,12 @@ class Chef
 
       provides :batch
 
-      description "Use the **batch** resource to execute a batch script using the cmd.exe interpreter on Windows. The batch resource creates and executes a temporary file (similar to how the script resource behaves), rather than running the command inline. 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."
+      description "Use the **batch** resource to execute a batch script using the cmd.exe interpreter on Windows. The batch resource creates and executes a temporary file (similar to how the script resource behaves), rather than running the command inline. 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(name, run_context, nil, "cmd.exe")
+      def initialize(*args)
+        super
+        @interpreter = "cmd.exe"
+        @default_guard_interpreter = resource_name
       end
 
     end

data/lib/chef/resource/bff_package.rb

@@ -17,6 +17,7 @@
 #
 
 require_relative "package"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 
 class Chef
   class Resource
@@ -27,6 +28,27 @@ class Chef
 
       description "Use the **bff_package** resource to manage packages for the AIX platform using the installp utility. When a package is installed from a local file, it must be added to the node using the **remote_file** or **cookbook_file** resources."
       introduced "12.0"
+      examples <<~DOC
+      The **bff_package** resource is the default package provider on the AIX platform. The base **package** resource may be used, and then when the platform is AIX, #{ChefUtils::Dist::Infra::PRODUCT} will identify the correct package provider. The following examples show how to install part of the IBM XL C/C++ compiler.
+
+      **Installing using the base package resource**
+
+      ```ruby
+      package 'xlccmp.13.1.0' do
+        source '/var/tmp/IBM_XL_C_13.1.0/usr/sys/inst.images/xlccmp.13.1.0'
+        action :install
+      end
+      ```
+
+      **Installing using the bff_package resource**
+
+      ```ruby
+      bff_package 'xlccmp.13.1.0' do
+        source '/var/tmp/IBM_XL_C_13.1.0/usr/sys/inst.images/xlccmp.13.1.0'
+        action :install
+      end
+      ```
+      DOC
 
       property :package_name, String,
         description: "An optional property to set the package name if it differs from the resource block's name.",

data/lib/chef/resource/breakpoint.rb

@@ -17,7 +17,7 @@
 #
 
 require_relative "../resource"
-require_relative "../dist"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 
 class Chef
   class Resource
@@ -26,8 +26,65 @@ class Chef
 
       provides :breakpoint, target_mode: true
 
-      description "Use the **breakpoint** resource to add breakpoints to recipes. Run the #{Chef::Dist::SHELL} in #{Chef::Dist::PRODUCT} mode, and then use those breakpoints to debug recipes. Breakpoints are ignored by the #{Chef::Dist::CLIENT} during an actual #{Chef::Dist::CLIENT} run. That said, breakpoints are typically used to debug recipes only when running them in a non-production environment, after which they are removed from those recipes before the parent cookbook is uploaded to the Chef server."
+      description "Use the **breakpoint** resource to add breakpoints to recipes. Run the #{ChefUtils::Dist::Infra::SHELL} in #{ChefUtils::Dist::Infra::PRODUCT} mode, and then use those breakpoints to debug recipes. Breakpoints are ignored by the #{ChefUtils::Dist::Infra::CLIENT} during an actual #{ChefUtils::Dist::Infra::CLIENT} run. That said, breakpoints are typically used to debug recipes only when running them in a non-production environment, after which they are removed from those recipes before the parent cookbook is uploaded to the Chef server."
       introduced "12.0"
+      examples <<~DOC
+      **A recipe without a breakpoint**
+
+      ```ruby
+      yum_key node['yum']['elrepo']['key'] do
+        url  node['yum']['elrepo']['key_url']
+        action :add
+      end
+
+      yum_repository 'elrepo' do
+        description 'ELRepo.org Community Enterprise Linux Extras Repository'
+        key node['yum']['elrepo']['key']
+        mirrorlist node['yum']['elrepo']['url']
+        includepkgs node['yum']['elrepo']['includepkgs']
+        exclude node['yum']['elrepo']['exclude']
+        action :create
+      end
+      ```
+
+      **The same recipe with breakpoints**
+
+      In the following example, the name of each breakpoint is an arbitrary string.
+
+      ```ruby
+      breakpoint "before yum_key node['yum']['repo_name']['key']" do
+        action :break
+      end
+
+      yum_key node['yum']['repo_name']['key'] do
+        url  node['yum']['repo_name']['key_url']
+        action :add
+      end
+
+      breakpoint "after yum_key node['yum']['repo_name']['key']" do
+        action :break
+      end
+
+      breakpoint "before yum_repository 'repo_name'" do
+        action :break
+      end
+
+      yum_repository 'repo_name' do
+        description 'description'
+        key node['yum']['repo_name']['key']
+        mirrorlist node['yum']['repo_name']['url']
+        includepkgs node['yum']['repo_name']['includepkgs']
+        exclude node['yum']['repo_name']['exclude']
+        action :create
+      end
+
+      breakpoint "after yum_repository 'repo_name'" do
+        action :break
+      end
+      ```
+
+      In the previous examples, the names are used to indicate if the breakpoint is before or after a resource and also to specify which resource it is before or after.
+      DOC
 
       default_action :break
 

data/lib/chef/resource/build_essential.rb

@@ -15,7 +15,6 @@
 #
 
 require_relative "../resource"
-require "plist"
 
 class Chef
   class Resource
@@ -130,8 +129,8 @@ class Chef
           pkg_label = xcode_cli_package_label
 
           # With upgrade action we should install if it's not installed or if there's an available update.
-          # `xcode_cli_package_label` will be nil if there's no update.
-          install_xcode_cli_tools(pkg_label) if !xcode_cli_installed? || xcode_cli_package_label
+          # `pkg_label` will be nil if there's no update.
+          install_xcode_cli_tools(pkg_label) if !xcode_cli_installed? || pkg_label
         else
           Chef::Log.info "The build_essential resource :upgrade action is only supported on macOS systems. Skipping..."
         end
@@ -146,8 +145,8 @@ class Chef
         def install_xcode_cli_tools(label)
           # This script was graciously borrowed and modified from Tim Sutton's
           # osx-vm-templates at https://github.com/timsutton/osx-vm-templates/blob/b001475df54a9808d3d56d06e71b8fa3001fff42/scripts/xcode-cli-tools.sh
-          execute "install Xcode Command Line tools" do
-            command <<-EOH
+          bash "install Xcode Command Line Tools" do
+            code <<-EOH
               # create the placeholder file that's checked by CLI updates' .dist code
               # in Apple's SUS catalog
               touch /tmp/.com.apple.dt.CommandLineTools.installondemand.in-progress
@@ -160,14 +159,12 @@ class Chef
         end
 
         #
-        # Determine if the XCode Command Line Tools are installed by parsing the install history plist.
-        # We parse the plist data install of running pkgutil because we found that pkgutils doesn't always contain all the packages
+        # Determine if the XCode Command Line Tools are installed by checking
+        # for success from `xcode-select -p`
         #
         # @return [true, false]
         def xcode_cli_installed?
-          packages = ::Plist.parse_xml(::File.open("/Library/Receipts/InstallHistory.plist", "r"))
-          packages.select! { |package| package["displayName"].match? "Command Line Tools" }
-          !packages.empty?
+          !shell_out("xcode-select", "-p").error?
         end
 
         #

data/lib/chef/resource/cab_package.rb

@@ -29,6 +29,35 @@ class Chef
 
       description "Use the **cab_package** resource to install or remove Microsoft Windows cabinet (.cab) packages."
       introduced "12.15"
+      examples <<~'DOC'
+      **Using local path in source**
+
+      ```ruby
+      cab_package 'Install .NET 3.5 sp1 via KB958488' do
+        source 'C:\Users\xyz\AppData\Local\Temp\Windows6.1-KB958488-x64.cab'
+        action :install
+      end
+
+      cab_package 'Remove .NET 3.5 sp1 via KB958488' do
+        source 'C:\Users\xyz\AppData\Local\Temp\Windows6.1-KB958488-x64.cab'
+        action :remove
+      end
+      ```
+
+      **Using URL in source**
+
+      ```ruby
+      cab_package 'Install .NET 3.5 sp1 via KB958488' do
+        source 'https://s3.amazonaws.com/my_bucket/Windows6.1-KB958488-x64.cab'
+        action :install
+      end
+
+      cab_package 'Remove .NET 3.5 sp1 via KB958488' do
+        source 'https://s3.amazonaws.com/my_bucket/Temp\Windows6.1-KB958488-x64.cab'
+        action :remove
+      end
+      ```
+      DOC
 
       allowed_actions :install, :remove