inspec 4.3.2 → 4.6.3

data/lib/{resources → inspec/resources}/vbscript.rb

@@ -1,6 +1,5 @@
-# encoding: utf-8
-
-require 'securerandom'
+require "inspec/resources/powershell"
+require "securerandom"
 
 module Inspec::Resources
   # This resource allows users to run vbscript on windows machines. We decided
@@ -19,10 +18,10 @@ module Inspec::Resources
   # Since Windows does not delete tmp files automatically, we remove the VBScript
   # after we executed it
   # @see https://msdn.microsoft.com/en-us/library/aa364991.aspx
-  class VBScript < PowershellScript
-    name 'vbscript'
-    supports platform: 'windows'
-    desc ''
+  class VBScript < Powershell
+    name "vbscript"
+    supports platform: "windows"
+    desc ""
     example <<~EXAMPLE
       script = <<-EOH
         # you vbscript
@@ -53,14 +52,14 @@ module Inspec::Resources
     end
 
     def to_s
-      'Windows VBScript'
+      "Windows VBScript"
     end
 
     private
 
     def parse_stdout
       res = inspec.backend.run_command(@command)
-      parsed_result = res.stdout.gsub(/#{@seperator}\r\n$/, '')
+      parsed_result = res.stdout.gsub(/#{@seperator}\r\n$/, "")
       res.stdout = parsed_result
       res
     end

data/lib/{resources → inspec/resources}/virtualization.rb

@@ -1,12 +1,10 @@
-# encoding: utf-8
-
-require 'hashie/mash'
+require "hashie/mash"
 
 module Inspec::Resources
   class Virtualization < Inspec.resource(1)
-    name 'virtualization'
-    supports platform: 'linux'
-    desc 'Use the virtualization InSpec audit resource to test the virtualization platform on which the system is running'
+    name "virtualization"
+    supports platform: "linux"
+    desc "Use the virtualization InSpec audit resource to test the virtualization platform on which the system is running"
     example <<~EXAMPLE
       describe virtualization do
         its('system') { should eq 'docker' }
@@ -42,21 +40,21 @@ module Inspec::Resources
     end
 
     def to_s
-      'Virtualization Detection'
+      "Virtualization Detection"
     end
 
     private
 
     def lxc_version_exists?
-      inspec.command('lxc-version').exist?
+      inspec.command("lxc-version").exist?
     end
 
     def docker_exists?
-      inspec.command('docker').exist?
+      inspec.command("docker").exist?
     end
 
     def nova_exists?
-      inspec.command('nova').exist?
+      inspec.command("nova").exist?
     end
 
     # Detect Xen
@@ -68,12 +66,12 @@ module Inspec::Resources
     #   but rather be additive - btm
     def detect_xen
       # This file should exist on most Xen systems, normally empty for guests
-      return false unless inspec.file('/proc/xen/capabilities').exist?
-      @virtualization_data[:system] = 'xen'
-      if inspec.file('/proc/xen/capabilities').content =~ /control_d/i
-        @virtualization_data[:role] = 'host'
+      return false unless inspec.file("/proc/xen/capabilities").exist?
+      @virtualization_data[:system] = "xen"
+      if inspec.file("/proc/xen/capabilities").content =~ /control_d/i
+        @virtualization_data[:role] = "host"
       else
-        @virtualization_data[:role] = 'guest'
+        @virtualization_data[:role] = "guest"
       end
 
       true
@@ -81,16 +79,16 @@ module Inspec::Resources
 
     # Detect Virtualbox from kernel module
     def detect_virtualbox
-      return false unless inspec.file('/proc/modules').exist?
-      modules = inspec.file('/proc/modules').content
+      return false unless inspec.file("/proc/modules").exist?
+      modules = inspec.file("/proc/modules").content
       if modules =~ /^vboxdrv/
-        Inspec::Log.debug('Plugin Virtualization: /proc/modules contains vboxdrv. Detecting as vbox host')
-        @virtualization_data[:system] = 'vbox'
-        @virtualization_data[:role] = 'host'
+        Inspec::Log.debug("Plugin Virtualization: /proc/modules contains vboxdrv. Detecting as vbox host")
+        @virtualization_data[:system] = "vbox"
+        @virtualization_data[:role] = "host"
       elsif modules =~ /^vboxguest/
-        Inspec::Log.debug('Plugin Virtualization: /proc/modules contains vboxguest. Detecting as vbox guest')
-        @virtualization_data[:system] = 'vbox'
-        @virtualization_data[:role] = 'guest'
+        Inspec::Log.debug("Plugin Virtualization: /proc/modules contains vboxguest. Detecting as vbox guest")
+        @virtualization_data[:system] = "vbox"
+        @virtualization_data[:role] = "guest"
       else
         return false
       end
@@ -100,28 +98,28 @@ module Inspec::Resources
     # if nova binary is present we're on an openstack host
     def detect_openstack
       return false unless nova_exists?
-      @virtualization_data[:system] = 'openstack'
-      @virtualization_data[:role] = 'host'
+      @virtualization_data[:system] = "openstack"
+      @virtualization_data[:role] = "host"
       true
     end
 
     # Detect paravirt KVM/QEMU from cpuinfo, report as KVM
     def detect_kvm_from_cpuinfo
-      return false unless inspec.file('/proc/cpuinfo').content =~ /QEMU Virtual CPU|Common KVM processor|Common 32-bit KVM processor/
-      @virtualization_data[:system] = 'kvm'
-      @virtualization_data[:role] = 'guest'
+      return false unless inspec.file("/proc/cpuinfo").content =~ /QEMU Virtual CPU|Common KVM processor|Common 32-bit KVM processor/
+      @virtualization_data[:system] = "kvm"
+      @virtualization_data[:role] = "guest"
       true
     end
 
     # Detect KVM systems via /sys
     # guests will have the hypervisor cpu feature that hosts don't have
     def detect_kvm_from_sys
-      return false unless inspec.file('/sys/devices/virtual/misc/kvm').exist?
-      @virtualization_data[:system] = 'kvm'
-      if inspec.file('/proc/cpuinfo').content =~ /hypervisor/
-        @virtualization_data[:role] = 'guest'
+      return false unless inspec.file("/sys/devices/virtual/misc/kvm").exist?
+      @virtualization_data[:system] = "kvm"
+      if inspec.file("/proc/cpuinfo").content =~ /hypervisor/
+        @virtualization_data[:role] = "guest"
       else
-        @virtualization_data[:role] = 'host'
+        @virtualization_data[:role] = "host"
       end
       true
     end
@@ -129,12 +127,12 @@ module Inspec::Resources
     # Detect OpenVZ / Virtuozzo.
     # http://wiki.openvz.org/BC_proc_entries
     def detect_openvz
-      if inspec.file('/proc/bc/0').exist?
-        @virtualization_data[:system] = 'openvz'
-        @virtualization_data[:role] = 'host'
-      elsif inspec.file('/proc/vz').exist?
-        @virtualization_data[:system] = 'openvz'
-        @virtualization_data[:role] = 'guest'
+      if inspec.file("/proc/bc/0").exist?
+        @virtualization_data[:system] = "openvz"
+        @virtualization_data[:role] = "host"
+      elsif inspec.file("/proc/vz").exist?
+        @virtualization_data[:system] = "openvz"
+        @virtualization_data[:role] = "guest"
       else
         return false
       end
@@ -143,23 +141,23 @@ module Inspec::Resources
 
     # Detect Parallels virtual machine from pci devices
     def detect_parallels
-      return false unless inspec.file('/proc/bus/pci/devices').content =~ /1ab84000/
-      @virtualization_data[:system] = 'parallels'
-      @virtualization_data[:role] = 'guest'
+      return false unless inspec.file("/proc/bus/pci/devices").content =~ /1ab84000/
+      @virtualization_data[:system] = "parallels"
+      @virtualization_data[:role] = "guest"
       true
     end
 
     # Detect Linux-VServer
     def detect_linux_vserver
-      return false unless inspec.file('/proc/self/status').exist?
-      proc_self_status = inspec.file('/proc/self/status').content
+      return false unless inspec.file("/proc/self/status").exist?
+      proc_self_status = inspec.file("/proc/self/status").content
       vxid = proc_self_status.match(/^(s_context|VxID):\s*(\d+)$/)
       return false unless vxid && vxid[2]
-      @virtualization_data[:system] = 'linux-vserver'
-      if vxid[2] == '0'
-        @virtualization_data[:role] = 'host'
+      @virtualization_data[:system] = "linux-vserver"
+      if vxid[2] == "0"
+        @virtualization_data[:role] = "host"
       else
-        @virtualization_data[:role] = 'guest'
+        @virtualization_data[:role] = "guest"
       end
       true
     end
@@ -183,19 +181,19 @@ module Inspec::Resources
     # Full notes, https://tickets.opscode.com/browse/OHAI-551
     # Kernel docs, https://www.kernel.org/doc/Documentation/cgroups
     def detect_lxc_docker
-      return false unless inspec.file('/proc/self/cgroup').exist?
-      cgroup_content = inspec.file('/proc/self/cgroup').content
+      return false unless inspec.file("/proc/self/cgroup").exist?
+      cgroup_content = inspec.file("/proc/self/cgroup").content
       if cgroup_content =~ %r{^\d+:[^:]+:/(lxc|docker)/.+$} ||
           cgroup_content =~ %r{^\d+:[^:]+:/[^/]+/(lxc|docker)-.+$} # rubocop:disable Layout/MultilineOperationIndentation
         @virtualization_data[:system] = $1 # rubocop:disable Style/PerlBackrefs
-        @virtualization_data[:role] = 'guest'
+        @virtualization_data[:role] = "guest"
       elsif lxc_version_exists? && cgroup_content =~ %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
         # So we're cautious here to not overwrite other existing values (OHAI-573)
         unless @virtualization_data[:system] && @virtualization_data[:role]
-          @virtualization_data[:system] = 'lxc'
-          @virtualization_data[:role] = 'host'
+          @virtualization_data[:system] = "lxc"
+          @virtualization_data[:role] = "host"
         end
       else
         return false
@@ -204,21 +202,21 @@ module Inspec::Resources
     end
 
     def detect_docker
-      return false unless inspec.file('/.dockerenv').exist? || inspec.file('/.dockerinit').exist?
-      @virtualization_data[:system] = 'docker'
-      @virtualization_data[:role] = 'guest'
+      return false unless inspec.file("/.dockerenv").exist? || inspec.file("/.dockerinit").exist?
+      @virtualization_data[:system] = "docker"
+      @virtualization_data[:role] = "guest"
       true
     end
 
     # Detect LXD
     # See https://github.com/lxc/lxd/blob/master/doc/dev-lxd.md
     def detect_lxd
-      if inspec.file('/dev/lxd/sock').exist?
-        @virtualization_data[:system] = 'lxd'
-        @virtualization_data[:role] = 'guest'
-      elsif inspec.file('/var/lib/lxd/devlxd').exist?
-        @virtualization_data[:system] = 'lxd'
-        @virtualization_data[:role] = 'host'
+      if inspec.file("/dev/lxd/sock").exist?
+        @virtualization_data[:system] = "lxd"
+        @virtualization_data[:role] = "guest"
+      elsif inspec.file("/var/lib/lxd/devlxd").exist?
+        @virtualization_data[:system] = "lxd"
+        @virtualization_data[:role] = "host"
       else
         return false
       end

data/lib/{resources → inspec/resources}/windows_feature.rb

@@ -1,10 +1,10 @@
-# encoding: utf-8
+require "inspec/resources/command"
 
 module Inspec::Resources
   class WindowsFeature < Inspec.resource(1)
-    name 'windows_feature'
-    supports platform: 'windows'
-    desc 'Use the windows_feature InSpec audit resource to test features on Microsoft Windows.'
+    name "windows_feature"
+    supports platform: "windows"
+    desc "Use the windows_feature InSpec audit resource to test features on Microsoft Windows."
     example <<~EXAMPLE
       # By default this resource will use Get-WindowsFeature.
       # Failing that, it will use DISM.
@@ -72,7 +72,7 @@ module Inspec::Resources
       if cmd.exit_status != 0
         feature_info = {
           name: feature,
-          description: 'N/A',
+          description: "N/A",
           installed: false,
         }
       else
@@ -100,7 +100,7 @@ module Inspec::Resources
       # non-server OS. This attempts to use the `dism` command to get the info.
       if cmd.stderr =~ /The term 'Get-WindowsFeature' is not recognized/
         feature_info[:name] = feature
-        feature_info[:error] = 'Could not find `Get-WindowsFeature`'
+        feature_info[:error] = "Could not find `Get-WindowsFeature`"
       else
         # We cannot rely on `cmd.exit_status != 0` because by default the
         # command will exit 1 even on success. So, if we cannot parse the JSON
@@ -109,9 +109,9 @@ module Inspec::Resources
           result = JSON.parse(cmd.stdout)
 
           feature_info = {
-            name: result['Name'],
-            description: result['Description'],
-            installed: result['Installed'],
+            name: result["Name"],
+            description: result["Description"],
+            installed: result["Installed"],
           }
         rescue JSON::ParserError => _e
           feature_info[:name] = feature

data/lib/{resources → inspec/resources}/windows_hotfix.rb

@@ -1,10 +1,10 @@
-# encoding: utf-8
+require "inspec/resources/powershell"
 
 module Inspec::Resources
   class WindowsHotfix < Inspec.resource(1)
-    name 'windows_hotfix'
-    supports platform: 'windows'
-    desc 'Use the windows_hotfix InSpec audit resource to test if the hotfix has been installed on the Windows system.'
+    name "windows_hotfix"
+    supports platform: "windows"
+    desc "Use the windows_hotfix InSpec audit resource to test if the hotfix has been installed on the Windows system."
     example <<~EXAMPLE
       describe windows_hotfix('KB4012212') do
         it { should be_installed }
@@ -17,7 +17,7 @@ module Inspec::Resources
       @id = hotfix_id.upcase
       @content = nil
       os = inspec.os
-      return skip_resource 'The `windows_hotfix` resource is not a feature of your OS.' unless os.windows?
+      return skip_resource "The `windows_hotfix` resource is not a feature of your OS." unless os.windows?
       query = "get-hotfix -id #{@id}"
       cmd = inspec.powershell(query)
       @content = cmd.stdout

data/lib/{resources → inspec/resources}/windows_task.rb

@@ -1,9 +1,10 @@
-# encoding: utf-8
+require "inspec/resources/powershell"
+
 module Inspec::Resources
-  class WindowsTasks < Inspec.resource(1)
-    name 'windows_task'
-    supports platform: 'windows'
-    desc 'Use the windows_task InSpec audit resource to test task schedules on Microsoft Windows.'
+  class WindowsTasks < Inspec.resource(1) # TODO: rename singular
+    name "windows_task"
+    supports platform: "windows"
+    desc "Use the windows_task InSpec audit resource to test task schedules on Microsoft Windows."
     example <<~EXAMPLE
       describe windows_task('\\Microsoft\\Windows\\Time Synchronization\\SynchronizeTime') do
         it { should be_enabled }
@@ -38,12 +39,12 @@ module Inspec::Resources
     # rubocop:disable Style/WordArray
     def enabled?
       return false if info.nil? || info[:state].nil?
-      ['Ready', 'Running'].include?(info[:state])
+      ["Ready", "Running"].include?(info[:state])
     end
 
     def disabled?
       return false if info.nil? || info[:state].nil?
-      info[:scheduled_task_state] == 'Disabled' || info[:state] == 'Disabled'
+      info[:scheduled_task_state] == "Disabled" || info[:state] == "Disabled"
     end
 
     def logon_mode
@@ -84,14 +85,14 @@ module Inspec::Resources
       end
 
       @cache = {
-        uri: params['URI'],
-        state: params['State'],
-        logon_mode: params['Logon Mode'],
-        last_result: params['Last Result'],
-        task_to_run: params['Task To Run'],
-        run_as_user: params['Run As User'],
-        scheduled_task_state: params['Scheduled Task State'],
-        type: 'windows-task',
+        uri: params["URI"],
+        state: params["State"],
+        logon_mode: params["Logon Mode"],
+        last_result: params["Last Result"],
+        task_to_run: params["Task To Run"],
+        run_as_user: params["Run As User"],
+        scheduled_task_state: params["Scheduled Task State"],
+        type: "windows-task",
       }
     end
 

data/lib/{resources → inspec/resources}/wmi.rb

@@ -1,6 +1,5 @@
-# encoding: utf-8
-
-require 'utils/object_traversal'
+require "inspec/resources/powershell"
+require "inspec/utils/object_traversal"
 
 module Inspec::Resources
   # This resource simplifies the access to wmi
@@ -8,9 +7,9 @@ module Inspec::Resources
   # WMIC /NAMESPACE:\\root\rsop\computer PATH RSOP_SecuritySettingNumeric WHERE "KeyName = 'MinimumPasswordAge' And precedence=1" GET Setting
   # We use Get-WmiObject via Powershell to retrieve all values.
   class WMI < Inspec.resource(1)
-    name 'wmi'
-    supports platform: 'windows'
-    desc 'request wmi information'
+    name "wmi"
+    supports platform: "windows"
+    desc "request wmi information"
     example <<~EXAMPLE
       describe wmi({
         class: 'RSOP_SecuritySettingNumeric',
@@ -29,7 +28,7 @@ module Inspec::Resources
       if wmiclass.is_a?(Hash)
         @options.merge!(wmiclass)
       else
-        Inspec.deprecate(:wmi_non_hash_usage, 'Using `wmi(\'wmisclass\')` is deprecated. Please use`wmi({class: \'wmisclass\'})`')
+        Inspec.deprecate(:wmi_non_hash_usage, "Using `wmi('wmisclass')` is deprecated. Please use`wmi({class: 'wmisclass'})`")
         @options[:class] = wmiclass
       end
     end
@@ -61,7 +60,7 @@ module Inspec::Resources
       args = @options.select { |key, _value| [:class, :namespace, :query, :filter].include?(key) }
 
       # convert to Get-WmiObject arguments
-      params = ''
+      params = ""
       args.each { |key, value| params += " -#{key} \"#{value.gsub('"', '`"')}\"" }
 
       # run wmi command and filter empty wmi

data/lib/{resources → inspec/resources}/x509_certificate.rb

@@ -1,15 +1,13 @@
-# encoding: utf-8
-
-require 'openssl'
-require 'hashie/mash'
-require 'utils/file_reader'
+require "openssl"
+require "hashie/mash"
+require "inspec/utils/file_reader"
 
 module Inspec::Resources
   class X509CertificateResource < Inspec.resource(1)
-    name 'x509_certificate'
-    supports platform: 'unix'
-    supports platform: 'windows'
-    desc 'Used to test x.509 certificates'
+    name "x509_certificate"
+    supports platform: "unix"
+    supports platform: "windows"
+    desc "Used to test x.509 certificates"
     example <<~EXAMPLE
       describe x509_certificate('/etc/pki/www.mywebsite.com.pem') do
         its('subject') { should match /CN=My Website/ }
@@ -47,8 +45,8 @@ module Inspec::Resources
 
     # Forward these methods directly to OpenSSL::X509::Certificate instance
     %w{version not_before not_after signature_algorithm public_key}.each do |m|
-      define_method m.to_sym do |*args|
-        @cert.method(m.to_sym).call(*args)
+      define_method m do |*args|
+        @cert.send(m, *args)
       end
     end