haproxy-tools 0.1.0 → 0.2.0

data/lib/haproxy/treetop/config.treetop

@@ -0,0 +1,189 @@
+require 'haproxy/treetop/nodes'
+
+module HAProxy::Treetop
+
+  grammar Config
+    rule configuration
+      (comment_line / global_section / defaults_section / userlist_section / listen_section / frontend_section / backend_section)* <ConfigurationFile>
+    end
+
+    rule global_section
+      global_header config_block <GlobalSection>
+    end
+
+    rule defaults_section
+      defaults_header config_block <DefaultsSection>
+    end
+
+    rule userlist_section
+      userlist_header config_block <UserlistSection>
+    end
+
+    rule listen_section
+      listen_header config_block <ListenSection>
+    end
+
+    rule frontend_section
+      frontend_header config_block <FrontendSection>
+    end
+
+    rule backend_section
+      backend_header config_block <BackendSection>
+    end
+
+    rule global_header
+      whitespace "global" whitespace comment_text? line_break <GlobalHeader>
+    end
+
+    rule userlist_header
+      whitespace "userlist" whitespace proxy_name comment_text? line_break <UseristHeader>
+    end
+
+    rule defaults_header
+      whitespace "defaults" whitespace proxy_name? whitespace comment_text? line_break <DefaultsHeader>
+    end
+
+    rule listen_header
+      whitespace "listen" whitespace proxy_name whitespace service_address? value? comment_text? line_break <ListenHeader>
+    end
+
+    rule frontend_header
+      whitespace "frontend" whitespace proxy_name whitespace service_address? value? comment_text? line_break <FrontendHeader>
+    end
+
+    rule backend_header
+      whitespace "backend" whitespace proxy_name whitespace value? comment_text? line_break <BackendHeader>
+    end
+
+    rule config_block
+      (server_line / option_line / config_line / comment_line / blank_line)* <ConfigBlock>
+    end
+
+    rule server_line
+      whitespace "server" whitespace server_name whitespace service_address value? comment_text? line_break <ServerLine>
+    end
+
+    rule option_line
+      whitespace "option" whitespace keyword whitespace value? comment_text? line_break <OptionLine>
+    end
+
+    rule config_line
+      whitespace !("defaults" / "global" / "listen" / "frontend" / "backend") keyword whitespace value? comment_text? line_break <ConfigLine>
+    end
+
+    rule comment_line
+      whitespace comment_text line_break <CommentLine>
+    end
+
+    rule blank_line
+      whitespace line_break <BlankLine>
+    end
+
+    rule comment_text
+      '#' char* &line_break <CommentText>
+    end
+
+    rule line_break
+      [\n] <LineBreak>
+    end
+
+    rule keyword
+      [a-z\-\.]+ <Keyword>
+    end
+
+    rule server_name
+      [a-zA-Z0-9\-_\.:]+ <ServerName>
+    end
+
+    rule service_address
+      host [:]? port <ServiceAddress>
+    end
+
+    rule host
+      ipv4_host / dns_host / wildcard_host
+    end
+
+    rule port
+      [\d]* <Port>
+    end
+
+    rule ipv4_host
+      [\d] 1..3 '.' [\d] 1..3 '.' [\d] 1..3 '.' [\d] 1..3 <Host>
+    end
+
+    rule wildcard_host
+      "*" <Host>
+    end
+
+    rule dns_host
+      [a-zA-Z\-\.] 4..255 <Host>
+    end
+
+    rule proxy_name
+      [a-zA-Z0-9\-_\.:]+ <ProxyName>
+    end
+
+    rule value
+      [^#\n]+ <Value>
+    end
+
+    rule char
+      ![\n] . <Char>
+    end
+
+    rule whitespace
+      [ \t]* <Whitespace>
+    end
+
+# Valid Global Keywords (1.4)
+# * Process management and security
+#   - chroot <jail dir>
+#   - daemon
+#   - gid <number>
+#   - group <group name>
+#   - log <address> <facility> [max level [min level]]
+#   - log-send-hostname [<string>]
+#   ? log-tag <string>
+#   - nbproc <number>
+#   - pidfile <pidfile>
+#   - uid <number>
+#   - ulimit-n <number>
+#   - user <user name>
+#   - stats socket <path> [{uid | user} <uid>] [{gid | group} <gid>] [mode <mode>] [level <level>]
+#   - stats timeout <timeout, in milliseconds>
+#   - stats maxconn <connections>
+#   - node <name>
+#   - description <text>
+#
+# * Performance tuning
+#   - maxconn <number>
+#   - maxpipes <number>
+#   - noepoll
+#   - nokqueue
+#   - nopoll
+#   - nosepoll
+#   - nosplice
+#   - spread-checks <0..50, in percent>
+#   - tune.bufsize <number>
+#   - tune.chksize <number>
+#   - tune.maxaccept <number>
+#   - tune.maxpollevents <number>
+#   - tune.maxrewrite <number>
+#   - tune.rcvbuf.client <number>
+#   - tune.rcvbuf.server <number>
+#   - tune.sndbuf.client <number>
+#   - tune.sndbuf.server <number>
+#
+# * Debugging
+#   - debug
+#   - quiet
+
+# Valid Userlist keywords
+#   - userlist <listname>
+#   - group <groupname> [users <user>,<user>,(...)]
+#   - user <username> [password|insecure-password <password>] [groups <group>,<group>,(...)]
+
+
+  end
+end
+

data/lib/haproxy/treetop/nodes.rb

@@ -0,0 +1,174 @@
+module HAProxy
+  module Treetop
+    extend self
+
+    module StrippedTextContent
+      def content
+        self.text_value.strip
+      end
+    end
+
+    module ConfigBlockContainer
+      def option_lines
+        self.config_block.elements.select {|e| e.class == OptionLine}
+      end
+
+      def config_lines
+        self.config_block.elements.select {|e| e.class == ConfigLine}
+      end
+    end
+
+    module ServiceAddressContainer
+      def service_address
+        self.elements.find {|e| e.class == ServiceAddress }
+      end
+
+      def host
+        self.service_address.host.text_value.strip
+      end
+
+      def port
+        self.service_address.port.text_value.strip
+      end
+    end
+
+    module ServerContainer
+      def servers
+         self.config_block.elements.select {|e| e.class == ServerLine}
+      end
+    end
+
+    module OptionalValueElement
+      def value
+        self.elements.find {|e| e.class == Value}
+      end
+    end
+
+    class Whitespace < ::Treetop::Runtime::SyntaxNode
+      def content
+        self.text_value
+      end
+    end
+    class LineBreak < ::Treetop::Runtime::SyntaxNode; end
+    class Char < ::Treetop::Runtime::SyntaxNode; include StrippedTextContent; end
+    class Keyword < ::Treetop::Runtime::SyntaxNode; include StrippedTextContent; end
+    class ProxyName < ::Treetop::Runtime::SyntaxNode; include StrippedTextContent; end
+    class ServerName < ::Treetop::Runtime::SyntaxNode; include StrippedTextContent; end
+    class Host < ::Treetop::Runtime::SyntaxNode; include StrippedTextContent; end
+    class Port < ::Treetop::Runtime::SyntaxNode; include StrippedTextContent; end
+    class Value < ::Treetop::Runtime::SyntaxNode; include StrippedTextContent; end
+    class CommentText < ::Treetop::Runtime::SyntaxNode; include StrippedTextContent; end
+
+    class ServiceAddress < ::Treetop::Runtime::SyntaxNode
+      include StrippedTextContent
+    end
+
+    class CommentLine < ::Treetop::Runtime::SyntaxNode; include StrippedTextContent; end
+    class BlankLine < ::Treetop::Runtime::SyntaxNode; include StrippedTextContent; end
+    class ConfigLine < ::Treetop::Runtime::SyntaxNode
+      include StrippedTextContent
+      include OptionalValueElement
+    end
+
+    class OptionLine < ::Treetop::Runtime::SyntaxNode
+      include StrippedTextContent
+      include OptionalValueElement
+    end
+
+    class ServerLine < ::Treetop::Runtime::SyntaxNode
+      include StrippedTextContent
+      include ServiceAddressContainer
+      include OptionalValueElement
+
+      def name
+        self.server_name.content
+      end
+    end
+
+    class GlobalHeader < ::Treetop::Runtime::SyntaxNode; include StrippedTextContent; end
+
+    class DefaultsHeader < ::Treetop::Runtime::SyntaxNode
+      include StrippedTextContent
+      def proxy_name
+        self.elements.select {|e| e.class == ProxyName}.first
+      end
+    end
+
+    class UserlistHeader < ::Treetop::Runtime::SyntaxNode; include StrippedTextContent; end
+    class BackendHeader < ::Treetop::Runtime::SyntaxNode; include StrippedTextContent; end
+
+    class FrontendHeader < ::Treetop::Runtime::SyntaxNode
+      include ServiceAddressContainer
+    end
+
+    class ListenHeader < ::Treetop::Runtime::SyntaxNode
+      include ServiceAddressContainer
+    end
+
+    class ConfigBlock < ::Treetop::Runtime::SyntaxNode; end
+
+    class DefaultsSection < ::Treetop::Runtime::SyntaxNode
+      include ConfigBlockContainer
+    end
+
+    class GlobalSection < ::Treetop::Runtime::SyntaxNode
+      include ConfigBlockContainer
+    end
+
+    class UserlistSection < ::Treetop::Runtime::SyntaxNode
+      include ConfigBlockContainer
+    end
+
+    class FrontendSection < ::Treetop::Runtime::SyntaxNode
+      include ConfigBlockContainer
+    end
+
+    class ListenSection < ::Treetop::Runtime::SyntaxNode
+      include ConfigBlockContainer
+      include ServerContainer
+    end
+
+    class BackendSection < ::Treetop::Runtime::SyntaxNode
+      include ConfigBlockContainer
+      include ServerContainer
+    end
+
+    class ConfigurationFile < ::Treetop::Runtime::SyntaxNode
+      def global
+        self.elements.select {|e| e.class == GlobalSection}.first
+      end
+
+      def defaults
+        self.elements.select {|e| e.class == DefaultsSection}
+      end
+         
+      def listeners
+        self.elements.select {|e| e.class == ListenSection}
+      end
+
+      def frontends
+        self.elements.select {|e| e.class == FrontendSection}
+      end
+
+      def backends
+        self.elements.select {|e| e.class == BackendSection}
+      end
+    end
+
+    def print_node(e, depth, options = nil)
+      options ||= {}
+      options = {:max_depth => 2}.merge(options)
+
+      puts if depth == 0
+      print "--" * depth
+      print " #{e.class.name.split('::').last}"
+      print " [#{e.text_value}]" if e.class == ::Treetop::Runtime::SyntaxNode
+      print " [#{e.content}]" if e.respond_to? :content
+      puts
+      e.elements.each do |child|
+        print_node(child, depth + 1, options)
+      end if depth < options[:max_depth] && e.elements && !e.respond_to?(:content)
+    end
+  end
+end
+

data/lib/haproxy_tools.rb

@@ -1,2 +1,12 @@
+require 'polyglot'
+require 'treetop'
+require 'orderedhash'
+require 'haproxy/treetop/config'
 require 'haproxy/config'
+require 'haproxy/renderer'
 require 'haproxy/parser'
+
+module HAProxy
+  VERSION = File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).strip
+end
+

