inspec 4.3.2 → 4.6.3

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

@@ -1,10 +1,10 @@
-# encoding: utf-8
+require "inspec/resources/docker"
 
 module Inspec::Resources
   class DockerPlugin < Inspec.resource(1)
-    name 'docker_plugin'
-    supports platform: 'unix'
-    desc 'Retrieves info about docker plugins'
+    name "docker_plugin"
+    supports platform: "unix"
+    desc "Retrieves info about docker plugins"
     example <<~EXAMPLE
       describe docker_plugin('rexray/ebs') do
         it { should exist }
@@ -55,9 +55,9 @@ module Inspec::Resources
     def object_info
       return @info if defined?(@info)
       opts = @opts
-      @info = inspec.docker.plugins.where {
+      @info = inspec.docker.plugins.where do
         (name == opts[:name]) || (!id.nil? && !opts[:id].nil? && (id == opts[:id]))
-      }
+      end
     end
   end
 end

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

@@ -1,16 +1,16 @@
-# encoding: utf-8
 #
 # Copyright 2017, Christoph Hartmann
 
-require_relative 'docker_object'
+require "inspec/resources/docker"
+require_relative "docker_object"
 
 module Inspec::Resources
   class DockerService < Inspec.resource(1)
     include Inspec::Resources::DockerObject
 
-    name 'docker_service'
-    supports platform: 'unix'
-    desc 'Swarm-mode service'
+    name "docker_service"
+    supports platform: "unix"
+    desc "Swarm-mode service"
     example <<~EXAMPLE
       describe docker_service('service1') do
         it { should exist }
@@ -82,9 +82,9 @@ module Inspec::Resources
     def object_info
       return @info if defined?(@info)
       opts = @opts
-      @info = inspec.docker.services.where {
+      @info = inspec.docker.services.where do
         name == opts[:name] || image == opts[:image] || (!id.nil? && !opts[:id].nil? && (id == opts[:id] || id.start_with?(opts[:id])))
-      }
+      end
     end
   end
 end

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

@@ -1,13 +1,11 @@
-# encoding: utf-8
-
-require 'utils/filter'
-require 'hashie/mash'
-require 'resources/package'
+require "inspec/utils/filter"
+require "hashie/mash"
+require "inspec/resources/package"
 
 module Inspec::Resources
   class Elasticsearch < Inspec.resource(1)
-    name 'elasticsearch'
-    supports platform: 'unix'
+    name "elasticsearch"
+    supports platform: "unix"
     desc "Use the Elasticsearch InSpec audit resource to test the status of nodes in
       an Elasticsearch cluster."
 
@@ -25,39 +23,39 @@ module Inspec::Resources
 
     filter = FilterTable.create
     filter.register_custom_matcher(:exists?) { |x| !x.entries.empty? }
-    filter.register_column(:cluster_name,          field: 'cluster_name')
-          .register_column(:node_name,             field: 'name')
-          .register_column(:transport_address,     field: 'transport_address')
-          .register_column(:host,                  field: 'host')
-          .register_column(:ip,                    field: 'ip')
-          .register_column(:version,               field: 'version')
-          .register_column(:build_hash,            field: 'build_hash')
-          .register_column(:total_indexing_buffer, field: 'total_indexing_buffer')
-          .register_column(:roles,                 field: 'roles')
-          .register_column(:settings,              field: 'settings')
-          .register_column(:os,                    field: 'os')
-          .register_column(:process,               field: 'process')
-          .register_column(:jvm,                   field: 'jvm')
-          .register_column(:transport,             field: 'transport')
-          .register_column(:http,                  field: 'http')
-          .register_column(:plugins,               field: 'plugins')
-          .register_column(:plugin_list,           field: 'plugin_list')
-          .register_column(:modules,               field: 'modules')
-          .register_column(:module_list,           field: 'module_list')
-          .register_column(:node_id,               field: 'node_id')
-          .register_column(:ingest,                field: 'ingest')
-          .register_custom_property(:node_count) { |t, _|
+    filter.register_column(:cluster_name,          field: "cluster_name")
+          .register_column(:node_name,             field: "name")
+          .register_column(:transport_address,     field: "transport_address")
+          .register_column(:host,                  field: "host")
+          .register_column(:ip,                    field: "ip")
+          .register_column(:version,               field: "version")
+          .register_column(:build_hash,            field: "build_hash")
+          .register_column(:total_indexing_buffer, field: "total_indexing_buffer")
+          .register_column(:roles,                 field: "roles")
+          .register_column(:settings,              field: "settings")
+          .register_column(:os,                    field: "os")
+          .register_column(:process,               field: "process")
+          .register_column(:jvm,                   field: "jvm")
+          .register_column(:transport,             field: "transport")
+          .register_column(:http,                  field: "http")
+          .register_column(:plugins,               field: "plugins")
+          .register_column(:plugin_list,           field: "plugin_list")
+          .register_column(:modules,               field: "modules")
+          .register_column(:module_list,           field: "module_list")
+          .register_column(:node_id,               field: "node_id")
+          .register_column(:ingest,                field: "ingest")
+          .register_custom_property(:node_count) do |t, _|
             t.entries.length
-          }
+          end
 
     filter.install_filter_methods_on_resource(self, :nodes)
 
     attr_reader :nodes, :url
 
     def initialize(opts = {})
