inspec 2.0.16 → 2.0.17

data/lib/resources/json.rb

@@ -1,117 +1,117 @@
-# encoding: utf-8
-
-require 'utils/object_traversal'
-
-module Inspec::Resources
-  class JsonConfig < Inspec.resource(1)
-    name 'json'
-    supports platform: 'unix'
-    supports platform: 'windows'
-    supports platform: 'esx'
-    supports platform: 'cisco'
-    desc 'Use the json InSpec audit resource to test data in a JSON file.'
-    example "
-      describe json('policyfile.lock.json') do
-        its(['cookbook_locks','omnibus','version']) { should eq('2.2.0') }
-      end
-
-      describe json({ command: 'retrieve_data.py --json' }) do
-        its('state') { should eq('open') }
-      end
-
-      describe json({ content: '{\"item1\": { \"status\": \"available\" } }' }) do
-        its(['item1', 'status']) { should cmp 'available' }
-      end
-
-    "
-
-    include ObjectTraverser
-
-    # make params readable
-    attr_reader :params, :raw_content
-
-    def initialize(opts)
-      # pre-initialize @params to an empty hash. In the event that reading/parsing the data
-      # throws an exception, this allows the resource to still be called outside of a
-      # describe/test and not throw errors when a caller attempts to fetch a value from the params.
-      @params = {}
-
-      # load the raw content from the source, and then parse it
-      @raw_content = load_raw_content(opts)
-      @params = parse(@raw_content)
-    end
-
-    # Shorthand to retrieve a parameter name via `#its`.
-    # Example: describe json('file') { its('paramX') { should eq 'Y' } }
-    #
-    # @param [String] name name of the field to retrieve
-    # @return [Object] the value stored at this position
-    def method_missing(*keys)
-      # catch bahavior of rspec its implementation
-      # @see https://github.com/rspec/rspec-its/blob/master/lib/rspec/its.rb#L110
-      keys.shift if keys.is_a?(Array) && keys[0] == :[]
-      value(keys)
-    end
-
-    def value(key)
-      # uses ObjectTraverser.extract_value to walk the hash looking for the key,
-      # which may be an Array of keys for a nested Hash.
-      extract_value(key, params)
-    end
-
-    def to_s
-      "#{resource_base_name} #{@resource_name_supplement || 'content'}"
-    end
-
-    private
-
-    def parse(content)
-      require 'json'
-      JSON.parse(content)
-    rescue => e
-      raise Inspec::Exceptions::ResourceFailed, "Unable to parse JSON: #{e.message}"
-    end
-
-    def load_raw_content(opts)
-      # if the opts isn't a hash, we assume it's a path to a file
-      unless opts.is_a?(Hash)
-        @resource_name_supplement = opts
-        return load_raw_from_file(opts)
-      end
-
-      if opts.key?(:command)
-        @resource_name_supplement = "from command: #{opts[:command]}"
-        load_raw_from_command(opts[:command])
-      elsif opts.key?(:content)
-        opts[:content]
-      else
-        raise Inspec::Exceptions::ResourceFailed, 'No JSON content; must specify a file, command, or raw JSON content'
-      end
-    end
-
-    def load_raw_from_file(path)
-      file = inspec.file(path)
-
-      # these are currently ResourceSkipped to maintain consistency with the resource
-      # pre-refactor (which used skip_resource). These should likely be changed to
-      # ResourceFailed during a major version bump.
-      raise Inspec::Exceptions::ResourceSkipped, "No such file: #{path}" unless file.file?
-      raise Inspec::Exceptions::ResourceSkipped, "File #{path} is empty or is not readable by current user" if file.content.nil? || file.content.empty?
-
-      file.content
-    end
-
-    def load_raw_from_command(command)
-      command_output = inspec.command(command).stdout
-      raise Inspec::Exceptions::ResourceSkipped, "No output from command: #{command}" if command_output.nil? || command_output.empty?
-
-      command_output
-    end
-
-    # for resources the subclass JsonConfig, this allows specification of the resource
-    # base name in each subclass so we can build a good to_s method
-    def resource_base_name
-      'JSON'
-    end
-  end
-end
+# encoding: utf-8
+
+require 'utils/object_traversal'
+
+module Inspec::Resources
+  class JsonConfig < Inspec.resource(1)
+    name 'json'
+    supports platform: 'unix'
+    supports platform: 'windows'
+    supports platform: 'esx'
+    supports platform: 'cisco'
+    desc 'Use the json InSpec audit resource to test data in a JSON file.'
+    example "
+      describe json('policyfile.lock.json') do
+        its(['cookbook_locks','omnibus','version']) { should eq('2.2.0') }
+      end
+
+      describe json({ command: 'retrieve_data.py --json' }) do
+        its('state') { should eq('open') }
+      end
+
+      describe json({ content: '{\"item1\": { \"status\": \"available\" } }' }) do
+        its(['item1', 'status']) { should cmp 'available' }
+      end
+
+    "
+
+    include ObjectTraverser
+
+    # make params readable
+    attr_reader :params, :raw_content
+
+    def initialize(opts)
+      # pre-initialize @params to an empty hash. In the event that reading/parsing the data
+      # throws an exception, this allows the resource to still be called outside of a
+      # describe/test and not throw errors when a caller attempts to fetch a value from the params.
+      @params = {}
+
+      # load the raw content from the source, and then parse it
+      @raw_content = load_raw_content(opts)
+      @params = parse(@raw_content)
+    end
+
+    # Shorthand to retrieve a parameter name via `#its`.
+    # Example: describe json('file') { its('paramX') { should eq 'Y' } }
+    #
+    # @param [String] name name of the field to retrieve
+    # @return [Object] the value stored at this position
+    def method_missing(*keys)
+      # catch bahavior of rspec its implementation
+      # @see https://github.com/rspec/rspec-its/blob/master/lib/rspec/its.rb#L110
+      keys.shift if keys.is_a?(Array) && keys[0] == :[]
+      value(keys)
+    end
+
+    def value(key)
+      # uses ObjectTraverser.extract_value to walk the hash looking for the key,
+      # which may be an Array of keys for a nested Hash.
+      extract_value(key, params)
+    end
+
+    def to_s
+      "#{resource_base_name} #{@resource_name_supplement || 'content'}"
+    end
+
+    private
+
+    def parse(content)
+      require 'json'
+      JSON.parse(content)
+    rescue => e
+      raise Inspec::Exceptions::ResourceFailed, "Unable to parse JSON: #{e.message}"
+    end
+
+    def load_raw_content(opts)
+      # if the opts isn't a hash, we assume it's a path to a file
+      unless opts.is_a?(Hash)
+        @resource_name_supplement = opts
+        return load_raw_from_file(opts)
+      end
+
+      if opts.key?(:command)
+        @resource_name_supplement = "from command: #{opts[:command]}"
+        load_raw_from_command(opts[:command])
+      elsif opts.key?(:content)
+        opts[:content]
+      else
+        raise Inspec::Exceptions::ResourceFailed, 'No JSON content; must specify a file, command, or raw JSON content'
+      end
+    end
+
+    def load_raw_from_file(path)
+      file = inspec.file(path)
+
+      # these are currently ResourceSkipped to maintain consistency with the resource
+      # pre-refactor (which used skip_resource). These should likely be changed to
+      # ResourceFailed during a major version bump.
+      raise Inspec::Exceptions::ResourceSkipped, "No such file: #{path}" unless file.file?
+      raise Inspec::Exceptions::ResourceSkipped, "File #{path} is empty or is not readable by current user" if file.content.nil? || file.content.empty?
+
+      file.content
+    end
+
+    def load_raw_from_command(command)
+      command_output = inspec.command(command).stdout
+      raise Inspec::Exceptions::ResourceSkipped, "No output from command: #{command}" if command_output.nil? || command_output.empty?
+
+      command_output
+    end
+
+    # for resources the subclass JsonConfig, this allows specification of the resource
+    # base name in each subclass so we can build a good to_s method
+    def resource_base_name
+      'JSON'
+    end
+  end
+end

