Class: FPM::Fry::Command::Cook

Inherits:
FPM::Fry::Command show all
Defined in:
lib/fpm/fry/command/cook.rb

Constant Summary collapse

UPDATE_VALUES = 
['auto','never','always']

Instance Attribute Summary collapse

Attributes inherited from FPM::Fry::Command

#client, #ui

Instance Method Summary collapse

Methods inherited from FPM::Fry::Command

#parse

Constructor Details

#initialize(invocation_path, ctx = {}, parent_attribute_values = {}) ⇒ Cook

Returns a new instance of Cook.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/fpm/fry/command/cook.rb', line 21

def initialize(invocation_path, ctx = {}, parent_attribute_values = {})
  @tls = nil
  require 'digest'
  require 'fileutils'
  require 'fpm/fry/recipe'
  require 'fpm/fry/recipe/builder'
  require 'fpm/fry/detector'
  require 'fpm/fry/docker_file'
  require 'fpm/fry/stream_parser'
  require 'fpm/fry/os_db'
  require 'fpm/fry/block_enumerator'
  require 'fpm/fry/build_output_parser'
  super
end

Instance Attribute Details

#build_image ⇒ Object 



126
127
128
129
130
131
132
133
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
159
160
161
162
163
164
 
# File 'lib/fpm/fry/command/cook.rb', line 126

def build_image
  @build_image ||= begin
    sum = Digest::SHA256.hexdigest( image_id + "\0" + cache.cachekey )
    cachetag = "fpm-fry:#{sum[0..30]}"
    res = client.get(
      expects: [200,404],
      path: client.url("images/#{cachetag}/json")
    )
    if res.status == 404
      df = DockerFile::Source.new(builder.variables.merge(image: image_id),cache)
      client.post(
        headers: {
          'Content-Type'=>'application/tar'
        },
        expects: [200],
        path: client.url("build?rm=1&dockerfile=#{DockerFile::NAME}&t=#{cachetag}"),
        request_block: BlockEnumerator.new(df.tar_io)
      )
    end

    df = DockerFile::Build.new(cachetag, builder.variables.dup,builder.recipe, update: update?)
    parser = BuildOutputParser.new(out)
    res = client.post(
      headers: {
        'Content-Type'=>'application/tar'
      },
      expects: [200],
      path: client.url("build?rm=1&dockerfile=#{DockerFile::NAME}"),
      request_block: BlockEnumerator.new(df.tar_io),
      response_block: parser
    )
    if parser.images.none?
      raise "Didn't find a build image in the stream. This usually means that the build script failed."
    end
    image = parser.images.last
    logger.debug("Detected build image", image: image)
    image
  end
end

#builder ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/fpm/fry/command/cook.rb', line 76

def builder
  @builder ||= begin
    vars = {
      distribution: detector.distribution,
      distribution_version: detector.version,
      flavour: flavour
    }
    logger.debug("Loading recipe",variables: vars, recipe: recipe)
    b = Recipe::Builder.new(vars, Recipe.new, logger: ui.logger)
    b.load_file( recipe )
    b
  end
end

#cache ⇒ Object 



91
92
93
 
# File 'lib/fpm/fry/command/cook.rb', line 91

def cache
  @cache ||= builder.recipe.source.build_cache(tmpdir)
end

#flavour ⇒ Object 



54
55
56
 
# File 'lib/fpm/fry/command/cook.rb', line 54

def flavour
  @flavour ||= OsDb.fetch(detector.distribution,{flavour: "unknown"})[:flavour]
end

#image_id ⇒ Object 



114
115
116
117
118
119
120
121
122
123
 
# File 'lib/fpm/fry/command/cook.rb', line 114

def image_id
  @image_id ||= begin
    res = client.get(
      expects: [200],
      path: client.url("images/#{image}/json")
    )
    body = JSON.parse(res.body)
    body.fetch('id'){ body.fetch('Id') }
  end
end

#output_class ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/fpm/fry/command/cook.rb', line 59

def output_class
  @output_class ||= begin
    logger.debug("Autodetecting package type",flavour: flavour)
    case(flavour)
    when 'debian'
      require 'fpm/package/deb'
      FPM::Package::Deb
    when 'redhat'
      require 'fpm/package/rpm'
      FPM::Package::RPM
    else
      raise "Cannot auto-detect package type."
    end
  end
end

Instance Method Details

#adjust_config_files(output) ⇒ Object 



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/fpm/fry/command/cook.rb', line 324

def adjust_config_files( output )
  # FPM flags all files in /etc as config files but only for debian :/.
  # Actually this behavior makes sense to me for all packages because it's 
  # the thing I usually want. By setting this attribute at least the 
  # misleading warning goes away.
  output.attributes[:deb_no_default_config_files?] = true
  output.attributes[:deb_auto_config_files?] = false

  return if output.attributes[:fry_config_explicitly_used]

  # Now that we have disabled this for debian we have to reenable if it for 
  # all.
  etc = File.expand_path('etc', output.staging_path)
  if File.exists?( etc )
    # Config plugin wasn't used. Add everything under /etc
    prefix_length = output.staging_path.size + 1
    added = []
    Find.find(etc) do | path |
      next unless File.file? path
      name = path[prefix_length..-1]
      if !output.config_files.include? name
        added << name
        output.config_files << name
      end
    end
    if added.any?
      logger.hint( "#{output.name} contains some config files in /etc. They were automatically added. You can customize this using the \"config\" plugin.",
                  documentation: "https://github.com/xing/fpm-fry/wiki/Plugin-config",
                  files: added)
    end
  end
end

#build! ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
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
245
246
247
248
 
# File 'lib/fpm/fry/command/cook.rb', line 199

