Class: InspecPlugins::CloudFormation::Input

Inherits:
Object
  • Object
show all
Defined in:
lib/inspec-cloudformation/input.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Input 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/inspec-cloudformation/input.rb', line 18

def initialize
  @plugin_conf = Inspec::Config.cached.fetch_plugin_config("inspec-cloudformation")

  @logger = Inspec::Log
  logger.debug format("inspec-cloudformation plugin version %s", VERSION)

  # @mount_point = fetch_plugin_setting("mount_point", "secret")
  # @path_prefix = fetch_plugin_setting("path_prefix", "inspec")

  # We need priority to be numeric; even though env vars or JSON may present it as string - hence the to_i
  @priority = fetch_plugin_setting("priority", 60).to_i


end

Instance Attribute Details

#input_name ⇒ Object (readonly)

Returns the value of attribute input_name.



15
16
17
 
# File 'lib/inspec-cloudformation/input.rb', line 15

def input_name
  @input_name
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



16
17
18
 
# File 'lib/inspec-cloudformation/input.rb', line 16

def logger
  @logger
end

#plugin_conf ⇒ Object (readonly)

VALID_PATTERNS = [

Regexp.new("^databag://[^/]+/[^/]+/.+$"),
Regexp.new("^node://[^/]*/attributes/.+$"),

].freeze



13
14
15
 
# File 'lib/inspec-cloudformation/input.rb', line 13

def plugin_conf
  @plugin_conf
end

#priority ⇒ Object (readonly)

Returns the value of attribute priority.



14
15
16
 
# File 'lib/inspec-cloudformation/input.rb', line 14

def priority
  @priority
end

Instance Method Details

#default_priority ⇒ Object

What priority should an input value recieve from us? This plgin does not currently allow setting this on a per-input basis, so they all recieve the same “default” value. Implements github.com/inspec/inspec/blob/master/dev-docs/plugins.md#default_priority



37
38
39
 
# File 'lib/inspec-cloudformation/input.rb', line 37

def default_priority
  priority
end

#fetch(profile_name, input_name) ⇒ Object 



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
 
# File 'lib/inspec-cloudformation/input.rb', line 41

def fetch(profile_name, input_name)
  # skip any input name that is an invalid cloudformation stack name to keep things quick...no need to make the AWS API call.
  return nil if input_name.include?('_')
  return nil unless input_name.include?('/')

  # input format will be "cloudformation stack name / output name"
  stack_name = input_name.split('/').first
  output_name = input_name.split('/').last

  logger.debug format("The stack name is  %s", stack_name)
  logger.debug format("The output name is  %s", output_name)

  cf = Aws::CloudFormation::Client.new

  name = { stack_name: stack_name }
  resp = cf.describe_stacks(name)
  return nil if resp.stacks.nil? || resp.stacks.empty?
  stack = resp.stacks.first
  stack.outputs.each do |output|
      next unless output['output_key'] == output_name
      return output['output_value']
  end

  # if no CloudFormation output found
  return nil
end