inspec 0.14.8 → 0.15.0

data/lib/resources/windows_feature.rb

@@ -27,57 +27,59 @@
 #     "Installed":  false,
 #     "InstallState":  0
 # }
-class WindowsFeature < Inspec.resource(1)
-  name 'windows_feature'
-  desc 'Use the windows_feature InSpec audit resource to test features on Microsoft Windows.'
-  example "
-    describe windows_feature('dhcp') do
-      it { should be_installed }
-    end
-  "
+module Inspec::Resources
+  class WindowsFeature < Inspec.resource(1)
+    name 'windows_feature'
+    desc 'Use the windows_feature InSpec audit resource to test features on Microsoft Windows.'
+    example "
+      describe windows_feature('dhcp') do
+        it { should be_installed }
+      end
+    "
 
-  def initialize(feature)
-    @feature = feature
-    @cache = nil
+    def initialize(feature)
+      @feature = feature
+      @cache = nil
 
-    # verify that this resource is only supported on Windows
-    return skip_resource 'The `windows_feature` resource is not supported on your OS.' if inspec.os[:family] != 'windows'
-  end
+      # verify that this resource is only supported on Windows
+      return skip_resource 'The `windows_feature` resource is not supported on your OS.' if inspec.os[:family] != 'windows'
+    end
 
-  # returns true if the package is installed
-  def installed?(_provider = nil, _version = nil)
-    info[:installed] == true
-  end
+    # returns true if the package is installed
+    def installed?(_provider = nil, _version = nil)
+      info[:installed] == true
+    end
 
-  # returns the package description
-  def info
-    return @cache if !@cache.nil?
-    features_cmd = "Get-WindowsFeature | Where-Object {$_.Name -eq '#{@feature}' -or $_.DisplayName -eq '#{@feature}'} | Select-Object -Property Name,DisplayName,Description,Installed,InstallState | ConvertTo-Json"
-    cmd = inspec.command(features_cmd)
+    # returns the package description
+    def info
+      return @cache if !@cache.nil?
+      features_cmd = "Get-WindowsFeature | Where-Object {$_.Name -eq '#{@feature}' -or $_.DisplayName -eq '#{@feature}'} | Select-Object -Property Name,DisplayName,Description,Installed,InstallState | ConvertTo-Json"
+      cmd = inspec.command(features_cmd)
 
-    @cache = {
-      name: @feature,
-      type: 'windows-feature',
-    }
+      @cache = {
+        name: @feature,
+        type: 'windows-feature',
+      }
 
-    # cannot rely on exit code for now, successful command returns exit code 1
-    # return nil if cmd.exit_status != 0
-    # try to parse json
-    begin
-      params = JSON.parse(cmd.stdout)
-    rescue JSON::ParserError => _e
-      return @cache
-    end
+      # cannot rely on exit code for now, successful command returns exit code 1
+      # return nil if cmd.exit_status != 0
+      # try to parse json
+      begin
+        params = JSON.parse(cmd.stdout)
+      rescue JSON::ParserError => _e
+        return @cache
+      end
 
-    @cache = {
-      name: params['Name'],
-      description: params['Description'],
-      installed: params['Installed'],
-      type: 'windows-feature',
-    }
-  end
+      @cache = {
+        name: params['Name'],
+        description: params['Description'],
+        installed: params['Installed'],
+        type: 'windows-feature',
+      }
+    end
 
-  def to_s
-    "Windows Feature '#{@feature}'"
+    def to_s
+      "Windows Feature '#{@feature}'"
+    end
   end
 end

data/lib/resources/xinetd.rb

@@ -4,139 +4,141 @@
 
 require 'utils/parser'
 
-class XinetdConf < Inspec.resource(1) # rubocop:disable Metrics/ClassLength
-  name 'xinetd_conf'
-  desc 'Xinetd services configuration.'
-  example "
-    describe xinetd_conf.services('chargen') do
-      its('socket_types') { should include 'dgram' }
-    end
+module Inspec::Resources
+  class XinetdConf < Inspec.resource(1) # rubocop:disable Metrics/ClassLength
+    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
-  "
+      describe xinetd_conf.services('chargen').socket_types('dgram') do
+        it { should be_disabled }
+      end
+    "
 
-  include XinetdParser
+    include XinetdParser
 
-  def initialize(conf_path = '/etc/xinetd.conf', opts = {})
-    @conf_path = conf_path
-    @params = opts[:params] unless opts[:params].nil?
-    @filters = opts[:filters] || ''
-    @contents = {}
-  end
+    def initialize(conf_path = '/etc/xinetd.conf', opts = {})
+      @conf_path = conf_path
+      @params = opts[:params] unless opts[:params].nil?
+      @filters = opts[:filters] || ''
+      @contents = {}
+    end
 
-  def to_s
-    "Xinetd config #{@conf_path}"
-  end
+    def to_s
+      "Xinetd config #{@conf_path}"
+    end
 
-  def services(condition = nil)
-    condition.nil? ? params['services'].keys : filter(service: condition)
-  end
+    def services(condition = nil)
+      condition.nil? ? params['services'].keys : filter(service: condition)
+    end
 
