Class: FPM::Command

Inherits:
Clamp::Command
  • Object
show all
Includes:
Util
Defined in:
lib/fpm/command.rb

Overview

The main fpm command entry point.

Defined Under Namespace

Classes: Validator

Instance Method Summary collapse

Methods included from Util

#ar_cmd, #ar_cmd_deterministic?, #copied_entries, #copy_entry, #copy_metadata, #default_shell, #execmd, #expand_pessimistic_constraints, #logger, #mknod_w, #program_exists?, #program_in_path?, #safesystem, #safesystemout, #tar_cmd, #tar_cmd_supports_sort_names_and_set_mtime?

Constructor Details

#initialize(*args) ⇒ Command

A new FPM::Command


261
262
263
264
265
266
267
268
269
# File 'lib/fpm/command.rb', line 261

def initialize(*args)
  super(*args)
  @conflicts = []
  @replaces = []
  @provides = []
  @dependencies = []
  @config_files = []
  @directories = []
end

Instance Method Details

#executeObject

Execute this command. See Clamp::Command#execute and Clamp's documentation


272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
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
322
323
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
356
357
358
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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
# File 'lib/fpm/command.rb', line 272

def execute
  logger.level = :warn
  logger.level = :info if verbose? # --verbose
  logger.level = :debug if debug? # --debug
  if log_level
    logger.level = log_level.to_sym
  end

  if (stray_flags = args.grep(/^-/); stray_flags.any?)
    logger.warn("All flags should be before the first argument " \
                 "(stray flags found: #{stray_flags}")
  end

  # Some older behavior, if you specify:
  #   'fpm -s dir -t ... -C somepath'
  # fpm would assume you meant to add '.' to the end of the commandline.
  # Let's hack that. https://github.com/jordansissel/fpm/issues/187
  if input_type == "dir" and args.empty? and !chdir.nil?
    logger.info("No args, but -s dir and -C are given, assuming '.' as input")
    args << "."
  end

  logger.info("Setting workdir", :workdir => workdir)
  ENV["TMP"] = workdir

  validator = Validator.new(self)
  if !validator.ok?
    validator.messages.each do |message|
      logger.warn(message)
    end

    logger.fatal("Fix the above problems, and you'll be rolling packages in no time!")
    return 1
  end
  input_class = FPM::Package.types[input_type]
  output_class = FPM::Package.types[output_type]

  input = input_class.new

  # Merge in package settings.
  # The 'settings' stuff comes in from #apply_options, which goes through
  # all the options defined in known packages and puts them into our command.
  # Flags in packages defined as "--foo-bar" become named "--<packagetype>-foo-bar"
  # They are stored in 'settings' as :gem_foo_bar.
  input.attributes ||= {}

  # Iterate over all the options and set their values in the package's
  # attribute hash.
  #
  # Things like '--foo-bar' will be available as pkg.attributes[:foo_bar]
  self.class.declared_options.each do |option|
    option.attribute_name.tap do |attr|
      next if attr == "help"
      # clamp makes option attributes available as accessor methods
      # --foo-bar is available as 'foo_bar'. Put these in the package
      # attributes hash. (See FPM::Package#attributes)
      #
      # In the case of 'flag' options, the accessor is actually 'foo_bar?'
      # instead of just 'foo_bar'

      # If the instance variable @{attr} is defined, then
      # it means the flag was given on the command line.
      flag_given = instance_variable_defined?("@#{attr}")
      input.attributes["#{attr}_given?".to_sym] = flag_given
      attr = "#{attr}?" if !respond_to?(attr) # handle boolean :flag cases
      input.attributes[attr.to_sym] = send(attr) if respond_to?(attr)
      logger.debug("Setting attribute", attr.to_sym => send(attr))
    end
  end

  if input_type == "pleaserun"
    # Special case for pleaserun that all parameters are considered the 'command'
    # to run through pleaserun.
    input.input(args)
  else
    # Each remaining command line parameter is used as an 'input' argument.
    # For directories, this means paths. For things like gem and python, this
    # means package name or paths to the packages (rails, foo-1.0.gem, django,
    # bar/setup.py, etc)
    args.each do |arg|
      input.input(arg)
    end
  end

  # If --inputs was specified, read it as a file.
  if !inputs.nil?
    if !File.exists?(inputs)
      logger.fatal("File given for --inputs does not exist (#{inputs})")
      return 1
    end

    # Read each line as a path
    File.new(inputs, "r").each_line do |line|
      # Handle each line as if it were an argument
      input.input(line.strip)
    end
  end

  # If --exclude-file was specified, read it as a file and append to
  # the exclude pattern list.
  if !exclude_file.nil?
    if !File.exists?(exclude_file)
      logger.fatal("File given for --exclude-file does not exist (#{exclude_file})")
      return 1
    end

    # Ensure hash is initialized
    input.attributes[:excludes] ||= []

    # Read each line as a path
    File.new(exclude_file, "r").each_line do |line|
      # Handle each line as if it were an argument
      input.attributes[:excludes] << line.strip
    end
  end

  # Override package settings if they are not the default flag values
  # the below proc essentially does:
  #
  # if someflag != default_someflag
  #   input.someflag = someflag
  # end
  set = proc do |object, attribute|
    # if the package's attribute is currently nil *or* the flag setting for this
    # attribute is non-default, use the value.
    if object.send(attribute).nil? || send(attribute) != send("default_#{attribute}")
      logger.info("Setting from flags: #{attribute}=#{send(attribute)}")
      object.send("#{attribute}=", send(attribute))
    end
  end
  set.call(input, :architecture)
  set.call(input, :category)
  set.call(input, :description)
  set.call(input, :epoch)
  set.call(input, :iteration)
  set.call(input, :license)
  set.call(input, :maintainer)
  set.call(input, :name)
  set.call(input, :url)
  set.call(input, :vendor)
  set.call(input, :version)

  input.conflicts += conflicts
  input.dependencies += dependencies
  input.provides += provides
  input.replaces += replaces
  input.config_files += config_files
  input.directories += directories

  h = {}
  attrs.each do | e |

    s = e.split(':', 2)
    h[s.last] = s.first
  end

  input.attrs = h

  script_errors = []
  setscript = proc do |scriptname|
    # 'self.send(scriptname) == self.before_install == --before-install
    # Gets the path to the script
    path = self.send(scriptname)
    # Skip scripts not set
    next if path.nil?

    if !File.exists?(path)
      logger.error("No such file (for #{scriptname.to_s}): #{path.inspect}")
      script_errors << path
    end

    # Load the script into memory.
    input.scripts[scriptname] = File.read(path)
  end

  setscript.call(:before_install)
  setscript.call(:after_install)
  setscript.call(:before_remove)
  setscript.call(:after_remove)
  setscript.call(:before_upgrade)
  setscript.call(:after_upgrade)

  # Bail if any setscript calls had errors. We don't need to log
  # anything because we've already logged the error(s) above.
  return 1 if script_errors.any?

  # Validate the package
  if input.name.nil? or input.name.empty?
    logger.fatal("No name given for this package (set name with '-n', " \
                  "for example, '-n packagename')")
    return 1
  end

  # Convert to the output type
  output = input.convert(output_class)

  # Provide any template values as methods on the package.
  if template_scripts?
    template_value_list.each do |key, value|
      (class << output; self; end).send(:define_method, key) { value }
    end
  end

  # Write the output somewhere, package can be nil if no --package is specified,
  # and that's OK.

  # If the package output (-p flag) is a directory, write to the default file name
  # but inside that directory.
  if ! package.nil? && File.directory?(package)
    package_file = File.join(package, output.to_s)
  else
    package_file = output.to_s(package)
  end

  begin
    output.output(package_file)
  rescue FPM::Package::FileAlreadyExists => e
    logger.fatal(e.message)
    return 1
  rescue FPM::Package::ParentDirectoryMissing => e
    logger.fatal(e.message)
    return 1
  end

  logger.log("Created package", :path => package_file)
  return 0
rescue FPM::Util::ExecutableNotFound => e
  logger.error("Need executable '#{e}' to convert #{input_type} to #{output_type}")
  return 1
rescue FPM::InvalidPackageConfiguration => e
  logger.error("Invalid package configuration: #{e}")
  return 1
rescue FPM::Util::ProcessFailed => e
  logger.error("Process failed: #{e}")
  return 1
ensure
  if debug_workspace?
    # only emit them if they have files
    [input, output].each do |plugin|
      next if plugin.nil?
      [:staging_path, :build_path].each do |pathtype|
        path = plugin.send(pathtype)
        next unless Dir.open(path).to_a.size > 2
        logger.log("plugin directory", :plugin => plugin.type, :pathtype => pathtype, :path => path)
      end
    end
  else
    input.cleanup unless input.nil?
    output.cleanup unless output.nil?
  end
end

#help(*args) ⇒ Object


26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/fpm/command.rb', line 26

def help(*args)
  lines = [
    "Intro:",
    "",
    "  This is fpm version #{FPM::VERSION}",
    "",
    "  If you think something is wrong, it's probably a bug! :)",
    "  Please file these here: https://github.com/jordansissel/fpm/issues",
    "",
    "  You can find support on irc (#fpm on freenode irc) or via email with",
    "  [email protected]",
    "",
    "Loaded package types:",
  ]
  FPM::Package.types.each do |name, _|
    lines.push("  - #{name}")
  end
  lines.push("")
  lines.push(super)
  return lines.join("\n")
end

#run(run_args) ⇒ Object

def execute


524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
# File 'lib/fpm/command.rb', line 524

def run(run_args)
  logger.subscribe(STDOUT)

  # Short circuit for a `fpm --version` or `fpm -v` short invocation that 
  # is the user asking us for the version of fpm.
  if run_args == [ "-v" ] || run_args == [ "--version" ]
    puts FPM::VERSION
    return 0
  end

  # fpm initialization files, note the order of the following array is
  # important, try .fpm in users home directory first and then the current
  # directory
  rc_files = [ ".fpm" ]
  rc_files << File.join(ENV["HOME"], ".fpm") if ENV["HOME"]

  rc_args = []

  if ENV["FPMOPTS"]
    logger.warn("Loading flags from FPMOPTS environment variable")
    rc_args.push(*Shellwords.shellsplit(ENV["FPMOPTS"]))
  end

  rc_files.each do |rc_file|
    if File.readable? rc_file
      logger.warn("Loading flags from rc file #{rc_file}")
      rc_args.push(*Shellwords.shellsplit(File.read(rc_file)))
    end
  end

  flags = []
  args = []
  while rc_args.size > 0 do
    arg = rc_args.shift
    opt = self.class.find_option(arg)
    if opt and not opt.flag?
      flags.push(arg)
      flags.push(rc_args.shift)
    elsif opt or arg[0] == "-"
      flags.push(arg)
    else
      args.push(arg)
    end
  end

  logger.warn("Additional options: #{flags.join " "}") if flags.size > 0
  logger.warn("Additional arguments: #{args.join " "}") if args.size > 0

  ARGV.unshift(*flags)
  ARGV.push(*args)
  super(run_args)
rescue FPM::Package::InvalidArgument => e
  logger.error("Invalid package argument: #{e}")
  return 1
end