ci-cache 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 288ef0fe2be849cb4a5d1fbb0f48ecfae5fc62eb
+  data.tar.gz: 46f0d3a3f1b403bf6f678e48f9e0cdfbc7b808e9
+SHA512:
+  metadata.gz: b5ad74c170005c79dd259ff97441d77bbbb85dcda12ee52bf24675daf9478b9effa8fdb7735053c520be586bb5315fcb146ae34f11cfb36d60088bbfb659db07
+  data.tar.gz: 18d7f343646cf8d6bbaa12f239a2690a6ffab84e495d8884812ec24a99b859f982c6587ad0df121b35a60923e49f58796b352da704f4c0cda7c623dc6d85565a

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+- 1.9.3
+- 2.0.0
+- jruby-19mode
+- rbx-19mode
+deploy:
+  provider: rubygems
+  api_key:
+    secure: XMfj0fh0v8byvY67GtTLIeJcxEpmt7WBOTF9fmsEsWv6Wq2ZYeWdlLxgK042FTB7IkFYVF6EsA4zmOFKZkMpypwROj0cwTEeoA/5DjukowVc2KwpRLXMCUBeatRD9U63A8gq3CVrS7t5emo4trxb6lH+x3HIgF5Ef4n8Sj+MWJM=
+  gem: ci-cache
+  on:
+    tags: true
+    repo: johanneswuerbach/ci-cache

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Johannes Würbach
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,27 @@
+# ci-cache [![Build Status](https://travis-ci.org/johanneswuerbach/ci-cache.png?branch=master)](https://travis-ci.org/johanneswuerbach/ci-cache)
+
+Cache files and folders between continues integration builds.
+
+
+### Examples
+
+#### Bundler
+
+```yaml
+---
+bundler_args: --without development --path=~/.bundle
+language: ruby
+rvm:
+- 2.0.0
+env:
+  global:
+  - CI_CACHE_S3_BUCKET="cache-bucket"
+  - CI_CACHE_S3_KEY="cache-aws-key"
+  - CI_CACHE_S3_SECRET="cache-aws-secret"
+before_install:
+- gem install ci-cache
+- ci-cache get --name bundler-cache --output-path ~
+after_script:
+- bundle clean
+- ci-cache set --name bundler-cache --content ~/.bundle --hash-file Gemfile.lock
+```

data/Rakefile

@@ -0,0 +1 @@
+task(:default) { ruby '-S rspec' }

data/bin/ci-cache

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'ci-cache'
+CiCache::CLI.run(ARGV)

data/ci-cache.gemspec

@@ -0,0 +1,23 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "ci-cache/version"
+
+Gem::Specification.new do |s|
+  s.name                  = "ci-cache"
+  s.version               = CiCache::VERSION
+  s.author                = "Johannes Würbach"
+  s.email                 = "johannes.wuerbach@googlemail.com"
+  s.homepage              = "https://github.com/johanneswuerbach/ci-cache"
+  s.summary               = %q{ci cache tool}
+  s.description           = %q{cache files in an ephemeral continuous integration environment}
+  s.license               = 'MIT'
+  s.files                 = `git ls-files`.split("\n")
+  s.test_files            = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables           = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_path          = 'lib'
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.add_runtime_dependency 'aws-sdk'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
+end

data/lib/ci-cache/cli.rb

@@ -0,0 +1,160 @@
+require 'ci-cache/error'
+require 'optparse'
+require 'pathname'
+
+module CiCache
+  class CLI
+    def self.run(argv)
+      new(argv).run
+    end
+
+    attr_reader :options, :argv
+    attr_accessor :fold_count, :command
+
+    VALID_COMMANDS = ['get', 'set']
+
+    def initialize(argv = nil)
+      @argv    = argv || ARGV
+      @options = {}
+      self.fold_count = 0
+    end
+
+    def run
+      parse!
+      execute_command
+    rescue Error => error
+      options[:debug] ? raise(error) : die(error.message)
+    end
+
+    def fold(message)
+      self.fold_count += 1
+      print "travis_fold:start:ci-cache.#{fold_count}\r" if options[:fold]
+      puts "\e[33m#{message}\e[0m"
+      yield
+    ensure
+      print "\ntravis_fold:end:ci-cache.#{fold_count}\r" if options[:fold]
+    end
+
+    def name
+      error("No valid name provided") unless options[:name]
+      options[:name]
+    end
+
+    def content
+      error("No valid content provided") unless options[:content]
+      Pathname(options[:content])
+    end
+
+    def hash_file
+      error("No hash file provided") unless options[:hash_file]
+      Pathname(options[:hash_file]).expand_path
+    end
+
+    def output_path
+      error("No output path provided") unless options[:output_path]
+      Pathname(options[:output_path]).expand_path
+    end
+
+    def cache_archive_name
+      "#{name}.tar.gz"
+    end
+
+    def cache_hash_file_name
+      "#{name}.sha2"
+    end
+
+    def tmp_folder
+      Pathname("~").expand_path
+    end
+
+    def archive_path
+      Pathname("#{tmp_folder}/#{cache_archive_name}")
+    end
+
+    def old_hash_file
+      Pathname("#{tmp_folder}/#{cache_hash_file_name}")
+    end
+
+    def log(message)
+      $stderr.puts(message)
+    end
+
+    private
+
+    def execute_command
+      if VALID_COMMANDS.include? command
+        send(command)
+        return 0
+      else
+        error "Invalid command."
+        return 1
+      end
+    end
+
+    def get
+      fold("Getting #{name}") do
+        CiCache::Get.new(self).run
+      end
+    end
+
+    def set
+      fold("Setting #{name}") do
+        CiCache::Set.new(self).run
+      end
+    end
+
+    def error(message)
+      raise Error, message
+    end
+
+    def die(message)
+      $stderr.puts(message)
+      exit 1
+    end
+
+    def parse!
+      self.command = argv[0]
+      parser.parse! argv
+    end
+
+    def parser
+      @opt_parser ||= begin
+        options = self.options
+
+        OptionParser.new do |opt|
+          opt.banner = 'Usage: ci-cache COMMAND [OPTIONS]'
+          opt.separator  ''
+          opt.separator  'Commands'
+          opt.separator  '     get: get files from cache'
+          opt.separator  '     set: cache files'
+          opt.separator  ''
+          opt.separator  'Options'
+
+          opt.on('--name NAME','archive name') do |name|
+            options[:name] = name
+          end
+
+          opt.on('--content CONTENT','path or file to cache') do |content|
+            options[:content] = content
+          end
+
+          opt.on('--hash-file HASH_FILE', 'file used to check for updates') do |target_path|
+            options[:hash_file] = target_path
+          end
+
+          opt.on('--output-path OUTPUT_PATH', 'path the archive should be extracted to') do |output_path|
+            options[:output_path] = output_path
+          end
+
+          opt.on('--fold', 'fold output on travis') do |fold|
+            options[:fold] = fold
+          end
+
+          opt.on('-h','--help','help') do
+            puts @opt_parser
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ci-cache/error.rb

@@ -0,0 +1,3 @@
+module CiCache
+  Error = Class.new(StandardError)
+end

data/lib/ci-cache/get.rb

@@ -0,0 +1,50 @@
+module CiCache
+  class Get
+
+    def initialize(context)
+      @context = context
+      @storage = Storage.new(context)
+    end
+
+    def run
+      download_archive
+      download_hash_file
+      extract_archive
+    end
+
+    private
+
+    def download_archive
+      @storage.download(context.cache_archive_name, tmp_folder)
+    end
+
+    def download_hash_file
+      @storage.download(context.cache_hash_file_name, tmp_folder)
+    end
+
+    def extract_archive
+      log "Extract: #{archive_path} ~> #{output_path}"
+      CiCache.shell("tar -C #{output_path} -xf #{archive_path}")
+    end
+
+    def context
+      @context
+    end
+
+    def log(message)
+      context.log(message)
+    end
+
+    def tmp_folder
+      context.tmp_folder
+    end
+
+    def archive_path
+      context.archive_path
+    end
+
+    def output_path
+      context.output_path
+    end
+  end
+end

data/lib/ci-cache/set.rb

@@ -0,0 +1,66 @@
+require "digest"
+
+module CiCache
+  class Set
+    def initialize(context)
+      @context = context
+      @storage = Storage.new(context)
+    end
+
+    def run
+      if content_has_changed?
+        context.log("Updating cache.")
+        archive_files
+        upload_archive
+        upload_hash_file
+      else
+        context.log("Nothing changed.")
+      end
+    end
+
+    private
+
+    def context
+      @context
+    end
+
+    def archive_files
+      dirname, basename = content.split
+      log "Archive: #{content} ~> #{archive_path}"
+      CiCache.shell("tar -C #{dirname} -cjf #{archive_path} #{basename}")
+    end
+
+    def content_has_changed?
+      new_checksum != old_checksum
+    end
+
+    def new_checksum
+      @_new_checksum ||= Digest::SHA2.file(context.hash_file).hexdigest
+    end
+
+    def old_checksum
+      old_hash_file = context.old_hash_file
+      File.exists?(old_hash_file) ? File.read(old_hash_file) : ""
+    end
+
+    def upload_archive
+      @storage.upload(context.cache_archive_name, context.archive_path)
+    end
+
+    def upload_hash_file
+      @storage.upload(context.cache_hash_file_name, new_checksum)
+    end
+
+    def archive_path
+      context.archive_path
+    end
+
+    def content
+      context.content
+    end
+
+    def log(message)
+      context.log(message)
+    end
+  end
+end

