chef 15.8.23 → 15.9.17

data/lib/chef/knife/edit.rb

@@ -74,7 +74,7 @@ class Chef
 
             # Let the user edit the temporary file
             unless system("#{config[:editor]} #{file.path}")
-              raise "Please set EDITOR environment variable. See https://docs.chef.io/knife_setup.html for details."
+              raise "Please set EDITOR environment variable. See https://docs.chef.io/knife_setup/ for details."
             end
 
             result_text = IO.read(file.path)

data/lib/chef/knife/environment_compare.rb

@@ -81,7 +81,7 @@ class Chef
 
       def constraint_list(environments)
         constraints = {}
-        environments.each do |env, url| # rubocop:disable Performance/HashEachMethods
+        environments.each do |env, url| # rubocop:disable Style/HashEachMethods
           # Because you cannot modify the default environment I filter it out here.
           unless env == "_default"
             envdata = Chef::Environment.load(env)

data/lib/chef/knife/list.rb

@@ -90,7 +90,7 @@ class Chef
 
         # Flatten out directory results if necessary
         if config[:flat]
-          dir_results.each do |result, children| # rubocop:disable Performance/HashEachMethods
+          dir_results.each do |result, children| # rubocop:disable Style/HashEachMethods
             results += children
           end
           dir_results = []

data/lib/chef/mixin/api_version_request_handling.rb

@@ -55,7 +55,7 @@ class Chef
           The server that received the request supports a min version of #{min_version} and a max version of #{max_version}.
           User keys are now managed via the key rotation commmands.
           Please refer to the documentation on how to manage your keys via the key rotation commands:
-          https://docs.chef.io/server_security.html#key-rotation
+          https://docs.chef.io/ctl_chef_server/#key-rotation
         EOH
       end
 

data/lib/chef/provider/group/usermod.rb

@@ -1,6 +1,6 @@
 #
 # Author:: AJ Christensen (<aj@chef.io>)
-# Copyright:: Copyright 2008-2019, Chef Software Inc.
+# Copyright:: Copyright 2008-2020, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -76,10 +76,7 @@ class Chef
         end
 
         def append_flags
-          case node[:platform]
-          when "openbsd", "netbsd", "aix", "smartos", "omnios"
-            "-G"
-          end
+          "-G" if platform?("openbsd", "netbsd", "aix", "smartos", "omnios")
         end
 
       end

data/lib/chef/provider/mount/mount.rb

@@ -157,7 +157,7 @@ class Chef
 
         # Return appropriate default mount options according to the given os.
         def default_mount_options
-          node[:os] == "linux" ? "defaults" : "rw"
+          linux? ? "defaults" : "rw"
         end
 
         def enable_fs

data/lib/chef/provider/package/homebrew.rb

@@ -2,8 +2,7 @@
 # Author:: Joshua Timberman (<joshua@chef.io>)
 # Author:: Graeme Mathieson (<mathie@woss.name>)
 #
-# Copyright 2011-2016, Chef Software Inc.
-# Copyright 2014-2016, Chef Software, Inc <legal@chef.io>
+# Copyright:: 2011-2016, Chef Software, Inc <legal@chef.io>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/chef/provider/package/rubygems.rb

@@ -403,7 +403,7 @@ class Chef
                 "Gem options must be passed to gem_package as a string instead of a hash when",
                 "using this installation of #{Chef::Dist::PRODUCT} because it runs with its own packaged Ruby. A hash",
                 "may only be used when installing a gem to the same Ruby installation that #{Chef::Dist::PRODUCT} is",
-                "running under.  See https://docs.chef.io/resource_gem_package.html for more information.",
+                "running under. See https://docs.chef.io/resources/gem_package/ for more information.",
                 "Error raised at #{new_resource} from #{new_resource.source_line}",
               ].join("\n")
               raise ArgumentError, msg

data/lib/chef/provider/package/yum/python_helper.rb

@@ -88,9 +88,9 @@ class Chef
           def install_only_packages(name)
             query_output = query("installonlypkgs", { "package" => name })
             if query_output == "False"
-              return false
+              false
             elsif query_output == "True"
-              return true
+              true
             end
           end
 

data/lib/chef/provider/package/yum/rpm_utils.rb

@@ -209,9 +209,9 @@ class Chef
 
               # the most unprocessed characters left wins
               if (x_pos_max - x_pos) > (y_pos_max - y_pos)
-                return 1
+                1
               else
-                return -1
+                -1
               end
             end
 
@@ -522,9 +522,9 @@ class Chef
           def lookup(package_name)
             pkgs = @rpms[package_name]
             if pkgs
-              return pkgs.sort.reverse
+              pkgs.sort.reverse
             else
-              return nil
+              nil
             end
           end
 

data/lib/chef/provider/package/zypper.rb

@@ -3,7 +3,8 @@
 # Authors:: Adam Jacob (<adam@chef.io>)
 #           Ionuț Arțăriși (<iartarisi@suse.cz>)
 # Copyright:: Copyright 2008-2017, Chef Software Inc.
-#             Copyright 2013-2016, SUSE Linux GmbH
+# Copyright:: 2013-2016, SUSE Linux GmbH
+#
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/chef/provider/remote_file.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Jesse Campbell (<hikeit@gmail.com>)
 # Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright 2008-2016, Chef Software Inc.
+# Copyright:: Copyright 2008-2020, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -35,7 +35,7 @@ class Chef
             requirements.assert(:all_actions) do |a|
               a.assertion do
                 if prop
-                  node[:platform_family] == "windows"
+                  windows?
                 else
                   true
                 end

data/lib/chef/provider/route.rb

@@ -1,6 +1,7 @@
 #
 # Author:: Bryan McLellan (btm@loftninjas.org), Jesse Nelson (spheromak@gmail.com)
 # Copyright:: Copyright 2009-2016, Bryan McLellan
+# Copyright:: Copyright 2020, Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -78,7 +79,7 @@ class Chef
           IPAddr.new(ip, Socket::AF_INET).to_s
         rescue ArgumentError
           logger.trace("Invalid IP address data: hex=#{hex_ip}, ip=#{ip}")
-          return nil
+          nil
         end
       end
 
@@ -95,7 +96,7 @@ class Chef
                  end
 
         # For linux, we use /proc/net/route file to read proc table info
-        return if node[:os] != "linux"
+        return unless linux?
 
         route_file = ::File.open("/proc/net/route", "r")
 
@@ -159,8 +160,7 @@ class Chef
       end
 
       def generate_config
-        case node[:platform_family]
-        when "rhel", "amazon", "fedora"
+        if platform_family?("rhel", "amazon", "fedora")
           conf = {}
           # walk the collection
           run_context.resource_collection.each do |resource|

data/lib/chef/provider/windows_env.rb

@@ -104,7 +104,7 @@ class Chef
         needs_delete = new_values.any? { |v| current_values.include?(v) }
         if !needs_delete
           logger.trace("#{new_resource} element '#{new_resource.value}' does not exist")
-          return true # do not delete the key
+          true # do not delete the key
         else
           new_value =
             current_values.select do |item|
@@ -112,13 +112,13 @@ class Chef
             end.join(new_resource.delim)
 
           if new_value.empty?
-            return false # nothing left here, delete the key
+            false # nothing left here, delete the key
           else
             old_value = new_resource.value(new_value)
             create_env
             logger.trace("#{new_resource} deleted #{old_value} element")
             new_resource.updated_by_last_action(true)
-            return true # we removed the element and updated; do not delete the key
+            true # we removed the element and updated; do not delete the key
           end
         end
       end

data/lib/chef/resource.rb

@@ -965,6 +965,8 @@ class Chef
           @resource_name = nil
         end
       end
+
+      @resource_name = nil unless defined?(@resource_name)
       @resource_name
     end
 
@@ -990,7 +992,7 @@ class Chef
     # @param flag [Boolean] value to set unified_mode to
     # @return [Boolean] unified_mode value
     def self.unified_mode(flag = nil)
-      @unified_mode = Chef::Config[:resource_unified_mode_default] if @unified_mode.nil?
+      @unified_mode = Chef::Config[:resource_unified_mode_default] if !defined?(@unified_mode) || @unified_mode.nil?
       @unified_mode = flag unless flag.nil?
       !!@unified_mode
     end
@@ -1035,7 +1037,7 @@ class Chef
         self.allowed_actions |= @default_action
       end
 
-      if @default_action
+      if defined?(@default_action) && @default_action
         @default_action
       elsif superclass.respond_to?(:default_action)
         superclass.default_action
@@ -1366,6 +1368,9 @@ class Chef
     def self.provides(name, **options, &block)
       name = name.to_sym
 
+      # quell warnings
+      @chef_version_for_provides = nil unless defined?(@chef_version_for_provides)
+
       # `provides :resource_name, os: 'linux'`) needs to remove the old
       # canonical DSL before adding the new one.
       if @resource_name && name == @resource_name

data/lib/chef/resource/build_essential.rb

@@ -15,6 +15,7 @@
 #
 
 require_relative "../resource"
+require "plist"
 
 class Chef
   class Resource
@@ -67,23 +68,7 @@ class Chef
           package "devel/m4"
           package "devel/gettext"
         when macos?
-          unless xcode_cli_installed?
-            # 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.gsub(/^ {14}/, "")
-                # 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
-                # find the CLI Tools update. We tail here because sometimes there's 2 and newest is last
-                PROD=$(softwareupdate -l | grep "\*.*Command Line" | tail -n 1 | awk -F"*" '{print $2}' | sed -e 's/^ *//' | tr -d '\n')
-                # install it
-                softwareupdate -i "$PROD" --verbose
-                # Remove the placeholder to prevent perpetual appearance in the update utility
-                rm -f /tmp/.com.apple.dt.CommandLineTools.installondemand.in-progress
-              EOH
-            end
-          end
+          install_xcode_cli_tools(xcode_cli_package_label) unless xcode_cli_installed?
         when omnios?
           package "developer/gcc48"
           package "developer/object-file"
@@ -142,14 +127,53 @@ class Chef
 
       action_class do
         #
-        # Determine if the XCode Command Line Tools are installed
+        # Install Xcode Command Line tools via softwareupdate CLI
+        #
+        # @param [String] label The label (package name) to install
+        #
+        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
+
+          if label.nil?
+            Chef::Log.warn("Could not determine a Xcode CLI Tools package to install via softwareupdate")
+          else
+            # create the placeholder file that's checked by CLI updates' .dist code
+            # in Apple's SUS catalog and then remove it when we're done
+            execute "install Xcode Command Line tools" do
+              command <<-EOH
+                touch /tmp/.com.apple.dt.CommandLineTools.installondemand.in-progress
+                softwareupdate -i "#{label}" --verbose
+                rm -f /tmp/.com.apple.dt.CommandLineTools.installondemand.in-progress
+              EOH
+            end
+          end
+        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
         #
         # @return [true, false]
         def xcode_cli_installed?
-          cmd = Mixlib::ShellOut.new("pkgutil --pkgs=com.apple.pkg.CLTools_Executables")
-          cmd.run_command
-          # pkgutil returns an error if the package isn't found aka not installed
-          cmd.error? ? false : true
+          packages = Plist.parse_xml(::File.open("/Library/Receipts/InstallHistory.plist", "r"))
+          packages.select! { |package| package["displayName"].match? "Command Line Tools" }
+          !packages.empty?
+        end
+
+        #
+        # Return to package label of the latest Xcode Command Line Tools update, if available
+        #
+        # @return [String, NilClass]
+        def xcode_cli_package_label
+          available_updates = shell_out("softwareupdate", "--list")
+
+          # raise if we fail to check
+          available_updates.error!
+
+          # https://rubular.com/r/UPEE5P7mZLvXNs
+          # this will return the match or nil
+          available_updates.stdout[/^\s*\* (?:Label: )?(Command Line Tools.*)/, 1]
         end
       end
 

data/lib/chef/resource/cron.rb

@@ -135,7 +135,7 @@ class Chef
       end
 
       property :time, Symbol,
-        description: "A time interval. Possible values: :annually, :daily, :hourly, :midnight, :monthly, :reboot, :weekly, or :yearly.",
+        description: "A time interval.",
         equal_to: Chef::Provider::Cron::SPECIAL_TIME_VALUES
 
       property :mailto, String,

data/lib/chef/resource/cron_d.rb

@@ -146,7 +146,7 @@ class Chef
       property :cookbook, String, desired_state: false
 
       property :predefined_value, String,
-        description: 'Schedule your cron job with one of the special predefined value instead of ** * pattern. This correspond to "@reboot", "@yearly", "@annually", "@monthly", "@weekly", "@daily", "@midnight" or "@hourly".',
+        description: "Schedule your cron job with one of the special predefined value instead of ** * pattern.",
         equal_to: %w{ @reboot @yearly @annually @monthly @weekly @daily @midnight @hourly }
 
       property :minute, [Integer, String],

data/lib/chef/resource/execute.rb

@@ -131,7 +131,7 @@ class Chef
       end
 
       def validate_identity_platform(specified_user, password = nil, specified_domain = nil, elevated = false)
-        if node[:platform_family] == "windows"
+        if windows?
           if specified_user && password.nil?
             raise ArgumentError, "A value for `password` must be specified when a value for `user` is specified on the Windows platform"
           end

data/lib/chef/resource/freebsd_package.rb

@@ -21,13 +21,10 @@
 require_relative "package"
 require_relative "../provider/package/freebsd/port"
 require_relative "../provider/package/freebsd/pkgng"
-require_relative "../mixin/shell_out"
 
 class Chef
   class Resource
     class FreebsdPackage < Chef::Resource::Package
-      include Chef::Mixin::ShellOut
-
       resource_name :freebsd_package
       provides :package, platform: "freebsd"
 

data/lib/chef/resource/homebrew_package.rb

@@ -2,8 +2,7 @@
 # Author:: Joshua Timberman (<joshua@chef.io>)
 # Author:: Graeme Mathieson (<mathie@woss.name>)
 #
-# Copyright 2011-2016, Chef Software Inc.
-# Copyright 2014-2016, Chef Software, Inc <legal@chef.io>
+# Copyright:: 2011-2020, Chef Software Inc.<legal@chef.io>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/chef/resource/hostname.rb

@@ -82,7 +82,7 @@ class Chef
       action :set do
         description "Sets the node's hostname."
 
-        if node["platform_family"] != "windows"
+        if !windows?
           ohai "reload hostname" do
             plugin "hostname"
             action :nothing
@@ -125,7 +125,7 @@ class Chef
               not_if { shell_out!("/usr/sbin/scutil --get LocalHostName").stdout.chomp == shortname }
               notifies :reload, "ohai[reload hostname]"
             end
-          when node["os"] == "linux"
+          when linux?
             case
             when ::File.exist?("/usr/bin/hostnamectl") && !docker?
               # use hostnamectl whenever we find it on linux (as systemd takes over the world)

data/lib/chef/resource/kernel_module.rb

@@ -3,8 +3,9 @@
 #
 # The MIT License (MIT)
 #
-# Copyright 2016-2018, Shopify Inc.
-# Copyright 2018, Chef Software, Inc.
+# Copyright:: 2016-2018, Shopify Inc.
+# Copyright:: 2018-2020, Chef Software Inc.
+#
 
 require_relative "../resource"
 

data/lib/chef/resource/openbsd_package.rb

@@ -21,13 +21,10 @@
 
 require_relative "package"
 require_relative "../provider/package/openbsd"
-require_relative "../mixin/shell_out"
 
 class Chef
   class Resource
     class OpenbsdPackage < Chef::Resource::Package
-      include Chef::Mixin::ShellOut
-
       resource_name :openbsd_package
       provides :package, os: "openbsd"
 

data/lib/chef/resource/remote_file.rb

@@ -109,7 +109,7 @@ class Chef
       end
 
       def validate_identity_platform(specified_user, password = nil, specified_domain = nil)
-        if node[:platform_family] == "windows"
+        if windows?
           if specified_user && password.nil?
             raise ArgumentError, "A value for `remote_password` must be specified when a value for `user` is specified on the Windows platform"
           end