haproxy-tools 0.5.0 → 0.6.0

data/haproxy-tools.gemspec

@@ -1,31 +1,34 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'haproxy/version'
+require "haproxy/version"
 
 Gem::Specification.new do |gem|
-  gem.name          = 'haproxy-tools'
+  gem.name          = "haproxy-tools"
   gem.version       = HAProxy::VERSION
-  gem.authors       = ['Jason Wadsworth']
-  gem.email         = ['jdwadsworth@gmail.com']
-  gem.description   = %q{Ruby tools for HAProxy, including config file management.}
-  gem.summary       = %q{HAProxy Tools for Ruby}
-  gem.homepage      = 'https://github.com/subakva/haproxy-tools'
-  gem.license = 'MIT'
+  gem.authors       = ["Jason Wadsworth"]
+  gem.email         = ["jdwadsworth@gmail.com"]
+  gem.description   = "Ruby tools for HAProxy, including config file management."
+  gem.summary       = "HAProxy Tools for Ruby"
+  gem.homepage      = "https://github.com/subakva/haproxy-tools"
+  gem.license = "MIT"
 
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  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 = ["lib"]
 
-  gem.required_ruby_version = '>= 1.9.3'
+  gem.required_ruby_version = ">= 2.2.0"
 
-  gem.add_dependency('net-scp')
-  gem.add_dependency('treetop')
-  gem.add_development_dependency('rake')
-  gem.add_development_dependency('rspec')
-  gem.add_development_dependency('yard')
-  gem.add_development_dependency('simplecov')
-  gem.add_development_dependency('cane')
+  gem.add_dependency("net-scp")
+  gem.add_dependency("treetop")
+  gem.add_development_dependency("awesome_print")
+  gem.add_development_dependency("cane")
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("rspec")
+  gem.add_development_dependency("simplecov")
+  gem.add_development_dependency("standard")
+  gem.add_development_dependency("yard")
   # gem.add_development_dependency('pry-debugger')
 end

data/lib/haproxy-tools.rb

@@ -1 +1,3 @@
-require 'haproxy_tools'
+# frozen_string_literal: true
+
+require "haproxy_tools"

data/lib/haproxy/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HAProxy
   Default   = Struct.new(:name, :options, :config)
   Backend   = Struct.new(:name, :options, :config, :servers)
@@ -16,12 +18,11 @@ module HAProxy
       new_server.host       = host
       new_server.port       = options[:port] if options[:port]
       new_server.attributes ||= options[:attributes] || {}
-      self.servers[name] = new_server
+      servers[name] = new_server
       new_server
     end
   end
 
-
   # Represents a listener configuration block.
   class Listener
     include ServerList
@@ -46,23 +47,23 @@ module HAProxy
     end
 
     def listener(name)
-      self.listeners.find { |l| l.name == name }
+      listeners.find { |l| l.name == name }
     end
 
     def backend(name)
-      self.backends.find { |b| b.name == name }
+      backends.find { |b| b.name == name }
     end
 
     def frontend(name)
-      self.frontends.find { |f| f.name == name }
+      frontends.find { |f| f.name == name }
     end
 
-    def default(name=nil)
-      self.defaults.find { |d| d.name == name }
+    def default(name = nil)
+      defaults.find { |d| d.name == name }
     end
 
     def render
-      renderer = HAProxy::Renderer.new(self, self.original_parse_tree)
+      renderer = HAProxy::Renderer.new(self, original_parse_tree)
       renderer.render
     end
 
@@ -75,4 +76,3 @@ module HAProxy
     end
   end
 end
-

data/lib/haproxy/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HAProxy
   # Responsible for reading an HAProxy config file and building an HAProxy::Config instance.
   class Parser
@@ -5,42 +7,51 @@ module HAProxy
     Error = Class.new(StandardError)
 
     # haproxy 1.3
-    SERVER_ATTRIBUTE_NAMES_1_3 = %w{
+    SERVER_ATTRIBUTE_NAMES_1_3 = %w[
       addr backup check cookie disabled fall id inter fastinter downinter
       maxconn maxqueue minconn port redir rise slowstart source track weight
-    }
+    ]
     # Added in haproxy 1.4
