inspec 4.3.2 → 4.6.3

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

@@ -1,7 +1,6 @@
-# encoding: utf-8
-
-require 'hashie'
-require 'utils/file_reader'
+require "hashie"
+require "inspec/utils/file_reader"
+require "inspec/utils/simpleconfig"
 
 module Inspec::Resources
   class Runlevels < Hash
@@ -67,10 +66,10 @@ module Inspec::Resources
   #
   # TODO: extend the logic to detect the running init system, independently of OS
   class Service < Inspec.resource(1)
-    name 'service'
-    supports platform: 'unix'
-    supports platform: 'windows'
-    desc 'Use the service InSpec audit resource to test if the named service is installed, running and/or enabled.'
+    name "service"
+    supports platform: "unix"
+    supports platform: "windows"
+    desc "Use the service InSpec audit resource to test if the named service is installed, running and/or enabled."
     example <<~EXAMPLE
       describe service('service_name') do
         it { should be_installed }
@@ -98,7 +97,7 @@ module Inspec::Resources
       @cache = nil
       @service_mgmt = select_service_mgmt
 
-      return skip_resource 'The `service` resource is not supported on your OS yet.' if @service_mgmt.nil?
+      return skip_resource "The `service` resource is not supported on your OS yet." if @service_mgmt.nil?
     end
 
     def select_service_mgmt # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
@@ -132,14 +131,14 @@ module Inspec::Resources
         if version > 7
           Systemd.new(inspec, service_ctl)
         else
-          SysV.new(inspec, service_ctl || '/usr/sbin/service')
+          SysV.new(inspec, service_ctl || "/usr/sbin/service")
         end
       elsif %w{redhat fedora centos oracle cloudlinux}.include?(platform)
         version = os[:release].to_i
-        if (%w{redhat centos oracle cloudlinux}.include?(platform) && version >= 7) || (platform == 'fedora' && version >= 15)
+        if (%w{redhat centos oracle cloudlinux}.include?(platform) && version >= 7) || (platform == "fedora" && version >= 15)
           Systemd.new(inspec, service_ctl)
         else
-          SysV.new(inspec, service_ctl || '/sbin/service')
+          SysV.new(inspec, service_ctl || "/sbin/service")
         end
       elsif %w{wrlinux}.include?(platform)
         SysV.new(inspec, service_ctl)
@@ -157,7 +156,7 @@ module Inspec::Resources
         if os[:release].to_i >= 12
           Systemd.new(inspec, service_ctl)
         else
-          SysV.new(inspec, service_ctl || '/sbin/service')
+          SysV.new(inspec, service_ctl || "/sbin/service")
         end
       elsif %w{aix}.include?(platform)
         SrcMstr.new(inspec)
@@ -202,7 +201,7 @@ module Inspec::Resources
 
     # get all runlevels that are available and their configuration
     def runlevels(*args)
-      return Runlevels.new(self) if info.nil? or info[:runlevels].nil?
+      return Runlevels.new(self) if info.nil? || info[:runlevels].nil?
       Runlevels.from_hash(self, info[:runlevels], args)
     end
 
@@ -249,7 +248,7 @@ module Inspec::Resources
   # @see: http://www.freedesktop.org/software/systemd/man/systemd-system.conf.html
   class Systemd < ServiceManager
     def initialize(inspec, service_ctl = nil)
-      @service_ctl = service_ctl || 'systemctl'
+      @service_ctl = service_ctl || "systemctl"
       super
     end
 
@@ -279,19 +278,19 @@ module Inspec::Resources
       params = SimpleConfig.new(
         cmd.stdout.chomp,
         assignment_regex: /^\s*([^=]*?)\s*=\s*(.*?)\s*$/,
-        multiple_values: false,
+        multiple_values: false
       ).params
 
       # LoadState values eg. loaded, not-found
-      installed = params['LoadState'] == 'loaded'
+      installed = params["LoadState"] == "loaded"
 
       {
-        name: params['Id'],
-        description: params['Description'],
+        name: params["Id"],
+        description: params["Description"],
         installed: installed,
         running: is_active?(service_name),
         enabled: is_enabled?(service_name),
-        type: 'systemd',
+        type: "systemd",
         params: params,
       }
     end
@@ -312,7 +311,7 @@ module Inspec::Resources
         installed: true,
         running: running,
         enabled: enabled?,
-        type: 'srcmstr',
+        type: "srcmstr",
       }
     end
 
