chef 18.10.17 → 19.2.12

data/lib/chef/resource/apt_repository.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Thom May (<thom@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,7 +17,6 @@
 #
 
 require_relative "../resource"
-require_relative "../http/simple"
 require "tmpdir" unless defined?(Dir.mktmpdir)
 module Addressable
   autoload :URI, "addressable/uri"
@@ -27,7 +26,8 @@ class Chef
   class Resource
     class AptRepository < Chef::Resource
 
-      provides(:apt_repository) { true }
+      provides(:apt_repository, target_mode: true) { true }
+      target_mode support: :full
 
       description "Use the **apt_repository** resource to specify additional APT repositories. Adding a new repository will update the APT package cache immediately."
       introduced "12.9"
@@ -99,7 +99,6 @@ class Chef
         ```
 
         **Add repository that needs custom options**:
-
         ```ruby
         apt_repository 'corretto' do
           uri          'https://apt.corretto.aws'
@@ -127,6 +126,7 @@ class Chef
       # to allow that so don't refactor this however tempting it is
       property :repo_name, String,
         regex: [%r{^[^/]+$}],
+        coerce: proc { |x| x.gsub(" ", "-") },
         description: "An optional property to set the repository name if it differs from the resource block's name. The value of this setting must not contain spaces.",
         validation_message: "repo_name property cannot contain a forward slash '/'",
         introduced: "14.1", name_property: true
@@ -177,7 +177,7 @@ class Chef
         default: true, desired_state: false
 
       property :options, [String, Array],
-        description: "Additional options to set for the repository.",
+        description: "Additional options to set for the repository",
         default: [], coerce: proc { |x| Array(x) }
 
       default_action :add
@@ -330,8 +330,8 @@ class Chef
           keyfile_tmp_path = ::File.join(Chef::Config[:file_cache_path], key_name)
           keyfile_path = keyring_path
           gpg_keyring_prefix = apt_version > 2 ? "gnupg-ring:" : ""
-          tmp_dir = Dir.mktmpdir(".gpg")
-          at_exit { FileUtils.remove_entry(tmp_dir) }
+          tmp_dir = TargetIO::Dir.mktmpdir(".gpg")
+          at_exit { TargetIO::FileUtils.remove_entry(tmp_dir) }
 
           if new_resource.signed_by
             directory "/etc/apt/keyrings" do
@@ -456,7 +456,7 @@ class Chef
         # @return [void]
         def install_ppa_key(owner, repo)
           url = "https://launchpad.net/api/1.0/~#{owner}/+archive/#{repo}"
-          key_id = Chef::HTTP::Simple.new(url, {}).get("signing_key_fingerprint").delete('"')
+          key_id = TargetIO::HTTP.new(url).get("signing_key_fingerprint").delete('"')
           install_key_from_keyserver(key_id, "keyserver.ubuntu.com")
         rescue Net::HTTPClientException => e
           raise "Could not access Launchpad ppa API: #{e.message}"
@@ -532,7 +532,7 @@ class Chef
         # @return [void]
         def cleanup_legacy_file!
           legacy_path = "/etc/apt/sources.list.d/#{new_resource.name}.list"
-          if new_resource.name != new_resource.repo_name && ::File.exist?(legacy_path)
+          if new_resource.name != new_resource.repo_name && ::TargetIO::File.exist?(legacy_path)
             converge_by "Cleaning up legacy #{legacy_path} repo file" do
               file legacy_path do
                 action :delete
@@ -574,7 +574,12 @@ class Chef
 
         signed_by = new_resource.signed_by
         if signed_by == true
-          signed_by = keyring_path
+          if new_resource.key || ::File.exist?(keyring_path)
+            signed_by = keyring_path
+          else
+            # There isn't a key to use, so don't set the signed-by attribute
+            signed_by = false
+          end
         end
 
         repo = build_repo(
@@ -604,7 +609,7 @@ class Chef
         return unless debian?
 
         cleanup_legacy_file!
-        if ::File.exist?("/etc/apt/sources.list.d/#{new_resource.repo_name}.list")
+        if ::TargetIO::File.exist?("/etc/apt/sources.list.d/#{new_resource.repo_name}.list")
           converge_by "Removing #{new_resource.repo_name} repository from /etc/apt/sources.list.d/" do
             apt_update new_resource.name do
               ignore_failure true

data/lib/chef/resource/apt_update.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Thom May (<thom@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -23,7 +23,8 @@ class Chef
   class Resource
     class AptUpdate < Chef::Resource
 
-      provides(:apt_update) { true }
+      provides(:apt_update, target_mode: true) { true }
+      target_mode support: :full
 
       description "Use the **apt_update** resource to manage APT repository updates on Debian and Ubuntu platforms."
       introduced "12.7"
@@ -62,8 +63,8 @@ class Chef
         #
         # @return [Boolean]
         def apt_up_to_date?
-          ::File.exist?("#{STAMP_DIR}/update-success-stamp") &&
-            ::File.mtime("#{STAMP_DIR}/update-success-stamp") > Time.now - new_resource.frequency
+          ::TargetIO::File.exist?("#{STAMP_DIR}/update-success-stamp") &&
+            ::TargetIO::File.mtime("#{STAMP_DIR}/update-success-stamp") > Time.now - new_resource.frequency
         end
 
         def do_update

data/lib/chef/resource/archive_file.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # Author:: Jamie Winsor (<jamie@vialstudios.com>)
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
@@ -70,8 +70,7 @@ begin
   # ffi-libarchive must be eager loaded see: https://github.com/chef/chef/issues/12228
   require "ffi-libarchive" unless defined?(Archive::Reader)
 rescue LoadError => e
-  STDERR.puts "ffi-libarchive could not be loaded: #{e.message}"
-  STDERR.puts "libarchive is probably not installed on system, archive_file will not be available"
+  STDERR.puts "ffi-libarchive could not be loaded. libarchive is probably not installed on system, archive_file will not be available"
 end
 
 class Chef
@@ -172,9 +171,10 @@ class Chef
 
         if new_resource.owner || new_resource.group
           converge_by("set owner of files extracted in #{new_resource.destination} to #{new_resource.owner}:#{new_resource.group}") do
-            archive = Archive::Reader.open_filename(new_resource.path, nil, strip_components: new_resource.strip_components)
-            archive.each_entry do |e|
-              FileUtils.chown(new_resource.owner, new_resource.group, "#{new_resource.destination}/#{e.pathname}")
+            Archive::Reader.open_filename(new_resource.path, nil, strip_components: new_resource.strip_components) do |archive|
+              archive.each_entry do |e|
+                FileUtils.chown(new_resource.owner, new_resource.group, "#{new_resource.destination}/#{e.pathname}")
+              end
             end
           end
         end
@@ -211,16 +211,17 @@ class Chef
         # @return [Boolean]
         def archive_differs_from_disk?(src, dest)
           modified = false
-          archive = Archive::Reader.open_filename(src, nil, strip_components: new_resource.strip_components)
-          Chef::Log.trace("Beginning the comparison of file mtime between contents of #{src} and #{dest}")
-          archive.each_entry do |e|
-            pathname = ::File.expand_path(e.pathname, dest)
-            if ::File.exist?(pathname)
-              Chef::Log.trace("#{pathname} mtime is #{::File.mtime(pathname)} and archive is #{e.mtime}")
-              modified = true unless ::File.mtime(pathname) == e.mtime
-            else
-              Chef::Log.trace("#{pathname} doesn't exist on disk, but exists in the archive")
-              modified = true
+          Archive::Reader.open_filename(src, nil, strip_components: new_resource.strip_components) do |archive|
+            Chef::Log.trace("Beginning the comparison of file mtime between contents of #{src} and #{dest}")
+            archive.each_entry do |e|
+              pathname = ::File.expand_path(e.pathname, dest)
+              if ::File.exist?(pathname)
+                Chef::Log.trace("#{pathname} mtime is #{::File.mtime(pathname)} and archive is #{e.mtime}")
+                modified = true unless ::File.mtime(pathname) == e.mtime
+              else
+                Chef::Log.trace("#{pathname} doesn't exist on disk, but exists in the archive")
+                modified = true
+              end
             end
           end
           modified
@@ -238,12 +239,11 @@ class Chef
             flags = [options].flatten.map { |option| extract_option_map[option] }.compact.reduce(:|)
 
             Dir.chdir(dest) do
-              archive = Archive::Reader.open_filename(src, nil, strip_components: new_resource.strip_components)
-
-              archive.each_entry do |e|
-                archive.extract(e, flags.to_i)
+              Archive::Reader.open_filename(src, nil, strip_components: new_resource.strip_components) do |archive|
+                archive.each_entry do |e|
+                  archive.extract(e, flags.to_i)
+                end
               end
-              archive.close
             end
           end
         end

data/lib/chef/resource/bash.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,139 +22,140 @@ class Chef
   class Resource
     class Bash < Chef::Resource::Script
 
-      provides :bash
+      provides :bash, target_mode: true
+      target_mode support: :full
 
       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
-        ```
-
-        **Using escape characters in a string of code**
-
-        In the following example, the `find` command uses an escape character (`\`). Use a second escape character (`\\`) to preserve the escape character in the code string:
-
-        ```ruby
-        bash 'delete some archives ' do
-          code <<-EOH
-            find ./ -name "*.tar.Z" -mtime +180 -exec rm -f {} \\;
-          EOH
-          ignore_failure true
-        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
-        ```
+      **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
+      ```
+
+      **Using escape characters in a string of code**
+
+      In the following example, the `find` command uses an escape character (`\`). Use a second escape character (`\\`) to preserve the escape character in the code string:
+
+      ```ruby
+      bash 'delete some archives ' do
+        code <<-EOH
+          find ./ -name "*.tar.Z" -mtime +180 -exec rm -f {} \\;
+        EOH
+        ignore_failure true
+      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)

data/lib/chef/resource/batch.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Adam Edwards (<adamed@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/chef/resource/bff_package.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Deepali Jagtap (<deepali.jagtap@clogeny.com>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -23,30 +23,31 @@ class Chef
   class Resource
     class BffPackage < Chef::Resource::Package
 
-      provides :bff_package
+      provides :bff_package, target_mode: true
+      target_mode support: :full
 
       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.
+      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**
+      **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
-        ```
+      ```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**
+      **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
-        ```
+      ```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,