docker_helper 0.0.1

data/lib/docker_helper/proxy.rb

@@ -0,0 +1,57 @@
+#--
+###############################################################################
+#                                                                             #
+# docker_helper -- Helper methods to interact with Docker                     #
+#                                                                             #
+# Copyright (C) 2014 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@gmail.com>                                       #
+#                                                                             #
+# docker_helper is free software; you can redistribute it and/or modify it    #
+# under the terms of the GNU Affero General Public License as published by    #
+# the Free Software Foundation; either version 3 of the License, or (at your  #
+# option) any later version.                                                  #
+#                                                                             #
+# docker_helper is distributed in the hope that it will be useful, but        #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public      #
+# License for more details.                                                   #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with docker_helper. If not, see <http://www.gnu.org/licenses/>.       #
+#                                                                             #
+###############################################################################
+#++
+
+module DockerHelper
+
+  # Generic proxy class that allows to call prefixed methods with or without
+  # that prefix via #method_missing.
+
+  class Proxy
+
+    def initialize(prefix = 'docker')
+      self.proxy_prefix = prefix
+    end
+
+    attr_accessor :proxy_prefix
+
+    def method_missing(method, *args, &block)
+      respond_to_missing?(method) ?
+        send(prefix_method(method), *args, &block) : super
+    end
+
+    def respond_to_missing?(method, _ = false)
+      respond_to?(prefix_method(method))
+    end
+
+    private
+
+    def prefix_method(method)
+      "#{proxy_prefix}_#{method}"
+    end
+
+  end
+
+end

data/lib/docker_helper/version.rb

@@ -0,0 +1,27 @@
+module DockerHelper
+
+  module Version
+
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    class << self
+
+      # Returns array representation.
+      def to_a
+        [MAJOR, MINOR, TINY]
+      end
+
+      # Short-cut for version string.
+      def to_s
+        to_a.join('.')
+      end
+
+    end
+
+  end
+
+  VERSION = Version.to_s
+
+end

data/spec/docker_helper_spec.rb

