Compare commits

..

99 Commits

Author SHA1 Message Date
David Dollar
22ad6c5dd8 0.12.0.pre1 2011-03-25 19:29:11 -04:00
David Dollar
b117ef5b08 remove parka, relax thor version 2011-03-25 19:25:27 -04:00
David Dollar
35474ad1a5 0.11.1 2011-03-08 12:17:44 -05:00
David Dollar
fc5e86b269 describe .foreman in man page 2011-03-08 12:17:03 -05:00
David Dollar
7f8ca7da39 support .foreman file for default options 2011-03-08 12:14:48 -05:00
David Dollar
31239d98d0 ignore ctags file 2011-01-30 16:18:12 -08:00
David Dollar
472395edf8 0.11.0 2011-01-27 16:15:26 -08:00
David Dollar
6b7d5e5161 deprecate colon-less syntax, add check command 2011-01-27 16:14:43 -08:00
David Dollar
977c80ffdd add json export 2011-01-27 16:13:44 -08:00
David Dollar
2804316bbb 0.10.1 2010-12-22 13:56:13 -05:00
David Dollar
26859c2ec2 dont need a log dir 2010-12-22 13:55:51 -05:00
David Dollar
27152b0e76 docs pedantry 2010-12-13 18:13:11 -05:00
David Dollar
160945b499 doc the rake task so it shows in -T 2010-12-13 18:12:28 -05:00
David Dollar
f2be566051 update man page 2010-12-13 18:11:36 -05:00
David Dollar
a504a59f0b add a colon to the mock Procfile 2010-12-13 18:08:40 -05:00
David Dollar
e6b61801b1 0.10.0 2010-12-13 18:05:41 -05:00
David Dollar
dc231f072b allow optional colon after process name 2010-12-13 18:05:06 -05:00
David Dollar
b77b23b306 declare license 2010-11-16 17:47:53 -05:00
David Dollar
185617dddc 0.9.2 2010-11-09 13:42:18 -05:00
David Dollar
9e4cc02827 upgrade dependencies 2010-11-09 13:41:18 -05:00
David Dollar
8b6e2481f4 ruby 1.8.6 compatibility 2010-11-09 13:41:08 -05:00
David Dollar
79f376368c 0.9.1 2010-11-03 15:00:59 -07:00
David Dollar
3576ae82af use process order to determine port assignments 2010-11-03 15:00:35 -07:00
David Dollar
303d54155f uniq the order for safety 2010-11-03 14:13:06 -07:00
David Dollar
2e36cbf045 0.9.0 2010-11-03 14:11:37 -07:00
David Dollar
d3059ca563 always run processes in order they are defined in the procfile 2010-11-03 14:11:30 -07:00
David Dollar
9e42dfb253 change back to Procfile 2010-11-03 14:05:06 -07:00
David Dollar
eca48170a5 fixing specs 2010-10-15 17:26:18 -07:00
David Dollar
86e3cd12dd using Psfile 2010-10-15 17:25:12 -07:00
David Dollar
efd5a786f5 showing PORT here can be confusing 2010-10-15 16:29:40 -07:00
David Dollar
7e9117812f 0.9.0.beta.1 2010-10-15 16:18:54 -07:00
David Dollar
55f405a2b4 catch some common error cases 2010-10-15 16:17:55 -07:00
David Dollar
615bb0d4ba pass ENV["PS"] through to child processes (worker.1) and use it for display output 2010-10-15 16:08:33 -07:00
David Dollar
0ae144e468 better handling of Interrupt rescues 2010-10-15 16:06:06 -07:00
David Dollar
0c2b2a4ac2 prevent double interrupt 2010-10-15 15:55:53 -07:00
David Dollar
e68946f186 change to Pstypes 2010-10-15 15:53:43 -07:00
David Dollar
52edb7fd28 move data under data 2010-10-15 15:53:27 -07:00
David Dollar
8446528f5a change to Pstypes 2010-10-15 15:50:40 -07:00
David Dollar
d41a8726bd update dependencies 2010-10-15 15:50:19 -07:00
David Dollar
7bb1e58879 0.8.0 2010-09-20 16:22:31 -04:00
David Dollar
62b6cac741 print message when signal received 2010-09-20 16:22:13 -04:00
Keith Rarick
2a7dadc2b2 Wait cleanly for child processes to exit.
Signed-off-by: David Dollar <ddollar@gmail.com>
2010-09-20 16:21:41 -04:00
David Dollar
9cd772ac0f 0.7.5 2010-09-17 09:31:24 -04:00
David Dollar
2b27d0a51a include files from export in the gem 2010-09-17 09:31:08 -04:00
Keith Rarick
99204d7c1d Wait for descendant processes to exit. 2010-09-17 21:28:01 +08:00
Ricardo Chimal, Jr
e9b5ed81b8 bugfix upstart export erb templates 2010-09-17 21:27:29 +08:00
David Dollar
7d751470d2 0.7.3 2010-08-24 17:41:36 -04:00
David Dollar
68c1a01f15 add executable and man page to gem release 2010-08-24 17:41:22 -04:00
David Dollar
08f9027cb4 0.7.2 2010-08-24 17:24:43 -04:00
David Dollar
4f7692bed9 switch to parka for gem management 2010-08-24 17:23:03 -04:00
David Dollar
dd95cea997 update docs 2010-07-21 07:23:32 -07:00
David Dollar
f3988b0c52 Regenerated gemspec for version 0.7.1 2010-07-20 16:20:20 -07:00
David Dollar
fbb17dd37d 0.7.1 2010-07-20 16:20:16 -07:00
David Dollar
31a72b454b clean up development concurrency, make sure ports exist in dev mode 2010-07-20 16:20:03 -07:00
David Dollar
e5a8c38da6 clean up exports 2010-07-20 16:19:40 -07:00
David Dollar
d199ef2b4d Regenerated gemspec for version 0.7.0 2010-07-19 17:14:04 -07:00
David Dollar
7a1895e435 0.7.0 2010-07-19 17:13:54 -07:00
David Dollar
151ddb45c8 remove screen option, seems too hokey 2010-07-19 17:11:42 -07:00
David Dollar
51513dcb6d pedantry 2010-07-19 17:08:48 -07:00
David Dollar
0b6fdad3a2 allow concurrency to be used in development mode 2010-07-19 17:08:42 -07:00
David Dollar
096f532624 fix failing spec 2010-07-19 15:50:19 -07:00
David Dollar
efeef5b4f0 Regenerated gemspec for version 0.6.0 2010-07-06 16:43:00 -04:00
David Dollar
0eb08dd8ae 0.6.0 2010-07-06 16:42:50 -04:00
Adam Wiggins
92ba6e0ba7 use app name in log root for inittab export 2010-07-07 04:42:08 +08:00
David Dollar
2b90c48eb4 point to the better-formatted man page for help 2010-07-04 14:39:27 -04:00
David Dollar
dbfd8ba49a Regenerated gemspec for version 0.5.1 2010-06-30 23:11:30 -04:00
David Dollar
d6837177cd 0.5.1 2010-06-30 23:11:26 -04:00
Adam Wiggins
58b45c4933 require fileutils for ruby 1.8.6 compat 2010-07-01 11:10:44 +08:00
David Dollar
fbdf4d7220 add a bit more example to the docs 2010-06-30 21:48:11 -04:00
David Dollar
895672efe8 update readme 2010-06-30 21:47:17 -04:00
David Dollar
8597e0dc16 update readme 2010-06-30 21:46:46 -04:00
David Dollar
408ba06c3f update readme 2010-06-30 21:45:57 -04:00
David Dollar
a0f82840eb update readme 2010-06-30 21:45:50 -04:00
David Dollar
1317013898 update readme 2010-06-30 21:44:34 -04:00
David Dollar
6a7720872f update readme 2010-06-30 21:44:18 -04:00
David Dollar
b3a5fa9c1b update readme 2010-06-30 21:44:13 -04:00
David Dollar
41e095cf04 update readme 2010-06-30 21:42:48 -04:00
David Dollar
2c9f6c25fc update readme 2010-06-30 21:42:40 -04:00
David Dollar
ce0261c3de update readme 2010-06-30 21:42:23 -04:00
David Dollar
f138d26e7e update readme 2010-06-30 21:42:10 -04:00
David Dollar
6000e837fe update readme 2010-06-30 21:42:02 -04:00
David Dollar
02299c4c1c update readme 2010-06-30 21:41:54 -04:00
David Dollar
6dc9fe2667 update readme 2010-06-30 21:41:29 -04:00
David Dollar
a61d808487 update readme 2010-06-30 21:41:13 -04:00
David Dollar
5f98544dab update readme 2010-06-30 21:40:56 -04:00
David Dollar
99da671f5d update readme 2010-06-30 21:40:25 -04:00
David Dollar
26599f630f Regenerated gemspec for version 0.5.0 2010-06-30 21:32:44 -04:00
David Dollar
cfe6a49900 update readme 2010-06-30 21:32:44 -04:00
David Dollar
ddccab4c63 0.5.0 2010-06-30 21:32:38 -04:00
David Dollar
3151663f37 add -p flag to specify the base port for apps 2010-06-30 21:32:26 -04:00
David Dollar
98486513b6 switch procfile option to -f 2010-06-30 21:18:30 -04:00
David Dollar
b969e03086 pedantry 2010-06-29 20:42:06 -04:00
David Dollar
be593846e2 Regenerated gemspec for version 0.4.7 2010-06-29 17:08:49 -04:00
David Dollar
2458c4e75f 0.4.7 2010-06-29 17:08:46 -04:00
David Dollar
314e2f5530 fix -l, dont append app name 2010-06-29 17:08:30 -04:00
David Dollar
d6c5e6ddea Regenerated gemspec for version 0.4.6 2010-06-29 16:49:17 -04:00
David Dollar
261164e694 update readme 2010-06-29 16:49:17 -04:00
David Dollar
92e637a231 0.4.6 2010-06-29 16:49:14 -04:00
David Dollar
08b94716f2 support -l to export for specifying log root 2010-06-29 16:49:02 -04:00
30 changed files with 407 additions and 323 deletions

