inspec-core 2.1.67

data/lib/inspec/method_source.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+# author: Dominik Richter
+# author: Christoph Hartmann
+
+module Inspec
+  module MethodSource
+    def self.code_at(location, source_reader)
+      # TODO: logger for these cases
+      return '' if location.nil? || location[:ref].nil? || location[:line].nil?
+      return '' unless source_reader && source_reader.target
+
+      # TODO: Non-controls still need more detection
+      ref = location[:ref]
+      ref = ref.sub(source_reader.target.prefix, '')
+      src = source_reader.tests[ref]
+      return '' if src.nil?
+
+      ::MethodSource.expression_at(src.lines, location[:line]).force_encoding('utf-8')
+    rescue SyntaxError => e
+      raise ::MethodSource::SourceNotFoundError,
+            "Could not parse source at #{location[:ref]}:#{location[:line]}: #{e.message}"
+    end
+  end
+end

data/lib/inspec/objects.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module Inspec
+  autoload :Attribute, 'inspec/objects/attribute'
+  autoload :Tag, 'inspec/objects/tag'
+  autoload :Control, 'inspec/objects/control'
+  autoload :Describe, 'inspec/objects/describe'
+  autoload :EachLoop, 'inspec/objects/each_loop'
+  autoload :List, 'inspec/objects/list'
+  autoload :OrTest, 'inspec/objects/or_test'
+  autoload :RubyHelper, 'inspec/objects/ruby_helper'
+  autoload :Test, 'inspec/objects/test'
+  autoload :Value, 'inspec/objects/value'
+end

data/lib/inspec/objects/attribute.rb

@@ -0,0 +1,75 @@
+# encoding:utf-8
+
+module Inspec
+  class Attribute
+    attr_accessor :name
+    attr_writer :value
+
+    DEFAULT_ATTRIBUTE = Class.new do
+      def initialize(name)
+        @name = name
+      end
+
+      def method_missing(*_)
+        Inspec::Log.warn(
+          "Returning DEFAULT_ATTRIBUTE for '#{@name}'. "\
+          "Use --attrs to provide a value for '#{@name}' or specify a default  "\
+          "value with `attribute('#{@name}', default: 'somedefault', ...)`.",
+        )
+
+        self
+      end
+
+      def respond_to_missing?(_, _)
+        true
+      end
+    end
+
+    def initialize(name, options = {})
+      @name = name
+      @opts = options
+      @value = nil
+    end
+
+    # implicit call is done by inspec to determine the value of an attribute
+    def value
+      @value.nil? ? default : @value
+    end
+
+    def default
+      @opts.key?(:default) ? @opts[:default] : DEFAULT_ATTRIBUTE.new(@name)
+    end
+
+    def title
+      @opts[:title]
+    end
+
+    def description
+      @opts[:description]
+    end
+
+    def ruby_var_identifier
+      @opts[:identifier] || 'attr_' + @name.downcase.strip.gsub(/\s+/, '-').gsub(/[^\w-]/, '')
+    end
+
+    def to_hash
+      {
+        name: @name,
+        options: @opts,
+      }
+    end
+
+    def to_ruby
+      res = ["#{ruby_var_identifier} = attribute('#{@name}',{"]
+      res.push "  title: '#{title}'," unless title.to_s.empty?
+      res.push "  default: #{default.inspect}," unless default.to_s.empty?
+      res.push "  description: '#{description}'," unless description.to_s.empty?
+      res.push '})'
+      res.join("\n")
+    end
+
+    def to_s
+      "Attribute #{@name} with #{@value}"
+    end
+  end
+end

data/lib/inspec/objects/control.rb

@@ -0,0 +1,61 @@
+# encoding:utf-8
+
+module Inspec
+  class Control
+    attr_accessor :id, :title, :desc, :impact, :tests, :tags, :refs
+    def initialize
+      @tests = []
+      @tags = []
+      @refs = []
+    end
+
+    def add_test(t)
+      @tests.push(t)
+    end
+
+    def add_tag(t)
+      @tags.push(t)
+    end
+
+    def to_hash
+      { id: id, title: title, desc: desc, impact: impact, tests: tests.map(&:to_hash), tags: tags.map(&:to_hash) }
+    end
+
+    def to_ruby # rubocop:disable Metrics/AbcSize
+      res = ["control #{id.inspect} do"]
+      res.push "  title #{title.inspect}" unless title.to_s.empty?
+      res.push "  desc  #{prettyprint_text(desc, 2)}" unless desc.to_s.empty?
+      res.push "  impact #{impact}" unless impact.nil?
+      tags.each { |t| res.push(indent(t.to_ruby, 2)) }
+      refs.each { |t| res.push("  ref   #{print_ref(t)}") }
+      tests.each { |t| res.push(indent(t.to_ruby, 2)) }
+      res.push 'end'
+      res.join("\n")
+    end
+
+    private
+
+    def print_ref(x)
+      return x.inspect if x.is_a?(String)
+      raise "Cannot process the ref: #{x}" unless x.is_a?(Hash)
+      '('+x.inspect+')'
+    end
+
+    # Pretty-print a text block of InSpec code
+    #
+    # @param s [String] should not be empty
+    # @param depth [Int] indentation length for multiline text blocks
+    # @return [String] pretty-printed textblock
+    def prettyprint_text(s, depth)
+      txt = s.to_s.inspect.gsub('\n', "\n")
+      return txt if !txt.include?("\n")
+      middle = indent(txt[1..-2], depth+2)
+      txt[0] + "\n" + middle + "\n" + ' '*depth + txt[-1]
+    end
+
+    def indent(txt, d)
+      dt = ' '*d
+      dt + txt.gsub("\n", "\n"+dt)
+    end
+  end
+end