@@ -330,7 +329,7 @@ module Inspec::Resources
 
     def enabled_rc_tcpip?
       inspec.command(
-        "grep -v ^# /etc/rc.tcpip | grep 'start ' | grep -Eq '(/{0,1}| )#{name} '",
+        "grep -v ^# /etc/rc.tcpip | grep 'start ' | grep -Eq '(/{0,1}| )#{name} '"
       ).exit_status == 0
     end
 
@@ -344,7 +343,7 @@ module Inspec::Resources
     include FileReader
 
     def initialize(service_name, service_ctl = nil)
-      @service_ctl = service_ctl || 'initctl'
+      @service_ctl = service_ctl || "initctl"
       super
     end
 
@@ -353,7 +352,7 @@ module Inspec::Resources
       status = inspec.command("#{service_ctl} status #{service_name}")
 
       # fallback for systemv services, those are not handled via `initctl`
-      return SysV.new(inspec).info(service_name) if status.exit_status.to_i != 0 || status.stdout == ''
+      return SysV.new(inspec).info(service_name) if status.exit_status.to_i != 0 || status.stdout == ""
 
       # @see: http://upstart.ubuntu.com/cookbook/#job-states
       # grep for running to indicate the service is there
@@ -366,7 +365,7 @@ module Inspec::Resources
         installed: true,
         running: running,
         enabled: enabled,
-        type: 'upstart',
+        type: "upstart",
       }
     end
 
@@ -388,17 +387,17 @@ module Inspec::Resources
   end
 
   class SysV < ServiceManager
-    RUNLEVELS = { 0=>false, 1=>false, 2=>false, 3=>false, 4=>false, 5=>false, 6=>false }.freeze
+    RUNLEVELS = { 0 => false, 1 => false, 2 => false, 3 => false, 4 => false, 5 => false, 6 => false }.freeze
 
     def initialize(service_name, service_ctl = nil)
-      @service_ctl = service_ctl || 'service'
+      @service_ctl = service_ctl || "service"
       super
     end
 
     def info(service_name)
       # check if service is installed
       # read all available services via ls /etc/init.d/
-      srvlist = inspec.command('ls -1 /etc/init.d/')
+      srvlist = inspec.command("ls -1 /etc/init.d/")
       return nil if srvlist.exit_status != 0
 
       # check if the service is in list
@@ -412,9 +411,9 @@ module Inspec::Resources
       # bash: for i in `find /etc/rc*.d -name S*`; do basename $i | sed -r 's/^S[0-9]+//'; done | sort | uniq
       enabled_services_cmd = inspec.command('find /etc/rc*.d /etc/init.d/rc*.d -name "S*"').stdout
       service_line = %r{rc(?<runlevel>[0-6])\.d/S[^/]*?#{Regexp.escape service_name}$}
-      all_services = enabled_services_cmd.split("\n").map { |line|
+      all_services = enabled_services_cmd.split("\n").map do |line|
         service_line.match(line)
-      }.compact
+      end.compact
       enabled = !all_services.empty?
 
       # Determine a list of runlevels which this service is activated for
@@ -434,7 +433,7 @@ module Inspec::Resources
         running: running,
         enabled: enabled,
         runlevels: runlevels,
-        type: 'sysv',
+        type: "sysv",
       }
     end
   end
@@ -443,7 +442,7 @@ module Inspec::Resources
   # @see: https://www.freebsd.org/cgi/man.cgi?query=rc.conf&sektion=5
   class BSDInit < ServiceManager
     def initialize(service_name, service_ctl = nil)
-      @service_ctl = service_ctl || 'service'
+      @service_ctl = service_ctl || "service"
       super
     end
 
@@ -473,14 +472,14 @@ module Inspec::Resources
         installed: true,
         running: running,
         enabled: enabled,
-        type: 'bsd-init',
+        type: "bsd-init",
       }
     end
   end
 
   class Runit < ServiceManager
     def initialize(service_name, service_ctl = nil)
-      @service_ctl = service_ctl || 'sv'
+      @service_ctl = service_ctl || "sv"
       super
     end
 
@@ -500,7 +499,7 @@ module Inspec::Resources
         installed: installed,
         running: running,
         enabled: enabled,
-        type: 'runit',
+        type: "runit",
       }
     end
   end
@@ -509,7 +508,7 @@ module Inspec::Resources
   # new launctl on macos 10.10
   class LaunchCtl < ServiceManager
     def initialize(service_name, service_ctl = nil)
-      @service_ctl = service_ctl || 'launchctl'
+      @service_ctl = service_ctl || "launchctl"
       super
     end
 
@@ -524,14 +523,14 @@ module Inspec::Resources
 
       # extract values from service
       parsed_srv = /^(?<pid>[0-9-]+)\t(?<exit>[0-9]+)\t(?<name>\S*)$/.match(srv[0])
