foreman_god 0.0.1 → 0.0.2

data/README.md

@@ -1,9 +1,11 @@
 # ForemanGod
 
-God configuration with Procfiles.
+Monitor Procfiles with [God](http://godrb.com/).
 
 ## Installation
 
+Install the gem on the machine running god - there is no need to include it as a dependency in your project.
+
     $ gem install foreman_god
 
 ## Usage
@@ -24,6 +26,50 @@ To specify foreman options, add a .foreman file next to the Procfile.
 
 See samples/configuration for a complete example.
 
+### Restarting workers
+
+If present, the `tmp/restart.txt` file in your project is watched for changes. If this file is modified, for example
+with `touch tmp/restart.txt`, all workers are restarted.
+
+### Reloading the Procfile
+
+When the Procfile (or .env or .foreman files) changed, use `god load <god config> stop` to reload the config files.
+The `stop` action tells god to stop any processes that were removed from the Procfile (available since god 0.12.0,
+but not documented at the time of writing).
+
+### RVM
+
+To run god itself with RVM, use a wrapper script as explained at [https://rvm.io/integration/god/](https://rvm.io/integration/god/).
+
+Using RVM is tricky when running God as root. Often you would want to run the commands in a different environment from
+god (different user, different Ruby, different gems, etc).
+
+The simplest way to tell ForemanGod to run your processes with RVM, is to specify `rvm: default` in your .foreman config
+file. This tells ForemanGod to use the "default" Ruby version to run the script. Alternatively you can specify a
+specific ruby version or gemset, for example `rvm: ruby-1.9.3-p194` or `rvm: ruby-1.9.3-p194@global`.
+
+Technically this loads the environment for the ruby/gemset version, which is found in either `~/.rvm/environments/<version>`
+or `/usr/local/rvm/<version>`. This is similar to the approach for [Cron scripts](https://rvm.io/integration/cron/).
+
+### Capistrano
+
+On each deployment, God needs to reload the configuration. Restarting of the processes happen with the `tmp/restart.txt`
+solution explained earlier, which you already do if you're using Passenger.
+
+Use a task like the following to reload the configuration (see *Reloading the Procfile* above):
+
+    namespace :god do
+      task :reload do
+        # Replace the god command and config file here with the ones used on your server
+        run("god load /etc/god/master.god stop")
+      end
+    end
+
+    before "deploy:restart", "god:reload"
+
+
+
+
 ## Contributing
 
 1. Fork it

data/foreman_god.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = ForemanGod::VERSION
   gem.authors       = ["Ralf Kistner"]
   gem.email         = ["ralf@embarkmobile.com"]
-  gem.description   = %q{God configuration with Procfiles}
-  gem.summary       = %q{Configure God using foreman-style Procfiles.}
+  gem.description   = %q{Monitor Procfiles with God. Mostly compatible with foreman.}
+  gem.summary       = %q{Monitor Procfiles with God}
   gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($/)
@@ -17,6 +17,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'foreman'
-  gem.add_dependency 'god'
+  gem.add_dependency 'foreman', '~> 0.60.2'
+  gem.add_dependency 'god', '>= 0.12.0'
 end

data/lib/foreman_god/god_config.rb

@@ -17,7 +17,7 @@ module God
       end
 
       def process_start_time
-        Time.parse(`ps -o lstart= -p #{self.watch.pid}`)
+        Time.parse(`ps -o lstart= -p #{self.watch.pid}`) rescue nil
       end
 
       def restart_file_modification_time
@@ -31,7 +31,12 @@ module God
       end
 
       def test
-        process_start_time < restart_file_modification_time
+        ptime = process_start_time
+        if ptime
+          process_start_time < restart_file_modification_time
+        else
+          false
+        end
       end
     end
   end
@@ -44,6 +49,9 @@ module ForemanGod
 
     def initialize dir
       @dir_name = File.basename(File.absolute_path(dir))
+      if @dir_name == 'current'
+        @dir_name = File.basename(File.dirname(File.absolute_path(dir)))
+      end
 
       options_file = File.join(dir, ".foreman")
       temp_options = {}
@@ -77,6 +85,34 @@ module ForemanGod
       @options[:log] || 'log'
     end
 
+
+    def wrap_command(cmd)
+      if user_name
+        user_home = File.join('/home', user_name)
+      else
+        user_home = Dir.home
+      end
+      local_rvm_version = @options[:user_rvm]
+      system_rvm_version = @options[:system_rvm]
+      auto_rvm = @options[:rvm]
+      if auto_rvm
+        if File.directory? File.join(user_home, '.rvm', 'environments')
+          local_rvm_version = auto_rvm
+        elsif File.directory? '/usr/local/rvm/environments'
+          system_rvm_version = auto_rvm
+        end
+      end
+      if local_rvm_version
+        rvm_env = File.join(user_home, '.rvm', 'environments', local_rvm_version)
+        ". #{rvm_env} && exec #{cmd}"
+      elsif system_rvm_version
+        rvm_env = File.join('/usr/local/rvm/environments', system_rvm_version)
+        ". #{rvm_env} && exec #{cmd}"
+      else
+        cmd
+      end
+    end
+
     def watch_process(name, process, n)
       port = @engine.port_for(process, n)
       base_env = process.instance_variable_get(:@options)[:env]
@@ -88,7 +124,6 @@ module ForemanGod
         w.group = app_name
         w.interval = 60.seconds
         w.env = env
-        w.start = process.expanded_command(env)
         log = File.expand_path(log_path, process.cwd)
         if File.directory? log
           w.log = File.join(log, "#{app_name}-#{name}-#{n}.log")
@@ -96,7 +131,10 @@ module ForemanGod
           LOG.warn "Log path does not exist: #{log}"
         end
 
+        w.start = wrap_command(process.expanded_command(env))
+
         w.uid = user_name if user_name
+
         # w.gid = ?
 
         w.transition(:up, :restart) do |on|

data/lib/foreman_god/version.rb

@@ -1,3 +1,3 @@
 module ForemanGod
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/samples/rvm/.foreman

@@ -0,0 +1,7 @@
+log: .
+user: test
+# This looks for rvm in /home/user/.rvm and /usr/local/rvm. If it does not find it, system Ruby is used.
+rvm: default
+# Some alternatives:
+#  user_rvm: ruby-1.9.3-p194 # or default
+#  system_rvm: default # or any specific ruby version

data/samples/rvm/Procfile

@@ -0,0 +1 @@
+loop: bundle exec ruby ../simple_loop.rb

data/samples/rvm/rvm.god

@@ -0,0 +1,3 @@
+require 'foreman_god'
+
+ForemanGod.watch File.dirname(__FILE__)

data/samples/simple_loop.rb

@@ -1,4 +1,5 @@
 puts "Starting simple loop"
+
 begin
   while true
     sleep 1

data/spec/god_config_spec.rb

@@ -80,4 +80,9 @@ describe GodConfig do
     God.watches.values.count.should == 1
   end
 
+  it "should not use 'current' for the app name" do
+    FileUtils.mkdir_p 'spec/tmp/test/current'
+    FileUtils.touch 'spec/tmp/test/current/Procfile'
+    GodConfig.new('spec/tmp/test/current').app_name.should == 'test'
+  end
 end

data/spec/spec_helper.rb

@@ -43,5 +43,6 @@ RSpec.configure do |config|
 
   config.after :each do
     FileUtils.rm_rf 'spec/tmp'
+    FileUtils.rm_rf 'spec/simple/tmp'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_god
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -16,17 +16,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.60.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.60.2
 - !ruby/object:Gem::Dependency
   name: god
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,8 +42,8 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-description: God configuration with Procfiles
+        version: 0.12.0
+description: Monitor Procfiles with God. Mostly compatible with foreman.
 email:
 - ralf@embarkmobile.com
 executables: []
@@ -64,6 +64,9 @@ files:
 - samples/configuration/.env
 - samples/configuration/.foreman
 - samples/configuration/Procfile
+- samples/rvm/.foreman
+- samples/rvm/Procfile
+- samples/rvm/rvm.god
 - samples/simple/Procfile
 - samples/simple_loop.rb
 - spec/god_config_spec.rb
@@ -96,7 +99,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Configure God using foreman-style Procfiles.
+summary: Monitor Procfiles with God
 test_files:
 - spec/god_config_spec.rb
 - spec/integration_spec.rb