foreman_god 0.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.iml
+*.ipr
+*.iws
+.rakeTasks
+*.log

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+bundler_args: --without development
+script: "bundle exec rspec"
+env:
+  - CI=true
+rvm:
+  - 1.9.2
+  - 1.9.3
+notifications:
+  recipients:
+    - ralf@embarkmobile.com

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in foreman_god.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'capistrano'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Embark Mobile
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# ForemanGod
+
+God configuration with Procfiles.
+
+## Installation
+
+    $ gem install foreman_god
+
+## Usage
+
+To run the sample:
+
+    god -D -c sample.god
+
+Or with your own Procfile, add the following to your god configuration file:
+
+    require 'foreman_god'
+
+    ForemanGod.watch File.dirname(__FILE__) # Or an absolute path to the folder containing the Procfile
+
+To set environment variables, add an .env file in next to the Procfile.
+
+To specify foreman options, add a .foreman file next to the Procfile.
+
+See samples/configuration for a complete example.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/foreman_god.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'foreman_god/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "foreman_god"
+  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.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'foreman'
+  gem.add_dependency 'god'
+end

data/lib/foreman_god.rb

@@ -0,0 +1,25 @@
+require "foreman_god/version"
+require "foreman_god/god_config"
+
+module ForemanGod
+
+  # ForemanGod.watch File.dirname(__FILE__) => calls God.watch with the Procfile in the current file's folder
+  # ForemanGod.watch '/var/www/*/current/' => watch all folders matching the glob which contain either a .foreman file or a
+  #   Procfile.
+  def self.watch glob
+    # We append a backslash so that only folders are matched
+    glob += '/' unless glob.end_with? '/'
+    Dir[glob].each do |d|
+      if File.exists?(File.join(d, 'Procfile')) || File.exists?(File.join(d, '.foreman'))
+        watch_dir d
+      end
+    end
+  end
+
+  def self.watch_dir dir
+    config = GodConfig.new(dir)
+    config.watch
+    config
+  end
+end
+

data/lib/foreman_god/god_config.rb

@@ -0,0 +1,157 @@
+require 'pathname'
+require 'yaml'
+require 'foreman'
+require 'foreman/engine'
+require 'thor/core_ext/hash_with_indifferent_access'
+require 'god'
+require 'foreman_god'
+
+module God
+  module Conditions
+    # Adapted from https://gist.github.com/571095
+    class ForemanRestartFileTouched < PollCondition
+      attr_accessor :restart_file
+
+      def initialize
+        super
+      end
+
+      def process_start_time
+        Time.parse(`ps -o lstart= -p #{self.watch.pid}`)
+      end
+
+      def restart_file_modification_time
+        File.mtime(self.restart_file) rescue Time.at(0)
+      end
+
+      def valid?
+        valid = true
+        valid &= complain("Attribute 'restart_file' must be specified", self) if self.restart_file.nil?
+        valid
+      end
+
+      def test
+        process_start_time < restart_file_modification_time
+      end
+    end
+  end
+end
+
+
+module ForemanGod
+  class GodConfig
+    attr_reader :dir_name, :options, :engine
+
+    def initialize dir
+      @dir_name = File.basename(File.absolute_path(dir))
+
+      options_file = File.join(dir, ".foreman")
+      temp_options = {}
+      temp_options = (::YAML::load_file(options_file) || {}) if File.exists? options_file
+      @options = Thor::CoreExt::HashWithIndifferentAccess.new(temp_options)
+
+
+      @engine = Foreman::Engine.new(@options)
+
+      if @options[:env]
+        @options[:env].split(",").each do |file|
+          @engine.load_env file
+        end
+      else
+        default_env = File.join(dir, ".env")
+        @engine.load_env default_env if File.exists?(default_env)
+      end
+
+      @engine.load_procfile(File.join(dir, "Procfile"))
+    end
+
+    def app_name
+      @options[:app] || @dir_name
+    end
+
+    def user_name
+      @options[:user]
+    end
+
+    def log_path
+      @options[:log] || 'log'
+    end
+
+    def watch_process(name, process, n)
+      port = @engine.port_for(process, n)
+      base_env = process.instance_variable_get(:@options)[:env]
+      env = base_env.merge({'PORT' => port.to_s})
+
+      God.watch do |w|
+        w.dir = process.cwd
+        w.name = "#{app_name}-#{name}-#{n}"
+        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")
+        else
+          LOG.warn "Log path does not exist: #{log}"
+        end
+
+        w.uid = user_name if user_name
+        # w.gid = ?
+
+        w.transition(:up, :restart) do |on|
+          on.condition(:memory_usage) do |c|
+            c.above = 350.megabytes
+            c.times = 2
+          end
+
+          on.condition(:foreman_restart_file_touched) do |c|
+            c.interval = 5.seconds
+            # Should we make this path configurable?
+            c.restart_file = File.join(process.cwd, 'tmp', 'restart.txt')
+          end
+        end
+
+        # determine the state on startup
+        w.transition(:init, { true => :up, false => :start }) do |on|
+          on.condition(:process_running) do |c|
+            c.running = true
+          end
+        end
+
+        # determine when process has finished starting
+        w.transition([:start, :restart], :up) do |on|
+          on.condition(:process_running) do |c|
+            c.running = true
+            c.interval = 5.seconds
+          end
+
+          # failsafe
+          on.condition(:tries) do |c|
+            c.times = 5
+            c.transition = :start
+            c.interval = 5.seconds
+          end
+        end
+
+        # start if process is not running
+        w.transition(:up, :start) do |on|
+          on.condition(:process_running) do |c|
+            c.running = false
+          end
+        end
+
+      end
+    end
+
+    def watch
+      @engine.each_process do |name, process|
+        1.upto(@engine.formation[name]) do |n|
+          watch_process name, process, n
+        end
+      end
+    end
+  end
+end
+
+

