rhapr 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+-cfs

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in rhapr.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+
+require 'rspec'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task :release => :spec
+
+desc 'Run Specs'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern    = 'spec/**/*_spec.rb'
+  spec.verbose    = true
+  spec.rspec_opts = ['--color']
+end

data/bin/rhapr

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'rhapr'

data/lib/rhapr.rb

@@ -0,0 +1,6 @@
+require 'rhapr/version'
+require 'rhapr/environment'
+
+module Rhapr
+  # Your code goes here...
+end

data/lib/rhapr/environment.rb

@@ -0,0 +1,87 @@
+module Rhapr
+  module Environment
+    attr_accessor :haproxy_pid, :config_path, :config, :exec
+
+    # @return [String] The path to the HAProxy configuration file. Set the ENV variable $HAPROXY_CONFIG to override defaults
+    def config_path
+      return(@config_path) if @config_path
+
+      if ENV['HAPROXY_CONFIG']
+        @config_path = ENV['HAPROXY_CONFIG']
+      else
+        %w{/etc/haproxy/haproxy.cfg /etc/haproxy.cfg /usr/local/etc/haproxy.cfg}.each {|cfg|
+          next unless File.exists?(cfg)
+
+          @config_path = cfg
+        }
+      end
+
+      return(@config_path)
+    end
+
+    # @return [String] The raw contents of the HAProxy configuration file.
+    def config
+      @config ||= begin
+                    File.read(config_path)
+                  rescue Errno::ENOENT => e
+                    raise RuntimeError.new("Error openning file '#{config_path}'. Exception from File.read: #{e.exception}")
+                  end
+    end
+
+    # @return [true, false] Whether or not the HAProxy executable can be found.
+    # @see Rhapr::Environment#exec
+    def has_exec?
+      !exec.nil?
+    end
+
+    # @return [String, nil] The path to the HAProxy executable will be returned, if found. Set ENV variable $HAPROXY_BIN to override
+    def exec
+      return(@exec) if @exec
+
+      @exec   = ENV['HAPROXY_BIN']
+      @exec ||= `which haproxy`
+
+      if @exec.empty?
+        begin
+          `haproxy -v`
+          @exec = 'haproxy'
+        rescue Errno::ENOENT => e
+          @exec = nil
+        end
+      end
+
+      return(@exec)
+    end
+
+    # @return [String] The path to the HAProxy stats socket.
+    # @raise [RuntimeError] Raised if no stats socket has been specified, in the HAProxy configuration.
+    # @todo: Should there be an ENV var for this? Perhaps allow config-less runs of rhapr?
+    def socket
+      @socket ||= begin
+                    config.match /stats\s+socket\s+([^\s]*)/
+                    $1 || raise(RuntimeError.new "Expecting 'stats socket <UNIX_socket_path>' in #{config_path}")
+                  end
+    end
+
+    # @return [String] Returns the path to the pidfile, specified in the HAProxy configuration. Returns an assumption, if not found.
+    # @todo: Should there even be an assumption? Does HAProxy create a pid file, if not told to by the configuration?
+    # @todo: Should there be an ENV var for this? Perhaps allow config-less runs of rhapr?
+    def pid
+      @pid  ||= begin
+                  config.match /pidfile ([^\s]*)/
+                  @pid = $1 || '/var/run/haproxy.pid'
+                end
+    end
+
+    # @return [String, nil] Returns the PID of HAProxy as a string, if running. Nil otherwise.
+    # @todo: Look for something other than pidof, for searching the process list.
+    #   Could read from the pid file, but there's potential that it will go stale.
+    def check_running
+      pidof = `pidof haproxy`
+      pidof.strip!
+
+      return pidof unless pidof.empty?
+    end
+    alias :pidof :check_running
+  end
+end

data/lib/rhapr/version.rb

@@ -0,0 +1,3 @@
+module Rhapr
+  VERSION = '0.0.1'
+end

data/rhapr.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'rhapr/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'rhapr'
+  s.version     = Rhapr::VERSION
+  s.authors     = ['Scott Gonyea']
+  s.email       = ['me@sgonyea.com']
+  s.homepage    = 'https://github.com/sgonyea/rhapr'
+  s.summary     = %q{Rhapr wraps around HAProxy}
+  s.description = %q{Rhapr is a ruby lib that wraps around HAProxy, enabling you to sanely decomission a process.}
+
+  s.add_dependency 'yard', '~>0.6'
+
+  s.add_development_dependency 'rspec', '~>2.4'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/spec/config_fixtures/basic_haproxy.cfg

@@ -0,0 +1,6 @@
+global
+    daemon
+    maxconn 100
+    quiet
+    pidfile /some/other/run/haproxy.pid
+    stats socket  /tmp/haproxy

