template_configurator 1.0.0

data/README.md

@@ -0,0 +1,60 @@
+# Template Configurator
+
+Template Configurator is a utility to write configuration files from ERB templates. When the file's content changes, it can then call an init script to intelligently reload the configuration. Through out the entire process exclusive file locks are used on the output file and json file to help ensure they are unmanipulated during the transformation process.
+
+## Use Cases
+
+* Dynamically configure HAProxy to pick up new backends contained in a JSON file. Call "service haproxy reload" when the configuration changes.
+* Dynamically configure NGinx to pick up new backends contained in a JSON file. Call "service nginx reload" when the configuration changes.
+* Dynamically configure Varnish to pick up new backends contained in a JSON file. Call "service varnish reload" when the configuration changes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'template_configurator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install template_configurator
+
+## Usage
+
+    Usage: bin/template_configurator
+            --service:command EXECUTABLE action to execute to command service (default: /sbin/service)
+            --service:name INITRC        initrc used to control service (default: )
+            --service:status ACTION      action to execute to get status of service (default: status)
+            --service:reload ACTION      action to execute to reload service (default: reload)
+            --service:restart ACTION     action to execute to restart service (default: restart)
+            --service:start ACTION       action to execute to start service (default: start)
+            --service:stop ACTION        action to execute to stop service (default: stop)
+            --service:retries NUMBER     number of attempts to reload service (default: 5)
+            --service:retry-delay SECS   seconds to sleep between retries (default: 2)
+            --template:input-file FILE   Where to read ERB template
+            --template:output-file FILE  Where to write the output of the template
+            --template:json-file FILE    Base port to initialize haproxy listening for mysql clusters
+            --log:level LEVEL            Logging level
+            --log:file FILE              Write logs to FILE (default: STDERR)
+            --log:age DAYS               Rotate logs after DAYS pass (default: 7)
+            --log:size SIZE              Rotate logs after the grow past SIZE bytes
+            --dry-run                    Dry run (do not commit changes to disk)
+        -V, --version                    Display version information
+        -h, --help                       Display this screen
+
+## Examples
+
+Generate a new configuration file in /tmp/test.cfg using /tmp/test.cfg.erb using JSON data from /tmp/test.js. Reload "test" service when configuration changes.
+
+    template_configurator --template:input-file "/tmp/test.cfg.erb" --template:output-file "/tmp/test.cfg" --template:json-file "/tmp/test.js" --service:name "test"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/template_configurator

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+#
+# Template Configurator - A utility to generate configuration files from ERB templates and restart
+# services when configuration changes.
+#
+# Copyright (C) 2012 Erik Osterman <e@osterman.com>
+# 
+# This file is part of Template Configurator.
+# 
+# Template Configurator is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Template Configurator is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with Template Configurator.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+$:.unshift(File.expand_path('.')) # Ruby 1.9 doesn't have . in the load path...
+$:.push(File.expand_path('lib/')) 
+
+require 'rubygems'
+require 'template_configurator'
+
+command_line = TemplateConfigurator::CommandLine.new
+command_line.execute

data/lib/template_configurator/command_line.rb

@@ -0,0 +1,191 @@
+#
+# Template Configurator - A utility to generate configuration files from ERB templates and restart
+# services when configuration changes.
+#
+# Copyright (C) 2012 Erik Osterman <e@osterman.com>
+# 
+# This file is part of Template Configurator.
+# 
+# Template Configurator is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Template Configurator is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with Template Configurator.  If not, see <http://www.gnu.org/licenses/>.
+#
+require 'optparse'
+require 'logger'
+
+module TemplateConfigurator
+  class CommandLine
+    def initialize
+      @logger = Logger.new STDERR
+
+      @options = {}
+      @options[:log] = {}
+      @options[:template] = {}
+      @options[:service] = {}
+
+      args = OptionParser.new do |opts|
+        opts.banner = "Usage: #{$0}"
+
+        #
+        # Service options
+        #
+        @options[:service][:command] = '/sbin/service'
+        opts.on("--service:command EXECUTABLE", "action to execute to command service (default: #{@options[:service][:command]})") do |executable|
+          @options[:service][:command] = executable
+        end
+
+        @options[:service][:name] = nil
+        opts.on("--service:name INITRC", "initrc used to control service (default: #{@options[:service][:name]})") do |initrc|
+          @options[:service][:name] = initrc
+        end
+
+        @options[:service][:status] = 'status'
+        opts.on("--service:status ACTION", "action to execute to get status of service (default: #{@options[:service][:status]})") do |action|
+          @options[:service][:status] = action
+        end
+
+        @options[:service][:reload] = 'reload'
+        opts.on("--service:reload ACTION", "action to execute to reload service (default: #{@options[:service][:reload]})") do |action|
+          @options[:service][:reload] = action
+        end
+
+        @options[:service][:restart] = 'restart'
+        opts.on("--service:restart ACTION", "action to execute to restart service (default: #{@options[:service][:restart]})") do |action|
+          @options[:service][:restart] = action
+        end
+
+        @options[:service][:start] = 'start'
+        opts.on("--service:start ACTION", "action to execute to start service (default: #{@options[:service][:start]})") do |action|
+          @options[:service][:start] = action
+        end
+
+        @options[:service][:stop] = 'stop'
+        opts.on("--service:stop ACTION", "action to execute to stop service (default: #{@options[:service][:stop]})") do |action|
+          @options[:service][:stop] = action
+        end
+
+
+        @options[:service][:retries] = 5
+        opts.on("--service:retries NUMBER", "number of attempts to reload service (default: #{@options[:service][:retries]})") do |number|
+          @options[:service][:retries] = number.to_i
+        end
+
+        @options[:service][:retry_delay] = 2
+        opts.on("--service:retry-delay SECS", "seconds to sleep between retries (default: #{@options[:service][:retry_delay]})") do |seconds|
+          @options[:service][:retry_delay] = seconds.to_i
+        end
+
+        #
+        # Template options
+        #
+
+        @options[:template][:input_file] = nil
+        opts.on("--template:input-file FILE", "Where to read ERB template") do |file|
+          @options[:template][:input_file] = file
+        end
+
+        @options[:template][:output_file] = nil
+        opts.on("--template:output-file FILE", "Where to write the output of the template") do |file|
+          @options[:template][:output_file] = file
+        end
+
+        @options[:template][:json_file] = nil
+        opts.on("--template:json-file FILE", "Base port to initialize haproxy listening for mysql clusters") do |file|
+          @options[:template][:json_file] = file
+        end
+
+        #
+        # Logging
+        #
+
+        @options[:log][:level] = Logger::INFO
+        opts.on( '--log:level LEVEL', 'Logging level' ) do|level|
+          @options[:log][:level] = Logger.const_get level.upcase
+        end
+
+        @options[:log][:file] = STDERR
+        opts.on( '--log:file FILE', 'Write logs to FILE (default: STDERR)' ) do|file|
+          @options[:log][:file] = File.open(file, File::WRONLY | File::APPEND | File::CREAT)
+        end
+
+        @options[:log][:age] = 7
+        opts.on( '--log:age DAYS', "Rotate logs after DAYS pass (default: #{@options[:log][:age]})" ) do|days|
+          @options[:log][:age] = days.to_i
+        end
+
+        @options[:log][:size] = 1024*1024*10
+        opts.on( '--log:size SIZE', 'Rotate logs after the grow past SIZE bytes' ) do |size|
+          @options[:log][:size] = size.to_i
+        end
+
+
+        #
+        # General options
+        #
+
+        @options[:dry_run] = false
+        opts.on("--dry-run", "Dry run (do not commit changes to disk)") do 
+          @options[:dry_run] = true
+        end
+
+
+        opts.on( '-V', '--version', 'Display version information' ) do
+          puts "Template Configurator #{TemplateConfigurator::VERSION}"
+          puts "Copyright (C) 2012 Erik Osterman <e@osterman.com>"
+          puts "License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>"
+          puts "This is free software: you are free to change and redistribute it."
+          puts "There is NO WARRANTY, to the extent permitted by law."
+          exit
+        end
+
+        opts.on( '-h', '--help', 'Display this screen' ) do
+          puts opts
+          exit
+        end
+
+      end
+
+      begin
+        args.parse!
+        raise OptionParser::MissingArgument.new("--template:input-file") if @options[:template][:input_file].nil?
+      rescue OptionParser::MissingArgument => e
+        puts e.message
+        puts args
+        exit 1
+      rescue OptionParser::InvalidOption => e
+        puts e.message
+        puts args
+        exit 1
+      end
+    end
+
+    def execute
+      @processor = Processor.new(@options)
+      TemplateConfigurator.log = Logger.new(@options[:log][:file], @options[:log][:age], @options[:log][:size])
+      TemplateConfigurator.log.level = @options[:log][:level]
+      begin
+        @processor.render
+      rescue Interrupt => e
+        TemplateConfigurator.log.info("Aborting")
+      rescue NameError, ArgumentError => e
+        TemplateConfigurator.log.fatal(e.message)
+        TemplateConfigurator.log.debug(e.backtrace.join("\n"))
+        exit(1)
+      rescue Exception => e
+        TemplateConfigurator.log.fatal("#{e.class}: #{e.message}")
+        TemplateConfigurator.log.debug(e.backtrace.join("\n"))
+        exit(1)
+      end
+      exit(0)
+    end
+  end
+end

data/lib/template_configurator/processor.rb

@@ -0,0 +1,108 @@
+#
+# Template Configurator - A utility to generate configuration files from ERB templates and restart
+# services when configuration changes.
+#
+# Copyright (C) 2012 Erik Osterman <e@osterman.com>
+# 
+# This file is part of Template Configurator.
+# 
+# Template Configurator is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Template Configurator is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with Template Configurator.  If not, see <http://www.gnu.org/licenses/>.
+#
+require 'erb'
+require 'digest/sha1'
+require 'json'
+
+module TemplateConfigurator
+  class Processor
+    attr_accessor :service, :options, :locks
+
+    def lock file
+      @locks[:file] = File.open(file, File::RDWR|File::CREAT, 0644) 
+      @locks[:file].flock(File::LOCK_EX)
+      @locks[:file]
+    end
+
+    def unlock
+      @locks[:file].flock(File::LOCK_UN)
+      @locks[:file]
+    end
+
+    def initialize(options)
+      @options = options
+      @locks = {}
+      @service = Service.new(@options[:service])
+    end
+
+    def reload
+      if @options[:service][:name].nil?
+        TemplateConfigurator.log.info("service not specified; skipping reload")
+      else
+        begin
+          @service.conditional_reload
+        rescue ServiceException => e
+          TemplateConfigurator.log.error(e.message)
+          TemplateConfigurator.log.error(e.output) unless e.output.nil?
+        end
+      end
+    end
+
+    def render
+      @data = {}
+      unless @options[:template][:json_file].nil?
+        json_fh = lock(@options[:template][:json_file])
+        @data = JSON.parse(json_fh.read)
+      end
+      TemplateConfigurator.log.debug("json:[#{@data.inspect}]")
+      template = ERB.new(File.read(@options[:template][:input_file]), 0, '%<>')
+
+      if @options[:template][:output_file].nil?
+        output_fh = STDOUT
+        old_output = ""
+      else
+        output_fh = lock(@options[:template][:output_file])
+        old_output = output_fh.read
+      end
+      
+      new_output = template.result(binding)
+
+      new_sha1 = Digest::SHA1.hexdigest(new_output)
+      old_sha1 = Digest::SHA1.hexdigest(old_output)
+
+      TemplateConfigurator.log.debug("old_sha1:#{old_sha1} new_sha1:#{new_sha1}")
+
+      if new_sha1 == old_sha1
+        TemplateConfigurator.log.debug("SHA1 checksum unchanged")
+      else
+        TemplateConfigurator.log.info "SHA1 checksum changed"
+        # Write the new configuration
+        if @options[:dry_run]
+          TemplateConfigurator.log.debug("Not attemptig service reload due to dry-run")
+          output_fh.write new_output
+        elsif !@options[:template][:output_file].nil?
+          TemplateConfigurator.log.debug("writing new configuation (#{new_output.length} bytes)")
+          output_fh.rewind
+          output_fh.write(new_output)
+          output_fh.flush
+          output_fh.truncate(output_fh.pos)
+          output_fh.flush
+          reload()
+        else
+          TemplateConfigurator.log.debug("Not attemptig service reload due to missing output file parameter")
+          output_fh.write new_output
+        end
+      end
+
+    end
+  end
+end

data/lib/template_configurator/service.rb

@@ -0,0 +1,115 @@
+#
+# Template Configurator - A utility to generate configuration files from ERB templates and restart
+# services when configuration changes.
+#
+# Copyright (C) 2012 Erik Osterman <e@osterman.com>
+# 
+# This file is part of Template Configurator.
+# 
+# Template Configurator is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Template Configurator is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with Template Configurator.  If not, see <http://www.gnu.org/licenses/>.
+#
+require 'shellwords'
+
+module TemplateConfigurator
+  class ServiceException < Exception
+    attr_accessor :code, :output
+    def initialize(msg, code, output = nil)
+      @code = code
+      @output = output
+      super(msg)
+    end
+  end
+
+  class Service
+    attr_accessor :options
+    def initialize options
+      @options = options
+    end
+
+    def command action
+      args = []
+      args << @options[:command]
+      args << @options[:name]
+      args << action
+      TemplateConfigurator.log.debug("command args: #{args.inspect}")
+      Shellwords.join(args)
+    end
+
+    def execute command
+      TemplateConfigurator.log.debug("command: #{command}")
+      begin
+        output = %x{#{command}}
+        exit_code = $?.exitstatus
+        raise ServiceException.new("execution failed; #{command} exited with status #{exit_code}", exit_code, output) unless exit_code == 0
+      rescue Errno::ENOENT => e
+        raise ServiceException.new(e.message, 1)
+      end
+      return output
+    end
+
+    def status
+      execute command(@options[:status])
+    end
+
+    def restart
+      execute command(@options[:restart])
+    end
+
+    def reload
+      execute command(@options[:reload])
+    end
+
+    def start
+      execute command(@options[:start])
+    end
+
+    def stop
+      execute command(@options[:stop])
+    end
+
+    def conditional_reload
+      # Attempt to reload service if it's running, otherwise start it.
+      @options[:retries].times do 
+        begin
+          status_output = self.status
+          TemplateConfigurator.log.debug("#{@options[:name]} is running")
+          # If the configuration has changed, reload config
+          begin 
+            reload_output = self.reload
+            TemplateConfigurator.log.debug("Reload command succeeded")
+            return reload_output
+          rescue ServiceException => e
+            TemplateConfigurator.log.error(e.message)
+            TemplateConfigurator.log.error(e.output) unless e.output.nil?
+          end
+        rescue ServiceException => e
+          # service is not running
+          TemplateConfigurator.log.error(e.message)
+          TemplateConfigurator.log.error(e.output) unless e.output.nil?
+          begin
+            start_output = self.start
+            TemplateConfigurator.log.debug("Start command succeeded")
+            return start_output
+          rescue ServiceException => e
+            TemplateConfigurator.log.error(e.message)
+            TemplateConfigurator.log.error(e.output) unless e.output.nil?
+          end
+        end
+        sleep(@options[:retry_delay])
+      end
+      # Everything else failed. Try a restart
+      return self.restart
+    end
+  end
+end

data/lib/template_configurator/version.rb

@@ -0,0 +1,24 @@
+#
+# Template Configurator - A utility to generate configuration files from ERB templates and restart
+# services when configuration changes.
+#
+# Copyright (C) 2012 Erik Osterman <e@osterman.com>
+# 
+# This file is part of Template Configurator.
+# 
+# Template Configurator is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Template Configurator is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with Template Configurator.  If not, see <http://www.gnu.org/licenses/>.
+#
+module TemplateConfigurator
+  VERSION = "1.0.0"
+end

data/lib/template_configurator.rb

@@ -0,0 +1,37 @@
+#
+# Template Configurator - A utility to generate configuration files from ERB templates and restart
+# services when configuration changes.
+#
+# Copyright (C) 2012 Erik Osterman <e@osterman.com>
+# 
+# This file is part of Template Configurator.
+# 
+# Template Configurator is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Template Configurator is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with Template Configurator.  If not, see <http://www.gnu.org/licenses/>.
+#
+require "template_configurator/version"
+require 'template_configurator/service'
+require 'template_configurator/processor'
+require 'template_configurator/command_line'
+
+module TemplateConfigurator
+  @@logger = nil
+  
+  def self.log=(logger)
+    @@logger=logger
+  end
+
+  def self.log
+    @@logger
+  end
+end

data/template_configurator.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/template_configurator/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Erik Osterman"]
+  gem.email         = ["e@osterman.com"]
+  gem.summary       = %q{Template Configurator is a utility to write configuration files from ERB templates.}
+  gem.description   = %q{Template Configurator is a utility to write configuration files from ERB templates. When the file's content changes, it can then call an init script to intelligently reload the configuration. Through out the entire process exclusive file locks are used on the output file and json file to help ensure they are unmanipulated during the transformation process.}
+  gem.homepage      = "https://github.com/osterman/template_configurator"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "template_configurator"
+  gem.require_paths = ["lib"]
+  gem.version       = TemplateConfigurator::VERSION
+  gem.add_runtime_dependency 'json', '>= 1.4.3'
+end

data/test/test.cfg

@@ -0,0 +1,2 @@
+test1: value1
+test2: value2

data/test/test.cfg.erb

@@ -0,0 +1,2 @@
+test1: <%=@data['key1']%>
+test2: <%=@data['key2']%>

data/test/test.js

@@ -0,0 +1 @@
+{ "key1":"value1", "key2":"value2" }