ohai 18.0.26 → 18.1.0

data/lib/ohai/plugins/vmware.rb

@@ -1,94 +1,109 @@
-# frozen_string_literal: true
-#
-# Author:: "Dan Robinson" <drobinson@chef.io>
-# Author:: "Christopher M. Luciano" <cmlucian@us.ibm.com>
-# Copyright:: Copyright (c) Chef Software Inc.
-# Copyright (C) 2015 IBM Corp.
-# 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.
-#
-
-#
-# Provides a set of attributes for a VMware ESX virtual machine with results
-# obtained from vmware-toolbox-cmd.  VMware Tools must be installed
-# on the virtual machine.
-#
-# Modify the path to vmware-toolbox-cmd in the call to get_vm_attributes for
-# your particular operating system and configuration
-#
-# Example:
-#
-# get_vm_attributes("/usr/bin/vmware-toolbox-cmd")
-#
-
-Ohai.plugin(:VMware) do
-  provides "vmware"
-  depends "virtualization"
-
-  def from_cmd(cmd)
-    shell_out(cmd).stdout.strip
-  end
-
-  def get_vm_attributes(vmtools_path)
-    if !file_exist?(vmtools_path)
-      logger.trace("Plugin VMware: #{vmtools_path} not found")
-    else
-      vmware Mash.new
-      vmware[:host] = Mash.new
-      vmware[:guest] = Mash.new
-      begin
-        # vmware-toolbox-cmd stat <param> commands
-        # Iterate through each parameter supported by the "vwware-toolbox-cmd stat" command, assign value
-        # to attribute "vmware[:<parameter>]"
-        %w{hosttime speed sessionid balloon swap memlimit memres cpures cpulimit}.each do |param|
-          vmware[param] = from_cmd([vmtools_path, "stat", param])
-          if /UpdateInfo failed/.match?(vmware[param])
-            vmware[param] = nil
-          end
-        end
-        # vmware-toolbox-cmd <param> status commands
-        # Iterate through each parameter supported by the "vmware-toolbox-cmd status" command, assign value
-        # to attribute "vmware[:<parameter>]"
-        %w{upgrade timesync}.each do |param|
-          vmware[param] = from_cmd([vmtools_path, param, "status"])
-        end
-        # Distinguish hypervisors by presence of raw session data (vSphere only)
-        raw_session = from_cmd([vmtools_path, "stat", "raw", "json", "session"])
-        if raw_session.empty?
-          vmware[:host] = {
-            type: "vmware_desktop",
-          }
-        else
-          require "json" unless defined?(JSON)
-          session = JSON.parse(raw_session)
-          vmware[:host] = {
-            type: "vmware_vsphere",
-            version: session["version"],
-          }
-        end
-        vmware[:guest][:vmware_tools_version] = from_cmd([vmtools_path, "-v"]).split(" ").first
-      rescue
-        logger.trace("Plugin VMware: Error while collecting VMware guest attributes")
-      end
-    end
-  end
-
-  collect_data(:linux) do
-    get_vm_attributes("/usr/bin/vmware-toolbox-cmd") if virtualization[:systems][:vmware]
-  end
-
-  collect_data(:windows) do
-    get_vm_attributes("C:/Program Files/VMWare/VMware Tools/VMwareToolboxCmd.exe") if virtualization[:systems][:vmware]
-  end
-end
+# frozen_string_literal: true
+#
+# Author:: "Dan Robinson" <drobinson@chef.io>
+# Author:: "Christopher M. Luciano" <cmlucian@us.ibm.com>
+# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright (C) 2015 IBM Corp.
+# 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.
+#
+
+#
+# Provides a set of attributes for a VMware ESX virtual machine with results
+# obtained from vmware-toolbox-cmd.  VMware Tools must be installed
+# on the virtual machine.
+#
+# Modify the path to vmware-toolbox-cmd in the call to get_vm_attributes for
+# your particular operating system and configuration
+#
+# Example:
+#
+# get_vm_attributes("/usr/bin/vmware-toolbox-cmd")
+#
+
+Ohai.plugin(:VMware) do
+  provides "vmware"
+  depends "virtualization"
+
+  def from_cmd(cmd)
+    shell_out(cmd).stdout.strip
+  end
+
+  def get_vm_attributes(vmtools_path)
+    if !file_exist?(vmtools_path)
+      logger.trace("Plugin VMware: #{vmtools_path} not found")
+    else
+      vmware Mash.new
+      vmware[:host] = Mash.new
+      vmware[:guest] = Mash.new
+      begin
+        # vmware-toolbox-cmd stat <param> commands
+        # Iterate through each parameter supported by the "vwware-toolbox-cmd stat" command, assign value
+        # to attribute "vmware[:<parameter>]"
+        %w{hosttime speed sessionid balloon swap memlimit memres cpures cpulimit}.each do |param|
+          vmware[param] = from_cmd([vmtools_path, "stat", param])
+          if param == "hosttime" && vmtools_path.include?("Program Files")
+            # popen and %x return stdout encoded as IBM437 in Windows but in a string marked
+            # UTF-8. The string doesn't throw an exception when encoded to "UTF-8" but
+            # displays [?] character in Windows without this.
+            #
+            # .force_encoding(Encoding::ISO_8859_1) causes the character to be dropped
+            # and .force_encoding(Encoding::Windows_1252) displays the „ character in place
+            # of an ä. .force_encoding(Encoding::IBM437) allows for the correct characters
+            # to be displayed.
+            #
+            # Note:
+            # * this is broken for at least Ruby 2.7 through 3.1.3
+            # * confirmed that this is broken on Windows Server 2022
+            vmware[param] = vmware[param].force_encoding(Encoding::IBM437).encode("UTF-8")
+          end
+          if vmware[param].include?("UpdateInfo failed")
+            vmware[param] = nil
+          end
+        end
+        # vmware-toolbox-cmd <param> status commands
+        # Iterate through each parameter supported by the "vmware-toolbox-cmd status" command, assign value
+        # to attribute "vmware[:<parameter>]"
+        %w{upgrade timesync}.each do |param|
+          vmware[param] = from_cmd([vmtools_path, param, "status"])
+        end
+        # Distinguish hypervisors by presence of raw session data (vSphere only)
+        raw_session = from_cmd([vmtools_path, "stat", "raw", "json", "session"])
+        if raw_session.empty?
+          vmware[:host] = {
+            type: "vmware_desktop",
+          }
+        else
+          require "json" unless defined?(JSON)
+          session = JSON.parse(raw_session)
+          vmware[:host] = {
+            type: "vmware_vsphere",
+            version: session["version"],
+          }
+        end
+        vmware[:guest][:vmware_tools_version] = from_cmd([vmtools_path, "-v"]).split(" ").first
+      rescue
+        logger.trace("Plugin VMware: Error while collecting VMware guest attributes")
+      end
+    end
+  end
+
+  collect_data(:linux) do
+    get_vm_attributes("/usr/bin/vmware-toolbox-cmd") if virtualization[:systems][:vmware]
+  end
+
+  collect_data(:windows) do
+    get_vm_attributes("C:/Program Files/VMWare/VMware Tools/VMwareToolboxCmd.exe") if virtualization[:systems][:vmware]
+  end
+end

