inspec 4.18.51 → 4.18.85

data/lib/inspec/resources/xml.rb

@@ -1,48 +0,0 @@
-require "inspec/resources/json"
-
-module Inspec::Resources
-  class XmlConfig < JsonConfig
-    name "xml"
-    supports platform: "unix"
-    supports platform: "windows"
-    desc "Use the xml InSpec resource to test configuration data in an XML file"
-    example <<~EXAMPLE
-      describe xml('default.xml') do
-        its('key/sub_key') { should eq(['value']) }
-        its(['root/name.with.a.period']) { should cmp 'so_many_dots' }
-      end
-    EXAMPLE
-
-    def parse(content)
-      require "rexml/document"
-      REXML::Document.new(content)
-    rescue => e
-      raise Inspec::Exceptions::ResourceFailed, "Unable to parse XML: #{e.message}"
-    end
-
-    def value(key)
-      output = []
-      REXML::XPath.each(@params, key.first.to_s) do |element|
-        if element.is_a?(REXML::Attribute)
-          output.push(element.to_s)
-        elsif element.is_a?(REXML::Element)
-          output.push(element.text)
-        elsif element.is_a?(Integer) || element.is_a?(TrueClass) || element.is_a?(FalseClass) || element.is_a?(String)
-          output.push(element)
-        else
-          raise Inspec::Exceptions::ResourceFailed, "Unknown XML object received (#{element.class}): #{element}"
-        end
-      end
-
-      output
-    end
-
-    private
-
-    # used by JsonConfig to build up a full to_s method
-    # based on whether a file path, content, or command was supplied.
-    def resource_base_name
-      "XML"
-    end
-  end
-end

data/lib/inspec/resources/yaml.rb

