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

data/lib/chef/resource/dsc_script.rb

@@ -1,124 +1,131 @@
-#
-# Author:: Adam Edwards (<adamed@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/resource"
-require "chef/exceptions"
-require "chef/dsl/powershell"
-
-class Chef
-  class Resource
-    class DscScript < Chef::Resource
-      include Chef::DSL::Powershell
-
-      resource_name :dsc_script
-      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
-
-      def initialize(name, run_context = nil)
-        super
-        @imports = {}
-      end
-
-      def code(arg = nil)
-        if arg && command
-          raise ArgumentError, "Only one of 'code' and 'command' properties may be specified"
-        end
-        if arg && configuration_name
-          raise ArgumentError, "The 'code' and 'command' properties may not be used together"
-        end
-        set_or_return(
-          :code,
-          arg,
-          kind_of: [ String ]
-        )
-      end
-
-      def configuration_name(arg = nil)
-        if arg && code
-          raise ArgumentError, "Property `configuration_name` may not be set if `code` is set"
-        end
-        set_or_return(
-          :configuration_name,
-          arg,
-          kind_of: [ String ]
-        )
-      end
-
-      def command(arg = nil)
-        if arg && code
-          raise ArgumentError, "The 'code' and 'command' properties may not be used together"
-        end
-        set_or_return(
-          :command,
-          arg,
-          kind_of: [ String ]
-        )
-      end
-
-      def configuration_data(arg = nil)
-        if arg && configuration_data_script
-          raise ArgumentError, "The 'configuration_data' and 'configuration_data_script' properties may not be used together"
-        end
-        set_or_return(
-          :configuration_data,
-          arg,
-          kind_of: [ String ]
-        )
-      end
-
-      def configuration_data_script(arg = nil)
-        if arg && configuration_data
-          raise ArgumentError, "The 'configuration_data' and 'configuration_data_script' properties may not be used together"
-        end
-        set_or_return(
-          :configuration_data_script,
-          arg,
-          kind_of: [ String ]
-        )
-      end
-
-      def imports(module_name = nil, *args)
-        if module_name
-          @imports[module_name] ||= []
-          if args.length == 0
-            @imports[module_name] << "*"
-          else
-            @imports[module_name].push(*args)
-          end
-        else
-          @imports
-        end
-      end
-
-      property :flags, Hash
-      property :cwd, String
-      property :environment, Hash
-      property :timeout, Integer
-    end
-  end
-end
+#
+# Author:: Adam Edwards (<adamed@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/resource"
+require "chef/exceptions"
+require "chef/dsl/powershell"
+
+class Chef
+  class Resource
+    class DscScript < Chef::Resource
+      include Chef::DSL::Powershell
+
+      resource_name :dsc_script
+      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
+
+      def initialize(name, run_context = nil)
+        super
+        @imports = {}
+      end
+
+      def code(arg = nil)
+        if arg && command
+          raise ArgumentError, "Only one of 'code' and 'command' properties may be specified"
+        end
+        if arg && configuration_name
+          raise ArgumentError, "The 'code' and 'command' properties may not be used together"
+        end
+        set_or_return(
+          :code,
+          arg,
+          kind_of: [ String ]
+        )
+      end
+
+      def configuration_name(arg = nil)
+        if arg && code
+          raise ArgumentError, "Property `configuration_name` may not be set if `code` is set"
+        end
+        set_or_return(
+          :configuration_name,
+          arg,
+          kind_of: [ String ]
+        )
+      end
+
+      def command(arg = nil)
+        if arg && code
+          raise ArgumentError, "The 'code' and 'command' properties may not be used together"
+        end
+        set_or_return(
+          :command,
+          arg,
+          kind_of: [ String ]
+        )
+      end
+
+      def configuration_data(arg = nil)
+        if arg && configuration_data_script
+          raise ArgumentError, "The 'configuration_data' and 'configuration_data_script' properties may not be used together"
+        end
+        set_or_return(
+          :configuration_data,
+          arg,
+          kind_of: [ String ]
+        )
+      end
+
+      def configuration_data_script(arg = nil)
+        if arg && configuration_data
+          raise ArgumentError, "The 'configuration_data' and 'configuration_data_script' properties may not be used together"
+        end
+        set_or_return(
+          :configuration_data_script,
+          arg,
+          kind_of: [ String ]
+        )
+      end
+
+      def imports(module_name = nil, *args)
+        if module_name
+          @imports[module_name] ||= []
+          if args.length == 0
+            @imports[module_name] << "*"
+          else
+            @imports[module_name].push(*args)
+          end
+        else
+          @imports
+        end
+      end
+
+      property :flags, Hash,
+               description: "Pass parameters to the DSC script that is specified by the command property. Parameters are defined as key-value pairs, where the value of each key is the parameter to pass. This property may not be used in the same recipe as the code property."
+
+      property :cwd, String,
+               description: "The current working directory."
+
+      property :environment, Hash,
+               description: "A Hash of environment variables in the form of ({'ENV_VARIABLE' => 'VALUE'}). (These variables must exist for a command to be run successfully)."
+
+      property :timeout, Integer,
+               description: "The amount of time (in seconds) a command is to wait before timing out."
+    end
+  end
+end

data/lib/chef/resource/execute.rb

@@ -1,173 +1,198 @@
-#
-# Author:: Adam Jacob (<adam@chef.io>)
-# Author:: Tyler Cloke (<tyler@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"
-
-class Chef
-  class Resource
-    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.
-      # Only execute resources (and subclasses) can be guard interpreters.
-      attr_accessor :is_guard_interpreter
-
-      default_action :run
-
-      def initialize(name, run_context = nil)
-        super
-        @command = name
-        @backup = 5
-        @default_guard_interpreter = :execute
-        @is_guard_interpreter = false
-      end
-
-      def command(arg = nil)
-        set_or_return(
-          :command,
-          arg,
-          kind_of: [ String, Array ]
-        )
-      end
-      property :umask, [ String, Integer ]
-      property :creates, String
-      property :cwd, String
-      property :environment, Hash
-
-      alias :env :environment
-
-      property :group, [ String, Integer ]
-      property :live_stream, [ TrueClass, FalseClass ], default: false
-      # default_env defaults to `false` so that the command execution more exactly matches what the user gets on the command line without magic
-      property :default_env, [ TrueClass, FalseClass ], desired_state: false, default: false,
-        description: "When true this enables ENV magic to add path_sanity to the PATH and force the locale to English+UTF-8 for parsing output"
-      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
-      property :sensitive, [ TrueClass, FalseClass ], default: lazy { |r| r.password ? true : false }
-
-      property :elevated, [ TrueClass, FalseClass ], default: false
-
-      def self.set_guard_inherited_attributes(*inherited_attributes)
-        @class_inherited_attributes = inherited_attributes
-      end
-
-      def self.guard_inherited_attributes(*inherited_attributes)
-        # Similar to patterns elsewhere, return attributes from this
-        # class and superclasses as a form of inheritance
-        ancestor_attributes = []
-
-        if superclass.respond_to?(:guard_inherited_attributes)
-          ancestor_attributes = superclass.guard_inherited_attributes
-        end
-
-        ancestor_attributes.concat(@class_inherited_attributes ? @class_inherited_attributes : []).uniq
-      end
-
-      def after_created
-        validate_identity_platform(user, password, domain, elevated)
-        identity = qualify_user(user, password, domain)
-        domain(identity[:domain])
-        user(identity[:user])
-      end
-
-      def validate_identity_platform(specified_user, password = nil, specified_domain = nil, elevated = false)
-        if node[:platform_family] == "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
-
-          if elevated && !specified_user && !password
-            raise ArgumentError, "`elevated` option should be passed only with `username` and `password`."
-          end
-        else
-          if password || specified_domain
-            raise Exceptions::UnsupportedPlatform, "Values for `domain` and `password` are only supported on the Windows platform"
-          end
-
-          if elevated
-            raise Exceptions::UnsupportedPlatform, "Value for `elevated` is only supported on the Windows platform"
-          end
-        end
-      end
-
-      def qualify_user(specified_user, password = nil, specified_domain = nil)
-        domain = specified_domain
-        user = specified_user
-
-        if specified_user.nil? && ! specified_domain.nil?
-          raise ArgumentError, "The domain `#{specified_domain}` was specified, but no user name was given"
-        end
-
-        # if domain is provided in both username and domain
-        if specified_user && ((specified_user.include? '\\') || (specified_user.include? "@")) && specified_domain
-          raise ArgumentError, "The domain is provided twice. Username: `#{specified_user}`, Domain: `#{specified_domain}`. Please specify domain only once."
-        end
-
-        if ! specified_user.nil? && specified_domain.nil?
-          # Splitting username of format: Domain\Username
-          domain_and_user = user.split('\\')
-
-          if domain_and_user.length == 2
-            domain = domain_and_user[0]
-            user = domain_and_user[1]
-          elsif domain_and_user.length == 1
-            # Splitting username of format: Username@Domain
-            domain_and_user = user.split("@")
-            if domain_and_user.length == 2
-              domain = domain_and_user[1]
-              user = domain_and_user[0]
-            elsif domain_and_user.length != 1
-              raise ArgumentError, "The specified user name `#{user}` is not a syntactically valid user name"
-            end
-          end
-        end
-
-        if ( password || domain ) && user.nil?
-          raise ArgumentError, "A value for `password` or `domain` was specified without specification of a value for `user`"
-        end
-
-        { domain: domain, user: user }
-      end
-
-      set_guard_inherited_attributes(
-        :cwd,
-        :environment,
-        :group,
-        :user,
-        :umask
-      )
-
-    end
-  end
-end
+#
+# Author:: Adam Jacob (<adam@chef.io>)
+# Author:: Tyler Cloke (<tyler@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"
+
+class Chef
+  class Resource
+    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.
+      # Only execute resources (and subclasses) can be guard interpreters.
+      attr_accessor :is_guard_interpreter
+
+      default_action :run
+
+      def initialize(name, run_context = nil)
+        super
+        @command = name
+        @backup = 5
+        @default_guard_interpreter = :execute
+        @is_guard_interpreter = false
+      end
+
+      def command(arg = nil)
+        set_or_return(
+          :command,
+          arg,
+          kind_of: [ String, Array ]
+        )
+      end
+      property :umask, [ String, Integer ],
+               description: "The file mode creation mask, or umask."
+
+      property :creates, String,
+               description: "Prevent a command from creating a file when that file already exists."
+
+      property :cwd, String,
+               description: "Set the current working directory before running a command."
+
+      property :environment, Hash,
+               description: "Specify a Hash of environment variables to be set."
+
+      alias :env :environment
+
+      property :group, [ String, Integer ],
+               description: "The group name or group ID that must be changed before running a command."
+
+      property :live_stream, [ TrueClass, FalseClass ], default: false,
+               description: "Send the output of the command run by this execute resource block to the chef-client event stream."
+
+      # default_env defaults to `false` so that the command execution more exactly matches what the user gets on the command line without magic
+      property :default_env, [ TrueClass, FalseClass ], desired_state: false, default: false,
+               introduced: "14.2",
+               description: "When true this enables ENV magic to add path_sanity to the PATH and force the locale to English+UTF-8 for parsing output"
+
+      property :returns, [ Integer, Array ], default: 0,
+               description: "The return value for a command. This may be an array of accepted values. An exception is raised when the return value(s) do not match."
+
+      property :timeout, [ Integer, Float ],
+               description: "The amount of time (in seconds) a command is to wait before timing out."
+
+      property :user, [ String, Integer ],
+               description: "The user name of the user identity with which to launch the new process. The user name may optionally be specifed with a domain, i.e. domainuser or user@my.dns.domain.com via Universal Principal Name (UPN)format. It can also be specified without a domain simply as user if the domain is instead specified using the domain attribute. On Windows only, if this property is specified, the password property must be specified."
+
+      property :domain, String,
+               introduced: "12.21",
+               description: "Windows only: The domain of the user user specified by the user property. If not specified, the user name and password specified by the user and password properties will be used to resolve that user against the domain in which the system running Chef client is joined, or if that system is not joined to a domain it will resolve the user as a local account on that system. An alternative way to specify the domain is to leave this property unspecified and specify the domain as part of the user property."
+
+      property :password, String, sensitive: true,
+               introduced: "12.21",
+               description: "Windows only: The password of the user specified by the user property. This property is mandatory if user is specified on Windows and may only be specified if user is specified. The sensitive property for this resource will automatically be set to true if password is specified."
+
+      # lazy used to set default value of sensitive to true if password is set
+      property :sensitive, [ TrueClass, FalseClass ], default: lazy { |r| r.password ? true : false }
+
+      property :elevated, [ TrueClass, FalseClass ], default: false,
+               introduced: "13.3"
+
+      def self.set_guard_inherited_attributes(*inherited_attributes)
+        @class_inherited_attributes = inherited_attributes
+      end
+
+      def self.guard_inherited_attributes(*inherited_attributes)
+        # Similar to patterns elsewhere, return attributes from this
+        # class and superclasses as a form of inheritance
+        ancestor_attributes = []
+
+        if superclass.respond_to?(:guard_inherited_attributes)
+          ancestor_attributes = superclass.guard_inherited_attributes
+        end
+
+        ancestor_attributes.concat(@class_inherited_attributes ? @class_inherited_attributes : []).uniq
+      end
+
+      def after_created
+        validate_identity_platform(user, password, domain, elevated)
+        identity = qualify_user(user, password, domain)
+        domain(identity[:domain])
+        user(identity[:user])
+      end
+
+      def validate_identity_platform(specified_user, password = nil, specified_domain = nil, elevated = false)
+        if node[:platform_family] == "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
+
+          if elevated && !specified_user && !password
+            raise ArgumentError, "`elevated` option should be passed only with `username` and `password`."
+          end
+        else
+          if password || specified_domain
+            raise Exceptions::UnsupportedPlatform, "Values for `domain` and `password` are only supported on the Windows platform"
+          end
+
+          if elevated
+            raise Exceptions::UnsupportedPlatform, "Value for `elevated` is only supported on the Windows platform"
+          end
+        end
+      end
+
+      def qualify_user(specified_user, password = nil, specified_domain = nil)
+        domain = specified_domain
+        user = specified_user
+
+        if specified_user.nil? && ! specified_domain.nil?
+          raise ArgumentError, "The domain `#{specified_domain}` was specified, but no user name was given"
+        end
+
+        # if domain is provided in both username and domain
+        if specified_user && ((specified_user.include? '\\') || (specified_user.include? "@")) && specified_domain
+          raise ArgumentError, "The domain is provided twice. Username: `#{specified_user}`, Domain: `#{specified_domain}`. Please specify domain only once."
+        end
+
+        if ! specified_user.nil? && specified_domain.nil?
+          # Splitting username of format: Domain\Username
+          domain_and_user = user.split('\\')
+
+          if domain_and_user.length == 2
+            domain = domain_and_user[0]
+            user = domain_and_user[1]
+          elsif domain_and_user.length == 1
+            # Splitting username of format: Username@Domain
+            domain_and_user = user.split("@")
+            if domain_and_user.length == 2
+              domain = domain_and_user[1]
+              user = domain_and_user[0]
+            elsif domain_and_user.length != 1
+              raise ArgumentError, "The specified user name `#{user}` is not a syntactically valid user name"
+            end
+          end
+        end
+
+        if ( password || domain ) && user.nil?
+          raise ArgumentError, "A value for `password` or `domain` was specified without specification of a value for `user`"
+        end
+
+        { domain: domain, user: user }
+      end
+
+      set_guard_inherited_attributes(
+        :cwd,
+        :environment,
+        :group,
+        :user,
+        :umask
+      )
+
+    end
+  end
+end