ohai 18.2.6 → 19.0.3

data/lib/ohai/mixin/gce_metadata.rb

@@ -1,79 +1,79 @@
-# frozen_string_literal: true
-#
-# Author:: Ranjib Dey (<dey.ranjib@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)
-
-require_relative "../mixin/json_helper"
-include Ohai::Mixin::JsonHelper
-
-module Ohai
-  module Mixin
-    module GCEMetadata
-
-      # Trailing dot to host is added to avoid DNS search path
-      GCE_METADATA_ADDR ||= "metadata.google.internal."
-      GCE_METADATA_URL ||= "/computeMetadata/v1"
-
-      # fetch the meta content with a timeout and the required header
-      def http_get(uri)
-        conn = Net::HTTP.start(GCE_METADATA_ADDR)
-        conn.read_timeout = 6
-        conn.get(uri, {
-                        "Metadata-Flavor" => "Google",
-                        "User-Agent" => "chef-ohai/#{Ohai::VERSION}",
-                      })
-      end
-
-      def fetch_metadata(id = "")
-        url = "#{GCE_METADATA_URL}/#{id}"
-        url = "#{url}?recursive=true" if url.end_with?("/")
-        response = http_get(url)
-        if response.code == "200"
-          json_data = parse_json(response.body)
-          if json_data.nil?
-            logger.warn("Mixin GCEMetadata: Metadata response is NOT valid JSON for id='#{id}'")
-            if has_trailing_slash?(id) || (id == "")
-              temp = {}
-              response.body.split("\n").each do |sub_attr|
-                temp[sanitize_key(sub_attr)] = fetch_metadata("#{id}#{sub_attr}")
-              end
-              temp
-            else
-              response.body
-            end
-          else
-            json_data
-          end
-        else
-          logger.warn("Mixin GCEMetadata: Received response code #{response.code} requesting metadata for id='#{id}'")
-          nil
-        end
-      end
-
-      # @param data [String]
-      #
-      # @return [Boolean] is there a trailing /?
-      def has_trailing_slash?(data)
-        !!( data =~ %r{/$} )
-      end
-
-      def sanitize_key(key)
-        key.gsub(%r{\-|/}, "_")
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Author:: Ranjib Dey (<dey.ranjib@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)
+
+require_relative "../mixin/json_helper"
+include Ohai::Mixin::JsonHelper
+
+module Ohai
+  module Mixin
+    module GCEMetadata
+
+      # Trailing dot to host is added to avoid DNS search path
+      GCE_METADATA_ADDR ||= "metadata.google.internal."
+      GCE_METADATA_URL ||= "/computeMetadata/v1"
+
+      # fetch the meta content with a timeout and the required header
+      def http_get(uri)
+        conn = Net::HTTP.start(GCE_METADATA_ADDR)
+        conn.read_timeout = 6
+        conn.get(uri, {
+                        "Metadata-Flavor" => "Google",
+                        "User-Agent" => "chef-ohai/#{Ohai::VERSION}",
+                      })
+      end
+
+      def fetch_metadata(id = "")
+        url = "#{GCE_METADATA_URL}/#{id}"
+        url = "#{url}?recursive=true" if url.end_with?("/")
+        response = http_get(url)
+        if response.code == "200"
+          json_data = parse_json(response.body)
+          if json_data.nil?
+            logger.warn("Mixin GCEMetadata: Metadata response is NOT valid JSON for id='#{id}'")
+            if has_trailing_slash?(id) || (id == "")
+              temp = {}
+              response.body.split("\n").each do |sub_attr|
+                temp[sanitize_key(sub_attr)] = fetch_metadata("#{id}#{sub_attr}")
+              end
+              temp
+            else
+              response.body
+            end
+          else
+            json_data
+          end
+        else
+          logger.warn("Mixin GCEMetadata: Received response code #{response.code} requesting metadata for id='#{id}'")
+          nil
+        end
+      end
+
+      # @param data [String]
+      #
+      # @return [Boolean] is there a trailing /?
+      def has_trailing_slash?(data)
+        !!( data =~ %r{/$} )
+      end
+
+      def sanitize_key(key)
+        key.gsub(%r{\-|/}, "_")
+      end
+    end
+  end
+end

data/lib/ohai/mixin/http_helper.rb

