consul-template-generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba8f1717006ac33f420edd8b83719bdb68aae412
+  data.tar.gz: c0069022ebf8e26f26565428d15d7d553b791169
+SHA512:
+  metadata.gz: 63b020316a8f3291225f0ecc82e95e9ecd60b0a99205ecad5c5e8089c6c19c457422a292959fb724ee38dc60a9e1aea4e4b6b21924fe3fd2cb41fa1495ac29ae
+  data.tar.gz: 05eec4beb3cd09c1135ae92c59ded085fb678adec808ce483ff38f0fe35ead70510f439713c64a6e5bf0ebce7856ad205b2f7ed4e751cb17ba313b657bc0e6b4

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+*.swp
+bin/*
+!bin/consul-template-generator
+.bundle/
+coverage/
+install.sh
+test.rb

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    consul-template-generator (0.1.0)
+      diplomat (~> 0.12.0)
+      popen4 (~> 0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Platform (0.4.0)
+    addressable (2.3.8)
+    colorize (0.7.7)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    diplomat (0.12.0)
+      faraday (~> 0.9)
+      json (~> 1.8)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    hirb (0.7.3)
+    json (1.8.3)
+    multipart-post (2.0.0)
+    open4 (1.3.4)
+    popen4 (0.1.2)
+      Platform (>= 0.4.0)
+      open4 (>= 0.4.0)
+    rack (1.6.1)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.0)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    safe_yaml (1.0.4)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.2.0)
+      colorize
+      hirb
+      simplecov
+    simplecov-html (0.10.0)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  consul-template-generator!
+  rack (~> 1.6)
+  rake (~> 10.0)
+  rspec (~> 3.3)
+  simplecov (~> 0.10)
+  simplecov-console (~> 0.2)
+  webmock (~> 1.21)

data/bin/consul-template-generator

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+require 'optparse' 
+require 'consul/template/generator/cmd'
+
+include Consul::Template::Generator
+
+def verify_opts(opts)
+  !opts[:key].nil? && !opts[:template].nil?
+end
+
+
+options = {}
+opt_parser = OptionParser.new do |opts|
+  opts.banner = <<EOC
+consul-template-generator [options] <command>
+
+Available commands:
+  once    -- Run once and exit.  On success, the rendered template will be inserted into the KV store whether or not it has changed.
+  run     -- Run continually, uploading the rendered template when a change is detected.
+
+Options:
+EOC
+
+  options[:consul] = '127.0.0.1:8500'
+  opts.on('-c HOSTNAME', '--consul HOSTNAME', 'Hostname/port used to connect to consul [default: 127.0.0.1:8500]') do |h|
+    options[:consul] = h
+  end
+
+  options[:template] = nil
+  opts.on('-t TEMPLATE', '--template TEMPLATE', 'Consul-Template ctmpl file to monitor (required)') do |t|
+    options[:template] = t
+  end
+
+  options[:key] = nil
+  opts.on('-k KEY', '--key KEY', 'Key to store rendered template in (required)') do |k|
+    options[:key] = k
+  end
+
+  options[:proxy] = nil
+  opts.on('-p PROXY_URL', '--proxy PROXY_URL', 'Proxy URL if required (e.g. http://proxy.example.com:3128)') do |p|
+    options[:proxy] = p
+  end
+
+  options[:unset_proxy] = false
+  opts.on(nil, '--unset-proxy', "Use if 'http_proxy' is set in your environment, but you don't want to use it...") do |u|
+    options[:unset_proxy] = true
+  end
+
+  options[:log_level] = :info
+  opts.on('-l LOG_LEVEL', '--log-level LOG_LEVEL', "Log level, options are 'debug', 'info', 'error' [default: info]") do |l|
+    options[:log_level] = l.to_sym
+  end
+end
+
+opt_parser.parse!
+
+unless verify_opts(options)
+  STDOUT.puts "Both '--key' and '--template' must be provided"
+  puts opt_parser
+  exit(1)
+end
+
+if options[:unset_proxy]
+  ENV['http_proxy'] = nil
+end
+
+CMD.configure(options[:consul], options[:template], options[:key], options[:log_level], options[:proxy])
+
+ec = 1
+cmd = ARGV[0]
+case cmd
+when 'run'
+    ec = CMD.run
+when 'once'
+    ec = CMD.run_once
+else
+  puts "Unknown command: #{cmd}"
+  puts opt_parser
+end
+
+exit(ec)

data/consul-template-generator.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'consul/template/generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'consul-template-generator'
+  spec.version       = Consul::Template::Generator::VERSION
+  spec.authors       = ['Brian Oldfield']
+  spec.email         = ['brian.oldfield@socrata.com']
+  spec.summary       = %q{Wrapper around consul template which uploads renterd templates to consul's KV store}
+  spec.description   = %q{When using complex consul-template templates or distributing them across many hosts, you run the risk of DoSing your consul cluster.  Using consul-template-generator you can instead delegate the watching/rendering of templates to a single host and have downstream clients instead use a simple consul-template KV watch to retrieve the template and write it to disk.}
+  spec.homepage      = 'http://github.com/boldfield/consul-template-generator'
+  spec.license       = 'Apache'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/consul-template-generator}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+  spec.add_development_dependency 'simplecov-console', '~> 0.2'
+  spec.add_development_dependency 'webmock', '~> 1.21'
+  spec.add_development_dependency 'rack', '~> 1.6'
+  spec.add_dependency 'diplomat', '~> 0.12.0'
+  spec.add_dependency 'popen4', '~> 0.1.2'
+end

data/lib/consul/template/generator.rb

@@ -0,0 +1,69 @@
+require_relative 'generator/cmd'
+require_relative 'generator/ct'
+require_relative 'generator/configuration'
+require_relative 'generator/error'
+require_relative 'generator/init'
+require_relative 'generator/key_value'
+require_relative 'generator/run'
+require_relative 'generator/version'
+
+require 'diplomat'
+require 'faraday'
+
+module Consul
+  module Template
+    module Generator
+      class << self
+        attr_accessor :config
+        attr_accessor :create_session, :renew_session, :destroy_session
+        def configure
+          self.config ||= Consul::Template::Generator::Configuration.new
+          self.config.node = `hostname`.strip
+          self.config.consul_host = '127.0.0.1:8500'
+
+          yield self.config
+
+          if self.config.consul_template_binary.nil?
+            ct_binary = `which consul-template`.strip
+            if ct_binary.empty?
+              raise "consul-template must be in your $PATH or configure the location to the executable"
+            end
+            self.config.consul_template_binary = ct_binary
+          end
+
+          if self.config.template.nil?
+            raise "template must be defined in configuration"
+          end
+
+          if self.config.template_key.nil?
+            raise "template_key must be defined in configuration"
+          end
+
+          Diplomat.configure do |config|
+            config.url = "http://#{self.config.consul_host}"
+            config.options = self.config.client_options
+          end
+        end
+
+        def create_session(name)
+          Diplomat::Session.create({:Node => self.config.node, :Name => name})
+        end
+
+        def renew_session(sess_id)
+          # There is an outstanding bug in Diplomat::Session.renew with a PR to fix
+          # https://github.com/WeAreFarmGeek/diplomat/issues/43
+          # Until it's merged and release, we have to skip renewing sessions...
+          begin
+            #Diplomat::Session.renew sess_id
+          rescue Faraday::ResourceNotFound
+            raise ConsulSessionExpired
+          end
+        end
+
+        def destroy_session(sess_id)
+          Diplomat::Session.destroy sess_id
+        end
+      end
+    end
+  end
+end

data/lib/consul/template/generator/cmd.rb

@@ -0,0 +1,71 @@
+require 'consul/template/generator'
+
+module Consul
+  module Template
+    module Generator
+      module CMD
+        include Consul::Template::Generator
+
+        def self.configure(consul_host, template, template_key, log_level, proxy = nil)
+          Consul::Template::Generator.configure do |config|
+            config.log_level = log_level
+            config.template = template
+            config.template_key = template_key
+            config.consul_host = consul_host
+          end
+        end
+
+        def self.run
+          config = Consul::Template::Generator.config
+          uploaded_hash = nil
+          begin
+            runner = CTRunner.new
+            runner.acquire_session_lock do
+              config.logger.info "Session lock acquired..."
+              begin
+                uploaded_hash = runner.run(uploaded_hash) || uploaded_hash
+                sleep 5
+              rescue Interrupt
+                raise # Re-raise to break this rescue block
+              rescue ConsulSessionExpired
+                config.logger.error "The current consul session has expired."
+                break
+              rescue Exception => e
+                config.logger.error "An error occurred while updating template: #{e.message}"
+                config.logger.debug "Sleeping before attempting to update again..."
+                sleep 5
+                break
+              end until false
+            end
+          rescue Interrupt
+            config.logger.error "Recieved interrupt signal, exiting..."
+            break
+          rescue Exception => e
+            config.logger.info "Unable to obtain session lock: #{e.message}"
+            config.logger.debug "Sleeping before attempting lock session again..."
+            begin
+              sleep 5
+            rescue Interrupt
+              config.logger.error "Recieved interrupt signal, exiting..."
+              break
+            end
+          end until false
+          0
+        end
+
+        def self.run_once
+          config = Consul::Template::Generator.config
+          begin
+            runner = CTRunner.new
+            result = runner.run
+          rescue Exception => e
+            config.logger.error "An unexpected error occurred, unable to process template: #{e.message}"
+            1
+          else
+            0
+          end 
+        end 
+      end
+    end
+  end
+end

data/lib/consul/template/generator/configuration.rb

@@ -0,0 +1,65 @@
+module Consul
+  module Template
+    module Generator
+      module STDLogLvl
+        class << self
+          def debug() 1 end
+          def info() 2 end
+          def error() 3 end
+          def off() 4 end
+        end
+      end
+
+      module STDLogger
+        class << self
+          def do_log?(requested_lvl, curr_lvl)
+            curr_lvl = Consul::Template::Generator::STDLogLvl.send(curr_lvl.to_sym)
+            requested_lvl = Consul::Template::Generator::STDLogLvl.send(requested_lvl.to_sym)
+            requested_lvl >= curr_lvl
+          end
+
+          def debug(msg)
+            if do_log?(:debug, Consul::Template::Generator.config.log_level)
+              STDOUT.puts "[DEBUG] #{msg}"
+            end
+          end
+
+          def info(msg)
+            if do_log?(:info, Consul::Template::Generator.config.log_level)
+              STDOUT.puts "[INFO] #{msg}"
+            end
+          end
+
+          def error(msg)
+            if do_log?(:error, Consul::Template::Generator.config.log_level)
+              STDERR.puts "[ERROR] #{msg}"
+            end
+          end
+        end
+      end
+
+      class Configuration
+        attr_accessor :template, :template_key, :consul_template_binary, :logger, :log_level
+        attr_accessor :consul_host, :node, :client_options
+
+        def initialize
+          @log_level = :debug
+          @node = nil
+          @consul_host = nil
+          @template = nil
+          @template_key = nil
+          @client_options = {}
+          @logger = Consul::Template::Generator::STDLogger
+        end
+
+        def lock_key
+          "/lock/#{@template_key.sub(/^\//, '')}"
+        end
+
+        def session_lock_key
+          "/lock/session/#{@template_key.sub(/^\//, '')}"
+        end
+      end
+    end
+  end
+end

data/lib/consul/template/generator/ct.rb

@@ -0,0 +1,23 @@
+require 'open4'
+require 'digest'
+
+module Consul
+  module Template
+    module Generator
+      class CTRunner
+        def render_template
+          body = nil
+          cmd = %{#{@config.consul_template_binary} -dry -once -template #{@config.template}}
+          procs = ::Open4.popen4(*cmd) do |pid, stdin, stdout, stderr|
+            body = stdout.read.strip
+            # consul-template -dry inserts '> \n' at the top of stdout, remove it
+            body.sub!(/^>\s+\n/, '')
+          end
+          status = procs.to_i
+          hash = ::Digest::MD5.hexdigest(body)
+          return status, body, hash
+        end
+      end
+    end
+  end
+end

data/lib/consul/template/generator/error.rb

@@ -0,0 +1,7 @@
+class ConsulSessionExpired < StandardError; end
+
+class KeyNotLockedError < StandardError; end
+
+class TemplateUploadError < StandardError; end
+
+class TemplateRenderError < StandardError; end

data/lib/consul/template/generator/init.rb

@@ -0,0 +1,17 @@
+module Consul
+  module Template
+    module Generator
+      class CTRunner
+        attr_accessor :session
+
+        def initialize(consul_session_id = nil)
+          if consul_session_id.nil?
+            consul_session_id = Consul::Template::Generator.create_session 'consul-template-generator'
+          end
+          @session = consul_session_id
+          @config = Consul::Template::Generator.config
+        end
+      end
+    end
+  end
+end

data/lib/consul/template/generator/key_value.rb

@@ -0,0 +1,42 @@
+require 'diplomat'
+
+module Consul
+  module Template
+    module Generator
+      class CTRunner
+
+        def acquire_lock(lock_key = nil)
+          lock_key ||= @config.lock_key
+          @config.logger.debug "Attempting to acquire lock on key: #{lock_key}"
+          Consul::Template::Generator.renew_session @session
+          unless Diplomat::Lock.acquire(lock_key, @session)
+            raise KeyNotLockedError, "Unable to acquire lock on key: #{lock_key}"
+          end
+          @config.logger.debug "Lock acquired on key: #{lock_key}"
+
+          begin
+            yield
+          ensure
+            Diplomat::Lock.release(lock_key, @session)
+          end
+        end
+
+        def acquire_session_lock
+          acquire_lock(@config.session_lock_key) do
+            yield
+          end
+        end
+
+        def upload_template(raw_template)
+          @config.logger.info "Uploading key: #{@config.template_key}"
+          begin
+            Diplomat::Kv.put(@config.template_key, raw_template)
+          rescue Exception => e
+            raise TemplateUploadError, "Encountered an unexpected error while uploading template: #{e.message}"
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/consul/template/generator/run.rb

@@ -0,0 +1,38 @@
+require 'consul/template/generator/ct'
+
+module Consul
+  module Template
+    module Generator
+      class CTRunner
+        def run(comp_hash = nil)
+          status, body, hash, uploaded_hash = nil, nil, nil, nil
+          acquire_lock do
+            @config.logger.debug "Attempting to render template: #{@config.template}"
+            status, body, hash = render_template
+            unless status == 0
+              raise TemplateRenderError, "consul-template exited with on-zero exit status"
+            end
+            if body.nil? || body.empty?
+              raise TemplateRenderError, "rendered template is nil or empty!"
+            end
+            @config.logger.debug "Template rendered..."
+            if comp_hash.nil? || comp_hash != hash
+              @config.logger.info "Change in template discovered, attempting to upload to key #{@config.template_key}"
+              @config.logger.debug "Existing hash: #{comp_hash || 'nil'}, new hash: #{hash}"
+              uploaded = upload_template(body)
+              if uploaded
+                @config.logger.info "New template uploaded..."
+                uploaded_hash = hash
+              else
+                raise TemplateUploadError, "Template not uploaded!"
+              end
+            else
+              @config.logger.info "No change in template, skipping upload..."
+            end
+          end
+          return uploaded_hash
+        end
+      end
+    end
+  end
+end

data/lib/consul/template/generator/version.rb

@@ -0,0 +1,7 @@
+module Consul
+  module Template
+    module Generator
+      VERSION = '0.1.0'
+    end
+  end
+end

data/spec/ct_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'stringio'
+
+require 'open4'
+require 'consul/template/generator'
+
+include Consul::Template::Generator
+
+def setup_open4(stdout, exit_code, pid)
+  @pid = pid
+  @status = exit_code
+  @stdin = StringIO.new
+  @stdout = StringIO.new
+  @stderr = StringIO.new
+
+  @stdout_string = "> \n#{stdout}"
+
+  @stdout << stdout
+  @stdout.rewind
+
+  allow(Open4).to receive(:popen4).and_yield(@pid, @stdin, @stdout, @stderr).and_return(@status)
+end
+
+describe 'Consul::Template::Generator::CTRunner' '#render_template' do
+  before do
+    Consul::Template::Generator.configure do |config|
+      config.template = '/etc/test-template.ctmpl'
+      config.template_key = '/test-template'
+    end
+  end
+
+  context 'render template' do
+    it 'runs successfully' do
+      exp_out = 'this is a test'
+      exp_hash = '54b0c58c7ce9f2a8b551351102ee0938'
+      setup_open4(exp_out, 0, 101)
+      runner = CTRunner.new('test-session')
+      exit_code, body, hash = runner.render_template
+      expect(body).to eql(exp_out)
+      expect(hash).to eql(exp_hash)
+      expect(exit_code).to eql(@status)
+    end
+  end
+end

data/spec/init_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'webmock'
+
+require 'consul/template/generator'
+
+include Consul::Template::Generator
+
+describe 'Consul::Template::Generator::CTRunner' '#initialize' do
+  before do
+    Consul::Template::Generator.configure do |config|
+      config.template = 'test-session-template.ctmpl'
+      config.template_key = 'test-session-template'
+      config.node = 'test-node'
+    end
+  end
+
+  context 'initialization of Consul::Template::Generator::CTRunner' do
+    it "creates session if token isn't passed" do
+      @runner = Consul::Template::Generator::CTRunner.new
+      expect(WebMock).to_not have_requested(:put, 'http://127.0.0.1:8500/v1/kv/session/create').with(:body => "{\"Node\": \"test-node\", \"Name\": \"consul-template-generator\"}")
+      expect(@runner.session).to eql('test-session-id')
+    end
+  end
+end

data/spec/key_value_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+require 'stringio'
+require 'webmock'
+
+require 'open4'
+require 'consul/template/generator'
+
+include Consul::Template::Generator
+
+describe 'Consul::Template::Generator::CTRunner' '#acquire_lock' do
+  before do
+    Consul::Template::Generator.configure do |config|
+      config.template = 'test-template.ctmpl'
+      config.template_key = '/test-template'
+      config.consul_host = '127.0.0.1:8500'
+      config.log_level = :off
+    end
+  end
+
+  context 'aquires lock' do
+    it 'clean lock acquisision' do
+      runner = CTRunner.new('test-session')
+      runner.acquire_lock do
+       expect(true).to be_truthy ## This is simply to assert we are able to execute code in the block
+      end
+      expect(WebMock).to have_requested(:put, 'http://127.0.0.1:8500/v1/kv/lock/test-template').with(:query => {:acquire => 'test-session'})
+      expect(WebMock).to have_requested(:put, 'http://127.0.0.1:8500/v1/kv/lock/test-template').with(:query => {:release => 'test-session'})
+    end
+
+    it 'handles being unable to acquire lock' do
+      runner = CTRunner.new('test-session-lock-fail')
+      expect { runner.acquire_lock { puts 'hi' } }.to raise_error(KeyNotLockedError)
+      expect(WebMock).to have_requested(:put, 'http://127.0.0.1:8500/v1/kv/lock/test-template').with(:query => {:acquire => 'test-session-lock-fail'})
+      expect(WebMock).to_not have_requested(:put, 'http://127.0.0.1:8500/v1/kv/lock/test-template').with(:query => {:release => 'test-session-lock-fail'})
+    end
+  end
+end
+
+describe 'Consul::Template::Generator::CTRunner' '#acquire_session_lock' do
+  before do
+    Consul::Template::Generator.configure do |config|
+      config.template = 'test-template.ctmpl'
+      config.template_key = '/test-template'
+      config.consul_host = '127.0.0.1:8500'
+      config.log_level = :off
+    end
+  end
+
+  context 'aquires session lock' do
+    it 'clean lock acquisision' do
+      runner = CTRunner.new('test-session')
+      runner.acquire_session_lock do
+       expect(true).to be_truthy ## This is simply to assert we are able to execute code in the block
+      end
+      expect(WebMock).to have_requested(:put, 'http://127.0.0.1:8500/v1/kv/lock/session/test-template').with(:query => {:acquire => 'test-session'})
+      expect(WebMock).to have_requested(:put, 'http://127.0.0.1:8500/v1/kv/lock/session/test-template').with(:query => {:release => 'test-session'})
+    end
+
+    it 'handles being unable to acquire session lock' do
+      runner = CTRunner.new('test-session-lock-fail')
+      expect { runner.acquire_session_lock { puts 'hi' } }.to raise_error(KeyNotLockedError)
+      expect(WebMock).to have_requested(:put, 'http://127.0.0.1:8500/v1/kv/lock/session/test-template').with(:query => {:acquire => 'test-session-lock-fail'})
+      expect(WebMock).to_not have_requested(:put, 'http://127.0.0.1:8500/v1/kv/session/lock/test-template').with(:query => {:release => 'test-session-lock-fail'})
+    end
+  end
+end
+
+describe 'Consul::Template::Generator::CTRunner' '#upload_template' do
+  context 'uploads template' do
+    before do
+      Consul::Template::Generator.configure do |config|
+        config.template = 'test-template.ctmpl'
+        config.template_key = '/test-template'
+        config.consul_host = '127.0.0.1:8500'
+        config.log_level = :off
+      end
+    end
+
+    it 'does a clean upload' do
+      runner = CTRunner.new('test-session')
+      success = runner.upload_template('this is a test')
+      expect(success).to be_truthy
+      expect(WebMock).to have_requested(:put, 'http://127.0.0.1:8500/v1/kv/test-template').with(:body => 'this is a test')
+    end
+  end
+
+  context 'handles template upload failure' do
+    before do
+      Consul::Template::Generator.configure do |config|
+        config.template = 'test-template.ctmpl'
+        config.template_key = '/test-template-failure'
+        config.consul_host = '127.0.0.1:8500'
+        config.log_level = :off
+      end
+    end
+
+    it 'does a clean upload' do
+      runner = CTRunner.new('test-session')
+      expect { runner.upload_template('this is a fail test') }.to raise_error(TemplateUploadError)
+      expect(WebMock).to have_requested(:put, 'http://127.0.0.1:8500/v1/kv/test-template-failure').with(:body => 'this is a fail test')
+    end
+  end
+end

data/spec/run_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+require 'consul/template/generator'
+
+include Consul::Template::Generator
+
+describe 'Consul::Template::Generator::CTRunner' '#run' do
+  before do
+    @runner = Consul::Template::Generator::CTRunner.new 'test-session'
+    allow(@runner).to receive(:acquire_lock).and_yield
+  end
+
+  context 'run' do
+    it 'handles a clean run' do
+      exp_hash = 'bbf9afe7431caf5f89a608bc31e8d822'
+      expect(@runner).to receive(:render_template).with(no_args).and_return([0, 'test body', exp_hash])
+      expect(@runner).to receive(:upload_template).with('test body').and_return(true)
+      hash = @runner.run
+      expect(hash).to eql(exp_hash)
+    end
+
+    it "does't upload unchanged template" do
+      exp_hash = 'bbf9afe7431caf5f89a608bc31e8d822'
+      expect(@runner).to receive(:render_template).with(no_args).and_return([0, 'test body', exp_hash])
+      expect(@runner).not_to receive(:upload_template)
+      hash = @runner.run exp_hash
+      expect(hash).to be_nil
+    end
+
+    it 'handles non-zero exit status' do
+      expect(@runner).to receive(:render_template).with(no_args).and_return([1, 'not used', 'not used'])
+      expect(@runner).not_to receive(:upload_template)
+      expect { @runner.run }.to raise_exception(TemplateRenderError)
+    end
+
+    it 'handles empty rendered template' do
+      expect(@runner).to receive(:render_template).with(no_args).and_return([0, '', 'not used'])
+      expect(@runner).not_to receive(:upload_template)
+      expect { @runner.run }.to raise_exception(TemplateRenderError)
+    end
+
+    it 'handles bad return from upload_template' do
+      exp_hash = 'bbf9afe7431caf5f89a608bc31e8d822'
+      expect(@runner).to receive(:render_template).with(no_args).and_return([0, 'test body', exp_hash])
+      expect(@runner).to receive(:upload_template).with('test body').and_return(false)
+      expect { @runner.run }.to raise_exception(TemplateUploadError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,112 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'webmock/rspec'
+require 'rack'
+require 'simplecov'
+require 'simplecov-console'
+
+WebMock.disable_net_connect!(allow_localhost: false)
+DIR = File.expand_path(File.dirname(__FILE__))
+
+class ConsulApiRack
+  def call(env)
+    code, ret = 500, 'The tests have changed, fix the rack'
+    case env['PATH_INFO']
+    when /\/v1\/session\/create/
+      code, ret = 200, "{\"ID\": \"test-session-id\"}"
+    when /\/v1\/kv\/lock\//
+      code, ret = process_lock(env['QUERY_STRING'])
+    when /\/v1\/kv\//
+      code, ret = process_upload(env['PATH_INFO'])
+    end
+    [code, { 'Content-Type' => 'application/json' }, [ret]]
+  end
+
+  def process_upload(path)
+    code, ret = 500, 'The tests have changed, fix the rack'
+    case path
+    when /^\/v1\/kv\/test-template$/
+      code, ret = 200, 'true'
+    when /^\/v1\/kv\/test-template-failure$/
+      code, ret = 500, 'false'
+    end
+    return code, ret
+  end
+
+  def process_lock(qs)
+    code, ret = 500, 'The tests have changed, fix the rack'
+    case qs
+    when /^acquire=test-session$/
+      code, ret = 200, 'true'
+    when /^acquire=test-session-lock-fail$/
+      code, ret = 200, 'false'
+    when /release=test-session/
+      code, ret = 200, 'true'
+    end
+    return code, ret
+  end
+end
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+  config.before(:each) do
+    stub_request(:any, /127.0.0.1:8500\//).
+      to_rack(ConsulApiRack.new)
+  end
+
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::Console
+]
+SimpleCov.minimum_coverage(85)
+SimpleCov.start
+
+def capture_stdout(&block)
+  original_stdout = $stdout
+  $stdout = fake = StringIO.new
+  begin
+    yield
+  ensure
+    $stdout = original_stdout
+  end
+  #fake.string
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: consul-template-generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Oldfield
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: diplomat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: popen4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+description: When using complex consul-template templates or distributing them across
+  many hosts, you run the risk of DoSing your consul cluster.  Using consul-template-generator
+  you can instead delegate the watching/rendering of templates to a single host and
+  have downstream clients instead use a simple consul-template KV watch to retrieve
+  the template and write it to disk.
+email:
+- brian.oldfield@socrata.com
+executables:
+- consul-template-generator
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- bin/consul-template-generator
+- consul-template-generator.gemspec
+- lib/consul/template/generator.rb
+- lib/consul/template/generator/cmd.rb
+- lib/consul/template/generator/configuration.rb
+- lib/consul/template/generator/ct.rb
+- lib/consul/template/generator/error.rb
+- lib/consul/template/generator/init.rb
+- lib/consul/template/generator/key_value.rb
+- lib/consul/template/generator/run.rb
+- lib/consul/template/generator/version.rb
+- spec/ct_spec.rb
+- spec/init_spec.rb
+- spec/key_value_spec.rb
+- spec/run_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/boldfield/consul-template-generator
+licenses:
+- Apache
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Wrapper around consul template which uploads renterd templates to consul's
+  KV store
+test_files:
+- spec/ct_spec.rb
+- spec/init_spec.rb
+- spec/key_value_spec.rb
+- spec/run_spec.rb
+- spec/spec_helper.rb
+has_rdoc: