bincache 0.0.7 → 0.0.8

data/README.rdoc

@@ -1,13 +1,42 @@
 = bincache
 
-BinCache is a system designed to chache compiled binaries. It has resources for bash, ruby and chef. 
+BinCache is a system designed to chache compiled binaries on S3. It has resources for bash, ruby and chef. 
 
-== Bash example
+BinCache tracks a single directory and a series of scripts. After each script is run, the contents of the directory is cached on s3. On sequential runs, the scripts are not re-executed, but instead the cache from S3 is downloaded and placed in the directory. If a script is changed, itself and all following scripts will be re-executed. BinCache does this by hashing the current script together with all previous scripts ran and storing the resulting cache in S3 with that hash as it's name. By ensuring that scripts contain markers to introduce uniquness on different systems, you can make sure that you never have to wait twice for something to compile!
+
+== Install 
+ 
+  ## add rubygems.org to your gem sources list if it is not already there
+  gem sources -a https://rubygems.org
 
-  ## install bincache 
+  
+  ## install bincache
   gem install bincache
 
 
+== Environment
+
+Make sure you set the environment variables with something like:
+ 
+  ## S3 access key id
+  export BINCACHE_S3_ACCESS_KEY=1234567890ABCDEFGHIJ
+
+  ## S3 secret access key
+  export BINCACHE_S3_SECRET_KEY=1234567890ABCDEFHIJKLMNOPQRSTUVWXYZ12345
+
+  ## S3 bucket
+  export BINCACHE_S3_BUCKET=my_ec2_bucket
+
+  ## prefix inside bucket to store caches
+  export BINCACHE_S3_PREFIX=my_bincache/
+
+
+== Bash example
+
+  ## you may have to put rubygem bins in your path by doing something like..
+  export PATH=$HOME/.gem/ruby/1.8/bin:$PATH
+
+
   ## set the directory to cache
   dir=/tmp/bincache
 
@@ -54,7 +83,7 @@ BinCache is a system designed to chache compiled binaries. It has resources for
 
   ## run bincache
   bincache = BinCache.new
-  bincache.run_sequence(dir,scripts)
+  bincache.run_series(dir,scripts)
 
 == Chef example 
 
@@ -76,7 +105,16 @@ BinCache is a system designed to chache compiled binaries. It has resources for
     EOS
   end
 
