ohai 16.10.6 → 17.1.0

data/lib/ohai/plugins/eucalyptus.rb

@@ -29,7 +29,7 @@ Ohai.plugin(:Eucalyptus) do
   provides "eucalyptus"
   depends "network/interfaces"
 
-  MAC_MATCH = /^[dD]0:0[dD]:/.freeze
+  MAC_MATCH = /^[dD]0:0[dD]:/.freeze unless defined?(MAC_MATCH)
 
   # returns the mac address from the collection of all address types
   def get_mac_address(addresses)

data/lib/ohai/plugins/filesystem.rb

@@ -98,14 +98,6 @@ Ohai.plugin(:Filesystem) do
     view
   end
 
-  def generate_deprecated_windows_view(fs)
-    view = generate_mountpoint_view(fs)
-    view.each do |mp, entry|
-      view[mp].delete("devices")
-    end
-    view
-  end
-
   def parse_common_df(out)
     fs = {}
     out.each_line do |line|
@@ -466,9 +458,7 @@ Ohai.plugin(:Filesystem) do
     fs_data["by_mountpoint"] = by_mountpoint
     fs_data["by_pair"] = by_pair
 
-    # @todo in Chef 17 the filesystem2 part of this goes away
     filesystem fs_data
-    filesystem2 fs_data
   end
 
   collect_data(:darwin) do
@@ -613,9 +603,7 @@ Ohai.plugin(:Filesystem) do
     fs_data["by_mountpoint"] = by_mountpoint
     fs_data["by_pair"] = by_pair
 
-    # @todo in Chef 17 the filesystem2 plugin goes away
     filesystem fs_data
-    filesystem2 fs_data
   end
 
   collect_data(:aix) do
@@ -705,9 +693,7 @@ Ohai.plugin(:Filesystem) do
     fs_data["by_mountpoint"] = by_mountpoint
     fs_data["by_pair"] = by_pair
 
-    # @todo in Chef 17 the filesystem2 plugin goes away here
     filesystem fs_data
-    filesystem2 fs_data
   end
 
   collect_data(:windows) do
@@ -726,9 +712,10 @@ Ohai.plugin(:Filesystem) do
     fs_data["by_mountpoint"] = by_mountpoint
     fs_data["by_pair"] = by_pair
 
-    # Set the filesystem data - Windows didn't do the conversion when everyone
-    # else did, so 15 will have both be the new API and 16 will drop the old API
-    filesystem generate_deprecated_windows_view(fs)
+    # Chef 16 added 'filesystem2'
+    # In Chef 17 we made 'filesystem' and 'filesystem2' match (both new-style)
+    # In Chef 18 we will drop 'filesystem2'
+    filesystem fs_data
     filesystem2 fs_data
   end
 end

data/lib/ohai/plugins/habitat.rb

