ion1-mischacks 0.0.3 → 0.0.4

data/History.txt

@@ -1,3 +1,9 @@
+=== 0.0.4 / 2009-06-28
+
+* Implement overwrite, a method to safely replace a file.
+* Update README.
+* Move exception printing from sh to catching_exit.
+
 === 0.0.3 / 2009-06-28
 
 * Rename checking_exit_status as fork_and_check to make it clear it forks.

data/README.txt

@@ -4,7 +4,30 @@
 
 == DESCRIPTION:
 
-Safely pass untrusted parameters to sh scripts
+Miscellaneous methods that may or may not be useful.
+
+sh:: Safely pass untrusted parameters to sh scripts.
+
+fork_and_check:: Run a block in a forked process and raise an exception if the
+process returns a non-zero value.
+
+do_and_exit, do_and_exit!:: Run a block. If the block does not run exit!, a
+successful exec or equivalent, run exit(1) or exit!(1) ourselves. Useful to
+make sure a forked block either runs a successful exec or dies.
+
+Any exceptions from the block are printed to standard error.
+
+overwrite:: Safely replace a file. Writes to a temporary file and then moves it
+over the old file.
+
+tempname_for:: Generates an unique temporary path based on a filename. The
+generated filename resides in the same directory as the original one.
+
+try_n_times:: Retries a block of code until it succeeds or a maximum number of
+attempts (default 10) is exceeded.
+
+Exception#to_formatted_string:: Returns a string that looks like how Ruby would
+dump an uncaught exception.
 
 == FEATURES/PROBLEMS:
 
@@ -14,6 +37,8 @@ ever use an untrusted variable as a command.
 
 == SYNOPSIS:
 
+  # sh
+
   MiscHacks.sh %q{
     diff -u "$1" "$2" | tr a-z A-Z >"$output"
   }, '/dev/null', '/etc/motd', :output => 'foo'
@@ -21,6 +46,42 @@ ever use an untrusted variable as a command.
   unsafe_str = %q{" 'foo' $(bar) `baz` "}
   MiscHacks.sh 'printf "%s\n" "$1"', unsafe_str
 
+  # fork_and_check
+
+  # These examples raise MiscHacks::ChildError.
+  MiscHacks.fork_and_check do exit! 42 end
+  MiscHacks.fork_and_check do exec 'sh', '-c', 'exit 42' end
+  MiscHacks.fork_and_check do exec 'failure' end
+
+  # Does not raise an error.
+  MiscHacks.fork_and_check do exit! 0 end
+
+  # do_and_exit
+
+  # Prints foo if there are no failures. If anything fails, raises an
+  # exception.
+  MiscHacks.fork_and_check do
+    MiscHacks.do_and_exit! do
+      exec 'sh', '-c', 'echo foo'
+    end
+  end
+
+  # overwrite
+
+  MiscHacks.overwrite 'myconfig' do |io|
+    io << config.to_yaml
+  end
+
+  # tempname_for
+
+  MiscHacks.tempname_for '/foo/bar/baz'  # => '/foo/bar/.baz.klyce3f517qkh9l'
+
+  # try_n_times
+
+  io = MiscHacks.try_n_times do
+    File.open path, File::RDWR|File::CREAT|File::EXCL
+  end
+
 == REQUIREMENTS:
 
 * POSIX sh

data/lib/mischacks.rb

@@ -14,7 +14,7 @@
 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 module MiscHacks
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 
   class ChildError < RuntimeError
     attr_reader :status
@@ -25,6 +25,19 @@ module MiscHacks
     end
   end
 