3
.gitignore vendored
View File

@@ -1,6 +1,9 @@
.bundle
coverage
example/log/*
man/*.?
man/*.html
man/*.markdown
pkg
tags

18
Gemfile Normal file
View File

@@ -0,0 +1,18 @@
source "http://rubygems.org"
group :development do
gem 'parka'
gem 'rake'
gem 'ronn'
end
group :test do
gem 'fakefs', '~> 0.2.1'
gem 'rcov', '~> 0.9.8'
gem 'rr', '~> 1.0.2'
gem 'rspec', '~> 2.0.0'
end
gem 'json', '~> 1.5.1'
gem 'term-ansicolor', '~> 1.0.5'
gem 'thor', '>= 0.13.6'

49
Gemfile.lock Normal file
View File

@@ -0,0 +1,49 @@
GEM
remote: http://rubygems.org/
specs:
diff-lcs (1.1.2)
fakefs (0.2.1)
hpricot (0.8.2)
json (1.5.1)
mime-types (1.16)
mustache (0.11.2)
parka (0.3.1)
rest-client
thor
rake (0.8.7)
rcov (0.9.8)
rdiscount (1.6.5)
rest-client (1.6.0)
mime-types (>= 1.16)
ronn (0.7.3)
hpricot (>= 0.8.2)
mustache (>= 0.7.0)
rdiscount (>= 1.5.8)
rr (1.0.2)
rspec (2.0.1)
rspec-core (~> 2.0.1)
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)
rspec-mocks (2.0.1)
rspec-core (~> 2.0.1)
rspec-expectations (~> 2.0.1)
term-ansicolor (1.0.5)
thor (0.14.6)
PLATFORMS
ruby
DEPENDENCIES
fakefs (~> 0.2.1)
json (~> 1.5.1)
parka
rake
rcov (~> 0.9.8)
ronn
rr (~> 1.0.2)
rspec (~> 2.0.0)
term-ansicolor (~> 1.0.5)
thor (>= 0.13.6)

View File

@@ -1,100 +1,9 @@
foreman(1) -- manage Procfile-based applications
================================================
# Foreman
## SYNOPSIS
## Manual
`foreman start [process]`<br>
`foreman export <var>format</var> [location]`
See the [man page](http://ddollar.github.com/foreman) for usage.
## DESCRIPTION
## License
**Foreman** 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.
## RUNNING
`foreman start` is used to run your application directly from the command line.
If no additional parameters are passed, foreman will run one instance of each
type of process defined in your Procfile.
If a parameter is passed, foreman will run one instance of the specified
application type.
The following options control how the application is run:
* `-s`, `--screen`:
Run the application as a series of screen windows rather than interleaved
in stdout.
## EXPORTING
`foreman export` is used to export your application to another process
management format.
An location to export can be passed as an argument. This argument may be
either required or optional depending on the export format.
The following options control how the application is run:
* `-a`, `--app`:
Use this name rather than the application's root directory name as the
name of the application when exporting.
* `-c`, `--concurrency`:
Specify the number of each process type to run. The value passed in
should be in the format `process=num,process=num`
* `-u`, `--user`:
Specify the user the application should be run as. Defaults to the
app name
## OPTIONS
These options control all modes of foreman's operation.
* `-p`, `--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
application.
## PROCFILE
A Procfile should contain both a name for the process and the command used
to run it.
web bundle exec thin start
job bundle exec rake jobs:work
## EXAMPLES
Start one instance of each process type, interleave the output on stdout:
$ foreman start
Export the application in upstart format:
$ foreman export upstart /etc/init
Run one process type from the application defined in a specific Procfile:
$ foreman start alpha -p ~/app/Procfile
## COPYRIGHT
Foreman is Copyright (C) 2010 David Dollar <http://daviddollar.org>
[SYNOPSIS]: #SYNOPSIS "SYNOPSIS"
[DESCRIPTION]: #DESCRIPTION "DESCRIPTION"
[RUNNING]: #RUNNING "RUNNING"
[EXPORTING]: #EXPORTING "EXPORTING"
[OPTIONS]: #OPTIONS "OPTIONS"
[PROCFILE]: #PROCFILE "PROCFILE"
[EXAMPLES]: #EXAMPLES "EXAMPLES"
[COPYRIGHT]: #COPYRIGHT "COPYRIGHT"
[foreman(1)]: foreman.1.html
MIT

View File

@@ -1,3 +1,7 @@
require "rubygems"
require "bundler"
Bundler.setup
require "rake"
require "rspec"
require "rspec/core/rake_task"
@@ -21,7 +25,7 @@ end
Rspec::Core::RakeTask.new("rcov:build") do |t|
t.pattern = 'spec/**/*_spec.rb'
t.rcov = true
t.rcov_opts = [ "--exclude", Gem.default_dir , "--exclude", "spec" ]
t.rcov_opts = [ "--exclude", ".bundle", "--exclude", "spec" ]
end
desc 'Build the manual'
@@ -29,11 +33,11 @@ task :man do
ENV['RONN_MANUAL'] = "Foreman Manual"
ENV['RONN_ORGANIZATION'] = "Foreman #{Foreman::VERSION}"
sh "ronn -w -s toc -r5 --markdown man/*.ronn"
sh "cp man/foreman.1.markdown README.markdown"
sh "git add README.markdown"
sh "git commit -m 'update readme' || echo 'nothing to commit'"
end
desc "Generate the Github docs"
task :pages => :man do
sh %{
cp man/foreman.1.html /tmp/foreman.1.html
@@ -46,41 +50,3 @@ task :pages => :man do
git checkout master
}
end
######################################################
begin
require 'jeweler'
Jeweler::Tasks.new do |s|
s.name = "foreman"
s.version = Foreman::VERSION
s.summary = "Process manager for applications with multiple components"
s.description = s.summary
s.author = "David Dollar"
s.email = "ddollar@gmail.com"
s.homepage = "http://github.com/ddollar/foreman"
s.platform = Gem::Platform::RUBY
s.has_rdoc = false
s.files = %w(Rakefile README.md) + Dir["{bin,export,lib,spec}/**/*"]
s.require_path = "lib"
# #s.bindir = "bin"
# s.executables = Dir["bin/*"]
s.default_executable = "foreman"
s.add_development_dependency 'fakefs', '~> 0.2.1'
s.add_development_dependency 'rake', '~> 0.8.7'
s.add_development_dependency 'rcov', '~> 0.9.8'
s.add_development_dependency 'rr', '~> 0.10.11'
s.add_development_dependency 'rspec', '~> 2.0.0'
s.add_dependency 'term-ansicolor', '~> 1.0.5'
s.add_dependency 'thor', '~> 0.13.6'
end
Jeweler::GemcutterTasks.new
rescue LoadError
puts "Jeweler not available. Install it with: sudo gem install jeweler"
end