- 
+
+== uniquness example
+
+To tag a script with something unique to ensure that it is distingushible on multiple systems, you need to insert something unique into the comments. For example, you could do:
+
+  echo "I am showing you how to uniqueify your script" > example
+  ## #{`uname -m`}
+  ## #{`lsb_release -ds`
+
+When this script is hashed, it will produce different values on different systems. With this technique, you can cache different binaries from different systems with the same code base!
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/bincache.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bincache}
-  s.version = "0.0.7"
+  s.version = "0.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Rhoads"]
-  s.date = %q{2010-10-10}
+  s.date = %q{2010-10-18}
   s.default_executable = %q{bincache}
   s.description = %q{
       BinCache is a system designed to cache compiled binaries. It has support for bash, ruby , and chef. 

data/lib/bincache.rb

@@ -18,26 +18,31 @@ class BinCache
     ## set cache_dir to'/var/tmp/bincache' or ENV['BINCACHE_DIR'] if it is set 
     @cache_dir = (ENV['BINCACHE_DIR']  && ENV['BINCACHE_DIR']) || '/var/tmp/bincache'
 
-    print_and_exit "s3 keys not set. Please set S3_BUCKET and S3_PREFIX" unless ENV['S3_BUCKET'] && ENV['S3_PREFIX']
-    @bucket = ENV['S3_BUCKET']
-    @prefix = ENV['S3_PREFIX']
+    print_and_exit "S3 bucket and path not set. Please set BINCACHE_S3_BUCKET and BINCACHE_S3_PREFIX" unless ENV['BINCACHE_S3_BUCKET'] && ENV['BINCACHE_S3_PREFIX']
+    @bucket = ENV['BINCACHE_S3_BUCKET']
+    @prefix = ENV['BINCACHE_S3_PREFIX']
 
 
-    print_and_exit "s3 keys not set. Please set S3_ACCESS_KEY and S3_SECRET_KEY" unless ENV['S3_ACCESS_KEY'] && ENV['S3_SECRET_KEY']
-    @right_s3 = RightAws::S3.new(ENV['S3_ACCESS_KEY'],ENV['S3_SECRET_KEY'])
+    print_and_exit "S3 keys not set. Please set BINCACHE_S3_ACCESS_KEY and BINCACHE_S3_SECRET_KEY" unless ENV['BINCACHE_S3_ACCESS_KEY'] && ENV['BINCACHE_S3_SECRET_KEY']
+    @right_s3 = RightAws::S3.new(ENV['BINCACHE_S3_ACCESS_KEY'],ENV['BINCACHE_S3_SECRET_KEY'])
     @right_s3_bucket = @right_s3.bucket(@bucket)
-    @right_s3_interface = RightAws::S3Interface.new(ENV['S3_ACCESS_KEY'],ENV['S3_SECRET_KEY'])
+    @right_s3_interface = RightAws::S3Interface.new(ENV['BINCACHE_S3_ACCESS_KEY'],ENV['BINCACHE_S3_SECRET_KEY'])
   end
 
-  def run_series(directory, scripts)
+  def run_series(directory, scripts, cwd=nil, script_hash=nil)
     ## exit if given bogus input
     print_and_exit "bogus input in run_series" if directory.nil? || scripts.nil? 
 
     ## clear out directory if we are starting a new sequence
     `rm -rf #{directory} && mkdir -p #{directory}` && return if scripts.empty?
 
-    ## hash the scripts
-    hash = Digest::MD5.hexdigest("#{directory.inspect}#{scripts.inspect}")
+    ## hash the scripts together with the output of the script_hash
+    script_hash_output = ""
+    script_hash_output = `#{script_hash}` unless script_hash == nil
+
+STDERR.puts "script_hash_output = #{script_hash_output}"
+
+    hash = Digest::MD5.hexdigest("#{directory.inspect}#{scripts.inspect}#{script_hash_output}")
        
     ## pop the last script   
     pop = scripts.pop
@@ -46,7 +51,7 @@ class BinCache
     eval("#{__method__}(directory,scripts)")  unless check_for_hash?(hash)
 
     ## step this script
-    step(pop,directory,hash)
+    step(pop,directory,hash,cwd)
   end
 
   def check_for_hash?(hash)
@@ -57,13 +62,14 @@ class BinCache
     key.exists?
   end
 
-  def step(script,directory,hash)
+  def step(script,directory,hash,cwd=nil)
     if download_hash? hash
       `rm -rf #{directory}`
       `cd #{File.dirname directory} && tar -xzvf #{File.join(@cache_dir,hash)} `
     else
       `mkdir -p #{directory} #{@cache_dir}`
-      Dir.chdir directory
+      Dir.chdir cwd unless cwd == nil
+      puts "pwd = #{`pwd`}"
       res = `#{script}`
       `cd #{File.dirname directory} && tar -czvf #{@cache_dir}/#{hash} #{File.basename directory} `
       upload_file("#{@cache_dir}/#{hash}")

data/lib/bincache/provider/bincache.rb

@@ -23,7 +23,7 @@ class Chef
         ## run bincache
         require 'bincache'
         bincache = BinCache.new
-        bincache.run_series(@new_resource.directory,scripts)
+        bincache.run_series(@new_resource.directory,scripts,@new_resource.cwd,@new_resource.script_hash)
       end
 
 

data/lib/bincache/resource/bincache.rb

@@ -1,8 +1,5 @@
 require 'chef/resource'
 
-
-
-
 class Chef
   class Resource
     class Bincache < Chef::Resource
@@ -14,6 +11,7 @@ class Chef
         @allowed_actions.push(:run)
       end
 
+
       def script(arg=nil)
         set_or_return(
           :script,
@@ -30,6 +28,23 @@ class Chef
           :kind_of => String
         )
       end
+  
+  
+      def cwd(arg=nil)
+        set_or_return(
+          :cwd,
+          arg,
+          :kind_of => String
+        )
+      end
+
+      def script_hash(arg=nil)
+        set_or_return(
+          :script_hash,
+          arg,
+          :kind_of => String
+        )
+      end
 
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bincache
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: false
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Martin Rhoads
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-10 00:00:00 -07:00
+date: 2010-10-18 00:00:00 -07:00
 default_executable: bincache
 dependencies: 
 - !ruby/object:Gem::Dependency