foreman-systemd 0.78.0

data/lib/foreman/env.rb

@@ -0,0 +1,29 @@
+require "foreman"
+
+class Foreman::Env
+
+  attr_reader :entries
+
+  def initialize(filename)
+    @entries = File.read(filename).gsub("\r\n","\n").split("\n").inject({}) do |ax, line|
+      if line =~ /\A([A-Za-z_0-9]+)=(.*)\z/
+        key = $1
+        case val = $2
+          # Remove single quotes
+          when /\A'(.*)'\z/ then ax[key] = $1
+          # Remove double quotes and unescape string preserving newline characters
+          when /\A"(.*)"\z/ then ax[key] = $1.gsub('\n', "\n").gsub(/\\(.)/, '\1')
+         else ax[key] = val
+        end
+      end
+      ax
+    end
+  end
+
+  def entries
+    @entries.each do |key, value|
+      yield key, value
+    end
+  end
+
+end

data/lib/foreman/export.rb

@@ -0,0 +1,36 @@
+require "foreman"
+require "foreman/helpers"
+require "pathname"
+
+module Foreman::Export
+  extend Foreman::Helpers
+
+  class Exception < ::Exception; end
+
+  def self.formatter(format)
+    begin
+      require "foreman/export/#{ format.tr('-', '_') }"
+      classy_format = classify(format)
+      formatter     = constantize("Foreman::Export::#{ classy_format }")
+    rescue NameError => ex
+      error "Unknown export format: #{format} (no class Foreman::Export::#{ classy_format })."
+    rescue LoadError => ex
+      error "Unknown export format: #{format} (unable to load file 'foreman/export/#{ format.tr('-', '_') }')."
+    end
+  end
+
+  def self.error(message)
+    raise Foreman::Export::Exception.new(message)
+  end
+
+end
+
+require "foreman/export/base"
+require "foreman/export/inittab"
+require "foreman/export/upstart"
+require "foreman/export/daemon"
+require "foreman/export/bluepill"
+require "foreman/export/runit"
+require "foreman/export/supervisord"
+require "foreman/export/launchd"
+require "foreman/export/systemd"

data/lib/foreman/export/base.rb

@@ -0,0 +1,156 @@
+require "foreman/export"
+require "ostruct"
+require "pathname"
+require "shellwords"
+
+class Foreman::Export::Base
+
+  attr_reader :location
+  attr_reader :engine
+  attr_reader :options
+  attr_reader :formation
+
+  # deprecated
+  attr_reader :port
+
+  def initialize(location, engine, options={})
+    @location  = location
+    @engine    = engine
+    @options   = options.dup
+    @formation = engine.formation
+
+    # deprecated
+    def port
+      Foreman::Export::Base.warn_deprecation!
+      engine.base_port
+    end
+
+    # deprecated
+    def template
+      Foreman::Export::Base.warn_deprecation!
+      options[:template]
+    end
+
+    # deprecated
+    def @engine.procfile
+      Foreman::Export::Base.warn_deprecation!
+      @processes.map do |process|
+        OpenStruct.new(
+          :name => @names[process],
+          :process => process
+        )
+      end
+    end
+  end
+
+  def export
+    error("Must specify a location") unless location
+    FileUtils.mkdir_p(location) rescue error("Could not create: #{location}")
+    chown user, log
+    chown user, run
+  end
+
+  def app
+    options[:app] || "app"
+  end
+
+  def log
+    options[:log] || "/var/log/#{app}"
+  end
+
+  def run
+    options[:run] || "/var/run/#{app}"
+  end
+
+  def user
+    options[:user] || app
+  end
+
+private ######################################################################
+
+  def self.warn_deprecation!
+    @@deprecation_warned ||= false
+    return if @@deprecation_warned
+    puts "WARNING: Using deprecated exporter interface. Please update your exporter"
+    puts "the interface shown in the upstart exporter:"
+    puts
+    puts "https://github.com/ddollar/foreman/blob/master/lib/foreman/export/upstart.rb"
+    puts "https://github.com/ddollar/foreman/blob/master/data/export/upstart/process.conf.erb"
+    puts
+    @@deprecation_warned = true
+  end
+
+  def chown user, dir
+    FileUtils.chown user, nil, dir
+  rescue
+    error("Could not chown #{dir} to #{user}") unless File.writable?(dir) || ! File.exists?(dir)
+  end
+
+  def error(message)
+    raise Foreman::Export::Exception.new(message)
+  end
+
+  def say(message)
+    puts "[foreman export] %s" % message
+  end
+  
+  def clean(filename)
+    return unless File.exists?(filename)
+    say "cleaning up: #{filename}"
+    FileUtils.rm(filename)
+  end
+
+  def shell_quote(value)
+    Shellwords.escape(value)
+  end
+
+  # deprecated
+  def old_export_template(exporter, file, template_root)
+    if template_root && File.exist?(file_path = File.join(template_root, file))
+      File.read(file_path)
+    elsif File.exist?(file_path = File.expand_path(File.join("~/.foreman/templates", file)))
+      File.read(file_path)
+    else
+      File.read(File.expand_path("../../../../data/export/#{exporter}/#{file}", __FILE__))
+    end
+  end
+
+  def export_template(name, file=nil, template_root=nil)
+    if file && template_root
+      old_export_template name, file, template_root
+    else
+      name_without_first = name.split("/")[1..-1].join("/")
+      matchers = []
+      matchers << File.join(options[:template], name_without_first) if options[:template]
+      matchers << File.expand_path("~/.foreman/templates/#{name}")
+      matchers << File.expand_path("../../../../data/export/#{name}", __FILE__)
+      File.read(matchers.detect { |m| File.exists?(m) })
+    end
+  end
+
+  def write_template(name, target, binding)
+    compiled = ERB.new(export_template(name), nil, '-').result(binding)
+    write_file target, compiled
+  end
+
+  def chmod(mode, file)
+    say "setting #{file} to mode #{mode}"
+    FileUtils.chmod mode, File.join(location, file)
+  end
+
+  def create_directory(dir)
+    say "creating: #{dir}"
+    FileUtils.mkdir_p(File.join(location, dir))
+  end
+
+  def write_file(filename, contents)
+    say "writing: #{filename}"
+
+    filename = File.join(location, filename) unless Pathname.new(filename).absolute?
+
+    File.open(filename, "w") do |file|
+      file.puts contents
+    end
+  end
+
+end

data/lib/foreman/export/bluepill.rb

@@ -0,0 +1,12 @@
+require "erb"
+require "foreman/export"
+
+class Foreman::Export::Bluepill < Foreman::Export::Base
+
+  def export
+    super
+    clean "#{location}/#{app}.pill"
+    write_template "bluepill/master.pill.erb", "#{app}.pill", binding
+  end
+
+end

data/lib/foreman/export/daemon.rb

@@ -0,0 +1,28 @@
+require "erb"
+require "foreman/export"
+
+class Foreman::Export::Daemon < Foreman::Export::Base
+
+  def export
+    super
+
+    (Dir["#{location}/#{app}-*.conf"] << "#{location}/#{app}.conf").each do |file|
+      clean file
+    end
+
+    write_template "daemon/master.conf.erb", "#{app}.conf", binding
+
+    engine.each_process do |name, process|
+      next if engine.formation[name] < 1
+      write_template "daemon/process_master.conf.erb", "#{app}-#{name}.conf", binding
+
+      1.upto(engine.formation[name]) do |num|
+        port = engine.port_for(process, num)
+        arguments = process.command.split(" ")
+        executable = arguments.slice!(0)
+        arguments = arguments.size > 0 ? " -- #{arguments.join(' ')}" : ""
+        write_template "daemon/process.conf.erb", "#{app}-#{name}-#{num}.conf", binding
+      end
+    end
+  end
+end

data/lib/foreman/export/inittab.rb

@@ -0,0 +1,42 @@
+require "foreman/export"
+
+class Foreman::Export::Inittab < Foreman::Export::Base
+
+  def export
+    error("Must specify a location") unless location
+
+    inittab = []
+    inittab << "# ----- foreman #{app} processes -----"
+
+    index = 1
+    engine.each_process do |name, process|
+      1.upto(engine.formation[name]) do |num|
+        id = app.slice(0, 2).upcase + sprintf("%02d", index)
+        port = engine.port_for(process, num)
+
+        commands = []
+        commands << "cd #{engine.root}"
+        commands << "export PORT=#{port}"
+        engine.env.each_pair do |var, env|
+          commands << "export #{var.upcase}=#{shell_quote(env)}"
+        end
+        commands << "#{process.command} >> #{log}/#{name}-#{num}.log 2>&1"
+
+        inittab << "#{id}:4:respawn:/bin/su - #{user} -c '#{commands.join(";")}'"
+        index += 1
+      end
+    end
+
+    inittab << "# ----- end foreman #{app} processes -----"
+
+    inittab = inittab.join("\n") + "\n"
+
+    if location == "-"
+      puts inittab
+    else
+      say "writing: #{location}"
+      File.open(location, "w") { |file| file.puts inittab }
+    end
+  end
+
+end

data/lib/foreman/export/launchd.rb

@@ -0,0 +1,22 @@
+require "erb"
+require "foreman/export"
+
+class Foreman::Export::Launchd < Foreman::Export::Base
+
+  def export
+    super
+    engine.each_process do |name, process|
+      1.upto(engine.formation[name]) do |num|
+        port = engine.port_for(process, num)
+        command_args = process.command.split(/\s+/).map{|arg|
+          case arg
+          when "$PORT" then port
+          else arg
+          end
+        }
+        write_template "launchd/launchd.plist.erb", "#{app}-#{name}-#{num}.plist", binding
+      end
+    end
+  end
+
+end

data/lib/foreman/export/runit.rb

@@ -0,0 +1,34 @@
+require "erb"
+require "foreman/export"
+
+class Foreman::Export::Runit < Foreman::Export::Base
+
+  ENV_VARIABLE_REGEX = /([a-zA-Z_]+[a-zA-Z0-9_]*)=(\S+)/
+
+  def export
+    super
+
+    engine.each_process do |name, process|
+      1.upto(engine.formation[name]) do |num|
+        process_directory = "#{app}-#{name}-#{num}"
+
+        create_directory process_directory
+        create_directory "#{process_directory}/env"
+        create_directory "#{process_directory}/log"
+
+        write_template "runit/run.erb", "#{process_directory}/run", binding
+        chmod 0755, "#{process_directory}/run"
+
+        port = engine.port_for(process, num)
+        engine.env.merge("PORT" => port.to_s).each do |key, value|
+          write_file "#{process_directory}/env/#{key}", value
+        end
+
+        write_template "runit/log/run.erb", "#{process_directory}/log/run", binding
+        chmod 0755, "#{process_directory}/log/run"
+      end
+    end
+
+  end
+
+end

data/lib/foreman/export/supervisord.rb

@@ -0,0 +1,16 @@
+require "erb"
+require "foreman/export"
+
+class Foreman::Export::Supervisord < Foreman::Export::Base
+
+  def export
+    super
+
+    Dir["#{location}/#{app}*.conf"].each do |file|
+      clean file
+    end
+
+    write_template "supervisord/app.conf.erb", "#{app}.conf", binding
+  end
+
+end

data/lib/foreman/export/systemd.rb

@@ -0,0 +1,32 @@
+require "erb"
+require "foreman/export"
+
+class Foreman::Export::Systemd < Foreman::Export::Base
+
+  def export
+    super
+
+    Dir["#{location}/#{app}*.target"].concat(Dir["#{location}/#{app}*.service"]).each do |file|
+      clean file
+    end
+
+    process_master_names = []
+
+    engine.each_process do |name, process|
+      next if engine.formation[name] < 1
+
+      process_names = []
+
+      1.upto(engine.formation[name]) do |num|
+        port = engine.port_for(process, num)
+        write_template "systemd/process.service.erb", "#{app}-#{name}-#{num}.service", binding
+        process_names << "#{app}-#{name}-#{num}.service"
+      end
+
+      write_template "systemd/process_master.target.erb", "#{app}-#{name}.target", binding
+      process_master_names << "#{app}-#{name}.target"
+    end
+
+    write_template "systemd/master.target.erb", "#{app}.target", binding
+  end
+end

data/lib/foreman/export/upstart.rb

@@ -0,0 +1,43 @@
+require "erb"
+require "foreman/export"
+
+class Foreman::Export::Upstart < Foreman::Export::Base
+
+  def export
+    super
+
+    master_file = "#{app}.conf"
+
+    clean File.join(location, master_file)
+    write_template master_template, master_file, binding
+
+    engine.each_process do |name, process|
+      process_master_file = "#{app}-#{name}.conf"
+      clean File.join(location, process_master_file)
+
+      next if engine.formation[name] < 1
+      write_template process_master_template, process_master_file, binding
+
+      1.upto(engine.formation[name]) do |num|
+        port = engine.port_for(process, num)
+        process_file = "#{app}-#{name}-#{num}.conf"
+        clean File.join(location, process_file)
+        write_template process_template, process_file, binding
+      end
+    end
+  end
+
+  private
+
+  def master_template
+    "upstart/master.conf.erb"
+  end
+
+  def process_master_template
+    "upstart/process_master.conf.erb"
+  end
+
+  def process_template
+    "upstart/process.conf.erb"
+  end
+end