-      return skip_resource 'Package `curl` not avaiable on the host' unless inspec.command('curl').exist?
+      return skip_resource "Package `curl` not avaiable on the host" unless inspec.command("curl").exist?
 
-      @url = opts.fetch(:url, 'http://localhost:9200')
+      @url = opts.fetch(:url, "http://localhost:9200")
 
       username   = opts.fetch(:username, nil)
       password   = opts.fetch(:password, nil)
@@ -94,11 +92,11 @@ module Inspec::Resources
     private
 
     def parse_cluster(content)
-      return [] unless content['nodes']
+      return [] unless content["nodes"]
 
       nodes = []
 
-      content['nodes'].each do |node_id, node_data|
+      content["nodes"].each do |node_id, node_data|
         node_data = fix_mash_key_collision(node_data)
 
         node = Hashie::Mash.new(node_data)
@@ -134,13 +132,13 @@ module Inspec::Resources
     end
 
     def curl_command_string(username, password, ssl_verify)
-      cmd_string = ['curl']
-      cmd_string << '-k' unless ssl_verify
+      cmd_string = ["curl"]
+      cmd_string << "-k" unless ssl_verify
       cmd_string << "-H 'Content-Type: application/json'"
       cmd_string << " -u #{username}:#{password}" unless username.nil? || password.nil?
-      cmd_string << URI.join(url, '_nodes')
+      cmd_string << URI.join(url, "_nodes")
 
-      cmd_string.join(' ')
+      cmd_string.join(" ")
     end
 
     def verify_curl_success!(cmd)
@@ -150,18 +148,18 @@ module Inspec::Resources
       end
 
       if cmd.stderr =~ /Peer's Certificate issuer is not recognized/
-        raise 'Connection refused - peer certificate issuer is not recognized'
+        raise "Connection refused - peer certificate issuer is not recognized"
       end
 
-      raise "Error fetching Elastcsearch data from curl #{url}: #{cmd.stderr}" unless cmd.exit_status.zero?
+      raise "Error fetching Elastcsearch data from curl #{url}: #{cmd.stderr}" unless cmd.exit_status == 0
     end
 
     def verify_json_payload!(content)
-      unless content['error'].nil?
+      unless content["error"].nil?
         raise "#{content['error']['type']}: #{content['error']['reason']}"
       end
 
-      raise 'No successful nodes available in cluster' if content['_nodes']['successful'].zero?
+      raise "No successful nodes available in cluster" if content["_nodes"]["successful"] == 0
     end
   end
 end

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

@@ -1,14 +1,13 @@
-# encoding: utf-8
 # copyright:
 
-require 'utils/parser'
-require 'utils/file_reader'
+require "inspec/utils/parser"
+require "inspec/utils/file_reader"
 
 module Inspec::Resources
   class EtcFstab < Inspec.resource(1)
-    name 'etc_fstab'
-    supports platform: 'unix'
-    desc 'Use the etc_fstab InSpec audit resource to check the configuration of the etc/fstab file.'
+    name "etc_fstab"
+    supports platform: "unix"
+    desc "Use the etc_fstab InSpec audit resource to check the configuration of the etc/fstab file."
     example <<~EXAMPLE
       nfs_systems = etc_fstab.nfs_file_systems.entries
       nfs_systems.each do |file_system|
@@ -30,7 +29,7 @@ module Inspec::Resources
     include FileReader
 
     def initialize(fstab_path = nil)
-      @conf_path      = fstab_path || '/etc/fstab'
+      @conf_path      = fstab_path || "/etc/fstab"
       @files_contents = {}
       @content        = nil
       @params         = nil
@@ -38,12 +37,12 @@ module Inspec::Resources
     end
 
     filter = FilterTable.create
-    filter.register_column(:device_name,           field: 'device_name')
-          .register_column(:mount_point,           field: 'mount_point')
-          .register_column(:file_system_type,      field: 'file_system_type')
-          .register_column(:mount_options,         field: 'mount_options')
-          .register_column(:dump_options,          field: 'dump_options')
-          .register_column(:file_system_options,   field: 'file_system_options')
+    filter.register_column(:device_name,           field: "device_name")
+          .register_column(:mount_point,           field: "mount_point")
+          .register_column(:file_system_type,      field: "file_system_type")
+          .register_column(:mount_options,         field: "mount_options")
+          .register_column(:dump_options,          field: "dump_options")
+          .register_column(:file_system_options,   field: "file_system_options")
           .register_custom_matcher(:configured?) { |x| x.entries.any? }
 
     filter.install_filter_methods_on_resource(self, :params)
@@ -53,14 +52,14 @@ module Inspec::Resources
     end
 
     def home_mount_options
-      return nil unless where { mount_point == '/home' }.configured?
-      where { mount_point == '/home' }.entries[0].mount_options
+      return nil unless where { mount_point == "/home" }.configured?
+      where { mount_point == "/home" }.entries[0].mount_options
     end
 
     private
 
     def read_content
-      @content = ''
+      @content = ""
       @params  = {}
       @content = read_file(@conf_path)
       @params  = parse_conf(@content)
@@ -68,20 +67,20 @@ module Inspec::Resources
 
     def parse_conf(content)
       content.map do |line|
-        data, = parse_comment_line(line, comment_char: '#', standalone_comments: false)
-        parse_line(data) unless data == ''
+        data, = parse_comment_line(line, comment_char: "#", standalone_comments: false)
+        parse_line(data) unless data == ""
       end.compact
     end
 
     def parse_line(line)
       attributes = line.split
       {
-        'device_name'         => attributes[0],
-        'mount_point'         => attributes[1],
-        'file_system_type'    => attributes[2],
-        'mount_options'       => attributes[3].split(','),
-        'dump_options'        => attributes[4].to_i,
-        'file_system_options' => attributes[5].to_i,
+        "device_name" => attributes[0],
+        "mount_point" => attributes[1],
+        "file_system_type" => attributes[2],
+        "mount_options" => attributes[3].split(","),
+        "dump_options" => attributes[4].to_i,
+        "file_system_options" => attributes[5].to_i,
       }
     end
 

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

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # copyright: 2015, Vulcano Security GmbH
 
 # The file format consists of
@@ -18,18 +17,18 @@
 #   its('users') { should include 'my_user' }
 # end
 
-require 'utils/convert'
-require 'utils/parser'
-require 'utils/file_reader'
+require "inspec/utils/convert"
+require "inspec/utils/parser"
+require "inspec/utils/file_reader"
 
 module Inspec::Resources
   class EtcGroup < Inspec.resource(1)
     include Converter
     include CommentParser
 
-    name 'etc_group'
-    supports platform: 'unix'
-    desc 'Use the etc_group InSpec audit resource to test groups that are defined on Linux and UNIX platforms. The /etc/group file stores details about each group---group name, password, group identifier, along with a comma-separate list of users that belong to the group.'
+    name "etc_group"
+    supports platform: "unix"
+    desc "Use the etc_group InSpec audit resource to test groups that are defined on Linux and UNIX platforms. The /etc/group file stores details about each group---group name, password, group identifier, along with a comma-separate list of users that belong to the group."
     example <<~EXAMPLE
       describe etc_group do
         its('gids') { should_not contain_duplicates }
@@ -42,25 +41,25 @@ module Inspec::Resources
 
     attr_accessor :gid, :entries
     def initialize(path = nil)
-      @path = path || '/etc/group'
+      @path = path || "/etc/group"
       @entries = parse_group(@path)
     end
 
     def groups(filter = nil)
-      (filter || @entries)&.map { |x| x['name'] }
+      (filter || @entries)&.map { |x| x["name"] }
     end
 
     def gids(filter = nil)
-      (filter || @entries)&.map { |x| x['gid'] }
+      (filter || @entries)&.map { |x| x["gid"] }
     end
 
     def users(filter = nil)
       entries = filter || @entries
       return nil if entries.nil?
       # filter the user entry
-      res = entries.map { |x|
-        x['members'].split(',') if !x.nil? && !x['members'].nil?
-      }.flatten
+      res = entries.map do |x|
+        x["members"].split(",") if !x.nil? && !x["members"].nil?
+      end.flatten
       # filter nil elements
       res.reject { |x| x.nil? || x.empty? }
     end
@@ -68,13 +67,13 @@ module Inspec::Resources
     def where(conditions = {})
       return if conditions.empty?
       fields = {
-        name: 'name',
-        group_name: 'name',
-        password: 'password',
-        gid: 'gid',
-        group_id: 'gid',
-        users: 'members',
-        members: 'members',
+        name: "name",
+        group_name: "name",
+        password: "password",
+        gid: "gid",
+        group_id: "gid",
+        users: "members",
+        members: "members",
       }
       res = entries
 
@@ -90,7 +89,7 @@ module Inspec::Resources
     end
 
     def to_s
-      '/etc/group'
+      "/etc/group"
     end
 
     private
@@ -107,19 +106,19 @@ module Inspec::Resources
 
     def parse_group_line(line)
       opts = {
-        comment_char: '#',
+        comment_char: "#",
         standalone_comments: false,
       }
       line, _idx_nl = parse_comment_line(line, opts)
-      x = line.split(':')
+      x = line.split(":")
       # abort if we have an empty or comment line
       return nil if x.empty?
       # map data
       {
-        'name' => x.at(0), # Name of the group.
-        'password' => x.at(1), # Group's encrypted password.
-        'gid' => convert_to_i(x.at(2)), # The group's decimal ID.
-        'members' => x.at(3), # Group members.
+        "name" => x.at(0), # Name of the group.
+        "password" => x.at(1), # Group's encrypted password.
+        "gid" => convert_to_i(x.at(2)), # The group's decimal ID.
+        "members" => x.at(3), # Group members.
       }
     end
   end

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

@@ -1,13 +1,11 @@
-# encoding: utf-8
-
-require 'utils/parser'
-require 'utils/file_reader'
+require "inspec/utils/parser"
+require "inspec/utils/file_reader"
 
 class EtcHosts < Inspec.resource(1)
-  name 'etc_hosts'
-  supports platform: 'linux'
-  supports platform: 'bsd'
-  supports platform: 'windows'
+  name "etc_hosts"
+  supports platform: "linux"
+  supports platform: "bsd"
+  supports platform: "windows"
   desc 'Use the etc_hosts InSpec audit resource to find an
     ip_address and its associated hosts'
   example <<~EXAMPLE
@@ -23,7 +21,7 @@ class EtcHosts < Inspec.resource(1)
   include CommentParser
   include FileReader
 
-  DEFAULT_UNIX_PATH    = '/etc/hosts'.freeze
+  DEFAULT_UNIX_PATH    = "/etc/hosts".freeze
   DEFAULT_WINDOWS_PATH = 'C:\windows\system32\drivers\etc\hosts'.freeze
 
   def initialize(hosts_path = nil)
@@ -33,9 +31,9 @@ class EtcHosts < Inspec.resource(1)
   end
 
   FilterTable.create
-             .register_column(:ip_address,     field: 'ip_address')
-             .register_column(:primary_name,   field: 'primary_name')
-             .register_column(:all_host_names, field: 'all_host_names')
+             .register_column(:ip_address,     field: "ip_address")
+             .register_column(:primary_name,   field: "primary_name")
+             .register_column(:all_host_names, field: "all_host_names")
              .install_filter_methods_on_resource(self, :params)
 
   private
@@ -49,7 +47,7 @@ class EtcHosts < Inspec.resource(1)
   end
 
   def comment?
-    parse_options = { comment_char: '#', standalone_comments: false }
+    parse_options = { comment_char: "#", standalone_comments: false }
 
     ->(data) { parse_comment_line(data, parse_options).first.empty? }
   end