data/lib/resources/kernel_module.rb

@@ -1,107 +1,107 @@
-# encoding: utf-8
-
-module Inspec::Resources
-  class KernelModule < Inspec.resource(1)
-    name 'kernel_module'
-    supports platform: 'unix'
-    desc 'Use the kernel_module InSpec audit resource to test kernel modules on
-    Linux platforms. These parameters are located under /lib/modules. Any submodule
-    may be tested using this resource.
-
-    The `kernel_module` resource can also verify if a kernel module is `blacklisted`
-    or if a module is disabled via a fake install using the `bin_true` or `bin_false`
-    method.'
-
-    example "
-
-    describe kernel_module('video') do
-      it { should be_loaded }
-      it { should_not be_disabled }
-      it { should_not be_blacklisted }
-    end
-
-    describe kernel_module('sstfb') do
-      it { should_not be_loaded }
-      it { should be_disabled }
-    end
-
-    describe kernel_module('floppy') do
-      it { should be_blacklisted }
-    end
-
-    describe kernel_module('dhcp') do
-      it { should_not be_loaded }
-    end
-    "
-
-    def initialize(modulename = nil)
-      @module = modulename
-      # this resource is only supported on Linux
-      return skip_resource 'The `kernel_parameter` resource is not supported on your OS.' if !inspec.os.linux?
-    end
-
-    def loaded?
-      if inspec.os.redhat? || inspec.os.name == 'fedora'
-        lsmod_cmd = '/sbin/lsmod'
-      else
-        lsmod_cmd = 'lsmod'
-      end
-
-      # get list of all modules
-      cmd = inspec.command(lsmod_cmd)
-      return false if cmd.exit_status != 0
-
-      # check if module is loaded
-      re = Regexp.new('^'+Regexp.quote(@module)+'\s')
-      found = cmd.stdout.match(re)
-      !found.nil?
-    end
-
-    def disabled?
-      !modprobe_output.match(%r{^install\s+#{@module}\s+/(s?)bin/(true|false)}).nil?
-    end
-
-    def blacklisted?
-      !modprobe_output.match(/^blacklist\s+#{@module}/).nil? || disabled_via_bin_true? || disabled_via_bin_false?
-    end
-
-    def version
-      cmd = inspec.command("#{modinfo_cmd_for_os} -F version #{@module}")
-      cmd.exit_status.zero? ? cmd.stdout.delete("\n") : nil
-    end
-
-    def to_s
-      "Kernel Module #{@module}"
-    end
-
-    private
-
-    def modprobe_output
-      @modprobe_output ||= inspec.command("#{modprobe_cmd_for_os} --showconfig").stdout
-    end
-
-    def modinfo_cmd_for_os
-      if inspec.os.redhat? || inspec.os.name == 'fedora'
-        '/sbin/modinfo'
-      else
-        'modinfo'
-      end
-    end
-
-    def modprobe_cmd_for_os
-      if inspec.os.redhat? || inspec.os.name == 'fedora'
-        '/sbin/modprobe'
-      else
-        'modprobe'
-      end
-    end
-
-    def disabled_via_bin_true?
-      !modprobe_output.match(%r{^install\s+#{@module}\s+/(s?)bin/true}).nil?
-    end
-
-    def disabled_via_bin_false?
-      !modprobe_output.match(%r{^install\s+#{@module}\s+/(s?)bin/false}).nil?
-    end
-  end
-end
+# encoding: utf-8
+
+module Inspec::Resources
+  class KernelModule < Inspec.resource(1)
+    name 'kernel_module'
+    supports platform: 'unix'
+    desc 'Use the kernel_module InSpec audit resource to test kernel modules on
+    Linux platforms. These parameters are located under /lib/modules. Any submodule
+    may be tested using this resource.
+
+    The `kernel_module` resource can also verify if a kernel module is `blacklisted`
+    or if a module is disabled via a fake install using the `bin_true` or `bin_false`
+    method.'
+
+    example "
+
+    describe kernel_module('video') do
+      it { should be_loaded }
+      it { should_not be_disabled }
+      it { should_not be_blacklisted }
+    end
+
+    describe kernel_module('sstfb') do
+      it { should_not be_loaded }
+      it { should be_disabled }
+    end
+
+    describe kernel_module('floppy') do
+      it { should be_blacklisted }
+    end
+
+    describe kernel_module('dhcp') do
+      it { should_not be_loaded }
+    end
+    "
+
+    def initialize(modulename = nil)
+      @module = modulename
+      # this resource is only supported on Linux
+      return skip_resource 'The `kernel_parameter` resource is not supported on your OS.' if !inspec.os.linux?
+    end
+
+    def loaded?
+      if inspec.os.redhat? || inspec.os.name == 'fedora'
+        lsmod_cmd = '/sbin/lsmod'
+      else
+        lsmod_cmd = 'lsmod'
+      end
+
+      # get list of all modules
+      cmd = inspec.command(lsmod_cmd)
+      return false if cmd.exit_status != 0
+
+      # check if module is loaded
+      re = Regexp.new('^'+Regexp.quote(@module)+'\s')
+      found = cmd.stdout.match(re)
+      !found.nil?
+    end
+
+    def disabled?
+      !modprobe_output.match(%r{^install\s+#{@module}\s+/(s?)bin/(true|false)}).nil?
+    end
+
+    def blacklisted?
+      !modprobe_output.match(/^blacklist\s+#{@module}/).nil? || disabled_via_bin_true? || disabled_via_bin_false?
+    end
+
+    def version
+      cmd = inspec.command("#{modinfo_cmd_for_os} -F version #{@module}")
+      cmd.exit_status.zero? ? cmd.stdout.delete("\n") : nil
+    end
+
+    def to_s
+      "Kernel Module #{@module}"
+    end
+
+    private
+
+    def modprobe_output
+      @modprobe_output ||= inspec.command("#{modprobe_cmd_for_os} --showconfig").stdout
+    end
+
+    def modinfo_cmd_for_os
+      if inspec.os.redhat? || inspec.os.name == 'fedora'
+        '/sbin/modinfo'
+      else
+        'modinfo'
+      end
+    end
+
+    def modprobe_cmd_for_os
+      if inspec.os.redhat? || inspec.os.name == 'fedora'
+        '/sbin/modprobe'
+      else
+        'modprobe'
+      end
+    end
+
+    def disabled_via_bin_true?
+      !modprobe_output.match(%r{^install\s+#{@module}\s+/(s?)bin/true}).nil?
+    end
+
+    def disabled_via_bin_false?
+      !modprobe_output.match(%r{^install\s+#{@module}\s+/(s?)bin/false}).nil?
+    end
+  end
+end

data/lib/resources/kernel_parameter.rb

@@ -1,58 +1,58 @@
-# encoding: utf-8
-
-module Inspec::Resources
-  class KernelParameter < Inspec.resource(1)
-    name 'kernel_parameter'
-    supports platform: 'unix'
-    desc 'Use the kernel_parameter InSpec audit resource to test kernel parameters on Linux platforms.'
-    example "
-      describe kernel_parameter('net.ipv4.conf.all.forwarding') do
-        its('value') { should eq 0 }
-      end
-    "
-
-    def initialize(parameter = nil)
-      @parameter = parameter
-
-      # this resource is only supported on Linux
-      return skip_resource 'The `kernel_parameter` resource is not supported on your OS.' if !inspec.os.linux?
-    end
-
-    def value
-      cmd = inspec.command("/sbin/sysctl -q -n #{@parameter}")
-      return nil if cmd.exit_status != 0
-      # remove whitespace
-      cmd = cmd.stdout.chomp.strip
-      # convert to number if possible
-      cmd = cmd.to_i if cmd =~ /^\d+$/
-      cmd
-    end
-
-    def to_s
-      "Kernel Parameter #{@parameter}"
-    end
-  end
-
-  # for compatability with serverspec
-  # this is deprecated syntax and will be removed in future versions
-  class LinuxKernelParameter < KernelParameter
-    name 'linux_kernel_parameter'
-
-    def initialize(parameter)
-      super(parameter)
-    end
-
-    def value
-      deprecated
-      super()
-    end
-
-    def deprecated
-      warn '[DEPRECATION] `linux_kernel_parameter(parameter)` is deprecated.  Please use `kernel_parameter(parameter)` instead.'
-    end
-
-    def to_s
-      "Kernel Parameter #{@parameter}"
-    end
-  end
-end
+# encoding: utf-8
+
+module Inspec::Resources
+  class KernelParameter < Inspec.resource(1)
+    name 'kernel_parameter'
+    supports platform: 'unix'
+    desc 'Use the kernel_parameter InSpec audit resource to test kernel parameters on Linux platforms.'
+    example "
+      describe kernel_parameter('net.ipv4.conf.all.forwarding') do
+        its('value') { should eq 0 }
+      end
+    "
+
+    def initialize(parameter = nil)
+      @parameter = parameter
+
+      # this resource is only supported on Linux
+      return skip_resource 'The `kernel_parameter` resource is not supported on your OS.' if !inspec.os.linux?
+    end
+
+    def value
+      cmd = inspec.command("/sbin/sysctl -q -n #{@parameter}")
+      return nil if cmd.exit_status != 0
+      # remove whitespace
+      cmd = cmd.stdout.chomp.strip
+      # convert to number if possible
+      cmd = cmd.to_i if cmd =~ /^\d+$/
+      cmd
+    end
+
+    def to_s
+      "Kernel Parameter #{@parameter}"
+    end
+  end
+
+  # for compatability with serverspec
+  # this is deprecated syntax and will be removed in future versions
+  class LinuxKernelParameter < KernelParameter
+    name 'linux_kernel_parameter'
+
+    def initialize(parameter)
+      super(parameter)
+    end
+
+    def value
+      deprecated
+      super()
+    end
+
+    def deprecated
+      warn '[DEPRECATION] `linux_kernel_parameter(parameter)` is deprecated.  Please use `kernel_parameter(parameter)` instead.'
+    end
+
+    def to_s
+      "Kernel Parameter #{@parameter}"
+    end
+  end
+end