require "rubygems" require "fpm/namespace" require "fpm/version" require "fpm/util" require "clamp" require "ostruct" require "fpm" require "tmpdir" # for Dir.tmpdir if $DEBUG Cabin::Channel.get(Kernel).subscribe($stdout) Cabin::Channel.get(Kernel).level = :debug end Dir[File.join(File.dirname(__FILE__), "package", "*.rb")].each do |plugin| Cabin::Channel.get(Kernel).info("Loading plugin", :path => plugin) require "fpm/package/#{File.basename(plugin)}" end # The main fpm command entry point. class FPM::Command < Clamp::Command include FPM::Util 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", " fpm-users@googlegroups.com", "", "Loaded package types:", ] FPM::Package.types.each do |name, _| lines.push(" - #{name}") end lines.push("") lines.push(super) return lines.join("\n") end # def help option ["-t", "--output-type"], "OUTPUT_TYPE", "the type of package you want to create (deb, rpm, solaris, etc)", :attribute_name => :output_type option ["-s", "--input-type"], "INPUT_TYPE", "the package type to use as input (gem, rpm, python, etc)", :attribute_name => :input_type option ["-C", "--chdir"], "CHDIR", "Change directory to here before searching for files", :attribute_name => :chdir option "--prefix", "PREFIX", "A path to prefix files with when building the target package. This may " \ "not be necessary for all input packages. For example, the 'gem' type " \ "will prefix with your gem directory automatically." option ["-p", "--package"], "OUTPUT", "The package file path to output." option ["-f", "--force"], :flag, "Force output even if it will overwrite an " \ "existing file", :default => false option ["-n", "--name"], "NAME", "The name to give to the package" loglevels = %w(error warn info debug) option "--log", "LEVEL", "Set the log level. Values: #{loglevels.join(", ")}.", :attribute_name => :log_level do |val| val.downcase.tap do |v| if !loglevels.include?(v) raise FPM::Package::InvalidArgument, "Invalid log level, #{v.inspect}. Must be one of: #{loglevels.join(", ")}" end end end # --log option "--verbose", :flag, "Enable verbose output" option "--debug", :flag, "Enable debug output" option "--debug-workspace", :flag, "Keep any file workspaces around for " \ "debugging. This will disable automatic cleanup of package staging and " \ "build paths. It will also print which directories are available." option ["-v", "--version"], "VERSION", "The version to give to the package", :default => 1.0 option "--iteration", "ITERATION", "The iteration to give to the package. RPM calls this the 'release'. " \ "FreeBSD calls it 'PORTREVISION'. Debian calls this 'debian_revision'" option "--epoch", "EPOCH", "The epoch value for this package. RPM and Debian calls this 'epoch'. " \ "FreeBSD calls this 'PORTEPOCH'" option "--license", "LICENSE", "(optional) license name for this package" option "--vendor", "VENDOR", "(optional) vendor name for this package" option "--category", "CATEGORY", "(optional) category this package belongs to", :default => "none" option ["-d", "--depends"], "DEPENDENCY", "A dependency. This flag can be specified multiple times. Value is " \ "usually in the form of: -d 'name' or -d 'name > version'", :multivalued => true, :attribute_name => :dependencies option "--no-depends", :flag, "Do not list any dependencies in this package", :default => false option "--no-auto-depends", :flag, "Do not list any dependencies in this " \ "package automatically", :default => false option "--provides", "PROVIDES", "What this package provides (usually a name). This flag can be " \ "specified multiple times.", :multivalued => true, :attribute_name => :provides option "--conflicts", "CONFLICTS", "Other packages/versions this package conflicts with. This flag can be " \ "specified multiple times.", :multivalued => true, :attribute_name => :conflicts option "--replaces", "REPLACES", "Other packages/versions this package replaces. Equivalent of rpm's 'Obsoletes'. " \ "This flag can be specified multiple times.", :multivalued => true, :attribute_name => :replaces option "--config-files", "CONFIG_FILES", "Mark a file in the package as being a config file. This uses 'conffiles'" \ " in debs and %config in rpm. If you have multiple files to mark as " \ "configuration files, specify this flag multiple times. If argument is " \ "directory all files inside it will be recursively marked as config files.", :multivalued => true, :attribute_name => :config_files option "--directories", "DIRECTORIES", "Recursively mark a directory as being owned " \ "by the package. Use this flag multiple times if you have multiple directories " \ "and they are not under the same parent directory ", :multivalued => true, :attribute_name => :directories option ["-a", "--architecture"], "ARCHITECTURE", "The architecture name. Usually matches 'uname -m'. For automatic values," \ " you can use '-a all' or '-a native'. These two strings will be " \ "translated into the correct value for your platform and target package type." option ["-m", "--maintainer"], "MAINTAINER", "The maintainer of this package.", :default => "<#{ENV["USER"]}@#{Socket.gethostname}>" option ["-S", "--package-name-suffix"], "PACKAGE_NAME_SUFFIX", "a name suffix to append to package and dependencies." option ["-e", "--edit"], :flag, "Edit the package spec before building.", :default => false excludes = [] option ["-x", "--exclude"], "EXCLUDE_PATTERN", "Exclude paths matching pattern (shell wildcard globs valid here). " \ "If you have multiple file patterns to exclude, specify this flag " \ "multiple times.", :attribute_name => :excludes do |val| excludes << val next excludes end # -x / --exclude option "--exclude-file", "EXCLUDE_PATH", "The path to a file containing a newline-sparated list of "\ "patterns to exclude from input." option "--description", "DESCRIPTION", "Add a description for this package." \ " You can include '\\n' sequences to indicate newline breaks.", :default => "no description" option "--url", "URI", "Add a url for this package.", :default => "http://example.com/no-uri-given" option "--inputs", "INPUTS_PATH", "The path to a file containing a newline-separated list of " \ "files and dirs to use as input." option "--post-install", "FILE", "(DEPRECATED, use --after-install) A script to be run after " \ "package installation" do |val| @after_install = File.expand_path(val) # Get the full path to the script end # --post-install (DEPRECATED) option "--pre-install", "FILE", "(DEPRECATED, use --before-install) A script to be run before " \ "package installation" do |val| @before_install = File.expand_path(val) # Get the full path to the script end # --pre-install (DEPRECATED) option "--post-uninstall", "FILE", "(DEPRECATED, use --after-remove) A script to be run after " \ "package removal" do |val| @after_remove = File.expand_path(val) # Get the full path to the script end # --post-uninstall (DEPRECATED) option "--pre-uninstall", "FILE", "(DEPRECATED, use --before-remove) A script to be run before " \ "package removal" do |val| @before_remove = File.expand_path(val) # Get the full path to the script end # --pre-uninstall (DEPRECATED) option "--after-install", "FILE", "A script to be run after package installation" do |val| File.expand_path(val) # Get the full path to the script end # --after-install option "--before-install", "FILE", "A script to be run before package installation" do |val| File.expand_path(val) # Get the full path to the script end # --before-install option "--after-remove", "FILE", "A script to be run after package removal" do |val| File.expand_path(val) # Get the full path to the script end # --after-remove option "--before-remove", "FILE", "A script to be run before package removal" do |val| File.expand_path(val) # Get the full path to the script end # --before-remove option "--after-upgrade", "FILE", "A script to be run after package upgrade. If not specified,\n" \ "--before-install, --after-install, --before-remove, and \n" \ "--after-remove will behave in a backwards-compatible manner\n" \ "(they will not be upgrade-case aware).\n" \ "Currently only supports deb, rpm and pacman packages." do |val| File.expand_path(val) # Get the full path to the script end # --after-upgrade option "--before-upgrade", "FILE", "A script to be run before package upgrade. If not specified,\n" \ "--before-install, --after-install, --before-remove, and \n" \ "--after-remove will behave in a backwards-compatible manner\n" \ "(they will not be upgrade-case aware).\n" \ "Currently only supports deb, rpm and pacman packages." do |val| File.expand_path(val) # Get the full path to the script end # --before-upgrade option "--template-scripts", :flag, "Allow scripts to be templated. This lets you use ERB to template your " \ "packaging scripts (for --after-install, etc). For example, you can do " \ "things like <%= name %> to get the package name. For more information, " \ "see the fpm wiki: " \ "https://github.com/jordansissel/fpm/wiki/Script-Templates" option "--template-value", "KEY=VALUE", "Make 'key' available in script templates, so <%= key %> given will be " \ "the provided value. Implies --template-scripts", :multivalued => true do |kv| @template_scripts = true next kv.split("=", 2) end option "--workdir", "WORKDIR", "The directory you want fpm to do its work in, where 'work' is any file " \ "copying, downloading, etc. Roughly any scratch space fpm needs to build " \ "your package.", :default => Dir.tmpdir option "--source-date-epoch-from-changelog", :flag, "Use release date from changelog as timestamp on generated files to reduce nondeterminism. " \ "Experimental; only implemented for gem so far. ", :default => false option "--source-date-epoch-default", "SOURCE_DATE_EPOCH_DEFAULT", "If no release date otherwise specified, use this value as timestamp on generated files to reduce nondeterminism. " \ "Reproducible build environments such as dpkg-dev and rpmbuild set this via envionment variable SOURCE_DATE_EPOCH " \ "variable to the integer unix timestamp to use in generated archives, " \ "and expect tools like fpm to use it as a hint to avoid nondeterministic output. " \ "This is a Unix timestamp, i.e. number of seconds since 1 Jan 1970 UTC. " \ "See https://reproducible-builds.org/specs/source-date-epoch ", :environment_variable => "SOURCE_DATE_EPOCH" option "--fpm-options-file", "FPM_OPTIONS_FILE", "A file that contains additional fpm options. Any fpm flag format is valid in this file. " \ "This can be useful on build servers where you want to use a common configuration or " \ "inject other parameters from a file instead of from a command-line flag.." do |path| load_options(path) end parameter "[ARGS] ...", "Inputs to the source package type. For the 'dir' type, this is the files" \ " and directories you want to include in the package. For others, like " \ "'gem', it specifies the packages to download and use as the gem input", :attribute_name => :args FPM::Package.types.each do |name, klass| klass.apply_options(self) end # A new FPM::Command def initialize(*args) super(*args) @conflicts = [] @replaces = [] @provides = [] @dependencies = [] @config_files = [] @directories = [] end # def initialize # Execute this command. See Clamp::Command#execute and Clamp's documentation 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 if !File.exist?(workdir) logger.fatal("Given --workdir=#{workdir} is not a path that exists.") raise FPM::Package::InvalidArgument, "The given workdir '#{workdir}' does not exist." end if !File.directory?(workdir) logger.fatal("Given --workdir=#{workdir} must be a directory") raise FPM::Package::InvalidArgument, "The given workdir '#{workdir}' must be a directory." 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 "---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.exist?(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.exist?(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.exist?(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 # def execute 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 # def run def load_options(path) @loaded_files ||= [] if @loaded_files.include?(path) #logger.error("Options file was already loaded once. Refusing to load a second time.", :path => path) raise FPM::Package::InvalidArgument, "Options file already loaded once. Refusing to load a second time. Maybe a file tries to load itself? Path: #{path}" end if !File.exist?(path) logger.fatal("Cannot load options from file because the file doesn't exist.", :path => path) end if !File.readable?(path) logger.fatal("Cannot load options from file because the file isn't readable.", :path => path) end @loaded_files << path logger.info("Loading flags from file", :path => path) # Safety check, abort if the file is huge. Arbitrarily chosen limit is 100kb stat = File.stat(path) max = 100 * 1024 if stat.size > max logger.fatal("Refusing to load options from file because the file seems pretty large.", :path => path, :size => stat.size) raise FPM::Package::InvalidArgument, "Options file given to --fpm-options-file is seems too large. For safety, fpm is refusing to load this. Path: #{path} - Size: #{stat.size}, maximum allowed size #{max}." end File.read(path).split($/).each do |line| logger.info("Processing flags from file", :path => path, :line => line) # With apologies for this hack to mdub (Mike Williams, author of Clamp)... # The following code will read a file and parse the file # as flags as if they were in same argument position as the given --fpm-options-file option. args = Shellwords.split(line) while args.any? arg = args.shift # Lookup the Clamp option by its --flag-name or short name like -f if arg =~ /^-/ # Single-letter options like -a or -z if single_letter = arg.match(/^(-[A-Za-z0-9])(.*)$/) option = self.class.find_option(single_letter.match(1)) arg, remainder = single_letter.match(1), single_letter.match(2) if option.flag? # Flags aka switches take no arguments, so we push the rest of the 'arg' entry back onto the args list # For combined letter flags, like `-abc`, we want to consume the # `-a` and then push `-bc` back to be processed. # Only do this if there's more flags, like, not for `-a` but yes for `-abc` args.unshift("-" + remainder) unless remainder.empty? else # Single letter options that take arguments, like `-ohello` same as `-o hello` # For single letter flags with values, like `-ofilename` aka `-o filename`, push the remainder ("filename") # back onto the args list so that it is consumed when we extract the flag value. args.unshift(remainder) unless remainder.empty? end elsif arg.match(/^--/) # Lookup the flag by its long --flag-name option = self.class.find_option(arg) end end # Extract the flag value, if any, from the remaining args list. value = option.extract_value(arg, args) # Process the flag into `self` option.of(self).take(value) end end end # A simple flag validator # # The goal of this class is to ensure the flags and arguments given # are a valid configuration. class Validator include FPM::Util private def initialize(command) @command = command @valid = true @messages = [] validate end # def initialize def ok? return @valid end # def ok? def validate # Make sure the user has passed '-s' and '-t' flags mandatory(@command.input_type, "Missing required -s flag. What package source did you want?") mandatory(@command.output_type, "Missing required -t flag. What package output did you want?") # Verify the types requested are valid types = FPM::Package.types.keys.sort @command.input_type.tap do |val| next if val.nil? mandatory(FPM::Package.types.include?(val), "Invalid input package -s flag) type #{val.inspect}. " \ "Expected one of: #{types.join(", ")}") end @command.output_type.tap do |val| next if val.nil? mandatory(FPM::Package.types.include?(val), "Invalid output package (-t flag) type #{val.inspect}. " \ "Expected one of: #{types.join(", ")}") end @command.dependencies.tap do |dependencies| # Verify dependencies don't include commas (#257) dependencies.each do |dep| next unless dep.include?(",") splitdeps = dep.split(/\s*,\s*/) @messages << "Dependencies should not " \ "include commas. If you want to specify multiple dependencies, use " \ "the '-d' flag multiple times. Example: " + \ splitdeps.map { |d| "-d '#{d}'" }.join(" ") end end if @command.inputs mandatory(@command.input_type == "dir", "--inputs is only valid with -s dir") end mandatory(@command.args.any? || @command.inputs || @command.input_type == 'empty', "No parameters given. You need to pass additional command " \ "arguments so that I know what you want to build packages " \ "from. For example, for '-s dir' you would pass a list of " \ "files and directories. For '-s gem' you would pass a one" \ " or more gems to package from. As a full example, this " \ "will make an rpm of the 'json' rubygem: " \ "`fpm -s gem -t rpm json`") end # def validate def mandatory(value, message) if value.nil? or !value @messages << message @valid = false end end # def mandatory def messages return @messages end # def messages public(:initialize, :ok?, :messages) end # class Validator end # class FPM::Program