2
data/example/Procfile Normal file
View File

@@ -0,0 +1,2 @@
ticker: ./ticker $PORT
error : ./error

View File

@@ -0,0 +1,2 @@
ticker ./ticker $PORT
error ./error

View File

@@ -0,0 +1,4 @@
tick
tick
./never_die:6:in `sleep': Interrupt
from ./never_die:6

View File

@@ -1,6 +1,6 @@
#!/usr/bin/env ruby
while true
puts "tick"
puts "tick: #{ARGV.inspect}"
sleep 1
end

View File

@@ -0,0 +1,8 @@
pre-start script
bash << "EOF"
mkdir -p <%= log_root %>
chown -R <%= user %> <%= log_root %>
EOF
end script

View File

@@ -3,4 +3,4 @@ stop on stopping <%= app %>-<%= process.name %>
respawn
chdir <%= engine.directory %>
exec su <%= user %> -c "<%= process.command %> >> /var/log/<%=app%>/<%=process.name%>-<%=num%>.log 2>&1"
exec su - <%= user %> -c 'export PORT=<%= port %>; <%= process.command %> >> <%= log_root %>/<%=process.name%>-<%=num%>.log 2>&1'

View File

@@ -1,2 +0,0 @@
ticker ./ticker
error ./error

View File

@@ -1,8 +0,0 @@
pre-start script
bash << "EOF"
mkdir -p /var/log/<%= app %>
chown -R <%= user %> /var/log/<%= app %>
EOF
end script

View File

@@ -1,89 +1,29 @@
# Generated by jeweler
# DO NOT EDIT THIS FILE DIRECTLY
# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
# -*- encoding: utf-8 -*-
$:.unshift File.expand_path("../lib", __FILE__)
require "foreman/version"
Gem::Specification.new do |s|
s.name = %q{foreman}
s.version = "0.4.5"
Gem::Specification.new do |gem|
gem.name = "foreman"
gem.version = Foreman::VERSION
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["David Dollar"]
s.date = %q{2010-06-29}
s.default_executable = %q{foreman}
s.description = %q{Process manager for applications with multiple components}
s.email = %q{ddollar@gmail.com}
s.executables = ["foreman"]
s.extra_rdoc_files = [
"README.markdown"
]
s.files = [
"Rakefile",
"bin/foreman",
"export/upstart/master.conf.erb",
"export/upstart/process.conf.erb",
"export/upstart/process_master.conf.erb",
"lib/foreman.rb",
"lib/foreman/cli.rb",
"lib/foreman/engine.rb",
"lib/foreman/export.rb",
"lib/foreman/export/base.rb",
"lib/foreman/export/inittab.rb",
"lib/foreman/export/upstart.rb",
"lib/foreman/process.rb",
"spec/foreman/cli_spec.rb",
"spec/foreman/engine_spec.rb",
"spec/foreman/export/upstart_spec.rb",
"spec/foreman/export_spec.rb",
"spec/foreman/process_spec.rb",
"spec/foreman_spec.rb",
"spec/spec_helper.rb"
]
s.has_rdoc = false
s.homepage = %q{http://github.com/ddollar/foreman}
s.rdoc_options = ["--charset=UTF-8"]
s.require_paths = ["lib"]
s.rubygems_version = %q{1.3.7}
s.summary = %q{Process manager for applications with multiple components}
s.test_files = [
"spec/foreman/cli_spec.rb",
"spec/foreman/engine_spec.rb",
"spec/foreman/export/upstart_spec.rb",
"spec/foreman/export_spec.rb",
"spec/foreman/process_spec.rb",
"spec/foreman_spec.rb",
"spec/spec_helper.rb"
]
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"
if s.respond_to? :specification_version then
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
s.specification_version = 3
gem.description = gem.summary
if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
s.add_development_dependency(%q<fakefs>, ["~> 0.2.1"])
s.add_development_dependency(%q<rake>, ["~> 0.8.7"])
s.add_development_dependency(%q<rcov>, ["~> 0.9.8"])
s.add_development_dependency(%q<rr>, ["~> 0.10.11"])
s.add_development_dependency(%q<rspec>, ["~> 2.0.0"])
s.add_runtime_dependency(%q<term-ansicolor>, ["~> 1.0.5"])
s.add_runtime_dependency(%q<thor>, ["~> 0.13.6"])
else
s.add_dependency(%q<fakefs>, ["~> 0.2.1"])
s.add_dependency(%q<rake>, ["~> 0.8.7"])
s.add_dependency(%q<rcov>, ["~> 0.9.8"])
s.add_dependency(%q<rr>, ["~> 0.10.11"])
s.add_dependency(%q<rspec>, ["~> 2.0.0"])
s.add_dependency(%q<term-ansicolor>, ["~> 1.0.5"])
s.add_dependency(%q<thor>, ["~> 0.13.6"])
end
else
s.add_dependency(%q<fakefs>, ["~> 0.2.1"])
s.add_dependency(%q<rake>, ["~> 0.8.7"])
s.add_dependency(%q<rcov>, ["~> 0.9.8"])
s.add_dependency(%q<rr>, ["~> 0.10.11"])
s.add_dependency(%q<rspec>, ["~> 2.0.0"])
s.add_dependency(%q<term-ansicolor>, ["~> 1.0.5"])
s.add_dependency(%q<thor>, ["~> 0.13.6"])
end
gem.executables = "foreman"
gem.files = Dir["**/*"].select { |d| d =~ %r{^(README|bin/|data/|ext/|lib/|spec/|test/)} }
gem.files << "man/foreman.1"
gem.add_dependency 'json', '~> 1.5.1'
gem.add_dependency 'term-ansicolor', '~> 1.0.5'
gem.add_dependency 'thor', '>= 0.13.6'
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

View File

@@ -1,7 +1,5 @@
module Foreman
VERSION = "0.4.5"
class AppDoesNotExist < Exception; end
end

View File

@@ -5,52 +5,61 @@ require "thor"
class Foreman::CLI < Thor
class_option :procfile, :type => :string, :aliases => "-p", :desc => "Default: ./Procfile"
class_option :procfile, :type => :string, :aliases => "-f", :desc => "Default: Procfile"
desc "start [PROCESS]", "Start the application, or a specific process"
method_option :screen, :type => :boolean, :aliases => "-s"
method_option :port, :type => :numeric, :aliases => "-p"
method_option :concurrency, :type => :string, :aliases => "-c",
:banner => '"alpha=5,bar=3"'
def start(process=nil)
check_procfile!
if process
engine.execute(process)
elsif options[:screen]
engine.screen
engine.execute(process, options)
else
engine.start
engine.start(options)
end
end
desc "export FORMAT LOCATION", "Export the application to another process management format"
method_option :app, :type => :string, :aliases => "-a"
method_option :user, :type => :string, :aliases => "-u"
method_option :concurrency, :type => :string, :aliases => "-c",
method_option :app, :type => :string, :aliases => "-a"
method_option :log, :type => :string, :aliases => "-l"
method_option :port, :type => :numeric, :aliases => "-p"
method_option :user, :type => :string, :aliases => "-u"
method_option :concurrency, :type => :string, :aliases => "-c",
:banner => '"alpha=5,bar=3"'
def export(format, location=nil)
check_procfile!
formatter = case format
when "upstart" then Foreman::Export::Upstart
when "json" then Foreman::Export::JSON
when "inittab" then Foreman::Export::Inittab
when "upstart" then Foreman::Export::Upstart
else error "Unknown export format: #{format}."
end
formatter.new(engine).export(location,
:name => options[:app],
:user => options[:user],
:concurrency => options[:concurrency]
)
formatter.new(engine).export(location, options)
rescue Foreman::Export::Exception => ex
error ex.message
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 ######################################################################
def check_procfile!
error("Procfile does not exist.") unless File.exist?(procfile)
error("#{procfile} does not exist.") unless File.exist?(procfile)
end
def engine
@@ -58,10 +67,12 @@ private ######################################################################
end
def procfile
options[:procfile] || "./Procfile"
options[:procfile] || "Procfile"
end
private ######################################################################
def display(message)
puts message
end
def error(message)
puts "ERROR: #{message}"
@@ -72,4 +83,11 @@ private ######################################################################
File.exist?(procfile)
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

View File

@@ -1,8 +1,10 @@
require "foreman"
require "foreman/process"
require "foreman/utils"
require "pty"
require "tempfile"
require "term/ansicolor"
require "fileutils"
class Foreman::Engine
@@ -11,7 +13,7 @@ class Foreman::Engine
extend Term::ANSIColor
COLORS = [ cyan, yellow, green, magenta, on_blue ]
COLORS = [ cyan, yellow, green, magenta, red ]
def initialize(procfile)
@procfile = read_procfile(procfile)
@@ -20,48 +22,75 @@ class Foreman::Engine
def processes
@processes ||= begin
@order = []
procfile.split("\n").inject({}) do |hash, line|
next if line.strip == ""
process = Foreman::Process.new(*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.color = next_color
@order << process.name
hash.update(process.name => process)
end
end
end
def start
def process_order
processes
@order.uniq
end
def processes_in_order
process_order.map do |name|
[name, processes[name]]
end
end
def start(options={})
proctitle "ruby: foreman master"
processes.each do |name, process|
fork process
processes_in_order.each do |name, process|
fork process, options
end
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("INT") }
watch_for_termination
end
def screen
tempfile = Tempfile.new("foreman")
tempfile.puts "sessionname foreman"
processes.each do |name, process|
tempfile.puts "screen -t #{name} #{process.command}"
end
tempfile.close
def execute(name, options={})
fork processes[name], options
system "screen -c #{tempfile.path}"
trap("TERM") { puts "SIGTERM received"; kill_all("TERM") }
trap("INT") { puts "SIGINT received"; kill_all("INT") }
tempfile.delete
watch_for_termination
end
def execute(name)
run(processes[name], false)
def port_for(process, num, base_port=nil)
base_port ||= 5000
offset = processes_in_order.map { |p| p.first }.index(process.name) * 100
base_port.to_i + offset + num - 1
end
private ######################################################################
def fork(process)
def fork(process, options={})
concurrency = Foreman::Utils.parse_concurrency(options[:concurrency])
1.upto(concurrency[process.name]) do |num|
fork_individual(process, num, port_for(process, num, options[:port]))
end
end
def fork_individual(process, num, port)
ENV["PORT"] = port.to_s
ENV["PS"] = "#{process.name}.#{num}"
pid = Process.fork do
run(process)
end
@@ -70,32 +99,33 @@ private ######################################################################
running_processes[pid] = process
end
def run(process, log_to_file=true)
def run(process)
proctitle "ruby: foreman #{process.name}"
Dir.chdir directory do
FileUtils.mkdir_p "log"
command = process.command
begin
Dir.chdir directory do
command = process.command
begin
PTY.spawn("#{process.command} 2>&1") do |stdin, stdout, pid|
until stdin.eof?
info stdin.gets, process
end
end
rescue PTY::ChildExited, Interrupt
end
rescue PTY::ChildExited, Interrupt
begin
info "process exiting", process
rescue Interrupt
end
end
end
def kill_and_exit(signal="TERM")
def kill_all(signal="TERM")
info "terminating"
running_processes.each do |pid, process|
info "killing #{process.name} in pid #{pid}"
Process.kill(signal, pid)
end
exit 0
end
def info(message, process=nil)
@@ -115,8 +145,8 @@ private ######################################################################
end
def pad_process_name(process)
name = process ? process.name : "system"
name.ljust(longest_process_name)
name = process ? "#{ENV["PS"]}" : "system"
name.ljust(longest_process_name + 3) # add 3 for process number padding
end
def print_info
@@ -138,7 +168,8 @@ private ######################################################################
pid, status = Process.wait2
process = running_processes.delete(pid)
info "process terminated", process
kill_and_exit
kill_all
Process.waitall
end
def running_processes
@@ -151,4 +182,12 @@ private ######################################################################
@current_color >= COLORS.length ? "" : COLORS[@current_color]
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
end

View File

@@ -4,5 +4,6 @@ module Foreman::Export
class Exception < ::Exception; end
end
require "foreman/export/upstart"
require "foreman/export/json"
require "foreman/export/inittab"
require "foreman/export/upstart"

View File

@@ -1,4 +1,5 @@
require "foreman/export"
require "foreman/utils"
class Foreman::Export::Base
@@ -23,17 +24,7 @@ private ######################################################################
end
def export_template(name)
File.read(File.expand_path("../../../../export/#{name}", __FILE__))
end
def parse_concurrency(concurrency)
@concurrency ||= begin
pairs = concurrency.to_s.gsub(/\s/, "").split(",")
pairs.inject(Hash.new(1)) do |hash, pair|
process, amount = pair.split("=")
hash.update(process => amount.to_i)
end
end
File.read(File.expand_path("../../../../data/export/#{name}", __FILE__))
end
def write_file(filename, contents)

View File

@@ -5,23 +5,30 @@ class Foreman::Export::Inittab < Foreman::Export::Base
def export(fname=nil, options={})
app = options[:app] || File.basename(engine.directory)
user = options[:user] || app
log_dir = "/var/log/#{app}"
log_root = options[:log] || "/var/log/#{app}"
concurrency = parse_concurrency(options[:concurrency])
concurrency = Foreman::Utils.parse_concurrency(options[:concurrency])
inittab = []
inittab << "# ----- foreman #{app} processes -----"
engine.processes.values.each_with_index do |process, num|
id = app.slice(0, 2).upcase + sprintf("%02d", num+1)
inittab << "#{id}:4:respawn:/bin/su - #{user} -c '#{process.command} >> #{log_dir}/#{process.name}-#{num+1}.log 2>&1'"
engine.processes.values.inject(1) do |index, process|
1.upto(concurrency[process.name]) do |num|
id = app.slice(0, 2).upcase + sprintf("%02d", index)
port = engine.port_for(process, num, options[:port])
inittab << "#{id}:4:respawn:/bin/su - #{user} -c 'PORT=#{port} #{process.command} >> #{log_root}/#{process.name}-#{num}.log 2>&1'"
index += 1
end
index
end
inittab << "# ----- end foreman #{app} processes -----"
inittab = inittab.join("\n") + "\n"
if fname
FileUtils.mkdir_p(log_dir)
FileUtils.chown(user, nil, log_dir)
FileUtils.mkdir_p(log_root) rescue error "could not create #{log_root}"
FileUtils.chown(user, nil, log_root) rescue error "could not chown #{log_root} to #{user}"
write_file(fname, inittab)
else
puts inittab

View File

@@ -0,0 +1,13 @@
require "foreman/export/base"
require "json"
class Foreman::Export::JSON < Foreman::Export::Base
def export(fname=nil, options={})
processes = engine.processes.values.inject({}) do |hash, process|
hash.update(process.name => { "command" => process.command })
end
puts processes.to_json
end
end

View File

@@ -10,13 +10,14 @@ class Foreman::Export::Upstart < Foreman::Export::Base
app = options[:app] || File.basename(engine.directory)
user = options[:user] || app
log_root = options[:log] || "/var/log/#{app}"
Dir["#{location}/#{app}*.conf"].each do |file|
say "cleaning up: #{file}"
FileUtils.rm(file)
end
concurrency = parse_concurrency(options[:concurrency])
concurrency = Foreman::Utils.parse_concurrency(options[:concurrency])
master_template = export_template("upstart/master.conf.erb")
master_config = ERB.new(master_template).result(binding)
@@ -30,6 +31,7 @@ class Foreman::Export::Upstart < Foreman::Export::Base
write_file "#{location}/#{app}-#{process.name}.conf", process_master_config
1.upto(concurrency[process.name]) do |num|
port = engine.port_for(process, num, options[:port])
process_config = ERB.new(process_template).result(binding)
write_file "#{location}/#{app}-#{process.name}-#{num}.conf", process_config
end

15
lib/foreman/utils.rb Normal file
View File

@@ -0,0 +1,15 @@
require "foreman"
class Foreman::Utils
def self.parse_concurrency(concurrency)
@concurrency ||= begin
pairs = concurrency.to_s.gsub(/\s/, "").split(",")
pairs.inject(Hash.new(1)) do |hash, pair|
process, amount = pair.split("=")
hash.update(process => amount.to_i)
end
end
end
end

5
lib/foreman/version.rb Normal file
View File

@@ -0,0 +1,5 @@
module Foreman
VERSION = "0.12.0.pre1"
end

View File

@@ -25,9 +25,13 @@ application type.
The following options control how the application is run:
* `-s`, `--screen`:
Run the application as a series of screen windows rather than interleaved
in stdout.
* `-c`, `--concurrency`:
Specify the number of each process type to run. The value passed in
should be in the format `process=num,process=num`
* `-p`, `--port`:
Specify which port to use as the base for this application. Should be
a multiple of 1000.
## EXPORTING
@@ -47,6 +51,13 @@ The following options control how the application is run:
Specify the number of each process type to run. The value passed in
should be in the format `process=num,process=num`
* `-l`, `--log`:
Specify the directory to place process logs in.
* `-p`, `--port`:
Specify which port to use as the base for this application. Should be
a multiple of 1000.
* `-u`, `--user`:
Specify the user the application should be run as. Defaults to the
app name
@@ -55,18 +66,67 @@ The following options control how the application is run:
These options control all modes of foreman's operation.
* `-p`, `--procfile`
* `-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
application.
## EXPORT FORMATS
foreman currently supports the following output formats:
* json
* inittab
* upstart
## JSON EXPORT
Will export your processes as JSON:
{ "web": { "command": "bundle exec thin start" } }
## INITTAB EXPORT
Will export a chunk of inittab-compatible configuration:
# ----- 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 -----
## UPSTART EXPORT
Will create a series of upstart scripts in the location you specify. Scripts
will be structured to make the following commands valid:
`start appname`
`stop appname-processname`
`restart appname-processname-3`
## PROCFILE
A Procfile should contain both a name for the process and the command used
to run it.
web bundle exec thin start
job bundle exec rake jobs:work
web: bundle exec thin start
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
@@ -80,7 +140,7 @@ Export the application in upstart format:
Run one process type from the application defined in a specific Procfile:
$ foreman start alpha -p ~/app/Procfile
$ foreman start alpha -p ~/myapp/Procfile
## COPYRIGHT