@@ -0,0 +1,73 @@
+# 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.
+#
+#
+Ohai.plugin(:Habitat) do
+  provides "habitat"
+
+  def habitat_binary
+    @habitat_binary ||= which("hab")
+  end
+
+  def fetch_habitat_version
+    shell_out([habitat_binary, "-V"]).stdout.gsub(/hab\s*/, "").strip
+  rescue Ohai::Exceptions::Exec
+    logger.trace("Plugin Habitat: Unable to determine the installed version of Habitat, skipping collection.")
+  end
+
+  def fetch_habitat_packages
+    shell_out([habitat_binary, "pkg", "list", "--all"]).stdout.split.sort.select { |pkg| pkg.match?(%r{.*/.*/.*/.*}) }
+  rescue Ohai::Exceptions::Exec
+    logger.trace("Plugin Habitat: Unable to determine the installed Habitat packages, skipping collection.")
+  end
+
+  def load_habitat_service_via_cli(status_stdout)
+    # package                           type        desired  state  elapsed (s)  pid   group
+    # core/httpd/2.4.35/20190307151146  standalone  up       up     158169       1410  httpd.default
+    @services = []
+    status_stdout.each_line do |line|
+      fields = line.split(/\s+/)
+      next unless fields[0].match?(%r{.*/.*/.*/.*}) # ignore header line
+
+      service = {}
+      service[:identity] = fields[0]
+      service[:topology] = fields[1]
+      service[:state_desired] = fields[2]
+      service[:state_actual] = fields[2]
+      (@services).push(service)
+    end
+    @services
+  end
+
+  def fetch_habitat_services
+    services_shell_out = shell_out([habitat_binary, "svc", "status"]).stdout
+    load_habitat_service_via_cli(services_shell_out) if services_shell_out
+  rescue Ohai::Exceptions::Exec
+    logger.trace("Plugin Habitat: Unable to determine the installed Habitat services, skipping collection.")
+  end
+
+  collect_data(:default) do
+    if habitat_binary
+      habitat Mash.new
+      habitat["version"] = fetch_habitat_version
+      habitat["packages"] = fetch_habitat_packages
+      habitat["services"] = fetch_habitat_services
+    else
+      logger.trace("Plugin Habitat: Could not find hab binary. Skipping plugin.")
+    end
+  end
+end

data/lib/ohai/plugins/hostname.rb

@@ -48,7 +48,28 @@ Ohai.plugin(:Hostname) do
     require "ipaddr" unless defined?(IPAddr)
 
     hostname = from_cmd("hostname")
-    addrinfo = Socket.getaddrinfo(hostname, nil).first
+    begin
+      addrinfo = Socket.getaddrinfo(hostname, nil).first
+    rescue SocketError
+      # In the event that we got an exception from Socket, it's possible
+      # that it will work if we restrict it to IPv4 only either because of
+      # IPv6 misconfiguration or other bugs.
+      #
+      # Specifically it's worth noting that on macOS, getaddrinfo() will choke
+      # if it gets back a link-local address (say if you have 'fe80::1 myhost'
+      # in /etc/hosts). This will raise:
+      #    SocketError (getnameinfo: Non-recoverable failure in name resolution)
+      #
+      # But general misconfiguration could cause similar issues, so attempt to
+      # fall back to v4-only
+      begin
+        addrinfo = Socket.getaddrinfo(hostname, nil, :INET).first
+      rescue
+        # and if *that* fails, then try v6-only, in case we're in a v6-only
+        # environment with v4 config issues
+        addrinfo = Socket.getaddrinfo(hostname, nil, :INET6).first
+      end
+    end
     iaddr = IPAddr.new(addrinfo[3])
     Socket.gethostbyaddr(iaddr.hton)[0]
   rescue

data/lib/ohai/plugins/linux/network.rb

@@ -141,13 +141,13 @@ Ohai.plugin(:Network) do
 
   # using a temporary var to hold routes and their interface name
   def parse_routes(family, iface)
-    iface.collect do |i, iv|
+    iface.filter_map do |i, iv|
       next unless iv[:routes]
 
-      iv[:routes].collect do |r|
+      iv[:routes].filter_map do |r|
         r.merge(dev: i) if r[:family] == family[:name]
-      end.compact # @todo: when we drop ruby 2.6 this should be a filter_map
-    end.compact.flatten # @todo: when we drop ruby 2.6 this should be a filter_map
+      end
+    end.flatten
   end
 
   # determine layer 1 details for the interface using ethtool
@@ -273,6 +273,30 @@ Ohai.plugin(:Network) do
     iface
   end
 
