chef-utils 18.2.5 → 18.2.7

data/lib/chef-utils/dsl/which.rb

@@ -1,123 +1,123 @@
-# frozen_string_literal: true
-#
-# Copyright:: Copyright (c) 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_relative "../internal"
-
-module ChefUtils
-  module DSL
-    module Which
-      include Internal
-
-      # Lookup an executable through the systems search PATH.  Allows specifying an array
-      # of executables to look for.  The first executable that is found, along any path entry,
-      # will be the preferred one and returned first.  The extra_path will override any default
-      # extra_paths which are added (allowing the user to pass an empty array to remove them).
-      #
-      # When passed a block the block will be called with the full pathname of any executables
-      # which are found, and the block should return truthy or falsey values to further filter
-      # the executable based on arbitrary criteria.
-      #
-      # This is syntactic sugar for `where(...).first`
-      #
-      # This helper can be used in target mode in chef or with train using the appropriate
-      # wiring externally.
-      #
-      # @example Find the most appropriate python executable, searching through the system PATH
-      #          plus additionally the "/usr/libexec" directory, which has the dnf libraries
-      #          installed and available.
-      #
-      #   cmd = which("platform-python", "python", "python3", "python2", "python2.7", extra_path: "/usr/libexec") do |f|
-      #     shell_out("#{f} -c 'import dnf'").exitstatus == 0
-      #   end
-      #
-      # @param [Array<String>] list of commands to search for
-      # @param [String,Array<String>] array of extra paths to search through
-      # @return [String] the first match
-      #
-      def which(*cmds, extra_path: nil, &block)
-        where(*cmds, extra_path: extra_path, &block).first || false
-      end
-
-      # Lookup all the instances of an an executable that can be found through the systems search PATH.
-      # Allows specifying an array of executables to look for.  All the instances of the first executable
-      # that is found will be returned first.  The extra_path will override any default extra_paths
-      # which are added (allowing the user to pass an empty array to remove them).
-      #
-      # When passed a block the block will be called with the full pathname of any executables
-      # which are found, and the block should return truthy or falsey values to further filter
-      # the executable based on arbitrary criteria.
-      #
-      # This helper can be used in target mode in chef or with train using the appropriate
-      # wiring externally.
-      #
-      # @example Find all the python executables, searching through the system PATH plus additionally
-      #          the "/usr/libexec" directory, which have the dnf libraries installed and available.
-      #
-      #   cmds = where("platform-python", "python", "python3", "python2", "python2.7", extra_path: "/usr/libexec") do |f|
-      #     shell_out("#{f} -c 'import dnf'").exitstatus == 0
-      #   end
-      #
-      # @param [Array<String>] list of commands to search for
-      # @param [String,Array<String>] array of extra paths to search through
-      # @return [String] the first match
-      #
-      def where(*cmds, extra_path: nil, &block)
-        extra_path ||= __extra_path
-        paths = __env_path.split(File::PATH_SEPARATOR) + Array(extra_path)
-        paths.uniq!
-        exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : []
-        exts.unshift("")
-        cmds.map do |cmd|
-          paths.map do |path|
-            exts.map do |ext|
-              filename = File.join(path, "#{cmd}#{ext}")
-              filename if __valid_executable?(filename, &block)
-            end.compact
-          end
-        end.flatten
-      end
-
-      private
-
-      # This is for injecting common extra_paths into the search PATH.  The chef-client codebase overrides this into its
-      # own custom mixin to ensure that /usr/sbin, /sbin, etc are in the search PATH for chef-client.
-      #
-      # @api private
-      def __extra_path
-        nil
-      end
-
-      # Windows compatible and train/target-mode-enhanced helper to determine if an executable is valid.
-      #
-      # @api private
-      def __valid_executable?(filename, &block)
-        is_executable =
-          if __transport_connection
-            __transport_connection.file(filename).stat[:mode] & 1 && !__transport_connection.file(filename).directory?
-          else
-            File.executable?(filename) && !File.directory?(filename)
-          end
-        return false unless is_executable
-
-        block ? yield(filename) : true
-      end
-
-      extend self
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 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_relative "../internal"
+
+module ChefUtils
+  module DSL
+    module Which
+      include Internal
+
+      # Lookup an executable through the systems search PATH.  Allows specifying an array
+      # of executables to look for.  The first executable that is found, along any path entry,
+      # will be the preferred one and returned first.  The extra_path will override any default
+      # extra_paths which are added (allowing the user to pass an empty array to remove them).
+      #
+      # When passed a block the block will be called with the full pathname of any executables
+      # which are found, and the block should return truthy or falsey values to further filter
+      # the executable based on arbitrary criteria.
+      #
+      # This is syntactic sugar for `where(...).first`
+      #
+      # This helper can be used in target mode in chef or with train using the appropriate
+      # wiring externally.
+      #
+      # @example Find the most appropriate python executable, searching through the system PATH
+      #          plus additionally the "/usr/libexec" directory, which has the dnf libraries
+      #          installed and available.
+      #
+      #   cmd = which("platform-python", "python", "python3", "python2", "python2.7", extra_path: "/usr/libexec") do |f|
+      #     shell_out("#{f} -c 'import dnf'").exitstatus == 0
+      #   end
+      #
+      # @param [Array<String>] list of commands to search for
+      # @param [String,Array<String>] array of extra paths to search through
+      # @return [String] the first match
+      #
+      def which(*cmds, extra_path: nil, &block)
+        where(*cmds, extra_path: extra_path, &block).first || false
+      end
+
+      # Lookup all the instances of an an executable that can be found through the systems search PATH.
+      # Allows specifying an array of executables to look for.  All the instances of the first executable
+      # that is found will be returned first.  The extra_path will override any default extra_paths
+      # which are added (allowing the user to pass an empty array to remove them).
+      #
+      # When passed a block the block will be called with the full pathname of any executables
+      # which are found, and the block should return truthy or falsey values to further filter
+      # the executable based on arbitrary criteria.
+      #
+      # This helper can be used in target mode in chef or with train using the appropriate
+      # wiring externally.
+      #
+      # @example Find all the python executables, searching through the system PATH plus additionally
+      #          the "/usr/libexec" directory, which have the dnf libraries installed and available.
+      #
+      #   cmds = where("platform-python", "python", "python3", "python2", "python2.7", extra_path: "/usr/libexec") do |f|
+      #     shell_out("#{f} -c 'import dnf'").exitstatus == 0
+      #   end
+      #
+      # @param [Array<String>] list of commands to search for
+      # @param [String,Array<String>] array of extra paths to search through
+      # @return [String] the first match
+      #
+      def where(*cmds, extra_path: nil, &block)
+        extra_path ||= __extra_path
+        paths = __env_path.split(File::PATH_SEPARATOR) + Array(extra_path)
+        paths.uniq!
+        exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : []
+        exts.unshift("")
+        cmds.map do |cmd|
+          paths.map do |path|
+            exts.map do |ext|
+              filename = File.join(path, "#{cmd}#{ext}")
+              filename if __valid_executable?(filename, &block)
+            end.compact
+          end
+        end.flatten
+      end
+
+      private
+
+      # This is for injecting common extra_paths into the search PATH.  The chef-client codebase overrides this into its
+      # own custom mixin to ensure that /usr/sbin, /sbin, etc are in the search PATH for chef-client.
+      #
+      # @api private
+      def __extra_path
+        nil
+      end
+
+      # Windows compatible and train/target-mode-enhanced helper to determine if an executable is valid.
+      #
+      # @api private
+      def __valid_executable?(filename, &block)
+        is_executable =
+          if __transport_connection
+            __transport_connection.file(filename).stat[:mode] & 1 && !__transport_connection.file(filename).directory?
+          else
+            File.executable?(filename) && !File.directory?(filename)
+          end
+        return false unless is_executable
+
+        block ? yield(filename) : true
+      end
+
+      extend self
+    end
+  end
+end

