inspec 1.51.15 → 1.51.18

data/lib/resources/xinetd.rb

@@ -1,112 +1,112 @@
-# encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
-
-require 'utils/parser'
-require 'utils/filter'
-
-module Inspec::Resources
-  class XinetdConf < Inspec.resource(1)
-    name 'xinetd_conf'
-    desc 'Xinetd services configuration.'
-    example "
-      describe xinetd_conf.services('chargen') do
-        its('socket_types') { should include 'dgram' }
-      end
-
-      describe xinetd_conf.services('chargen').socket_types('dgram') do
-        it { should be_disabled }
-      end
-    "
-
-    include XinetdParser
-
-    def initialize(conf_path = '/etc/xinetd.conf')
-      @conf_path = conf_path
-      @contents = {}
-    end
-
-    def to_s
-      "Xinetd config #{@conf_path}#{@filters}"
-    end
-
-    def params
-      @params ||= read_params
-    end
-
-    filter = FilterTable.create
-    filter.add_accessor(:where)
-          .add_accessor(:entries)
-          .add(:services,     field: 'service')
-          .add(:ids,          field: 'id')
-          .add(:socket_types, field: 'socket_type')
-          .add(:types,        field: 'type')
-          .add(:protocols,    field: 'protocol')
-          .add(:wait,         field: 'wait')
-          .add(:disabled?) { |x| x.where('disable' => 'no').services.empty? }
-          .add(:enabled?) { |x| x.where('disable' => 'yes').services.empty? }
-          .connect(self, :service_lines)
-
-    private
-
-    def read_content(path = @conf_path)
-      return @contents[path] if @contents.key?(path)
-      file = inspec.file(path)
-      if !file.file?
-        raise Inspec::Exceptions::ResourceSkipped, "Can't find file: #{path}"
-      end
-
-      if file.content.nil? || file.content.empty?
-        raise Inspec::Exceptions::ResourceSkipped, "Can't read file: #{path}"
-      end
-
-      @contents[path] = file.content
-    end
-
-    def read_params
-      return {} if read_content.nil?
-      flat_params = parse_xinetd(read_content)
-      # we need to map service data in order to use it with filtertable
-      params = { 'services' => {} }
-      # map services that were defined and map it to the service hash
-      flat_params.each do |k, v|
-        name = k[/^service (.+)$/, 1]
-        # its not a service, no change required
-        if name.nil?
-          params[k] = v
-        # handle service entries
-        else
-          # store service
-          params['services'][name] = v
-
-          # add the service identifier to its parameters
-          if v.is_a?(Array)
-            v.each { |service| service.params['service'] = name }
-          else
-            v.params['service'] = name
-          end
-        end
-      end
-      params
-    end
-
-    # Method used to derive the default protocol used from the socket_type
-    def default_protocol(type)
-      case type
-      when 'stream'
-        'tcp'
-      when 'dgram'
-        'udp'
-      else
-        'unknown'
-      end
-    end
-
-    def service_lines
-      @services ||= params['services'].values.flatten.map { |service|
-        service.params['protocol'] ||= default_protocol(service.params['socket_type'])
-        service.params
-      }
-    end
-  end
-end
+# encoding: utf-8
+# author: Christoph Hartmann
+# author: Dominik Richter
+
+require 'utils/parser'
+require 'utils/filter'
+
+module Inspec::Resources
+  class XinetdConf < Inspec.resource(1)
+    name 'xinetd_conf'
+    desc 'Xinetd services configuration.'
+    example "
+      describe xinetd_conf.services('chargen') do
+        its('socket_types') { should include 'dgram' }
+      end
+
+      describe xinetd_conf.services('chargen').socket_types('dgram') do
+        it { should be_disabled }
+      end
+    "
+
+    include XinetdParser
+
+    def initialize(conf_path = '/etc/xinetd.conf')
+      @conf_path = conf_path
+      @contents = {}
+    end
+
+    def to_s
+      "Xinetd config #{@conf_path}#{@filters}"
+    end
+
+    def params
+      @params ||= read_params
+    end
+
+    filter = FilterTable.create
+    filter.add_accessor(:where)
+          .add_accessor(:entries)
+          .add(:services,     field: 'service')
+          .add(:ids,          field: 'id')
+          .add(:socket_types, field: 'socket_type')
+          .add(:types,        field: 'type')
+          .add(:protocols,    field: 'protocol')
+          .add(:wait,         field: 'wait')
+          .add(:disabled?) { |x| x.where('disable' => 'no').services.empty? }
+          .add(:enabled?) { |x| x.where('disable' => 'yes').services.empty? }
+          .connect(self, :service_lines)
+
+    private
+
+    def read_content(path = @conf_path)
+      return @contents[path] if @contents.key?(path)
+      file = inspec.file(path)
+      if !file.file?
+        raise Inspec::Exceptions::ResourceSkipped, "Can't find file: #{path}"
+      end
+
+      if file.content.nil? || file.content.empty?
+        raise Inspec::Exceptions::ResourceSkipped, "Can't read file: #{path}"
+      end
+
+      @contents[path] = file.content
+    end
+
+    def read_params
+      return {} if read_content.nil?
+      flat_params = parse_xinetd(read_content)
+      # we need to map service data in order to use it with filtertable
+      params = { 'services' => {} }
+      # map services that were defined and map it to the service hash
+      flat_params.each do |k, v|
+        name = k[/^service (.+)$/, 1]
+        # its not a service, no change required
+        if name.nil?
+          params[k] = v
+        # handle service entries
+        else
+          # store service
+          params['services'][name] = v
+
+          # add the service identifier to its parameters
+          if v.is_a?(Array)
+            v.each { |service| service.params['service'] = name }
+          else
+            v.params['service'] = name
+          end
+        end
+      end
+      params
+    end
+
+    # Method used to derive the default protocol used from the socket_type
+    def default_protocol(type)
+      case type
+      when 'stream'
+        'tcp'
+      when 'dgram'
+        'udp'
+      else
+        'unknown'
+      end
+    end
+
+    def service_lines
+      @services ||= params['services'].values.flatten.map { |service|
+        service.params['protocol'] ||= default_protocol(service.params['socket_type'])
+        service.params
+      }
+    end
+  end
+end

data/lib/resources/xml.rb

@@ -1,45 +1,45 @@
-# encoding: utf-8
-# author: Jonathan Morley
-
-module Inspec::Resources
-  class XmlConfig < JsonConfig
-    name 'xml'
-    desc 'Use the xml InSpec resource to test configuration data in an XML file'
-    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
-    "
-
-    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)
-        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
+# encoding: utf-8
+# author: Jonathan Morley
+
+module Inspec::Resources
+  class XmlConfig < JsonConfig
+    name 'xml'
+    desc 'Use the xml InSpec resource to test configuration data in an XML file'
+    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
+    "
+
+    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)
+        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/resources/yaml.rb

@@ -1,45 +1,45 @@
-# encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
-
-require 'yaml'
-
-# 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 "
-      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
-    "
-
-    # 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
+# encoding: utf-8
+# author: Christoph Hartmann
+# author: Dominik Richter
+
+require 'yaml'
+
+# 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 "
+      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
+    "
+
+    # 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/resources/yum.rb

@@ -1,181 +1,181 @@
-# encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
-
-# 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'
-    desc 'Use the yum InSpec audit resource to test the configuration of Yum repositories.'
-    example "
-      describe yum.repo('name') do
-        it { should exist }
-        it { should be_enabled }
-      end
-    "
-
-    # 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" && 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
-    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) if !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
-    [
-      :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
-
-  # for compatability with serverspec
-  # this is deprecated syntax and will be removed in future versions
-  class YumRepoLegacy < Yum
-    name 'yumrepo'
-
-    def initialize(name)
-      super()
-      @repository = repo(name)
-    end
-
-    def exists?
-      deprecated
-      @repository.exist?
-    end
-
-    def enabled?
-      deprecated
-      @repository.enabled?
-    end
-
-    def deprecated
-      warn '[DEPRECATION] `yumrepo(reponame)` is deprecated.  Please use `yum.repo(reponame)` instead.'
-    end
-  end
-end
+# encoding: utf-8
+# author: Christoph Hartmann
+# author: Dominik Richter
+
+# 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'
+    desc 'Use the yum InSpec audit resource to test the configuration of Yum repositories.'
+    example "
+      describe yum.repo('name') do
+        it { should exist }
+        it { should be_enabled }
+      end
+    "
+
+    # 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" && 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
+    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) if !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
+    [
+      :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
+
+  # for compatability with serverspec
+  # this is deprecated syntax and will be removed in future versions
+  class YumRepoLegacy < Yum
+    name 'yumrepo'
+
+    def initialize(name)
+      super()
+      @repository = repo(name)
+    end
+
+    def exists?
+      deprecated
+      @repository.exist?
+    end
+
+    def enabled?
+      deprecated
+      @repository.enabled?
+    end
+
+    def deprecated
+      warn '[DEPRECATION] `yumrepo(reponame)` is deprecated.  Please use `yum.repo(reponame)` instead.'
+    end
+  end
+end