ohai 18.2.6 → 19.0.3

data/lib/ohai/mixin/os.rb

@@ -1,128 +1,128 @@
-# frozen_string_literal: true
-#
-# Author:: Adam Jacob (<adam@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 "rbconfig" unless defined?(RbConfig)
-
-module Ohai
-  module Mixin
-    module OS
-
-      # Using ruby configuration determine the OS we're running on
-      #
-      # @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.name
-        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"
-        when /darwin(.+)$/
-          "darwin"
-        when /linux/
-          "linux"
-        when /freebsd(.+)$/
-          "freebsd"
-        when /openbsd(.+)$/
-          "openbsd"
-        when /netbsd(.*)$/
-          "netbsd"
-        when /dragonfly(.*)$/
-          "dragonflybsd"
-        when /solaris2/
-          "solaris2"
-        when /mswin|mingw|windows/
-          # After long discussion in IRC the "powers that be" have come to a consensus
-          # that no Windows platform exists that was not based on the
-          # Windows_NT kernel, so we herby decree that "windows" will refer to all
-          # platforms built upon the Windows_NT kernel and have access to win32 or win64
-          # subsystems.
-          "windows"
-        else
-          ::RbConfig::CONFIG["host_os"]
-        end
-      end
-
-      extend self
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Author:: Adam Jacob (<adam@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 "rbconfig" unless defined?(RbConfig)
+
+module Ohai
+  module Mixin
+    module OS
+
+      # Using ruby configuration determine the OS we're running on
+      #
+      # @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.name
+        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"
+        when /darwin(.+)$/
+          "darwin"
+        when /linux/
+          "linux"
+        when /freebsd(.+)$/
+          "freebsd"
+        when /openbsd(.+)$/
+          "openbsd"
+        when /netbsd(.*)$/
+          "netbsd"
+        when /dragonfly(.*)$/
+          "dragonflybsd"
+        when /solaris2/
+          "solaris2"
+        when /mswin|mingw|windows/
+          # After long discussion in IRC the "powers that be" have come to a consensus
+          # that no Windows platform exists that was not based on the
+          # Windows_NT kernel, so we herby decree that "windows" will refer to all
+          # platforms built upon the Windows_NT kernel and have access to win32 or win64
+          # subsystems.
+          "windows"
+        else
+          ::RbConfig::CONFIG["host_os"]
+        end
+      end
+
+      extend self
+    end
+  end
+end

data/lib/ohai/mixin/scaleway_metadata.rb

@@ -1,51 +1,51 @@
-# frozen_string_literal: true
-#
-# Author:: Jonathan Amiez (<jonathan.amiez@gmail.com>)
-# 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 "net/http" unless defined?(Net::HTTP)
-
-module Ohai
-  module Mixin
-    module ScalewayMetadata
-
-      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
-        Net::HTTP.start(SCALEWAY_METADATA_ADDR).tap { |h| h.read_timeout = 6 }
-      end
-
-      # fetch scaleway metadata and parse the resulting JSON
-      #
-      # @return [Hash]
-      def fetch_metadata
-        uri = SCALEWAY_METADATA_URL.to_s
-        response = http_client.get(uri)
-        case response.code
-        when "200"
-          parser = FFI_Yajl::Parser.new
-          parser.parse(response.body)
-        when "404"
-          logger.trace("Mixin ScalewayMetadata: Encountered 404 response retrieving Scaleway metadata: #{uri} ; continuing.")
-          {}
-        else
-          raise "Mixin ScalewayMetadata: Encountered error retrieving Scaleway metadata (#{uri} returned #{response.code} response)"
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Author:: Jonathan Amiez (<jonathan.amiez@gmail.com>)
+# 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 "net/http" unless defined?(Net::HTTP)
+
+module Ohai
+  module Mixin
+    module ScalewayMetadata
+
+      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
+        Net::HTTP.start(SCALEWAY_METADATA_ADDR).tap { |h| h.read_timeout = 6 }
+      end
+
+      # fetch scaleway metadata and parse the resulting JSON
+      #
+      # @return [Hash]
+      def fetch_metadata
+        uri = SCALEWAY_METADATA_URL.to_s
+        response = http_client.get(uri)
+        case response.code
+        when "200"
+          parser = FFI_Yajl::Parser.new
+          parser.parse(response.body)
+        when "404"
+          logger.trace("Mixin ScalewayMetadata: Encountered 404 response retrieving Scaleway metadata: #{uri} ; continuing.")
+          {}
+        else
+          raise "Mixin ScalewayMetadata: Encountered error retrieving Scaleway metadata (#{uri} returned #{response.code} response)"
+        end
+      end
+    end
+  end
+end

data/lib/ohai/mixin/seconds_to_human.rb

@@ -1,52 +1,52 @@
-# frozen_string_literal: true
-#
-# Author:: Adam Jacob (<adam@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.
-#
-
-module Ohai
-  module Mixin
-    module SecondsToHuman
-      # given the number of seconds return a day/hours/minutes/seconds human form
-      #
-      # @param seconds [Integer]
-      #
-      # @return String
-      def seconds_to_human(seconds)
-        days = seconds.to_i / 86400
-        seconds -= 86400 * days
-
-        hours = seconds.to_i / 3600
-        seconds -= 3600 * hours
-
-        minutes = seconds.to_i / 60
-        seconds -= 60 * minutes
-
-        if days > 1
-          sprintf("%d days %02d hours %02d minutes %02d seconds", days, hours, minutes, seconds)
-        elsif days == 1
-          sprintf("%d day %02d hours %02d minutes %02d seconds", days, hours, minutes, seconds)
-        elsif hours > 0
-          sprintf("%d hours %02d minutes %02d seconds", hours, minutes, seconds)
-        elsif minutes > 0
-          sprintf("%d minutes %02d seconds", minutes, seconds)
-        else
-          sprintf("%02d seconds", seconds)
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Author:: Adam Jacob (<adam@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.
+#
+
+module Ohai
+  module Mixin
+    module SecondsToHuman
+      # given the number of seconds return a day/hours/minutes/seconds human form
+      #
+      # @param seconds [Integer]
+      #
+      # @return String
+      def seconds_to_human(seconds)
+        days = seconds.to_i / 86400
+        seconds -= 86400 * days
+
+        hours = seconds.to_i / 3600
+        seconds -= 3600 * hours
+
+        minutes = seconds.to_i / 60
+        seconds -= 60 * minutes
+
+        if days > 1
+          sprintf("%d days %02d hours %02d minutes %02d seconds", days, hours, minutes, seconds)
+        elsif days == 1
+          sprintf("%d day %02d hours %02d minutes %02d seconds", days, hours, minutes, seconds)
+        elsif hours > 0
+          sprintf("%d hours %02d minutes %02d seconds", hours, minutes, seconds)
+        elsif minutes > 0
+          sprintf("%d minutes %02d seconds", minutes, seconds)
+        else
+          sprintf("%02d seconds", seconds)
+        end
+      end
+    end
+  end
+end

data/lib/ohai/mixin/shell_out.rb

@@ -1,51 +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
+# 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