View File

@@ -19,7 +19,7 @@ describe "Foreman::CLI" do
it "runs successfully" do
dont_allow(subject).error
mock.instance_of(Foreman::Engine).start
mock.instance_of(Foreman::Engine).start({})
subject.start
end
end
@@ -51,14 +51,34 @@ describe "Foreman::CLI" do
it "runs successfully" do
dont_allow(subject).error
mock.instance_of(Foreman::Export::Upstart).export("/tmp/foo", {
:concurrency => nil,
:name => nil
})
mock.instance_of(Foreman::Export::Upstart).export("/tmp/foo", {})
subject.export("upstart", "/tmp/foo")
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

View File

@@ -10,30 +10,54 @@ describe "Foreman::Engine" do
lambda { subject }.should raise_error
end
end
describe "with a Procfile" do
before { write_procfile }
it "reads the processes" do
write_procfile
subject.processes["alpha"].command.should == "./alpha"
subject.processes["bravo"].command.should == "./bravo"
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
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).watch_for_termination
subject.start(:concurrency => "alpha=2")
end
end
describe "execute" do
it "runs the processes" do
write_procfile
mock(subject).run(subject.processes["alpha"], false)
mock(subject).fork(subject.processes["alpha"], {})
mock(subject).watch_for_termination
subject.execute("alpha")
end
end

View File

@@ -26,8 +26,8 @@ end
def write_procfile(procfile="Procfile")
File.open(procfile, "w") do |file|
file.puts "alpha ./alpha"
file.puts "bravo ./bravo"
file.puts "alpha: ./alpha"
file.puts "bravo: ./bravo"
end
end