@@ -0,0 +1,203 @@
+describe DockerHelper do
+
+  subject { Object.new.extend(described_class) }
+
+  describe '#version' do
+
+    it 'should return the client version' do
+      expect_pipe('Client version: 1.2.3', 'version', {})
+      expect(subject.docker_version).to eq('1.2.3')
+    end
+
+  end
+
+  describe '#tags' do
+
+    it 'should return the image tags' do
+      expect_pipe(<<-EOT, 'images', {})
+REPOSITORY                       TAG                 IMAGE ID            CREATED             VIRTUAL SIZE
+foo/bar                          baz                 123                 now                 0.0
+quix                             1.1                 456                 yesterday           0.0
+quix                             1.0                 789                 a week ago          0.0
+      EOT
+
+      expect(subject.docker_tags('quix')).to eq(%w[1.0 1.1])
+    end
+
+  end
+
+  describe '#build' do
+
+    it 'should build the image' do
+      expect_system(true, 'build', '-t', 'foo', 'bar', {})
+      expect(subject.docker_build('bar', 'foo')).to eq(true)
+    end
+
+  end
+
+  describe '#volume' do
+
+    it 'should return the volume path' do
+      expect_pipe('path', 'inspect', '-f', '{{index .Volumes "volume"}}', 'foo', {})
+      expect(subject.docker_volume('volume', 'foo')).to eq('path')
+    end
+
+  end
+
+  describe '#url' do
+
+    it 'should return the URL' do
+      expect_pipe('0.0.0.0:42', 'port', 'foo', '23', {})
+      expect(subject.docker_url(23, 'foo')).to eq('http://0.0.0.0:42')
+    end
+
+  end
+
+  describe '#start' do
+
+    it 'should start the container' do
+      expect_system(true, 'run', '-d', '-P', '--name', 'foo', 'bar', {})
+      expect(subject.docker_start('foo', 'bar')).to eq(true)
+    end
+
+  end
+
+  describe '#start!' do
+
+    describe 'when already running' do
+
+      before do
+        expect_system(true, 'stop', 'foo', err: :close)
+        expect_system(true, 'start', 'foo', {})
+      end
+
+      describe 'without a block' do
+
+        it 'should restart the container' do
+          expect(subject.docker_start!('foo', 'bar')).to eq(true)
+        end
+
+      end
+
+      describe 'with a block' do
+
+        it 'should ignore the block' do
+          expect { |b| subject.docker_start!('foo', 'bar', &b) }.not_to yield_control
+        end
+
+      end
+
+    end
+
+    describe 'when not running' do
+
+      before do
+        expect_system(false, 'stop', 'foo', err: :close)
+        expect_system(false, 'start', 'foo', {})
+        expect_system(true, 'run', '-d', '-P', '--name', 'foo', 'bar', {})
+      end
+
+      describe 'without a block' do
+
+        it 'should start the container' do
+          expect(subject.docker_start!('foo', 'bar')).to eq(true)
+        end
+
+      end
+
+      describe 'with a block' do
+
+        it 'should start the container and yield control' do
+          expect { |b| subject.docker_start!('foo', 'bar', &b) }.to yield_with_args('foo', 'bar')
+        end
+
+      end
+
+    end
+
+  end
+
+  describe '#stop' do
+
+    it 'should stop the container' do
+      expect_system(true, 'stop', 'foo', err: :close)
+      expect(subject.docker_stop('foo')).to eq(true)
+    end
+
+  end
+
+  describe '#restart' do
+
+    describe 'when already running' do
+
+      it 'should restart the container' do
+        expect_system(true, 'stop', 'foo', err: :close)
+        expect_system(true, 'start', 'foo', {})
+        expect(subject.docker_restart('foo')).to eq(true)
+      end
+
+    end
+
+    describe 'when not running' do
+
+      it 'should restart the container' do
+        expect_system(false, 'stop', 'foo', err: :close)
+        expect_system(true, 'start', 'foo', {})
+        expect(subject.docker_restart('foo')).to eq(true)
+      end
+
+    end
+
+  end
+
+  describe '#clean' do
+
+    it 'should remove the container' do
+      expect_system(true, 'stop', 'foo', err: :close)
+      expect_system(true, 'rm', '-v', '-f', 'foo', err: :close)
+      expect(subject.docker_clean('foo')).to eq(true)
+    end
+
+  end
+
+  describe '#clobber' do
+
+    it 'should remove the container and the image' do
+      expect_system(true, 'stop', 'foo', err: :close)
+      expect_system(true, 'rm', '-v', '-f', 'foo', err: :close)
+      expect_system(true, 'rmi', 'bar', err: :close)
+      expect(subject.docker_clobber('foo', 'bar')).to eq(true)
+    end
+
+  end
+
+  describe '#reset' do
+
+    it 'should reset the container' do
+      expect_system(true, 'stop', 'foo', err: :close)
+      expect_system(true, 'rm', '-v', '-f', 'foo', err: :close)
+      expect_system(true, 'run', '-d', '-P', '--name', 'foo', 'bar', {})
+      expect(subject.docker_reset('foo', 'bar')).to eq(true)
+    end
+
+  end
+
+end
+
+describe DockerHelper, '::proxy' do
+
+  subject { described_class.proxy }
+
+  before do
+    expect(subject).to receive(:docker_version).with(no_args).and_return('1.2.3')
+  end
+
+  it 'should respond to unabbreviated method' do
+    expect(subject.docker_version).to eq('1.2.3')
+  end
+
+  it 'should respond to abbreviated method' do
+    expect(subject.version).to eq('1.2.3')
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$:.unshift('lib') unless $:.first == 'lib'
+
+require 'docker_helper'
+
+RSpec.configure { |config|
+  config.mock_with(:rspec) { |c| c.verify_partial_doubles = true }
+
+  config.include(Module.new {
+    def expect_pipe(result, *args)
+      expect(subject).to receive(:docker_pipe).with('sudo', /\Adocker(?:\.io)?\z/, *args).and_return(result)
+      expect(subject).not_to receive(:docker_system)
+    end
+
+    def expect_system(result, *args)
+      expect(subject).to receive(:docker_system).with('sudo', /\Adocker(?:\.io)?\z/, *args).and_return(result)
+      expect(subject).not_to receive(:docker_pipe)
+    end
+  })
+}

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: docker_helper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jens Wille
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hen
+  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'
+- !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'
+description: Control the Docker command-line client from Ruby.
+email: jens.wille@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README
+- COPYING
+- ChangeLog
+files:
+- COPYING
+- ChangeLog
+- README
+- Rakefile
+- lib/docker_helper.rb
+- lib/docker_helper/proxy.rb
+- lib/docker_helper/version.rb
+- spec/docker_helper_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/blackwinter/docker_helper
+licenses:
+- AGPL-3.0
+metadata: {}
+post_install_message: |2+
+
+  docker_helper-0.0.1 [2014-08-05]:
+
+  * First release.
+
+rdoc_options:
+- "--title"
+- docker_helper Application documentation (v0.0.1)
+- "--charset"
+- UTF-8
+- "--line-numbers"
+- "--all"
+- "--main"
+- README
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Helper methods to interact with Docker.
+test_files: []