-      enabled = !parsed_srv['name'].nil? # it's in the list
+      enabled = !parsed_srv["name"].nil? # it's in the list
 
       # check if the service is running
-      pid = parsed_srv['pid']
-      running = pid != '-'
+      pid = parsed_srv["pid"]
+      running = pid != "-"
 
       # extract service label
-      srv = parsed_srv['name'] || service_name
+      srv = parsed_srv["name"] || service_name
 
       {
         name: srv,
@@ -539,7 +538,7 @@ module Inspec::Resources
         installed: true,
         running: running,
         enabled: enabled,
-        type: 'darwin',
+        type: "darwin",
       }
     end
   end
@@ -590,16 +589,16 @@ module Inspec::Resources
       end
 
       # check that we got a response
-      return nil if service.nil? || service['Service'].nil?
+      return nil if service.nil? || service["Service"].nil?
 
       {
-        name: service['Service']['Name'],
-        description: service['Service']['DisplayName'],
+        name: service["Service"]["Name"],
+        description: service["Service"]["DisplayName"],
         installed: true,
         running: service_running?(service),
         enabled: service_enabled?(service),
-        startmode: service['WMI']['StartMode'],
-        type: 'windows',
+        startmode: service["WMI"]["StartMode"],
+        type: "windows",
       }
     end
 
@@ -607,22 +606,22 @@ module Inspec::Resources
 
     # detect if service is enabled
     def service_enabled?(service)
-      !service['WMI'].nil? &&
-        !service['WMI']['StartMode'].nil? &&
-        (service['WMI']['StartMode'] == 'Auto' ||
-        service['WMI']['StartMode'] == 'Manual')
+      !service["WMI"].nil? &&
+        !service["WMI"]["StartMode"].nil? &&
+        (service["WMI"]["StartMode"] == "Auto" ||
+        service["WMI"]["StartMode"] == "Manual")
     end
 
     # detect if service is running
     def service_running?(service)
-      !service['Service']['Status'].nil? && service['Service']['Status'] == 4
+      !service["Service"]["Status"].nil? && service["Service"]["Status"] == 4
     end
   end
 
   # Solaris services
   class Svcs < ServiceManager
     def initialize(service_name, service_ctl = nil)
-      @service_ctl = service_ctl || 'svcs'
+      @service_ctl = service_ctl || "svcs"
       super
     end
 
@@ -634,20 +633,20 @@ module Inspec::Resources
       params = SimpleConfig.new(
         cmd.stdout.chomp,
         assignment_regex: /^(\w+)\s*(.*)$/,
-        multiple_values: false,
+        multiple_values: false
       ).params
 
       installed = cmd.exit_status == 0
-      running = installed && (params['state'] == 'online')
-      enabled = installed && (params['enabled'] == 'true')
+      running = installed && (params["state"] == "online")
+      enabled = installed && (params["enabled"] == "true")
 
       {
         name: service_name,
-        description: params['name'],
+        description: params["name"],
         installed: installed,
         running: running,
         enabled: enabled,
-        type: 'svcs',
+        type: "svcs",
       }
     end
   end
@@ -655,9 +654,9 @@ module Inspec::Resources
   # specific resources for specific service managers
 
   class SystemdService < Service
-    name 'systemd_service'
-    supports platform: 'unix'
-    desc 'Use the systemd_service InSpec audit resource to test if the named service (controlled by systemd) is installed, running and/or enabled.'
+    name "systemd_service"
+    supports platform: "unix"
+    desc "Use the systemd_service InSpec audit resource to test if the named service (controlled by systemd) is installed, running and/or enabled."
     example <<~EXAMPLE
       # to override service mgmt auto-detection
       describe systemd_service('service_name') do
@@ -678,9 +677,9 @@ module Inspec::Resources
   end
 
   class UpstartService < Service
-    name 'upstart_service'
-    supports platform: 'unix'
-    desc 'Use the upstart_service InSpec audit resource to test if the named service (controlled by upstart) is installed, running and/or enabled.'
+    name "upstart_service"
+    supports platform: "unix"
+    desc "Use the upstart_service InSpec audit resource to test if the named service (controlled by upstart) is installed, running and/or enabled."
     example <<~EXAMPLE
       # to override service mgmt auto-detection
       describe upstart_service('service_name') do
@@ -701,9 +700,9 @@ module Inspec::Resources
   end
 
   class SysVService < Service
