dockly 1.3.5 → 1.4.0

data/README.md

@@ -142,9 +142,37 @@ In addition to the above attributes, `docker` has the following references:
     - allows multiple
     - class: `Dockly::BuildCache`
     - description: a caching system to stop rebuilding/compiling the same files every time
+- `build_cache`
+    - required: `false`
+    - allows one
+    - class: `Dockly::Docker::Registry`
+    - description: a registry to push to in lieu of exporting as a tar -- the registry will be automatically pulled upon installing the debian package
 
 Need finer control of Docker packages? We also wrote [docker-api](https://github.com/swipely/docker-api).
 
+`registry`
+--------
+
+The `registry` DSL is used to define Docker Registries. It has the following attributes:
+
+- `authentication_required`
+    - required: `false`
+    - default: `true`
+    - description: a boolean that determines whether or not authentication is required on the registry.
+- `username`
+    - required: `true` unless `authentication_required` is `false`
+    - description: the username to authenticate
+- `email`:
+    - required: `true` unless `authentication_required` is `false`
+    - description: the email to authenticate
+- `password`:
+    - required: `false`
+    - description: the user's password; unless supplied, `ENV['DOCKER_REGISTRY_PASSWORD']` will be checked. not that `ENV['DOCKER_REGISTRY_PASSWORD']` is required to be set on the host on to which the package will be deployed
+- `server_address`:
+    - required: `true`
+    - default: `https://index.docker.io/v1`
+    - description: the server where the registry lives
+
 `foreman`
 ---------
 

data/lib/dockly.rb

@@ -1,23 +1,20 @@
 require 'dockly/util'
+require 'dockly/util/tar'
+require 'dockly/util/git'
 require 'fog'
 require 'foreman/cli_fix'
 require 'foreman/export/base_fix'
 
-module Dockly
-end
-
-require 'dockly/aws'
-require 'dockly/foreman'
-require 'dockly/build_cache'
-require 'dockly/docker'
-require 'dockly/deb'
-require 'dockly/util/tar'
-require 'dockly/util/git'
-
 module Dockly
   attr_reader :instance, :git_sha
   attr_writer :load_file
 
+  autoload :AWS, 'dockly/aws'
+  autoload :Foreman, 'dockly/foreman'
+  autoload :BuildCache, 'dockly/build_cache'
+  autoload :Docker, 'dockly/docker'
+  autoload :Deb, 'dockly/deb'
+
   LOAD_FILE = 'dockly.rb'
 
   def load_file

data/lib/dockly/deb.rb

@@ -92,7 +92,7 @@ private
     debug "converting to deb"
     @deb_package = @dir_package.convert(FPM::Package::Deb)
 
-    @deb_package.scripts[:before_install] = pre_install
+    @deb_package.scripts[:before_install] = compile_pre_install
     @deb_package.scripts[:after_install] = post_install
     @deb_package.scripts[:before_remove] = pre_uninstall
     @deb_package.scripts[:after_remove] = post_uninstall
@@ -120,6 +120,7 @@ private
     return if docker.nil?
     info "adding docker image"
     docker.generate!
+    return unless docker.registry.nil?
     package.attributes[:prefix] = docker.package_dir
     Dir.chdir(File.dirname(docker.tar_path)) do
       package.input(File.basename(docker.tar_path))
@@ -138,4 +139,17 @@ private
       package.attributes[:prefix] = nil
     end
   end
+
+  def compile_pre_install
+    registry = !docker.nil? && docker.registry
+    if registry
+      [
+        pre_install,
+        "docker login -e '#{registry.email}' -p '$DOCKER_REGISTRY_PASSWORD' -u '#{registry.username}'",
+        "docker pull #{docker.repo}"
+      ].join("\n")
+    else
+      pre_install
+    end
+  end
 end

data/lib/dockly/docker.rb

@@ -9,9 +9,12 @@ class Dockly::Docker
   include Dockly::Util::DSL
   include Dockly::Util::Logger::Mixin
 
+  autoload :Registry, 'dockly/docker/registry'
+
   logger_prefix '[dockly docker]'
 
   dsl_class_attribute :build_cache, Dockly::BuildCache.model, type: Array
+  dsl_class_attribute :registry, Dockly::Docker::Registry
 
   dsl_attribute :name, :import, :git_archive, :build, :tag, :build_dir, :package_dir,
     :timeout, :cleanup_images
@@ -26,17 +29,29 @@ class Dockly::Docker
     Docker.options = { :read_timeout => timeout, :write_timeout => timeout }
     docker_tar = File.absolute_path(ensure_tar(fetch_import))
 
-    import = import_base(docker_tar)
+    images = {}
 
-    cleanup = add_git_archive(import)
-    cleanup = run_build_caches(cleanup)
-    cleanup = build_image(cleanup)
+    images[:one] = import_base(docker_tar)
+    images[:two] = add_git_archive(images[:one])
+    images[:three] = run_build_caches(images[:two])
+    images[:four] = build_image(images[:three])
 
-    export_image(cleanup)
+    export_image(images[:four])
 
     true
   ensure
-    cleanup.remove if cleanup_images && !cleanup.nil?
+    cleanup(images.values.compact) if cleanup_images
+  end
+
+  def cleanup(images)
+    ::Docker::Container.all(:all => true).each do |container|
+      image_id = container.json['Image']
+      if images.any? { |image| image.id.start_with?(image_id) || image_id.start_with?(image.id) }
+        container.kill
+        container.delete
+      end
+    end
+    images.each { |image| image.remove rescue nil }
   end
 
   def export_filename
@@ -116,20 +131,47 @@ class Dockly::Docker
     info "starting build from #{image.id}"
     out_image = ::Docker::Image.build("from #{image.id}\n#{build}")
     info "built the image: #{out_image.id}"
-    out_image.tag(:repo => name, :tag => tag)
+    out_image.tag(:repo => repo, :tag => tag)
     out_image
   end
 
+  def repo
+    @repo ||= case
+    when registry.nil?
+      name
+    when registry.default_server_address?
+      "#{registry.username}/#{name}"
+    else
+      "#{registry.server_address}/#{name}"
+    end
+  end
+
   def export_image(image)
-    ensure_present! :name, :build_dir
-    container = ::Docker::Container.create('Image' => image.id, 'Cmd' => %w[true])
-    info "created the container: #{container.id}"
-    Zlib::GzipWriter.open(tar_path) do |file|
-      container.export do |chunk, remaining, total|
-        file.write(chunk)
+    ensure_present! :name
+    if registry.nil?
+      ensure_present! :build_dir
+      container = ::Docker::Container.create('Image' => image.id, 'Cmd' => %w[true])
+      info "created the container: #{container.id}"
+      Zlib::GzipWriter.open(tar_path) do |file|
+        container.export do |chunk, remaining, total|
+          file.write(chunk)
+        end
       end
+      info "done writing the docker tar: #{export_filename}"
+    else
+      push_to_registry(image)
     end
-    info "done writing the docker tar: #{export_filename}"
+  end
+
+  def push_to_registry(image)
+    ensure_present! :registry
+    info "Exporting #{image.id} to Docker registry at #{registry.server_address}"
+    registry.authenticate!
+    image = Docker::Image.all(:all => true).find { |img|
+      img.id.start_with?(image.id) || image.id.start_with?(img.id)
+    }
+    raise "Could not find image after authentication" if image.nil?
+    image.push(registry.to_h, :registry => registry.server_address)
   end
 
   def fetch_import

data/lib/dockly/docker/registry.rb

@@ -0,0 +1,42 @@
+class Dockly::Docker::Registry
+  include Dockly::Util::DSL
+  include Dockly::Util::Logger::Mixin
+
+  DEFAULT_SERVER_ADDRESS = 'https://index.docker.io/v1/'
+
+  logger_prefix '[dockly docker registry]'
+
+  dsl_attribute :name, :server_address, :email, :username, :password,
+                :authentication_required
+
+  default_value :server_address, DEFAULT_SERVER_ADDRESS
+  default_value :authentication_required, true
+
+  alias_method :authentication_required?, :authentication_required
+
+  def authenticate!
+    return unless authentication_required?
+
+    @password ||= ENV['DOCKER_REGISTRY_PASSWORD']
+    ensure_present! :email, :password, :server_address, :username
+
+    debug "Attempting to authenticate at #{server_address}"
+    ::Docker.authenticate!(self.to_h)
+    info "Successfully authenticated at #{server_address} with username #{username}"
+  rescue ::Docker::Error::AuthenticationError
+    raise "Could not authenticate at #{server_address} with username #{username}"
+  end
+
+  def default_server_address?
+    server_address == DEFAULT_SERVER_ADDRESS
+  end
+
+  def to_h
+    {
+      'serveraddress' => server_address,
+      'email' => email,
+      'username' => username,
+      'password' => password
+    }
+  end
+end

data/lib/dockly/version.rb

@@ -1,3 +1,3 @@
 module Dockly
-  VERSION = '1.3.5'
+  VERSION = '1.4.0'
 end

data/spec/dockly/build_cache/docker_spec.rb

@@ -59,9 +59,8 @@ describe Dockly::BuildCache::Docker, :docker do
 
       it "does have the file lol" do
         i = build_cache.execute!
-        output = ""
-        i.run('ls /').attach { |source,chunk| output += chunk }
-        output.should include('lol')
+        output = i.run('ls /').attach(:stdout => true)
+        output.first.first.lines.map(&:chomp).should include('lol')
       end
     end
   end
@@ -152,7 +151,7 @@ describe Dockly::BuildCache::Docker, :docker do
     before do
       build_cache.parameter_command command
     end
-    let(:output) { "3.8.0-27-generic" }
+    let(:output) { "3.12.9-2-ARCH" }
 
     context "when parameter command returns successfully" do
       let(:command) { "uname -r" }

data/spec/dockly/docker/registry_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Dockly::Docker::Registry, :current do
+  subject { described_class.new(:name => :dockly_registry) }
+
+  describe '#authenticate!' do
+    context 'when authentication is not required' do
+      before { subject.authentication_required false }
+
+      it 'does nothing' do
+        ::Docker.should_not_receive(:authenticate!)
+        subject.authenticate!
+      end
+    end
+
+    context 'when the password has not been supplied via the DSL' do
+      subject {
+        described_class.new(
+          :name => 'no-password',
+          :email => 'fake@email.com',
+          :username => 'fakeuser'
+        )
+      }
+
+      before { ::Docker.stub(:authenticate!) }
+
+      it 'prompts the user for the password' do
+        ENV.should_receive(:[]).and_return('password')
+        expect { subject.authenticate! }.to_not raise_error
+      end
+    end
+
+    context 'when the password has been supplied via the DSL' do
+      subject {
+        described_class.new(
+          :name => 'no-password',
+          :email => 'fake@email.com',
+          :password => 'fakepassword',
+          :username => 'fakeuser'
+        )
+      }
+
+      context 'when authentication succeeds' do
+        before { ::Docker.stub(:authenticate!) }
+
+        it 'does nothing' do
+          ENV.should_not_receive(:[])
+          expect { subject.authenticate! }.to_not raise_error
+        end
+      end
+
+      context 'when authentication fails' do
+        before do
+          ::Docker.stub(:authenticate!).and_raise(::Docker::Error::AuthenticationError)
+        end
+
+        it 'raieses an error' do
+          ENV.should_not_receive(:[])
+          expect { subject.authenticate! }.to raise_error
+        end
+      end
+    end
+  end
+end

data/spec/dockly/docker_spec.rb

@@ -173,9 +173,9 @@ describe Dockly::Docker do
             paths << entry.header.name
           end
           paths.size.should be > 1000
-          paths.should include('./sbin/init')
-          paths.should include('./lib/dockly.rb')
-          paths.should include('./it_worked')
+          paths.should include('sbin/init')
+          paths.should include('lib/dockly.rb')
+          paths.should include('it_worked')
         }.to change { ::Docker::Image.all(:all => true).length }.by(3)
       end
     end
