File Manager

Viewing File: test.rb

# This class is deprecated and will be removed in the next major release of InSpec.
# Use the Inspec::Object classes from the inspec-objects rubygem instead.

require "inspec/utils/deprecation"

module Inspec
  class Test
    attr_accessor :qualifier, :matcher, :expectation, :skip, :negated, :variables, :only_if
    include RubyHelper

    def initialize
      @qualifier = []
      @negated = false
      @variables = []

      Inspec.deprecate(:object_classes, "The Inspec::Test class is deprecated. Use the Inspec::Object::Test class from the inspec-objects Ruby library.")
    end

    def negate!
      @negated = !@negated
    end

    def to_ruby
      return rb_skip unless 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
      only_if_clause = "only_if { #{only_if} }\n" if only_if
      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("%s%sdescribe %s do\n  %s { should%s %s%s }\nend",
             only_if_clause, 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