ohai 18.2.6 → 19.0.3

data/lib/ohai/plugins/azure.rb

@@ -1,154 +1,154 @@
-# 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(:Azure) do
-  require_relative "../mixin/azure_metadata"
-  require_relative "../mixin/http_helper"
-
-  include Ohai::Mixin::AzureMetadata
-  include Ohai::Mixin::HttpHelper
-
-  provides "azure"
-
-  collect_data do
-    # Before we had the metadata endpoint we relied exclusively on
-    # the knife-azure plugin populating data to the hint file.
-    # Please see the lib/chef/knife/azure_server_create.rb file in that
-    # project for details
-    azure_metadata_from_hints = hint?("azure")
-    if azure_metadata_from_hints
-      logger.trace("Plugin Azure: Azure hint is present. Parsing any hint data.")
-      azure Mash.new
-      azure_metadata_from_hints.each { |k, v| azure[k] = v }
-      azure["metadata"] = parse_metadata
-    elsif has_waagent? || has_dhcp_option_245? || has_reddog_dhcp_domain?
-      logger.trace("Plugin Azure: No hints present, but system appears to be on Azure.")
-      azure Mash.new
-      azure["metadata"] = parse_metadata
-    else
-      logger.trace("Plugin Azure: No hints present and doesn't appear to be on Azure.")
-      false
-    end
-  end
-
-  # check for either the waagent or the unknown-245 DHCP option that Azure uses
-  # http://blog.mszcool.com/index.php/2015/04/detecting-if-a-virtual-machine-runs-in-microsoft-azure-linux-windows-to-protect-your-software-when-distributed-via-the-azure-marketplace/
-  def has_waagent?
-    if file_exist?("/usr/sbin/waagent") || dir_exist?("C:\\WindowsAzure")
-      logger.trace("Plugin Azure: Found waagent used by Azure.")
-      true
-    end
-  end
-
-  def has_dhcp_option_245?
-    has_245 = false
-    if file_exist?("/var/lib/dhcp/dhclient.eth0.leases")
-      file_open("/var/lib/dhcp/dhclient.eth0.leases").each do |line|
-        if line.include?("unknown-245")
-          logger.trace("Plugin Azure: Found unknown-245 DHCP option used by Azure.")
-          has_245 = true
-          break
-        end
-      end
-    end
-    has_245
-  end
-
-  def has_reddog_dhcp_domain?
-    tcp_ip_dhcp_domain == "reddog.microsoft.com"
-  end
-
-  def tcp_ip_dhcp_domain
-    return unless RUBY_PLATFORM.match?(/mswin|mingw|windows/)
-
-    if ChefUtils.windows?
-      require "win32/registry" unless defined?(Win32::Registry)
-    end
-
-    begin
-      key = Win32::Registry::HKEY_LOCAL_MACHINE.open("SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters")
-      dhcp_domain = key["DhcpDomain"]
-      Ohai::Log.trace("Plugin Azure: DhcpDomain registry value is #{dhcp_domain}")
-    rescue Win32::Registry::Error
-      Ohai::Log.trace("Plugin Azure: DhcpDomain registry value cannot be found")
-    end
-
-    dhcp_domain
-  end
-
-  # create the basic structure we'll store our data in
-  def initialize_metadata_mash_compute
-    metadata = Mash.new
-    metadata["compute"] = Mash.new
-    metadata
-  end
-
-  def initialize_metadata_mash_network(metadata)
-    metadata["network"] = Mash.new
-    metadata["network"]["interfaces"] = Mash.new
-    %w{public_ipv4 local_ipv4 public_ipv6 local_ipv6}.each do |type|
-      metadata["network"][type] = []
-    end
-    metadata
-  end
-
-  def fetch_ip_data(data, type, field)
-    ips = []
-
-    data[type]["ipAddress"].each do |val|
-      ips << val[field] unless val[field].empty?
-    end
-    ips
-  end
-
-  def parse_metadata
-    return nil unless can_socket_connect?(Ohai::Mixin::AzureMetadata::AZURE_METADATA_ADDR, 80)
-
-    endpoint_data = fetch_metadata
-    return nil if endpoint_data.nil?
-
-    metadata = initialize_metadata_mash_compute
-
-    # blindly add everything in compute to our data structure
-    endpoint_data["compute"].each do |k, v|
-      metadata["compute"][k] = v
-    end
-
-    # receiving network output is not guaranteed
-    unless endpoint_data["network"].nil?
-      metadata = initialize_metadata_mash_network(metadata)
-      # parse out per interface interface IP data
-      endpoint_data["network"]["interface"].each do |int|
-        metadata["network"]["interfaces"][int["macAddress"]] = Mash.new
-        metadata["network"]["interfaces"][int["macAddress"]]["mac"] = int["macAddress"]
-        metadata["network"]["interfaces"][int["macAddress"]]["public_ipv6"] = fetch_ip_data(int, "ipv6", "publicIpAddress")
-        metadata["network"]["interfaces"][int["macAddress"]]["public_ipv4"] = fetch_ip_data(int, "ipv4", "publicIpAddress")
-        metadata["network"]["interfaces"][int["macAddress"]]["local_ipv6"] = fetch_ip_data(int, "ipv6", "privateIpAddress")
-        metadata["network"]["interfaces"][int["macAddress"]]["local_ipv4"] = fetch_ip_data(int, "ipv4", "privateIpAddress")
-      end
-
-      # aggregate the total IP data
-      %w{public_ipv4 local_ipv4 public_ipv6 local_ipv6}.each do |type|
-        metadata["network"]["interfaces"].each_value do |val|
-          metadata["network"][type].concat val[type] unless val[type].empty?
-        end
-      end
-    end
-
-    metadata
-  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.
+#
+
+Ohai.plugin(:Azure) do
+  require_relative "../mixin/azure_metadata"
+  require_relative "../mixin/http_helper"
+
+  include Ohai::Mixin::AzureMetadata
+  include Ohai::Mixin::HttpHelper
+
+  provides "azure"
+
+  collect_data do
+    # Before we had the metadata endpoint we relied exclusively on
+    # the knife-azure plugin populating data to the hint file.
+    # Please see the lib/chef/knife/azure_server_create.rb file in that
+    # project for details
+    azure_metadata_from_hints = hint?("azure")
+    if azure_metadata_from_hints
+      logger.trace("Plugin Azure: Azure hint is present. Parsing any hint data.")
+      azure Mash.new
+      azure_metadata_from_hints.each { |k, v| azure[k] = v }
+      azure["metadata"] = parse_metadata
+    elsif has_waagent? || has_dhcp_option_245? || has_reddog_dhcp_domain?
+      logger.trace("Plugin Azure: No hints present, but system appears to be on Azure.")
+      azure Mash.new
+      azure["metadata"] = parse_metadata
+    else
+      logger.trace("Plugin Azure: No hints present and doesn't appear to be on Azure.")
+      false
+    end
+  end
+
+  # check for either the waagent or the unknown-245 DHCP option that Azure uses
+  # http://blog.mszcool.com/index.php/2015/04/detecting-if-a-virtual-machine-runs-in-microsoft-azure-linux-windows-to-protect-your-software-when-distributed-via-the-azure-marketplace/
+  def has_waagent?
+    if file_exist?("/usr/sbin/waagent") || dir_exist?("C:\\WindowsAzure")
+      logger.trace("Plugin Azure: Found waagent used by Azure.")
+      true
+    end
+  end
+
+  def has_dhcp_option_245?
+    has_245 = false
+    if file_exist?("/var/lib/dhcp/dhclient.eth0.leases")
+      file_open("/var/lib/dhcp/dhclient.eth0.leases").each do |line|
+        if line.include?("unknown-245")
+          logger.trace("Plugin Azure: Found unknown-245 DHCP option used by Azure.")
+          has_245 = true
+          break
+        end
+      end
+    end
+    has_245
+  end
+
+  def has_reddog_dhcp_domain?
+    tcp_ip_dhcp_domain == "reddog.microsoft.com"
+  end
+
+  def tcp_ip_dhcp_domain
+    return unless RUBY_PLATFORM.match?(/mswin|mingw|windows/)
+
+    if ChefUtils.windows?
+      require "win32/registry" unless defined?(Win32::Registry)
+    end
+
+    begin
+      key = Win32::Registry::HKEY_LOCAL_MACHINE.open("SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters")
+      dhcp_domain = key["DhcpDomain"]
+      Ohai::Log.trace("Plugin Azure: DhcpDomain registry value is #{dhcp_domain}")
+    rescue Win32::Registry::Error
+      Ohai::Log.trace("Plugin Azure: DhcpDomain registry value cannot be found")
+    end
+
+    dhcp_domain
+  end
+
+  # create the basic structure we'll store our data in
+  def initialize_metadata_mash_compute
+    metadata = Mash.new
+    metadata["compute"] = Mash.new
+    metadata
+  end
+
+  def initialize_metadata_mash_network(metadata)
+    metadata["network"] = Mash.new
+    metadata["network"]["interfaces"] = Mash.new
+    %w{public_ipv4 local_ipv4 public_ipv6 local_ipv6}.each do |type|
+      metadata["network"][type] = []
+    end
+    metadata
+  end
+
+  def fetch_ip_data(data, type, field)
+    ips = []
+
+    data[type]["ipAddress"].each do |val|
+      ips << val[field] unless val[field].empty?
+    end
+    ips
+  end
+
+  def parse_metadata
+    return nil unless can_socket_connect?(Ohai::Mixin::AzureMetadata::AZURE_METADATA_ADDR, 80)
+
+    endpoint_data = fetch_metadata
+    return nil if endpoint_data.nil?
+
+    metadata = initialize_metadata_mash_compute
+
+    # blindly add everything in compute to our data structure
+    endpoint_data["compute"].each do |k, v|
+      metadata["compute"][k] = v
+    end
+
+    # receiving network output is not guaranteed
+    unless endpoint_data["network"].nil?
+      metadata = initialize_metadata_mash_network(metadata)
+      # parse out per interface interface IP data
+      endpoint_data["network"]["interface"].each do |int|
+        metadata["network"]["interfaces"][int["macAddress"]] = Mash.new
+        metadata["network"]["interfaces"][int["macAddress"]]["mac"] = int["macAddress"]
+        metadata["network"]["interfaces"][int["macAddress"]]["public_ipv6"] = fetch_ip_data(int, "ipv6", "publicIpAddress")
+        metadata["network"]["interfaces"][int["macAddress"]]["public_ipv4"] = fetch_ip_data(int, "ipv4", "publicIpAddress")
+        metadata["network"]["interfaces"][int["macAddress"]]["local_ipv6"] = fetch_ip_data(int, "ipv6", "privateIpAddress")
+        metadata["network"]["interfaces"][int["macAddress"]]["local_ipv4"] = fetch_ip_data(int, "ipv4", "privateIpAddress")
+      end
+
+      # aggregate the total IP data
+      %w{public_ipv4 local_ipv4 public_ipv6 local_ipv6}.each do |type|
+        metadata["network"]["interfaces"].each_value do |val|
+          metadata["network"][type].concat val[type] unless val[type].empty?
+        end
+      end
+    end
+
+    metadata
+  end
+end

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

@@ -1,121 +1,121 @@
-# frozen_string_literal: true
-#
-# Author:: Bryan McLellan (btm@loftninjas.org)
-# Copyright:: Copyright (c) 2009 Bryan McLellan
-# 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(:Virtualization) do
-  provides "virtualization"
-  depends "dmi"
-  require_relative "../../mixin/dmi_decode"
-  include Ohai::Mixin::DmiDecode
-
-  collect_data(:freebsd, :openbsd, :netbsd, :dragonflybsd) do
-
-    virtualization Mash.new unless virtualization
-    virtualization[:systems] ||= Mash.new
-
-    # detect when in a jail or when a jail is actively running (not in stopped state)
-    so = shell_out("sysctl -n security.jail.jailed")
-    if so.stdout.strip.to_i == 1
-      virtualization[:system] = "jail"
-      virtualization[:role] = "guest"
-      virtualization[:systems][:jail] = "guest"
-      logger.trace("Plugin Virtualization: Guest running in FreeBSD jail detected")
-    end
-
-    # run jls to get a list of running jails
-    # -n: name=value 1 line per jail format
-    # -d: list the dying jails as well as active jails
-    so = shell_out("jls -nd")
-    if (so.stdout || "").lines.count >= 1
-      virtualization[:system] = "jail"
-      virtualization[:role] = "host"
-      virtualization[:systems][:jail] = "host"
-      logger.trace("Plugin Virtualization: Host running FreeBSD jails detected")
-    end
-
-    # detect from modules
-    so = shell_out(Ohai.abs_path("/sbin/kldstat").to_s)
-    so.stdout.lines do |line|
-      case line
-      when /vboxdrv/
-        virtualization[:system] = "vbox"
-        virtualization[:role] = "host"
-        virtualization[:systems][:vbox] = "host"
-        logger.trace("Plugin Virtualization: Guest running on VirtualBox detected")
-      when /vboxguest/
-        virtualization[:system] = "vbox"
-        virtualization[:role] = "guest"
-        virtualization[:systems][:vbox] = "guest"
-        logger.trace("Plugin Virtualization: Host running VirtualBox detected")
-      end
-    end
-
-    # Detect bhyve by presence of /dev/vmm
-    if file_exist?("/dev/vmm")
-      virtualization[:system] = "bhyve"
-      virtualization[:role] = "host"
-      virtualization[:systems][:bhyve] = "host"
-      logger.trace("Plugin Virtualization: Host running bhyve detected")
-    end
-
-    # Detect KVM/QEMU paravirt guests from cpu, report as KVM
-    # hw.model: QEMU Virtual CPU version 0.9.1
-    so = shell_out("sysctl -n hw.model")
-    if /QEMU Virtual CPU|KVM processor/.match?(so.stdout)
-      virtualization[:system] = "kvm"
-      virtualization[:role] = "guest"
-      virtualization[:systems][:kvm] = "guest"
-      logger.trace("Plugin Virtualization: Guest running on KVM detected")
-    end
-
-    # gather hypervisor of guests from sysctl kern.vm_guest
-    # there are a limited number of hypervisors detected here, BUT it doesn't
-    # require dmidecode to be installed and dmidecode isn't in freebsd out of the box
-    so = shell_out("sysctl -n kern.vm_guest")
-    hypervisor = case so.stdout
-                 when /vmware/
-                   "vmware"
-                 when /hv/
-                   "hyperv"
-                 when /xen/
-                   "xen"
-                 when /kvm/
-                   so = shell_out("sysctl -n kern.hostuuid")
-                   /^ec2/.match?(so.stdout) ? "amazonec2" : "kvm"
-                 when /bhyve/
-                   "bhyve"
-                 end
-
-    if hypervisor
-      virtualization[:system] = hypervisor
-      virtualization[:role] = "guest"
-      virtualization[:systems][hypervisor.to_sym] = "guest"
-      logger.trace("Plugin Virtualization: Guest running on #{hypervisor} detected")
-    end
-
-    # parse dmi to discover various virtualization guests
-    guest = guest_from_dmi_data(get_attribute(:dmi, :system, :manufacturer), get_attribute(:dmi, :system, :product), get_attribute(:dmi, :system, :version))
-    if guest
-      logger.trace("Plugin Virtualization: DMI data indicates #{guest} guest")
-      virtualization[:system] = guest
-      virtualization[:role] = "guest"
-      virtualization[:systems][guest.to_sym] = "guest"
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Author:: Bryan McLellan (btm@loftninjas.org)
+# Copyright:: Copyright (c) 2009 Bryan McLellan
+# 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(:Virtualization) do
+  provides "virtualization"
+  depends "dmi"
+  require_relative "../../mixin/dmi_decode"
+  include Ohai::Mixin::DmiDecode
+
+  collect_data(:freebsd, :openbsd, :netbsd, :dragonflybsd) do
+
+    virtualization Mash.new unless virtualization
+    virtualization[:systems] ||= Mash.new
+
+    # detect when in a jail or when a jail is actively running (not in stopped state)
+    so = shell_out("sysctl -n security.jail.jailed")
+    if so.stdout.strip.to_i == 1
+      virtualization[:system] = "jail"
+      virtualization[:role] = "guest"
+      virtualization[:systems][:jail] = "guest"
+      logger.trace("Plugin Virtualization: Guest running in FreeBSD jail detected")
+    end
+
+    # run jls to get a list of running jails
+    # -n: name=value 1 line per jail format
+    # -d: list the dying jails as well as active jails
+    so = shell_out("jls -nd")
+    if (so.stdout || "").lines.count >= 1
+      virtualization[:system] = "jail"
+      virtualization[:role] = "host"
+      virtualization[:systems][:jail] = "host"
+      logger.trace("Plugin Virtualization: Host running FreeBSD jails detected")
+    end
+
+    # detect from modules
+    so = shell_out(Ohai.abs_path("/sbin/kldstat").to_s)
+    so.stdout.lines do |line|
+      case line
+      when /vboxdrv/
+        virtualization[:system] = "vbox"
+        virtualization[:role] = "host"
+        virtualization[:systems][:vbox] = "host"
+        logger.trace("Plugin Virtualization: Guest running on VirtualBox detected")
+      when /vboxguest/
+        virtualization[:system] = "vbox"
+        virtualization[:role] = "guest"
+        virtualization[:systems][:vbox] = "guest"
+        logger.trace("Plugin Virtualization: Host running VirtualBox detected")
+      end
+    end
+
+    # Detect bhyve by presence of /dev/vmm
+    if file_exist?("/dev/vmm")
+      virtualization[:system] = "bhyve"
+      virtualization[:role] = "host"
+      virtualization[:systems][:bhyve] = "host"
+      logger.trace("Plugin Virtualization: Host running bhyve detected")
+    end
+
+    # Detect KVM/QEMU paravirt guests from cpu, report as KVM
+    # hw.model: QEMU Virtual CPU version 0.9.1
+    so = shell_out("sysctl -n hw.model")
+    if /QEMU Virtual CPU|KVM processor/.match?(so.stdout)
+      virtualization[:system] = "kvm"
+      virtualization[:role] = "guest"
+      virtualization[:systems][:kvm] = "guest"
+      logger.trace("Plugin Virtualization: Guest running on KVM detected")
+    end
+
+    # gather hypervisor of guests from sysctl kern.vm_guest
+    # there are a limited number of hypervisors detected here, BUT it doesn't
+    # require dmidecode to be installed and dmidecode isn't in freebsd out of the box
+    so = shell_out("sysctl -n kern.vm_guest")
+    hypervisor = case so.stdout
+                 when /vmware/
+                   "vmware"
+                 when /hv/
+                   "hyperv"
+                 when /xen/
+                   "xen"
+                 when /kvm/
+                   so = shell_out("sysctl -n kern.hostuuid")
+                   /^ec2/.match?(so.stdout) ? "amazonec2" : "kvm"
+                 when /bhyve/
+                   "bhyve"
+                 end
+
+    if hypervisor
+      virtualization[:system] = hypervisor
+      virtualization[:role] = "guest"
+      virtualization[:systems][hypervisor.to_sym] = "guest"
+      logger.trace("Plugin Virtualization: Guest running on #{hypervisor} detected")
+    end
+
+    # parse dmi to discover various virtualization guests
+    guest = guest_from_dmi_data(get_attribute(:dmi, :system, :manufacturer), get_attribute(:dmi, :system, :product), get_attribute(:dmi, :system, :version))
+    if guest
+      logger.trace("Plugin Virtualization: DMI data indicates #{guest} guest")
+      virtualization[:system] = guest
+      virtualization[:role] = "guest"
+      virtualization[:systems][guest.to_sym] = "guest"
+    end
+  end
+end