@@ -1,42 +0,0 @@
-require "yaml"
-require "inspec/resources/json"
-
-# Parses a yaml document
-# Usage:
-# describe yaml('.kitchen.yaml') do
-#   its('driver.name') { should eq('vagrant') }
-# end
-module Inspec::Resources
-  class YamlConfig < JsonConfig
-    name "yaml"
-    desc "Use the yaml InSpec audit resource to test configuration data in a YAML file."
-    example <<~EXAMPLE
-      describe yaml('config.yaml') do
-        its(['driver', 'name']) { should eq 'vagrant' }
-      end
-
-      describe yaml({ command: 'retrieve_data.py --yaml' }) do
-        its('state') { should eq 'open' }
-      end
-
-      describe yaml({ content: \"key1: value1\nkey2: value2\" }) do
-        its('key2') { should cmp 'value2' }
-      end
-    EXAMPLE
-
-    # override file load and parse hash from yaml
-    def parse(content)
-      YAML.load(content)
-    rescue => e
-      raise Inspec::Exceptions::ResourceFailed, "Unable to parse YAML: #{e.message}"
-    end
-
-    private
-
-    # used by JsonConfig to build up a full to_s method
-    # based on whether a file path, content, or command was supplied.
-    def resource_base_name
-      "YAML"
-    end
-  end
-end

data/lib/inspec/resources/yum.rb

@@ -1,162 +0,0 @@
-require "inspec/resources/command"
-
-# Usage:
-# describe yum do
-#   its('repos') { should exist }
-# end
-#
-# describe yum do
-#   its('repos') { should include 'base/7/x86_64' }
-#   its('epel') { should exist }
-#   its('epel') { should be_enabled }
-# end
-#
-# Filter for a specific repo by name
-# - use full identifier e.g. 'updates/7/x86_64'
-# - use short identifier e.g. 'updates'
-#
-# describe yum.repo('epel') do
-#   it { should exist }
-#   it { should be_enabled }
-#   its('baseurl') { should include 'mycompany.biz' }
-# end
-#
-# deprecated:
-# describe yumrepo('epel') do
-#   it { should exist }
-#   it { should be_enabled }
-# end
-
-module Inspec::Resources
-  class Yum < Inspec.resource(1)
-    name "yum"
-    supports platform: "unix"
-    desc "Use the yum InSpec audit resource to test the configuration of Yum repositories."
-    example <<~EXAMPLE
-      describe yum.repo('name') do
-        it { should exist }
-        it { should be_enabled }
-      end
-    EXAMPLE
-
-    # returns all repositories
-    # works as following:
-    # search for Repo-id
-    #   parse data in hashmap
-    #   store data in object
-    # until \n
-    def repositories
-      return @cache if defined?(@cache)
-
-      # parse the repository data from yum
-      # we cannot use -C, because this is not reliable and may lead to errors
-      @command_result = inspec.command("yum -v repolist all")
-      @content = @command_result.stdout
-      @cache = []
-      repo = {}
-      in_repo = false
-      @content.each_line do |line|
-        # detect repo start
-        in_repo = true if line =~ /^\s*Repo-id\s*:\s*(.*)\b/
-        # detect repo end
-        if (line == "\n" || line =~ /\s*Total packages:/) && in_repo
-          in_repo = false
-          @cache.push(repo)
-          repo = {}
-        end
-        # parse repo content
-        if in_repo == true
-          val = /^\s*([^:]*?)\s*:\s*(.*?)\s*$/.match(line)
-          repo[repo_key(strip(val[1]))] = strip(val[2])
-        end
-      end
-
-      @cache.push(repo) if in_repo
-
-      @cache
-    end
-
-    def repos
-      repositories.map { |repo| repo["id"] }
-    end
-
-    def repo(repo)
-      YumRepo.new(self, repo)
-    end
-
-    # alias for yum.repo('reponame')
-    def method_missing(name)
-      repo(name.to_s) unless name.nil?
-    end
-
-    def to_s
-      "Yum Repository"
-    end
-
-    private
-
-    # Removes lefthand and righthand whitespace
-    def strip(value)
-      value&.strip
-    end
-
-    # Optimize the key value
-    def repo_key(key)
-      return key if key.nil?
-
-      key.gsub("Repo-", "").downcase
-    end
-  end
-
-  class YumRepo
-    def initialize(yum, reponame)
-      @yum = yum
-      @reponame = reponame
-    end
-
-    # extracts the shortname from a repo id
-    # e.g. extras/7/x86_64 -> extras
-    def shortname(id)
-      val = %r{^\s*([^/]*?)/(.*?)\s*$}.match(id)
-      val.nil? ? nil : val[1]
-    end
-
-    def info
-      return @cache if defined?(@cache)
-
-      selection = @yum.repositories.select { |e| e["id"] == @reponame || shortname(e["id"]) == @reponame }
-      @cache = selection.empty? ? {} : selection.first
-      @cache
-    end
-
-    def exist?
-      !info.empty?
-    end
-
-    def enabled?
-      return false unless exist?
-
-      info["status"] == "enabled"
-    end
-
-    # provide a method for each of the repo metadata items we know about
-    %i{
-      baseurl
-      expire
-      filename
-      mirrors
-      pkgs
-      size
-      status
-      updated
-    }.each do |key|
-      define_method key do
-        info[key.to_s]
-      end
-    end
-
-    def to_s
-      "YumRepo #{@reponame}"
-    end
-  end
-end

data/lib/inspec/resources/zfs_dataset.rb

@@ -1,62 +0,0 @@
-require "inspec/resources/command"
-
-module Inspec::Resources
-  class ZfsDataset < Inspec.resource(1)
-    name "zfs_dataset"
-    supports platform: "unix"
-    desc "
-      Use the zfs_dataset InSpec audit resource to test if the named
-      ZFS Dataset is present and/or has certain properties.
-    "
-    example <<~EXAMPLE
-      describe zfs_dataset('tank/tmp') do
-        its('exec') { should eq('off') }
-        its('setuid') { should eq('off') }
-      end
-    EXAMPLE
-
-    def initialize(zfs_dataset)
-      return skip_resource "The `zfs_dataset` resource is not supported on your OS yet." unless inspec.os.bsd?
-
-      @zfs_dataset = zfs_dataset
-
-      @params = gather
-    end
-
-    # method called by 'it { should exist }'
-    def exists?
-      inspec.command("/sbin/zfs get -Hp all #{@zfs_dataset}").exit_status == 0
-    end
-
-    def mounted?
-      return false unless exists?
-
-      inspec.mount(@params["mountpoint"]).mounted?
-    end
-
-    def to_s
-      "ZFS Dataset #{@zfs_dataset}"
-    end
-
-    def gather
-      cmd = inspec.command("/sbin/zfs get -Hp all #{@zfs_dataset}")
-      return nil if cmd.exit_status.to_i != 0
-
-      # parse data
-      cmd.stdout.chomp.split("\n").each_with_object(Hash.new(0)) do |line, h|
-        t = line.split("\t")
-        h[t[1].to_s] = t[2].to_s
-      end
-    end
-
-    # override method
-    def exec
-      @params["exec"]
-    end
-
-    # expose all parameters
-    def method_missing(name)
-      @params[name.to_s]
-    end
-  end
-end

data/lib/inspec/resources/zfs_pool.rb

@@ -1,50 +0,0 @@
-require "inspec/resources/command"
-
-module Inspec::Resources
-  class ZfsPool < Inspec.resource(1)
-    name "zfs_pool"
-    supports platform: "unix"
-    desc "
-      Use the zfs_pool InSpec audit resource to test if the named
-      ZFS Pool is present and/or has certain properties.
-    "
-    example <<~EXAMPLE
-      describe zfs_pool('tank') do
-        its('failmode') { should eq('continue') }
-      end
-    EXAMPLE
-
-    def initialize(zfs_pool)
-      return skip_resource "The `zfs_pool` resource is not supported on your OS yet." unless inspec.os.bsd?
-
-      @zfs_pool = zfs_pool
-
-      @params = gather
-    end
-
-    # method called by 'it { should exist }'
-    def exists?
-      inspec.command("/sbin/zpool get -Hp all #{@zfs_pool}").exit_status == 0
-    end
-
-    def to_s
-      "ZFS Pool #{@zfs_pool}"
-    end
-
-    def gather
-      cmd = inspec.command("/sbin/zpool get -Hp all #{@zfs_pool}")
-      return nil if cmd.exit_status.to_i != 0
-
-      # parse data
-      cmd.stdout.chomp.split("\n").each_with_object(Hash.new(0)) do |line, h|
-        t = line.split("\t")
-        h[t[1].to_s] = t[2].to_s
-      end
-    end
-
-    # expose all parameters
-    def method_missing(name)
-      @params[name.to_s]
-    end
-  end
-end

data/lib/inspec/rspec_extensions.rb

@@ -1,116 +0,0 @@
-require "inspec/input_registry"
-require "inspec/plugin/v2"
-require "rspec/core/example_group"
-require "inspec/input_dsl_helpers"
-
-# Any additions to RSpec::Core::ExampleGroup (the RSpec class behind describe blocks) should go here.
-
-module Inspec
-  # This module exists to intercept the method_missing *class* method on RSpec::Core::ExampleGroup
-  # and is part of support for DSL plugintypes
-  module DescribeDslLazyLoader
-    # Support for Describe DSL plugins
-    def method_missing(method_name, *arguments, &block)
-      begin
-        backend = metadata[:backend] # populated via Inspec::Runner#add_resource
-        resource = Inspec::DSL.method_missing_resource(backend, method_name, *arguments)
-        return resource if resource
-      rescue LoadError
-        # pass through
-      end
-
-      # Check to see if there is a describe_dsl plugin activator hook with the method name
-      registry = Inspec::Plugin::V2::Registry.instance
-      hook = registry.find_activators(plugin_type: :describe_dsl, activator_name: method_name).first
-
-      if hook
-        # OK, load the hook if it hasn't been already.  We'll then know a module,
-        # which we can then inject into the context
-        hook.activate
-
-        # Inject the module's methods into the example group contexts.
-        # implementation_class is the field name, but this is actually a module.
-        # RSpec works by having these helper methods defined as class methods
-        # (see the definition of `let` as an example)
-        # So, we use extend to inject the new DSL methods.
-        RSpec::Core::ExampleGroup.extend(hook.implementation_class)
-
-        # We still haven't called the method we were looking for, so do so now.
-        send(method_name, *arguments, &block)
-      else
-        super
-      end
-    end
-  end
-
-  # This module exists to intercept the method_missing *instance* method on RSpec::Core::ExampleGroup
-  # and is part of support for DSL plugintypes
-  module TestDslLazyLoader
-    # Support for test DSL plugins
-    def method_missing(method_name, *arguments, &block)
-      # see if it is a resource first
-      begin
-        backend = inspec if respond_to?(:inspec) # backend not available??
-        resource = Inspec::DSL.method_missing_resource(backend, method_name, *arguments)
-        return resource if resource
-      rescue LoadError
-        # pass through
-      end
-
-      # Check to see if there is a test_dsl plugin activator hook with the method name
-      registry = Inspec::Plugin::V2::Registry.instance
-      hook = registry.find_activators(plugin_type: :test_dsl, activator_name: method_name).first
-
-      if hook
-        # OK, load the hook if it hasn't been already.  We'll then know a module,
-        # which we can then inject into the context
-        hook.activate
-
-        # Inject the module's methods into the example group contexts.
-        # implementation_class is the field name, but this is actually a module.
-        # RSpec works by having these helper methods defined as instance methods.
-        # So, we use include to inject the new DSL methods.
-        RSpec::Core::ExampleGroup.include(hook.implementation_class)
-
-        # We still haven't called the method we were looking for, so do so now.
-        send(method_name, *arguments, &block)
-      else
-        super
-      end
-    end
-  end
-end
-
-class RSpec::Core::ExampleGroup
-  include Inspec::InputDslHelpers
-
-  # This DSL method allows us to access the values of inputs within InSpec tests
-  def input(input_name, options = {})
-    profile_id = self.class.metadata[:profile_id]
-    input_with_profile_id(profile_id, input_name, options)
-  end
-  define_example_method :input
-
-  def input_object(name)
-    Inspec::InputRegistry.find_or_register_input(name, self.class.metadata[:profile_id])
-  end
-  define_example_method :input_object
-
-  def attribute(name, options = {})
-    Inspec.deprecate(:attrs_dsl, "Input name: #{name}, Profile: #{self.class.metadata[:profile_id]}")
-    input(name, options)
-  end
-  define_example_method :attribute
-
-  # Here, we have to ensure our method_missing gets called prior
-  # to RSpec::Core::ExampleGroup.method_missing (the class method).
-  # So, we use prepend.
-  # Because it is a class method we're attempting to prepend, we must
-  # prepend against the singleton class.
-  singleton_class.prepend Inspec::DescribeDslLazyLoader
-
-  # Here, we have to ensure our method_missing gets called prior
-  # to RSpec::Core::ExampleGroup#method_missing (the instance method).
-  # So, we use prepend.
-  prepend Inspec::TestDslLazyLoader
-end