-  def ids(condition = nil)
-    condition.nil? ? services_field('id') : filter(id: condition)
-  end
+    def ids(condition = nil)
+      condition.nil? ? services_field('id') : filter(id: condition)
+    end
 
-  def socket_types(condition = nil)
-    condition.nil? ? services_field('socket_type') : filter(socket_type: condition)
-  end
+    def socket_types(condition = nil)
+      condition.nil? ? services_field('socket_type') : filter(socket_type: condition)
+    end
 
-  def types(condition = nil)
-    condition.nil? ? services_field('type') : filter(type: condition)
-  end
+    def types(condition = nil)
+      condition.nil? ? services_field('type') : filter(type: condition)
+    end
 
-  def wait(condition = nil)
-    condition.nil? ? services_field('wait') : filter(wait: condition)
-  end
+    def wait(condition = nil)
+      condition.nil? ? services_field('wait') : filter(wait: condition)
+    end
 
-  def disabled?
-    filter(disable: 'no').services.empty?
-  end
+    def disabled?
+      filter(disable: 'no').services.empty?
+    end
 
-  def enabled?
-    filter(disable: 'yes').services.empty?
-  end
+    def enabled?
+      filter(disable: 'yes').services.empty?
+    end
 
-  def params
-    return @params if defined?(@params)
-    return @params = {} if read_content.nil?
-    flat_params = parse_xinetd(read_content)
-    @params = { 'services' => {} }
-    flat_params.each do |k, v|
-      name = k[/^service (.+)$/, 1]
-      if name.nil?
-        @params[k] = v
-      else
-        @params['services'][name] = v
+    def params
+      return @params if defined?(@params)
+      return @params = {} if read_content.nil?
+      flat_params = parse_xinetd(read_content)
+      @params = { 'services' => {} }
+      flat_params.each do |k, v|
+        name = k[/^service (.+)$/, 1]
+        if name.nil?
+          @params[k] = v
+        else
+          @params['services'][name] = v
+        end
       end
+      @params
     end
-    @params
-  end
 
-  def filter(conditions = {})
-    res = params.dup
-    filters = ''
-    conditions.each do |k, v|
-      v = v.to_s if v.is_a? Integer
-      filters += " #{k} = #{v.inspect}"
-      res['services'] = filter_by(res['services'], k.to_s, v)
+    def filter(conditions = {})
+      res = params.dup
+      filters = ''
+      conditions.each do |k, v|
+        v = v.to_s if v.is_a? Integer
+        filters += " #{k} = #{v.inspect}"
+        res['services'] = filter_by(res['services'], k.to_s, v)
+      end
+      XinetdConf.new(@conf_path, params: res, filters: filters)
     end
-    XinetdConf.new(@conf_path, params: res, filters: filters)
-  end
 
-  private
+    private
 
-  # Retrieve the provided field from all configured services.
-  #
-  # @param [String] field name, e.g. `socket_type`
-  # @return [Array[String]] all values of this field across services
-  def services_field(field)
-    params['services'].values.compact.flatten
-                      .map { |x| x.params[field] }.flatten.compact
-  end
-
-  def match_condition(sth, condition)
-    case sth
-    # this does Regex-matching as well as string comparison
-    when condition
-      true
-    else
-      false
+    # Retrieve the provided field from all configured services.
+    #
+    # @param [String] field name, e.g. `socket_type`
+    # @return [Array[String]] all values of this field across services
+    def services_field(field)
+      params['services'].values.compact.flatten
+                        .map { |x| x.params[field] }.flatten.compact
     end
-  end
 
-  # Filter services by a criteria. This allows for search queries for
-  # certain values.
-  #
-  # @param [Hash] service collection
-  # @param [String] search key you want to query
-  # @param [Any] search value that the key should match
-  # @return [Hash] filtered service collection
-  def filter_by(services, k, v)
-    if k == 'service'
-      return Hash[services.find_all { |name, _| match_condition(v, name) }]
+    def match_condition(sth, condition)
+      case sth
+      # this does Regex-matching as well as string comparison
+      when condition
+        true
+      else
+        false
+      end
     end
-    Hash[services.map { |name, service_arr|
-      found = service_arr.find_all { |service|
-        match_condition(service.params[k], v)
-      }
-      found.empty? ? nil : [name, found]
-    }.compact]
-  end
 
-  def read_content(path = @conf_path)
-    return @contents[path] if @contents.key?(path)
-    file = inspec.file(path)
-    if !file.file?
-      return skip_resource "Can't find file \"#{path}\""
+    # Filter services by a criteria. This allows for search queries for
+    # certain values.
+    #
+    # @param [Hash] service collection
+    # @param [String] search key you want to query
+    # @param [Any] search value that the key should match
+    # @return [Hash] filtered service collection
+    def filter_by(services, k, v)
+      if k == 'service'
+        return Hash[services.find_all { |name, _| match_condition(v, name) }]
+      end
+      Hash[services.map { |name, service_arr|
+        found = service_arr.find_all { |service|
+          match_condition(service.params[k], v)
+        }
+        found.empty? ? nil : [name, found]
+      }.compact]
     end
 
-    @contents[path] = file.content
-    if @contents[path].empty? && file.size > 0
-      return skip_resource "Can't read file \"#{path}\""
-    end
+    def read_content(path = @conf_path)
+      return @contents[path] if @contents.key?(path)
+      file = inspec.file(path)
+      if !file.file?
+        return skip_resource "Can't find file \"#{path}\""
+      end
+
+      @contents[path] = file.content
+      if @contents[path].empty? && file.size > 0
+        return skip_resource "Can't read file \"#{path}\""
+      end
 
-    @contents[path]
+      @contents[path]
+    end
   end
 end

data/lib/resources/yaml.rb

@@ -9,21 +9,23 @@ require 'yaml'
 # describe yaml('.kitchen.yaml') do
 #   its('driver.name') { should eq('vagrant') }
 # end
-class YamlConfig < JsonConfig
-  name 'yaml'
-  desc 'Use the yaml InSpec audit resource to test configuration data in a YAML file.'
-  example "
-    describe yaml do
-      its('name') { should eq 'foo' }
-    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 do
+        its('name') { should eq 'foo' }
+      end
+    "
 
-  # override file load and parse hash from yaml
-  def parse(content)
-    YAML.load(content)
-  end
+    # override file load and parse hash from yaml
+    def parse(content)
+      YAML.load(content)
+    end
 
-  def to_s
-    "YAML #{@path}"
+    def to_s
+      "YAML #{@path}"
+    end
   end
 end

data/lib/resources/yum.rb

@@ -30,132 +30,134 @@ require 'resources/file'
 #   it { should be_enabled }
 # end
 
-class Yum < Inspec.resource(1)
-  name 'yum'
-  desc 'Use the yum InSpec audit resource to test packages in the Yum repository.'
-  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 = {}
+module Inspec::Resources
+  class Yum < Inspec.resource(1)
+    name 'yum'
+    desc 'Use the yum InSpec audit resource to test packages in the Yum repository.'
+    example "
+      describe yum.repo('name') do
+        it { should exist }
+        it { should be_enabled }
       end
-      # parse repo content
-      if in_repo == true
-        val = /^\s*([^:]*?)\s*:\s*(.*?)\s*$/.match(line)
-        repo[repo_key(strip(val[1]))] = strip(val[2])
+    "
+
+    # 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
-    @cache
-  end
 
-  def repos
-    repositories.map { |repo| repo['id'] }
-  end
+    def repos
+      repositories.map { |repo| repo['id'] }
+    end
 
-  def repo(repo)
-    YumRepo.new(self, repo)
-  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
+    # alias for yum.repo('reponame')
+    def method_missing(name)
+      repo(name.to_s) if !name.nil?
+    end
 
-  def to_s
-    'Yum Repository'
-  end
+    def to_s
+      'Yum Repository'
+    end
 
-  private
+    private
 
-  # Removes lefthand and righthand whitespace
-  def strip(value)
-    value.strip if !value.nil?
-  end
+    # Removes lefthand and righthand whitespace
+    def strip(value)
+      value.strip if !value.nil?
+    end
 
-  # Optimize the key value
-  def repo_key(key)
-    return key if key.nil?
-    key.gsub('Repo-', '').downcase
+    # Optimize the key value
+    def repo_key(key)
+      return key if key.nil?
+      key.gsub('Repo-', '').downcase
+    end
   end
-end
 
-class YumRepo
-  def initialize(yum, reponame)
-    @yum = yum
-    @reponame = reponame
-  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
+    # 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[0] if !selection.nil? && selection.length == 1
-    @cache
-  end
+    def info
+      return @cache if defined?(@cache)
+      selection = @yum.repositories.select { |e| e['id'] == @reponame || shortname(e['id']) == @reponame }
+      @cache = selection[0] if !selection.nil? && selection.length == 1
+      @cache
+    end
 
-  def exist?
-    !info.nil?
-  end
+    def exist?
+      !info.nil?
+    end
 
-  def enabled?
-    repo = info
-    return false if repo.nil?
-    info['status'] == 'enabled'
+    def enabled?
+      repo = info
+      return false if repo.nil?
+      info['status'] == 'enabled'
+    end
   end
-end
 
-# for compatability with serverspec
-# this is deprecated syntax and will be removed in future versions
-class YumRepoLegacy < Yum
-  name 'yumrepo'
+  # 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 initialize(name)
+      super()
+      @repository = repo(name)
+    end
 
-  def exists?
-    deprecated
-    @repository.exist?
-  end
+    def exists?
+      deprecated
+      @repository.exist?
+    end
 
-  def enabled?
-    deprecated
-    @repository.enabled?
-  end
+    def enabled?
+      deprecated
+      @repository.enabled?
+    end
 
-  def deprecated
-    warn '[DEPRECATION] `yumrepo(reponame)` is deprecated.  Please use `yum.repo(reponame)` instead.'
+    def deprecated
+      warn '[DEPRECATION] `yumrepo(reponame)` is deprecated.  Please use `yum.repo(reponame)` instead.'
+    end
   end
 end