From 9193a675a3e53739f412d4e493ab74594d1e826c Mon Sep 17 00:00:00 2001 From: David Dollar Date: Fri, 13 May 2011 12:01:26 -0400 Subject: [PATCH] add support for process environments --- .env | 1 + data/example/ticker | 2 +- lib/foreman/cli.rb | 1 + lib/foreman/engine.rb | 37 ++++++++++++++++++++++++++++++++----- man/foreman.1 | 6 +++++- man/foreman.1.ronn | 5 +++++ spec/foreman/engine_spec.rb | 37 +++++++++++++++++++++++++++++++------ 7 files changed, 76 insertions(+), 13 deletions(-) create mode 100644 .env diff --git a/.env b/.env new file mode 100644 index 0000000..c075a74 --- /dev/null +++ b/.env @@ -0,0 +1 @@ +FOO=bar diff --git a/data/example/ticker b/data/example/ticker index 67b6564..e64c516 100755 --- a/data/example/ticker +++ b/data/example/ticker @@ -1,6 +1,6 @@ #!/usr/bin/env ruby while true - puts "tick: #{ARGV.inspect}" + puts "tick: #{ARGV.inspect} -- FOO:#{ENV["FOO"]}" sleep 1 end diff --git a/lib/foreman/cli.rb b/lib/foreman/cli.rb index 7ea78de..6d20a9a 100644 --- a/lib/foreman/cli.rb +++ b/lib/foreman/cli.rb @@ -6,6 +6,7 @@ require "yaml" class Foreman::CLI < Thor + class_option :env, :type => :string, :aliases => "-e" class_option :procfile, :type => :string, :aliases => "-f", :desc => "Default: Procfile" desc "start [PROCESS]", "Start the application, or a specific process" diff --git a/lib/foreman/engine.rb b/lib/foreman/engine.rb index 110f2f9..d2f8cbd 100644 --- a/lib/foreman/engine.rb +++ b/lib/foreman/engine.rb @@ -50,10 +50,12 @@ class Foreman::Engine end def start(options={}) + environment = read_environment(options[:env]) + proctitle "ruby: foreman master" processes_in_order.each do |name, process| - fork process, options + fork process, options, environment end trap("TERM") { puts "SIGTERM received"; kill_all("TERM") } @@ -63,7 +65,9 @@ class Foreman::Engine end def execute(name, options={}) - fork processes[name], options + environment = read_environment(options[:env]) + + fork processes[name], options, environment trap("TERM") { puts "SIGTERM received"; kill_all("TERM") } trap("INT") { puts "SIGINT received"; kill_all("TERM") } @@ -79,15 +83,17 @@ class Foreman::Engine private ###################################################################### - def fork(process, options={}) + def fork(process, options={}, environment={}) concurrency = Foreman::Utils.parse_concurrency(options[:concurrency]) 1.upto(concurrency[process.name]) do |num| - fork_individual(process, num, port_for(process, num, options[:port])) + fork_individual(process, num, port_for(process, num, options[:port]), environment) end end - def fork_individual(process, num, port) + def fork_individual(process, num, port, environment) + environment.each { |k,v| ENV[k] = v } + ENV["PORT"] = port.to_s ENV["PS"] = "#{process.name}.#{num}" @@ -136,6 +142,11 @@ private ###################################################################### puts end + def error(message) + puts "ERROR: #{message}" + exit 1 + end + def longest_process_name @longest_process_name ||= begin longest = processes.keys.map { |name| name.length }.sort.last @@ -190,4 +201,20 @@ private ###################################################################### puts "!!! e.g. web: thin start" end + def read_environment(filename) + error "No such file: #{filename}" if filename && !File.exists?(filename) + filename ||= ".env" + environment = {} + + if File.exists?(filename) + File.read(filename).split("\n").each do |line| + if line =~ /\A([A-Za-z_]+)=(.*)\z/ + environment[$1] = $2 + end + end + end + + environment + end + end diff --git a/man/foreman.1 b/man/foreman.1 index 3f0476a..beb5423 100644 --- a/man/foreman.1 +++ b/man/foreman.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "FOREMAN" "1" "May 2011" "Foreman 0.13.0" "Foreman Manual" +.TH "FOREMAN" "1" "May 2011" "Foreman 0.15.0" "Foreman Manual" . .SH "NAME" \fBforeman\fR \- manage Procfile\-based applications @@ -68,6 +68,10 @@ Specify the user the application should be run as\. Defaults to the app name These options control all modes of foreman\'s operation\. . .TP +\fB\-e\fR, \fB\-\-env\fR +Specify a file containing the environment that should be set up for each child process\. The file should be key/value pairs separated by \fB=\fR, with one key/value pair per line\. +. +.TP \fB\-f\fR, \fB\-\-procfile\fR Specify an alternate location for the application\'s Procfile\. This file\'s containing directory will be assumed to be the root directory of the application\. . diff --git a/man/foreman.1.ronn b/man/foreman.1.ronn index 0224e67..b26198e 100644 --- a/man/foreman.1.ronn +++ b/man/foreman.1.ronn @@ -66,6 +66,11 @@ The following options control how the application is run: These options control all modes of foreman's operation. + * `-e`, `--env`: + Specify a file containing the environment that should be set up for each + child process. The file should be key/value pairs separated by `=`, with + one key/value pair per line. + * `-f`, `--procfile`: Specify an alternate location for the application's Procfile. This file's containing directory will be assumed to be the root directory of the diff --git a/spec/foreman/engine_spec.rb b/spec/foreman/engine_spec.rb index f59c701..7e76f59 100644 --- a/spec/foreman/engine_spec.rb +++ b/spec/foreman/engine_spec.rb @@ -37,17 +37,17 @@ describe "Foreman::Engine" do describe "start" do it "forks the processes" do write_procfile - mock(subject).fork(subject.processes["alpha"], {}) - mock(subject).fork(subject.processes["bravo"], {}) + mock(subject).fork(subject.processes["alpha"], {}, {}) + mock(subject).fork(subject.processes["bravo"], {}, {}) mock(subject).watch_for_termination subject.start end it "handles concurrency" do write_procfile - mock(subject).fork_individual(subject.processes["alpha"], 1, 5000) - mock(subject).fork_individual(subject.processes["alpha"], 2, 5001) - mock(subject).fork_individual(subject.processes["bravo"], 1, 5100) + mock(subject).fork_individual(subject.processes["alpha"], 1, 5000, {}) + mock(subject).fork_individual(subject.processes["alpha"], 2, 5001, {}) + mock(subject).fork_individual(subject.processes["bravo"], 1, 5100, {}) mock(subject).watch_for_termination subject.start(:concurrency => "alpha=2") end @@ -56,9 +56,34 @@ describe "Foreman::Engine" do describe "execute" do it "runs the processes" do write_procfile - mock(subject).fork(subject.processes["alpha"], {}) + mock(subject).fork(subject.processes["alpha"], {}, {}) mock(subject).watch_for_termination subject.execute("alpha") end end + + describe "environment" do + before(:each) do + write_procfile + stub(Process).fork + stub(subject).info + mock(subject).watch_for_termination + end + + it "should read if specified" do + File.open("/tmp/env", "w") { |f| f.puts("FOO=baz") } + subject.execute("alpha", :env => "/tmp/env") + end + + it "should fail if specified and doesnt exist" do + mock(subject).error("No such file: /tmp/env") + subject.execute("alpha", :env => "/tmp/env") + end + + it "should read .env if none specified" do + File.open(".env", "w") { |f| f.puts("FOO=qoo") } + mock(subject).fork_individual(anything, anything, anything, { "FOO" => "qoo" }) + subject.execute("bravo") + end + end end