data/lib/foreman_god/version.rb

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

data/sample.god

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

data/samples/configuration/.env

@@ -0,0 +1,2 @@
+MY_VAR=12345
+ANOTHER_VAR=yes

data/samples/configuration/.foreman

@@ -0,0 +1,4 @@
+formation: loop=1,another=2
+app: configured-app
+user: test
+log: .

data/samples/configuration/Procfile

@@ -0,0 +1,2 @@
+loop: ruby ../simple_loop.rb -p $PORT
+another:  ruby ../simple_loop.rb

data/samples/simple/Procfile

@@ -0,0 +1 @@
+loop: ruby ../simple_loop.rb -p $PORT

data/samples/simple_loop.rb

@@ -0,0 +1,8 @@
+puts "Starting simple loop"
+begin
+  while true
+    sleep 1
+  end
+rescue Exception => e
+  puts "Terminated loop with #{e.inspect}"
+end

data/spec/god_config_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+require 'foreman_god/god_config'
+require 'god'
+require 'etc'
+
+describe GodConfig do
+  context "simple" do
+    let(:config) { GodConfig.new(sample('simple')) }
+
+    it "should load basic properties" do
+      config.dir_name.should == 'simple'
+      config.app_name.should == 'simple'
+      config.user_name.should == nil
+      config.options.should == {}
+    end
+
+    it "should watch" do
+      config.watch
+      God.watches.values.count.should == 1
+      watch = God.watches.values.first
+      watch.should be
+
+      File.absolute_path(watch.dir).should == sample('simple')
+      watch.name.should == 'simple-loop-1'
+      watch.group.should == 'simple'
+      watch.interval.should == 60.seconds
+      watch.env.should == {'PORT' => '5000'}
+      watch.start.should == 'ruby ../simple_loop.rb -p 5000'
+      watch.log.should == '/dev/null'
+      watch.uid.should == nil
+
+    end
+
+    it "should log if log is specified" do
+      begin
+        FileUtils.mkdir 'samples/simple/log'
+        config.watch
+        watch = God.watches.values.first
+        watch.log.should == File.absolute_path('samples/simple/log/simple-loop-1.log')
+      ensure
+        FileUtils.rm_rf 'samples/simple/log'
+      end
+    end
+
+  end
+
+  context "configuration" do
+    let(:config) { GodConfig.new(sample('configuration')) }
+    let(:user) { Etc.getlogin }
+
+    it "should load basic properties" do
+      config.dir_name.should == 'configuration'
+      config.app_name.should == 'configured-app'
+      config.user_name.should == 'test'
+      config.options.should ==  {"formation"=>"loop=1,another=2", "app"=>"configured-app", "user"=>"test", "log" => "."}
+    end
+
+    it "should watch" do
+      config.options["user"] = user # We need to override the user to the current user, otherwise god will fail
+
+      config.watch
+      God.watches.values.count.should == 3
+      watch = God.watches.values.first
+      watch.should be
+
+      File.absolute_path(watch.dir).should == sample('configuration')
+      watch.name.should == 'configured-app-loop-1'
+      watch.group.should == 'configured-app'
+      watch.interval.should == 60.seconds
+      watch.env.should == {'PORT' => '5000', 'MY_VAR' => '12345', 'ANOTHER_VAR' => 'yes'}
+      watch.start.should == 'ruby ../simple_loop.rb -p 5000'
+      watch.log.should == File.absolute_path('samples/configuration/configured-app-loop-1.log')
+      watch.uid.should == user
+    end
+  end
+
+  it "should glob" do
+    # This should match spec/simple
+    ForemanGod.watch 'spec/*'
+    God.watches.values.count.should == 1
+  end
+
+end

data/spec/integration_spec.rb

@@ -0,0 +1,35 @@
+# Run god and test it
+require 'spec_helper'
+
+OPTIONS = "-p 13985 -P spec/tmp/god.pid -l #{LOG_FILE} --no-syslog"
+
+describe "god" do
+  after do
+    `god #{OPTIONS} terminate`
+    FileUtils.rm_rf 'spec/simple/tmp'
+  end
+
+  it "should run and terminate a script" do
+    `god #{OPTIONS} --attach #{Process.pid} -c spec/simple/simple.god`
+    sleep 1
+    `god #{OPTIONS} terminate`
+
+    File.read('spec/tmp/test-simple-loop-1.log').should == "Starting simple loop\nTerminated loop with #<SignalException: SIGTERM>\n"
+  end
+
+  it "should restart a script on file touch" do
+    `god #{OPTIONS} --attach #{Process.pid} -c spec/simple/simple.god`
+
+    sleep 1
+
+    FileUtils.mkdir_p 'spec/simple/tmp'
+    FileUtils.touch 'spec/simple/tmp/restart.txt'
+
+    sleep 6 # Currently the file is checked every 5 seconds
+
+    `god #{OPTIONS} terminate`
+
+    File.read('spec/tmp/test-simple-loop-1.log').should == "Starting simple loop\nTerminated loop with #<SignalException: SIGTERM>\n"*2
+  end
+end
+

data/spec/simple/.foreman

@@ -0,0 +1,2 @@
+app: test-simple
+log: ../tmp

data/spec/simple/Procfile

@@ -0,0 +1 @@
+loop: ruby simple_loop.rb -p $PORT

data/spec/simple/simple.god

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

data/spec/simple/simple_loop.rb

@@ -0,0 +1,8 @@
+puts "Starting simple loop"
+begin
+  while true
+    sleep 1
+  end
+rescue Exception => e
+  puts "Terminated loop with #{e.inspect}"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+require 'rspec'
+$load_god = true
+require 'god'
+require 'foreman_god'
+
+LOG_FILE = 'god.log'
+FileUtils.rm_f LOG_FILE
+
+Object.send(:remove_const, :LOG)
+LOG = God::Logger.new(File.open(LOG_FILE, 'w'))
+
+include ForemanGod
+
+def sample(name)
+  File.absolute_path(File.join(File.dirname(__FILE__), '..', 'samples', name))
+end
+
+
+module God
+
+  def self.reset
+    self.watches = nil
+    self.groups = nil
+    self.server = nil
+    self.inited = nil
+    self.host = nil
+    self.port = nil
+    self.pid_file_directory = File.join(File.dirname(__FILE__), 'tmp')
+    self.registry.reset
+  end
+end
+
+
+RSpec.configure do |config|
+  #Other config stuff goes here
+
+  # Clean/Reset God's state prior to running the tests
+  config.before :each do
+    God.reset
+    FileUtils.rm_rf 'spec/tmp'
+    FileUtils.mkdir_p 'spec/tmp'
+  end
+
+  config.after :each do
+    FileUtils.rm_rf 'spec/tmp'
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: foreman_god
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ralf Kistner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: foreman
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: god
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: God configuration with Procfiles
+email:
+- ralf@embarkmobile.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- foreman_god.gemspec
+- lib/foreman_god.rb
+- lib/foreman_god/god_config.rb
+- lib/foreman_god/version.rb
+- sample.god
+- samples/configuration/.env
+- samples/configuration/.foreman
+- samples/configuration/Procfile
+- samples/simple/Procfile
+- samples/simple_loop.rb
+- spec/god_config_spec.rb
+- spec/integration_spec.rb
+- spec/simple/.foreman
+- spec/simple/Procfile
+- spec/simple/simple.god
+- spec/simple/simple_loop.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Configure God using foreman-style Procfiles.
+test_files:
+- spec/god_config_spec.rb
+- spec/integration_spec.rb
+- spec/simple/.foreman
+- spec/simple/Procfile
+- spec/simple/simple.god
+- spec/simple/simple_loop.rb
+- spec/spec_helper.rb
+has_rdoc: