Class: Secrets::YAML

Inherits:
Object
  • Object
show all
Defined in:
lib/inspec/secrets/yaml.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(target) ⇒ YAML

array of yaml file paths



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/inspec/secrets/yaml.rb', line 18

def initialize(target)
  # Ruby 3.1 treats YAML load as a dangerous operation by default, requiring us to declare date and time classes as permitted
  # It's not a valid option in 3.0.x
  if Gem.ruby_version >= Gem::Version.new("3.1.0")
    @inputs = ::YAML.load_file(target, permitted_classes: [Date, Time])
  else
    @inputs = ::YAML.load_file(target)
  end

  # In case of empty yaml file raise the warning else raise the parsing error.
  if !@inputs || @inputs.empty?
    Inspec::Log.warn("Unable to parse #{target}: YAML file is empty.")
    @inputs = nil
  elsif !@inputs.is_a?(Hash)
    # Exits with usage error.
    Inspec::Log.error("Unable to parse #{target}: invalid YAML or contents is not a Hash")
    Inspec::UI.new.exit(:usage_error)
  end
rescue => e
  # Any other error related to Yaml parsing will be raised here.
  raise "Error reading YAML file #{target}: #{e}"
end

Instance Attribute Details

#inputs ⇒ Object (readonly)

Returns the value of attribute inputs.



7
8
9
 
# File 'lib/inspec/secrets/yaml.rb', line 7

def inputs
  @inputs
end

Class Method Details

.resolve(target) ⇒ Object 



9
10
11
12
13
14
15
 
# File 'lib/inspec/secrets/yaml.rb', line 9

def self.resolve(target)
  unless target.is_a?(String) && File.file?(target) && [".yml", ".yaml"].include?(File.extname(target).downcase)
    return nil
  end

  new(target)
end