chef 13.12.14-universal-mingw32 → 14.0.190-universal-mingw32

data/lib/chef/resource/apt_repository.rb

@@ -20,27 +20,36 @@ require "chef/resource"
 
 class Chef
   class Resource
-    # Use the apt_repository resource to specify additional APT repositories. Adding a new repository will update
-    # APT package cache immediately.
-    #
-    # @since 12.9
     class AptRepository < Chef::Resource
       resource_name :apt_repository
       provides :apt_repository
 
-      property :repo_name, String, name_property: true
+      description "Use the apt_repository resource to specify additional APT repositories."\
+                  " Adding a new repository will update APT package cache immediately."
+      introduced "12.9"
+
+      # There's a pile of [ String, nil, FalseClass ] types in these properties.
+      # This goes back to Chef 12 where String didn't default to nil and we had to do
+      # it ourself, which required allowing that type as well. We've cleaned up the
+      # defaults, but since we allowed users to pass nil here we need to continue
+      # to allow that so don't refactor this however tempting it is
+      property :repo_name, String,
+               regex: [/^[^\/]+$/],
+               validation_message: "repo_name property cannot contain a forward slash '/'",
+               name_property: true
+
       property :uri, String
-      property :distribution, [ String, nil, false ], default: lazy { node["lsb"]["codename"] }, nillable: true, coerce: proc { |x| x ? x : nil }
-      property :components, Array, default: []
-      property :arch, [String, nil, false], default: nil, nillable: true, coerce: proc { |x| x ? x : nil }
+      property :distribution, [ String, nil, FalseClass ], default: lazy { node["lsb"]["codename"] }
+      property :components, Array, default: lazy { [] }
+      property :arch, [String, nil, FalseClass]
       property :trusted, [TrueClass, FalseClass], default: false
       # whether or not to add the repository as a source repo, too
       property :deb_src, [TrueClass, FalseClass], default: false
-      property :keyserver, [String, nil, false], default: "keyserver.ubuntu.com", nillable: true, coerce: proc { |x| x ? x : nil }
-      property :key, [String, Array, nil, false], default: [], coerce: proc { |x| x ? Array(x) : nil }
-      property :key_proxy, [String, nil, false], default: nil, nillable: true, coerce: proc { |x| x ? x : nil }
+      property :keyserver, [String, nil, FalseClass], default: "keyserver.ubuntu.com"
+      property :key, [String, Array, nil, FalseClass], default: lazy { [] }, coerce: proc { |x| x ? Array(x) : x }
+      property :key_proxy, [String, nil, FalseClass]
 
-      property :cookbook, [String, nil, false], default: nil, desired_state: false, nillable: true, coerce: proc { |x| x ? x : nil }
+      property :cookbook, [String, nil, FalseClass], desired_state: false
       property :cache_rebuild, [TrueClass, FalseClass], default: true, desired_state: false
 
       default_action :add

data/lib/chef/resource/apt_update.rb

@@ -20,13 +20,13 @@ require "chef/resource"
 
 class Chef
   class Resource
-    # Use the apt_update resource to manage APT repository updates on Debian and Ubuntu platforms.
-    #
-    # @since 12.7
     class AptUpdate < Chef::Resource
       resource_name :apt_update
       provides :apt_update
 
+      description "Use the apt_update resource to manage APT repository updates on Debian and Ubuntu platforms."
+      introduced "12.7"
+
       # allow bare apt_update with no name
       property :name, String, default: ""
       property :frequency, Integer, default: 86_400

data/lib/chef/resource/bash.rb

@@ -21,11 +21,13 @@ require "chef/provider/script"
 
 class Chef
   class Resource
-    # 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.
     class Bash < Chef::Resource::Script
+      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."
 
       def initialize(name, run_context = nil)
         super

data/lib/chef/resource/batch.rb

@@ -20,14 +20,16 @@ require "chef/resource/windows_script"
 
 class Chef
   class Resource
-    # 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.
     class Batch < Chef::Resource::WindowsScript
+      provides :batch
 
-      provides :batch, os: "windows"
+      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")

data/lib/chef/resource/bff_package.rb

@@ -17,15 +17,18 @@
 #
 
 require "chef/resource/package"
-require "chef/provider/package/aix"
 
 class Chef
   class Resource
-    # 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.
-    #
-    # @since 12.0
     class BffPackage < Chef::Resource::Package
+      resource_name :bff_package
+      provides :bff_package
+
+      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"
     end
   end
 end

data/lib/chef/resource/breakpoint.rb

@@ -20,16 +20,19 @@ require "chef/resource"
 
 class Chef
   class Resource
-    # Use the breakpoint resource to add breakpoints to recipes. Run the chef-shell in chef-client mode, and then use
-    # those breakpoints to debug recipes. Breakpoints are ignored by the chef-client during an actual chef-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.
-    #
-    # @since 12.0
     class Breakpoint < Chef::Resource
       provides :breakpoint
       resource_name :breakpoint
 
