foreman-monit 1.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a95b4eeaf37f24b3bb61e14806dfd0103e352c07
-  data.tar.gz: 7567d088c18b44c5b0ba13b1c75031da1c04615d
+  metadata.gz: dae214da7d53772a0aa9d75be46ff2a6d5d8e37f
+  data.tar.gz: 2966aa3eaa93c4e9a07c18502fc055639cc86219
 SHA512:
-  metadata.gz: 5821a7ee7e2b0b8933b6605e535be2cd44c2aa1d527d492f63e97818d7f0f8f9dfbadc4631ed17549dc5370d97efc9f5a82351da6f0922044fd2aa78e3ef448a
-  data.tar.gz: 7ffafa7c9f79bb280fa0f944220272000380f7f3f4dc21bde7f3883d4bd64f86f5375cf2978e6dc06fd82bbd0abb90c7067efed031eed3e2784793653b99ab8f
+  metadata.gz: 36dae762cbd692eb4c5f3bb79f8b8a29791c6c29d7d759480e366a44ef8181f8e46617c936748593b142d86bdc1728f5ddc7612e4e05fa532913e2c7e969ffb1
+  data.tar.gz: 2ebbae052262822fe76e4e74e7a3162bba133c8636d73d66e147b6b03eaaa993e3ed7abcace722554115ab3773f63bebf69c882be8391258174833faf6067da7

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/README.md

@@ -7,6 +7,8 @@ Small command-line too to export from Procfile to monit control files
 Add this line to your application's Gemfile:
 
     gem 'foreman-monit', github: 'capita/foreman-monit'
+    or
+    gem 'foreman-monit, '~> v1.0.1'
 
 And then execute:
 
@@ -19,8 +21,10 @@ has to be called from the projects root directory and outputs to /tmp/foreman-mo
 via Capistrano to automate restarting of processes or changing the processes configuration/definition after or inside
 your deployment routine
 
-You have to provide --user, --env, [--chruby] and --app to specify the user that will be running the processes, the RAILS_ENV
-to use an a general application-indentifier to name control files and groups accordingly.
+You have to provide --user, --env and --app to specify the user that will be running the processes, the RAILS_ENV
+to use an a general application-indentifier to name control files and groups accordingly. Additional parameters
+are --target, which specifies a non-default directory to store the control files in, and --procfile if your Procfile
+resides outside of the directory you call foreman-monit from.
 
 Inside your procfile, you can use PORT, PID_FILE and RAILS_ENV in your process command, e.g.
 
@@ -29,7 +33,13 @@ Inside your procfile, you can use PORT, PID_FILE and RAILS_ENV in your process c
 
 Monit will fork the command in a shell for the specified user and will redirect each output to ./<target>/<app>-<process>.log
 
