Class: Lono::Param::Generator

Inherits:
Object
  • Object
show all
Includes:
Blueprint::Root, Conventions
Defined in:
lib/lono/param/generator.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Conventions

#template_param_convention

Methods included from Blueprint::Root

#bundler_groups, #find_blueprint_root, #require_bundle_gems, #set_blueprint_root

Constructor Details

#initialize(blueprint, options = {}) ⇒ Generator

Returns a new instance of Generator.



7
8
9
10
11
12
13
14
 
# File 'lib/lono/param/generator.rb', line 7

def initialize(blueprint, options={})
  # dup because we're modifying the Thor frozen hash
  # HashWithIndifferentAccess.new again because .dup changes it to a normal Hash
  @blueprint, @options = blueprint, ActiveSupport::HashWithIndifferentAccess.new(options.dup)
  @options[:stack] ||= @blueprint
  set_blueprint_root(@blueprint)
  @template, @param = template_param_convention(options)
end

Instance Attribute Details

#base_path ⇒ Object (readonly)

set when generate is called



6
7
8
 
# File 'lib/lono/param/generator.rb', line 6

def base_path
  @base_path
end

#env_path ⇒ Object (readonly)

set when generate is called



6
7
8
 
# File 'lib/lono/param/generator.rb', line 6

def env_path
  @env_path
end

Instance Method Details

#config_locations ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/lono/param/generator.rb', line 42

def config_locations
  @base_path = lookup_config_location("base")
  @env_path = lookup_config_location(Lono.env)

  if ENV['LONO_DEBUG_PARAM']
    puts "LONO_DEBUG_PARAM enabled"
    puts "  @base_path #{@base_path.inspect}"
    puts "  @env_path #{@env_path.inspect}"
  end

  [@base_path, @env_path]
end

#context ⇒ Object

Context for ERB rendering. This is where we control what references get passed to the ERB rendering.



128
129
130
 
# File 'lib/lono/param/generator.rb', line 128

def context
  @context ||= Lono::Template::Context.new(@blueprint, @options)
end

#convert_to_cfn_format(contents, casing = :camel) ⇒ Object 



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/lono/param/generator.rb', line 143

def convert_to_cfn_format(contents, casing=:camel)
  lines = parse_contents(contents)

  # First use a Hash structure so that overlay env files will override
  # the base param file.
  data = {}
  lines.each do |line|
    key,value = line.strip.split("=").map {|x| x.strip}
    data[key] = value
  end

  # Now build up the aws json format for parameters
  params = []
  data.each do |key,value|
    param = if value == "use_previous_value" || value == "UsePreviousValue"
              {
                "ParameterKey": key,
                "UsePreviousValue": true
              }
            elsif value
              {
                "ParameterKey": key,
                "ParameterValue": value
              }
            end
    if param
      param = param.to_snake_keys if casing == :underscore
      params << param
    end
  end
  params
end

#generate ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/lono/param/generator.rb', line 16

def generate
  puts "Generating parameter files for blueprint #{@blueprint.color(:green)}:"

  @base_path, @env_path = config_locations

  return unless @base_path || @env_path

  # useful option for lono cfn, since some templates dont require params
  return if @options[:allow_not_exists] && !params_exist?

  if params_exist?
    contents = process_erb
    data = convert_to_cfn_format(contents)
    json = JSON.pretty_generate(data)
    write_output(json)
    unless @options[:mute]
      short_output_path = output_path.sub("#{Lono.root}/","")
      puts "  #{short_output_path}"
    end
  else
    puts "#{@base_path} or #{@env_path} could not be found?  Are you sure it exist?"
    exit 1
  end
  json
end

#lookup_config_location(env) ⇒ Object 



55
56
57
58
59
60
61
 
# File 'lib/lono/param/generator.rb', line 55

def lookup_config_location(env)
  options = @options.clone
  options[:blueprint] = @blueprint
  options[:stack] ||= @blueprint
  location = Lono::ConfigLocation.new("params", options, env)
  env == "base" ? location.lookup_base : location.lookup
end

#output_path ⇒ Object 



176
177
178
179
180
181
182
183
184
185
 
# File 'lib/lono/param/generator.rb', line 176

def output_path
  output = Lono.config.output_path.sub("#{Lono.root}/","")
  path = if @base_path && !@env_path
           # Handle case when base config exist but the env config does not
           @base_path.sub("configs", output).sub("base", Lono.env)
         else
           @env_path.sub("configs", output)
         end
  path.sub(/\.txt$/,'.json')
end

#params(casing = :underscore) ⇒ Object

useful for when calling CloudFormation via the aws-sdk gem



82
83
84
85
86
87
88
89
90
 
# File 'lib/lono/param/generator.rb', line 82

def params(casing = :underscore)
  @base_path, @env_path = config_locations

  # useful option for lono cfn
  return {} if @options[:allow_not_exists] && !params_exist?

  contents = process_erb
  convert_to_cfn_format(contents, casing)
end

#params_exist? ⇒ Boolean

Checks both base and source path for existing of the param file. Example:

params/base/mystack.txt - base path
params/production/mystack.txt - source path

Returns:

  • (Boolean) 


76
77
78
79
 
# File 'lib/lono/param/generator.rb', line 76

def params_exist?
  @base_path && File.exist?(@base_path) ||
  @env_path && File.exist?(@env_path)
end

#parse_contents(contents) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/lono/param/generator.rb', line 132

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

#process_erb ⇒ Object

Reads both the base source and env source and overlay the two Example 1:

params/base/mystack.txt - base path
params/production/mystack.txt - env path

the base/mystack.txt gets combined with the prod/mystack.txt
it produces a final prod/mystack.txt

Example 2:

params/base/mystack.txt - base path

the base/mystack.txt is used to produced a prod/mystack.txt

Example 3:

params/production/mystack.txt - env path

the prod/mystack.txt is used to produced a prod/mystack.txt



109
110
111
112
113
114
115
116
117
 
# File 'lib/lono/param/generator.rb', line 109

def process_erb
  contents = []
  contents << render_erb(@base_path)
  contents << render_erb(@env_path)
  result = contents.compact.join("\n")
  # puts "process_erb result".color(:yellow)
  # puts result
  result
end

#puts_param_message(type) ⇒ Object 



63
64
65
66
67
68
69
70
 
# File 'lib/lono/param/generator.rb', line 63

def puts_param_message(type)
  path = send("#{type}_path")
  return unless path
  if param_file?(path)
    pretty_path = path.sub("#{Lono.root}/",'')
    puts "Using param for #{type}: #{pretty_path}".color(:yellow)
  end
end

#render_erb(path) ⇒ Object 



119
120
121
122
123
124
 
# File 'lib/lono/param/generator.rb', line 119

def render_erb(path)
  return unless path
  if File.exist?(path)
    RenderMePretty.result(path, context: context)
  end
end

#write_output(json) ⇒ Object 



187
188
189
190
191
 
# File 'lib/lono/param/generator.rb', line 187

def write_output(json)
  dir = File.dirname(output_path)
  FileUtils.mkdir_p(dir)
  IO.write(output_path, json)
end