+      description "Use the breakpoint resource to add breakpoints to recipes. Run the"\
+                  " chef-shell in chef-client mode, and then use those breakpoints to debug"\
+                  " recipes. Breakpoints are ignored by the chef-client during an actual"\
+                  " chef-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"
+
       default_action :break
 
       def initialize(action = "break", *args)

data/lib/chef/resource/build_essential.rb

@@ -0,0 +1,139 @@
+#
+# Copyright:: 2008-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 BuildEssential < Chef::Resource
+      resource_name :build_essential
+      provides :build_essential
+
+      description "Use the build_essential resource to install packages required for compiling C software from source"
+      introduced "14.0"
+
+      property :compile_time, [TrueClass, FalseClass],
+               description: "Install build essential packages at compile time.",
+               default: false
+
+      action :install do
+
+        description "Install build essential packages"
+
+        case node["platform_family"]
+        when "debian"
+          declare_resource(:package,  %w{ autoconf binutils-doc bison build-essential flex gettext ncurses-dev })
+        when "amazon", "fedora", "rhel"
+          declare_resource(:package,  %w{ autoconf bison flex gcc gcc-c++ gettext kernel-devel make m4 ncurses-devel patch })
+
+          # Ensure GCC 4 is available on older pre-6 EL
+          declare_resource(:package,  %w{ gcc44 gcc44-c++ }) if platform_family?("rhel") && node["platform_version"].to_i < 6
+        when "freebsd"
+          declare_resource(:package,  "devel/gmake")
+          declare_resource(:package,  "devel/autoconf")
+          declare_resource(:package,  "devel/m4")
+          declare_resource(:package,  "devel/gettext")
+        when "mac_os_x"
+          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
+            declare_resource(: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
+        when "omnios"
+          declare_resource(:package,  "developer/gcc48")
+          declare_resource(:package,  "developer/object-file")
+          declare_resource(:package,  "developer/linker")
+          declare_resource(:package,  "developer/library/lint")
+          declare_resource(:package,  "developer/build/gnu-make")
+          declare_resource(:package,  "system/header")
+          declare_resource(:package,  "system/library/math/header-math")
+
+          # Per OmniOS documentation, the gcc bin dir isn't in the default
+          # $PATH, so add it to the running process environment
+          # http://omnios.omniti.com/wiki.php/DevEnv
+          ENV["PATH"] = "#{ENV['PATH']}:/opt/gcc-4.7.2/bin"
+        when "solaris2"
+          declare_resource(:package,  "autoconf")
+          declare_resource(:package,  "automake")
+          declare_resource(:package,  "bison")
+          declare_resource(:package,  "gnu-coreutils")
+          declare_resource(:package,  "flex")
+          declare_resource(:package,  "gcc") do
+            # lock because we don't use 5 yet
+            version "4.8.2"
+          end
+          declare_resource(:package,  "gcc-3")
+          declare_resource(:package,  "gnu-grep")
+          declare_resource(:package,  "gnu-make")
+          declare_resource(:package,  "gnu-patch")
+          declare_resource(:package,  "gnu-tar")
+          declare_resource(:package,  "make")
+          declare_resource(:package,  "pkg-config")
+          declare_resource(:package,  "ucb")
+        when "smartos"
+          declare_resource(:package,  "autoconf")
+          declare_resource(:package,  "binutils")
+          declare_resource(:package,  "build-essential")
+          declare_resource(:package,  "gcc47")
+          declare_resource(:package,  "gmake")
+          declare_resource(:package,  "pkg-config")
+        when "suse"
+          declare_resource(:package,  %w{ autoconf bison flex gcc gcc-c++ kernel-default-devel make m4 })
+          declare_resource(:package,  %w{ gcc48 gcc48-c++ }) if node["platform_version"].to_i < 12
+        else
+          Chef::Log.warn <<-EOH
+        The build_essential resource does not currently support the '#{node['platform_family']}'
+        platform family. Skipping...
+        EOH
+        end
+      end
+
+      action_class do
+        #
+        # Determine if the XCode Command Line Tools are installed
+        #
+        # @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
+        end
+      end
+
+      # this resource forces itself to run at compile_time
+      def after_created
+        return unless compile_time
+        Array(action).each do |action|
+          run_action(action)
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/cab_package.rb

@@ -21,14 +21,15 @@ require "chef/mixin/uris"
 
 class Chef
   class Resource
-    # Use the cab_package resource to install or remove Microsoft Windows cabinet (.cab) packages.
-    #
-    # @since 12.15
     class CabPackage < Chef::Resource::Package
       include Chef::Mixin::Uris
 
       resource_name :cab_package
-      provides :cab_package, os: "windows"
+      provides :cab_package
+
+      description "Use the cab_package resource to install or remove Microsoft Windows"\
+                  " cabinet (.cab) packages."
+      introduced "12.15"
 
       allowed_actions :install, :remove
 

data/lib/chef/resource/chef_gem.rb

@@ -40,7 +40,7 @@ class Chef
                             callbacks: {
                  "The chef_gem resource is restricted to the current gem environment, use gem_package to install to other environments." => proc { |v| v == "#{RbConfig::CONFIG['bindir']}/gem" },
                }
-      property :compile_time, [ true, false ], default: false, desired_state: false
+      property :compile_time, [TrueClass, FalseClass], default: false, desired_state: false
 
       # force the resource to compile time if the compile time property has been set
       def after_created

data/lib/chef/resource/chef_handler.rb

@@ -0,0 +1,130 @@
+#
+# Author:: Seth Chisamore <schisamo@chef.io>
+# Copyright:: 2011-2018, 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.
+# 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.
+#
+
+class Chef
+  class Resource
+    class ChefHandler < Chef::Resource
+      resource_name :chef_handler
+      provides :chef_handler
+
+      description "Use the chef_handler resource to install or uninstall Chef reporting/exception handlers."
+      introduced "14.0"
+
+      property :class_name, String,
+               description: "The name of the handler class (can be module name-spaced).",
+               name_property: true
+
+      property :source, String,
+               description: "The full path to the handler file. Can also be a gem path if the handler ships as part of a Ruby gem."
+
+      property :arguments, [Array, Hash],
+               description: "Arguments to pass the handler's class initializer.",
+               default: lazy { [] }
+
+      property :type, Hash,
+               description: "The type of Chef Handler to register as, i.e. :report, :exception or both.",
+               default: { report: true, exception: true }
+
+      # supports means a different thing in chef-land so we renamed it but
+      # wanted to make sure we didn't break the world
+      alias_method :supports, :type
+
+      # This action needs to find an rb file that presumably contains the indicated class in it and the
+      # load that file. It then instantiates that class by name and registers it as a handler.
+      action :enable do
+        description "Enables the Chef handler for the current Chef run on the current node"
+
+        class_name = new_resource.class_name
+        new_resource.type.each do |type, enable|
+          next unless enable
+
+          unregister_handler(type, class_name)
+        end
+
+        handler = nil
+
+        require new_resource.source unless new_resource.source.nil?
+
+        _, klass = get_class(class_name)
+        handler = klass.send(:new, *collect_args(new_resource.arguments))
+
+        new_resource.type.each do |type, enable|
+          next unless enable
+          register_handler(type, handler)
+        end
+      end
+
+      action :disable do
+        description "Disables the Chef handler for the current Chef run on the current node"
+
+        new_resource.type.each_key do |type|
+          unregister_handler(type, new_resource.class_name)
+        end
+      end
+
+      action_class do
+        # Registers a handler in Chef::Config.
+        #
+        # @param handler_type [Symbol] such as :report or :exception.
+        # @param handler [Chef::Handler] handler to register.
+        def register_handler(handler_type, handler)
+          Chef::Log.info("Enabling #{handler.class.name} as a #{handler_type} handler.")
+          Chef::Config.send("#{handler_type}_handlers") << handler
+        end
+
+        # Removes all handlers that match the given class name in Chef::Config.
+        #
+        # @param handler_type [Symbol] such as :report or :exception.
+        # @param class_full_name [String] such as 'Chef::Handler::ErrorReport'.
+        def unregister_handler(handler_type, class_full_name)
+          Chef::Config.send("#{handler_type}_handlers").delete_if do |v|
+            # avoid a bit of log spam
+            if v.class.name == class_full_name
+              Chef::Log.info("Disabling #{class_full_name} as a #{handler_type} handler.")
+              true
+            end
+          end
+        end
+
+        # Walks down the namespace heirarchy to return the class object for the given class name.
+        # If the class is not available, NameError is thrown.
+        #
+        # @param class_full_name [String] full class name such as 'Chef::Handler::Foo' or 'MyHandler'.
+        # @return [Array] parent class and child class.
+        def get_class(class_full_name)
+          ancestors = class_full_name.split("::")
+          class_name = ancestors.pop
+
+          # We need to search the ancestors only for the first/uppermost namespace of the class, so we
+          # need to enable the #const_get inherit paramenter only when we are searching in Kernel scope
+          # (see COOK-4117).
+          parent = ancestors.inject(Kernel) { |scope, const_name| scope.const_get(const_name, scope === Kernel) }
+          child = parent.const_get(class_name, parent === Kernel)
+          [parent, child]
+        end
+
+        def collect_args(resource_args = [])
+          if resource_args.is_a? Array
+            resource_args
+          else
+            [resource_args]
+          end
+        end
+      end
+    end
+  end
+end