@@ -1,64 +1,64 @@
-# 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 "socket" unless defined?(Socket)
-
-module Ohai
-  module Mixin
-    module HttpHelper
-
-      # see if we can socket connect to an address/port
-      #
-      # @param addr [String] the address to connect to
-      # @param port [Integer] the port to connect to
-      # @param timeout [Integer] the seconds before timing out
-      #
-      # @return [Boolean] can we connect?
-      def can_socket_connect?(addr, port, timeout = 2)
-        t = Socket.new(Socket::Constants::AF_INET, Socket::Constants::SOCK_STREAM, 0)
-        begin
-          saddr = Socket.pack_sockaddr_in(port, addr)
-        rescue SocketError => e # generally means dns resolution error
-          logger.trace("Mixin HttpHelper: can_socket_connect? failed setting up socket connection: #{e}")
-          return false
-        end
-
-        connected = false
-
-        begin
-          t.connect_nonblock(saddr)
-        rescue Errno::EINPROGRESS
-          _r, w, _e = IO.select(nil, [t], nil, timeout)
-          if !w.nil?
-            connected = true
-          else
-            begin
-              t.connect_nonblock(saddr)
-            rescue Errno::EISCONN
-              t.close
-              connected = true
-            rescue SystemCallError
-            end
-          end
-        rescue SystemCallError
-        end
-        logger.trace("Mixin HttpHelper: can_socket_connect? == #{connected}")
-        connected
-      end
-    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 "socket" unless defined?(Socket)
+
+module Ohai
+  module Mixin
+    module HttpHelper
+
+      # see if we can socket connect to an address/port
+      #
+      # @param addr [String] the address to connect to
+      # @param port [Integer] the port to connect to
+      # @param timeout [Integer] the seconds before timing out
+      #
+      # @return [Boolean] can we connect?
+      def can_socket_connect?(addr, port, timeout = 2)
+        t = Socket.new(Socket::Constants::AF_INET, Socket::Constants::SOCK_STREAM, 0)
+        begin
+          saddr = Socket.pack_sockaddr_in(port, addr)
+        rescue SocketError => e # generally means dns resolution error
+          logger.trace("Mixin HttpHelper: can_socket_connect? failed setting up socket connection: #{e}")
+          return false
+        end
+
+        connected = false
+
+        begin
+          t.connect_nonblock(saddr)
+        rescue Errno::EINPROGRESS
+          _r, w, _e = IO.select(nil, [t], nil, timeout)
+          if !w.nil?
+            connected = true
+          else
+            begin
+              t.connect_nonblock(saddr)
+            rescue Errno::EISCONN
+              t.close
+              connected = true
+            rescue SystemCallError
+            end
+          end
+        rescue SystemCallError
+        end
+        logger.trace("Mixin HttpHelper: can_socket_connect? == #{connected}")
+        connected
+      end
+    end
+  end
+end

data/lib/ohai/mixin/json_helper.rb

@@ -1,36 +1,36 @@
-# frozen_string_literal: true
-#
-# Author:: Renato Covarrubias (<rnt@rnt.cl>)
-# 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 JsonHelper
-      # parse JSON data from a String to a Hash
-      #
-      # @param [String] response_body json as string to parse
-      # @param [Object] return_on_parse_error value to return if parsing fails
-      #
-      # @return [Hash]
-      def parse_json(response_body, return_on_parse_error = nil)
-        data = String(response_body)
-        parser = FFI_Yajl::Parser.new
-        parser.parse(data)
-      rescue FFI_Yajl::ParseError
-        return_on_parse_error
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Author:: Renato Covarrubias (<rnt@rnt.cl>)
+# 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 JsonHelper
+      # parse JSON data from a String to a Hash
+      #
+      # @param [String] response_body json as string to parse
+      # @param [Object] return_on_parse_error value to return if parsing fails
+      #
+      # @return [Hash]
+      def parse_json(response_body, return_on_parse_error = nil)
+        data = String(response_body)
+        parser = FFI_Yajl::Parser.new
+        parser.parse(data)
+      rescue FFI_Yajl::ParseError
+        return_on_parse_error
+      end
+    end
+  end
+end

data/lib/ohai/mixin/network_helper.rb

