Class: Inspec::Object::Describe

Inherits:
Object
  • Object
show all
Includes:
RubyHelper
Defined in:
lib/inspec/objects/describe.rb

Defined Under Namespace

Classes: Test

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from RubyHelper

#ruby_qualifier

Constructor Details

#initializeDescribe

Returns a new instance of Describe.


52
53
54
55
56
# File 'lib/inspec/objects/describe.rb', line 52

def initialize
  @qualifier = []
  @tests = []
  @variables = []
end

Instance Attribute Details

#qualifierObject

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.


36
37
38
# File 'lib/inspec/objects/describe.rb', line 36

def qualifier
  @qualifier
end

#skipObject

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.


48
49
50
# File 'lib/inspec/objects/describe.rb', line 48

def skip
  @skip
end

#testsObject

An array of individual tests for the qualifier. Every entry will be translated into an `it` or `its` clause.


40
41
42
# File 'lib/inspec/objects/describe.rb', line 40

def tests
  @tests
end

#variablesObject

Optional variables which are used by tests.


43
44
45
# File 'lib/inspec/objects/describe.rb', line 43

def variables
  @variables
end

Instance Method Details

#add_test(its, matcher, expectation, opts = {}) ⇒ Object


58
59
60
61
62
# File 'lib/inspec/objects/describe.rb', line 58

def add_test(its, matcher, expectation, opts = {})
  test = Inspec::Object::Describe::Test.new(its, matcher, expectation, opts[:negated])
  tests.push(test)
  test
end

#resourceObject


74
75
76
77
78
# File 'lib/inspec/objects/describe.rb', line 74

def resource
  return nil if qualifier.empty? || qualifier[0].empty? || qualifier[0][0].empty?

  qualifier[0][0]
end

#to_hashObject


70
71
72
# File 'lib/inspec/objects/describe.rb', line 70

def to_hash
  { qualifier: qualifier, tests: tests.map(&:to_h), variables: variables, skip: skip }
end

#to_rubyObject


64
65
66
67
68
# File 'lib/inspec/objects/describe.rb', line 64

def to_ruby
  return rb_skip unless skip.nil?

  rb_describe
end