rhapr 0.0.1 → 0.1.0

data/lib/rhapr.rb

@@ -2,5 +2,5 @@ require 'rhapr/version'
 require 'rhapr/environment'
 
 module Rhapr
-  # Your code goes here...
+  autoload :Interface, 'rhapr/interface'
 end

data/lib/rhapr/environment.rb

@@ -1,25 +1,27 @@
+require 'socket'
+
 module Rhapr
   module Environment
-    attr_accessor :haproxy_pid, :config_path, :config, :exec
+    attr_reader :haproxy_pid, :config_path, :config, :exec, :socket_path
 
-    # @return [String] The path to the HAProxy configuration file. Set the ENV variable $HAPROXY_CONFIG to override defaults
+    # @return [String, nil] The path to the HAProxy configuration file, or nil if not found. 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_paths = %w{/etc/haproxy/haproxy.cfg /etc/haproxy.cfg /usr/local/etc/haproxy.cfg}
+        config_paths.select!{|cfg| File.exists?(cfg)}
 
-          @config_path = cfg
-        }
+        @config_path = config_paths.first
       end
 
       return(@config_path)
     end
 
     # @return [String] The raw contents of the HAProxy configuration file.
+    # @raise [RuntimeError] If it cannot read the contents of #config_path.
     def config
       @config ||= begin
                     File.read(config_path)
@@ -53,14 +55,24 @@ module Rhapr
       return(@exec)
     end
 
+    # @return [UNIXSocket] A connection to the HAProxy Socket
+    # @raise [RuntimeError] Raised if a socket connection could not be established
+    def socket
+      begin
+        UNIXSocket.open(socket_path)
+      rescue Errno::EACCES => e
+        raise RuntimeError.new("Could not open a socket with HAProxy. Error message: #{e.message}")
+      end
+    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
+    def socket_path
+      @socket_path  ||= 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.
@@ -69,7 +81,7 @@ module Rhapr
     def pid
       @pid  ||= begin
                   config.match /pidfile ([^\s]*)/
-                  @pid = $1 || '/var/run/haproxy.pid'
+                  $1 || '/var/run/haproxy.pid'
                 end
     end
 

data/lib/rhapr/interface.rb