-Just include the directory ./monit/*.conf (or whatever you chose as a target) in your global monitrc and do a 'monit reload'
+Include the newly exported control files in your monitrc (which normally resides in /etc/monit/monitrc or /etc/monit) with
+a
+    include /tmp/foreman-monit/*.conf
+    or
+    include /your/path/to/foreman-monit/*.conf
+
+and simply reload/restart monit with /etc/init.d/monit reload (or restart)
 
 You can start or stop the app's jobs by issuing
 

data/Rakefile

@@ -1 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/foreman-monit.gemspec

@@ -4,18 +4,19 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'foreman-monit/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "foreman-monit"
+  gem.name          = 'foreman-monit'
   gem.version       = Foreman::Monit::VERSION
-  gem.authors       = ["Sebastian Georgi"]
-  gem.email         = ["sgeorgi@capita.de"]
+  gem.authors       = ['Sebastian Georgi']
+  gem.email         = %w(sgeorgi@capita.de)
   gem.description   = %q{Outputs bash-wrapped launchers and control files for monit}
   gem.summary       = %q{...}
-  gem.homepage      = ""
+  gem.homepage      = ''
 
   gem.files         = `git ls-files`.split($/)
   gem.add_dependency('foreman')
   gem.add_dependency('thor')
+  gem.add_development_dependency('rspec')
   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.require_paths = %w(lib)
 end

data/lib/foreman-monit/cli.rb

@@ -10,6 +10,7 @@ module ForemanMonit
 
     method_option 'app', :type => :string, :required => true
     method_option 'user', :type => :string, :required => true
+    method_option 'procfile', :type => :string, :default => 'Procfile'
     method_option 'target', :type => :string, :default => '/tmp/foreman-monit'
     method_option 'env', :type => :string, :required => true
     method_option 'chruby', :type => :string, :required => false

data/lib/foreman-monit/exporter.rb

@@ -1,4 +1,4 @@
-require "foreman/engine"
+require 'foreman/engine'
 require 'fileutils'
 
 module ForemanMonit
@@ -9,6 +9,10 @@ module ForemanMonit
       @target = options[:target]
       @env = options[:env]
       @chruby = options[:chruby]
+      @procfile = options[:procfile]
+
+      @su = which_su
+      @bash = which_bash
 
       @engine = Foreman::Engine.new
       load_procfile
@@ -21,7 +25,7 @@ module ForemanMonit
       FileUtils.rm Dir.glob("#{@target}/*.conf")
       @engine.each_process do |name, process|
         file_name = File.join(@target, "#{@app}-#{name}.conf")
-        File.open(file_name, 'w') { |f| f.write ERB.new(File.read(File.expand_path("../../../templates/monitrc.erb", __FILE__))).result(binding) }
+        File.open(file_name, 'w') { |f| f.write ERB.new(File.read(File.expand_path('../../../templates/monitrc.erb', __FILE__))).result(binding) }
       end
     end
 
@@ -60,13 +64,21 @@ module ForemanMonit
 
     private
 
+    def which_su
+      `which su`.chomp
+    end
+
+    def which_bash
+      `which bash`.chomp
+    end
+
     def load_env
-      default_env = File.join(@engine.root, ".env")
+      default_env = File.join(@engine.root, '.env')
       @engine.load_env default_env if File.exists?(default_env)
     end
 
     def load_procfile
-      @engine.load_procfile('Procfile')
+      @engine.load_procfile(@procfile)
     end
   end
 end

data/lib/foreman-monit/version.rb

@@ -1,5 +1,5 @@
 module Foreman
   module Monit
-    VERSION = "1.0"
+    VERSION = '1.0.2'
   end
 end

data/spec/Procfile

@@ -0,0 +1,3 @@
+# THIS IS ONLY USED FOR RSPEC!!!
+web: bin/puma -p $PORT --pidfile $PID_FILE -t 4:32
+worker: bin/rake resque:work PIDFILE=$PID_FILE

data/spec/lib/foreman-monit/exporter_spec.rb

@@ -0,0 +1,102 @@
+require File.join(File.dirname(__FILE__), '../../spec_helper')
+
+describe ForemanMonit::Exporter do
+  let(:app) { 'FM' }
+  let(:env) { 'production' }
+  let(:user) { 'foreman-user' }
+  let(:target) { '../../tmp' }
+  let(:chruby) {}
+  let(:procfile) { File.join(File.dirname(__FILE__), '../../Procfile') }
+
+  let(:exporter) do
+    ForemanMonit::Exporter.new(app: app, env: env, user: user, target: target, chruby: chruby, procfile: procfile)
+  end
+
+
+  describe '#run!' do
+    before(:each) { exporter.run! }
+
+    it 'creates the target directory' do
+      expect(Dir.exists?('../../tmp')).to be == true
+    end
+
+    it 'exports the control file for Procfile#web' do
+      expect(File.exists?('../../tmp/FM-web.conf'))
+    end
+
+    it 'exports the control file for Procfile#worker' do
+      expect(File.exists?('../../tmp/FM-worker.conf'))
+    end
+  end
+
+  describe '#info' do
+    it 'shows the Procfiles entries' do
+      pending 'Either stub out Kernel.puts or make STDOUT go to a local string for comparison'
+    end
+
+  end
+
+  describe '#port' do
+    it 'returns an incrementing port number' do
+      expect(exporter.port).to be == 5000
+      expect(exporter.port).to be == 5001
+      expect(exporter.port).to be == 5002
+    end
+
+  end
+
+  describe '#chruby_init' do #
+    context 'without @chruby defined' do
+      it 'returns an empty string' do
+        expect(exporter.chruby_init).to be == ''
+      end
+    end
+
+    context 'with @chruby defined' do
+      let(:chruby) { '2.0.0-p247' }
+
+      it 'returns a chruby prefix' do
+        expect(exporter.chruby_init).to be == 'chruby 2.0.0-p247 &&'
+      end
+    end
+
+  end
+
+  describe '#base_dir' do
+    it 'returns the current base directory' do
+      expect(exporter.base_dir).to be == Dir.getwd
+    end
+  end
+
+  describe '#log_file' do
+    it 'returns the log file for a given Procfile entry' do
+      name = 'my_test_app'
+      expect(exporter.log_file(name)).to be == File.expand_path(File.join(target, "#{app}-#{name}.log"))
+    end
+  end
+
+  describe '#pid_file' do
+    it 'returns the pid file for a given Procfile entry' do
+      name = 'my_test_app'
+      expect(exporter.pid_file(name)).to be == File.expand_path(File.join(target, "#{app}-#{name}.pid"))
+    end
+  end
+
+  describe '#rails_env' do
+    it 'returns the given env' do
+      expect(exporter.rails_env).to be == 'production'
+    end
+  end
+
+  describe '##which_su' do
+    it 'returns the path to the su binary' do
+      expect(exporter.send(:which_su)).to be == `which su`.chomp
+    end
+  end
+
+  describe '##which_bash' do
+    it 'returns the path to the bash binary' do
+      expect(exporter.send(:which_bash)).to be == `which bash`.chomp
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'foreman-monit'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.before(:suite) do
+    FileUtils.rm_rf(File.join(File.dirname(__FILE__), 'tmp'))
+  end
+end

data/templates/monitrc.erb

@@ -1,5 +1,5 @@
 check process <%= @app %>-<%= name %> with pidfile <%= pid_file(name) %>
-  start program "`which su` <%= @user %> -l -c '<%= chruby_init %> cd <%= base_dir %>; export PORT=<%= port %>; export PID_FILE=<%= pid_file(name) %>; export RAILS_ENV=<%= rails_env %>; <%= process.command %> >> <%= log_file(name) %> 2>&1 &'" with timeout 180 seconds
-  stop program = "`which bash` -c 'kill -SIGKILL `cat <%= pid_file(name) %>` && rm <%= pid_file(name) %>'"
+  start program "<%= @su %> <%= @user %> -l -c '<%= chruby_init %> cd <%= base_dir %>; export PORT=<%= port %>; export PID_FILE=<%= pid_file(name) %>; export RAILS_ENV=<%= rails_env %>; <%= process.command %> >> <%= log_file(name) %> 2>&1 &'" with timeout 180 seconds
+  stop program = "<%= @bash %> -c 'kill -SIGKILL `cat <%= pid_file(name) %>` && rm <%= pid_file(name) %>'"
   group <%= @app %>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-monit
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.2
 platform: ruby
 authors:
 - Sebastian Georgi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-22 00:00:00.000000000 Z
+date: 2013-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreman
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Outputs bash-wrapped launchers and control files for monit
 email:
 - sgeorgi@capita.de
@@ -47,6 +61,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .ruby-version
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -57,6 +73,9 @@ files:
 - lib/foreman-monit/cli.rb
 - lib/foreman-monit/exporter.rb
 - lib/foreman-monit/version.rb
+- spec/Procfile
+- spec/lib/foreman-monit/exporter_spec.rb
+- spec/spec_helper.rb
 - templates/monitrc.erb
 homepage: ''
 licenses: []
@@ -81,5 +100,8 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: '...'
-test_files: []
+test_files:
+- spec/Procfile
+- spec/lib/foreman-monit/exporter_spec.rb
+- spec/spec_helper.rb
 has_rdoc: