chef 18.10.17 → 19.1.164

data/lib/chef/resource/apt_package.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");
@@ -24,49 +24,54 @@ class Chef
 
       provides :apt_package, target_mode: true
       provides :package, platform_family: "debian", target_mode: true
+      target_mode support: :full,
+        introduced: "15.1",
+        updated: "19.0",
+        description: "Does not support the `response_file` property in Target Mode."
+
       examples <<~DOC
-        **Install a package using package manager**:
+      **Install a package using package manager**:
 
-        ```ruby
-        apt_package 'name of package' do
-          action :install
-        end
-        ```
+      ```ruby
+      apt_package 'name of package' do
+        action :install
+      end
+      ```
 
-        **Install a package without specifying the default action**:
+      **Install a package without specifying the default action**:
 
-        ```ruby
-        apt_package 'name of package'
-        ```
+      ```ruby
+      apt_package 'name of package'
+      ```
 
-        **Install multiple packages at once**:
+      **Install multiple packages at once**:
 
-        ```ruby
-        apt_package %w(package1 package2 package3)
-        ```
+      ```ruby
+      apt_package %w(package1 package2 package3)
+      ```
 
-        **Install without using recommend packages as a dependency**:
+      **Install without using recommend packages as a dependency**:
 
-        ```ruby
-        package 'apache2' do
-          options '--no-install-recommends'
-        end
-        ```
+      ```ruby
+      package 'apache2' do
+        options '--no-install-recommends'
+      end
+      ```
 
-        **Prevent the apt_package resource from installing packages with pattern matching names**:
+      **Prevent the apt_package resource from installing packages with pattern matching names**:
 
-        By default, the apt_package resource will install the named package.
-        If it can't find a package with the exact same name, it will treat the package name as regular expression string and match with any package that matches that regular expression.
-        This may lead Chef Infra Client to install one or more packages with names that match that regular expression.
+      By default, the apt_package resource will install the named package.
+      If it can't find a package with the exact same name, it will treat the package name as regular expression string and match with any package that matches that regular expression.
+      This may lead Chef Infra Client to install one or more packages with names that match that regular expression.
 
-        In this example, `anchor_package_regex true` prevents the apt_package resource from installing matching packages if it can't find the `lua5.3` package.
+      In this example, `anchor_package_regex true` prevents the apt_package resource from installing matching packages if it can't find the `lua5.3` package.
 
-        ```ruby
-        apt_package 'lua5.3' do
-          version '5.3.3-1.1ubuntu2'
-          anchor_package_regex true
-        end
-        ```
+      ```ruby
+      apt_package 'lua5.3' do
+        version '5.3.3-1.1ubuntu2'
+        anchor_package_regex true
+      end
+      ```
       DOC
 
       description "Use the **apt_package** resource to manage packages on Debian, Ubuntu, and other platforms that use the APT package system."
@@ -96,7 +101,7 @@ class Chef
         default: false
 
       property :environment, Hash,
-        introduced: "18.8",
+        introduced: "19.0",
         description: "A Hash of environment variables in the form of {'ENV_VARIABLE' => 'VALUE'} to be set before running the command.",
         default: {}, desired_state: false
     end

data/lib/chef/resource/apt_preference.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Tim Smith (<tsmith@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,39 +22,40 @@ class Chef
   class Resource
     class AptPreference < Chef::Resource
 
-      provides(:apt_preference) { true }
+      provides(:apt_preference, target_mode: true) { true }
+      target_mode support: :full
 
       description "Use the **apt_preference** resource to create APT [preference files](https://wiki.debian.org/AptPreferences). Preference files are used to control which package versions and sources are prioritized during installation."
       introduced "13.3"
       examples <<~DOC
-        **Pin libmysqlclient16 to a version 5.1.49-3**:
+      **Pin libmysqlclient16 to a version 5.1.49-3**:
 
-        ```ruby
-        apt_preference 'libmysqlclient16' do
-          pin          'version 5.1.49-3'
-          pin_priority '700'
-        end
-        ```
+      ```ruby
+      apt_preference 'libmysqlclient16' do
+        pin          'version 5.1.49-3'
+        pin_priority '700'
+      end
+      ```
 
-        Note: The `pin_priority` of `700` ensures that this version will be preferred over any other available versions.
+      Note: The `pin_priority` of `700` ensures that this version will be preferred over any other available versions.
 
-        **Unpin a libmysqlclient16**:
+      **Unpin a libmysqlclient16**:
 
-        ```ruby
-        apt_preference 'libmysqlclient16' do
-          action :remove
-        end
-        ```
+      ```ruby
+      apt_preference 'libmysqlclient16' do
+        action :remove
+      end
+      ```
 
-        **Pin all packages to prefer the packages.dotdeb.org repository**:
+      **Pin all packages to prefer the packages.dotdeb.org repository**:
 
-        ```ruby
-        apt_preference 'dotdeb' do
-          glob         '*'
-          pin          'origin packages.dotdeb.org'
-          pin_priority '700'
-        end
-        ```
+      ```ruby
+      apt_preference 'dotdeb' do
+        glob         '*'
+        pin          'origin packages.dotdeb.org'
+        pin_priority '700'
+      end
+      ```
       DOC
 
       property :package_name, String,

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