ohai 16.4.12 → 16.7.18

data/lib/ohai/mixin/command.rb

@@ -1,54 +1,4 @@
-#
-# Author:: Adam Jacob (<adam@chef.io>)
-# Author:: Tim Smith (<tsmith@chef.io>)
-# Copyright:: Copyright (c) 2008-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_relative "../exception"
-require_relative "../log"
-require "mixlib/shellout" unless defined?(Mixlib::ShellOut::DEFAULT_READ_TIMEOUT)
-
-module Ohai
-  module Mixin
-    module Command
-      # DISCLAIMER: Logging only works in the context of a plugin!!
-      # accept a command and any of the mixlib-shellout options
-      def shell_out(cmd, **options)
-        options = options.dup
-        # unless specified by the caller timeout after configured timeout (default 30 seconds)
-        options[:timeout] ||= Ohai::Config.ohai[:shellout_timeout]
-        unless RUBY_PLATFORM.match?(/mswin|mingw32|windows/)
-          options[:env] = options.key?(:env) ? options[:env].dup : {}
-          options[:env]["PATH"] ||= ((ENV["PATH"] || "").split(":") + %w{/usr/local/sbin /usr/local/bin /usr/sbin /usr/bin /sbin /bin}).join(":")
-        end
-        so = Mixlib::ShellOut.new(cmd, options)
-        begin
-          so.run_command
-          logger.trace("Plugin #{name}: ran '#{cmd}' and returned #{so.exitstatus}")
-          so
-        rescue Errno::ENOENT => e
-          logger.trace("Plugin #{name}: ran '#{cmd}' and failed #{e.inspect}")
-          raise Ohai::Exceptions::Exec, e
-        rescue Mixlib::ShellOut::CommandTimeout => e
-          logger.trace("Plugin #{name}: ran '#{cmd}' and timed out after #{options[:timeout]} seconds")
-          raise Ohai::Exceptions::Exec, e
-        end
-      end
-
-      module_function :shell_out
-    end
-  end
-end
+# frozen_string_literal: true
+$stderr.puts "WARN: Ohai::Mixin::Command is deprecated, please use Ohai::Mixin::ShellOut or remove if the reference is unnecessary"
+require_relative "shell_out"
+Ohai::Mixin::Command = Ohai::Mixin::ShellOut unless defined?(Ohai::Mixin::Command)

data/lib/ohai/mixin/constant_helper.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 #
 # Author:: Serdar Sutay (<serdar@chef.io>)
-# Copyright:: Copyright (c) 2014-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/ohai/mixin/dmi_decode.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 #
 # Author:: Tim Smith <tsmith@chef.io>
-# Copyright:: Copyright (c) 2015-2018 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/ohai/mixin/do_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 # Author:: Dylan Page (<dpage@digitalocean.com>)
 # License:: Apache License, Version 2.0
@@ -20,15 +21,15 @@ module Ohai
   module Mixin
     module DOMetadata
 
-      DO_METADATA_ADDR ||= "169.254.169.254".freeze
-      DO_METADATA_URL ||= "/metadata/v1.json".freeze
+      DO_METADATA_ADDR ||= "169.254.169.254"
+      DO_METADATA_URL ||= "/metadata/v1.json"
 
       def http_client
         Net::HTTP.start(DO_METADATA_ADDR).tap { |h| h.read_timeout = 6 }
       end
 
       def fetch_metadata
-        uri = (DO_METADATA_URL).to_s
+        uri = DO_METADATA_URL.to_s
         response = http_client.get(uri)
         case response.code
         when "200"

data/lib/ohai/mixin/ec2_metadata.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 #
 # Author:: Tim Dysinger (<tim@dysinger.net>)
 # Author:: Benjamin Black (<bb@chef.io>)
 # Author:: Christopher Brown (<cb@chef.io>)
-# Copyright:: 2009-2017 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -39,7 +40,7 @@ module Ohai
     #
     module Ec2Metadata
 
-      EC2_METADATA_ADDR ||= "169.254.169.254".freeze
+      EC2_METADATA_ADDR ||= "169.254.169.254"
       EC2_SUPPORTED_VERSIONS ||= %w{ 1.0 2007-01-19 2007-03-01 2007-08-29 2007-10-10 2007-12-15
                                    2008-02-01 2008-09-01 2009-04-04 2011-01-01 2011-05-01 2012-01-12
                                    2014-02-25 2014-11-05 2015-10-20 2016-04-19 2016-06-30 2016-09-02 }.freeze
@@ -142,7 +143,7 @@ module Ohai
             key = expand_path(o)
             if key[-1..-1] != "/"
               retr_meta = metadata_get("#{id}#{key}", api_version)