data/lib/chef-utils/dsl/windows.rb

@@ -1,86 +1,86 @@
-# frozen_string_literal: true
-#
-# Copyright:: Copyright (c) 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_relative "../internal"
-
-module ChefUtils
-  module DSL
-    module Windows
-      require_relative "../version_string"
-
-      include Internal
-
-      # Determine if the current node is Windows Server Core.
-      #
-      # @param [Chef::Node] node the node to check
-      # @since 15.7
-      #
-      # @return [Boolean]
-      #
-      def windows_server_core?(node = __getnode)
-        node["kernel"]["server_core"] == true
-      end
-
-      # Determine if the current node is Windows Workstation.
-      #
-      # @param [Chef::Node] node the node to check
-      # @since 15.7
-      #
-      # @return [Boolean]
-      #
-      def windows_workstation?(node = __getnode)
-        node["kernel"]["product_type"] == "Workstation"
-      end
-
-      # Determine if the current node is Windows Server.
-      #
-      # @param [Chef::Node] node the node to check
-      # @since 15.7
-      #
-      # @return [Boolean]
-      #
-      def windows_server?(node = __getnode)
-        node["kernel"]["product_type"] == "Server"
-      end
-
-      # Determine the current Windows NT version. The NT version often differs from the marketing version, but offers a good way to find desktop and server releases that are based on the same codebase. For example NT 6.3 corresponds to Windows 8.1 and Windows 2012 R2.
-      #
-      # @param [Chef::Node] node the node to check
-      # @since 15.8
-      #
-      # @return [ChefUtils::VersionString]
-      #
-      def windows_nt_version(node = __getnode)
-        ChefUtils::VersionString.new(node["os_version"])
-      end
-
-      # Determine the installed version of PowerShell.
-      #
-      # @param [Chef::Node] node the node to check
-      # @since 15.8
-      #
-      # @return [ChefUtils::VersionString]
-      #
-      def powershell_version(node = __getnode)
-        ChefUtils::VersionString.new(node["languages"]["powershell"]["version"])
-      end
-
-      extend self
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 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_relative "../internal"
+
+module ChefUtils
+  module DSL
+    module Windows
+      require_relative "../version_string"
+
+      include Internal
+
+      # Determine if the current node is Windows Server Core.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.7
+      #
+      # @return [Boolean]
+      #
+      def windows_server_core?(node = __getnode)
+        node["kernel"]["server_core"] == true
+      end
+
+      # Determine if the current node is Windows Workstation.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.7
+      #
+      # @return [Boolean]
+      #
+      def windows_workstation?(node = __getnode)
+        node["kernel"]["product_type"] == "Workstation"
+      end
+
+      # Determine if the current node is Windows Server.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.7
+      #
+      # @return [Boolean]
+      #
+      def windows_server?(node = __getnode)
+        node["kernel"]["product_type"] == "Server"
+      end
+
+      # Determine the current Windows NT version. The NT version often differs from the marketing version, but offers a good way to find desktop and server releases that are based on the same codebase. For example NT 6.3 corresponds to Windows 8.1 and Windows 2012 R2.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
+      #
+      # @return [ChefUtils::VersionString]
+      #
+      def windows_nt_version(node = __getnode)
+        ChefUtils::VersionString.new(node["os_version"])
+      end
+
+      # Determine the installed version of PowerShell.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
+      #
+      # @return [ChefUtils::VersionString]
+      #
+      def powershell_version(node = __getnode)
+        ChefUtils::VersionString.new(node["languages"]["powershell"]["version"])
+      end
+
+      extend self
+    end
+  end
+end