data/lib/ci-cache/storage.rb

@@ -0,0 +1,54 @@
+module CiCache
+  class Storage
+
+    def initialize(context)
+      configure_aws
+      @s3 = AWS::S3.new
+      @context = context
+    end
+
+    def download(name, tmp_folder)
+      target_file = "#{tmp_folder}/#{name}"
+      log "Download: #{name} ~> #{target_file}"
+      object = bucket_object(name)
+      File.open(target_file, 'wb') do |file|
+        object.read do |chunk|
+           file.write(chunk)
+        end
+      end
+    rescue AWS::S3::Errors::AccessDenied => e
+      log "Not found."
+    end
+
+    def upload(name, content)
+      log "Upload: #{name}"
+      object = bucket_object(name)
+      object.write(content)
+    end
+
+    private
+
+    def log(message)
+      @context.log(message)
+    end
+
+    def bucket_name
+      ENV["CI_CACHE_S3_BUCKET"]
+    end
+
+    def configure_aws
+      AWS.config(
+        access_key_id: ENV["CI_CACHE_S3_KEY"],
+        secret_access_key: ENV["CI_CACHE_S3_SECRET"]
+      )
+    end
+
+    def bucket_object(name)
+      bucket.objects[name]
+    end
+
+    def bucket
+      @s3.buckets[bucket_name]
+    end
+  end
+end

data/lib/ci-cache/version.rb

@@ -0,0 +1,3 @@
+module CiCache
+  VERSION = '1.0.0'
+end

data/lib/ci-cache.rb

@@ -0,0 +1,13 @@
+require 'aws-sdk'
+
+module CiCache
+  autoload :CLI,     'ci-cache/cli'
+  autoload :Get,     'ci-cache/get'
+  autoload :Set,     'ci-cache/set'
+  autoload :Error,   'ci-cache/error'
+  autoload :Storage, 'ci-cache/storage'
+
+  def self.shell(command)
+    system(command)
+  end
+end

data/spec/cli_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe CiCache::CLI do
+
+  describe "::new" do
+    let(:path) { Pathname("~/").expand_path }
+    let(:cli) { CiCache::CLI.new([
+      "set",
+      "--name", "bundle_cache",
+      "--hash-file", "Gemfile",
+      "--content", "~/.bundle_cache"
+    ])}
+    subject { cli }
+    before do
+      cli.send(:parse!)
+    end
+
+    its(:cache_archive_name) { should eq("bundle_cache.tar.gz")}
+    its(:cache_hash_file_name) { should eq("bundle_cache.sha2")}
+    its(:tmp_folder) { should eq(path) }
+    its(:archive_path) { should eq(Pathname("#{path}/bundle_cache.tar.gz"))}
+    its(:old_hash_file) { should eq(Pathname("#{path}/bundle_cache.sha2"))}
+    its(:hash_file) { should eq(Pathname("Gemfile").expand_path) }
+    its(:content) { should eq(Pathname("~/.bundle_cache")) }
+  end
+
+  describe "::run" do
+    context "when get is used" do
+      let(:get) { double "get" }
+      subject { CiCache::CLI.run(["get", "--name", "cached"]) }
+
+      it "should execute the get command" do
+        CiCache::Get.should_receive(:new).with(instance_of(CiCache::CLI)).and_return(get)
+        CiCache::CLI.any_instance.should_receive(:fold).and_yield
+        get.should_receive(:run)
+        subject
+      end
+    end
+
+    context "when set is used" do
+      let(:set) { double "set" }
+      subject { CiCache::CLI.run(["set", "--name", "cached"]) }
+
+      it "should execute the set command" do
+        CiCache::Set.should_receive(:new).with(instance_of(CiCache::CLI)).and_return(set)
+        CiCache::CLI.any_instance.should_receive(:fold).and_yield
+        set.should_receive(:run)
+        subject
+      end
+    end
+  end
+end