-    name 'sysv_service'
-    supports platform: 'unix'
-    desc 'Use the sysv_service InSpec audit resource to test if the named service (controlled by SysV) is installed, running and/or enabled.'
+    name "sysv_service"
+    supports platform: "unix"
+    desc "Use the sysv_service InSpec audit resource to test if the named service (controlled by SysV) is installed, running and/or enabled."
     example <<~EXAMPLE
       # to override service mgmt auto-detection
       describe sysv_service('service_name') do
@@ -724,9 +723,9 @@ module Inspec::Resources
   end
 
   class BSDService < Service
-    name 'bsd_service'
-    supports platform: 'unix'
-    desc 'Use the bsd_service InSpec audit resource to test if the named service (controlled by BSD init) is installed, running and/or enabled.'
+    name "bsd_service"
+    supports platform: "unix"
+    desc "Use the bsd_service InSpec audit resource to test if the named service (controlled by BSD init) is installed, running and/or enabled."
     example <<~EXAMPLE
       # to override service mgmt auto-detection
       describe bsd_service('service_name') do
@@ -747,9 +746,9 @@ module Inspec::Resources
   end
 
   class LaunchdService < Service
-    name 'launchd_service'
-    supports platform: 'unix'
-    desc 'Use the launchd_service InSpec audit resource to test if the named service (controlled by launchd) is installed, running and/or enabled.'
+    name "launchd_service"
+    supports platform: "unix"
+    desc "Use the launchd_service InSpec audit resource to test if the named service (controlled by launchd) is installed, running and/or enabled."
     example <<~EXAMPLE
       # to override service mgmt auto-detection
       describe launchd_service('service_name') do
@@ -770,9 +769,9 @@ module Inspec::Resources
   end
 
   class RunitService < Service
-    name 'runit_service'
-    supports platform: 'unix'
-    desc 'Use the runit_service InSpec audit resource to test if the named service (controlled by runit) is installed, running and/or enabled.'
+    name "runit_service"
+    supports platform: "unix"
+    desc "Use the runit_service InSpec audit resource to test if the named service (controlled by runit) is installed, running and/or enabled."
     example <<~EXAMPLE
       # to override service mgmt auto-detection
       describe runit_service('service_name') do

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

@@ -1,8 +1,7 @@
-# encoding: utf-8
 # copyright: 2016, Chef Software Inc.
 
-require 'utils/filter'
-require 'utils/file_reader'
+require "inspec/utils/filter"
+require "inspec/utils/file_reader"
 
 # The file format consists of
 # - user
@@ -16,11 +15,11 @@ require 'utils/file_reader'
 
 module Inspec::Resources
   class Shadow < Inspec.resource(1)
-    name 'shadow'
-    supports platform: 'unix'
-    desc 'Use the shadow InSpec resource to test the contents of /etc/shadow, '\
-         'which contains information for users that may log into '\
-         'the system and/or as users that own running processes.'
+    name "shadow"
+    supports platform: "unix"
+    desc "Use the shadow InSpec resource to test the contents of /etc/shadow, "\
+         "which contains information for users that may log into "\
+         "the system and/or as users that own running processes."
     example <<~EXAMPLE
       describe shadow do
         its('user') { should_not include 'forbidden_user' }
@@ -36,23 +35,23 @@ module Inspec::Resources
 
     attr_reader :params
 
-    def initialize(path = '/etc/shadow', opts = {})
+    def initialize(path = "/etc/shadow", opts = {})
       @opts = opts
-      @path = path || '/etc/shadow'
-      @filters = @opts[:filters] || ''
+      @path = path || "/etc/shadow"
+      @filters = @opts[:filters] || ""
     end
 
     filtertable = FilterTable.create
     filtertable
-      .register_column(:users, field: 'user')
-      .register_column(:passwords, field: 'password')
-      .register_column(:last_changes, field: 'last_change')
-      .register_column(:min_days, field: 'min_days')
-      .register_column(:max_days, field: 'max_days')
-      .register_column(:warn_days, field: 'warn_days')
-      .register_column(:inactive_days, field: 'inactive_days')
-      .register_column(:expiry_dates, field: 'expiry_date')
-      .register_column(:reserved, field: 'reserved')
+      .register_column(:users, field: "user")
+      .register_column(:passwords, field: "password")
+      .register_column(:last_changes, field: "last_change")
+      .register_column(:min_days, field: "min_days")
+      .register_column(:max_days, field: "max_days")
+      .register_column(:warn_days, field: "warn_days")
+      .register_column(:inactive_days, field: "inactive_days")
+      .register_column(:expiry_dates, field: "expiry_date")
+      .register_column(:reserved, field: "reserved")
     # These are deprecated, but we need to "alias" them
     filtertable
       .register_custom_property(:user) { |table, value| table.resource.user(value) }
