dockly 1.2.1 → 1.3.1

data/.gitignore

@@ -13,3 +13,4 @@ build/
 dist/
 
 docker-export-ubuntu-latest.tar.gz
+tmp

data/README.md

@@ -2,8 +2,8 @@
 [![Build Status](https://travis-ci.org/swipely/dockly.png?branch=refactor_setup)](https://travis-ci.org/swipely/dockly)
 [![Dependency Status](https://gemnasium.com/swipely/dockly.png)](https://gemnasium.com/swipely/dockly)
 
-Dockly
-=======
+![Dockly](https://raw.github.com/swipely/dockly/master/img/dockly.png)
+======================================================================
 
 `dockly` is a gem made to ease the pain of packaging an application. For this gem to be useful, quite a few assumptions can be made about your stack:
 
@@ -74,10 +74,14 @@ The `build_cache` DSL is used to prevent rebuilding assets every build and used
     - description: the name prepended to the package; allows for namespacing your caches
 - `hash_command`
     - required: `true`
-    - description: command run inside of the Docker image to determine if the build cache is up to date (eg. `md5sum ... | awk '{ print $1 }'`)
+    - description: command run to determine if the build cache is up to date (eg. `md5sum ... | awk '{ print $1 }'`)
+- `parameter_command`
+    - required: `false`
+    - allows multiple
+    - description: command run to build specific versions of build caches -- useful for multiple operating systems (not required)
 - `build_command`
     - required: `true`
-    - description: command run inside of the Docker image when the build cache is out of date
+    - description: command run when the build cache is out of date
 - `output_dir`
     - required: `true`
     - description: where the cache is located in the Docker image filesystem
@@ -135,6 +139,7 @@ In addition to the above attributes, `docker` has the following references:
 
 - `build_cache`
     - required: `false`
+    - allows multiple
     - class: `Dockly::BuildCache`
     - description: a caching system to stop rebuilding/compiling the same files every time
 

data/dockly.gemspec

@@ -15,8 +15,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = %w{lib}
   gem.version       = Dockly::VERSION
   gem.add_dependency 'clamp', '~> 0.6'
-  gem.add_dependency 'docker-api', '~> 1.7.2'
-  gem.add_dependency 'dockly-util', '~> 0.0.5'
+  gem.add_dependency 'docker-api', '~> 1.7.3'
+  gem.add_dependency 'dockly-util', '~> 0.0.6'
   gem.add_dependency 'excon'
   gem.add_dependency 'fog', '~> 1.18.0'
   gem.add_dependency 'foreman'

data/lib/dockly/build_cache.rb

@@ -1,139 +1,16 @@
-require 'tempfile'
-
-class Dockly::BuildCache
-  include Dockly::Util::DSL
-  include Dockly::Util::Logger::Mixin
-
-  logger_prefix '[dockly build_cache]'
-
-  attr_accessor :image
-  dsl_attribute :s3_bucket, :s3_object_prefix, :hash_command, :output_dir, :build_command,
-                :use_latest, :tmp_dir
-
-  default_value :use_latest, false
-  default_value :tmp_dir, '/tmp'
-
-  def execute!
-    ensure_present! :image
-    debug "Looking for cache for hash: #{hash_output}"
-    if up_to_date?
-      debug "build cache up to date, pulling from s3"
-      insert_cache
-    else
-      insert_latest
-      debug "build cache out of date, running build"
-      run_build
-    end
-    debug "finished build cache"
-    image
-  end
-
-  def insert_cache
-    push_cache(hash_output)
-  end
-
-  def insert_latest
-    if use_latest
-      debug "attempting to push latest"
-      if cache = push_cache("latest")
-        debug "pushed latest, removing local file"
-        File.delete(cache.path)
-      end
-    end
-  end
-
-  def run_build
-    container = image.run(build_command)
-    status = container.wait(3600)['StatusCode'] # 1 hour max timeout
-    raise "Build Cache `#{build_command}` failed to run." unless status.zero?
-    cache = copy_output_dir(container)
-    debug "pushing #{output_dir} to s3"
-    push_to_s3(cache)
-    cache.close
-    self.image = container.commit
-  end
-
-  def push_cache(version)
-    ensure_present! :output_dir
-    if cache = pull_from_s3(version)
-      debug "inserting to #{output_dir}"
-      container = image.run("mkdir -p #{File.dirname(output_dir)}")
-      image_with_dir = container.tap { |c| c.wait }.commit
-      self.image = image_with_dir.insert_local(
-        'localPath' => cache.path,
-        'outputPath' => File.dirname(output_dir)
-      )
-      cache.close
-    else
-      info "could not find #{s3_object(version)}"
-    end
-  end
-
-  def up_to_date?
-    ensure_present! :s3_bucket, :s3_object_prefix
-    connection.head_object(s3_bucket, s3_object(hash_output))
-    true
-  rescue Excon::Errors::NotFound
-    false
-  end
-
-  def pull_from_s3(version)
-    ensure_present! :s3_bucket, :s3_object_prefix
+module Dockly::BuildCache
+end
 
-    file_name = s3_object(version)
-    file_path = File.join(tmp_dir,file_name)
+require 'dockly/build_cache/base'
+require 'dockly/build_cache/docker'
+require 'dockly/build_cache/local'
 
-    FileUtils.mkdir_p(File.dirname(file_path))
-    unless File.exist?(file_path)
-      object = connection.get_object(s3_bucket, file_name)
+module Dockly::BuildCache
+  class << self
+    attr_writer :model
 
-      file = File.open(file_path, 'w+b')
-      file.write(object.body)
-      file.tap(&:rewind)
-    else
-      File.open(file_path, 'rb')
+    def model
+      @mode ||= Dockly::BuildCache::Docker
     end
-  rescue Excon::Errors::NotFound
-    nil
-  end
-
-  def push_to_s3(file)
-    ensure_present! :s3_bucket, :s3_object_prefix
-    connection.put_object(s3_bucket, s3_object(hash_output), file.read)
-    connection.copy_object(s3_bucket, s3_object(hash_output), s3_bucket, s3_object("latest"))
-  end
-
-  def copy_output_dir(container)
-    ensure_present! :output_dir
-    file_path = File.join(tmp_dir,s3_object(hash_output))
-    FileUtils.mkdir_p(File.dirname(file_path))
-    file = File.open(file_path, 'w+b')
-    container.wait(3600) # 1 hour max timeout
-    container.copy(output_dir) { |chunk| file.write(chunk) }
-    file.tap(&:rewind)
-  end
-
-  def hash_output
-    ensure_present! :image, :hash_command
-    @hash_output ||= begin
-      resp = ""
-      container = image.run(hash_command)
-      container.attach { |source,chunk| resp += chunk }
-      status = container.wait['StatusCode']
-      raise "Hash Command `#{hash_command} failed to run" unless status.zero?
-      resp.strip
-    end
-  end
-
-  def file_output(file)
-    File.join(File.dirname(output_dir), File.basename(file.path))
-  end
-
-  def s3_object(file)
-    "#{s3_object_prefix}#{file}"
-  end
-
-  def connection
-    Dockly::AWS.s3
   end
 end

data/lib/dockly/build_cache/base.rb

@@ -0,0 +1,117 @@
+require 'tempfile'
+
+class Dockly::BuildCache::Base
+  include Dockly::Util::DSL
+  include Dockly::Util::Logger::Mixin
+
+  logger_prefix '[dockly build_cache]'
+
+  dsl_attribute :s3_bucket, :s3_object_prefix, :use_latest,
+                :hash_command, :build_command, :parameter_commands,
+                :base_dir, :command_dir, :output_dir, :tmp_dir
+
+  default_value :use_latest, false
+  default_value :parameter_commands, {}
+  default_value :command_dir, '.'
+  default_value :output_dir, '.'
+  default_value :tmp_dir, '/tmp'
+
+  def execute!
+    debug "Looking for cache for hash: #{hash_output}"
+    if up_to_date?
+      debug "build cache up to date, pulling from s3"
+      insert_cache
+    else
+      insert_latest
+      debug "build cache out of date, running build"
+      run_build
+    end
+    debug "finished build cache"
+  end
+
+  def insert_cache
+    push_cache(hash_output)
+  end
+
+  def insert_latest
+    if use_latest
+      debug "attempting to push latest"
+      if cache = push_cache("latest")
+        debug "pushed latest, removing local file"
+        File.delete(cache.path)
+      end
+    end
+  end
+
+  def up_to_date?
+    ensure_present! :s3_bucket, :s3_object_prefix
+    connection.head_object(s3_bucket, s3_object(hash_output))
+    true
+  rescue Excon::Errors::NotFound
+    false
+  end
+
+  def pull_from_s3(version)
+    ensure_present! :s3_bucket, :s3_object_prefix
+
+    file_name = s3_object(version)
+    file_path = File.join(tmp_dir,file_name)
+
+    FileUtils.mkdir_p(File.dirname(file_path))
+    unless File.exist?(file_path)
+      object = connection.get_object(s3_bucket, file_name)
+
+      file = File.open(file_path, 'w+b')
+      file.write(object.body)
+      file.tap(&:rewind)
+    else
+      File.open(file_path, 'rb')
+    end
+  rescue Excon::Errors::NotFound
+    nil
+  end
+
+  def hash_output
+  end
+
+  def parameter_output(command)
+  end
+
+  def parameter_command(command)
+    parameter_commands[command] = nil
+  end
+
+  def push_to_s3(file)
+    ensure_present! :s3_bucket, :s3_object_prefix
+    connection.put_object(s3_bucket, s3_object(hash_output), file.read)
+    connection.copy_object(s3_bucket, s3_object(hash_output), s3_bucket, s3_object("latest"))
+  end
+
+  def file_output(file)
+    File.join(File.dirname(output_dir), File.basename(file.path))
+  end
+
+  def s3_object(file)
+    output = "#{s3_object_prefix}"
+    parameter_commands.each do |parameter_command, _|
+      output << "#{parameter_output(parameter_command)}_" unless parameter_output(parameter_command).nil?
+    end
+    output << "#{file}"
+  end
+
+  def command_directory
+    File.join(base_directory, command_dir)
+  end
+
+  def output_directory
+    File.join(base_directory, output_dir)
+  end
+
+  def base_directory
+    base_dir || docker.git_archive
+  end
+
+  def connection
+    Dockly::AWS.s3
+  end
+end

data/lib/dockly/build_cache/docker.rb

@@ -0,0 +1,72 @@
+class Dockly::BuildCache::Docker < Dockly::BuildCache::Base
+  attr_accessor :image
+
+  def execute!
+    ensure_present! :image
+    super
+    image
+  end
+
+  def run_build
+    status, body, container = run_command(build_command)
+    raise "Build Cache `#{build_command}` failed to run." unless status.zero?
+    cache = copy_output_dir(container)
+    debug "pushing #{output_directory} to s3"
+    push_to_s3(cache)
+    cache.close
+    self.image = container.commit
+  end
+
+  def push_cache(version)
+    ensure_present! :output_dir
+    if cache = pull_from_s3(version)
+      debug "inserting to #{output_directory}"
+      container = image.run("mkdir -p #{File.dirname(output_directory)}")
+      image_with_dir = container.tap { |c| c.wait }.commit
+      self.image = image_with_dir.insert_local(
+        'localPath' => cache.path,
+        'outputPath' => File.dirname(output_directory)
+      )
+      cache.close
+    else
+      info "could not find #{s3_object(version)}"
+    end
+  end
+
+  def copy_output_dir(container)
+    ensure_present! :output_dir
+    file_path = File.join(tmp_dir,s3_object(hash_output))
+    FileUtils.mkdir_p(File.dirname(file_path))
+    file = File.open(file_path, 'w+b')
+    container.wait(3600) # 1 hour max timeout
+    container.copy(output_directory) { |chunk| file.write(chunk) }
+    file.tap(&:rewind)
+  end
+
+  def hash_output
+    ensure_present! :image, :hash_command
+    @hash_output ||= begin
+      status, body, container = run_command(hash_command)
+      raise "Hash Command `#{hash_command}` failed to run" unless status.zero?
+      body
+    end
+  end
+
+  def parameter_output(command)
+    ensure_present! :image
+    raise "Parameter Command tried to run but not found" unless parameter_commands.keys.include?(command)
+    @parameter_commands[command] ||= begin
+      status, body, container = run_command(command)
+      raise "Parameter Command `#{command}` failed to run" unless status.zero?
+      body
+    end
+  end
+
+  def run_command(command)
+    resp = ""
+    container = image.run(["/bin/bash", "-lc", "cd #{command_directory} && #{command}"])
+    container.attach { |source,chunk| resp += chunk }
+    status = container.wait['StatusCode']
+    [status, resp.strip, container]
+  end
+end

data/lib/dockly/build_cache/local.rb

@@ -0,0 +1,56 @@
+class Dockly::BuildCache::Local < Dockly::BuildCache::Base
+  def run_build
+    puts "Build command: #{build_command}"
+    status, body = run_command(build_command)
+    raise "Build Cache `#{build_command}` failed to run." unless status.success?
+    FileUtils.mkdir_p(File.dirname(save_file))
+    tar_file = Dockly::Util::Tar.tar(output_directory, save_file)
+    push_to_s3(tar_file)
+  end
+
+  def output_directory
+    File.expand_path(File.join(Dir.pwd, output_dir))
+  end
+
+  def save_file
+    File.expand_path("build/build_cache/#{s3_object_prefix}#{hash_output}")
+  end
+
+  def push_cache(version)
+    ensure_present! :output_dir
+    if cache = pull_from_s3(version)
+      dest = File.dirname(File.expand_path(output_dir))
+      Dockly::Util::Tar.untar(cache, dest)
+    else
+      info "could not find #{s3_object(output_dir)}"
+    end
+  end
+
+  def hash_output
+    ensure_present! :hash_command
+    @hash_output ||= begin
+      status, body = run_command(hash_command)
+      raise "Hash Command `#{hash_command} failed to run" unless status.success?
+      body
+    end
+  end
+
+  def parameter_output(command)
+    raise "Parameter Command tried to run but not found" unless parameter_commands.keys.include?(command)
+    @parameter_commands[command] ||= begin
+      status, body = run_command(command)
+      raise "Parameter Command `#{command} failed to run" unless status.success?
+      body
+    end
+  end
+
+  def run_command(command)
+    resp = ""
+    Bundler.with_clean_env do
+      IO.popen(command) do |io|
+        resp << io.read
+      end
+    end
+    [$?, resp.strip]
+  end
+end

data/lib/dockly/cli.rb

@@ -39,8 +39,47 @@ class Dockly::ListCommand < Dockly::AbstractCommand
   end
 end
 
+class Dockly::BuildCacheCommand < Dockly::AbstractCommand
+  parameter 'DOCKER', 'the name of the docker image to build for', :attribute_name => :docker_name
+  option ['-l', '--list'], :flag, 'list the build caches', :default => false, :attribute_name => :list
+  option ['-L', '--local'], :flag, 'use local build caches', :default => false, :attribute_name => :local
+
+  def execute
+    Dockly::BuildCache.model = Dockly::BuildCache::Local
+    super
+    build_caches = Dockly.docker(docker_name.to_sym).build_cache || []
+    raise "No build cache for #{docker_name}" if build_caches.empty?
+    if list?
+      build_caches.each_with_index do |build_cache, index|
+        puts "#{index + 1}. Hash: #{build_cache.hash_command} Build: #{build_cache.build_command}"
+      end
+    else
+      bcs = if local?
+        convert_bc_to_local_bc(docker_name)
+      else
+        build_caches
+      end
+      bcs.each do |bc|
+        bc.execute!
+      end
+    end
+  end
+end
+
 class Dockly::Cli < Dockly::AbstractCommand
   subcommand ['build', 'b'], 'Create package', Dockly::BuildCommand
   subcommand ['list', 'l'], 'List packages', Dockly::ListCommand
+  subcommand ['build_cache', 'bc'], 'Build Cache commands', Dockly::BuildCacheCommand
 end
 
+def convert_bc_to_local_bc(docker_name)
+  lbcs = []
+  Dockly.docker(docker_name.to_sym).build_cache.each do |bc|
+    lbc = Dockly::BuildCache::Local.new! { name bc.name }
+    bc.instance_variables.each do |variable|
+      lbc.instance_variable_set(variable, bc.instance_variable_get(variable))
+    end
+    lbcs << lbc
+  end
+  lbcs
+end

data/lib/dockly/docker.rb

@@ -10,13 +10,15 @@ class Dockly::Docker
   include Dockly::Util::Logger::Mixin
 
   logger_prefix '[dockly docker]'
+
+  dsl_class_attribute :build_cache, Dockly::BuildCache.model, type: Array
+
   dsl_attribute :name, :import, :git_archive, :build, :tag, :build_dir, :package_dir,
-    :timeout, :cleanup_images, :build_caches
+    :timeout, :cleanup_images
 
   default_value :tag, nil
   default_value :build_dir, 'build/docker'
   default_value :package_dir, '/opt/docker'
-  default_value :build_caches, []
   default_value :cleanup_images, false
   default_value :timeout, 60
 
@@ -43,7 +45,7 @@ class Dockly::Docker
 
   def run_build_caches(image)
     info "starting build caches"
-    build_caches.each do |cache|
+    (build_cache || []).each do |cache|
       cache.image = image
       image = cache.execute!
     end
@@ -158,10 +160,6 @@ class Dockly::Docker
     path
   end
 
-  def build_cache(&block)
-    build_caches << Dockly::BuildCache.new(&block)
-  end
-
   def repository(value = nil)
     name(value)
   end

data/lib/dockly/util/tar.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module Dockly::Util::Tar
   extend self
 
@@ -24,4 +26,33 @@ module Dockly::Util::Tar
     magic = magic.unpack('H*')[0]
     magic == "1f8b"
   end
+
+  # Creates a tar file in memory recursively
+  # from the given path.
+  #
+  # Returns a StringIO whose underlying String
+  # is the contents of the tar file.
+  def tar(path, output)
+    FileUtils.mkdir_p(File.dirname(output))
+    puts "tarring #{path} to #{output}"
+    tar_command = "tar -cf #{output} -C #{File.dirname(path)} #{File.basename(path)}"
+    puts "Tar Command: #{tar_command}"
+    IO.popen(tar_command) do |io|
+      puts io.read
+    end
+    File.open(output, 'rb+')
+  end
+
+  # untars the given IO into the specified
+  # directory
+  def untar(input_io, destination)
+    puts "untarring #{input_io.path} to #{destination}"
+    FileUtils.mkdir_p(destination)
+    untar_command = "tar -xf #{input_io.path} -C #{destination}"
+    puts "Untar command: #{untar_command}"
+    IO.popen(untar_command) do |io|
+      puts io.read
+    end
+    input_io
+  end
 end

data/lib/dockly/version.rb

@@ -1,3 +1,3 @@
 module Dockly
-  VERSION = '1.2.1'
+  VERSION = '1.3.1'
 end

data/spec/dockly/build_cache/base_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Dockly::BuildCache::Base do
+  subject { described_class.new(:name => :test_build_cache) }
+
+  before do
+    subject.s3_bucket 'lol'
+    subject.s3_object_prefix 'swag'
+    subject.hash_command 'md5sum /etc/vim/vimrc'
+    subject.build_command 'touch lol'
+    subject.output_dir '/'
+  end
+
+  describe '#up_to_date?' do
+    context 'when the object exists in s3' do
+      before { subject.connection.stub(:head_object) }
+
+      its(:up_to_date?) { should be_true }
+    end
+
+    context 'when the object does not exist in s3' do
+      before do
+        subject.connection.stub(:head_object)
+            .and_raise(Excon::Errors::NotFound.new('help'))
+      end
+
+      its(:up_to_date?) { should be_false }
+    end
+  end
+
+  describe '#pull_from_s3' do
+    let(:file) { subject.pull_from_s3('hey') }
+    let(:object) { double(:object) }
+
+    before do
+      subject.connection.stub(:get_object).and_return object
+      object.stub(:body).and_return 'hey dad'
+    end
+
+    after do
+      path = file.path
+      file.close
+      File.delete(path)
+    end
+
+    it 'returns a File with the data pulled' do
+      file.read.should == 'hey dad'
+    end
+  end
+
+  describe '#s3_object' do
+    before do
+      subject.stub(:s3_object_prefix) { 'lol' }
+      subject.stub(:hash_output) { 'lel' }
+    end
+
+    context "without an arch_output" do
+      it 'returns the s3_prefix merged with the hash_output' do
+        subject.s3_object(subject.hash_output).should == 'lollel'
+      end
+    end
+
+    context "with an arch_output" do
+      before do
+        subject.parameter_command "linux"
+        subject.stub(:parameter_output) { "linux" }
+      end
+
+      it 'returns the s3_prefix merged with the hash_output' do
+        subject.s3_object(subject.hash_output).should == 'lollinux_lel'
+      end
+    end
+  end
+end

data/spec/dockly/build_cache/docker_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+
+describe Dockly::BuildCache::Docker, :docker do
+  let!(:build_cache) { described_class.new!(:name => :test_build_cache) }
+  let!(:docker) do
+    Dockly::Docker.new!(:name => :test_docker) do
+      git_archive '/app'
+    end
+  end
+  let(:image) { ::Docker::Image.build('from base') }
+
+  before do
+    build_cache.s3_bucket 'lol'
+    build_cache.s3_object_prefix 'swag'
+    build_cache.image = image
+    build_cache.hash_command 'md5sum /etc/vim/vimrc'
+    build_cache.build_command 'touch lol'
+    build_cache.output_dir '/etc/vim'
+    build_cache.base_dir '/'
+    docker.build_cache :test_build_cache
+  end
+
+  describe "#initialize" do
+    context "base_dir is the docker git_archive" do
+      before do
+        build_cache.instance_variable_set(:@base_dir, nil)
+      end
+
+      it "should return the base_directory as the git_archive" do
+        expect(build_cache.base_directory).to eq(docker.git_archive)
+      end
+    end
+  end
+
+  describe '#execute!' do
+    before do
+      build_cache.stub(:up_to_date?).and_return(up_to_date)
+      build_cache.stub(:push_cache)
+      build_cache.stub(:push_to_s3)
+    end
+
+    context 'when the object is up to date' do
+      let(:up_to_date) { true }
+
+      it "does not have the file lol" do
+        i = build_cache.execute!
+        output = ""
+        i.run('ls').attach { |source,chunk| output += chunk }
+        output.should_not include('lol')
+      end
+    end
+
+    context 'when the object is not up to date' do
+      let(:up_to_date) { false }
+
+      before do
+        build_cache.stub(:copy_output_dir) { StringIO.new }
+      end
+
+      it "does have the file lol" do
+        i = build_cache.execute!
+        output = ""
+        i.run('ls /').attach { |source,chunk| output += chunk }
+        output.should include('lol')
+      end
+    end
+  end
+
+  describe "#run_build" do
+    before do
+      build_cache.stub(:push_to_s3)
+    end
+
+    context "when the build succeeds" do
+      it "does have the file lol" do
+        i = build_cache.run_build
+        output = ""
+        i.run('ls').attach { |source,chunk| output += chunk }
+        output.should include('lol')
+      end
+    end
+
+    context "when the build fails" do
+      let!(:image) { build_cache.image }
+      before do
+        build_cache.image = double(:image).stub(:run) {
+          stub(:container, { :wait => { 'StatusCode' => 1 } })
+        }
+      end
+
+      after do
+        build_cache.image = image
+      end
+
+      it "raises an error" do
+        expect { build_cache.run_build }.to raise_error
+      end
+    end
+  end
+
+  describe '#hash_output' do
+    let(:output) {
+      "682aa2a07693cc27756eee9751db3903  /etc/vim/vimrc"
+    }
+
+    context "when hash command returns successfully" do
+      before do
+        build_cache.image = image
+      end
+
+      it 'returns the output of the hash_command in the container' do
+        build_cache.hash_output.should == output
+      end
+    end
+
+    context "when hash command returns failure" do
+      before do
+        build_cache.image = double(:image).stub(:run, {
+          :wait => { 'StatusCode' => 1 }
+        })
+      end
+
+      it 'raises an error' do
+        expect { build_cache.hash_output }.to raise_error
+      end
+    end
+  end
+
+  describe '#copy_output_dir' do
+    let(:container) { Docker::Container.create('Image' => 'base', 'Cmd' => %w[true]) }
+    let(:file) { build_cache.copy_output_dir(container) }
+    let(:hash) { 'this_really_unique_hash' }
+    let(:path) { file.path }
+
+    before do
+      build_cache.stub(:hash_output).and_return(hash)
+      build_cache.output_dir '/root/'; container.wait
+    end
+    after do
+      file.close
+      File.delete(path)
+    end
+
+    it 'returns a File of the specified directory from the Container' do
+      expect(file.path).to include("#{hash}")
+      file.should be_a File
+      file.read.should include('root/.bashrc')
+    end
+  end
+
+  describe '#parameter_output' do
+    before do
+      build_cache.parameter_command command
+    end
+    let(:output) { "3.8.0-27-generic" }
+
+    context "when parameter command returns successfully" do
+      let(:command) { "uname -r" }
+      it 'returns the output of the parameter_command' do
+        expect(build_cache.parameter_output(command)).to eq(output)
+      end
+    end
+
+    context "when parameter command returns failure" do
+      let(:command) { 'md6sum' }
+
+      it 'raises an error' do
+        expect { build_cache.parameter_output(command) }.to raise_error
+      end
+    end
+
+    context "when a parameter command isn't previously added" do
+      let(:command) { "md5sum /etc/vim/vimrc" }
+
+      it 'raises an error' do
+        expect { build_cache.parameter_output("#{command}1") }.to raise_error
+      end
+    end
+  end
+end
+

data/spec/dockly/build_cache/local_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+describe Dockly::BuildCache::Local do
+  let(:build_cache) { described_class.new!(:name => :test_local_build_cache) }
+
+  before do
+    build_cache.s3_bucket 'fake'
+    build_cache.s3_object_prefix 'object'
+    build_cache.hash_command "md5sum #{File.join(Dir.pwd, 'Gemfile')} | awk '{ print $1 }'"
+    build_cache.build_command 'mkdir -p tmp && touch tmp/lol'
+    build_cache.output_dir 'lib'
+  end
+
+  describe '#execute!' do
+    before do
+      build_cache.stub(:hash_output).and_return('abcdef')
+      build_cache.stub(:up_to_date?).and_return(up_to_date)
+      build_cache.stub(:push_cache)
+      build_cache.stub(:push_to_s3)
+
+      if File.exist?('tmp/lol')
+        File.delete('tmp/lol')
+      end
+    end
+
+    context 'when the object is up to date' do
+      let(:up_to_date) { true }
+
+      it "does not have the file lol" do
+        i = build_cache.execute!
+        output = ""
+        IO.popen('ls tmp') { |io| output += io.read }
+        output.should_not include('lol')
+      end
+    end
+
+    context 'when the object is not up to date' do
+      let(:up_to_date) { false }
+
+      before do
+        build_cache.stub(:copy_output_dir) { StringIO.new }
+      end
+
+      after do
+        if File.exist?('tmp/lol')
+          File.delete('tmp/lol')
+        end
+      end
+
+      it "does have the file lol" do
+        i = build_cache.execute!
+        output = ""
+        IO.popen('ls tmp') { |io| output << io.read }
+        output.should include('lol')
+      end
+    end
+  end
+
+  describe "#run_build" do
+    before do
+      build_cache.stub(:push_to_s3)
+    end
+
+    context "when the build succeeds" do
+      it "does have the file lol" do
+        i = build_cache.run_build
+        output = ""
+        IO.popen('ls tmp') { |io| output << io.read }
+        output.should include('lol')
+      end
+    end
+
+    context "when the build fails" do
+      before do
+        build_cache.build_command 'md6sum'
+      end
+
+      it "raises an error" do
+        expect { build_cache.run_build }.to raise_error
+      end
+    end
+  end
+
+  describe '#hash_output' do
+    let(:output) {
+      "f683463a09482287c33959ab71a87189"
+    }
+
+    context "when hash command returns successfully" do
+      it 'returns the output of the hash_command' do
+        build_cache.hash_output.should == output
+      end
+    end
+
+    context "when hash command returns failure" do
+      before do
+        build_cache.hash_command 'md6sum'
+      end
+
+      it 'raises an error' do
+        expect { build_cache.hash_output }.to raise_error
+      end
+    end
+  end
+
+  describe '#parameter_output' do
+    before do
+      build_cache.parameter_command command
+    end
+
+    let(:output) { "3.8.0-23-generic" }
+    context "when parameter command returns successfully" do
+      let(:command) { "uname -r" }
+      let(:status) { double(:status) }
+      before do
+        status.stub(:"success?") { true }
+        build_cache.stub(:run_command) { [status, output] }
+      end
+
+      it 'returns the output of the parameter_command' do
+        expect(build_cache.parameter_output(command)).to eq(output)
+      end
+    end
+
+    context "when parameter command returns failure" do
+      let(:command) { "md6sum" }
+
+      it 'raises an error' do
+        expect { build_cache.parameter_output(command) }.to raise_error
+      end
+    end
+
+    context "when a parameter command isn't previously added" do
+      let(:command) { "md5sum /etc/vim/vimrc" }
+
+      it 'raises an error' do
+        expect { build_cache.parameter_output("#{command}1") }.to raise_error
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dockly
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2013-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: 1.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: 1.7.3
 - !ruby/object:Gem::Dependency
   name: dockly-util
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
@@ -256,9 +256,13 @@ files:
 - Rakefile
 - bin/dockly
 - dockly.gemspec
+- img/dockly.png
 - lib/dockly.rb
 - lib/dockly/aws.rb
 - lib/dockly/build_cache.rb
+- lib/dockly/build_cache/base.rb
+- lib/dockly/build_cache/docker.rb
+- lib/dockly/build_cache/local.rb
 - lib/dockly/cli.rb
 - lib/dockly/deb.rb
 - lib/dockly/docker.rb
@@ -270,7 +274,9 @@ files:
 - lib/foreman/cli_fix.rb
 - lib/foreman/export/base_fix.rb
 - spec/dockly/aws_spec.rb
-- spec/dockly/build_cache_spec.rb
+- spec/dockly/build_cache/base_spec.rb
+- spec/dockly/build_cache/docker_spec.rb
+- spec/dockly/build_cache/local_spec.rb
 - spec/dockly/deb_spec.rb
 - spec/dockly/docker_spec.rb
 - spec/dockly/foreman_spec.rb
@@ -311,7 +317,9 @@ specification_version: 3
 summary: Packaging made easy
 test_files:
 - spec/dockly/aws_spec.rb
-- spec/dockly/build_cache_spec.rb
+- spec/dockly/build_cache/base_spec.rb
+- spec/dockly/build_cache/docker_spec.rb
+- spec/dockly/build_cache/local_spec.rb
 - spec/dockly/deb_spec.rb
 - spec/dockly/docker_spec.rb
 - spec/dockly/foreman_spec.rb

data/spec/dockly/build_cache_spec.rb

@@ -1,175 +0,0 @@
-require 'spec_helper'
-
-describe Dockly::BuildCache, :docker do
-  subject { described_class.new(:name => :test_build_cache) }
-  let(:image) { ::Docker::Image.build('from base') }
-
-  before do
-    subject.s3_bucket 'lol'
-    subject.s3_object_prefix 'swag'
-    subject.image = image
-    subject.hash_command 'md5sum /etc/vim/vimrc'
-    subject.build_command 'touch lol'
-    subject.output_dir '/'
-  end
-
-  describe '#execute!' do
-    before do
-      subject.stub(:up_to_date?).and_return(up_to_date)
-      subject.stub(:push_cache)
-      subject.stub(:push_to_s3)
-    end
-
-    context 'when the object is up to date' do
-      let(:up_to_date) { true }
-
-      it "does not have the file lol" do
-        i = subject.execute!
-        output = ""
-        i.run('ls').attach { |source,chunk| output += chunk }
-        output.should_not include('lol')
-      end
-    end
-
-    context 'when the object is not up to date' do
-      let(:up_to_date) { false }
-
-      it "does have the file lol" do
-        i = subject.execute!
-        output = ""
-        i.run('ls').attach { |source,chunk| output += chunk }
-        output.should include('lol')
-      end
-    end
-  end
-
-  describe "#run_build" do
-    before do
-      subject.stub(:push_to_s3)
-    end
-
-    context "when the build succeeds" do
-      it "does have the file lol" do
-        i = subject.run_build
-        output = ""
-        i.run('ls').attach { |source,chunk| output += chunk }
-        output.should include('lol')
-      end
-    end
-
-    context "when the build fails" do
-      let!(:image) { subject.image }
-      before do
-        subject.image = double(:image).stub(:run) {
-          stub(:container, { :wait => { 'StatusCode' => 1 } })
-        }
-      end
-
-      after do
-        subject.image = image
-      end
-
-      it "raises an error" do
-        expect { subject.run_build }.to raise_error
-      end
-    end
-  end
-
-  describe '#pull_from_s3' do
-    let(:file) { subject.pull_from_s3('hey') }
-    let(:object) { double(:object) }
-
-    before do
-      subject.connection.stub(:get_object).and_return object
-      object.stub(:body).and_return 'hey dad'
-    end
-
-    after do
-      path = file.path
-      file.close
-      File.delete(path)
-    end
-
-    it 'returns a File with the data pulled' do
-      file.read.should == 'hey dad'
-    end
-  end
-
-  describe '#up_to_date?' do
-    context 'when the object exists in s3' do
-      before { subject.connection.stub(:head_object) }
-
-      its(:up_to_date?) { should be_true }
-    end
-
-    context 'when the object does not exist in s3' do
-      before do
-        subject.connection.stub(:head_object)
-            .and_raise(Excon::Errors::NotFound.new('help'))
-      end
-
-      its(:up_to_date?) { should be_false }
-    end
-  end
-
-  describe '#hash_output' do
-    let(:output) {
-      "682aa2a07693cc27756eee9751db3903  /etc/vim/vimrc"
-    }
-
-    context "when hash command returns successfully" do
-      before do
-        subject.image = image
-      end
-
-      it 'returns the output of the hash_command in the container' do
-        subject.hash_output.should == output
-      end
-    end
-
-    context "when hash command returns failure" do
-      before do
-        subject.image = double(:image).stub(:run, {
-          :wait => { 'StatusCode' => 1 }
-        })
-      end
-
-      it 'raises an error' do
-        expect { subject.hash_output }.to raise_error
-      end
-    end
-  end
-
-  describe '#copy_output_dir' do
-    let(:container) { Docker::Container.create('Image' => 'base', 'Cmd' => %w[true]) }
-    let(:file) { subject.copy_output_dir(container) }
-    let(:hash) { 'this_really_unique_hash' }
-    let(:path) { file.path }
-
-    before do
-      subject.stub(:hash_output).and_return(hash)
-      subject.output_dir '/root/'; container.wait
-    end
-    after do
-      file.close
-      File.delete(path)
-    end
-
-    it 'returns a File of the specified directory from the Container' do
-      expect(file.path).to include("#{hash}")
-      file.should be_a File
-      file.read.should include('root/.bashrc')
-    end
-  end
-
-  describe '#s3_object' do
-    before do
-      subject.stub(:s3_object_prefix) { 'lol' }
-      subject.stub(:hash_output) { 'lel' }
-    end
-
-    it 'returns the s3_prefix merged with the hash_output' do
-      subject.s3_object(subject.hash_output).should == 'lollel'
-    end
-  end
-end