chef 14.3.37-universal-mingw32 → 14.4.56-universal-mingw32

data/lib/chef/resource/file.rb

@@ -1,90 +1,105 @@
-#
-# Author:: Adam Jacob (<adam@chef.io>)
-# Author:: Seth Chisamore (<schisamo@chef.io>)
-# Copyright:: Copyright 2008-2018, Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# 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/platform/query_helpers"
-require "chef/mixin/securable"
-require "chef/resource/file/verification"
-require "pathname"
-
-class Chef
-  class Resource
-    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
-      else
-        state_attrs :checksum, :owner, :group, :mode
-      end
-
-      attr_writer :checksum
-
-      #
-      # The checksum of the rendered file.  This has to be saved on the
-      # new_resource for the 'after' state for reporting but we cannot
-      # mutate the new_resource.checksum which would change the
-      # user intent in the new_resource if the resource is reused.
-      #
-      # @return [String] Checksum of the file we actually rendered
-      attr_accessor :final_checksum
-
-      default_action :create
-      allowed_actions :create, :delete, :touch, :create_if_missing
-
-      property :path, String, name_property: true, identity: true
-      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, [ 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)
-        if ! (command.nil? || [String, Symbol].include?(command.class))
-          raise ArgumentError, "verify requires either a string, symbol, or a block"
-        end
-
-        if command || block_given?
-          verifications << Verification.new(self, command, opts, &block)
-        else
-          verifications
-        end
-      end
-
-      def state_for_resource_reporter
-        state_attrs = super()
-        # fix up checksum state with final_checksum saved by the provider
-        if checksum.nil? && final_checksum
-          state_attrs[:checksum] = final_checksum
-        end
-        state_attrs
-      end
-
-      def special_docker_files?(file)
-        %w{/etc/hosts /etc/hostname /etc/resolv.conf}.include?(Pathname(file.scrub).cleanpath.to_path)
-      end
-    end
-  end
-end
+#
+# Author:: Adam Jacob (<adam@chef.io>)
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+# Copyright:: Copyright 2008-2018, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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/platform/query_helpers"
+require "chef/mixin/securable"
+require "chef/resource/file/verification"
+require "pathname"
+
+class Chef
+  class Resource
+    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
+      else
+        state_attrs :checksum, :owner, :group, :mode
+      end
+
+      attr_writer :checksum
+
+      #
+      # The checksum of the rendered file.  This has to be saved on the
+      # new_resource for the 'after' state for reporting but we cannot
+      # mutate the new_resource.checksum which would change the
+      # user intent in the new_resource if the resource is reused.
+      #
+      # @return [String] Checksum of the file we actually rendered
+      attr_accessor :final_checksum
+
+      default_action :create
+      allowed_actions :create, :delete, :touch, :create_if_missing
+
+      property :path, String, name_property: true, identity: true,
+               description: "The full path to the file, including the file name and its extension. For example: /files/file.txt. Default value: the name of the resource block. Microsoft Windows: A path that begins with a forward slash (/) will point to the root of the current working directory of the chef-client process. This path can vary from system to system. Therefore, using a path that begins with a forward slash (/) is not recommended."
+
+      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] },
+               description: "Perform atomic file updates on a per-resource basis. Set to true for atomic file updates. Set to false for non-atomic file updates. This setting overrides file_atomic_update, which is a global setting found in the client.rb file."
+
+      property :backup, [ Integer, FalseClass ], desired_state: false, default: 5,
+               description: "The number of backups to be kept in /var/chef/backup (for UNIX- and Linux-based platforms) or C:/chef/backup (for the Microsoft Windows platform). Set to false to prevent backups from being kept."
+
+      property :checksum, [ /^[a-zA-Z0-9]{64}$/, nil ],
+               description: "The SHA-256 checksum of the file. Use to ensure that a specific file is used. If the checksum does not match, the file is not used."
+
+      property :content, [ String, nil ], desired_state: false,
+               description: "A string that is written to the file. The contents of this property replace any previous content when this property has something other than the default value. The default behavior will not modify content."
+
+      property :diff, [ String, nil ], desired_state: false
+
+      property :force_unlink, [ TrueClass, FalseClass ], desired_state: false, default: false,
+               description: "How the chef-client handles certain situations when the target file turns out not to be a file. For example, when a target file is actually a symlink. Set to true for the chef-client delete the non-file target and replace it with the specified file. Set to false for the chef-client to raise an error."
+
+      property :manage_symlink_source, [ TrueClass, FalseClass ], desired_state: false,
+               description: "Change the behavior of the file resource if it is pointed at a symlink. When this value is set to true, the Chef client will manage the symlink's permissions or will replace the symlink with a normal file if the resource has content. When this value is set to false, Chef will follow the symlink and will manage the permissions and content of symlink's target file. The default behavior is true but emits a warning that the default value will be changed to false in a future version; setting this explicitly to true or false suppresses this warning."
+
+      property :verifications, Array, default: lazy { [] }
+
+      def verify(command = nil, opts = {}, &block)
+        if ! (command.nil? || [String, Symbol].include?(command.class))
+          raise ArgumentError, "verify requires either a string, symbol, or a block"
+        end
+
+        if command || block_given?
+          verifications << Verification.new(self, command, opts, &block)
+        else
+          verifications
+        end
+      end
+
+      def state_for_resource_reporter
+        state_attrs = super()
+        # fix up checksum state with final_checksum saved by the provider
+        if checksum.nil? && final_checksum
+          state_attrs[:checksum] = final_checksum
+        end
+        state_attrs
+      end
+
+      def special_docker_files?(file)
+        %w{/etc/hosts /etc/hostname /etc/resolv.conf}.include?(Pathname(file.scrub).cleanpath.to_path)
+      end
+    end
+  end
+end

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