def build!
  res = client.post(
     headers: {
      'Content-Type' => 'application/json'
     },
     path: client.url('containers','create'),
     expects: [201],
     body: JSON.generate({"Image" => build_image})
  )

  body = JSON.parse(res.body)
  container = body['Id']
  begin
    client.post(
      headers: {
        'Content-Type' => 'application/json'
      },
      path: client.url('containers',container,'start'),
      expects: [204],
      body: JSON.generate({})
    )

    client.post(
      path: client.url('containers',container,'attach?stderr=1&stdout=1&stream=1'),
      body: '',
      expects: [200],
      middlewares: [
        StreamParser.new(out,err),
        Excon::Middleware::Expects,
        Excon::Middleware::Instrumentor,
        Excon::Middleware::Mock
      ]
    )

    res = client.post(
      path: client.url('containers',container,'wait'),
      expects: [200],
      body: ''
    )
    json = JSON.parse(res.body)
    if json["StatusCode"] != 0
      raise "Build failed with exit code #{json["StatusCode"]}"
    end
    return yield container
  ensure
    unless keep?
      client.delete(path: client.url('containers',container))
    end
  end
end

#detector ⇒ Object 



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/fpm/fry/command/cook.rb', line 36

def detector
  @detector || begin
    if distribution
      d = Detector::String.new(distribution)
    else
      d = Detector::Image.new(client, image)
    end
    self.detector=d
  end
end

#detector=(d) ⇒ Object 



47
48
49
50
51
52
 
# File 'lib/fpm/fry/command/cook.rb', line 47

def detector=(d)
  unless d.detect!
    raise "Unable to detect distribution from given image"
  end
  @detector = d
end

#execute ⇒ Object 



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/fpm/fry/command/cook.rb', line 359

def execute
  # force some eager loading
  lint_recipe_file!
  detector
  flavour
  output_class
  lint_output_class!
  builder
  lint_recipe!
  cache

  image_id
  build_image

  packages do | dir_map |

    build! do |container|
      input_package(container) do |input|
        input.split( container, dir_map )
      end
    end

  end

  return 0
rescue Recipe::NotFound => e
  logger.error("Recipe not found", recipe: recipe, exception: e)
  return 1
rescue => e
  logger.error(e)
  return 1
end

#input_package(container) ⇒ Object 



250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/fpm/fry/command/cook.rb', line 250

def input_package(container)
  input = FPM::Package::Docker.new(logger: logger, client: client)
  builder.recipe.apply_input(input)
  begin
    input.input(container)
    return yield(input)
  ensure
    input.cleanup_staging
    input.cleanup_build
  end
end

#lint_output_class! ⇒ Object 



96
97
98
 
# File 'lib/fpm/fry/command/cook.rb', line 96

def lint_output_class!

end

#lint_recipe! ⇒ Object 



104
105
106
107
108
109
110
111
112
 
# File 'lib/fpm/fry/command/cook.rb', line 104

def lint_recipe!
  problems = builder.recipe.lint
  if problems.any?
    problems.each do |p|
      logger.error(p)
    end
    raise
  end
end

#lint_recipe_file! ⇒ Object 



100
101
102
 
# File 'lib/fpm/fry/command/cook.rb', line 100

def lint_recipe_file!
  File.exists?(recipe) || raise(Recipe::NotFound)
end

#packages ⇒ Object 



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/fpm/fry/command/cook.rb', line 288

def packages
  dir_map = []
  out_map = {}

  package_map = builder.recipe.packages.map do | package |
    output = output_class.new
    output.instance_variable_set(:@logger,logger)
    package.files.each do | pattern |
      dir_map << [ pattern, output.staging_path ]
    end
    out_map[ output ] = package
  end

  dir_map = Hash[ dir_map.reverse ]

  yield dir_map

  out_map.each do |output, package|
    package.apply_output(output)
    adjust_config_files(output)
  end

  out_map.each do |output, _|
    write_output!(output)
  end

ensure

  out_map.each do |output, _|
    output.cleanup_staging
    output.cleanup_build
  end

end

#update? ⇒ Boolean

Returns:

  • (Boolean) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/fpm/fry/command/cook.rb', line 167

def update?
  if flavour == 'debian'
    case(update)
    when 'auto'
      body = JSON.generate({"Image" => image, "Cmd" => "exit 0"})
      res = client.post( path: client.url('containers','create'),
                         headers: {'Content-Type' => 'application/json'},
                         body: body,
                         expects: [201]
                       )
      body = JSON.parse(res.body)
      container = body.fetch('Id')
      begin
        client.read( container, '/var/lib/apt/lists') do |file|
          next if file.header.name == 'lists/'
          logger.hint("/var/lib/apt/lists is not empty, you could try to speed up builds with --update=never", documentation: 'https://github.com/xing/fpm-fry/wiki/The-update-parameter')
          return true
        end
      ensure
        client.delete(path: client.url('containers',container))
      end
      return true
    when 'always'
      return true
    when 'never'
      return false
    end
  else
    return false
  end
end

#write_output!(output) ⇒ Object 



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/fpm/fry/command/cook.rb', line 262

def write_output!(output)
  package_file = File.expand_path(output.to_s(nil))
  FileUtils.mkdir_p(File.dirname(package_file))
  tmp_package_file = package_file + '.tmp'
  begin
    FileUtils.rm_rf tmp_package_file
  rescue Errno::ENOENT
  end

  output.output(tmp_package_file)

  if output.config_files.any?
    logger.debug("Found config files for #{output.name}", files: output.config_files)
  else
    logger.debug("No config files for #{output.name}")
  end

  begin
    FileUtils.rm_rf package_file
  rescue Errno::ENOENT
  end
  File.rename tmp_package_file, package_file

  logger.info("Created package", :path => package_file)
end