@@ -60,18 +59,18 @@ module Inspec::Resources
       .register_custom_property(:last_change) { |table, value| table.resource.last_change(value) }
       .register_custom_property(:expiry_date) { |table, value| table.resource.expiry_date(value) }
 
-    filtertable.register_custom_property(:content) { |t, _|
+    filtertable.register_custom_property(:content) do |t, _|
       t.entries.map do |e|
-        [e.user, e.password, e.last_change, e.min_days, e.max_days, e.warn_days, e.inactive_days, e.expiry_date].compact.join(':')
+        [e.user, e.password, e.last_change, e.min_days, e.max_days, e.warn_days, e.inactive_days, e.expiry_date].compact.join(":")
       end.join("\n")
-    }
+    end
 
     filtertable.install_filter_methods_on_resource(self, :set_params)
 
     def filter(query = {})
       return self if query.nil? || query.empty?
       res = set_params
-      filters = ''
+      filters = ""
       query.each do |attr, condition|
         condition = condition.to_s if condition.is_a? Integer
         filters += " #{attr} = #{condition.inspect}"
@@ -84,39 +83,39 @@ module Inspec::Resources
           end
         end
       end
-      content = res.map { |x| x.values.join(':') }.join("\n")
+      content = res.map { |x| x.values.join(":") }.join("\n")
       Shadow.new(@path, content: content, filters: @filters + filters)
     end
 
     # Next 4 are deprecated methods.  We define them here so we can emit a deprecation message.
     # They are also defined on the Table, above.
     def user(query = nil)
-      Inspec.deprecate(:properties_shadow, 'The shadow `user` property is deprecated. Please use `users` instead.')
-      query.nil? ? where.users : where('user' => query)
+      Inspec.deprecate(:properties_shadow, "The shadow `user` property is deprecated. Please use `users` instead.")
+      query.nil? ? where.users : where("user" => query)
     end
 
     def password(query = nil)
-      Inspec.deprecate(:properties_shadow, 'The shadow `password` property is deprecated. Please use `passwords` instead.')
-      query.nil? ? where.passwords : where('password' => query)
+      Inspec.deprecate(:properties_shadow, "The shadow `password` property is deprecated. Please use `passwords` instead.")
+      query.nil? ? where.passwords : where("password" => query)
     end
 
     def last_change(query = nil)
-      Inspec.deprecate(:properties_shadow, 'The shadow `last_change` property is deprecated. Please use `last_changes` instead.')
-      query.nil? ? where.last_changes : where('last_change' => query)
+      Inspec.deprecate(:properties_shadow, "The shadow `last_change` property is deprecated. Please use `last_changes` instead.")
+      query.nil? ? where.last_changes : where("last_change" => query)
     end
 
     def expiry_date(query = nil)
-      Inspec.deprecate(:properties_shadow, 'The shadow `expiry_date` property is deprecated. Please use `expiry_dates` instead.')
-      query.nil? ? where.expiry_dates : where('expiry_date' => query)
+      Inspec.deprecate(:properties_shadow, "The shadow `expiry_date` property is deprecated. Please use `expiry_dates` instead.")
+      query.nil? ? where.expiry_dates : where("expiry_date" => query)
     end
 
     def lines
-      Inspec.deprecate(:properties_shadow, 'The shadow `lines` property is deprecated.')
+      Inspec.deprecate(:properties_shadow, "The shadow `lines` property is deprecated.")
       shadow_content.to_s.split("\n")
     end
 
     def to_s
-      f = @filters.empty? ? '' : ' with'+@filters
+      f = @filters.empty? ? "" : " with" + @filters
       "#{@path}#{f}"
     end
 
@@ -139,17 +138,17 @@ module Inspec::Resources
     # @param [String] line a line of /etc/shadow
     # @return [Hash] Map of entries in this line
     def parse_shadow_line(line)
-      x = line.split(':')
+      x = line.split(":")
       {
-        'user'          => x.at(0),
-        'password'      => x.at(1),
-        'last_change'   => x.at(2),
-        'min_days'      => x.at(3),
-        'max_days'      => x.at(4),
-        'warn_days'     => x.at(5),
-        'inactive_days' => x.at(6),
-        'expiry_date'   => x.at(7),
-        'reserved'      => x.at(8),
+        "user" => x.at(0),
+        "password" => x.at(1),
+        "last_change" => x.at(2),
+        "min_days" => x.at(3),
+        "max_days" => x.at(4),
+        "warn_days" => x.at(5),
+        "inactive_days" => x.at(6),
+        "expiry_date" => x.at(7),
+        "reserved" => x.at(8),
       }
     end
   end