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

data/lib/chef/resource/dsc_script.rb

@@ -21,16 +21,20 @@ require "chef/dsl/powershell"
 
 class Chef
   class Resource
-    # Many DSC resources are comparable to built-in Chef resources. For example, both DSC and Chef have file, package,
-    # and service resources. The dsc_script resource is most useful for those DSC resources that do not have a direct
-    # comparison to a resource in Chef, such as the Archive resource, a custom DSC resource, an existing DSC script
-    # that performs an important task, and so on. Use the dsc_script resource to embed the code that defines a DSC
-    # configuration directly within a Chef recipe.
     class DscScript < Chef::Resource
       include Chef::DSL::Powershell
 
       resource_name :dsc_script
-      provides :dsc_script, os: "windows"
+      provides :dsc_script
+
+      description "Many DSC resources are comparable to built-in Chef resources. For"\
+                  " example, both DSC and Chef have file, package, and service resources."\
+                  " The dsc_script resource is most useful for those DSC resources that"\
+                  " do not have a direct comparison to a resource in Chef, such as the"\
+                  " Archive resource, a custom DSC resource, an existing DSC script"\
+                  " that performs an important task, and so on. Use the dsc_script resource"\
+                  " to embed the code that defines a DSC configuration directly within a"\
+                  " Chef recipe."
 
       default_action :run
 
@@ -110,37 +114,10 @@ class Chef
         end
       end
 
-      def flags(arg = nil)
-        set_or_return(
-          :flags,
-          arg,
-          :kind_of => [ Hash ]
-        )
-      end
-
-      def cwd(arg = nil)
-        set_or_return(
-          :cwd,
-          arg,
-          :kind_of => [ String ]
-        )
-      end
-
-      def environment(arg = nil)
-        set_or_return(
-          :environment,
-          arg,
-          :kind_of => [ Hash ]
-        )
-      end
-
-      def timeout(arg = nil)
-        set_or_return(
-          :timeout,
-          arg,
-          :kind_of => [ Integer ]
-        )
-      end
+      property :flags, Hash
+      property :cwd, String
+      property :environment, Hash
+      property :timeout, Integer
     end
   end
 end

data/lib/chef/resource/execute.rb

@@ -18,17 +18,20 @@
 #
 
 require "chef/resource"
-require "chef/provider/execute"
 
 class Chef
   class Resource
-    # Use the execute resource to execute a single command. 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 Execute < Chef::Resource
+      resource_name :execute
+      provides :execute
 
       identity_attr :command
 
+      description "Use the execute resource to execute a single command. 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."
+
       # The ResourceGuardInterpreter wraps a resource's guards in another resource.  That inner resource
       # needs to behave differently during (for example) why_run mode, so we flag it here. For why_run mode
       # we still want to execute the guard resource even if we are not executing the wrapping resource.
@@ -41,25 +44,8 @@ class Chef
         super
         @command = name
         @backup = 5
-        @creates = nil
-        @cwd = nil
-        @environment = nil
-        @group = nil
-        @returns = 0
-        @timeout = nil
-        @user = nil
-        @umask = nil
         @default_guard_interpreter = :execute
         @is_guard_interpreter = false
-        @live_stream = false
-      end
-
-      def umask(arg = nil)
-        set_or_return(
-          :umask,
-          arg,
-          :kind_of => [ String, Integer ]
-        )
       end
 
       def command(arg = nil)
@@ -69,68 +55,19 @@ class Chef
           :kind_of => [ String, Array ]
         )
       end
-
-      def creates(arg = nil)
-        set_or_return(
-          :creates,
-          arg,
-          :kind_of => [ String ]
-        )
-      end
-
-      def cwd(arg = nil)
-        set_or_return(
-          :cwd,
-          arg,
-          :kind_of => [ String ]
-        )
-      end
-
-      def environment(arg = nil)
-        set_or_return(
-          :environment,
-          arg,
-          :kind_of => [ Hash ]
-        )
-      end
+      property :umask, [ String, Integer ]
+      property :creates, String
+      property :cwd, String
+      property :environment, Hash
 
       alias :env :environment
 
-      def group(arg = nil)
-        set_or_return(
-          :group,
-          arg,
-          :kind_of => [ String, Integer ]
-        )
-      end
-
-      def live_stream(arg = nil)
-        set_or_return(
-          :live_stream,
-          arg,
-          :kind_of => [ TrueClass, FalseClass ])
-      end
-
-      def returns(arg = nil)
-        set_or_return(
-          :returns,
-          arg,
-          :kind_of => [ Integer, Array ]
-        )
-      end
-
-      def timeout(arg = nil)
-        set_or_return(
-          :timeout,
-          arg,
-          :kind_of => [ Integer, Float ]
-        )
-      end
-
+      property :group, [ String, Integer ]
+      property :live_stream, [ TrueClass, FalseClass ], default: false
+      property :returns, [ Integer, Array ], default: 0
+      property :timeout, [ Integer, Float ]
       property :user, [ String, Integer ]
-
       property :domain, String
-
       property :password, String, sensitive: true
 
       # lazy used to set default value of sensitive to true if password is set

data/lib/chef/resource/file.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Adam Jacob (<adam@chef.io>)
 # Author:: Seth Chisamore (<schisamo@chef.io>)
-# Copyright:: Copyright 2008-2016 Chef Software, Inc.
+# Copyright:: Copyright 2008-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,10 +25,11 @@ require "pathname"
 
 class Chef
   class Resource
-    # Use the file resource to manage files directly on a node.
     class File < Chef::Resource
       include Chef::Mixin::Securable
 
+      description "Use the file resource to manage files directly on a node."
+
       if Platform.windows?
         # Use Windows rights instead of standard *nix permissions
         state_attrs :checksum, :rights, :deny_rights
@@ -51,13 +52,13 @@ class Chef
       allowed_actions :create, :delete, :touch, :create_if_missing
 
       property :path, String, name_property: true, identity: true
-      property :atomic_update, [ true, false ], desired_state: false, default: lazy { |r| r.docker? && r.special_docker_files?(r.path) ? false : Chef::Config[:file_atomic_update] }
+      property :atomic_update, [ TrueClass, FalseClass ], desired_state: false, default: lazy { |r| r.docker? && r.special_docker_files?(r.path) ? false : Chef::Config[:file_atomic_update] }
       property :backup, [ Integer, false ], desired_state: false, default: 5
       property :checksum, [ /^[a-zA-Z0-9]{64}$/, nil ]
       property :content, [ String, nil ], desired_state: false
       property :diff, [ String, nil ], desired_state: false
-      property :force_unlink, [ true, false ], desired_state: false, default: false
-      property :manage_symlink_source, [ true, false ], desired_state: false
+      property :force_unlink, [ TrueClass, FalseClass ], desired_state: false, default: false
+      property :manage_symlink_source, [ TrueClass, FalseClass ], desired_state: false
       property :verifications, Array, default: lazy { [] }
 
       def verify(command = nil, opts = {}, &block)

data/lib/chef/resource/file/verification.rb

@@ -80,6 +80,10 @@ class Chef
           c
         end
 
+        def logger
+          @parent_resource.logger
+        end
+
         def initialize(parent_resource, command, opts, &block)
           @command, @command_opts = command, opts
           @block = block
@@ -87,7 +91,7 @@ class Chef
         end
 
         def verify(path, opts = {})
-          Chef::Log.debug("Running verification[#{self}] on #{path}")
+          logger.trace("Running verification[#{self}] on #{path}")
           if @block
             verify_block(path, opts)
           elsif @command.is_a?(Symbol)

data/lib/chef/resource/freebsd_package.rb

@@ -26,13 +26,14 @@ require "chef/mixin/shell_out"
 
 class Chef
   class Resource
-    # Use the freebsd_package resource to manage packages for the FreeBSD platform.
     class FreebsdPackage < Chef::Resource::Package
       include Chef::Mixin::ShellOut
 
       resource_name :freebsd_package
       provides :package, platform: "freebsd"
 
+      description "Use the freebsd_package resource to manage packages for the FreeBSD platform."
+
       # make sure we assign the appropriate underlying providers based on what
       # package managers exist on this FreeBSD system or the source of the package
       #

data/lib/chef/resource/gem_package.rb

@@ -20,11 +20,14 @@ require "chef/resource/package"
 
 class Chef
   class Resource
-    # Use the gem_package resource to manage gem packages that are only included in recipes. When a package is installed
-    # from a local file, it must be added to the node using the remote_file or cookbook_file resources.
     class GemPackage < Chef::Resource::Package
       resource_name :gem_package
 
+      description "Use the gem_package resource to manage gem packages that are only"\
+                  " included in recipes. When a package is installed from a local file,"\
+                  " it must be added to the node using the remote_file or cookbook_file"\
+                  " resources."
+
       # the source can either be a path to a package source like:
       #   source /var/tmp/mygem-1.2.3.4.gem
       # or it can be a url rubygems source like:
@@ -37,7 +40,7 @@ class Chef
       # FIXME? the array form of installing paths most likely does not work?
       #
       property :source, [ String, Array ]
-      property :clear_sources, [ true, false ], default: false, desired_state: false
+      property :clear_sources, [ TrueClass, FalseClass ], default: false, desired_state: false
       # Sets a custom gem_binary to run for gem commands.
       property :gem_binary, String, desired_state: false
 

data/lib/chef/resource/git.rb

@@ -20,26 +20,15 @@ require "chef/resource/scm"
 
 class Chef
   class Resource
-    # Use the git resource to manage source control resources that exist in a git repository. git version 1.6.5 (or higher)
-    # is required to use all of the functionality in the git resource.
     class Git < Chef::Resource::Scm
+      description "Use the git resource to manage source control resources that exist"\
+                  " in a git repository. git version 1.6.5 (or higher) is required to"\
+                  " use all of the functionality in the git resource."
 
-      def initialize(name, run_context = nil)
-        super
-        @additional_remotes = Hash[]
-      end
-
-      def additional_remotes(arg = nil)
-        set_or_return(
-          :additional_remotes,
-          arg,
-          :kind_of => Hash
-        )
-      end
+      property :additional_remotes, Hash, default: lazy { Hash.new }
 
       alias :branch :revision
       alias :reference :revision