+  def self.sh cmd, *args
+    env = if args.last.is_a? Hash then args.pop else {} end
+
+    fork_and_check do
+      do_and_exit! do
+        env.each_pair do |k, v| ENV[k.to_s] = v.to_s end
+        exec *(%W{sh -e -c #{cmd} sh} + args.map {|a| a.to_s })
+      end
+    end
+
+    nil
+  end
+
   def self.fork_and_check
     fork do
       yield
@@ -43,6 +56,8 @@ module MiscHacks
       yield
     rescue SystemExit => e
       status = e.status
+    rescue Exception => e
+      warn e.to_formatted_string
     ensure
       final_proc.call status
     end
@@ -58,21 +73,66 @@ module MiscHacks
     catching_exit method(:exit!), status, &block
   end
 
-  def self.sh cmd, *args
-    env = if args.last.is_a? Hash then args.pop else {} end
+  def self.overwrite path, mode=nil
+    begin
+      stat = File.stat path
 
-    fork_and_check do
-      do_and_exit! do
-        begin
-          env.each_pair do |k, v| ENV[k.to_s] = v.to_s end
-          exec *(%W{sh -e -c #{cmd} sh} + args.map {|a| a.to_s })
-        rescue Exception => e
-          warn e.to_formatted_string
-        end
-      end
+      raise ArgumentError, "Not a file: #{path}",   caller unless stat.file?
+      raise ArgumentError, "Not writable: #{path}", caller unless stat.writable?
+
+      mode ||= stat.mode & 0777
+    rescue Errno::ENOENT
+      stat = nil
     end
 
-    nil
+    temppath, io = try_n_times do
+      t  = tempname_for path
+      io = File.open t, File::RDWR|File::CREAT|File::EXCL
+      [t, io]
+    end
+
+    begin
+      ret = yield io
+
+      File.chmod mode, temppath if mode
+
+      File.rename temppath, path
+
+    rescue
+      File.unlink temppath
+      raise
+
+    ensure
+      io.close
+    end
+
+    ret
+  end
+
+  def self.tempname_for path
+    dirname  = File.dirname  path
+    basename = File.basename path
+
+    '%s/.%s.%s%s%s' % [
+      dirname,
+      basename,
+      Time.now.to_i.to_s(36),
+      $$.to_s(36),
+      rand(1<<32).to_s(36)
+    ]
+  end
+
+  def self.try_n_times n=10
+    i = 0
+    begin
+      ret = yield
+    rescue
+      i += 1
+      retry if i < n
+      raise
+    end
+
+    ret
   end
 end
 

data/mischacks.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mischacks}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Johan Kiviniemi"]
   s.date = %q{2009-06-28}
-  s.description = %q{Safely pass untrusted parameters to sh scripts}
+  s.description = %q{Miscellaneous methods that may or may not be useful.  sh:: Safely pass untrusted parameters to sh scripts.  fork_and_check:: Run a block in a forked process and raise an exception if the process returns a non-zero value.  do_and_exit, do_and_exit!:: Run a block. If the block does not run exit!, a successful exec or equivalent, run exit(1) or exit!(1) ourselves. Useful to make sure a forked block either runs a successful exec or dies.  Any exceptions from the block are printed to standard error.  overwrite:: Safely replace a file. Writes to a temporary file and then moves it over the old file.  tempname_for:: Generates an unique temporary path based on a filename. The generated filename resides in the same directory as the original one.  try_n_times:: Retries a block of code until it succeeds or a maximum number of attempts (default 10) is exceeded.  Exception#to_formatted_string:: Returns a string that looks like how Ruby would dump an uncaught exception.}
   s.email = ["devel@johan.kiviniemi.name"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
   s.files = ["COPYING", "History.txt", "Manifest.txt", "README.txt", "Rakefile", "lib/mischacks.rb", "mischacks.gemspec", "spec/mischacks_spec.rb", "spec/spec_helper.rb"]
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{mischacks}
   s.rubygems_version = %q{1.3.1}
-  s.summary = %q{Safely pass untrusted parameters to sh scripts}
+  s.summary = %q{Miscellaneous methods that may or may not be useful}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/spec/mischacks_spec.rb

@@ -17,11 +17,64 @@ require File.expand_path(File.dirname(__FILE__)+'/spec_helper.rb')
 require 'mischacks'
 
 require 'digest/sha1'
+require 'fileutils'
+require 'set'
+require 'tmpdir'
 
 mh = MiscHacks
 ce = MiscHacks::ChildError
 
 describe mh do
+  describe 'sh' do
+    unsafe_str = %q{" 'foo' $(bar) `baz` "}
+    checksum   = Digest::SHA1.hexdigest unsafe_str
+
+    it "should raise #{ce} on error" do
+      good = ['true', '', 'printf ""']
+      bad  = ['false', 'exit 2', 'return 2']
+
+      bad.each do |c|
+        lambda do mh.sh c end.should raise_error ce
+      end
+
+      good.each do |c|
+        lambda do mh.sh c end.should_not raise_error
+      end
+    end
+
+    it 'should call sh with -e' do
+      lambda do mh.sh 'false; true' end.should raise_error ce
+    end
+
+    it 'should pass normal parameters safely' do
+      test = lambda do |str, sha|
+        mh.sh %q{
+          temp="$(mktemp -t mischacks.XXXXXXXXXX)"
+          trap 'rm -f "$temp"' 0 1 2 13 15
+          printf "%s" "$1" >"$temp"
+          printf "%s *%s\n" "$2" "$temp" | sha1sum -c >/dev/null 2>&1
+        }, str, sha
+      end
+
+      lambda do test.call unsafe_str, checksum end.should_not raise_error
+      lambda do test.call 'foo',      checksum end.should raise_error ce
+    end
+
+    it 'should pass environment variables safely' do
+      test = lambda do |str, sha|
+        mh.sh %q{
+          temp="$(mktemp -t mischacks.XXXXXXXXXX)"
+          trap 'rm -f "$temp"' 0 1 2 13 15
+          printf "%s" "$string" >"$temp"
+          printf "%s *%s\n" "$checksum" "$temp" | sha1sum -c >/dev/null 2>&1
+        }, :string => str, :checksum => sha
+      end
+
+      lambda do test.call unsafe_str, checksum end.should_not raise_error
+      lambda do test.call 'foo',      checksum end.should raise_error ce
+    end
+  end
+
   describe 'fork_and_check' do
     it 'should raise an error when child fails' do
       lambda do mh.fork_and_check do exit  1 end end.should raise_error ce
@@ -127,53 +180,90 @@ describe mh do
     end
   end
 
-  describe 'sh' do
-    unsafe_str = %q{" 'foo' $(bar) `baz` "}
-    checksum   = Digest::SHA1.hexdigest unsafe_str
+  describe 'overwrite' do
+    before :all do
+      @dir      = Dir.mktmpdir
+      @file     = "#{@dir}/foo"
+      @content0 = "bar\n"
+      @content1 = "baz\n"
+      @mode0    = 0714
+      @mode1    = 0755
+    end
 
-    it "should raise #{ce} on error" do
-      good = ['true', '', 'printf ""']
-      bad  = ['false', 'exit 2', 'return 2']
+    after :all do
+      FileUtils.rm_rf @dir
+    end
 
-      bad.each do |c|
-        lambda do mh.sh c end.should raise_error ce
+    it 'should create a fresh file' do
+      mh.overwrite @file do |io|
+        io << @content0
+        File.exists?(@file).should == false
       end
+      File.read(@file).should == @content0
+    end
 
-      good.each do |c|
-        lambda do mh.sh c end.should_not raise_error
+    it 'should overwrite a file' do
+      mh.overwrite @file do |io|
+        io << @content1
+        File.read(@file).should == @content0
       end
+      File.read(@file).should == @content1
     end
 
-    it 'should call sh with -e' do
-      lambda do mh.sh 'false; true' end.should raise_error ce
+    it 'should retain the mode' do
+      File.chmod @mode0, @file
+      mh.overwrite @file do end
+      (File.stat(@file).mode & 07777).should == @mode0
     end
 
-    it 'should pass normal parameters safely' do
-      test = lambda do |str, sha|
-        mh.sh %q{
-          temp="$(mktemp -t mischacks.XXXXXXXXXX)"
-          trap 'rm -f "$temp"' 0 1 2 13 15
-          printf "%s" "$1" >"$temp"
-          printf "%s *%s\n" "$2" "$temp" | sha1sum -c >/dev/null 2>&1
-        }, str, sha
-      end
-
-      lambda do test.call unsafe_str, checksum end.should_not raise_error
-      lambda do test.call 'foo',      checksum end.should raise_error ce
+    it 'should set the mode' do
+      mh.overwrite @file, @mode1 do end
+      (File.stat(@file).mode & 07777).should == @mode1
     end
+  end
 
-    it 'should pass environment variables safely' do
-      test = lambda do |str, sha|
-        mh.sh %q{
-          temp="$(mktemp -t mischacks.XXXXXXXXXX)"
-          trap 'rm -f "$temp"' 0 1 2 13 15
-          printf "%s" "$string" >"$temp"
-          printf "%s *%s\n" "$checksum" "$temp" | sha1sum -c >/dev/null 2>&1
-        }, :string => str, :checksum => sha
+  describe 'tempname_for' do
+    it 'should generate an unique temporary path' do
+      path = '/foo/bar/baz'
+      tempnames = (0...10).map { mh.tempname_for(path) }.to_set
+
+      # It is very, very unlikely there are duplicates.
+      tempnames.length.should > 8
+
+      tempnames.each do |n|
+        n.should =~ %r{\A/foo/bar/.baz.[a-z0-9]+\z}
       end
+    end
+  end
 
-      lambda do test.call unsafe_str, checksum end.should_not raise_error
-      lambda do test.call 'foo',      checksum end.should raise_error ce
+  describe 'try_n_times' do
+    it 'should try 10 times' do
+      e = Class.new RuntimeError
+
+      i = 0
+      mh.try_n_times do
+        i += 1
+        42
+      end.should == 42
+      i.should == 1
+
+      i = 0
+      mh.try_n_times do
+        i += 1
+        raise e if i < 10
+        42
+      end.should == 42
+      i.should == 10
+
+      i = 0
+      lambda do
+        mh.try_n_times do
+          i += 1
+          raise e if i < 11
+          42
+        end
+      end.should raise_error e
+      i.should == 10
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ion1-mischacks
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Johan Kiviniemi
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.3.1
     version: 
-description: Safely pass untrusted parameters to sh scripts
+description: "Miscellaneous methods that may or may not be useful.  sh:: Safely pass untrusted parameters to sh scripts.  fork_and_check:: Run a block in a forked process and raise an exception if the process returns a non-zero value.  do_and_exit, do_and_exit!:: Run a block. If the block does not run exit!, a successful exec or equivalent, run exit(1) or exit!(1) ourselves. Useful to make sure a forked block either runs a successful exec or dies.  Any exceptions from the block are printed to standard error.  overwrite:: Safely replace a file. Writes to a temporary file and then moves it over the old file.  tempname_for:: Generates an unique temporary path based on a filename. The generated filename resides in the same directory as the original one.  try_n_times:: Retries a block of code until it succeeds or a maximum number of attempts (default 10) is exceeded.  Exception#to_formatted_string:: Returns a string that looks like how Ruby would dump an uncaught exception."
 email: 
 - devel@johan.kiviniemi.name
 executables: []
@@ -69,6 +69,6 @@ rubyforge_project: mischacks
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Safely pass untrusted parameters to sh scripts
+summary: Miscellaneous methods that may or may not be useful
 test_files: []