data/spec/fixtures/simple.haproxy.cfg

@@ -1,3 +1,4 @@
+# This is a top-level comment.  It should be allowed.
 global
 	maxconn 4096 # Total Max Connections. This is dependent on ulimit
 	daemon
@@ -10,7 +11,7 @@ defaults
 	contimeout 4000
 	option httpclose # Disable Keepalive
 
-	listen http_proxy 55.55.55.55:80
+listen http_proxy 55.55.55.55:80
 	balance roundrobin # Load Balancing algorithm
 	option httpchk
 	option forwardfor # This sets X-Forwarded-For

data/spec/haproxy/config_spec.rb

@@ -1,4 +1,103 @@
 require 'spec_helper'
 
 describe "HAProxy::Config" do
+  describe 'render multi-backend config' do
+    before(:each) do
+      @config = HAProxy::Config.parse_file('spec/fixtures/multi-pool.haproxy.cfg')
+    end
+
+    it 'can re-render a config file with a server removed' do
+      l = @config.backend('www_main')
+      l.servers.delete('prd_www_1')
+
+      new_config_text = @config.render
+
+      new_config = HAProxy::Parser.new.parse(new_config_text)
+      new_config.backend('www_main').servers['prd_www_1'].should be_nil
+    end
+
+    it 'can re-render a config file with a server attribute added' do
+      b = @config.backend('www_main')
+      b.servers['prd_www_1'].attributes['disabled'] = true
+      new_config_text = @config.render
+
+      new_config = HAProxy::Parser.new.parse(new_config_text)
+      s = new_config.backend('www_main').servers['prd_www_1']
+      s.should_not be_nil
+      s.attributes['disabled'].should be_true
+    end
+
+    it 'can re-render a config file with a server added' do
+      b = @config.backend('www_main')
+      b.add_server('prd_www_4', '99.99.99.99', :port => '8000')
+
+      new_config_text = @config.render
+
+      new_config = HAProxy::Parser.new.parse(new_config_text)
+      s = new_config.backend('www_main').servers['prd_www_4']
+      s.should_not be_nil
+      s.name.should == 'prd_www_4'
+      s.host.should == '99.99.99.99'
+      s.port.should == '8000'
+      s.attributes.to_a.should == []
+    end
+
+    it 'can re-render a config file with a server added based on template' do
+      b = @config.backend('www_main')
+      b.add_server('prd_www_4', '99.99.99.99', :template => b.servers['prd_www_1'])
+
+      new_config_text = @config.render
+
+      new_config = HAProxy::Parser.new.parse(new_config_text)
+      s = new_config.backend('www_main').servers['prd_www_4']
+      s.should_not be_nil
+      s.name.should == 'prd_www_4'
+      s.host.should == '99.99.99.99'
+      s.port.should == '8000'
+      s.attributes.to_a.should == [
+        ['cookie','i-prd_www_1'],
+        ['check',true],
+        ['inter','3000'],
+        ['rise','2'],
+        ['fall','3'],
+        ['maxconn','1000']
+      ]
+    end
+  end
+
+  describe 'render simple config' do
+    before(:each) do
+      @config = HAProxy::Config.parse_file('spec/fixtures/simple.haproxy.cfg')
+    end
+
+    it 'can re-render a config file with a server removed' do
+      l = @config.listener('http_proxy')
+      l.servers.delete('web1')
+
+      new_config_text = @config.render
+
+      new_config = HAProxy::Parser.new.parse(new_config_text)
+      new_config.listener('http_proxy').servers['web1'].should be_nil
+    end
+
+    it 'can re-render a config file with a server added' do
+      l = @config.listener('http_proxy')
+      l.add_server('web4', '99.99.99.99', :template => l.servers['web1'])
+
+      new_config_text = @config.render
+
+      new_config = HAProxy::Parser.new.parse(new_config_text)
+      s = new_config.listener('http_proxy').servers['web4']
+      s.should_not be_nil
+      s.name.should == 'web4'
+      s.host.should == '99.99.99.99'
+      s.port.should == '80'
+      s.attributes.to_a.should == [
+        ['weight','1'],
+        ['maxconn','512'],
+        ['check',true]
+      ]
+    end
+  end
 end
+