-    SERVER_ATTRIBUTE_NAMES_1_4 = %w{error-limit observe on-error}
+    SERVER_ATTRIBUTE_NAMES_1_4 = %w[error-limit observe on-error]
     # Added in haproxy 1.5
-    SERVER_ATTRIBUTE_NAMES_1_5 = %w{ 
+    SERVER_ATTRIBUTE_NAMES_1_5 = %w[
       agent-check agent-inter agent-port ca-file check-send-proxy check-ssl
       ciphers crl-file crt error-limit force-sslv3 force-tlsv10 force-tlsv11
       force-tlsv12 no-sslv3 no-tls-tickets no-tlsv10 no-tlsv11 no-tlsv12 non-stick observe
       on-error on-marked-down on-marked-up send-proxy send-proxy-v2 send-proxy-v2-ssl
       send-proxy-v2-ssl-cn ssl verify verifyhost
-    }
+    ]
     # Added in haproxy 1.6
-    SERVER_ATTRIBUTE_NAMES_1_6 = %w{
+    SERVER_ATTRIBUTE_NAMES_1_6 = %w[
       namespace no-ssl-reuse resolve-prefer resolvers sni tcp-ut
-    }
+    ]
     # Added in haproxy 1.7
-    SERVER_ATTRIBUTE_NAMES_1_7 = %w{
+    SERVER_ATTRIBUTE_NAMES_1_7 = %w[
       agent-send init-addr resolve-net
-    }
-    SERVER_ATTRIBUTE_NAMES_1_8 = %w{
+    ]
+    SERVER_ATTRIBUTE_NAMES_1_8 = %w[
       agent-addr check-sni enabled force-tlsv13 no-agent-check no-backup no-check no-check-ssl
-      no-send-proxy no-send-proxy-v2 no-send-proxy-v2-ssl no-send-proxy-v2-ssl-cn no-ssl no-tlsv13 
+      no-send-proxy no-send-proxy-v2 no-send-proxy-v2-ssl no-send-proxy-v2-ssl-cn no-ssl no-tlsv13
       no-verifyhost ssl-max-ver ssl-min-ver ssl-reuse stick tls-tickets
-    }
-    # SERVER_ATTRIBUTE_NAMES_1_9 = %w{ } # as of 1/16/18 I do not see new server attributes in haproxy 1.9
-    SERVER_ATTRIBUTE_NAMES = SERVER_ATTRIBUTE_NAMES_1_3 + SERVER_ATTRIBUTE_NAMES_1_4 + SERVER_ATTRIBUTE_NAMES_1_5 \
-      + SERVER_ATTRIBUTE_NAMES_1_6 + SERVER_ATTRIBUTE_NAMES_1_7 + SERVER_ATTRIBUTE_NAMES_1_8
+    ]
+    SERVER_ATTRIBUTE_NAMES_1_9 = %w[
+      alpn check-alpn max-reuse npn pool-max-conn pool-purge-delay proto proxy-v2-options
+    ].freeze
+    SERVER_ATTRIBUTE_NAMES = [
+      SERVER_ATTRIBUTE_NAMES_1_3,
+      SERVER_ATTRIBUTE_NAMES_1_4,
+      SERVER_ATTRIBUTE_NAMES_1_5,
+      SERVER_ATTRIBUTE_NAMES_1_6,
+      SERVER_ATTRIBUTE_NAMES_1_7,
+      SERVER_ATTRIBUTE_NAMES_1_8,
+      SERVER_ATTRIBUTE_NAMES_1_9,
+    ].flatten.freeze
 
     attr_accessor :verbose, :options, :parse_result
 
     def initialize(options = nil)
       options ||= {}
-      options = { :verbose => false }.merge(options)
+      options = {verbose: false}.merge(options)
 
       self.options = options
       self.verbose = options[:verbose]
