davidrichards-appender 0.0.5

data/README.rdoc

@@ -0,0 +1,62 @@
+== Appender
+
+This is a general tool for cleaning configuration files and appending text in them.  The need for something like this occurs when some process is changing a configuration file but isn't necessarily the only process that manages that file.  If manual changes are allowed, or other deployment scripts are touching the same file, we want to only remove our own lines and append them to the file.  
+
+To do this with a little extra safety, appender log rotates the configuration file with a time-stamped history.  This way, rollbacks can be managed manually.
+
+The workflow is very basic:
+
+* Rotate the configuration file, in case a mistake has been made
+* Remove lines that match a pattern
+* Append some new configuration at the end of the file
+
+This doesn't mean the file looks pretty when we're finished.  
+
+When possible, a fully-owned configuration file makes more sense.  I.e., let Sprinkle, Puppet, Chef, whatever fully own a configuration file and make the changes in the configuration management tool, rather than appending the file.  
+
+This appender approach can easily break if:
+
+* You get your search and replace wrong
+* The configuration file is context sensitive (which is often true)
+
+  
+==Usage
+
+From Ruby:
+
+  new_content = %[
+  destination df_cron { file("/var/log/cron.log"); };
+  filter f_cron { facility(cron); };
+  ]
+  Appender.process(:config_file => '/etc/syslog-ng/syslog-ng.conf', :append => new_content, :remove => 'f_cron')
+
+From the command line:
+
+  appender --file /etc/syslog-ng/syslog-ng.conf --remove "destination df_cron" --append "destination df_cron { file(\"/var/log/cron.log\"); };"
+  appender --file /etc/syslog-ng/syslog-ng.conf --remove "filter f_cron" --append "filter f_cron {facility(cron); };"
+
+Another way to do this is simply with bash:
+
+  cat /etc/syslog-ng/syslog-ng.conf | grep -v "destination df_cron" > syslog-ng.conf.tmp
+  echo "destination df_cron { file(\"/var/log/cron.log\"); };" >> syslog-ng.conf.tmp
+  mv syslog-ng.conf.tmp /etc/syslog-ng/syslog-ng.conf
+
+The problem with this bash approach is:
+
+* limited regular expression support
+* less error control
+* manual configuration history management
+
+Yet, I prefer the simpler bash approach when I can do it that way.
+
+==Installation
+
+  gem install davidrichards-appender
+  
+=== Dependencies
+
+  * logrotate
+  
+==COPYRIGHT
+
+Copyright (c) 2009 David Richards. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 0
+:patch: 5

data/bin/appender

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby -KU
+
+require File.join(File.dirname(__FILE__), %w(.. lib appender))
+
+# Make sure OpenStruct has at least this bug fixed.
+class OpenStruct
+  def table; @table; end
+end
+
+# Gather the command-line arguments and pass them to Appender.process
+class ConfigOptparse
+  require 'ostruct'
+  require 'optparse'
+
+  #
+  # Return a structure describing the options.
+  #
+  def self.parse(args)
+    # The options specified on the command line will be collected in *options*.
+    # We set default values here.
+    options = OpenStruct.new
+    options.config_file =  ''
+    options.append =  ''
+    options.remove =  []
+
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: appender [options]"
+
+      opts.separator ""
+      opts.separator "Specific options:"
+
+      opts.on("--file [path]", "Path to the config file") do |config|
+        options.config_file = config
+      end
+      
+      opts.on("--remove [expression]", Array, "Lines matching expression are removed from the config") do |config|
+        options.remove = config
+      end
+      
+      opts.on("--append [contents]", "New contents to add to the file") do |config|
+        options.append = config
+      end
+
+      # No argument, shows at tail.  This will print an options summary.
+      # Try it and see!
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+
+    end
+
+    opts.parse!(args)
+    options
+  end  # parse()
+
+end  # class OptparseExample
+
+options = ConfigOptparse.parse(ARGV)
+
+Appender.process(options.table)

data/lib/appender.rb

