Class: Ufo::TaskDefinition::Helpers::Vars

Inherits:
Object
  • Object
show all
Extended by:
Memoist
Includes:
Concerns::Names, Config::CallableOption::Concern, AwsHelper, Utils::Pretty
Defined in:
lib/ufo/task_definition/helpers/vars.rb

Instance Method Summary collapse

Methods included from Config::CallableOption::Concern

#callable_option

Methods included from Utils::Pretty

#pretty_home, #pretty_path, #pretty_time

Methods included from Concerns::Names

#names

Methods included from AwsHelper

#aws

Constructor Details

#initialize(options = {}) ⇒ Vars

Returns a new instance of Vars.



11
12
13
14
15
# File 'lib/ufo/task_definition/helpers/vars.rb', line 11

def initialize(options={})
  # use either file or text. text takes higher precedence
  @file = options[:file]
  @text = options[:text]
end

Instance Method Details

#contentObject



17
18
19
# File 'lib/ufo/task_definition/helpers/vars.rb', line 17

def content
  @text || read(@file)
end

#conventional_pattern(name, value) ⇒ Object

Examples with config.secrets.provider = “ssm”

.secrets

DB_NAME

Results

DB_NAME=:APP/:ENV/:SECRET_NAME # expansion will use => demo/dev/DB_NAME


89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/ufo/task_definition/helpers/vars.rb', line 89

def conventional_pattern(name, value)
  secrets = Ufo.config.secrets
  provider = secrets.provider # ssm or secretsmanager
  namespace = provider == "ssm" ? "parameter/" : "secret:"

  config_name = "secrets.pattern.#{provider}"
  pattern = callable_option(
    config_name: config_name, # Ufo.config.names.stack => :APP-:ROLE-:ENV => demo-web-dev
    passed_args: [self],
  )
  # replace :SECRET_NAME since names expand doesnt know how to nor do we want to add logic there
  pattern = pattern.sub(':SECRET_NAME', name)
  "arn:aws:#{provider}:#{region}:#{}:#{namespace}#{pattern}"
end

#envObject



30
31
32
33
34
35
36
37
38
39
40
41
42
# File 'lib/ufo/task_definition/helpers/vars.rb', line 30

def env
  lines = filtered_lines(content)
  lines.map do |line|
    key,*value = line.strip.split("=").map do |x|
      remove_surrounding_quotes(x.strip)
    end
    value = value.join('=')
    {
      name: key,
      value: value,
    }
  end
end

#expansion(arn) ⇒ Object

arn:aws:ssm:us-west-2:111111111111:parameter/demo/dev/DB-NAME arn:aws:ssm:us-west-2:111111111111:parameter/demo/dev/DB-NAME



71
72
73
74
75
76
77
# File 'lib/ufo/task_definition/helpers/vars.rb', line 71

def expansion(arn)
  # performance improvement only run names.expansion on the name portion
  md = arn.match(/(.*:)(parameter\/|secret:)(.*)/)
  prefix, type, name = md[1], md[2], md[3]
  expanded_name = names.expansion(name, dasherize: false) # dasherize: false. dont turn SECRET_NAME => SECRET-NAME
  "#{prefix}#{type}#{expanded_name}"
end

#filtered_lines(content) ⇒ Object



114
115
116
117
118
119
120
121
122
# File 'lib/ufo/task_definition/helpers/vars.rb', line 114

def filtered_lines(content)
  lines = content.split("\n")
  # remove comment at the end of the line
  lines.map! { |l| l.sub(/\s+#.*/,'').strip }
  # filter out commented lines
  lines = lines.reject { |l| l =~ /(^|\s)#/i }
  # filter out empty lines
  lines = lines.reject { |l| l.strip.empty? }
end

#normalize_to_arn(name, value) ⇒ Object



56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/ufo/task_definition/helpers/vars.rb', line 56

def normalize_to_arn(name, value)
  case value
  when /^ssm:/i
    value.sub(/^ssm:/i, "arn:aws:ssm:#{region}:#{}:parameter/")
  when /^secretsmanager:/i
    value.sub(/^secretsmanager:/i, "arn:aws:secretsmanager:#{region}:#{}:secret:")
  when '' # blank string will mean use convention
    conventional_pattern(name, value)
  else
    value # assume full arn has been passed
  end
end

#read(path) ⇒ Object



21
22
23
24
25
26
27
28
# File 'lib/ufo/task_definition/helpers/vars.rb', line 21

def read(path)
  full_path = "#{Ufo.root}/#{path}"
  unless File.exist?(full_path)
    puts "The #{pretty_path(full_path)} env file could not be found.  Are you sure it exists?"
    exit 1
  end
  IO.read(full_path)
end

#remove_surrounding_quotes(s) ⇒ Object



104
105
106
107
108
109
110
111
112
# File 'lib/ufo/task_definition/helpers/vars.rb', line 104

def remove_surrounding_quotes(s)
  if s =~ /^"/ && s =~ /"$/
    s.sub(/^["]/, '').gsub(/["]$/,'') # remove surrounding double quotes
  elsif s =~ /^'/ && s =~ /'$/
    s.sub(/^[']/, '').gsub(/[']$/,'') # remove surrounding single quotes
  else
    s
  end
end

#secretsObject



44
45
46
47
48
49
50
51
52
53
54
# File 'lib/ufo/task_definition/helpers/vars.rb', line 44

def secrets
  secrets = env
  secrets.map do |item|
    value = item.delete(:value)
    arn = normalize_to_arn(item[:name], value)
    value = expansion(arn)
    value = value.sub('parameter//','parameter/') # auto fix accidental leading slash for user
    item[:valueFrom] = value
  end
  secrets
end