chef-utils 0.0.1 → 15.5.9

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

@@ -0,0 +1,118 @@
+#
+# Copyright:: Copyright 2018-2019, 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 (allwing 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 extenerally.
+      #
+      # @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 (allwing 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 extenerally.
+      #
+      # @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!
+        cmds.map do |cmd|
+          paths.map do |path|
+            filename = File.join(path, cmd)
+            filename if __valid_executable?(filename, &block)
+          end.compact
+        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/internal.rb

@@ -0,0 +1,77 @@
+#
+# Copyright:: Copyright 2018-2019, 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 runnign 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
+
+    # FIXME: include a `__config` method so we can wire up Chef::Config automatically or allow other consumers to
+    # inject a config hash without having to take a direct dep on the chef-config gem
+
+    # @api private
+    def __getnode(skip_global = false)
+      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
+
+    # @api private
+    def __env_path
+      if __transport_connection
+        __transport_connection.run_command("echo $PATH").stdout || ""
+      else
+        ENV["PATH"] || ""
+      end
+    end
+
+    # @api private
+    def __transport_connection
+      return Chef.run_context.transport_connection if defined?(Chef) && Chef.respond_to?(:run_context) && Chef&.run_context&.transport_connection
+
+      nil
+    end
+
+    extend self
+  end
+end

data/lib/chef-utils/mash.rb

@@ -0,0 +1,239 @@
+# Copyright 2009-2016, Dan Kubb
+
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# ---
+# ---
+
+# Some portions of blank.rb and mash.rb are verbatim copies of software
+# licensed under the MIT license. That license is included below:
+
+# Copyright 2005-2016, David Heinemeier Hansson
+
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# This class has dubious semantics and we only have it so that people can write
+# params[:key] instead of params['key'].
+module ChefUtils
+  class Mash < Hash
+
+    # @param constructor<Object>
+    #   The default value for the mash. Defaults to an empty hash.
+    #
+    # @details [Alternatives]
+    #   If constructor is a Hash, a new mash will be created based on the keys of
+    #   the hash and no default value will be set.
+    def initialize(constructor = {})
+      if constructor.is_a?(Hash)
+        super()
+        update(constructor)
+      else
+        super(constructor)
+      end
+    end
+
+    # @param orig<Object> Mash being copied
+    #
+    # @return [Object] A new copied Mash
+    def initialize_copy(orig)
+      super
+      # Handle nested values
+      each do |k, v|
+        if v.is_a?(Mash) || v.is_a?(Array)
+          self[k] = v.dup
+        end
+      end
+      self
+    end
+
+    # @param key<Object> The default value for the mash. Defaults to nil.
+    #
+    # @details [Alternatives]
+    #   If key is a Symbol and it is a key in the mash, then the default value will
+    #   be set to the value matching the key.
+    def default(key = nil)
+      if key.is_a?(Symbol) && include?(key = key.to_s)
+        self[key]
+      else
+        super
+      end
+    end
+
+    unless method_defined?(:regular_writer)
+      alias_method :regular_writer, :[]=
+    end
+
+    unless method_defined?(:regular_update)
+      alias_method :regular_update, :update
+    end
+
+    # @param key<Object> The key to set.
+    # @param value<Object>
+    #   The value to set the key to.
+    #
+    # @see Mash#convert_key
+    # @see Mash#convert_value
+    def []=(key, value)
+      regular_writer(convert_key(key), convert_value(value))
+    end
+
+    # internal API for use by Chef's deep merge cache
+    # @api private
+    def internal_set(key, value)
+      regular_writer(key, convert_value(value))
+    end
+
+    # @param other_hash<Hash>
+    #   A hash to update values in the mash with. The keys and the values will be
+    #   converted to Mash format.
+    #
+    # @return [Mash] The updated mash.
+    def update(other_hash)
+      other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
+      self
+    end
+
+    alias_method :merge!, :update
+
+    # @param key<Object> The key to check for. This will be run through convert_key.
+    #
+    # @return [Boolean] True if the key exists in the mash.
+    def key?(key)
+      super(convert_key(key))
+    end
+
+    # def include? def has_key? def member?
+    alias_method :include?, :key?
+    alias_method :has_key?, :key?
+    alias_method :member?, :key?
+
+    # @param key<Object> The key to fetch. This will be run through convert_key.
+    # @param *extras<Array> Default value.
+    #
+    # @return [Object] The value at key or the default value.
+    def fetch(key, *extras)
+      super(convert_key(key), *extras)
+    end
+
+    # @param *indices<Array>
+    #   The keys to retrieve values for. These will be run through +convert_key+.
+    #
+    # @return [Array] The values at each of the provided keys
+    def values_at(*indices)
+      indices.collect { |key| self[convert_key(key)] }
+    end
+
+    # @param hash<Hash> The hash to merge with the mash.
+    #
+    # @return [Mash] A new mash with the hash values merged in.
+    def merge(hash)
+      dup.update(hash)
+    end
+
+    # @param key<Object>
+    #   The key to delete from the mash.\
+    def delete(key)
+      super(convert_key(key))
+    end
+
+    # @param *rejected<Array[(String, Symbol)] The mash keys to exclude.
+    #
+    # @return [Mash] A new mash without the selected keys.
+    #
+    # @example
+    #   { :one => 1, :two => 2, :three => 3 }.except(:one)
+    #     #=> { "two" => 2, "three" => 3 }
+    def except(*keys)
+      super(*keys.map { |k| convert_key(k) })
+    end
+
+    # Used to provide the same interface as Hash.
+    #
+    # @return [Mash] This mash unchanged.
+    def stringify_keys!; self end
+
+    # @return [Hash] The mash as a Hash with symbolized keys.
+    def symbolize_keys
+      h = Hash.new(default)
+      each { |key, val| h[key.to_sym] = val }
+      h
+    end
+
+    # @return [Hash] The mash as a Hash with string keys.
+    def to_hash
+      Hash.new(default).merge(self)
+    end
+
+    # @return [Mash] Convert a Hash into a Mash
+    # The input Hash's default value is maintained
+    def self.from_hash(hash)
+      mash = Mash.new(hash)
+      mash.default = hash.default
+      mash
+    end
+
+    protected
+
+    # @param key<Object> The key to convert.
+    #
+    # @param [Object]
+    #   The converted key. If the key was a symbol, it will be converted to a
+    #   string.
+    #
+    # @api private
+    def convert_key(key)
+      key.is_a?(Symbol) ? key.to_s : key
+    end
+
+    # @param value<Object> The value to convert.
+    #
+    # @return [Object]
+    #   The converted value. A Hash or an Array of hashes, will be converted to
+    #   their Mash equivalents.
+    #
+    # @api private
+    def convert_value(value)
+      if value.class == Hash
+        Mash.from_hash(value)
+      elsif value.is_a?(Array)
+        value.collect { |e| convert_value(e) }
+      else
+        value
+      end
+    end
+  end
+end