data/lib/ohai/plugins/windows/dmi.rb

@@ -1,95 +1,95 @@
-# frozen_string_literal: true
-#
-# Author:: Pete Higgins (pete@peterhiggins.org)
-# 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(:DMI) do
-  provides "dmi"
-
-  # Map the linux component types to their rough Windows API equivalents
-  DMI_TO_WIN32OLE ||= {
-    chassis: "SystemEnclosure",
-    processor: "Processor",
-    bios: "Bios",
-    system: "ComputerSystemProduct",
-    base_board: "BaseBoard",
-  }.freeze
-
-  # This regex is in 3 parts for the different supported patterns in camel
-  # case names coming from the Windows API:
-  # * Typical camelcase, eg Depth, PartNumber, NumberOfPowerCords
-  # * Acronyms preceding camelcase, eg SMBIOSAssetTag
-  # * Acronyms that occur at the end of the name, eg SKU, DeviceID
-  #
-  # This cannot handle some property names, eg SMBIOSBIOSVersion.
-  # https://rubular.com/r/FBNtXod4wkZGAG
-  SPLIT_REGEX ||= /[A-Z][a-z0-9]+|[A-Z]{2,}(?=[A-Z][a-z0-9])|[A-Z]{2,}/.freeze
-
-  WINDOWS_TO_UNIX_KEYS ||= [
-    %w{vendor manufacturer},
-    %w{identifying_number serial_number},
-    %w{name family},
-  ].freeze
-
-  collect_data(:windows) do
-    require_relative "../../common/dmi"
-    require "wmi-lite/wmi" unless defined?(WmiLite::Wmi)
-    wmi = WmiLite::Wmi.new
-
-    dmi Mash.new
-
-    # The Windows API returns property names in camel case, eg "SerialNumber",
-    # while `dmi` returns them as space separated strings, eg "Serial Number".
-    # `Ohai::Common::DMI.convenience_keys` expects property names in `dmi`'s
-    # format, so build two parallel hashes with the keys as they come from the
-    # Windows API and in a faked-out `dmi` version. After the call to
-    # `Ohai::Common::DMI.convenience_keys` replace the faked-out `dmi`
-    # collection with the one with the original property names.
-    DMI_TO_WIN32OLE.each do |dmi_key, ole_key|
-      wmi_objects = wmi.instances_of("Win32_#{ole_key}").map(&:wmi_ole_object)
-
-      split_name_properties = []
-      properties = []
-
-      wmi_objects.each do |wmi_object|
-        split_name_properties << Mash.new
-        properties << Mash.new
-
-        wmi_object.properties_.each do |property|
-          property_name = property.name
-          value = wmi_object.invoke(property_name)
-
-          split_name = property_name.scan(SPLIT_REGEX).join(" ")
-          split_name_properties.last[split_name] = value
-          properties.last[property_name] = value
-        end
-      end
-
-      dmi[dmi_key] = Mash.new(all_records: split_name_properties, _all_records: properties)
-    end
-
-    Ohai::Common::DMI.convenience_keys(dmi)
-
-    dmi.each_value do |records|
-      records[:all_records] = records.delete(:_all_records)
-
-      WINDOWS_TO_UNIX_KEYS.each do |windows_key, unix_key|
-        records[unix_key] = records.delete(windows_key) if records.key?(windows_key)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Author:: Pete Higgins (pete@peterhiggins.org)
+# 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(:DMI) do
+  provides "dmi"
+
+  # Map the linux component types to their rough Windows API equivalents
+  DMI_TO_WIN32OLE ||= {
+    chassis: "SystemEnclosure",
+    processor: "Processor",
+    bios: "Bios",
+    system: "ComputerSystemProduct",
+    base_board: "BaseBoard",
+  }.freeze
+
+  # This regex is in 3 parts for the different supported patterns in camel
+  # case names coming from the Windows API:
+  # * Typical camelcase, eg Depth, PartNumber, NumberOfPowerCords
+  # * Acronyms preceding camelcase, eg SMBIOSAssetTag
+  # * Acronyms that occur at the end of the name, eg SKU, DeviceID
+  #
+  # This cannot handle some property names, eg SMBIOSBIOSVersion.
+  # https://rubular.com/r/FBNtXod4wkZGAG
+  SPLIT_REGEX ||= /[A-Z][a-z0-9]+|[A-Z]{2,}(?=[A-Z][a-z0-9])|[A-Z]{2,}/.freeze
+
+  WINDOWS_TO_UNIX_KEYS ||= [
+    %w{vendor manufacturer},
+    %w{identifying_number serial_number},
+    %w{name family},
+  ].freeze
+
+  collect_data(:windows) do
+    require_relative "../../common/dmi"
+    require "wmi-lite/wmi" unless defined?(WmiLite::Wmi)
+    wmi = WmiLite::Wmi.new
+
+    dmi Mash.new
+
+    # The Windows API returns property names in camel case, eg "SerialNumber",
+    # while `dmi` returns them as space separated strings, eg "Serial Number".
+    # `Ohai::Common::DMI.convenience_keys` expects property names in `dmi`'s
+    # format, so build two parallel hashes with the keys as they come from the
+    # Windows API and in a faked-out `dmi` version. After the call to
+    # `Ohai::Common::DMI.convenience_keys` replace the faked-out `dmi`
+    # collection with the one with the original property names.
+    DMI_TO_WIN32OLE.each do |dmi_key, ole_key|
+      wmi_objects = wmi.instances_of("Win32_#{ole_key}").map(&:wmi_ole_object)
+
+      split_name_properties = []
+      properties = []
+
+      wmi_objects.each do |wmi_object|
+        split_name_properties << Mash.new
+        properties << Mash.new
+
+        wmi_object.properties_.each do |property|
+          property_name = property.name
+          value = wmi_object.invoke(property_name)
+
+          split_name = property_name.scan(SPLIT_REGEX).join(" ")
+          split_name_properties.last[split_name] = value
+          properties.last[property_name] = value
+        end
+      end
+
+      dmi[dmi_key] = Mash.new(all_records: split_name_properties, _all_records: properties)
+    end
+
+    Ohai::Common::DMI.convenience_keys(dmi)
+
+    dmi.each_value do |records|
+      records[:all_records] = records.delete(:_all_records)
+
+      WINDOWS_TO_UNIX_KEYS.each do |windows_key, unix_key|
+        records[unix_key] = records.delete(windows_key) if records.key?(windows_key)
+      end
+    end
+  end
+end