@@ -0,0 +1,116 @@
+#!/usr/bin/env ruby
+
+# Appends a configuration file, rotating the file for safety.
+class Appender
+
+  require 'rubygems'
+  require 'fileutils'
+  require 'yaml'
+  require 'ostruct'
+  require 'logrotate'
+  
+  def self.process(options={})
+    appender = new
+    appender.process(options)
+  end
+
+  # Usage:
+  # append_text = %{# Some configuration
+  # Usually on multiple lines
+  # key value
+  # etc etc...
+  # }
+  # Appender.process(
+  #  :config_file => '/etc/syslog-ng/syslog-ng.conf', 
+  #  :append => append_text, 
+  #  :remove => [/^etc/, /^Usually on multiple lines/]
+  # )
+  def process(options={})
+    rotate_file(options[:config_file])
+    clean_file(options[:remove])
+    new_content = options[:append]
+    new_content ||= options[:content]
+    append_file(new_content)
+    clean_white_space if options[:clean]
+    ensure_file
+  end
+  alias :call :process
+  
+  # The contents to work with.
+  attr_reader :content
+  
+  # The file we are working on.
+  attr_reader :config_file
+  
+  # The directory where the configuration file is stored.
+  attr_reader :output_directory
+  
+  protected
+  
+    # Makes sure at least the original contents are in place
+    def ensure_file
+      return if File.exist?(self.config_file)
+      File.open(self.config_file, 'w') { |f| f.write(self.content) }
+    end
+  
+    def log_options
+      {
+        :date_time_ext => true,
+        :directory => self.output_directory,
+        :date_time_format => '%F_%T',
+        :count => 5
+      }
+    end
+    
+    def append_file(content)
+      return true unless content
+      self.content << "\n" unless self.content[-1].chr == "\n"
+      self.content << content
+      write_content_to_file
+      true
+    end
+    
+    def write_content_to_file
+      File.open(self.config_file, 'w+') {|f| f.write(self.content)}
+    end
+    
+    def clean_file(expressions)
+      expressions = Array(expressions)
+      expressions.delete_if {|e| e.nil? or (e.is_a?(String) and e.empty?)}
+      return true if expressions.empty?
+      expressions.map! {|e| Regexp.new(e)}
+      
+      new_content = ''
+      self.content.each_line do |line|
+        new_content << line unless expressions.any? {|e| line =~ e}
+      end
+      
+      # Makes sure the internal state and the external state both reflect the
+      # filtered contents. 
+      @content = new_content
+      File.open(self.config_file, 'w') {|f| f.write(new_content)}
+      true
+    end
+  
+    # Removes multiple blank rows in a row
+    def clean_white_space
+      @content.gsub!(/\n{2,}/, "\n")
+      write_content_to_file
+    end
+    
+    # Rotates the config file
+    def rotate_file(config_file)
+      config_file = nil if config_file.is_a?(String) and config_file.empty?
+      raise ArgumentError, "Must provide a configuration file: config_file => 'some_file.conf'" unless
+        config_file
+        
+      @content = File.read(config_file)
+      
+      LogRotate.rotate_file(config_file, self.log_options)
+
+      @config_file = File.expand_path(config_file)
+      @output_directory = File.dirname(@config_file)
+      true
+    end
+  
+end

data/spec/appender_spec.rb

@@ -0,0 +1,163 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Appender" do
+  
+  before do
+    @config_file = "/tmp/appender_spec.conf"
+    File.open(@config_file, 'w') {|f| f.write contents}
+  end
+  
+  it "should be able to append a file with new contents" do
+    Appender.process(:config_file => @config_file, :append => "New contents")
+    File.read(@config_file).should match(/New contents$/)
+  end
+  
+  it "should append new contents on a new line" do
+    Appender.process(:config_file => @config_file, :append => "New contents")
+    File.read(@config_file).should match(/^New contents$/)
+  end
+  
+  it "should not try to work on missing files" do
+    missing_file = 'not_a_file'
+    File.should_not be_exist(missing_file)
+    lambda{Appender.process(:config_file => missing_file)}.should raise_error(/No such file or directory/)
+    File.should_not be_exist(missing_file)
+  end
+  
+  it "should not complain if not appending anything" do
+    lambda{Appender.process(:config_file => @config_file)}.should_not raise_error
+  end
+  
+  it "should leave an identical file in place, even if it wasn't changed" do
+    Appender.process(:config_file => @config_file)
+    read_contents.should eql(contents)
+  end
+  
+  it "should remove all lines that match a pattern" do
+    Appender.process(:config_file => @config_file, :remove => '#')
+    read_contents.should_not match(/\#/)
+  end
+  
+  it "should remove the whole line, not just the matching portion of the remove parameter" do
+    Appender.process(:config_file => @config_file, :remove => '#')
+    read_contents.should eql(comment_less_expectation)
+  end
+  
+  it "should change the stored content with the filtered results" do
+    a = Appender.new
+    a.process(:config_file => @config_file, :remove => '#')
+    a.content.should eql(comment_less_expectation)
+  end
+  
+  it "should be able to take an array of filters" do
+    Appender.process(:config_file => @config_file, :remove => ['#', 'value'])
+    read_contents.should eql(comment_and_value_less_expectation)
+  end
+  
+  it "should be able to take regular expressions for filters" do
+    Appender.process(:config_file => @config_file, :remove => [/#/, /value/])
+    read_contents.should eql(comment_and_value_less_expectation)
+  end
+  
+  it "should append the new contents after removing the matching contents" do
+    read_contents.should match(/^key value/)
+    Appender.process(:config_file => @config_file, :remove => /^key value/, :append => "key new_value")
+    read_contents.should_not match(/^key value/)
+    read_contents.should match(/^key new_value/)
+  end
+  
+  it "should be able to remove excessive white space" do
+    Appender.process(:config_file => @config_file, :remove => [/#/, /value/], :clean => true)
+    read_contents.should eql(clean_expectation)
+  end
+  
+  it "should log rotate the file, keep 5 versions of the configuration file in the directory" do
+    STDOUT.sync = true
+    puts "\n\n******************************\nRunning a 7-second spec\n******************************\n\n"
+    7.times do 
+      Appender.process(:config_file => @config_file)
+      sleep 1 # Ensure a new timestamp
+    end
+    ls = `ls #{File.dirname(@config_file)}/#{File.split(@config_file).last}.*`.split("\n")
+    ls.size.should eql(5)
+  end
+  
+  it "should not break the original configuration file if it cannot be log rotated" do
+    def LogRotate.rotate_file(*args); raise(StandardError, "Testing rotate_file"); end
+    lambda{Appender.process(:config_file => @config_file, :append => "New contents")}.should 
+      raise_error(StandardError, "Testing rotate_file")
+    File.read(@config_file).should eql(contents)
+  end
+
+  after(:all) do
+    `rm -rf /tmp/appender_spec.conf*`
+  end
+end
+
+describe Appender, "Log Rotate" do
+  
+  before do
+    @config_file = "/tmp/appender_spec.conf"
+    File.open(@config_file, 'w') {|f| f.write contents}
+  end
+
+  # Running this on its own to reduce the side effects of stubbing out log rotation.
+  it "should not break the original configuration file if it cannot be log rotated" do
+    LogRotate.stub!(:rotate_file).and_return(lambda{raise(StandardError, "Testing rotate_file")})
+    # def LogRotate.rotate_file(*args); raise(StandardError, ); end
+    lambda{Appender.process(:config_file => @config_file, :append => "New contents")}.should 
+      raise_error(StandardError, "Testing rotate_file")
+    File.read(@config_file).should eql(contents)
+  end
+  
+  after(:all) do
+    `rm -rf /tmp/appender_spec.conf*`
+  end
+end
+
+
+def read_contents
+  File.read(@config_file)
+end
+
+def contents
+  %{
+# This is like a config file
+
+# It has comments (this)
+
+# It has key/value pairs:
+key value
+
+# It has some more-specific values that may be interesting to test
+destination df_cron { file("/var/log/cron.log"); };
+
+# It does NOT have trailing whitespace}
+end
+
+def comment_less_expectation
+  %{
+
+
+key value
+
+destination df_cron { file("/var/log/cron.log"); };
+
+}
+end
+
+def comment_and_value_less_expectation
+  %{
+
+
+
+destination df_cron { file("/var/log/cron.log"); };
+
+}
+end
+
+def clean_expectation
+  %{
+destination df_cron { file("/var/log/cron.log"); };
+}
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$: << File.join(File.dirname(__FILE__), "/../lib") 
+require 'rubygems' 
+require 'spec' 
+require 'appender'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: davidrichards-appender
+version: !ruby/object:Gem::Version 
+  version: 0.0.5
+platform: ruby
+authors: 
+- David Richards
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-24 00:00:00 -07:00
+default_executable: appender
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: logrotate
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Appends configuration to files
+email: drichards@showcase60.com
+executables: 
+- appender
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- VERSION.yml
+- bin/appender
+- lib/appender.rb
+- spec/appender_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/davidrichards/appender
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Appends configuration to files
+test_files: []
+