inspec 2.1.0 → 2.1.10

data/lib/resources/docker_service.rb

@@ -1,90 +1,90 @@
-# encoding: utf-8
-#
-# Copyright 2017, Christoph Hartmann
-
-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'
-    example "
-      describe docker_service('service1') do
-        it { should exist }
-        its('id') { should_not eq '' }
-        its('image') { should eq 'alpine:latest' }
-        its('repo') { should eq 'alpine' }
-        its('tag') { should eq 'latest' }
-      end
-
-      describe docker_service(id: '4a415e366388') do
-        it { should exist }
-      end
-
-      describe docker_service(image: 'alpine:latest') do
-        it { should exist }
-      end
-    "
-
-    def initialize(opts = {})
-      # do sanitizion of input values
-      o = opts.dup
-      o = { name: opts } if opts.is_a?(String)
-      @opts = sanitize_options(o)
-    end
-
-    def name
-      object_info.names[0] if object_info.entries.size == 1
-    end
-
-    def image
-      object_info.images[0] if object_info.entries.size == 1
-    end
-
-    def image_name
-      parse_components_from_image(image)[:image_name] if object_info.entries.size == 1
-    end
-
-    def repo
-      parse_components_from_image(image)[:repo] if object_info.entries.size == 1
-    end
-
-    def tag
-      parse_components_from_image(image)[:tag] if object_info.entries.size == 1
-    end
-
-    def mode
-      object_info.modes[0] if object_info.entries.size == 1
-    end
-
-    def replicas
-      object_info.replicas[0] if object_info.entries.size == 1
-    end
-
-    def ports
-      object_info.ports[0] if object_info.entries.size == 1
-    end
-
-    def to_s
-      service = @opts[:name] || @opts[:id]
-      "Docker Service #{service}"
-    end
-
-    private
-
-    def sanitize_options(opts)
-      opts.merge(parse_components_from_image(opts[:image]))
-    end
-
-    def object_info
-      return @info if defined?(@info)
-      opts = @opts
-      @info = inspec.docker.services.where {
-        name == opts[:name] || image == opts[:image] || (!id.nil? && !opts[:id].nil? && (id == opts[:id] || id.start_with?(opts[:id])))
-      }
-    end
-  end
-end
+# encoding: utf-8
+#
+# Copyright 2017, Christoph Hartmann
+
+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'
+    example "
+      describe docker_service('service1') do
+        it { should exist }
+        its('id') { should_not eq '' }
+        its('image') { should eq 'alpine:latest' }
+        its('repo') { should eq 'alpine' }
+        its('tag') { should eq 'latest' }
+      end
+
+      describe docker_service(id: '4a415e366388') do
+        it { should exist }
+      end
+
+      describe docker_service(image: 'alpine:latest') do
+        it { should exist }
+      end
+    "
+
+    def initialize(opts = {})
+      # do sanitizion of input values
+      o = opts.dup
+      o = { name: opts } if opts.is_a?(String)
+      @opts = sanitize_options(o)
+    end
+
+    def name
+      object_info.names[0] if object_info.entries.size == 1
+    end
+
+    def image
+      object_info.images[0] if object_info.entries.size == 1
+    end
+
+    def image_name
+      parse_components_from_image(image)[:image_name] if object_info.entries.size == 1
+    end
+
+    def repo
+      parse_components_from_image(image)[:repo] if object_info.entries.size == 1
+    end
+
+    def tag
+      parse_components_from_image(image)[:tag] if object_info.entries.size == 1
+    end
+
+    def mode
+      object_info.modes[0] if object_info.entries.size == 1
+    end
+
+    def replicas
+      object_info.replicas[0] if object_info.entries.size == 1
+    end
+
+    def ports
+      object_info.ports[0] if object_info.entries.size == 1
+    end
+
+    def to_s
+      service = @opts[:name] || @opts[:id]
+      "Docker Service #{service}"
+    end
+
+    private
+
+    def sanitize_options(opts)
+      opts.merge(parse_components_from_image(opts[:image]))
+    end
+
+    def object_info
+      return @info if defined?(@info)
+      opts = @opts
+      @info = inspec.docker.services.where {
+        name == opts[:name] || image == opts[:image] || (!id.nil? && !opts[:id].nil? && (id == opts[:id] || id.start_with?(opts[:id])))
+      }
+    end
+  end
+end

data/lib/resources/elasticsearch.rb

@@ -1,169 +1,169 @@
-# encoding: utf-8
-
-require 'utils/filter'
-require 'hashie/mash'
-require 'resources/package'
-
-module Inspec::Resources
-  class Elasticsearch < Inspec.resource(1)
-    name 'elasticsearch'
-    supports platform: 'unix'
-    desc "Use the Elasticsearch InSpec audit resource to test the status of nodes in
-      an Elasticsearch cluster."
-
-    example "
-      describe elasticsearch('http://eshost.mycompany.biz:9200/', username: 'elastic', password: 'changeme', ssl_verify: false) do
-        its('node_count') { should >= 3 }
-      end
-
-      describe elasticsearch do
-        its('node_name') { should include 'node1' }
-        its('os') { should_not include 'MacOS' }
-        its('version') { should cmp > 1.2.0 }
-      end
-    "
-
-    filter = FilterTable.create
-    filter.add_accessor(:where)
-          .add_accessor(:entries)
-          .add(:cluster_name,          field: 'cluster_name')
-          .add(:node_name,             field: 'name')
-          .add(:transport_address,     field: 'transport_address')
-          .add(:host,                  field: 'host')
-          .add(:ip,                    field: 'ip')
-          .add(:version,               field: 'version')
-          .add(:build_hash,            field: 'build_hash')
-          .add(:total_indexing_buffer, field: 'total_indexing_buffer')
-          .add(:roles,                 field: 'roles')
-          .add(:settings,              field: 'settings')
-          .add(:os,                    field: 'os')
-          .add(:process,               field: 'process')
-          .add(:jvm,                   field: 'jvm')
-          .add(:transport,             field: 'transport')
-          .add(:http,                  field: 'http')
-          .add(:plugins,               field: 'plugins')
-          .add(:plugin_list,           field: 'plugin_list')
-          .add(:modules,               field: 'modules')
-          .add(:module_list,           field: 'module_list')
-          .add(:node_id,               field: 'node_id')
-          .add(:ingest,                field: 'ingest')
-          .add(:exists?) { |x| !x.entries.empty? }
-          .add(:node_count) { |t, _|
-            t.entries.length
-          }
-
-    filter.connect(self, :nodes)
-
-    attr_reader :nodes, :url
-
-    def initialize(opts = {})
-      return skip_resource 'Package `curl` not avaiable on the host' unless inspec.command('curl').exist?
-
-      @url = opts.fetch(:url, 'http://localhost:9200')
-
-      username   = opts.fetch(:username, nil)
-      password   = opts.fetch(:password, nil)
-      ssl_verify = opts.fetch(:ssl_verify, true)
-
-      cmd = inspec.command(curl_command_string(username, password, ssl_verify))
-
-      # after implementation of PR #2235, this begin..rescue won't be necessary.
-      # The checks in verify_curl_success! can raise their own skip message exception.
-      begin
-        verify_curl_success!(cmd)
-      rescue => e
-        return skip_resource e.message
-      end
-
-      begin
-        content = JSON.parse(cmd.stdout)
-        # after implementation of PR #2235, this can be broken out of the begin..rescue
-        # clause. The checks in verify_json_payload! can raise their own skip message exception.
-        verify_json_payload!(content)
-      rescue JSON::ParserError => e
-        return skip_resource "Couldn't parse the Elasticsearch response: #{e.message}"
-      rescue => e
-        return skip_resource e.message
-      end
-
-      @nodes = parse_cluster(content)
-    end
-
-    def to_s
-      "Elasticsearch Cluster #{url}"
-    end
-
-    private
-
-    def parse_cluster(content)
-      return [] unless content['nodes']
-
-      nodes = []
-
-      content['nodes'].each do |node_id, node_data|
-        node_data = fix_mash_key_collision(node_data)
-
-        node = Hashie::Mash.new(node_data)
-        node.node_id = node_id
-        node.plugin_list = node.plugins.map(&:name)
-        node.module_list = node.modules.map(&:name)
-        node.cluster_name = node.settings.cluster.name
-        nodes << node
-      end
-
-      nodes
-    end
-
-    #
-    # Hashie::Mash will throw warnings if the Mash contains a key that is the same as a built-in
-    # method on a Hashie::Mash instance. This is a crude way of avoiding those warnings without
-    # hard-coding a bunch of key renames.
-    #
-    # Any key that is in conflict will be renamed "es_ORIGINALKEY"
-    #
-    def fix_mash_key_collision(data)
-      test_mash = Hashie::Mash.new
-
-      new_data = {}
-      data.each do |key, value|
-        new_key = test_mash.respond_to?(key.to_sym) ? "es_#{key}" : key
-        new_value = value.is_a?(Hash) ? fix_mash_key_collision(value) : value
-
-        new_data[new_key] = new_value
-      end
-
-      new_data
-    end
-
-    def curl_command_string(username, password, 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.join(' ')
-    end
-
-    def verify_curl_success!(cmd)
-      # the following lines captures known possible curl command errors and provides compact skip resource messeges
-      if cmd.stderr =~ /Failed to connect/
-        raise "Connection refused - please check the URL #{url} for accuracy"
-      end
-
-      if cmd.stderr =~ /Peer's 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?
-    end
-
-    def verify_json_payload!(content)
-      unless content['error'].nil?
-        raise "#{content['error']['type']}: #{content['error']['reason']}"
-      end
-
-      raise 'No successful nodes available in cluster' if content['_nodes']['successful'].zero?
-    end
-  end
-end
+# encoding: utf-8
+
+require 'utils/filter'
+require 'hashie/mash'
+require 'resources/package'
+
+module Inspec::Resources
+  class Elasticsearch < Inspec.resource(1)
+    name 'elasticsearch'
+    supports platform: 'unix'
+    desc "Use the Elasticsearch InSpec audit resource to test the status of nodes in
+      an Elasticsearch cluster."
+
+    example "
+      describe elasticsearch('http://eshost.mycompany.biz:9200/', username: 'elastic', password: 'changeme', ssl_verify: false) do
+        its('node_count') { should >= 3 }
+      end
+
+      describe elasticsearch do
+        its('node_name') { should include 'node1' }
+        its('os') { should_not include 'MacOS' }
+        its('version') { should cmp > 1.2.0 }
+      end
+    "
+
+    filter = FilterTable.create
+    filter.add_accessor(:where)
+          .add_accessor(:entries)
+          .add(:cluster_name,          field: 'cluster_name')
+          .add(:node_name,             field: 'name')
+          .add(:transport_address,     field: 'transport_address')
+          .add(:host,                  field: 'host')
+          .add(:ip,                    field: 'ip')
+          .add(:version,               field: 'version')
+          .add(:build_hash,            field: 'build_hash')
+          .add(:total_indexing_buffer, field: 'total_indexing_buffer')
+          .add(:roles,                 field: 'roles')
+          .add(:settings,              field: 'settings')
+          .add(:os,                    field: 'os')
+          .add(:process,               field: 'process')
+          .add(:jvm,                   field: 'jvm')
+          .add(:transport,             field: 'transport')
+          .add(:http,                  field: 'http')
+          .add(:plugins,               field: 'plugins')
+          .add(:plugin_list,           field: 'plugin_list')
+          .add(:modules,               field: 'modules')
+          .add(:module_list,           field: 'module_list')
+          .add(:node_id,               field: 'node_id')
+          .add(:ingest,                field: 'ingest')
+          .add(:exists?) { |x| !x.entries.empty? }
+          .add(:node_count) { |t, _|
+            t.entries.length
+          }
+
+    filter.connect(self, :nodes)
+
+    attr_reader :nodes, :url
+
+    def initialize(opts = {})
+      return skip_resource 'Package `curl` not avaiable on the host' unless inspec.command('curl').exist?
+
+      @url = opts.fetch(:url, 'http://localhost:9200')
+
+      username   = opts.fetch(:username, nil)
+      password   = opts.fetch(:password, nil)
+      ssl_verify = opts.fetch(:ssl_verify, true)
+
+      cmd = inspec.command(curl_command_string(username, password, ssl_verify))
+
+      # after implementation of PR #2235, this begin..rescue won't be necessary.
+      # The checks in verify_curl_success! can raise their own skip message exception.
+      begin
+        verify_curl_success!(cmd)
+      rescue => e
+        return skip_resource e.message
+      end
+
+      begin
+        content = JSON.parse(cmd.stdout)
+        # after implementation of PR #2235, this can be broken out of the begin..rescue
+        # clause. The checks in verify_json_payload! can raise their own skip message exception.
+        verify_json_payload!(content)
+      rescue JSON::ParserError => e
+        return skip_resource "Couldn't parse the Elasticsearch response: #{e.message}"
+      rescue => e
+        return skip_resource e.message
+      end
+
+      @nodes = parse_cluster(content)
+    end
+
+    def to_s
+      "Elasticsearch Cluster #{url}"
+    end
+
+    private
+
+    def parse_cluster(content)
+      return [] unless content['nodes']
+
+      nodes = []
+
+      content['nodes'].each do |node_id, node_data|
+        node_data = fix_mash_key_collision(node_data)
+
+        node = Hashie::Mash.new(node_data)
+        node.node_id = node_id
+        node.plugin_list = node.plugins.map(&:name)
+        node.module_list = node.modules.map(&:name)
+        node.cluster_name = node.settings.cluster.name
+        nodes << node
+      end
+
+      nodes
+    end
+
+    #
+    # Hashie::Mash will throw warnings if the Mash contains a key that is the same as a built-in
+    # method on a Hashie::Mash instance. This is a crude way of avoiding those warnings without
+    # hard-coding a bunch of key renames.
+    #
+    # Any key that is in conflict will be renamed "es_ORIGINALKEY"
+    #
+    def fix_mash_key_collision(data)
+      test_mash = Hashie::Mash.new
+
+      new_data = {}
+      data.each do |key, value|
+        new_key = test_mash.respond_to?(key.to_sym) ? "es_#{key}" : key
+        new_value = value.is_a?(Hash) ? fix_mash_key_collision(value) : value
+
+        new_data[new_key] = new_value
+      end
+
+      new_data
+    end
+
+    def curl_command_string(username, password, 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.join(' ')
+    end
+
+    def verify_curl_success!(cmd)
+      # the following lines captures known possible curl command errors and provides compact skip resource messeges
+      if cmd.stderr =~ /Failed to connect/
+        raise "Connection refused - please check the URL #{url} for accuracy"
+      end
+
+      if cmd.stderr =~ /Peer's 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?
+    end
+
+    def verify_json_payload!(content)
+      unless content['error'].nil?
+        raise "#{content['error']['type']}: #{content['error']['reason']}"
+      end
+
+      raise 'No successful nodes available in cluster' if content['_nodes']['successful'].zero?
+    end
+  end
+end