data/lib/chef-utils/version.rb

@@ -15,5 +15,5 @@
 
 module ChefUtils
   CHEFUTILS_ROOT = File.expand_path("../..", __FILE__)
-  VERSION = "0.0.1".freeze
+  VERSION = "15.5.9".freeze
 end

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+require "chef-utils"
+
+# FIXME: dynamically generate this for accuracy
+HELPER_MODULES = [
+  ChefUtils::DSL::Architecture,
+  ChefUtils::DSL::Introspection,
+  ChefUtils::DSL::OS,
+  ChefUtils::DSL::PathSanity,
+  ChefUtils::DSL::Platform,
+  ChefUtils::DSL::PlatformFamily,
+  ChefUtils::DSL::Service,
+  ChefUtils::DSL::Which,
+].freeze
+
+ARCH_HELPERS = (ChefUtils::DSL::Architecture.methods - Module.methods).freeze
+OS_HELPERS = (ChefUtils::DSL::OS.methods - Module.methods).freeze
+PLATFORM_HELPERS = (ChefUtils::DSL::Platform.methods - Module.methods).freeze
+PLATFORM_FAMILY_HELPERS = (ChefUtils::DSL::PlatformFamily.methods - Module.methods).freeze
+INTROSPECTION_HELPERS = (ChefUtils::DSL::Introspection.methods - Module.methods).freeze
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.filter_run_excluding windows_only: true unless ChefUtils.windows?
+  config.filter_run_excluding unix_only: true if ChefUtils.windows?
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end