deprecate colon-less syntax, add check command

This commit is contained in:
David Dollar
2011-01-27 16:14:43 -08:00
parent 977c80ffdd
commit 6b7d5e5161
9 changed files with 73 additions and 6 deletions
+1 -1
View File
@@ -25,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'
+2 -2
View File
@@ -1,2 +1,2 @@
ticker ./ticker $PORT
error ./error
ticker: ./ticker $PORT
error : ./error
+2
View File
@@ -0,0 +1,2 @@
ticker ./ticker $PORT
error ./error
+12
View File
@@ -48,6 +48,14 @@ class Foreman::CLI < Thor
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!
@@ -64,6 +72,10 @@ private ######################################################################
private ######################################################################
def display(message)
puts message
end
def error(message)
puts "ERROR: #{message}"
exit 1
+13 -1
View File
@@ -25,7 +25,11 @@ class Foreman::Engine
@order = []
procfile.split("\n").inject({}) do |hash, line|
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.color = next_color
@order << process.name
@@ -178,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
+4
View File
@@ -115,6 +115,10 @@ to run it.
web: bundle exec thin start
job: bundle exec rake jobs:work
You can validate your Procfile format using the `check` command
$ foreman check
## EXAMPLES
Start one instance of each process type, interleave the output on stdout:
+23
View File
@@ -58,4 +58,27 @@ describe "Foreman::CLI" do
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
+15 -1
View File
@@ -12,12 +12,26 @@ describe "Foreman::Engine" do
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
+1 -1
View File
@@ -26,7 +26,7 @@ end
def write_procfile(procfile="Procfile")
File.open(procfile, "w") do |file|
file.puts "alpha ./alpha"
file.puts "alpha: ./alpha"
file.puts "bravo: ./bravo"
end
end