data/lib/inspec/objects/describe.rb

@@ -0,0 +1,92 @@
+# encoding:utf-8
+
+module Inspec
+  class Describe
+    # Internal helper to structure test objects.
+    # Should not be exposed to the user as it is hidden behind
+    # `add_test`, `to_hash`, and `to_ruby` in Inspec::Describe
+    Test = Struct.new(:its, :matcher, :expectation, :negated) do
+      def negate!
+        self.negated = !negated
+      end
+
+      def to_ruby
+        itsy = its.nil? ? 'it' : 'its(' + its.to_s.inspect + ')'
+        naughty = negated ? '_not' : ''
+        xpect = if expectation.nil?
+                  ''
+                elsif expectation.class == Regexp
+                  # without this, xpect values like / \/zones\// will not be parsed properly
+                  "(#{expectation.inspect})"
+                else
+                  ' ' + expectation.inspect
+                end
+        format('%s { should%s %s%s }', itsy, naughty, matcher, xpect)
+      end
+    end
+
+    # A qualifier describing the resource that will be tested. It may consist
+    # of the resource identification and multiple accessors to pinpoint the data
+    # the user wants to test.
+    attr_accessor :qualifier
+
+    # An array of individual tests for the qualifier. Every entry will be
+    # translated into an `it` or `its` clause.
+    attr_accessor :tests
+
+    # Optional variables which are used by tests.
+    attr_accessor :variables
+
+    # Optional method to skip this describe block altogether. If `skip` is
+    # defined it takes precendence and will print the skip statement instead
+    # of adding other tests.
+    attr_accessor :skip
+
+    include RubyHelper
+
+    def initialize
+      @qualifier = []
+      @tests = []
+      @variables = []
+    end
+
+    def add_test(its, matcher, expectation)
+      test = Inspec::Describe::Test.new(its, matcher, expectation, false)
+      tests.push(test)
+      test
+    end
+
+    def to_ruby
+      return rb_skip if !skip.nil?
+      rb_describe
+    end
+
+    def to_hash
+      { qualifier: qualifier, tests: tests.map(&:to_h), variables: variables, skip: skip }
+    end
+
+    def resource
+      return nil if qualifier.empty? || qualifier[0].empty? || qualifier[0][0].empty?
+      qualifier[0][0]
+    end
+
+    private
+
+    def rb_describe
+      vars = variables.map(&:to_ruby).join("\n")
+      vars += "\n" unless vars.empty?
+
+      objarr = @qualifier
+      objarr = [['unknown object'.inspect]] if objarr.nil? || objarr.empty?
+      obj = objarr.map { |q| ruby_qualifier(q) }.join('.')
+
+      rbtests = tests.map(&:to_ruby).join("\n  ")
+      format("%sdescribe %s do\n  %s\nend", vars, obj, rbtests)
+    end
+
+    def rb_skip
+      obj = @qualifier || skip.inspect
+      format("describe %s do\n  skip %s\nend", obj, skip.inspect)
+    end
+  end
+end

data/lib/inspec/objects/each_loop.rb

@@ -0,0 +1,36 @@
+# encoding:utf-8
+
+module Inspec
+  class EachLoop < List
+    attr_reader :variables
+    attr_accessor :tests
+    def initialize
+      super
+      @tests = []
+      @variables = []
+    end
+
+    def add_test(t = nil)
+      t ||= Test.new
+      t.qualifier[0] = ['entry']
+      @tests.push(t)
+      t
+    end
+
+    def negate!
+      @tests.each(&:negate!)
+    end
+
+    def to_hash
+      { qualifier: qualifier, test: @test }
+    end
+
+    def to_ruby
+      vars = variables.map(&:to_ruby).join("\n")
+      vars += "\n" unless vars.empty?
+      obj = super
+      all_tests = @tests.map(&:to_ruby).join("\n").gsub("\n", "\n  ")
+      format("%s%s.each do |entry|\n  %s\nend", vars, obj, all_tests)
+    end
+  end
+end

data/lib/inspec/objects/list.rb