@@ -191,6 +191,7 @@ describe Dockly::Docker do
           cleanup_images true
         end
       end
+
       it 'builds a docker image' do
         expect {
           subject.generate!
@@ -202,12 +203,33 @@ describe Dockly::Docker do
             paths << entry.header.name
           end
           paths.size.should be > 1000
-          paths.should include('./sbin/init')
-          paths.should include('./lib/dockly.rb')
-          paths.should include('./it_worked')
-        }.to change { ::Docker::Image.all(:all => true).length }.by(0)
+          paths.should include('sbin/init')
+          paths.should include('lib/dockly.rb')
+          paths.should include('it_worked')
+        }.to_not change { ::Docker::Image.all(:all => true).length }
+      end
+    end
+
+    context 'when there is a registry' do
+      subject {
+        Dockly::Docker.new do
+          import 'https://s3.amazonaws.com/swipely-pub/docker-export-ubuntu-latest.tgz'
+          git_archive '.'
+          build "run touch /it_worked"
+          repository 'dockly_test'
+          build_dir 'build/docker'
+
+          registry do
+            username 'nahiluhmot'
+            email 'tomhulihan@swipely.com'
+          end
+        end
+      }
+
+      it 'pushes the image to the registry instead of exporting it' do
+        subject.generate!
+        expect { ::Docker::Image.build('from nahiluhmot/dockly_test') }.to_not raise_error
       end
     end
   end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dockly
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -266,6 +266,7 @@ files:
 - lib/dockly/cli.rb
 - lib/dockly/deb.rb
 - lib/dockly/docker.rb
+- lib/dockly/docker/registry.rb
 - lib/dockly/foreman.rb
 - lib/dockly/rake_task.rb
 - lib/dockly/util/git.rb
@@ -279,6 +280,7 @@ files:
 - spec/dockly/build_cache/local_spec.rb
 - spec/dockly/cli_spec.rb
 - spec/dockly/deb_spec.rb
+- spec/dockly/docker/registry_spec.rb
 - spec/dockly/docker_spec.rb
 - spec/dockly/foreman_spec.rb
 - spec/dockly_spec.rb
@@ -323,6 +325,7 @@ test_files:
 - spec/dockly/build_cache/local_spec.rb
 - spec/dockly/cli_spec.rb
 - spec/dockly/deb_spec.rb
+- spec/dockly/docker/registry_spec.rb
 - spec/dockly/docker_spec.rb
 - spec/dockly/foreman_spec.rb
 - spec/dockly_spec.rb