necktie 1.0.4 → 1.0.5

data/CHANGELOG

@@ -1,3 +1,9 @@
+1.0.5 (2009-11-13)
+* Added erb: a file task that creates a file form an ERB template.
+* Changed: The write and update file methods now perform atomic writes (create
+temporary file, rename to desired path).
+* Fix: MySQL examples used task instead of file task.
+
 1.0.4 (2009-11-4)
 * When used with -U option and no other argument, necktie command updates the
 local repo but does not run any task.

data/README.rdoc

@@ -1,29 +1,22 @@
-I use Necktie to setup and upgrade multiple servers. 
+= Minimalistic server configuration tool
 
+Necktie is tool for running configuration tasks: setting up new servers and
+upgrading production servers.  You can use it to manage services, mount
+volumes, change configuration, manage cronjobs, etc.
 
-== Dress to impress
-
-Necktie runs a set of scripts (or configuration tasks) that can create and edit
-files, install and setup services, mount volumes, and basically anything you
-can script with Ruby and a shell.
-
-To use Necktie:
-- Write your Necktie tasks
-- Include support files (config, binaries, etc)
-- git push && cap necktie
-
-I use it to:
-
-- gem install, apt-get
-- Configure Nginx, install and setup Unicorn
-- Change memcached configuration from default
-- Setup MySQL to use a mounted (EBS) volume
-- Install and update cron scripts
+http://19.media.tumblr.com/tumblr_kspcaa4Djr1qzo4cfo1_250.jpg
 
 To install Necktie:
 
   $ gem install necktie --source http://gemcutter.org
 
+To use Necktie:
+1. Write a Necktie file with configurtaion tasks
+2. Include any support files: config, scripts, binaries, etc
+3. git push && cap necktie
+
+Introduction to Necktie: http://blog.labnotes.org/2009/11/04/necktie-dress-to-impress/
+
 
 == Tasking
 
@@ -215,4 +208,8 @@ Includes Session, created by Ara T. Howard and released under the Ruby License
 http://raa.ruby-lang.org/project/session
 http://www.codeforpeople.com/lib/ruby/session
 
+Atomic file write adapted from Rails.
+
+ERB task adapted from Luke Bayes http://gist.github.com/215270.
+
 Developed for managing EC2 instances for http://apartly.com 

data/example/tasks/db.rb

@@ -3,13 +3,13 @@ file "/etc/cron.hourly/snapshot"=>"etc/cron/snapshot" do
   chmod 0755, "/etc/cron.hourly/snapshot"
 end
 
-task "/vol" do
+file "/vol" do
   # Assumes we attach EBS volume to /dev/sdh, formatted it to XFS, mounted to /vol.
   append "/etc/fstab", "/dev/sdh /vol xfs noatime,nobarrier 0 0\n" unless read("/etc/fstab")["/dev/sdh "]
   sh "mount /vol"
 end
 
-task "/etc/mysql"=>"/vol" do
+file "/etc/mysql"=>"/vol" do
   # Mount the respective MySQL directories. Make sure they exist on your EBS volume first, see:
   # http://developer.amazonwebservices.com/connect/entry.jspa?externalID=1663
   mounts = { "/vol/etc/mysql"=>"/etc/mysql",
@@ -23,7 +23,7 @@ task "/etc/mysql"=>"/vol" do
   chmod 0755, "/etc/mysql/debian-start"
 end
 
-task "mysql"=>"/etc/mysql" do
+task :mysql=>"/etc/mysql" do
   services.start "mysql" unless services.running?("mysql")
 end
 

data/lib/necktie.rb

@@ -3,6 +3,7 @@ require "necktie/files"
 require "necktie/gems"
 require "necktie/services"
 require "necktie/rush"
+require "necktie/erb"
 
 
 # Includes all methods from Necktie::Files and Necktie::Gems methods.

data/lib/necktie/application.rb

@@ -10,7 +10,6 @@ module Necktie
       @rakefiles = ["Necktie", "necktie", "Necktie.rb", "necktie.rb"]
       options.nosearch = true
       options.env = "production"
-      @syslog = Syslog.open("necktie")
     end
 
     def run
@@ -31,7 +30,7 @@ module Necktie
           sh "git checkout #{options.ref}" if options.ref
           @sha = `git rev-parse --verify HEAD --short`.strip
           puts "(in #{Dir.pwd}, head is #{@sha}, environment is #{options.env})"
-          syslog :info, "environment is #{options.env}"
+          syslog :info, "environment is %s", options.env
 
           load_rakefile
           top_level unless options.pull && ARGV.empty?
@@ -141,8 +140,10 @@ module Necktie
       load_imports
     end
 
-    def syslog(level, message)
-      @syslog.send level, "[#{@sha}] #{message.strip.gsub(/%/, '%%')}" # syslog(3) freaks on % (printf)
+    def syslog(level, message, *args)
+      Syslog.open("necktie") do |s|
+        s.send level, "[#{@sha}] #{message}", *args
+      end
     end
 
   end
@@ -158,10 +159,10 @@ end
 class Rake::Task #:nodoc:
   alias :execute_without_syslog :execute
   def execute(args=nil)
-    application.syslog :info, "execute: #{name}"
+    application.syslog :info, "execute: %s", name
     execute_without_syslog args
   rescue
-    application.syslog :err, "#{$!.backtrace.first}: #{$!.class}: #{$!}"
+    application.syslog :err, "%s: %s: %s", $!.backtrace.first, $!.class.name, $!.to_s
     raise
   end
 end

data/lib/necktie/capistrano.rb

@@ -13,7 +13,7 @@ Capistrano::Configuration.instance.load do
     desc "[internal] Pull updates from Git"
     task :pull do
       fail "You need to set :necktie_url, <git_url>" unless necktie_url
-      sudo "necktie --source #{necktie_url} --update"
+      sudo "necktie --environment #{fetch(:rails_env, "production")} --source #{necktie_url} --update"
     end
 
     desc "[internal] Run necktie upgrade"

data/lib/necktie/erb.rb

@@ -0,0 +1,66 @@
+require "erb"
+ 
+module Necktie
+  
+  # Rake task that makes it stupid-easy to render ERB templates to disk. Just
+  # add parameters to the yielded object, and they will be available to your
+  # Template.
+  #
+  # Loosely based on: http://gist.github.com/215270
+  class ErbTask < Rake::FileTask
+    
+    # Path to the input ERB template. This value will default to the value of
+    # "#{output}.erb"
+    attr_accessor :template
+    
+    def initialize(name, app) # :nodoc:
+      super
+      @output = name
+      @template = "#{name}.erb"
+      @values = {}
+    end
+ 
+    def execute(*args)
+      super
+      content = File.read(template)
+      result = ERB.new(content, nil, '>').result(binding)
+      write name, result
+      puts " * Created ERB output at: #{name}" if application.options.trace
+    end
+ 
+    def self.define_task(args)
+      task = super
+      if task.is_a?(Necktie::ErbTask)
+        yield task if block_given?
+        task.prerequisites << file(task.template)
+      end
+      return task
+    end
+
+    def method_missing(method, *params, &block)
+      if method.to_s[/^(.*)=$/, 1]
+        return @values[$1] = params.first
+      elsif @values.keys.include?(method.to_s)
+        return @values[method.to_s]
+      else
+        super
+      end
+    end
+    
+  end
+end
+ 
+# Rake task that makes it stupid-easy to render ERB templates to disk. Just add
+# parameters to the yielded object, and they will be available to your
+# Template.
+#
+# For example:
+#   erb 'config/SomeFile.xml' do |t|
+#     t.param1 = 'value'
+#     t.other_param = 'other value'
+#     t.another_param = ['a', 'b', 'c']
+#     t.template = 'config/SomeFile.xml.erb' # Optional - will automatically look here...
+#   end
+def erb(args, &block)
+  Necktie::ErbTask.define_task(args, &block)
+end

data/lib/necktie/files.rb

@@ -1,44 +1,67 @@
-module Necktie::Files
-  # Return the contents of the file (same as File.read).
-  def read(name)
-    File.read(name)
-  end
+require "tempfile"
 
-  # Writes contents to a new file, or overwrites existing file.
-  # Takes string as second argument, or yields to block. For example:
-  #   write "/etc/mailname", "example.com"
-  #   write("/var/run/bowtie.pid") { Process.pid }
-  def write(name, contents = nil)
-    contents ||= yield
-    File.open name, "w" do |f|
-      f.write contents
+module Necktie
+  module Files
+    # Return the contents of the file (same as File.read).
+    def read(name)
+      File.read(name)
     end
-  end
 
-  # Append contents to a file, creating it if necessary.
-  # Takes string as second argument, or yields to block. For example:
-  #   append "/etc/fstab", "/dev/sdh /vol xfs\n" unless read("/etc/fstab")["/dev/sdh "]
-  def append(name, contents = nil)
-    contents ||= yield
-    File.open name, "a" do |f|
-      f.write contents
+    # Writes contents to a new file, or overwrites existing file.  Takes string
+    # as second argument, or yields to block. For example:
+    #
+    #   write "/etc/mailname", "example.com"
+    #   write("/var/run/bowtie.pid") { Process.pid }
+    # 
+    # This method performs an atomic write using TMPDIR or (/tmp) as the
+    # temporary directory and renaming the file over to the new location.
+    # Ownership and premission are retained if replacing existing file.
+    def write(name, contents = nil)
+      temp = Tempfile.new(File.basename(name))
+      temp.write contents || yield
+      temp.close
+
+      begin
+        # Get original file permissions
+        stat = File.stat(name)
+      rescue Errno::ENOENT
+        # No old permissions, write a temp file to determine the defaults
+        stat_check = File.join(File.dirname(name), ".permissions_check.#{Thread.current.object_id}.#{Process.pid}.#{rand(1000000)}")
+        File.open(stat_check, "w") { }
+        stat = File.stat(stat_check)
+        File.unlink stat_check
+      end
+      
+      # Overwrite original file with temp file (tries rename, if that fails, copies).
+      FileUtils.mv temp.path, name
+
+      # Set correct permissions on new file
+      File.chown stat.uid, stat.gid, name
+      File.chmod stat.mode, name
     end
-  end
 
-  # Updates a file: read contents, substitue and write it back.
-  # Takes two arguments for substitution, or yields to block.
-  # These two are equivalent:
-  #   update "/etc/memcached.conf", /^-l 127.0.0.1/, "-l 0.0.0.0"
-  #   update("/etc/memcached.conf") { |s| s.sub(/^-l 127.0.0.1/, "-l 0.0.0.0") }
-  def update(name, from = nil, to = nil)
-    contents = File.read(name)
-    if from && to
-      contents = contents.sub(from, to)
-    else
-      contents = yield(contents)
+    # Append contents to a file, creating it if necessary.  Takes string as
+    # second argument, or yields to block. For example:
+    #   append "/etc/fstab", "/dev/sdh /vol xfs\n" unless read("/etc/fstab")["/dev/sdh "]
+    def append(name, contents = nil)
+      contents ||= yield
+      File.open name, "a" do |f|
+        f.write contents
+      end
     end
-    File.open name, "w" do |f|
-      f.write contents
+
+    # Updates a file: read contents, substitue and write it back.  Takes two
+    # arguments for substitution, or yields to block.  These two are equivalent:
+    #   update "/etc/memcached.conf", /^-l 127.0.0.1/, "-l 0.0.0.0"
+    #   update("/etc/memcached.conf") { |s| s.sub(/^-l 127.0.0.1/, "-l 0.0.0.0") }
+    def update(name, from = nil, to = nil)
+      contents = File.read(name)
+      if from && to
+        contents = contents.sub(from, to)
+      else
+        contents = yield(contents)
+      end
+      write name, contents
     end
   end
 end

data/lib/necktie/gems.rb

@@ -1,20 +1,22 @@
 require "rubygems/dependency_installer"
 
-module Necktie::Gems
-  # Installs the specified gem, if not already installed. First argument is the
-  # name of the gem, or file containing the gem. Second argument is version requirement.
-  # For example:
-  #   install_gem "unicorn", "~>0.93"
-  #
-  #   Dir["gems/*.gem"].each do |gem|
-  #     install_gem gem
-  #   end
-  def install_gem(name, version = nil)
-    installer = Gem::DependencyInstaller.new
-    spec = installer.find_spec_by_name_and_version(name, version).first.first
-    if Gem::SourceIndex.from_installed_gems.find_name(spec.name, spec.version).empty?
-      puts " ** Installing the gem #{spec.name} #{spec.version}"
-      installer.install name, version
+module Necktie
+  module Gems
+    # Installs the specified gem, if not already installed. First argument is the
+    # name of the gem, or file containing the gem. Second argument is version requirement.
+    # For example:
+    #   install_gem "unicorn", "~>0.93"
+    #
+    #   Dir["gems/*.gem"].each do |gem|
+    #     install_gem gem
+    #   end
+    def install_gem(name, version = nil)
+      installer = Gem::DependencyInstaller.new
+      spec = installer.find_spec_by_name_and_version(name, version).first.first
+      if Gem::SourceIndex.from_installed_gems.find_name(spec.name, spec.version).empty?
+        puts " ** Installing the gem #{spec.name} #{spec.version}"
+        installer.install name, version
+      end
     end
   end
 end

data/necktie.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name           = "necktie"
-  spec.version        = "1.0.4"
+  spec.version        = "1.0.5"
   spec.author         = "Assaf Arkin"
   spec.email          = "assaf@labnotes.org"
   spec.homepage       = "http://github.com/assaf/necktie"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: necktie
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors: 
 - Assaf Arkin
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-04 00:00:00 -08:00
+date: 2009-11-13 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -26,6 +26,7 @@ files:
 - bin/necktie
 - lib/necktie/application.rb
 - lib/necktie/capistrano.rb
+- lib/necktie/erb.rb
 - lib/necktie/files.rb
 - lib/necktie/gems.rb
 - lib/necktie/rush.rb
@@ -255,7 +256,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --title
-- Necktie 1.0.4
+- Necktie 1.0.5
 - --main
 - README.rdoc
 - --webcvs