data/lib/ohai/plugins/windows/drivers.rb

@@ -1,52 +1,52 @@
-# 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(:Drivers) do
-  provides "kernel/pnp_drivers", "kernel/modules"
-  depends "kernel"
-
-  collect_data(:windows) do
-    if configuration(:enabled)
-
-      require "wmi-lite/wmi" unless defined?(WmiLite::Wmi)
-
-      kext = Mash.new
-      pnp_drivers = Mash.new
-
-      wmi = WmiLite::Wmi.new
-
-      drivers = wmi.instances_of("Win32_PnPSignedDriver")
-      drivers.each do |driver|
-        pnp_drivers[driver["deviceid"]] = Mash.new
-        driver.wmi_ole_object.properties_.each do |p|
-          pnp_drivers[driver["deviceid"]][p.name.wmi_underscore.to_sym] = driver[p.name.downcase]
-        end
-        if driver["devicename"]
-          kext[driver["devicename"]] = pnp_drivers[driver["deviceid"]]
-          kext[driver["devicename"]][:version] = pnp_drivers[driver["deviceid"]][:driver_version]
-          kext[driver["devicename"]][:date] = pnp_drivers[driver["deviceid"]][:driver_date] ? pnp_drivers[driver["deviceid"]][:driver_date].to_s[0..7] : nil
-        end
-      end
-
-      kernel[:pnp_drivers] = pnp_drivers
-      kernel[:modules] = kext
-
-    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.
+#
+
+Ohai.plugin(:Drivers) do
+  provides "kernel/pnp_drivers", "kernel/modules"
+  depends "kernel"
+
+  collect_data(:windows) do
+    if configuration(:enabled)
+
+      require "wmi-lite/wmi" unless defined?(WmiLite::Wmi)
+
+      kext = Mash.new
+      pnp_drivers = Mash.new
+
+      wmi = WmiLite::Wmi.new
+
+      drivers = wmi.instances_of("Win32_PnPSignedDriver")
+      drivers.each do |driver|
+        pnp_drivers[driver["deviceid"]] = Mash.new
+        driver.wmi_ole_object.properties_.each do |p|
+          pnp_drivers[driver["deviceid"]][p.name.wmi_underscore.to_sym] = driver[p.name.downcase]
+        end
+        if driver["devicename"]
+          kext[driver["devicename"]] = pnp_drivers[driver["deviceid"]]
+          kext[driver["devicename"]][:version] = pnp_drivers[driver["deviceid"]][:driver_version]
+          kext[driver["devicename"]][:date] = pnp_drivers[driver["deviceid"]][:driver_date] ? pnp_drivers[driver["deviceid"]][:driver_date].to_s[0..7] : nil
+        end
+      end
+
+      kernel[:pnp_drivers] = pnp_drivers
+      kernel[:modules] = kext
+
+    end
+  end
+
+end

data/lib/ohai/plugins/windows/memory.rb

@@ -1,39 +1,39 @@
-# frozen_string_literal: true
-#
-# 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(:Memory) do
-  provides "memory"
-
-  collect_data(:windows) do
-    require "wmi-lite/wmi" unless defined?(WmiLite::Wmi)
-
-    memory Mash.new
-    memory[:swap] = Mash.new
-
-    wmi = WmiLite::Wmi.new
-
-    os = wmi.first_of("Win32_OperatingSystem")
-
-    # MemTotal
-    memory[:total] = os["TotalVisibleMemorySize"] + "kB"
-    # MemFree
-    memory[:free] = os["FreePhysicalMemory"] + "kB"
-    # SwapTotal
-    memory[:swap][:total] = os["SizeStoredInPagingFiles"] + "kB"
-    # SwapFree
-    memory[:swap][:free] = os["FreeSpaceInPagingFiles"] + "kB"
-  end
-end
+# frozen_string_literal: true
+#
+# 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(:Memory) do
+  provides "memory"
+
+  collect_data(:windows) do
+    require "wmi-lite/wmi" unless defined?(WmiLite::Wmi)
+
+    memory Mash.new
+    memory[:swap] = Mash.new
+
+    wmi = WmiLite::Wmi.new
+
+    os = wmi.first_of("Win32_OperatingSystem")
+
+    # MemTotal
+    memory[:total] = os["TotalVisibleMemorySize"] + "kB"
+    # MemFree
+    memory[:free] = os["FreePhysicalMemory"] + "kB"
+    # SwapTotal
+    memory[:swap][:total] = os["SizeStoredInPagingFiles"] + "kB"
+    # SwapFree
+    memory[:swap][:free] = os["FreeSpaceInPagingFiles"] + "kB"
+  end
+end