+  # determine offload features for the interface using ethtool
+  def ethernet_offload_parameters(iface)
+    return iface unless ethtool_binary_path
+
+    iface.each_key do |tmp_int|
+      next unless iface[tmp_int][:encapsulation] == "Ethernet"
+
+      so = shell_out("#{ethtool_binary_path} -k #{tmp_int}")
+      Ohai::Log.debug("Plugin Network: Parsing ethtool output: #{so.stdout}")
+      iface[tmp_int]["offload_params"] = {}
+      so.stdout.lines.each do |line|
+        next if line.start_with?("Features for")
+        next if line.strip.nil?
+
+        key, val = line.split(/:\s+/)
+        if val
+          offload_key = key.downcase.strip.tr(" ", "_").to_s
+          iface[tmp_int]["offload_params"][offload_key] = val.downcase.gsub(/\[.*\]/, "").strip.to_s
+        end
+      end
+    end
+    iface
+  end
+
   # determine pause parameters for the interface using ethtool
   def ethernet_pause_parameters(iface)
     return iface unless ethtool_binary_path
@@ -793,6 +817,7 @@ Ohai.plugin(:Network) do
     iface = ethernet_ring_parameters(iface)
     iface = ethernet_channel_parameters(iface)
     iface = ethernet_coalesce_parameters(iface)
+    iface = ethernet_offload_parameters(iface)
     iface = ethernet_driver_info(iface)
     iface = ethernet_pause_parameters(iface)
     counters[:network][:interfaces] = net_counters

data/lib/ohai/plugins/linux/os_release.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+#
+# Author:: Lance Albertson (lance@osuosl.org>)
+# Copyright:: Copyright (c) 2021 Oregon State University
+# 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.
+#
+
+Ohai.plugin(:OsRelease) do
+  provides "os_release"
+
+  collect_data(:linux) do
+    os_release Mash.new unless os_release
+
+    # https://www.freedesktop.org/software/systemd/man/os-release.html
+    if file_exist?("/etc/os-release")
+      file_read("/etc/os-release").each_line do |line|
+        key, value = line.split("=")
+        if key == "ID_LIKE"
+          os_release[key.downcase] = value.chomp.gsub(/\A"|"\Z/, "").split(" ") if value
+        else
+          os_release[key.downcase] = value.chomp.gsub(/\A"|"\Z/, "") if value
+        end
+      end
+    end
+  end
+end

data/lib/ohai/plugins/linux/platform.rb

@@ -54,7 +54,7 @@ Ohai.plugin(:Platform) do
   end
 
   #
-  # Cached /etc/os-release info Hash.  Also has logic for Cisco Nexus
+  # Cached /etc/os-release info Hash. Also has logic for Cisco Nexus
   # switches that pulls the chained CISCO_RELEASE_INFO file into the Hash (other
   # distros can also reuse this method safely).
   #
@@ -112,16 +112,17 @@ Ohai.plugin(:Platform) do
     # ohai uses. If you're adding a new platform here and you want to change the name
     # you'll want to add it here and then add a spec for the platform_id_remap method
     {
-      "rhel" => "redhat",
+      "alinux" => "alibabalinux",
       "amzn" => "amazon",
+      "archarm" => "arch",
+      "cumulus-linux" => "cumulus",
       "ol" => "oracle",
-      "sles" => "suse",
-      "sles_sap" => "suse",
       "opensuse-leap" => "opensuseleap",
+      "rhel" => "redhat",
+      "sles_sap" => "suse",
+      "sles" => "suse",
       "xenenterprise" => "xenserver",
-      "cumulus-linux" => "cumulus",
-      "archarm" => "arch",
-    }[id] || id
+    }[id.downcase] || id.downcase
   end
 
   #
@@ -133,22 +134,24 @@ Ohai.plugin(:Platform) do
   #
   def platform_family_from_platform(plat)
     case plat
-    when /debian/, /ubuntu/, /linuxmint/, /raspbian/, /cumulus/, /kali/, /pop/
+    when /ubuntu/, /debian/, /linuxmint/, /raspbian/, /cumulus/, /kali/, /pop/
       # apt-get+dpkg almost certainly goes here
       "debian"
-    when /oracle/, /centos/, /redhat/, /almalinux/, /scientific/, /enterpriseenterprise/, /xcp/, /xenserver/, /cloudlinux/, /ibm_powerkvm/, /parallels/, /nexus_centos/, /clearos/, /bigip/ # Note that 'enterpriseenterprise' is oracle's LSB "distributor ID"
+    when /centos/, /redhat/, /oracle/, /almalinux/, /rocky/, /scientific/, /enterpriseenterprise/, /xenserver/, /xcp-ng/, /cloudlinux/, /alibabalinux/, /sangoma/, /clearos/, /parallels/, /ibm_powerkvm/, /nexus_centos/, /bigip/ # Note that 'enterpriseenterprise' is oracle's LSB "distributor ID"
       # NOTE: "rhel" should be reserved exclusively for recompiled rhel versions that are nearly perfectly compatible down to the platform_version.
       # The operating systems that are "rhel" should all be as compatible as rhel7 = centos7 = oracle7 = scientific7 (98%-ish core RPM version compatibility
       # and the version numbers MUST track the upstream). The appropriate EPEL version repo should work nearly perfectly.  Some variation like the
-      # oracle kernel version differences and tuning and extra packages are clearly acceptable.  Almost certainly some distros above (xenserver?)
-      # should not be in this list.  Please use fedora, below, instead.  Also note that this is the only platform_family with this strict of a rule,
+      # oracle kernel version differences and tuning and extra packages are clearly acceptable. Almost certainly some distros above (xenserver?)
+      # should not be in this list. Please use fedora, below, instead. Also note that this is the only platform_family with this strict of a rule,
       # see the example of the debian platform family for how the rest of the platform_family designations should be used.
+      #
+      # TODO: when XCP-NG 7.4 support ends we can remove the xcp-ng match. 7.5+ reports as xenenterprise which we remap to xenserver
       "rhel"
     when /amazon/
       "amazon"
-    when /suse/, /sles/, /opensuse/, /opensuseleap/, /sled/
+    when /suse/, /sles/, /opensuseleap/, /opensuse/, /sled/
       "suse"
-    when /fedora/, /pidora/, /arista_eos/
+    when /fedora/, /arista_eos/
       # In the broadest sense:  RPM-based, fedora-derived distributions which are not strictly re-compiled RHEL (if it uses RPMs, and smells more like redhat and less like
       # SuSE it probably goes here).
       "fedora"
@@ -156,9 +159,7 @@ Ohai.plugin(:Platform) do
       "wrlinux"
     when /gentoo/
       "gentoo"
-    when /slackware/
-      "slackware"
-    when /arch/, /manjaro/, /antergos/
+    when /arch/, /manjaro/
       "arch"
     when /exherbo/
       "exherbo"
@@ -168,6 +169,8 @@ Ohai.plugin(:Platform) do
       "clearlinux"
     when /mangeia/
       "mandriva"
+    when /slackware/
+      "slackware"
     end
   end
 
@@ -270,9 +273,6 @@ Ohai.plugin(:Platform) do
     elsif /XenServer/i.match?(lsb[:id])
       platform "xenserver"
       platform_version lsb[:release]
-    elsif /XCP/i.match?(lsb[:id])
-      platform "xcp"
-      platform_version lsb[:release]
     elsif lsb[:id] # LSB can provide odd data that changes between releases, so we currently fall back on it rather than dealing with its subtleties
       platform lsb[:id].downcase
       platform_version lsb[:release]

data/lib/ohai/plugins/linux/virtualization.rb

@@ -20,6 +20,7 @@
 Ohai.plugin(:Virtualization) do
   provides "virtualization"
   depends "dmi"
+  depends "cpu"
   require_relative "../../mixin/dmi_decode"
   include Ohai::Mixin::DmiDecode
 
@@ -35,6 +36,10 @@ Ohai.plugin(:Virtualization) do
     which("docker")
   end
 
+  def podman_exists?
+    which("podman")
+  end
+
   collect_data(:linux) do
     virtualization Mash.new unless virtualization
     virtualization[:systems] ||= Mash.new
