Class: Orch::Parse

Inherits:
Object
  • Object
show all
Defined in:
lib/parse.rb

Instance Method Summary collapse

Constructor Details

#initialize(path, options) ⇒ Parse

Returns a new instance of Parse.



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/parse.rb', line 9

def initialize(path, options)
  if ! File.file?(path)
    exit_with_msg "file does not exist: #{path}"
  end

  begin
    yaml = ::YAML.load_file(path)
  rescue Psych::SyntaxError => e
    exit_with_msg "error parsing yaml file #{e}"
  end

  @options = options

  @spec = Hashie::Mash.new(yaml)
end

Instance Method Details

#check_option_syntax ⇒ Object 



272
273
274
275
276
277
278
279
280
 
# File 'lib/parse.rb', line 272

def check_option_syntax
  if @dry_run
    return
  end

  if ! ['chronos', 'marathon', 'all'].include?(@options[:deploy_kind])
    exit_with_msg "value of --deploy-type was #{@options[:deploy_kind]}, must be chronos, marathon or all"
  end
end

#check_version ⇒ Object 



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/parse.rb', line 246

def check_version

  # Check for valid version paramter
  if @spec.version.nil?
    exit_with_msg "required field version was not found"
  end

  if @spec.version == "alpha1"
    # Getting rid of alpha1 syntax and just going to number syntax.  Will support this for a little bit...
    version = 1.0
  else

    number = Float( @spec.version ) rescue nil
    if number.nil? 
      exit_with_msg "invalid value \"#{@spec.version}\" for version field of spec"
    end
    version = number
  end

  if version > CURRENT_SPEC_VERSION
    STDERR.puts "warning: spec version greater than software supports - may get failure or unexpected behavior"
  end

  # If we get to point where we need to support older formats - determine that here.
end

#do_subst(spec, app) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/parse.rb', line 219