@@ -48,7 +59,7 @@ module HAProxy
 
     def parse_file(filename)
       config_text = File.read(filename)
-      self.parse(config_text)
+      parse(config_text)
     end
 
     def parse(config_text)
@@ -131,22 +142,18 @@ module HAProxy
       result.defaults.map { |ds| build_default(ds) }
     end
 
-
     def try_send(node, *method_names)
       method_name = method_names.shift
       if node.respond_to?(method_name)
         next_node = node.send(method_name)
         method_names.empty? ? next_node : try_send(next_node, *method_names)
-      else
-        nil
       end
     end
 
     def server_hash_from_config_section(cs)
-      cs.servers.inject({}) do |ch, s|
+      cs.servers.each_with_object({}) do |s, ch|
         value = try_send(s, :value, :content)
         ch[s.name] = Server.new(s.name, s.host, s.port, parse_server_attributes(value))
-        ch
       end
     end
 
@@ -161,46 +168,42 @@ module HAProxy
     def parse_server_attributes(value)
       parts = value.to_s.split(/\s/)
       current_name = nil
-      pairs = parts.inject({}) do |pairs, part|
+      pairs = parts.each_with_object({}) { |part, attrs|
         if SERVER_ATTRIBUTE_NAMES.include?(part)
-          current_name  = part
-          pairs[current_name] = []
+          current_name = part
+          attrs[current_name] = []
         elsif current_name.nil?
           raise "Invalid server attribute: #{part}"
         else
-          pairs[current_name] << part
+          attrs[current_name] << part
         end
-        pairs
-      end
+      }
 
-      return clean_parsed_server_attributes(pairs)
+      clean_parsed_server_attributes(pairs)
     end
 
     # Converts attributes with no values to true, and combines everything else into space-
     # separated strings.
     def clean_parsed_server_attributes(pairs)
-      pairs.each do |k,v|
-        if v.empty?
-          pairs[k] = true
+      pairs.each do |k, v|
+        pairs[k] = if v.empty?
+          true
         else
-          pairs[k] = v.join(' ')
+          v.join(" ")
         end
       end
     end
 
     def options_hash_from_config_section(cs)
-      cs.option_lines.inject({}) do |ch, l|
+      cs.option_lines.each_with_object({}) do |l, ch|
         ch[l.keyword.content] = l.value ? l.value.content : nil
-        ch
       end
     end
 
     def config_hash_from_config_section(cs)
-      cs.config_lines.reject{|l| l.keyword.content == 'option'}.inject({}) do |ch, l|
+      cs.config_lines.reject {|l| l.keyword.content == "option"}.each_with_object({}) do |l, ch|
         ch[l.keyword.content] = l.value ? l.value.content : nil
-        ch
       end
     end
-
   end
-end
+end

data/lib/haproxy/renderer.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module HAProxy
   # Responsible for rendering an HAProxy::Config instance to a string.
   class Renderer
-
     attr_accessor :config, :source_tree
 
     def initialize(config, source_tree)
@@ -11,11 +12,11 @@ module HAProxy
       @config_list      = {}
       @context          = self.config
       @prev_context     = self.config
-      @config_text      = ''
+      @config_text      = "".dup
     end
 
     def render
-      render_node(self.source_tree)
+      render_node(source_tree)
       handle_context_change
       @config_text
     end
@@ -33,18 +34,19 @@ module HAProxy
           next if @context.servers[e.name].nil?
         end
 
-        if e.class == HAProxy::Treetop::ConfigLine and @context.class == HAProxy::Default
-          # Keep track of the configs in this config block we've seen, so that we can detect and render new ones.
+        if (e.class == HAProxy::Treetop::ConfigLine) && (@context.class == HAProxy::Default)
+          # Keep track of the configs in this config block we've seen, so that
+          # we can detect and render new ones.
           @config_list[e.key] = e
           # Don't render the config *if* it's been removed from the config block.
-          next if @context.config[e.key].nil?
+          next unless @context.config.key?(e.key)
         end
 
         if e.class == HAProxy::Treetop::ServerLine
           # Use a custom rendering method for servers, since we allow them to be
           # added/removed/changed.
           render_server_element(e)
-        elsif e.class== HAProxy::Treetop::ConfigLine and @context.class == HAProxy::Default
+        elsif (e.class == HAProxy::Treetop::ConfigLine) && (@context.class == HAProxy::Default)
           # Use a custom rendering method for configs, since we allow them to be
           # added/removed/changed.
           render_config_line_element(e)
@@ -64,14 +66,15 @@ module HAProxy
     end
 
     def render_config_line_element(e)
-      config_key = e.key.gsub(/\s+/, ' ')
+      config_key = e.key.gsub(/\s+/, " ")
       config_value = @context.config[e.key]
-      config_value = config_value.gsub(/\s+/, ' ') if not config_value.nil?
+      config_value = config_value.gsub(/\s+/, " ") unless config_value.nil?
       render_config_line(config_key, config_value)
     end
 
     def render_config_line(key, value)
-      @config_text << "\t#{key} #{value}\n"
+      content = "#{key} #{value}".strip
+      @config_text << "\t#{content}\n"
     end
 
     def render_server_element(e)
@@ -81,7 +84,8 @@ module HAProxy
 
     def render_server(server)
       attribute_string = render_server_attributes(server.attributes)
-      @config_text << "\tserver #{server.name} #{server.host}:#{server.port} #{attribute_string}\n"
+      content = "server #{server.name} #{server.host}:#{server.port} #{attribute_string}".strip
+      @config_text << "\t#{content}\n"
     end
 
     def handle_context_change
@@ -108,7 +112,7 @@ module HAProxy
     end
 
     def render_server_attributes(attributes)
-      attribute_string = ""
+      attribute_string = "".dup
       attributes.each do |name, value|
         attribute_string << name.to_s
         attribute_string << " "
@@ -123,18 +127,18 @@ module HAProxy
     def update_render_context(e)
       @prev_context = @context
       case e.class.name
-      when 'HAProxy::Treetop::GlobalSection'
+      when "HAProxy::Treetop::GlobalSection"
         @context = @config.global
-      when 'HAProxy::Treetop::DefaultsSection'
+      when "HAProxy::Treetop::DefaultsSection"
         section_name = e.defaults_header.proxy_name ? e.defaults_header.proxy_name.content : nil
         @context = @config.default(section_name)
-      when 'HAProxy::Treetop::ListenSection'
+      when "HAProxy::Treetop::ListenSection"
         section_name = e.listen_header.proxy_name ? e.listen_header.proxy_name.content : nil
         @context = @config.listener(section_name)
-      when 'HAProxy::Treetop::FrontendSection'
+      when "HAProxy::Treetop::FrontendSection"
         section_name = e.frontend_header.proxy_name ? e.frontend_header.proxy_name.content : nil
         @context = @config.frontend(section_name)
-      when 'HAProxy::Treetop::BackendSection'
+      when "HAProxy::Treetop::BackendSection"
         section_name = e.backend_header.proxy_name ? e.backend_header.proxy_name.content : nil
         @context = @config.backend(section_name)
       else
@@ -143,4 +147,3 @@ module HAProxy
     end
   end
 end
-

data/lib/haproxy/treetop/config.treetop

@@ -88,7 +88,7 @@ module HAProxy::Treetop
     end
 
     rule keyword
-       (("errorfile" / "timeout") whitespace)? [a-z0-9\-\.]+ <Keyword>
+       (("errorfile" / "timeout") whitespace)? [a-z0-9_\-\.]+ <Keyword>
     end
 
     rule server_name

data/lib/haproxy/treetop/nodes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HAProxy
   module Treetop
     extend self
@@ -5,53 +7,54 @@ module HAProxy
     # Include this module to always strip whitespace from the text_value
     module StrippedTextContent
       def content
-        self.text_value.strip
+        text_value.strip
       end
     end
 
     # Include this module if the node contains a config element.
     module ConfigBlockContainer
       def option_lines
-        self.config_block.elements.select {|e| e.class == OptionLine}
+        config_block.elements.select {|e| e.class == OptionLine}
       end
 
       def config_lines
-        self.config_block.elements.select {|e| e.class == ConfigLine}
+        config_block.elements.select {|e| e.class == ConfigLine}
       end
     end
 
     # Include this module if the node contains a service address element.
     module ServiceAddressContainer
       def service_address
-        self.elements.find {|e| e.class == ServiceAddress }
+        elements.find {|e| e.class == ServiceAddress }
       end
 
       def host
-        self.service_address.host.text_value.strip
+        service_address.host.text_value.strip
       end
 
       def port
-        self.service_address.port.text_value.strip
+        service_address.port.text_value.strip
       end
     end
 
     # Include this module if the node contains a server elements.
     module ServerContainer
       def servers
-        self.config_block.elements.select {|e| e.class == ServerLine}
+        config_block.elements.select {|e| e.class == ServerLine}
       end
     end
 
     # Include this module if the value is optional for the node.
     module OptionalValueElement
       def value
-        self.elements.find {|e| e.class == Value}
+        elements.find {|e| e.class == Value}
       end
     end
 
+    # Helper class for whitespace nodes
     class Whitespace < ::Treetop::Runtime::SyntaxNode
       def content
-        self.text_value
+        text_value
       end
     end
 
@@ -102,18 +105,18 @@ module HAProxy
       include StrippedTextContent
     end
 
+    # Helper class for config nodes
     class ConfigLine < ::Treetop::Runtime::SyntaxNode
       include StrippedTextContent
       include OptionalValueElement
 
       def key
-        self.keyword.content
+        keyword.content
       end
 
       def attribute
-        self.value.content
+        value.content
       end
-
     end
 
     class OptionLine < ::Treetop::Runtime::SyntaxNode
@@ -121,13 +124,14 @@ module HAProxy
       include OptionalValueElement
     end
 
+    # Helper class for server nodes
     class ServerLine < ::Treetop::Runtime::SyntaxNode
       include StrippedTextContent
       include ServiceAddressContainer
       include OptionalValueElement
 
       def name
-        self.server_name.content
+        server_name.content
       end
     end
 
@@ -135,10 +139,11 @@ module HAProxy
       include StrippedTextContent
     end
 
+    # Helper class for defaults header nodes
     class DefaultsHeader < ::Treetop::Runtime::SyntaxNode
       include StrippedTextContent
       def proxy_name
-        self.elements.select {|e| e.class == ProxyName}.first
+        elements.select {|e| e.class == ProxyName}.first
       end
     end
 
@@ -187,41 +192,44 @@ module HAProxy
       include ServerContainer
     end
 
+    # Helper class for the root config file node
     class ConfigurationFile < ::Treetop::Runtime::SyntaxNode
       def global
-        self.elements.select {|e| e.class == GlobalSection}.first
+        elements.select {|e| e.class == GlobalSection}.first
       end
 
       def defaults
-        self.elements.select {|e| e.class == DefaultsSection}
+        elements.select {|e| e.class == DefaultsSection}
       end
 
       def listeners
-        self.elements.select {|e| e.class == ListenSection}
+        elements.select {|e| e.class == ListenSection}
       end
 
       def frontends
-        self.elements.select {|e| e.class == FrontendSection}
+        elements.select {|e| e.class == FrontendSection}
       end
 
       def backends
-        self.elements.select {|e| e.class == BackendSection}
+        elements.select {|e| e.class == BackendSection}
       end
     end
 
     def print_node(e, depth, options = nil)
       options ||= {}
-      options = {:max_depth => 2}.merge(options)
+      options = {max_depth: 2}.merge(options)
 
       puts if depth == 0
       print "--" * depth
-      print " #{e.class.name.split('::').last}"
+      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)
+      if depth < options[:max_depth] && e.elements && !e.respond_to?(:content)
+        e.elements.each do |child|
+          print_node(child, depth + 1, options)
+        end
+      end
     end
   end
 end