-              metadata[metadata_key(key)] = retr_meta ? retr_meta : ""
+              metadata[metadata_key(key)] = retr_meta || ""
             elsif not key.eql?("/")
               metadata[key[0..-2]] = fetch_dir_metadata("#{id}#{key}", api_version)
             end
@@ -159,7 +160,7 @@ module Ohai
             key = expand_path(o)
             if key[-1..-1] != "/"
               retr_meta = metadata_get("#{id}#{key}", api_version)
-              data = retr_meta ? retr_meta : ""
+              data = retr_meta || ""
               json = String(data)
               parser = FFI_Yajl::Parser.new
               metadata[metadata_key(key)] = parser.parse(json)

data/lib/ohai/mixin/gce_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Ranjib Dey (<dey.ranjib@gmail.com>)
 # License:: Apache License, Version 2.0
@@ -21,8 +22,8 @@ module Ohai
     module GCEMetadata
 
       # Trailing dot to host is added to avoid DNS search path
-      GCE_METADATA_ADDR ||= "metadata.google.internal.".freeze
-      GCE_METADATA_URL ||= "/computeMetadata/v1/?recursive=true".freeze
+      GCE_METADATA_ADDR ||= "metadata.google.internal."
+      GCE_METADATA_URL ||= "/computeMetadata/v1/?recursive=true"
 
       # fetch the meta content with a timeout and the required header
       def http_get(uri)

data/lib/ohai/mixin/http_helper.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 #
-# Copyright:: 2017, Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/ohai/mixin/network_helper.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 #
 # Author:: Serdar Sutay (<serdar@chef.io>)
-# Copyright:: Copyright (c) 2014-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/ohai/mixin/os.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 #
 # Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright (c) 2008-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,6 +28,71 @@ module Ohai
       #
       # @return [String] the OS
       def collect_os
+        if target_mode?
+          collect_os_target
+        else
+          collect_os_local
+        end
+      end
+
+      # This should exactly preserve the semantics of collect_os_local below, which is authoritative
+      # for the API and must adhere to pre-existing ohai semantics and not follow inspec's notion of
+      # os/family/hierarchy.
+      #
+      # Right or wrong the ohai `os` variable has matched the ruby `host_os` definition for the past
+      # 10+ years, preceding inspec/train's definitions and this is the documented correct API of
+      # these methods.  Mismatches between the ruby notion and the train version will be fixed as
+      # bugfixes in these methods and may not be considered semver violating even though they make
+      # break downstream consumers.  Please ensure that both methods produce the same results if
+      # you are on a platform which supports running ruby (train is considered authoritative for
+      # any "OS" which cannot run ruby -- server consoles, REST APIs, etc...)
+      #
+      # @api private
+      def collect_os_target
+        case
+        when transport_connection.os.aix?
+          "aix"
+        when transport_connection.os.darwin?
+          "darwin"
+        when transport_connection.os.linux?
+          "linux"
+        when transport_connection.os.family == "freebsd"
+          "freebsd"
+        when transport_connection.os.family == "openbsd"
+          "openbsd"
+        when transport_connection.os.family == "netbsd"
+          "netbsd"
+        when transport_connection.os.family == "dragonflybsd"
+          "dragonflybsd"
+        when transport_connection.os.solaris?
+          "solaris2"
+        when transport_connection.os.windows?
+          "windows"
+
+          #
+          # The purpose of the next two lines is that anything which runs Unix is presumed to be able to run ruby, and
+          # if it was not caught above, we MUST translate whatever train uses as the 'os' into the proper ruby host_os
+          # string.  If it is not unix and not caught above we assume it is something like a REST API which cannot run
+          # ruby.  If these assumptions are incorrect then it is a bug, which should be submitted to fix it, and the
+          # values should not be relied upon until that bug is fixed.  The train os is NEVER considered authoritative
+          # for any target which can run ruby.
+          #
+        when transport_connection.os.unix?
+          raise "Target mode unsupported on this Unix-like host, please update the collect_os_target case statement with the correct ruby host_os value."
+        else
+          # now we have something like an IPMI console that isn't Unix-like or Windows, presumably cannot run ruby, and
+          # so we just trust the train O/S information.
+          transport_connection.os
+        end
+      end
+
+      # @api private
+      def nonruby_target?
+        transport_connection && !transport_connection.os.unix? && !transport_connection.os.windows
+      end
+
+      # @api private
+      def collect_os_local
         case ::RbConfig::CONFIG["host_os"]
         when /aix(.+)$/
           "aix"
@@ -56,7 +122,7 @@ module Ohai
         end
       end
 
-      module_function :collect_os
+      extend self
     end
   end
 end

data/lib/ohai/mixin/scaleway_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Jonathan Amiez (<jonathan.amiez@gmail.com>)
 # License:: Apache License, Version 2.0
@@ -20,8 +21,8 @@ module Ohai
   module Mixin
     module ScalewayMetadata
 