@@ -0,0 +1,15 @@
+# encoding:utf-8
+
+module Inspec
+  class List < Value
+    def map
+      raise 'Inspec::List.map needs to be called with a block' unless block_given?
+      t = List.new
+      t.qualifier = [['x']]
+      yield(t)
+      return if t.qualifier == [['x']]
+      @qualifier.push(['map', "{ |x| #{t.to_ruby} }"])
+      self
+    end
+  end
+end

data/lib/inspec/objects/or_test.rb

@@ -0,0 +1,40 @@
+# encoding:utf-8
+
+module Inspec
+  class OrTest
+    attr_reader :tests
+    def initialize(tests)
+      @tests = tests
+      @negated = false
+    end
+
+    def skip
+      nil
+    end
+
+    def negate!
+      @negated = !@negated
+    end
+
+    def to_ruby
+      if @negated
+        # We don't use the describe.one wrapper when negated because:
+        # !(test1 || test2)     same as    (!test1 && !test2)    where && is implicit in inspec
+        all_tests = @tests.map { |test|
+          test.negate!
+          test
+        }.map(&:to_ruby).join("\n")
+
+        all_tests
+      else
+        all_tests = @tests.map(&:to_ruby).join("\n").gsub("\n", "\n  ")
+
+        format("describe.one do\n  %s\nend", all_tests)
+      end
+    end
+
+    def to_hash
+      { describe_one: @tests.map(&:to_hash) }
+    end
+  end
+end

data/lib/inspec/objects/ruby_helper.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module Inspec
+  module RubyHelper
+    def ruby_qualifier(q)
+      if q.length <= 1
+        q[0]
+      elsif q[0] == 'map' && q.length == 2
+        q[0] + ' ' + q[1]
+      else
+        q[0] + '(' + q[1..-1].map(&:inspect).join(', ') + ')'
+      end
+    end
+  end
+end

data/lib/inspec/objects/tag.rb

@@ -0,0 +1,27 @@
+# encoding:utf-8
+
+module Inspec
+  class Tag
+    attr_accessor :key, :value
+
+    def initialize(key, value)
+      @key = key
+      @value = value
+    end
+
+    def to_hash
+      {
+        name: key,
+        value: value,
+      }
+    end
+
+    def to_ruby
+      "tag #{key.inspect}: #{value.inspect}"
+    end
+
+    def to_s
+      "Tag #{key} with #{value}"
+    end
+  end
+end

data/lib/inspec/objects/test.rb

@@ -0,0 +1,87 @@
+# encoding:utf-8
+
+module Inspec
+  class Test
+    attr_accessor :qualifier, :matcher, :expectation, :skip, :negated, :variables
+    include RubyHelper
+
+    def initialize
+      @qualifier = []
+      @negated = false
+      @variables = []
+    end
+
+    def negate!
+      @negated = !@negated
+    end
+
+    def to_ruby
+      return rb_skip if !skip.nil?
+      rb_describe
+    end
+
+    def to_hash
+      { qualifier: qualifier, matcher: matcher, expectation: expectation, skip: skip, negated: negated }
+    end
+
+    def resource
+      @resource ||=
+        if qualifier.empty? || qualifier[0].empty? || qualifier[0][0].empty?
+          nil
+        else
+          qualifier[0][0]
+        end
+    end
+
+    def remove_expectation
+      remove_instance_variable(:@expectation)
+    end
+
+    private
+
+    def describe_chain
+      return nil if @qualifier.empty?
+
+      resource = @qualifier.length > 1 ? @qualifier[0..-2] : [@qualifier[0]]
+      res = resource.map { |q| ruby_qualifier(q) }.join('.')
+      xres = nil
+
+      if @qualifier.length > 1
+        last = @qualifier[-1]
+        last_call = last.is_a?(Array) ? last[0].to_s : ''
+        if last.length == 1 && last_call !~ /^to_.$/ && !last_call.include?('[') && !last_call.empty?
+          # this will go in its()
+          xres = last_call
+        else
+          res += '.' + ruby_qualifier(last) unless last_call.empty?
+        end
+      end
+
+      [res, xres]
+    end
+
+    def rb_describe
+      vars = variables.map(&:to_ruby).join("\n")
+      vars += "\n" unless vars.empty?
+      res, xtra = describe_chain
+      itsy = xtra.nil? ? 'it' : 'its(' + xtra.to_s.inspect + ')'
+      naughty = @negated ? '_not' : ''
+      xpect = if !defined?(@expectation)
+                ''
+              elsif @expectation.class == Regexp
+                # without this, xpect values like / \/zones\// will not be parsed properly
+                "(#{@expectation.inspect})"
+              elsif xpect != ''
+                ' ' + expectation.inspect
+              end
+      format("%sdescribe %s do\n  %s { should%s %s%s }\nend",
+             vars, res, itsy, naughty, matcher, xpect)
+    end
+
+    def rb_skip
+      dc = describe_chain
+      obj = dc.nil? ? skip.inspect : dc[0]
+      format("describe %s do\n  skip %s\nend", obj, skip.inspect)
+    end
+  end
+end