@@ -1,92 +1,92 @@
-# frozen_string_literal: true
-#
-# Author:: Serdar Sutay (<serdar@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 "socket" unless defined?(Socket)
-require "resolv" unless defined?(Resolv)
-
-module Ohai
-  module Mixin
-    module NetworkHelper
-      unless defined?(FAMILIES)
-        FAMILIES = {
-          "inet" => "default",
-          "inet6" => "default_inet6",
-        }.freeze
-      end
-
-      def hex_to_dec_netmask(netmask)
-        # example 'ffff0000' -> '255.255.0.0'
-        dec = netmask[0..1].to_i(16).to_s(10)
-        [2, 4, 6].each { |n| dec = dec + "." + netmask[n..n + 1].to_i(16).to_s(10) }
-        dec
-      end
-
-      # Addrinfo#ip*? methods return true on AI_CANONNAME Addrinfo records that match
-      # the ipv* scheme and #ip? always returns true unless a non tcp Addrinfo
-      def ip?(hostname)
-        Resolv::IPv4::Regex.match?(hostname) || Resolv::IPv6::Regex.match?(hostname)
-      end
-
-      # This does a forward and reverse lookup on the hostname to return what should be
-      # the FQDN for the host determined by name lookup (generally DNS).  If the forward
-      # lookup fails this will throw.  If the reverse lookup fails this will return the
-      # hostname back.  The behavior on failure of the reverse lookup is both vitally important
-      # to this API, and completely untested, so changes to this method (not recommended) need
-      # to be manually validated by hand by setting up a DNS server with a broken A record to
-      # an IP without a PTR record (e.g. any RFC1918 space not served by the configured DNS
-      # server), and the method should return the hostname and not the IP address.
-      #
-      def canonicalize_hostname(hostname)
-        ai = Addrinfo
-          .getaddrinfo(hostname, nil, nil, nil, nil, Socket::AI_CANONNAME)
-          .first
-
-        canonname = ai&.canonname
-        # use canonname if it's an FQDN
-        # This API is preferred as it never gives us an IP address for broken DNS
-        # (see https://github.com/chef/ohai/pull/1705)
-        # However, we have found that Windows hosts that are not joined to a domain
-        # can return a non-qualified hostname).
-        # Use a '.' in the canonname as indicator of FQDN
-        return canonname if canonname.include?(".")
-
-        # If we got a non-qualified name, then we do a standard reverse resolve
-        # which, assuming DNS is working, will work around that windows bug
-        # (and maybe others)
-        canonname = ai&.getnameinfo&.first
-        return canonname unless ip?(canonname)
-
-        # if all else fails, return the name we were given as a safety
-        hostname
-      end
-
-      def canonicalize_hostname_with_retries(hostname)
-        retries = 3
-        begin
-          canonicalize_hostname(hostname)
-        rescue
-          retries -= 1
-          retry if retries > 0
-          nil
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Author:: Serdar Sutay (<serdar@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 "socket" unless defined?(Socket)
+require "resolv" unless defined?(Resolv)
+
+module Ohai
+  module Mixin
+    module NetworkHelper
+      unless defined?(FAMILIES)
+        FAMILIES = {
+          "inet" => "default",
+          "inet6" => "default_inet6",
+        }.freeze
+      end
+
+      def hex_to_dec_netmask(netmask)
+        # example 'ffff0000' -> '255.255.0.0'
+        dec = netmask[0..1].to_i(16).to_s(10)
+        [2, 4, 6].each { |n| dec = dec + "." + netmask[n..n + 1].to_i(16).to_s(10) }
+        dec
+      end
+
+      # Addrinfo#ip*? methods return true on AI_CANONNAME Addrinfo records that match
+      # the ipv* scheme and #ip? always returns true unless a non tcp Addrinfo
+      def ip?(hostname)
+        Resolv::IPv4::Regex.match?(hostname) || Resolv::IPv6::Regex.match?(hostname)
+      end
+
+      # This does a forward and reverse lookup on the hostname to return what should be
+      # the FQDN for the host determined by name lookup (generally DNS).  If the forward
+      # lookup fails this will throw.  If the reverse lookup fails this will return the
+      # hostname back.  The behavior on failure of the reverse lookup is both vitally important
+      # to this API, and completely untested, so changes to this method (not recommended) need
+      # to be manually validated by hand by setting up a DNS server with a broken A record to
+      # an IP without a PTR record (e.g. any RFC1918 space not served by the configured DNS
+      # server), and the method should return the hostname and not the IP address.
+      #
+      def canonicalize_hostname(hostname)
+        ai = Addrinfo
+          .getaddrinfo(hostname, nil, nil, nil, nil, Socket::AI_CANONNAME)
+          .first
+
+        canonname = ai&.canonname
+        # use canonname if it's an FQDN
+        # This API is preferred as it never gives us an IP address for broken DNS
+        # (see https://github.com/chef/ohai/pull/1705)
+        # However, we have found that Windows hosts that are not joined to a domain
+        # can return a non-qualified hostname).
+        # Use a '.' in the canonname as indicator of FQDN
+        return canonname if canonname.include?(".")
+
+        # If we got a non-qualified name, then we do a standard reverse resolve
+        # which, assuming DNS is working, will work around that windows bug
+        # (and maybe others)
+        canonname = ai&.getnameinfo&.first
+        return canonname unless ip?(canonname)
+
+        # if all else fails, return the name we were given as a safety
+        hostname
+      end
+
+      def canonicalize_hostname_with_retries(hostname)
+        retries = 3
+        begin
+          canonicalize_hostname(hostname)
+        rescue
+          retries -= 1
+          retry if retries > 0
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/ohai/mixin/oci_metadata.rb

@@ -1,60 +1,60 @@
-# frozen_string_literal: true
-
-#
-# Author:: Renato Covarrubias (<rnt@rnt.cl>)
-# 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)
-
-require_relative "../mixin/json_helper"
-include Ohai::Mixin::JsonHelper
-
-module Ohai
-  module Mixin
-    module OCIMetadata
-      OCI_METADATA_ADDR = "169.254.169.254"
-      OCI_METADATA_URL = "/opc/v2"
-      CHASSIS_ASSET_TAG_FILE = "/sys/devices/virtual/dmi/id/chassis_asset_tag"
-
-      # fetch the meta content with a timeout and the required header
-      def http_get(uri)
-        conn = Net::HTTP.start(OCI_METADATA_ADDR)
-        conn.read_timeout = 6
-        conn.get(
-          uri,
-          {
-            "Authorization" => "Bearer Oracle",
-            "User-Agent" => "chef-ohai/#{Ohai::VERSION}",
-          }
-        )
-      end
-
-      # Fetch metadata from api
-      def fetch_metadata(metadata = "instance")
-        response = http_get("#{OCI_METADATA_URL}/#{metadata}")
-        if response.code == "200"
-          json_data = parse_json(response.body)
-          if json_data.nil?
-            logger.warn("Mixin OciMetadata: Metadata response is NOT valid JSON")
-          end
-          json_data
-        else
-          logger.warn("Mixin OciMetadata: Received response code #{response.code} requesting metadata")
-          nil
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+# Author:: Renato Covarrubias (<rnt@rnt.cl>)
+# 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)
+
+require_relative "../mixin/json_helper"
+include Ohai::Mixin::JsonHelper
+
+module Ohai
+  module Mixin
+    module OCIMetadata
+      OCI_METADATA_ADDR = "169.254.169.254"
+      OCI_METADATA_URL = "/opc/v2"
+      CHASSIS_ASSET_TAG_FILE = "/sys/devices/virtual/dmi/id/chassis_asset_tag"
+
+      # fetch the meta content with a timeout and the required header
+      def http_get(uri)
+        conn = Net::HTTP.start(OCI_METADATA_ADDR)
+        conn.read_timeout = 6
+        conn.get(
+          uri,
+          {
+            "Authorization" => "Bearer Oracle",
+            "User-Agent" => "chef-ohai/#{Ohai::VERSION}",
+          }
+        )
+      end
+
+      # Fetch metadata from api
+      def fetch_metadata(metadata = "instance")
+        response = http_get("#{OCI_METADATA_URL}/#{metadata}")
+        if response.code == "200"
+          json_data = parse_json(response.body)
+          if json_data.nil?
+            logger.warn("Mixin OciMetadata: Metadata response is NOT valid JSON")
+          end
+          json_data
+        else
+          logger.warn("Mixin OciMetadata: Received response code #{response.code} requesting metadata")
+          nil
+        end
+      end
+    end
+  end
+end