data/spec/config_fixtures/crappy_haproxy.cfg

@@ -0,0 +1,4 @@
+global
+    daemon
+    maxconn 100
+    quiet

data/spec/quality_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+IGNORE = /\.(gitmodules|png$|tar$|gz$|rbc$|gem$|pdf$)/
+
+describe 'The application itself' do
+  it 'has no malformed whitespace' do
+    files = `git ls-files`.split("\n").select {|fn| fn !~ IGNORE}
+
+    files.should be_well_formed
+  end
+end

data/spec/rhapr/environment_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe Rhapr::Environment do
+  class EnvTest
+    include Rhapr::Environment
+  end
+
+  before(:each) do
+    @env_test = EnvTest.new
+  end
+
+  describe '#config_path' do
+    it 'should set to the ENV variable, if present' do
+      ENV['HAPROXY_CONFIG'] = '/some/path.cfg'
+
+      @env_test.config_path.should == '/some/path.cfg'
+
+      # Clean up.
+      ENV.delete 'HAPROXY_CONFIG'
+    end
+
+    it 'should go down a list of pre-defined file names' do
+      File.stub!(:exists?).and_return(false)
+      File.should_receive(:exists?).with('/etc/haproxy.cfg').and_return(true)
+
+      @env_test.config_path.should == '/etc/haproxy.cfg'
+    end
+
+    it 'should be nil if config files do not exist and $HAPROXY_CONFIG is not set' do
+      File.stub!(:exists?).and_return(false)
+      @env_test.config_path.should be_nil
+    end
+  end
+
+  describe '#config' do
+    before(:each) do
+      File.stub!(:exists?).and_return(false)
+      File.should_receive(:exists?).with('/etc/haproxy.cfg').and_return(true)
+    end
+
+    it 'should raise an exception if it cannot read from #config_path' do
+      File.should_receive(:read).and_raise(Errno::ENOENT)
+
+      lambda {
+        @env_test.config
+      }.should raise_error(RuntimeError)
+    end
+
+    it 'should read and return the contents of a file' do
+      File.should_receive(:read).and_return { "I can haz cfg ?\n" }
+
+      @env_test.config.should == "I can haz cfg ?\n"
+    end
+  end
+
+  describe '#exec' do
+    it 'should set to the ENV variable, if present' do
+      ENV['HAPROXY_BIN'] = '/usr/local/bin/haproxy'
+
+      @env_test.exec.should == '/usr/local/bin/haproxy'
+
+      # Clean up.
+      ENV.delete 'HAPROXY_BIN'
+    end
+
+    it 'should call out to the `which` command to find haproxy, if the ENV var is not set' do
+      @env_test.should_receive(:`).with('which haproxy').and_return('/opt/bin/haproxy')
+
+      @env_test.exec.should == '/opt/bin/haproxy'
+    end
+
+    it 'should call out to haproxy directly, if all else fails' do
+      @env_test.should_receive(:`).with('which haproxy').and_return('')
+      @env_test.should_receive(:`).with('haproxy -v').and_return("HA-Proxy version 1.4.15 2011/04/08\nCopyright 2000-2010 Willy Tarreau <w@1wt.eu>\n\n")
+
+      @env_test.exec.should == 'haproxy'
+    end
+
+    it 'should be nil if none of the above worked' do
+      @env_test.should_receive(:`).with('which haproxy').and_return('')
+      @env_test.should_receive(:`).with('haproxy -v').and_raise(Errno::ENOENT)
+
+      @env_test.exec.should be_nil
+    end
+  end
+
+  describe '#socket' do
+    it 'should parse out the io socket from the config file' do
+      @env_test.should_receive(:config).and_return { config_for(:basic_haproxy) }
+
+      @env_test.socket.should == '/tmp/haproxy'
+    end
+
+    it 'should raise an error if it cannot derive an io socket from the config file' do
+      @env_test.should_receive(:config).and_return { config_for(:crappy_haproxy) }
+
+      lambda {
+        @env_test.socket
+      }.should raise_error(RuntimeError)
+    end
+  end
+
+  describe '#pid' do
+    it 'should parse out the pidfile from the config file' do
+      @env_test.should_receive(:config).and_return { config_for(:basic_haproxy) }
+
+      @env_test.pid.should == '/some/other/run/haproxy.pid'
+    end
+
+    it 'should return a default path if it cannot derive an io socket from the config file' do
+      @env_test.should_receive(:config).and_return { config_for(:crappy_haproxy) }
+
+      @env_test.pid.should == '/var/run/haproxy.pid'
+    end
+  end
+
+  describe '#check_running, #pidof' do
+    pending 'TBD'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+
+Bundler.require :default
+Bundler.require :development
+
+Dir[ Bundler.root.join('spec/support/**/*.rb') ].each{|f| require f}
+
+RSpec.configure do |c|
+  c.include CustomMatchers
+  c.include ConfigFixtures
+end

data/spec/support/config_fixtures.rb

@@ -0,0 +1,53 @@
+require 'bundler'
+
+module ConfigFixtures
+  attr_reader :config_fixtures
+
+  # @param [Symbol]
+  # @return [String]
+  def fixture_for(sym)
+    config_fixtures[sym][:fixture]
+  end
+  alias :config_for :fixture_for
+
+  def path_for(sym)
+    config_fixtures[sym][:path]
+  end
+
+  # @see ConfigFixtures#create_fixture_hash
+  def config_fixtures
+    @config_fixtures ||= begin
+      hash = Hash.new {|k,v| k[v] = {}}
+      hash.merge!(create_fixture_hash)
+    end
+  end
+
+  # @return [Hash{Symbol => String}]
+  def create_fixture_hash
+    Hash[ find_fixtures.map{|fpath| map_fixture(fpath) } ]
+  end
+
+  # @param [String]
+  # @return [Array<Symbol, String>]
+  def map_fixture(fpath)
+    [symbolize_filename(fpath), {:path => fpath, :fixture => read_file(fpath)}]
+  end
+
+  # @return [Array<String>]
+  def find_fixtures
+    Dir.glob Bundler.root.join('spec/config_fixtures/**.cfg')
+  end
+
+  # @param [String]
+  # @return [Symbol]
+  def symbolize_filename(fpath)
+    fname = File.basename(fpath)
+    fname.split(/\W/).shift.to_sym
+  end
+
+  # @param [String]
+  # @return [String]
+  def read_file(fpath)
+    File.read(fpath)
+  end
+end

data/spec/support/custom_matchers.rb

@@ -0,0 +1,44 @@
+module CustomMatchers
+  class BeWellFormed
+    def matches?(files)
+      @errors = files.map {|filename|
+                  [
+                    check_for_tabs(filename),
+                    excessive_spacing(filename),
+                    newline_precedes_eof(filename)
+                  ]
+                }.flatten.compact
+
+      @errors.empty?
+    end
+
+    def failure_message_for_should
+      @errors.join("\n")
+    end
+
+  private
+    def check_for_tabs(filename)
+      bad_lines = File.readlines(filename).each_with_index.map do |line, line_no|
+                    line_no + 1 if line["\t"] and line !~ /^\s+#.*\s+\n$/
+                  end.flatten.compact
+
+      "#{filename} has tab characters on lines #{bad_lines.join(', ')}" if bad_lines.any?
+    end
+
+    def excessive_spacing(filename)
+      bad_lines = File.readlines(filename).each_with_index.map do |line, line_no|
+                    line_no + 1 if line =~ /\s+\n$/ and line !~ /^\s+#.*\s+\n$/
+                  end.flatten.compact
+
+      "#{filename} has spaces on the EOL on lines #{bad_lines.join(', ')}" if bad_lines.any?
+    end
+
+    def newline_precedes_eof(filename)
+      "#{filename} does not have a newline (\\n) before EOF" if File.read(filename) !~ /\n$/
+    end
+  end
+
+  def be_well_formed
+    BeWellFormed.new
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: rhapr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Scott Gonyea
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2165531120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165531120
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2165523840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: *2165523840
+description: Rhapr is a ruby lib that wraps around HAProxy, enabling you to sanely
+  decomission a process.
+email:
+- me@sgonyea.com
+executables:
+- rhapr
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Rakefile
+- bin/rhapr
+- lib/rhapr.rb
+- lib/rhapr/environment.rb
+- lib/rhapr/version.rb
+- rhapr.gemspec
+- spec/config_fixtures/basic_haproxy.cfg
+- spec/config_fixtures/crappy_haproxy.cfg
+- spec/quality_spec.rb
+- spec/rhapr/environment_spec.rb
+- spec/spec_helper.rb
+- spec/support/config_fixtures.rb
+- spec/support/custom_matchers.rb
+homepage: https://github.com/sgonyea/rhapr
+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.5
+signing_key: 
+specification_version: 3
+summary: Rhapr wraps around HAProxy
+test_files:
+- spec/config_fixtures/basic_haproxy.cfg
+- spec/config_fixtures/crappy_haproxy.cfg
+- spec/quality_spec.rb
+- spec/rhapr/environment_spec.rb
+- spec/spec_helper.rb
+- spec/support/config_fixtures.rb
+- spec/support/custom_matchers.rb