-
       alias :repo :repository
     end
   end

data/lib/chef/resource/group.rb

@@ -19,41 +19,22 @@
 
 class Chef
   class Resource
-    # Use the group resource to manage a local group.
     class Group < Chef::Resource
-
-      identity_attr :group_name
-
       state_attrs :members
 
+      description "Use the group resource to manage a local group."
+
       allowed_actions :create, :remove, :modify, :manage
       default_action :create
 
       def initialize(name, run_context = nil)
         super
-        @group_name = name
-        @gid = nil
         @members = []
         @excluded_members = []
-        @append = false
-        @non_unique = false
       end
 
-      def group_name(arg = nil)
-        set_or_return(
-          :group_name,
-          arg,
-          :kind_of => [ String ]
-        )
-      end
-
-      def gid(arg = nil)
-        set_or_return(
-          :gid,
-          arg,
-          :kind_of => [ String, Integer ]
-        )
-      end
+      property :group_name, String, name_property: true, identity: true
+      property :gid, [ String, Integer ]
 
       def members(arg = nil)
         converted_members = arg.is_a?(String) ? arg.split(",") : arg
@@ -75,29 +56,9 @@ class Chef
         )
       end
 
-      def append(arg = nil)
-        set_or_return(
-          :append,
-          arg,
-          :kind_of => [ TrueClass, FalseClass ]
-        )
-      end
-
-      def system(arg = nil)
-        set_or_return(
-          :system,
-          arg,
-          :kind_of => [ TrueClass, FalseClass ]
-        )
-      end
-
-      def non_unique(arg = nil)
-        set_or_return(
-          :non_unique,
-          arg,
-          :kind_of => [ TrueClass, FalseClass ]
-        )
-      end
+      property :append, [ TrueClass, FalseClass ], default: false
+      property :system, [ TrueClass, FalseClass ], default: false
+      property :non_unique, [ TrueClass, FalseClass ], default: false
     end
   end
 end

data/lib/chef/resource/homebrew_cask.rb

@@ -0,0 +1,98 @@
+#
+# Author:: Joshua Timberman (<jtimberman@chef.io>)
+# Author:: Graeme Mathieson (<mathie@woss.name>)
+#
+# Copyright:: 2011-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"
+require "chef/mixin/homebrew_user"
+
+class Chef
+  class Resource
+    class HomebrewCask < Chef::Resource
+      resource_name :homebrew_cask
+
+      description "Use the homebrew_cask resource to install binaries distributed via the Homebrew package manager."
+      introduced "14.0"
+
+      include Chef::Mixin::HomebrewUser
+
+      property :cask_name, String,
+               description: "Cask name to override the resource name.",
+               regex: %r{^[\w/-]+$},
+               name_property: true
+
+      property :options, String,
+               description: "Options to pass to the brew CLI during installation."
+
+      property :install_cask, [TrueClass, FalseClass],
+               description: "Auto install cask tap if necessary.",
+               default: true
+
+      property :homebrew_path, String,
+               description: "The path to the homebrew binary.",
+               default: "/usr/local/bin/brew"
+
+      property :owner, String,
+               description: "The owner of the homebrew installation.",
+               default: lazy { find_homebrew_username }
+
+      action :install do
+        description "Install an application packaged as a Homebrew cask."
+
+        homebrew_tap "caskroom/cask" if new_resource.install_cask
+
+        unless casked?
+          converge_by("install cask #{new_resource.name} #{new_resource.options}") do
+            shell_out!("#{new_resource.homebrew_path} cask install #{new_resource.name} #{new_resource.options}",
+                user: new_resource.owner,
+                env:  { "HOME" => ::Dir.home(new_resource.owner), "USER" => new_resource.owner },
+                cwd: ::Dir.home(new_resource.owner))
+          end
+        end
+      end
+
+      action :remove do
+        description "Remove an application packaged as a Homebrew cask."
+
+        homebrew_tap "caskroom/cask" if new_resource.install_cask
+
+        if casked?
+          converge_by("uninstall cask #{new_resource.name}") do
+            shell_out!("#{new_resource.homebrew_path} cask uninstall #{new_resource.name}",
+                user: new_resource.owner,
+                env:  { "HOME" => ::Dir.home(new_resource.owner), "USER" => new_resource.owner },
+                cwd: ::Dir.home(new_resource.owner))
+          end
+        end
+      end
+
+      action_class do
+        alias_method :action_cask, :action_install
+        alias_method :action_uncask, :action_remove
+        alias_method :action_uninstall, :action_remove
+
+        def casked?
+          unscoped_name = new_resource.name.split("/").last
+          shell_out!('#{new_resource.homebrew_path} cask list 2>/dev/null',
+            user: new_resource.owner,
+            env:  { "HOME" => ::Dir.home(new_resource.owner), "USER" => new_resource.owner },
+            cwd: ::Dir.home(new_resource.owner)).stdout.split.include?(unscoped_name)
+        end
+      end
+    end
+  end
+end