-      SCALEWAY_METADATA_ADDR ||= "169.254.42.42".freeze
-      SCALEWAY_METADATA_URL ||= "/conf?format=json".freeze
+      SCALEWAY_METADATA_ADDR ||= "169.254.42.42"
+      SCALEWAY_METADATA_URL ||= "/conf?format=json"
 
       # @return [Net::HTTP] net/http object without timeout set to 6
       def http_client
@@ -32,7 +33,7 @@ module Ohai
       #
       # @return [Hash]
       def fetch_metadata
-        uri = (SCALEWAY_METADATA_URL).to_s
+        uri = SCALEWAY_METADATA_URL.to_s
         response = http_client.get(uri)
         case response.code
         when "200"

data/lib/ohai/mixin/seconds_to_human.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 #
 # Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright (c) 2008-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/ohai/mixin/shell_out.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+#
+# Author:: Adam Jacob (<adam@chef.io>)
+# Author:: Tim Smith (<tsmith@chef.io>)
+# 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 "../exception"
+require_relative "../log"
+
+require "mixlib/shellout/helper" unless defined?(Mixlib::ShellOut::Helper)
+require_relative "chef_utils_wiring" unless defined?(Ohai::Mixin::ChefUtilsWiring)
+
+module Ohai
+  module Mixin
+    module ShellOut
+      include Mixlib::ShellOut::Helper
+      include Ohai::Mixin::ChefUtilsWiring
+
+      def shell_out(cmd, **options)
+        options = options.dup
+        # unless specified by the caller timeout after configured timeout (default 30 seconds)
+        options[:timeout] ||= Ohai::Config.ohai[:shellout_timeout]
+        begin
+          so = super(cmd, **options)
+          logger.trace("Plugin #{name}: ran '#{cmd}' and returned #{so.exitstatus}")
+          so
+        rescue Errno::ENOENT => e
+          logger.trace("Plugin #{name}: ran '#{cmd}' and failed #{e.inspect}")
+          raise Ohai::Exceptions::Exec, e
+        rescue Mixlib::ShellOut::CommandTimeout => e
+          logger.trace("Plugin #{name}: ran '#{cmd}' and timed out after #{options[:timeout]} seconds")
+          raise Ohai::Exceptions::Exec, e
+        end
+      end
+    end
+  end
+end

data/lib/ohai/mixin/softlayer_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Alexey Karpik <alexey.karpik@rightscale.com>
 # Author:: Peter Schroeter <peter.schroeter@rightscale.com>
@@ -22,7 +23,7 @@ require "uri" unless defined?(URI)
 
 # https://softlayer.github.io/reference/services/SoftLayer_Resource_Metadata/
 module ::Ohai::Mixin::SoftlayerMetadata
-  SOFTLAYER_API_QUERY_URL ||= "https://api.service.softlayer.com/rest/v3.1/SoftLayer_Resource_Metadata".freeze
+  SOFTLAYER_API_QUERY_URL ||= "https://api.service.softlayer.com/rest/v3.1/SoftLayer_Resource_Metadata"
 
   # fetch metadata items and build out hash of data
   #

data/lib/ohai/mixin/string.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 #
 # Author:: James Gartrell (<jgartrel@gmail.com>)
-# Copyright:: Copyright (c) 2009-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/ohai/mixin/train_helpers.rb

@@ -0,0 +1,36 @@
+# 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 "chef-utils/dsl/train_helpers" unless defined?(ChefUtils::DSL::TrainHelpers)
+require_relative "chef_utils_wiring" unless defined?(Ohai::Mixin::ChefUtilsWiring)
+
+module Ohai
+  module Mixin
+    module TrainHelpers
+      include ChefUtils::DSL::TrainHelpers
+      include ChefUtilsWiring
+
+      # anything added to this file temporarily should be pushed back up
+      # into ChefUtils::DSL::TrainHelpers
+
+      # XXX: this needs better support directly in train
+      def dir_glob(path)
+        shell_out!("ls -d #{path}").stdout.split
+      end
+    end
+  end
+end

data/lib/ohai/mixin/which.rb

@@ -0,0 +1,39 @@
+# 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 "chef-utils/dsl/which" unless defined?(ChefUtils::DSL::Which)
+require "chef-utils/dsl/default_paths" unless defined?(ChefUtils::DSL::DefaultPaths)
+require_relative "chef_utils_wiring" unless defined?(Ohai::Mixin::ChefUtilsWiring)
+
+module Ohai
+  module Mixin
+    module Which
+      include ChefUtils::DSL::Which
+      include ChefUtils::DSL::DefaultPaths
+      include ChefUtilsWiring
+
+      private
+
+      # we dep-inject default paths into this API for historical reasons
+      #
+      # @api private
+      def __extra_path
+        __default_paths
+      end
+    end
+  end
+end