Class: Inspec::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

#initialize ⇒ Describe

Returns a new instance of Describe.



54
55
56
57
58
 
# File 'lib/inspec/objects/describe.rb', line 54

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

Instance Attribute Details

#qualifier ⇒ Object

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.



38
39
40
 
# File 'lib/inspec/objects/describe.rb', line 38

def qualifier
  @qualifier
end

#skip ⇒ Object

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.



50
51
52
 
# File 'lib/inspec/objects/describe.rb', line 50

def skip
  @skip
end

#tests ⇒ Object

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



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

def tests
  @tests
end

#variables ⇒ Object

Optional variables which are used by tests.



45
46
47
 
# File 'lib/inspec/objects/describe.rb', line 45

def variables
  @variables
end

Instance Method Details

#add_test(its, matcher, expectation) ⇒ Object 



60
61
62
63
64
 
# File 'lib/inspec/objects/describe.rb', line 60

def add_test(its, matcher, expectation)
  test = Inspec::Describe::Test.new(its, matcher, expectation, false)
  tests.push(test)
  test
end

#resource ⇒ Object 



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

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

#to_hash ⇒ Object 



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

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

#to_ruby ⇒ Object 



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

def to_ruby
  return rb_skip if !skip.nil?
  rb_describe
end