fauxhai-chef 9.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 896ab0477428745f79a22d289f737627005f135db4ba96f3a6a76d0cfc35ae9f
+  data.tar.gz: b871054d36602a4ac4f0b13f719bd7fedd2386524ca957622fa38d57e188494f
+SHA512:
+  metadata.gz: bacb0390cf12ecb08c65229817560e2fa36dd89827f0db65b9df01649d827a5f9932f8db925f4f5108fdeb890a8f1accf3bc156af62944f4d125a5022cf33942
+  data.tar.gz: 2b6764d05de53b65393c387165cf48d43e23fed98f75ba605c8720f4aad23e49de14f991689159a6e7366ee2c38132855dc472d4f3d230f89095c6505d8390b2

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Seth Vargo and CustomInk, LCC
+
+MIT License
+
+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.

data/bin/fauxhai

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + "../../lib")
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+args = ARGV.dup
+ARGV.clear
+
+unless (args & ["-v", "--version"]).empty?
+  require "fauxhai/version"
+  puts Fauxhai::VERSION
+  exit(0)
+end
+
+unless (args & ["-h", "--help"]).empty?
+  puts "Usage: fauxhai"
+  puts "(There are no flags or options)"
+  exit(0)
+end
+
+require "fauxhai"
+require "fauxhai/runner"
+Fauxhai::Runner.new(args)

data/fauxhai-chef.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+require "fauxhai/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fauxhai-chef"
+  spec.version       = Fauxhai::VERSION
+  spec.authors       = ["Seth Vargo", "Tim Smith"]
+  spec.email         = ["sethvargo@gmail.com", "tsmith84@gmail.com"]
+  spec.description   = "Easily mock out ohai data"
+  spec.summary       = "Fauxhai provides an easy way to mock out your ohai data for testing with chefspec!"
+  spec.homepage      = "https://github.com/chef/fauxhai"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.7"
+
+  spec.files         = %w{LICENSE Gemfile fauxhai-chef.gemspec} + Dir.glob("{lib,bin}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
+  spec.executables   = "fauxhai"
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "net-ssh"
+
+  spec.add_development_dependency "chef", ">= 13.0"
+  spec.add_development_dependency "ohai", ">= 13.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "rspec-its", "~> 1.2"
+end

data/lib/fauxhai/exception.rb

@@ -0,0 +1,6 @@
+module Fauxhai
+  module Exception
+    class InvalidPlatform < ArgumentError; end
+    class InvalidVersion < ArgumentError; end
+  end
+end

data/lib/fauxhai/fetcher.rb

@@ -0,0 +1,80 @@
+require "digest/sha1"
+require "json" unless defined?(JSON)
+
+module Fauxhai
+  class Fetcher
+    def initialize(options = {}, &override_attributes)
+      @options = options
+
+      if !force_cache_miss? && cached?
+        @data = cache
+      else
+        require "net/ssh" unless defined?(Net::SSH)
+        Net::SSH.start(host, user, @options) do |ssh|
+          @data = JSON.parse(ssh.exec!("ohai"))
+        end
+
+        # cache this data so we do not have to SSH again
+        File.open(cache_file, "w+") { |f| f.write(@data.to_json) }
+      end
+
+      yield(@data) if block_given?
+
+      if defined?(ChefSpec)
+        data = @data
+        ::ChefSpec::Runner.send :define_method, :fake_ohai do |ohai|
+          data.each_pair do |attribute, value|
+            ohai[attribute] = value
+          end
+        end
+      end
+
+      @data
+    end
+
+    def cache
+      @cache ||= JSON.parse(File.read(cache_file))
+    end
+
+    def cached?
+      File.exist?(cache_file)
+    end
+
+    def cache_key
+      Digest::SHA2.hexdigest("#{user}@#{host}")
+    end
+
+    def cache_file
+      File.expand_path(File.join(Fauxhai.root, "tmp", cache_key))
+    end
+
+    def force_cache_miss?
+      @force_cache_miss ||= @options.delete(:force_cache_miss) || false
+    end
+
+    # Return the given `@data` attribute as a Ruby hash instead of a JSON object
+    #
+    # @return [Hash] the `@data` represented as a Ruby hash
+    def to_hash(*args)
+      @data.to_hash(*args)
+    end
+
+    def to_s
+      "#<Fauxhai::Fetcher @host=#{host}, @options=#{@options}>"
+    end
+
+    private
+
+    def host
+      @host ||= begin
+        raise ArgumentError, ":host is a required option for Fauxhai.fetch" unless @options[:host]
+
+        @options.delete(:host)
+      end
+    end
+
+    def user
+      @user ||= (@options.delete(:user) || ENV["USER"] || ENV["USERNAME"]).chomp
+    end
+  end
+end

data/lib/fauxhai/keys/id_dsa

@@ -0,0 +1,12 @@
+-----BEGIN DSA PRIVATE KEY-----
+MIIBvAIBAAKBgQCRaPQSwMOFihLOYYIqZOZuNtxcwbA1wmUjHAvXGv6Jv9VWMzKi
+JosRnt7iAg8zRVFsRaCyU0ADnHMs6OjF2YkKsFiQyxYuajkq+sNl3DMhPs3eMDsj
+KA4lTOX4s5hvCtxc66rxo8AXB3AXTkJ2r0oo6I9/AzduSfc4a4neQWOFpQIVAPFe
+sLIbnZcLOfcVXh6PfzAkGSiZAoGAaLxjyeJj9j+gSvJR5dDz25LcEG1paSdd6M+k
+RCRQ1XFIu71dum1/wY0F/qIc2UM5Y3c9UqVGz3P/J7gOHWq2JFYfdXgYt9OxDfCH
+cUR49ngYKf2RuMrISHmxt1h68CQ/8VI42dTEX8g09Xq5lYuC744z4Fg8S2Zz6TGk
+ektZ84ECgYEAj0Vd6DCWslvlsZ8+N53HWsqPi3gnx35JoLPz9Z2epkKIKqmEHav+
+93G3hdfztVa4I4t3phoPniQchYryF5+RNg8hqxKzjNtrIqUYCeuf2NJrksNsH7OZ
+ygPHZpqt4kTuwAGZxjxEGfAI0y8DhkU2ntp2LnzRnWH106BQBCmcXwoCFQDry5iu
+Lv4xvy0I7w/bDtXIGj5RYA==
+-----END DSA PRIVATE KEY-----

data/lib/fauxhai/keys/id_dsa.pub

@@ -0,0 +1 @@
+ssh-dss AAAAB3NzaC1kc3MAAACBAJFo9BLAw4WKEs5hgipk5m423FzBsDXCZSMcC9ca/om/1VYzMqImixGe3uICDzNFUWxFoLJTQAOccyzo6MXZiQqwWJDLFi5qOSr6w2XcMyE+zd4wOyMoDiVM5fizmG8K3FzrqvGjwBcHcBdOQnavSijoj38DN25J9zhrid5BY4WlAAAAFQDxXrCyG52XCzn3FV4ej38wJBkomQAAAIBovGPJ4mP2P6BK8lHl0PPbktwQbWlpJ13oz6REJFDVcUi7vV26bX/BjQX+ohzZQzljdz1SpUbPc/8nuA4darYkVh91eBi307EN8IdxRHj2eBgp/ZG4yshIebG3WHrwJD/xUjjZ1MRfyDT1ermVi4LvjjPgWDxLZnPpMaR6S1nzgQAAAIEAj0Vd6DCWslvlsZ8+N53HWsqPi3gnx35JoLPz9Z2epkKIKqmEHav+93G3hdfztVa4I4t3phoPniQchYryF5+RNg8hqxKzjNtrIqUYCeuf2NJrksNsH7OZygPHZpqt4kTuwAGZxjxEGfAI0y8DhkU2ntp2LnzRnWH106BQBCmcXwo= fauxhai.local

data/lib/fauxhai/keys/id_rsa

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEpAIBAAKCAQEArSwnqraq/x25zkXJMNbpHS4aXxqDjxYuf3rChKJM06qtYLIE
+NlfHppso36tYul130bUgcZHZR7/xlnT+cAU7hNhvOTMwZFUkD75sEDfJV/yTDxBL
+Sl5HjqNKPdvz4kpr2OHkbHRdJsONFL4O47RN3938Y+Pe5M4eXyrZKx5xeMfYFwm1
+Xa9xalyX4IEeSCcAMU6Hq2yu8f7kUvu2LmSPT4qd7bdeJ7/Xs8F3Lhm/7b41jmSD
+YhZfIs1SBSou7MX019PaeDYGpsUUu0w9mHdI0/JxKBfVGU7IF3CdZA0sezezcRXz
+Xz+qwnThkUc+IFIV7bFIxv15MT3gsGewPVZzgwIDAQABAoIBAHgnSt6IH90jIuic
+QxxAAT7d3i5elymQmnKZGp4sfmHe6q1M1t9dyIkw3wtSOB4W/CvlIL2sFLZT16wt
+QN04xDNIeOOXQNxctsi1twUJsAn8lYy+IX9YKw4s/jYthupb+LhjA7q8gmWDCUB7
+HpmfYOkTfStR0DWxTiF5+XSRiunhmz0qidpAA0Rv8Fz5B1PL7zI0yyV1oJwVATc8
+f1wEl53TDel+udwJ5rnWihiJMehLqsAa68WkQIOig77Logrz+WybMQYpF3D3SqRL
+cx0vc2cStbvnpcuG8UtAz61fi029rkWmAj6sa7BSgngFXphCezZ9dFDBtahc+Kzw
+ncMsyAECgYEA0++mKDq2oMN+i7Nc1VcvmfwxtkWMK6y+qusVpEhJB/u6E0Adxdxa
+wHuRhiD623lGHduzHxO8GqSKAFSR5KDOwcDFduiq/K9f2rHJE4eL3BHnm28/0T0e
+2VGYXebs4IPxuGjpNOAWPw/jo0tMSU+xr7ajELi3PU5DAD1SUiHJWaECgYEA0S1N
+LC+1Fz9ZsmL0hQpwoGhvKeLmbHinSbskovczMtI5JUU4HLzfCjovMuct93PxOsMO
+Gsy7J/v+dVpk8P4x58g2ZYjpF98r9lLkIs+wa7r7XAkHBqJ3SrrA2z4qm1bijr15
+/HGRT8q33umESYBFfdrbiN2CMHrs/72dgSBbIqMCgYEAtN5e1RJWbZipVJv76+3+
+J9H8sutjlppUFhWOYKd3/CIuSON9BTDrGj3akbdvnwI+fpjSowD6lVo6k9GYuJ8s
+FFppqvMhiYg5q6/yRIJ3L5bwK8yjj/QzcY+bEvhSy8CO96xA6ekb0zHCOce3ERG8
+OJMLUufxKZayw2+R45oF9kECgYEAsn3Yk3LmMT8ymADOrFP7RTW4XeKrQzY1cboK
+ijEsdBpk/wOw3PzhygVaTzJry/MYjk7xUzcOIRFr0dHfvrD5/tGecUfBt0gNaHTV
+DUtyPItif+eIIkYySwdPGAZVLxaV3r2aQSrbl13hRoq3Ak09fyZpHMH/nMTYRWYU
+56GngscCgYB3/vF1j+fxoqjhecMuhxNB3KDxuj3kW6ZBFC1yI3tsiHU+cTDBzdlG
+fANBAUvFxMyd7FV8DxRKsfv+YX4U3oET2SB5xxVyZZ5km+X4nWdzJdEXl2JNiBCr
+yDsMDWkmavqDJTZkngJnQ43pwdEOZlv8ePLj453YcVGACziizDlsyw==
+-----END RSA PRIVATE KEY-----

data/lib/fauxhai/keys/id_rsa.pub

@@ -0,0 +1 @@
+ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCtLCeqtqr/HbnORckw1ukdLhpfGoOPFi5/esKEokzTqq1gsgQ2V8emmyjfq1i6XXfRtSBxkdlHv/GWdP5wBTuE2G85MzBkVSQPvmwQN8lX/JMPEEtKXkeOo0o92/PiSmvY4eRsdF0mw40Uvg7jtE3f3fxj497kzh5fKtkrHnF4x9gXCbVdr3FqXJfggR5IJwAxToerbK7x/uRS+7YuZI9Pip3tt14nv9ezwXcuGb/tvjWOZINiFl8izVIFKi7sxfTX09p4NgamxRS7TD2Yd0jT8nEoF9UZTsgXcJ1kDSx7N7NxFfNfP6rCdOGRRz4gUhXtsUjG/XkxPeCwZ7A9VnOD fauxhai.local

data/lib/fauxhai/mocker.rb

@@ -0,0 +1,143 @@
+require "json" unless defined?(JSON)
+require "pathname" unless defined?(Pathname)
+
+module Fauxhai
+  class Mocker
+    # The base URL for the GitHub project (raw)
+    RAW_BASE = "https://raw.githubusercontent.com/chefspec/fauxhai/master".freeze
+
+    # A message about where to find a list of platforms
+    PLATFORM_LIST_MESSAGE = "A list of available platforms is available at https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md".freeze
+
+    # Create a new Ohai Mock with fauxhai.
+    #
+    # @param [Hash] options
+    #   the options for the mocker
+    # @option options [String] :platform
+    #   the platform to mock
+    # @option options [String] :version
+    #   the version of the platform to mock
+    # @option options [String] :path
+    #   the path to a local JSON file
+    # @option options [Bool] :github_fetching
+    #   whether to try loading from Github
+    def initialize(options = {}, &override_attributes)
+      @options = { github_fetching: true }.merge(options)
+
+      yield(data) if block_given?
+    end
+
+    def data
+      @fauxhai_data ||= lambda do
+        # If a path option was specified, use it
+        if @options[:path]
+          filepath = File.expand_path(@options[:path])
+
+          unless File.exist?(filepath)
+            raise Fauxhai::Exception::InvalidPlatform.new("You specified a path to a JSON file on the local system that does not exist: '#{filepath}'")
+          end
+        else
+          filepath = File.join(platform_path, "#{version}.json")
+        end
+
+        if File.exist?(filepath)
+          parse_and_validate(File.read(filepath))
+        elsif @options[:github_fetching]
+          # Try loading from github (in case someone submitted a PR with a new file, but we haven't
+          # yet updated the gem version). Cache the response locally so it's faster next time.
+          require "open-uri" unless defined?(OpenURI)
+          begin
+            response = URI.open("#{RAW_BASE}/lib/fauxhai/platforms/#{platform}/#{version}.json")
+          rescue OpenURI::HTTPError
+            raise Fauxhai::Exception::InvalidPlatform.new("Could not find platform '#{platform}/#{version}' on the local disk and an HTTP error was encountered when fetching from Github. #{PLATFORM_LIST_MESSAGE}")
+          end
+
+          if response.status.first.to_i == 200
+            response_body = response.read
+            path = Pathname.new(filepath)
+            FileUtils.mkdir_p(path.dirname)
+
+            begin
+              File.open(filepath, "w") { |f| f.write(response_body) }
+            rescue Errno::EACCES # a pretty common problem in CI systems
+              puts "Fetched '#{platform}/#{version}' from GitHub, but could not write to the local path: #{filepath}. Fix the local file permissions to avoid downloading this file every run."
+            end
+            return parse_and_validate(response_body)
+          else
+            raise Fauxhai::Exception::InvalidPlatform.new("Could not find platform '#{platform}/#{version}' on the local disk and an Github fetching returned http error code #{response.status.first.to_i}! #{PLATFORM_LIST_MESSAGE}")
+          end
+        else
+          raise Fauxhai::Exception::InvalidPlatform.new("Could not find platform '#{platform}/#{version}' on the local disk and Github fetching is disabled! #{PLATFORM_LIST_MESSAGE}")
+        end
+      end.call
+    end
+
+    private
+
+    # As major releases of Ohai ship it's difficult and sometimes impossible
+    # to regenerate all fauxhai data. This allows us to deprecate old releases
+    # and eventually remove them while giving end users ample warning.
+    def parse_and_validate(unparsed_data)
+      parsed_data = JSON.parse(unparsed_data)
+      if parsed_data["deprecated"]
+        STDERR.puts "WARNING: Fauxhai platform data for #{parsed_data["platform"]} #{parsed_data["platform_version"]} is deprecated and will be removed in the 10.0 release 3/2022. #{PLATFORM_LIST_MESSAGE}"
+      end
+      parsed_data
+    end
+
+    def platform
+      @options[:platform] ||= begin
+                                STDERR.puts "WARNING: you must specify a 'platform' and optionally a 'version' for your ChefSpec Runner and/or Fauxhai constructor, in the future omitting the platform will become a hard error. #{PLATFORM_LIST_MESSAGE}"
+                                "chefspec"
+                              end
+    end
+
+    def platform_path
+      File.join(Fauxhai.root, "lib", "fauxhai", "platforms", platform)
+    end
+
+    def version
+      @version ||= begin
+        if File.exist?("#{platform_path}/#{@options[:version]}.json")
+          # Whole version, use it as-is.
+          @options[:version]
+        else
+          # Check if it's a prefix of an existing version.
+          versions = Dir["#{platform_path}/*.json"].map { |path| File.basename(path, ".json") }
+          unless @options[:version].to_s == ""
+            # If the provided version is nil or '', that means take anything,
+            # otherwise run the prefix match with an extra \D to avoid the
+            # case where "7.1" matches "7.10.0".
+            prefix_re = /^#{Regexp.escape(@options[:version])}\D/
+            versions.select! { |ver| ver =~ prefix_re }
+          end
+
+          if versions.empty?
+            # No versions available, either an unknown platform or nothing matched
+            # the prefix check. Pass through the option as given so we can try
+            # github fetching.
+            @options[:version]
+          else
+            # Take the highest version available, trying to use rules that should
+            # probably mostly work on all OSes. Famous last words. The idea of
+            # the regex is to split on any punctuation (the common case) and
+            # also any single letter with digit on either side (2012r2). This
+            # leaves any long runs of letters intact (4.2-RELEASE). Then convert
+            # any run of digits to an integer to get version-ish comparison.
+            # This is basically a more flexible version of Gem::Version.
+            versions.max_by do |ver|
+              ver.split(/[^a-z0-9]|(?<=\d)[a-z](?=\d)/i).map do |part|
+                if part =~ /^\d+$/
+                  part.to_i
+                else
+                  part
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+  end
+end