@@ -46,6 +51,13 @@ Ohai.plugin(:Virtualization) do
       virtualization[:systems][:docker] = "host"
     end
 
+    # Podman hosts
+    if podman_exists?
+      virtualization[:system] = "podman"
+      virtualization[:role] = "host"
+      virtualization[:systems][:podman] = "host"
+    end
+
     # Xen Notes:
     # - /proc/xen is an empty dir for EL6 + Linode Guests + Paravirt EC2 instances
     # - cpuid of guests, if we could get it, would also be a clue
@@ -115,6 +127,14 @@ Ohai.plugin(:Virtualization) do
         virtualization[:role] = "host"
         virtualization[:systems][:kvm] = "host"
       end
+    elsif get_attribute(:cpu, :hypervisor_vendor)
+      if get_attribute(:cpu, :hypervisor_vendor) == "KVM"
+        virtualization[:system] = "kvm"
+        if /(para|full)/.match?(get_attribute(:cpu, :virtualization_type))
+          virtualization[:role] = "guest"
+          virtualization[:systems][:kvm] = "guest"
+        end
+      end
     end
 
     # parse dmi to discover various virtualization guests
@@ -188,7 +208,7 @@ Ohai.plugin(:Virtualization) do
     # <index #>:<subsystem>:/
     #
     # Full notes, https://tickets.opscode.com/browse/OHAI-551
-    # Kernel docs, https://www.kernel.org/doc/Documentation/cgroups
+    # Kernel docs, https://web.archive.org/web/20100514070914/http://www.kernel.org/doc/Documentation/cgroups/
     if file_exist?("/proc/self/cgroup")
       cgroup_content = file_read("/proc/self/cgroup")
       # These two REs catch many different examples. Here's a specific one
@@ -210,6 +230,20 @@ Ohai.plugin(:Virtualization) do
         virtualization[:system] = "nspawn"
         virtualization[:role] = "guest"
         virtualization[:systems][:nspawn] = "guest"
+      elsif /container=podman/.match?(file_read("/proc/1/environ"))
+        logger.trace("Plugin Virtualization: /proc/1/environ indicates podman container. Detecting as podman guest")
+        virtualization[:system] = "podman"
+        virtualization[:role] = "guest"
+        virtualization[:systems][:podman] = "guest"
+      # Detect any containers that appear to be using docker such as those running on Github Actions virtual machines
+      # but aren't triggered by the cgroup regex above. It's pretty safe to assume if the cgroup contains containerd,
+      # it's likely using docker.
+      # https://rubular.com/r/qhSmV113cPmEBT
+      elsif %r{^\d+:[^:]*:/[^/]+/(containerd)-?.+$}.match?(cgroup_content)
+        logger.trace("Plugin Virtualization: /proc/self/cgroup indicates docker container. Detecting as docker guest")
+        virtualization[:system] = "docker"
+        virtualization[:role] = "guest"
+        virtualization[:systems][:docker] = "guest"
       elsif lxc_version_exists? && file_read("/proc/self/cgroup") =~ %r{\d:[^:]+:/$}
         # lxc-version shouldn't be installed by default
         # Even so, it is likely we are on an LXC capable host that is not being used as such
@@ -225,7 +259,11 @@ Ohai.plugin(:Virtualization) do
         # If so, we may need to look further for a differentiator (OHAI-573)
         virtualization[:systems][:lxc] = "host"
       end
-    elsif file_exist?("/.dockerenv") || file_exist?("/.dockerinit")
+    end
+
+    # regardless of what we found above, if we're a docker container inside
+    # of the above, lets report as a docker container
+    if file_exist?("/.dockerenv") || file_exist?("/.dockerinit")
       logger.trace("Plugin Virtualization: .dockerenv or .dockerinit exist. Detecting as docker guest")
       virtualization[:system] = "docker"
       virtualization[:role] = "guest"