@@ -1,139 +1,139 @@
-#
-# Author:: Steven Danna (<steve@chef.io>)
-# Copyright:: Copyright 2014-2016, Chef Software, Inc
-# License:: Apache License, Version 2.0
-#
-# 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/exceptions"
-require "chef/guard_interpreter"
-require "chef/mixin/descendants_tracker"
-
-class Chef
-  class Resource
-    class File < Chef::Resource
-
-      #
-      # See RFC 027 for a full specification
-      #
-      # File verifications allow user-supplied commands a means of
-      # preventing file resource content deploys.  Their intended use
-      # is to verify the contents of a temporary file before it is
-      # deployed onto the system.
-      #
-      # Similar to not_if and only_if, file verifications can take a
-      # ruby block, which will be called, or a string, which will be
-      # executed as a Shell command.
-      #
-      # Additonally, Chef or third-party verifications can ship
-      # "registered verifications" that the user can use by specifying
-      # a :symbol as the command name.
-      #
-      # To create a registered verification, create a class that
-      # inherits from Chef::Resource::File::Verification and use the
-      # provides class method to give it name.  Registered
-      # verifications are expected to supply a verify instance method
-      # that takes 2 arguments.
-      #
-      # Example:
-      # class Chef
-      #  class Resource
-      #    class File::Verification::Foo < Chef::Resource::File::Verification
-      #      provides :noop
-      #      def verify(path, opts)
-      #        #yolo
-      #        true
-      #      end
-      #    end
-      #  end
-      # end
-      #
-      #
-
-      class Verification
-        extend Chef::Mixin::DescendantsTracker
-
-        def self.provides(name)
-          @provides = name
-        end
-
-        def self.provides?(name)
-          @provides == name
-        end
-
-        def self.lookup(name)
-          c = descendants.find { |d| d.provides?(name) }
-          if c.nil?
-            raise Chef::Exceptions::VerificationNotFound.new "No file verification for #{name} found."
-          end
-          c
-        end
-
-        def logger
-          @parent_resource.logger
-        end
-
-        def initialize(parent_resource, command, opts, &block)
-          @command, @command_opts = command, opts
-          @block = block
-          @parent_resource = parent_resource
-        end
-
-        def verify(path, opts = {})
-          logger.trace("Running verification[#{self}] on #{path}")
-          if @block
-            verify_block(path, opts)
-          elsif @command.is_a?(Symbol)
-            verify_registered_verification(path, opts)
-          elsif @command.is_a?(String)
-            verify_command(path, opts)
-          end
-        end
-
-        # opts is currently unused, but included in the API
-        # to support future extensions
-        def verify_block(path, opts)
-          @block.call(path)
-        end
-
-        # We reuse Chef::GuardInterpreter in order to support
-        # the same set of options that the not_if/only_if blocks do
-        def verify_command(path, opts)
-          if @command.include?("%{file}")
-            raise ArgumentError, "The %{file} expansion for verify commands has been removed. Please use %{path} instead."
-          end
-          command = @command % { path: path }
-          interpreter = Chef::GuardInterpreter.for_resource(@parent_resource, command, @command_opts)
-          interpreter.evaluate
-        end
-
-        def verify_registered_verification(path, opts)
-          verification_class = Chef::Resource::File::Verification.lookup(@command)
-          v = verification_class.new(@parent_resource, @command, @command_opts, &@block)
-          v.verify(path, opts)
-        end
-
-        def to_s
-          if @block
-            "<Proc>"
-          elsif @command.is_a?(Symbol)
-            "#{@command.inspect} (#{Chef::Resource::File::Verification.lookup(@command).name})"
-          elsif @command.is_a?(String)
-            @command
-          end
-        end
-      end
-    end
-  end
-end
+#
+# Author:: Steven Danna (<steve@chef.io>)
+# Copyright:: Copyright 2014-2016, Chef Software, Inc
+# License:: Apache License, Version 2.0
+#
+# 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/exceptions"
+require "chef/guard_interpreter"
+require "chef/mixin/descendants_tracker"
+
+class Chef
+  class Resource
+    class File < Chef::Resource
+
+      #
+      # See RFC 027 for a full specification
+      #
+      # File verifications allow user-supplied commands a means of
+      # preventing file resource content deploys.  Their intended use
+      # is to verify the contents of a temporary file before it is
+      # deployed onto the system.
+      #
+      # Similar to not_if and only_if, file verifications can take a
+      # ruby block, which will be called, or a string, which will be
+      # executed as a Shell command.
+      #
+      # Additonally, Chef or third-party verifications can ship
+      # "registered verifications" that the user can use by specifying
+      # a :symbol as the command name.
+      #
+      # To create a registered verification, create a class that
+      # inherits from Chef::Resource::File::Verification and use the
+      # provides class method to give it name.  Registered
+      # verifications are expected to supply a verify instance method
+      # that takes 2 arguments.
+      #
+      # Example:
+      # class Chef
+      #  class Resource
+      #    class File::Verification::Foo < Chef::Resource::File::Verification
+      #      provides :noop
+      #      def verify(path, opts)
+      #        #yolo
+      #        true
+      #      end
+      #    end
+      #  end
+      # end
+      #
+      #
+
+      class Verification
+        extend Chef::Mixin::DescendantsTracker
+
+        def self.provides(name)
+          @provides = name
+        end
+
+        def self.provides?(name)
+          @provides == name
+        end
+
+        def self.lookup(name)
+          c = descendants.find { |d| d.provides?(name) }
+          if c.nil?
+            raise Chef::Exceptions::VerificationNotFound.new "No file verification for #{name} found."
+          end
+          c
+        end
+
+        def logger
+          @parent_resource.logger
+        end
+
+        def initialize(parent_resource, command, opts, &block)
+          @command, @command_opts = command, opts
+          @block = block
+          @parent_resource = parent_resource
+        end
+
+        def verify(path, opts = {})
+          logger.trace("Running verification[#{self}] on #{path}")
+          if @block
+            verify_block(path, opts)
+          elsif @command.is_a?(Symbol)
+            verify_registered_verification(path, opts)
+          elsif @command.is_a?(String)
+            verify_command(path, opts)
+          end
+        end
+
+        # opts is currently unused, but included in the API
+        # to support future extensions
+        def verify_block(path, opts)
+          @block.call(path)
+        end
+
+        # We reuse Chef::GuardInterpreter in order to support
+        # the same set of options that the not_if/only_if blocks do
+        def verify_command(path, opts)
+          if @command.include?("%{file}")
+            raise ArgumentError, "The %{file} expansion for verify commands has been removed. Please use %{path} instead."
+          end
+          command = @command % { path: path }
+          interpreter = Chef::GuardInterpreter.for_resource(@parent_resource, command, @command_opts)
+          interpreter.evaluate
+        end
+
+        def verify_registered_verification(path, opts)
+          verification_class = Chef::Resource::File::Verification.lookup(@command)
+          v = verification_class.new(@parent_resource, @command, @command_opts, &@block)
+          v.verify(path, opts)
+        end
+
+        def to_s
+          if @block
+            "<Proc>"
+          elsif @command.is_a?(Symbol)
+            "#{@command.inspect} (#{Chef::Resource::File::Verification.lookup(@command).name})"
+          elsif @command.is_a?(String)
+            @command
+          end
+        end
+      end
+    end
+  end
+end