@@ -0,0 +1,111 @@
+require 'csv'
+
+module Rhapr
+  class Interface
+    include Rhapr::Environment
+
+    EMPTY = "\n"
+
+    # @param [String, #to_s] message The message to be sent to HAProxy
+    # return [Array<String>] All of the output from HAProxy, read in.
+    # @see Rhapr::Interface#write, Rhapr::Interface#read_full
+    def send(message)
+      sock = socket
+
+      write(sock, message)
+      read_full(sock)
+    end
+
+    # @return [true, false] Whether or not the 'clear counters' command was successful
+    def clear_counters
+      resp = send 'clear counters'
+      resp == EMPTY
+    end
+    alias :clear :clear_counters
+
+    # @return [Hash{String => String}] The 'show info' attributes, from HAProxy, parsed into a Hash.
+    def show_info
+      resp = send 'show info'
+
+      attrs = resp.split("\n")
+
+      attrs.map! {|line|
+        _attr, *_val = line.split(/: /)
+        [ _attr, _val.join ]
+      }
+
+      Hash[ attrs ]
+    end
+    alias :info :show_info
+
+    # @return [Array<Hash{String => String}>] The 'show stat' response, from HAProxy, parsed into an Array of Hashes.
+    def show_stat
+      resp = send 'show stat'
+      resp.gsub!(/^# /, '')
+
+      csv = CSV.parse(resp, :headers => true)
+      out = csv.map(&:to_a)
+
+      out.map!{|row| Hash[ row ]}
+
+      return(out)
+    end
+    alias :stat :show_stat
+
+    # @todo: Implement. I do not know the possible errors that may be present, nor how HAProxy will render them.
+    def show_errors
+    end
+    alias :errors :show_errors
+
+    # @todo: Implement. Not sure how this should look. It's likely that I will want to 'interpret' the data that is spit out.
+    def show_sess(id)
+    end
+    alias :session :show_sess
+
+    # @return [Array<Fixnum, Fixnum>] An Array with Two Elements: the Current Weight and the Initial Weight.
+    # @todo: Allow the numeric id to be used as a parameter?
+    def get_weight(backend, server)
+      resp = send "get weight #{backend}/#{server}"
+
+      resp.match /([[:digit:]]+) \(initial ([[:digit:]]+)\)/
+      weight, initial = $1, $2
+
+      return [weight.to_i, initial.to_i] if weight and initial
+
+      raise ArgumentError.new("HAProxy did not recognize the specified Backend/Server. Response from HAProxy: #{resp}")
+    end
+
+    # @todo: Implement.
+    # @todo: Allow the numeric id to be used as a parameter?
+    def set_weight(backend, server, weight)
+    end
+
+    # @todo: Implement.
+    def disable(backend, server)
+    end
+
+    # @todo: Implement.
+    def enable(backend, server)
+    end
+
+   protected
+    # @param [UNIXSocket]
+    # @param [String]
+    # @return [nil]
+    def write(socket, message)
+      socket.puts message
+    end
+
+    # @return [String]
+    def read(socket)
+      socket.gets
+    end
+
+    # @return [Array<String>] All of the output from HAProxy, read in.
+    # @see Rhapr::Interface#read
+    def read_full(socket)
+      output = []
+      output << read(socket) until(sock.eof?)
+    end
+  end
+end

data/lib/rhapr/version.rb

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

data/rhapr.gemspec

@@ -11,9 +11,10 @@ Gem::Specification.new do |s|
   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.has_rdoc    = true
+  s.add_dependency 'yard'
 
-  s.add_development_dependency 'rspec', '~>2.4'
+  s.add_development_dependency 'rspec', '~>2.6'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/config_fixtures/basic_haproxy.cfg

@@ -1,6 +1,34 @@
 global
     daemon
-    maxconn 100
-    quiet
-    pidfile /some/other/run/haproxy.pid
-    stats socket  /tmp/haproxy
+    maxconn 1024
+    # quiet
+    pidfile /var/run/haproxy.pid
+    stats socket /tmp/haproxy level admin uid 501 group staff
+
+defaults
+    log global
+    mode http
+    option httplog
+    option dontlognull
+    stats enable
+    stats uri /proxystats     # and this guy for statistics
+    stats auth webreport:areallysecretsupersecurepassword
+    stats refresh 5s
+
+listen thrift :9090
+    mode    tcp
+    balance roundrobin
+    option  tcplog
+    option  redispatch
+    retries 3
+
+    contimeout  5000
+    clitimeout  40000
+    srvtimeout  7000
+
+    server thrift1 localhost:9091 maxconn 20 check inter 20000
+    server thrift2 localhost:9092 maxconn 20 check inter 20000
+    server thrift3 localhost:9093 maxconn 20 check inter 20000
+    server thrift4 localhost:9094 maxconn 20 check inter 20000
+    server thrift5 localhost:9095 maxconn 20 check inter 20000
+    server thrift6 localhost:9096 maxconn 20 check inter 20000

data/spec/config_fixtures/pid_test_haproxy.cfg

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

data/spec/rhapr/environment_spec.rb

@@ -26,6 +26,14 @@ describe Rhapr::Environment do
       @env_test.config_path.should == '/etc/haproxy.cfg'
     end
 
+    it 'should select the first configuration found, from the pre-defined list' do
+      File.stub!(:exists?).and_return(false)
+      File.should_receive(:exists?).with('/etc/haproxy/haproxy.cfg').and_return(true)
+      File.should_receive(:exists?).with('/etc/haproxy.cfg').and_return(true)
+
+      @env_test.config_path.should == '/etc/haproxy/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
@@ -85,24 +93,28 @@ describe Rhapr::Environment do
   end
 
   describe '#socket' do
+    it 'should establish a socket connection with HAProxy'
+  end
+
+  describe '#socket_path' 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'
+      @env_test.socket_path.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
+        @env_test.socket_path
       }.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.should_receive(:config).and_return { config_for(:pid_test_haproxy) }
 
       @env_test.pid.should == '/some/other/run/haproxy.pid'
     end