data/spec/get_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe CiCache::Get do
+  describe :run do
+    let(:context) { double "context" }
+    let(:get) { CiCache::Get.new(context) }
+    let(:storage) { double "storage" }
+    subject { get.run }
+
+    before do
+      CiCache.stub(:shell)
+      context.stub(:cache_archive_name).and_return("cache.tar.gz")
+      context.stub(:cache_hash_file_name).and_return("cache.sha2")
+      context.stub(:archive_path).and_return(Pathname("~/cache.tar.gz"))
+      context.stub(:tmp_folder).and_return("~")
+      context.stub(:output_path).and_return("~")
+      context.stub(:log)
+
+      storage.stub(:download)
+      CiCache::Storage.should_receive(:new).and_return(storage)
+    end
+
+    it "downloads the archive" do
+      storage.should_receive(:download).with("cache.tar.gz", "~")
+      subject
+    end
+
+    it "download the hash file" do
+      storage.should_receive(:download).with("cache.sha2", "~")
+      subject
+    end
+
+    it "extracts the archive" do
+      CiCache.should_receive(:shell).with("tar -C ~ -xf ~/cache.tar.gz")
+      subject
+    end
+  end
+end

data/spec/set_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe CiCache::Set do
+  describe :run do
+    let(:context) { double "context" }
+    let(:set) { CiCache::Set.new(context) }
+    let(:storage) { double "storage" }
+    subject { set.run }
+
+    before do
+      CiCache.stub(:shell)
+      context.stub(:cache_archive_name).and_return("cache.tar.gz")
+      context.stub(:cache_hash_file_name).and_return("cache.sha2")
+      context.stub(:hash_file).and_return("Gemfile")
+      context.stub(:archive_path).and_return("~/archive.tar.gz")
+      context.stub(:old_hash_file).and_return("~/cache.sha2")
+      context.stub(:content).and_return(Pathname("~/.bundle_cache"))
+      context.stub(:log)
+
+      storage.stub(:upload)
+      CiCache::Storage.should_receive(:new).and_return(storage)
+    end
+
+    context "when content has changed" do
+      it "archives the folder" do
+        CiCache.should_receive(:shell).with("tar -C ~ -cjf ~/archive.tar.gz .bundle_cache")
+        subject
+      end
+
+      it "uploads the archive" do
+        storage.should_receive(:upload).with("cache.tar.gz", "~/archive.tar.gz")
+        subject
+      end
+
+      it "uploads the hash file" do
+        storage.should_receive(:upload).with("cache.sha2", Digest::SHA2.file("Gemfile").hexdigest)
+        subject
+      end
+    end
+
+    context "when content has not changed" do
+      it "logs a message" do
+        context.should_receive(:log)
+        subject
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'ci-cache'

data/spec/storage_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe CiCache::Storage do
+  let(:context) { double "context" }
+  let(:storage) { CiCache::Storage.new(context) }
+  let(:object) { double "object" }
+  let(:name) { "file" }
+
+  before do
+    context.stub(:log)
+  end
+
+  describe :download do
+    let(:folder) { "~" }
+    let(:handle) { double "handle" }
+    subject { storage.download(name, folder) }
+
+    context "when the object exists" do
+      it "downloads the object" do
+        storage.should_receive(:bucket_object).and_return(object)
+        object.should_receive(:read).and_yield("chunk")
+        handle.should_receive(:write).with("chunk")
+        File.should_receive(:open).with("~/file", "wb").and_yield(handle)
+        subject
+      end
+    end
+
+    context "when the object doesn't exist" do
+      it "logs an error" do
+        storage.should_receive(:bucket_object).and_raise(AWS::S3::Errors::AccessDenied.new)
+        context.should_receive(:log)
+        subject
+      end
+    end
+  end
+
+  describe :upload do
+    subject { storage.upload(name, "content") }
+
+    it "uploads the content" do
+      storage.should_receive(:bucket_object).and_return(object)
+      object.should_receive(:write).with("content")
+      subject
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: ci-cache
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Johannes Würbach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: cache files in an ephemeral continuous integration environment
+email: johannes.wuerbach@googlemail.com
+executables:
+- ci-cache
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/ci-cache
+- ci-cache.gemspec
+- lib/ci-cache.rb
+- lib/ci-cache/cli.rb
+- lib/ci-cache/error.rb
+- lib/ci-cache/get.rb
+- lib/ci-cache/set.rb
+- lib/ci-cache/storage.rb
+- lib/ci-cache/version.rb
+- spec/cli_spec.rb
+- spec/get_spec.rb
+- spec/set_spec.rb
+- spec/spec_helper.rb
+- spec/storage_spec.rb
+homepage: https://github.com/johanneswuerbach/ci-cache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.3
+signing_key: 
+specification_version: 4
+summary: ci cache tool
+test_files:
+- spec/cli_spec.rb
+- spec/get_spec.rb
+- spec/set_spec.rb
+- spec/spec_helper.rb
+- spec/storage_spec.rb