data/lib/chef-utils/internal.rb

@@ -1,114 +1,114 @@
-# frozen_string_literal: true
-#
-# Copyright:: Copyright (c) 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.
-#
-
-module ChefUtils
-  #
-  # This is glue code to make the helpers work when called as ChefUtils.helper? from inside of chef-client.
-  #
-  # This also is glue code to make the helpers work when mixed into classes that have node/run_context methods that
-  # provide those objects.
-  #
-  # It should not be assumed that any of this code runs from within chef-client and that the
-  # Chef class or run_context, etc exists.
-  #
-  # This gem may be used by gems like mixlib-shellout which can be consumed by external non-Chef utilities,
-  # so including brittle code here which depends on the existence of the chef-client will cause broken
-  # behavior downstream.  You must practice defensive coding, and not make assumptions about running within chef-client.
-  #
-  # Other consumers may mix in the helper classes and then override the methods here and provide their own custom
-  # wiring and override what is provided here.  They are marked as private because no downstream user should ever touch
-  # them -- they are intended to be subclassable and overridable by Chef developers in other projects.  Chef Software
-  # reserves the right to change the implementation details of this class in minor revs which is what "api private" means,
-  # so external persons should subclass and override only when necessary (submit PRs and issues upstream if this is a problem).
-  #
-  module Internal
-    extend self
-
-    private
-
-    # This should be set to a Chef::Node instance or to some Hash/Mash-like configuration object with the same keys.  It needs to
-    # expose keys like `:os`, `:platform`, `:platform_version` and `:platform_family` at least to be useful.  It will automatically
-    # pick up a `node` method when mixed into an object that has that as a method (which is the encouraged "public" API to use
-    # for dependency injection rather than overriding the method in this case.
-    #
-    # @return [Hash] hash-like config object
-    #
-    # @api private
-    def __getnode(skip_global = false)
-      # Software developers should feel free to rely on the default wiring here to the node method by implementing the node method in their
-      # own class.  For anything more complicated they should completely override the method (overriding the whole method is never wrong and
-      # is safer).
-      return node if respond_to?(:node) && node
-
-      return run_context&.node if respond_to?(:run_context) && run_context&.node
-
-      unless skip_global
-        return Chef.run_context&.node if defined?(Chef) && Chef.respond_to?(:run_context) && Chef.run_context&.node
-      end
-
-      nil
-    end
-
-    # Just a helper to pull the ENV["PATH"] in a train-independent way
-    #
-    # @api private
-    #
-    def __env_path
-      if __transport_connection
-        __transport_connection.run_command("echo $PATH").stdout.chomp || ""
-      else
-        ENV["PATH"] || ""
-      end
-    end
-
-    # This should be set to a Train::Plugins::Transport instance.  You should wire this up to nil for not using a train transport connection.
-    #
-    # @return [Train::Plugins::Transport]
-    #
-    # @api private
-    #
-    def __transport_connection
-      # Software consumers MUST override this method with their own implementation.  The default behavior here is subject to change.
-      return Chef.run_context.transport_connection if defined?(Chef) && Chef.respond_to?(:run_context) && Chef&.run_context&.transport_connection
-
-      nil
-    end
-
-    # This should be set to Chef::Config or to some Hash/Mash-like configuration object with the same keys.  It must not be nil.
-    #
-    # @return [Hash] hash-like config object
-    #
-    # @api private
-    #
-    def __config
-      raise NotImplementedError
-    end
-
-    # This should be set to Chef::Log or something that duck-types like it.  It must not be nil.
-    #
-    # @return [Chef::Log] logger-like logging object
-    #
-    # @api private
-    #
-    def __log
-      raise NotImplementedError
-    end
-
-    extend self
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 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.
+#
+
+module ChefUtils
+  #
+  # This is glue code to make the helpers work when called as ChefUtils.helper? from inside of chef-client.
+  #
+  # This also is glue code to make the helpers work when mixed into classes that have node/run_context methods that
+  # provide those objects.
+  #
+  # It should not be assumed that any of this code runs from within chef-client and that the
+  # Chef class or run_context, etc exists.
+  #
+  # This gem may be used by gems like mixlib-shellout which can be consumed by external non-Chef utilities,
+  # so including brittle code here which depends on the existence of the chef-client will cause broken
+  # behavior downstream.  You must practice defensive coding, and not make assumptions about running within chef-client.
+  #
+  # Other consumers may mix in the helper classes and then override the methods here and provide their own custom
+  # wiring and override what is provided here.  They are marked as private because no downstream user should ever touch
+  # them -- they are intended to be subclassable and overridable by Chef developers in other projects.  Chef Software
+  # reserves the right to change the implementation details of this class in minor revs which is what "api private" means,
+  # so external persons should subclass and override only when necessary (submit PRs and issues upstream if this is a problem).
+  #
+  module Internal
+    extend self
+
+    private
+
+    # This should be set to a Chef::Node instance or to some Hash/Mash-like configuration object with the same keys.  It needs to
+    # expose keys like `:os`, `:platform`, `:platform_version` and `:platform_family` at least to be useful.  It will automatically
+    # pick up a `node` method when mixed into an object that has that as a method (which is the encouraged "public" API to use
+    # for dependency injection rather than overriding the method in this case.
+    #
+    # @return [Hash] hash-like config object
+    #
+    # @api private
+    def __getnode(skip_global = false)
+      # Software developers should feel free to rely on the default wiring here to the node method by implementing the node method in their
+      # own class.  For anything more complicated they should completely override the method (overriding the whole method is never wrong and
+      # is safer).
+      return node if respond_to?(:node) && node
+
+      return run_context&.node if respond_to?(:run_context) && run_context&.node
+
+      unless skip_global
+        return Chef.run_context&.node if defined?(Chef) && Chef.respond_to?(:run_context) && Chef.run_context&.node
+      end
+
+      nil
+    end
+
+    # Just a helper to pull the ENV["PATH"] in a train-independent way
+    #
+    # @api private
+    #
+    def __env_path
+      if __transport_connection
+        __transport_connection.run_command("echo $PATH").stdout.chomp || ""
+      else
+        ENV["PATH"] || ""
+      end
+    end
+
+    # This should be set to a Train::Plugins::Transport instance.  You should wire this up to nil for not using a train transport connection.
+    #
+    # @return [Train::Plugins::Transport]
+    #
+    # @api private
+    #
+    def __transport_connection
+      # Software consumers MUST override this method with their own implementation.  The default behavior here is subject to change.
+      return Chef.run_context.transport_connection if defined?(Chef) && Chef.respond_to?(:run_context) && Chef&.run_context&.transport_connection
+
+      nil
+    end
+
+    # This should be set to Chef::Config or to some Hash/Mash-like configuration object with the same keys.  It must not be nil.
+    #
+    # @return [Hash] hash-like config object
+    #
+    # @api private
+    #
+    def __config
+      raise NotImplementedError
+    end
+
+    # This should be set to Chef::Log or something that duck-types like it.  It must not be nil.
+    #
+    # @return [Chef::Log] logger-like logging object
+    #
+    # @api private
+    #
+    def __log
+      raise NotImplementedError
+    end
+
+    extend self
+  end
+end