Method: Inspec::ResourceDSL#__register

Defined in:
lib/inspec/plugins/resource.rb

#__register(name, obj) ⇒ Object

rubocop:disable Metrics/MethodLength



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/inspec/plugins/resource.rb', line 40

def __register(name, obj) # rubocop:disable Metrics/MethodLength
  cl = Class.new(obj) do
    attr_reader :resource_exception_message

    def initialize(backend, name, *args)
      @resource_skipped = false
      @resource_failed = false

      # attach the backend to this instance
      @__backend_runner__ = backend
      @__resource_name__ = name

      # call the resource initializer
      begin
        super(*args)
      rescue Inspec::Exceptions::ResourceSkipped => e
        skip_resource(e.message)
      rescue Inspec::Exceptions::ResourceFailed => e
        fail_resource(e.message)
      end
    end

    def self.desc(description = nil)
      return @description if description.nil?
      @description = description
    end

    def self.example(example = nil)
      return @example if example.nil?
      @example = example
    end

    def skip_resource(message)
      @resource_skipped = true
      @resource_exception_message = message
    end

    def resource_skipped?
      @resource_skipped
    end

    def resource_skipped
      warn('[DEPRECATION] Use `resource_exception_message` for the resource skipped message. This method will be removed in InSpec 2.0.')
      # Returning `nil` here to match previous behavior
      return nil if @resource_skipped == false
      @resource_exception_message
    end

    def fail_resource(message)
      @resource_failed = true
      @resource_exception_message = message
    end

    def resource_failed?
      @resource_failed
    end

    def inspec
      @__backend_runner__
    end
  end

  # rubocop:enable Lint/NestedMethodDefinition
  if __resource_registry.key?(name)
    Inspec::Log.warn("Overwriting resource #{name}. To reference a specific version of #{name} use the resource() method")
  end
  __resource_registry[name] = cl
end