def do_subst(spec, app)
  spec_str = spec.to_json.to_s

  # Subst any of the deploy_vars values
  if (! @spec.deploy_vars.nil?)
    @spec.deploy_vars.each do |key, value|
      spec_str = spec_str.gsub(/{{#{key}}}/, app[key])
    end
  end

  # Subst any values that were passed in via command line
  if ! @options[:subst].nil?
    @options[:subst].split(",").each do |x|
      pair = x.split("=")
      spec_str = spec_str.gsub(/{{#{pair[0]}}}/, pair[1])
    end
  end

  # Check if any substitution variables still exist
  tag_match = /{{\w+}}/.match(spec_str)
  if !tag_match.nil?
    exit_with_msg "unsubstituted varaibles still remain in spec: #{tag_match.to_s}"
  end

  return spec_str
end

#parse(dry_run) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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
 
# File 'lib/parse.rb', line 25

def parse(dry_run)
  @dry_run = dry_run
  check_option_syntax
  check_version
  spec = @spec

  # Check for vault vars
  env_var_values = parse_vault_vars(@spec)

  # Check for env values at spec level
  if ! spec.env.nil?
    env_var_values = env_var_values.merge(spec.env)
  end

  if spec.applications.nil?
    exit_with_msg "required section applications: must have at least one application defined"
  end

  results = []
  spec.applications.each do |app|
    # Check for valid kind paramter
    if app.kind.nil?
      exit_with_msg "required field 'kind:' was not found"
    end

    if !(app.kind == "Chronos" || app.kind == "Marathon")
      exit_with_msg "unsupported kind specified: #{app.kind} - must be: Chronos | Marathon"
    end

    # Generate any deploy variables that need to be merged in
    deploy_vars = parse_deploy_vars(app)
    app_var_values = env_var_values.merge(deploy_vars)

    # Check for env values at app level
    if ! app.env.nil?
      app_var_values = app_var_values.merge(app.env)
    end

    if (app.kind == "Chronos")
      chronos_spec = parse_chronos(app, app_var_values)

      result = {
        :name => chronos_spec["name"], 
        :type => app.kind, 
        :deploy => should_deploy?(app), 
        :env_vars => deploy_vars, 
        :json => chronos_spec,
        :url => $ORCH_CONFIG.chronos_url(spec, app)
      }

      results << result
    end

    if (app.kind == "Marathon")
      marathon_spec = parse_marathon(app, app_var_values)

      result = {
        :name => marathon_spec["id"], 
        :type => app.kind, 
        :deploy => should_deploy?(app), 
        :env_vars => deploy_vars, 
        :json => marathon_spec,
        :url => $ORCH_CONFIG.marathon_url(spec, app)
      }

      if app.bamboo_spec
        bamboo_spec = parse_bamboo(app, app_var_values)
        result[:bamboo_spec] = bamboo_spec
        result[:bamboo_url] = $ORCH_CONFIG.bamboo_url(spec, app)
      end

      results << result
    end

  end

  return results
end

#parse_bamboo(app, env_var_values) ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/parse.rb', line 184

def parse_bamboo(app, env_var_values)
  # Do any substs
  spec_str = do_subst(app.bamboo_spec, app)
  bamboo_spec = JSON.parse(spec_str)

  if bamboo_spec['acl'].nil?
    puts "required field 'acl:' missing from bamboo_spec"
  end

  return bamboo_spec
end

#parse_chronos(app, env_var_values) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/parse.rb', line 134

def parse_chronos(app, env_var_values)
  if app.chronos_spec.nil?
    exit_with_msg "App of kind: Chronos requires a 'chronos_spec:' field"
  end
  chronos_spec = app.chronos_spec

  # Override out high-level env vars with any chronos_spec level vars
  env_vars = env_var_values
  (chronos_spec.environmentVariables || []).each do |x|
    env_vars[x["name"]] = x["value"]
  end

  # Rewrite the environmentVariables from the hash
  chronos_spec.environmentVariables = []
  env_vars.each do |key, value|
    pair = {"name" => key, "value" => value}
    chronos_spec.environmentVariables << pair        
  end

  # Do subst processing
  spec_str = do_subst(chronos_spec, app)
  chronos_spec = JSON.parse(spec_str)

  return chronos_spec
end

#parse_deploy_vars(app) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/parse.rb', line 104

def parse_deploy_vars(app)
  result = {}
  if (! @spec.deploy_vars.nil?)
    @spec.deploy_vars.each do |key, value|
      if app[key].nil?
        exit_with_msg "deploy_var #{key} specified - but not included in app"
        # TODO: would be nice to put the app name...
      end
      if ! @spec.deploy_vars[key].include? app[key]
        exit_with_msg "#{key} value \"#{app[key]}\" not in #{@spec.deploy_vars[key].to_s}"
      end
      result[key] = app[key]
    end
  end

  return result
end

#parse_marathon(app, env_var_values) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/parse.rb', line 160

def parse_marathon(app, env_var_values)
  if app.marathon_spec.nil?
    exit_with_msg "App of kind: Marathon requires a 'marathon_spec:' field"
  end
  marathon_spec = app.marathon_spec

  # Augment any spec environment variables with meta values - but don't overwite
  marathon_spec.env = {} unless marathon_spec.env
  env_var_values.each do |key, value|
    marathon_spec.env[key] = value.to_s unless marathon_spec.env[key] 
  end

  if marathon_spec.id
    marathon_spec.id = (marathon_spec.id[0] == '/') ? marathon_spec.id : ("/" + marathon_spec.id)
  else
    exit_with_msg "id: is a required field for a marathon spec"
  end

  spec_str = do_subst(marathon_spec, app)
  marathon_spec = JSON.parse(spec_str)

  return marathon_spec
end

#parse_vault_vars(spec) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/parse.rb', line 122

def parse_vault_vars(spec)
  result = {}
  if ! spec.vault.nil?
    count = 1
    spec.vault.each do |vault_key|
      result["VAULT_KEY_#{count}"] = vault_key
      count += 1
    end
  end
  return result
end

#should_deploy?(app) ⇒ Boolean

Returns:

  • (Boolean) 


196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/parse.rb', line 196

def should_deploy?(app)
  result = true
  if @options[:deploy_kind] != 'all' && app.kind != @options[:deploy_kind]
    result = false
  end

  if @options[:deploy_var] != 'all'
    @options[:deploy_var].split(",").each do |x|
      pair = x.split("=")
      deployVar = pair[0]
      deployVal = pair[1]
      if app[deployVar].nil?
        exit_with_msg "environment var of '#{deployVar}' not found in app"
      end
      if app[deployVar] != deployVal
        result = false
      end
    end
  end

  return result
end