data/spec/rhapr/interface_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Rhapr::Interface do
+  let(:basic_info) {
+    "Name: HAProxy\nVersion: 1.4.15\nRelease_date: 2011/04/08\nNbproc: 1\nProcess_num: 1\nPid: 97413\nUptime: 0d 18h43m53s\n"   <<
+    "Uptime_sec: 67433\nMemmax_MB: 0\nUlimit-n: 2066\nMaxsock: 2066\nMaxconn: 1024\nMaxpipes: 0\nCurrConns: 1\nPipesUsed: 0\n"  <<
+    "PipesFree: 0\nTasks: 7\nRun_queue: 1\nnode: skg.local\ndescription: \n"
+  }
+
+  let(:basic_stat) {
+    "# pxname,svname,qcur,qmax,scur,smax,slim,stot,bin,bout,dreq,dresp,ereq,econ,eresp,wretr,wredis,status,weight,act,bck,chkfail,"           <<
+    "chkdown,lastchg,downtime,qlimit,pid,iid,sid,throttle,lbtot,tracked,type,rate,rate_lim,rate_max,check_status,check_code,check_duration,"  <<
+    "hrsp_1xx,hrsp_2xx,hrsp_3xx,hrsp_4xx,hrsp_5xx,hrsp_other,hanafail,req_rate,req_rate_max,req_tot,cli_abrt,srv_abrt,\nsrv,FRONTEND,"        <<
+    ",,0,0,2000,0,0,0,0,0,0,,,,,OPEN,,,,,,,,,1,1,0,,,,0,0,0,0,,,,,,,,,,,0,0,0,,,\nsrv,srv1,0,0,0,0,20,0,0,0,,0,,0,0,0,0,DOWN,1,1,0,"          <<
+    "0,1,72468,72468,,1,1,1,,0,,2,0,,0,L4CON,,0,,,,,,,0,,,,0,0,\nsrv,srv2,0,0,0,0,20,0,0,0,,0,,0,0,0,0,DOWN,1,1,0,0,1,72465,72465,,"          <<
+    "1,1,2,,0,,2,0,,0,L4CON,,0,,,,,,,0,,,,0,0,\n"
+  }
+
+
+  subject { Rhapr::Interface.new }
+
+  describe '#clear_counters' do
+    it 'should send the "clear counters" message to HAProxy' do
+      subject.should_receive(:send).with('clear counters').and_return("\n")
+
+      subject.clear_counters.should be_true
+    end
+  end
+
+  describe '#show_info' do
+    it 'should parse and return a Hash of HAProxy\'s info attributes' do
+      subject.should_receive(:send).with('show info').and_return(basic_info)
+
+      subject.show_info.should be_a(Hash)
+    end
+
+    it 'should normalize the attribute names into lower-case and underscore-ized form'
+  end
+
+  describe '#show_stat' do
+    before(:each) do
+      subject.should_receive(:send).with('show stat').and_return(basic_stat)
+    end
+
+    it 'should return an Array of Hashes, returned from HAProxy\'s "show stats" request' do
+      stats = subject.show_stat
+
+      stats.should be_a(Array)
+      stats.each{|stat| stat.should be_a(Hash) }
+    end
+
+    it 'should strip the "# " from the beginning of the headers, before calling CSV.parse' do
+      stats = subject.show_stat
+
+      stats.first.should_not  have_key('# pxname')
+      stats.first.should      have_key('pxname')
+    end
+  end
+
+  describe '#show_errors'
+  describe '#show_sess'
+
+  describe '#get_weight' do
+    it 'should parse the weight into an Array, with two elements: The weight and the initial weight' do
+      subject.should_receive(:send).with('get weight test/test1').and_return('1 (initial 1)')
+
+      subject.get_weight('test', 'test1').should == [1, 1]
+    end
+
+    it 'should raise an error if the specific backend+server is not known to HAProxy' do
+      subject.should_receive(:send).with('get weight test/test9').and_return('No such server.')
+
+      lambda {
+        subject.get_weight('test', 'test9')
+      }.should raise_error(ArgumentError, "HAProxy did not recognize the specified Backend/Server. Response from HAProxy: No such server.")
+    end
+  end
+
+  describe '#set_weight'
+  describe '#disable'
+  describe '#enable'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rhapr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,36 +9,35 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-01 00:00:00.000000000Z
+date: 2011-07-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2165531120 !ruby/object:Gem::Requirement
+  requirement: &2152753740 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165531120
+  version_requirements: *2152753740
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2165523840 !ruby/object:Gem::Requirement
+  requirement: &2152753080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *2165523840
+  version_requirements: *2152753080
 description: Rhapr is a ruby lib that wraps around HAProxy, enabling you to sanely
   decomission a process.
 email:
 - me@sgonyea.com
-executables:
-- rhapr
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -46,15 +45,17 @@ files:
 - .rspec
 - Gemfile
 - Rakefile
-- bin/rhapr
 - lib/rhapr.rb
 - lib/rhapr/environment.rb
+- lib/rhapr/interface.rb
 - lib/rhapr/version.rb
 - rhapr.gemspec
 - spec/config_fixtures/basic_haproxy.cfg
 - spec/config_fixtures/crappy_haproxy.cfg
+- spec/config_fixtures/pid_test_haproxy.cfg
 - spec/quality_spec.rb
 - spec/rhapr/environment_spec.rb
+- spec/rhapr/interface_spec.rb
 - spec/spec_helper.rb
 - spec/support/config_fixtures.rb
 - spec/support/custom_matchers.rb
@@ -85,8 +86,10 @@ summary: Rhapr wraps around HAProxy
 test_files:
 - spec/config_fixtures/basic_haproxy.cfg
 - spec/config_fixtures/crappy_haproxy.cfg
+- spec/config_fixtures/pid_test_haproxy.cfg
 - spec/quality_spec.rb
 - spec/rhapr/environment_spec.rb
+- spec/rhapr/interface_spec.rb
 - spec/spec_helper.rb
 - spec/support/config_fixtures.rb
 - spec/support/custom_matchers.rb

data/bin/rhapr

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