Compare commits

..
2 Commits
Author SHA1 Message Date
David Dollar d0f5b2412c 0.7.4 2010-09-17 09:30:20 -04:00
David Dollar 15ab54bc18 include files from export in the gem 2010-09-17 09:30:09 -04:00
36 changed files with 100 additions and 587 deletions
-1
View File
@@ -1 +0,0 @@
FOO=bar
+1 -2
View File
@@ -1,8 +1,7 @@
.bundle .bundle
coverage coverage
example/log/* example/log/*
man/*.?
man/*.html man/*.html
man/*.markdown man/*.markdown
pkg pkg
tags
+14 -1
View File
@@ -1,3 +1,16 @@
source "http://rubygems.org" source "http://rubygems.org"
gemspec group :development do
gem 'parka'
gem 'rake'
end
group :test do
gem 'fakefs', '~> 0.2.1'
gem 'rcov', '~> 0.9.8'
gem 'rr', '~> 0.10.11'
gem 'rspec', '~> 2.0.0.beta.19'
end
gem 'term-ansicolor', '~> 1.0.5'
gem 'thor', '~> 0.13.6'
+15 -33
View File
@@ -1,55 +1,37 @@
PATH
remote: .
specs:
foreman (0.16.0)
term-ansicolor (~> 1.0.5)
thor (>= 0.13.6)
GEM GEM
remote: http://rubygems.org/ remote: http://rubygems.org/
specs: specs:
crack (0.1.8)
diff-lcs (1.1.2) diff-lcs (1.1.2)
fakefs (0.2.1) fakefs (0.2.1)
hpricot (0.8.2)
mime-types (1.16) mime-types (1.16)
mustache (0.11.2) parka (0.3.1)
parka (0.6.2)
crack
rest-client rest-client
thor thor
rake (0.8.7) rake (0.8.7)
rcov (0.9.8) rcov (0.9.8)
rdiscount (1.6.5) rest-client (1.6.0)
rest-client (1.6.1)
mime-types (>= 1.16) mime-types (>= 1.16)
ronn (0.7.3) rr (0.10.11)
hpricot (>= 0.8.2) rspec (2.0.0.beta.19)
mustache (>= 0.7.0) rspec-core (= 2.0.0.beta.19)
rdiscount (>= 1.5.8) rspec-expectations (= 2.0.0.beta.19)
rr (1.0.2) rspec-mocks (= 2.0.0.beta.19)
rspec (2.0.1) rspec-core (2.0.0.beta.19)
rspec-core (~> 2.0.1) rspec-expectations (2.0.0.beta.19)
rspec-expectations (~> 2.0.1)
rspec-mocks (~> 2.0.1)
rspec-core (2.0.1)
rspec-expectations (2.0.1)
diff-lcs (>= 1.1.2) diff-lcs (>= 1.1.2)
rspec-mocks (2.0.1) rspec-mocks (2.0.0.beta.19)
rspec-core (~> 2.0.1)
rspec-expectations (~> 2.0.1)
term-ansicolor (1.0.5) term-ansicolor (1.0.5)
thor (0.14.6) thor (0.13.8)
PLATFORMS PLATFORMS
ruby ruby
DEPENDENCIES DEPENDENCIES
fakefs (~> 0.2.1) fakefs (~> 0.2.1)
foreman!
parka parka
rake rake
rcov (~> 0.9.8) rcov (~> 0.9.8)
ronn rr (~> 0.10.11)
rr (~> 1.0.2) rspec (~> 2.0.0.beta.19)
rspec (~> 2.0.0) term-ansicolor (~> 1.0.5)
thor (~> 0.13.6)
+2 -27
View File
@@ -1,29 +1,4 @@
# Foreman Foreman
=======
## Installation
gem install foreman
## Description
http://blog.daviddollar.org/2011/05/06/introducing-foreman.html
## Manual
See the [man page](http://ddollar.github.com/foreman) for usage. See the [man page](http://ddollar.github.com/foreman) for usage.
## Author
David Dollar
## Contributors
Adam Wiggins
clifff
Dan Peterson
Keith Rarick
Ricardo Chimal, Jr
## License
MIT
+3 -8
View File
@@ -25,7 +25,7 @@ end
Rspec::Core::RakeTask.new("rcov:build") do |t| Rspec::Core::RakeTask.new("rcov:build") do |t|
t.pattern = 'spec/**/*_spec.rb' t.pattern = 'spec/**/*_spec.rb'
t.rcov = true t.rcov = true
t.rcov_opts = [ "--exclude", ".bundle", "--exclude", "spec" ] t.rcov_opts = [ "--exclude", Gem.default_dir , "--exclude", "spec" ]
end end
desc 'Build the manual' desc 'Build the manual'
@@ -33,23 +33,18 @@ task :man do
ENV['RONN_MANUAL'] = "Foreman Manual" ENV['RONN_MANUAL'] = "Foreman Manual"
ENV['RONN_ORGANIZATION'] = "Foreman #{Foreman::VERSION}" ENV['RONN_ORGANIZATION'] = "Foreman #{Foreman::VERSION}"
sh "ronn -w -s toc -r5 --markdown man/*.ronn" sh "ronn -w -s toc -r5 --markdown man/*.ronn"
end
desc "Commit the manual to git"
task "man:commit" => :man do
sh "git add README.markdown" sh "git add README.markdown"
sh "git commit -m 'update readme' || echo 'nothing to commit'" sh "git commit -m 'update readme' || echo 'nothing to commit'"
end end
desc "Generate the Github docs" task :pages => :man do
task :pages => "man:commit" do
sh %{ sh %{
cp man/foreman.1.html /tmp/foreman.1.html cp man/foreman.1.html /tmp/foreman.1.html
git checkout gh-pages git checkout gh-pages
rm ./index.html rm ./index.html
cp /tmp/foreman.1.html ./index.html cp /tmp/foreman.1.html ./index.html
git add -u index.html git add -u index.html
git commit -m "saving man page to github docs" git commit -m "rebuilding man page"
git push origin -f gh-pages git push origin -f gh-pages
git checkout master git checkout master
} }
-2
View File
@@ -1,2 +0,0 @@
ticker: ./ticker $PORT
error : ./error
-4
View File
@@ -1,4 +0,0 @@
tick
tick
./never_die:6:in `sleep': Interrupt
from ./never_die:6
-6
View File
@@ -1,6 +0,0 @@
#!/usr/bin/env ruby
while true
puts "tick: #{ARGV.inspect} -- FOO:#{ENV["FOO"]}"
sleep 1
end
Executable
+6
View File
@@ -0,0 +1,6 @@
#!/usr/bin/env ruby
while true
puts "tick: #{ARGV.inspect}"
sleep 1
end
@@ -3,4 +3,4 @@ stop on stopping <%= app %>-<%= process.name %>
respawn respawn
chdir <%= engine.directory %> chdir <%= engine.directory %>
exec su <%= user %> -c 'export PORT=<%= port %>; <%= process.command %> >> <%= log_root %>/<%=process.name%>-<%=num%>.log 2>&1' exec su <%= user %> -c "PORT=<%= port %> <%= process.command %> >> <%= log_root %>/<%=process.name%>-<%=num%>.log 2>&1"
+7 -23
View File
@@ -1,29 +1,13 @@
$:.unshift File.expand_path("../lib", __FILE__) require "rubygems"
require "foreman/version" require "parka/specification"
Gem::Specification.new do |gem| Parka::Specification.new do |gem|
gem.name = "foreman" gem.name = "foreman"
gem.version = Foreman::VERSION gem.version = Foreman::VERSION
gem.author = "David Dollar"
gem.email = "ddollar@gmail.com"
gem.homepage = "http://github.com/ddollar/foreman"
gem.summary = "Process manager for applications with multiple components" gem.summary = "Process manager for applications with multiple components"
gem.homepage = "http://github.com/ddollar/foreman"
gem.description = gem.summary gem.executables = "foreman"
gem.files << "man/foreman.1"
gem.executables = "foreman" gem.files << Dir["export/**/*"]
gem.files = Dir["**/*"].select { |d| d =~ %r{^(README|bin/|data/|ext/|lib/|spec/|test/)} }
gem.files << "man/foreman.1"
gem.add_dependency 'term-ansicolor', '~> 1.0.5'
gem.add_dependency 'thor', '>= 0.13.6'
gem.add_development_dependency 'parka'
gem.add_development_dependency 'rake'
gem.add_development_dependency 'ronn'
gem.add_development_dependency 'fakefs', '~> 0.2.1'
gem.add_development_dependency 'rcov', '~> 0.9.8'
gem.add_development_dependency 'rr', '~> 1.0.2'
gem.add_development_dependency 'rspec', '~> 2.0.0'
end end
+2 -2
View File
@@ -1,7 +1,7 @@
require "foreman/version"
module Foreman module Foreman
VERSION = "0.7.4"
class AppDoesNotExist < Exception; end class AppDoesNotExist < Exception; end
end end
+7 -25
View File
@@ -2,17 +2,16 @@ require "foreman"
require "foreman/engine" require "foreman/engine"
require "foreman/export" require "foreman/export"
require "thor" require "thor"
require "yaml"
class Foreman::CLI < Thor class Foreman::CLI < Thor
class_option :procfile, :type => :string, :aliases => "-f", :desc => "Default: Procfile" class_option :procfile, :type => :string, :aliases => "-f", :desc => "Default: ./Procfile"
desc "start [PROCESS]", "Start the application, or a specific process" desc "start [PROCESS]", "Start the application, or a specific process"
method_option :env, :type => :string, :aliases => "-e", :desc => "Specify an environment file to load, defaults to .env"
method_option :port, :type => :numeric, :aliases => "-p" method_option :port, :type => :numeric, :aliases => "-p"
method_option :concurrency, :type => :string, :aliases => "-c", :banner => '"alpha=5,bar=3"' method_option :concurrency, :type => :string, :aliases => "-c",
:banner => '"alpha=5,bar=3"'
def start(process=nil) def start(process=nil)
check_procfile! check_procfile!
@@ -37,8 +36,8 @@ class Foreman::CLI < Thor
check_procfile! check_procfile!
formatter = case format formatter = case format
when "inittab" then Foreman::Export::Inittab
when "upstart" then Foreman::Export::Upstart when "upstart" then Foreman::Export::Upstart
when "inittab" then Foreman::Export::Inittab
else error "Unknown export format: #{format}." else error "Unknown export format: #{format}."
end end
@@ -48,18 +47,10 @@ class Foreman::CLI < Thor
error ex.message error ex.message
end end
desc "check", "Validate your application's Procfile"
def check
processes = engine.processes_in_order.map { |p| p.first }
error "no processes defined" unless processes.length > 0
display "valid procfile detected (#{processes.join(', ')})"
end
private ###################################################################### private ######################################################################
def check_procfile! def check_procfile!
error("#{procfile} does not exist.") unless File.exist?(procfile) error("Procfile does not exist.") unless File.exist?(procfile)
end end
def engine def engine
@@ -67,12 +58,10 @@ private ######################################################################
end end
def procfile def procfile
options[:procfile] || "Procfile" options[:procfile] || "./Procfile"
end end
def display(message) private ######################################################################
puts message
end
def error(message) def error(message)
puts "ERROR: #{message}" puts "ERROR: #{message}"
@@ -83,11 +72,4 @@ private ######################################################################
File.exist?(procfile) File.exist?(procfile)
end end
def options
original_options = super
return original_options unless File.exists?(".foreman")
defaults = YAML::load_file(".foreman")
Thor::CoreExt::HashWithIndifferentAccess.new(defaults.merge(original_options))
end
end end
+23 -78
View File
@@ -22,80 +22,56 @@ class Foreman::Engine
def processes def processes
@processes ||= begin @processes ||= begin
@order = []
procfile.split("\n").inject({}) do |hash, line| procfile.split("\n").inject({}) do |hash, line|
next if line.strip == "" next if line.strip == ""
name, command = line.split(/ *: +/, 2) name, command = line.split(" ", 2)
unless command
warn_deprecated_procfile!
name, command = line.split(/ +/, 2)
end
process = Foreman::Process.new(name, command) process = Foreman::Process.new(name, command)
process.color = next_color process.color = next_color
@order << process.name
hash.update(process.name => process) hash.update(process.name => process)
end end
end end
end end
def process_order
processes
@order.uniq
end
def processes_in_order
process_order.map do |name|
[name, processes[name]]
end
end
def start(options={}) def start(options={})
environment = read_environment(options[:env])
proctitle "ruby: foreman master" proctitle "ruby: foreman master"
processes_in_order.each do |name, process| processes.each do |name, process|
fork process, options, environment fork process, options
end end
trap("TERM") { puts "SIGTERM received"; kill_all("TERM") } trap("TERM") { kill_and_exit("TERM") }
trap("INT") { puts "SIGINT received"; kill_all("TERM") } trap("INT") { kill_and_exit("INT") }
watch_for_termination watch_for_termination
end end
def execute(name, options={}) def execute(name, options={})
environment = read_environment(options[:env]) fork processes[name], options
fork processes[name], options, environment trap("TERM") { kill_and_exit("TERM") }
trap("INT") { kill_and_exit("INT") }
trap("TERM") { puts "SIGTERM received"; kill_all("TERM") }
trap("INT") { puts "SIGINT received"; kill_all("TERM") }
watch_for_termination watch_for_termination
end end
def port_for(process, num, base_port=nil) def port_for(process, num, base_port=nil)
base_port ||= 5000 base_port ||= 5000
offset = processes_in_order.map { |p| p.first }.index(process.name) * 100 offset = processes.keys.sort.index(process.name) * 100
base_port.to_i + offset + num - 1 base_port.to_i + offset + num - 1
end end
private ###################################################################### private ######################################################################
def fork(process, options={}, environment={}) def fork(process, options={})
concurrency = Foreman::Utils.parse_concurrency(options[:concurrency]) concurrency = Foreman::Utils.parse_concurrency(options[:concurrency])
1.upto(concurrency[process.name]) do |num| 1.upto(concurrency[process.name]) do |num|
fork_individual(process, num, port_for(process, num, options[:port]), environment) fork_individual(process, port_for(process, num, options[:port]))
end end
end end
def fork_individual(process, num, port, environment) def fork_individual(process, port)
environment.each { |k,v| ENV[k] = v }
ENV["PORT"] = port.to_s ENV["PORT"] = port.to_s
ENV["PS"] = "#{process.name}.#{num}"
pid = Process.fork do pid = Process.fork do
run(process) run(process)
@@ -105,33 +81,32 @@ private ######################################################################
running_processes[pid] = process running_processes[pid] = process
end end
def run(process) def run(process, log_to_file=true)
proctitle "ruby: foreman #{process.name}" proctitle "ruby: foreman #{process.name}"
begin Dir.chdir directory do
Dir.chdir directory do FileUtils.mkdir_p "log"
command = process.command command = process.command
begin
PTY.spawn("#{process.command} 2>&1") do |stdin, stdout, pid| PTY.spawn("#{process.command} 2>&1") do |stdin, stdout, pid|
until stdin.eof? until stdin.eof?
info stdin.gets, process info stdin.gets, process
end end
end end
end rescue PTY::ChildExited, Interrupt
rescue PTY::ChildExited, Interrupt
begin
info "process exiting", process info "process exiting", process
rescue Interrupt
end end
end end
end end
def kill_all(signal="TERM") def kill_and_exit(signal="TERM")
info "terminating" info "terminating"
running_processes.each do |pid, process| running_processes.each do |pid, process|
info "killing #{process.name} in pid #{pid}" info "killing #{process.name} in pid #{pid}"
Process.kill(signal, pid) Process.kill(signal, pid)
end end
exit 0
end end
def info(message, process=nil) def info(message, process=nil)
@@ -142,11 +117,6 @@ private ######################################################################
puts puts
end end
def error(message)
puts "ERROR: #{message}"
exit 1
end
def longest_process_name def longest_process_name
@longest_process_name ||= begin @longest_process_name ||= begin
longest = processes.keys.map { |name| name.length }.sort.last longest = processes.keys.map { |name| name.length }.sort.last
@@ -156,8 +126,8 @@ private ######################################################################
end end
def pad_process_name(process) def pad_process_name(process)
name = process ? "#{ENV["PS"]}" : "system" name = process ? "#{process.name}:#{ENV["PORT"]}" : "system"
name.ljust(longest_process_name + 3) # add 3 for process number padding name.ljust(longest_process_name + 6) # add 6 for port padding
end end
def print_info def print_info
@@ -179,8 +149,7 @@ private ######################################################################
pid, status = Process.wait2 pid, status = Process.wait2
process = running_processes.delete(pid) process = running_processes.delete(pid)
info "process terminated", process info "process terminated", process
kill_all kill_and_exit
Process.waitall
end end
def running_processes def running_processes
@@ -193,28 +162,4 @@ private ######################################################################
@current_color >= COLORS.length ? "" : COLORS[@current_color] @current_color >= COLORS.length ? "" : COLORS[@current_color]
end end
def warn_deprecated_procfile!
return if @already_warned_deprecated
@already_warned_deprecated = true
puts "!!! This format of Procfile is deprecated, and will not work starting in v0.12"
puts "!!! Use a colon to separate the process name from the command"
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 end
+1 -2
View File
@@ -4,6 +4,5 @@ module Foreman::Export
class Exception < ::Exception; end class Exception < ::Exception; end
end end
require "foreman/export/base"
require "foreman/export/inittab"
require "foreman/export/upstart" require "foreman/export/upstart"
require "foreman/export/inittab"
+1 -1
View File
@@ -24,7 +24,7 @@ private ######################################################################
end end
def export_template(name) def export_template(name)
File.read(File.expand_path("../../../../data/export/#{name}", __FILE__)) File.read(File.expand_path("../../../../export/#{name}", __FILE__))
end end
def write_file(filename, contents) def write_file(filename, contents)
+3 -3
View File
@@ -1,4 +1,4 @@
require "foreman/export" require "foreman/export/base"
class Foreman::Export::Inittab < Foreman::Export::Base class Foreman::Export::Inittab < Foreman::Export::Base
@@ -27,8 +27,8 @@ class Foreman::Export::Inittab < Foreman::Export::Base
inittab = inittab.join("\n") + "\n" inittab = inittab.join("\n") + "\n"
if fname if fname
FileUtils.mkdir_p(log_root) rescue error "could not create #{log_root}" FileUtils.mkdir_p(log_root)
FileUtils.chown(user, nil, log_root) rescue error "could not chown #{log_root} to #{user}" FileUtils.chown(user, nil, log_root)
write_file(fname, inittab) write_file(fname, inittab)
else else
puts inittab puts inittab
+1 -1
View File
@@ -1,5 +1,5 @@
require "erb" require "erb"
require "foreman/export" require "foreman/export/base"
class Foreman::Export::Upstart < Foreman::Export::Base class Foreman::Export::Upstart < Foreman::Export::Base
-5
View File
@@ -1,5 +0,0 @@
module Foreman
VERSION = "0.16.0"
end
-198
View File
@@ -1,198 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "FOREMAN" "1" "May 2011" "Foreman 0.15.0" "Foreman Manual"
.
.SH "NAME"
\fBforeman\fR \- manage Procfile\-based applications
.
.SH "SYNOPSIS"
\fBforeman start [process]\fR
.
.br
\fBforeman export <format> [location]\fR
.
.SH "DESCRIPTION"
\fBForeman\fR is a manager for Procfile\-based applications\. Its aim is to abstract away the details of the Procfile format, and allow you to either run your application directly or export it to some other process management format\.
.
.SH "RUNNING"
\fBforeman start\fR is used to run your application directly from the command line\.
.
.P
If no additional parameters are passed, foreman will run one instance of each type of process defined in your Procfile\.
.
.P
If a parameter is passed, foreman will run one instance of the specified application type\.
.
.P
The following options control how the application is run:
.
.TP
\fB\-c\fR, \fB\-\-concurrency\fR
Specify the number of each process type to run\. The value passed in should be in the format \fBprocess=num,process=num\fR
.
.TP
\fB\-p\fR, \fB\-\-port\fR
Specify which port to use as the base for this application\. Should be a multiple of 1000\.
.
.SH "EXPORTING"
\fBforeman export\fR is used to export your application to another process management format\.
.
.P
An location to export can be passed as an argument\. This argument may be either required or optional depending on the export format\.
.
.P
The following options control how the application is run:
.
.TP
\fB\-a\fR, \fB\-\-app\fR
Use this name rather than the application\'s root directory name as the name of the application when exporting\.
.
.TP
\fB\-c\fR, \fB\-\-concurrency\fR
Specify the number of each process type to run\. The value passed in should be in the format \fBprocess=num,process=num\fR
.
.TP
\fB\-l\fR, \fB\-\-log\fR
Specify the directory to place process logs in\.
.
.TP
\fB\-p\fR, \fB\-\-port\fR
Specify which port to use as the base for this application\. Should be a multiple of 1000\.
.
.TP
\fB\-u\fR, \fB\-\-user\fR
Specify the user the application should be run as\. Defaults to the app name
.
.SH "OPTIONS"
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\.
.
.SH "EXPORT FORMATS"
foreman currently supports the following output formats:
.
.IP "\(bu" 4
inittab
.
.IP "\(bu" 4
upstart
.
.IP "" 0
.
.SH "INITTAB EXPORT"
Will export a chunk of inittab\-compatible configuration:
.
.IP "" 4
.
.nf
# \-\-\-\-\- foreman example processes \-\-\-\-\-
EX01:4:respawn:/bin/su \- example \-c \'PORT=5000 bundle exec thin start >> /var/log/web\-1\.log 2>&1\'
EX02:4:respawn:/bin/su \- example \-c \'PORT=5100 bundle exec rake jobs:work >> /var/log/job\-1\.log 2>&1\'
# \-\-\-\-\- end foreman example processes \-\-\-\-\-
.
.fi
.
.IP "" 0
.
.SH "UPSTART EXPORT"
Will create a series of upstart scripts in the location you specify\. Scripts will be structured to make the following commands valid:
.
.P
\fBstart appname\fR
.
.P
\fBstop appname\-processname\fR
.
.P
\fBrestart appname\-processname\-3\fR
.
.SH "PROCFILE"
A Procfile should contain both a name for the process and the command used to run it\.
.
.IP "" 4
.
.nf
web: bundle exec thin start
job: bundle exec rake jobs:work
.
.fi
.
.IP "" 0
.
.P
You can validate your Procfile format using the \fBcheck\fR command
.
.IP "" 4
.
.nf
$ foreman check
.
.fi
.
.IP "" 0
.
.SH "DEFAULT OPTIONS"
If a \fB\.foreman\fR file exists in the current directory, default options will be read from it\. This file should be in YAML format with the long option name as keys\. Example:
.
.IP "" 4
.
.nf
concurrency: alpha=0
port: 15000
.
.fi
.
.IP "" 0
.
.SH "EXAMPLES"
Start one instance of each process type, interleave the output on stdout:
.
.IP "" 4
.
.nf
$ foreman start
.
.fi
.
.IP "" 0
.
.P
Export the application in upstart format:
.
.IP "" 4
.
.nf
$ foreman export upstart /etc/init
.
.fi
.
.IP "" 0
.
.P
Run one process type from the application defined in a specific Procfile:
.
.IP "" 4
.
.nf
$ foreman start alpha \-p ~/myapp/Procfile
.
.fi
.
.IP "" 0
.
.SH "COPYRIGHT"
Foreman is Copyright (C) 2010 David Dollar \fIhttp://daviddollar\.org\fR
+3 -21
View File
@@ -66,11 +66,6 @@ The following options control how the application is run:
These options control all modes of foreman's operation. 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`: * `-f`, `--procfile`:
Specify an alternate location for the application's Procfile. This file's Specify an alternate location for the application's Procfile. This file's
containing directory will be assumed to be the root directory of the containing directory will be assumed to be the root directory of the
@@ -109,21 +104,8 @@ will be structured to make the following commands valid:
A Procfile should contain both a name for the process and the command used A Procfile should contain both a name for the process and the command used
to run it. to run it.
web: bundle exec thin start web bundle exec thin start
job: bundle exec rake jobs:work job bundle exec rake jobs:work
You can validate your Procfile format using the `check` command
$ foreman check
## DEFAULT OPTIONS
If a `.foreman` file exists in the current directory, default options will
be read from it. This file should be in YAML format with the long option
name as keys. Example:
concurrency: alpha=0
port: 15000
## EXAMPLES ## EXAMPLES
@@ -137,7 +119,7 @@ Export the application in upstart format:
Run one process type from the application defined in a specific Procfile: Run one process type from the application defined in a specific Procfile:
$ foreman start alpha -p ~/myapp/Procfile $ foreman start alpha -p ~/app/Procfile
## COPYRIGHT ## COPYRIGHT
-23
View File
@@ -58,27 +58,4 @@ describe "Foreman::CLI" do
end end
end end
describe "check" do
describe "with a valid Procfile" do
before { write_procfile }
it "displays the jobs" do
mock(subject).display("valid procfile detected (alpha, bravo)")
subject.check
end
end
describe "with a blank Procfile" do
before do
FileUtils.touch("Procfile")
end
it "displays an error" do
mock_error(subject, "no processes defined") do
subject.check
end
end
end
end
end end
+7 -46
View File
@@ -12,42 +12,28 @@ describe "Foreman::Engine" do
end end
describe "with a Procfile" do describe "with a Procfile" do
before { write_procfile }
it "reads the processes" do it "reads the processes" do
write_procfile
subject.processes["alpha"].command.should == "./alpha" subject.processes["alpha"].command.should == "./alpha"
subject.processes["bravo"].command.should == "./bravo" subject.processes["bravo"].command.should == "./bravo"
end end
end end
describe "with a deprecated Procfile" do
before do
File.open("Procfile", "w") do |file|
file.puts "name command"
end
end
it "should print a deprecation warning" do
mock(subject).warn_deprecated_procfile!
subject.processes.length.should == 1
end
end
end end
describe "start" do describe "start" do
it "forks the processes" do it "forks the processes" do
write_procfile write_procfile
mock(subject).fork(subject.processes["alpha"], {}, {}) mock(subject).fork(subject.processes["alpha"], {})
mock(subject).fork(subject.processes["bravo"], {}, {}) mock(subject).fork(subject.processes["bravo"], {})
mock(subject).watch_for_termination mock(subject).watch_for_termination
subject.start subject.start
end end
it "handles concurrency" do it "handles concurrency" do
write_procfile write_procfile
mock(subject).fork_individual(subject.processes["alpha"], 1, 5000, {}) mock(subject).fork_individual(subject.processes["alpha"], 5000)
mock(subject).fork_individual(subject.processes["alpha"], 2, 5001, {}) mock(subject).fork_individual(subject.processes["alpha"], 5001)
mock(subject).fork_individual(subject.processes["bravo"], 1, 5100, {}) mock(subject).fork_individual(subject.processes["bravo"], 5100)
mock(subject).watch_for_termination mock(subject).watch_for_termination
subject.start(:concurrency => "alpha=2") subject.start(:concurrency => "alpha=2")
end end
@@ -56,34 +42,9 @@ describe "Foreman::Engine" do
describe "execute" do describe "execute" do
it "runs the processes" do it "runs the processes" do
write_procfile write_procfile
mock(subject).fork(subject.processes["alpha"], {}, {}) mock(subject).fork(subject.processes["alpha"], {})
mock(subject).watch_for_termination mock(subject).watch_for_termination
subject.execute("alpha") subject.execute("alpha")
end end
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 end
-20
View File
@@ -1,22 +1,2 @@
require "spec_helper" require "spec_helper"
require "foreman/engine"
require "foreman/export/upstart" require "foreman/export/upstart"
describe Foreman::Export::Upstart do
let(:engine) { Foreman::Engine.new(write_procfile) }
let(:upstart) { Foreman::Export::Upstart.new(engine) }
before(:each) { load_export_templates_into_fakefs("upstart") }
before(:each) { stub(upstart).say }
it "exports to the filesystem" do
upstart.export("/tmp/init")
File.read("/tmp/init/foreman.conf").should == example_export_file("upstart/foreman.conf")
File.read("/tmp/init/foreman-alpha.conf").should == example_export_file("upstart/foreman-alpha.conf")
File.read("/tmp/init/foreman-alpha-1.conf").should == example_export_file("upstart/foreman-alpha-1.conf")
File.read("/tmp/init/foreman-alpha-2.conf").should == example_export_file("upstart/foreman-alpha-2.conf")
File.read("/tmp/init/foreman-bravo.conf").should == example_export_file("upstart/foreman.bravo.conf")
File.read("/tmp/init/foreman-bravo-1.conf").should == example_export_file("upstart/foreman-bravo-1.conf")
end
end
@@ -1,6 +0,0 @@
start on starting foreman-alpha
stop on stopping foreman-alpha
respawn
chdir /Users/david/Code/foreman
exec su foreman -c 'export PORT=5000; ./alpha >> /var/log/foreman/alpha-1.log 2>&1'
@@ -1,6 +0,0 @@
start on starting foreman-alpha
stop on stopping foreman-alpha
respawn
chdir /Users/david/Code/foreman
exec su foreman -c 'export PORT=5001; ./alpha >> /var/log/foreman/alpha-2.log 2>&1'
@@ -1,2 +0,0 @@
start on starting foreman
stop on stopping foreman
@@ -1,6 +0,0 @@
start on starting foreman-bravo
stop on stopping foreman-bravo
respawn
chdir /Users/david/Code/foreman
exec su foreman -c 'export PORT=5100; ./bravo >> /var/log/foreman/bravo-1.log 2>&1'
@@ -1,2 +0,0 @@
start on starting foreman
stop on stopping foreman
@@ -1,8 +0,0 @@
pre-start script
bash << "EOF"
mkdir -p /var/log/foreman
chown -R foreman /var/log/foreman
EOF
end script
+3 -24
View File
@@ -3,7 +3,7 @@ require "rspec"
require "fakefs/safe" require "fakefs/safe"
require "fakefs/spec_helpers" require "fakefs/spec_helpers"
$:.unshift File.expand_path("../../lib", __FILE__) $:.unshift "lib"
def mock_error(subject, message) def mock_error(subject, message)
mock_exit do mock_exit do
@@ -26,30 +26,9 @@ end
def write_procfile(procfile="Procfile") def write_procfile(procfile="Procfile")
File.open(procfile, "w") do |file| File.open(procfile, "w") do |file|
file.puts "alpha: ./alpha" file.puts "alpha ./alpha"
file.puts "bravo: ./bravo" file.puts "bravo ./bravo"
end end
File.expand_path(procfile)
end
def load_export_templates_into_fakefs(type)
FakeFS.deactivate!
files = Dir[File.expand_path("../../data/export/#{type}/**", __FILE__)].inject({}) do |hash, file|
hash.update(file => File.read(file))
end
FakeFS.activate!
files.each do |filename, contents|
File.open(filename, "w") do |f|
f.puts contents
end
end
end
def example_export_file(filename)
FakeFS.deactivate!
data = File.read(File.expand_path("../resources/export/#{filename}", __FILE__))
FakeFS.activate!
data
end end
Rspec.configure do |config| Rspec.configure do |config|