sshkit-backend-docker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77ced5c48d6681caf49f45a90b2318c9c15429d2
+  data.tar.gz: 6f905759e8df50cfed6717080e0778bea612aaf9
+SHA512:
+  metadata.gz: 0f809f383355a4623b37903160b4e8e6e979f0d43cd9e3676a8e70ffddbbe143f4e635f7d67fda0032d82cae6d328b4b463b940ddf232c9368c687ee9504cf92
+  data.tar.gz: 6840d0e8e3e07d526a2f214d70b2662fbc9ad935141b0965ffec3923e7b60a07949f878868f37562708a1052d268ecb030d39b883ba5883adf36b772841ac81f

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Tatsuki Sugiura
+
+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,85 @@
+# SSHKit::Backend::Docker
+
+Docker connector backend for SSHKit.
+You can execute commands inside docker container without ssh connection.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sshkit-backend-docker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sshkit-backend-docker
+
+## Usage
+
+**If you use capistrano, please refer [capistrano-deploy_into_docker](https://github.com/sugi/capistrano-deploy_into_docker).**
+
+Currently, you need to set `SSHKit.config.backend` to run command with docker backend.
+
+```ruby
+SSHKit.config.backend = SSHKit::Backend::Docker
+```
+
+### Host definitions
+
+`SSHKit::Backend::Docker` extends `SSHKit::Host`.
+You can specify docker environemnt as Hash. The hash requires `:image` (or :container) key to run.
+
+```ruby
+host = SSHKit::Host.new(docker: {image: 'ruby:slim'})
+```
+
+In addtion, you can add any options for "docker run" via docker_run_image. for example;
+
+```ruby
+host = SSHKit::Host.new(docker: {
+    image: 'sugi/rails-base:latest',
+    commit: 'new-image-name:tag',
+    volume: ['/storage/tmp:/tmp', '/storage/home:/home'],
+    network: 'my-net',
+    dns: '8.8.8.8',
+    dns_search: 'example.com',
+    cap_add: ['SYS_NICE', 'SYS_RESOURCE'],
+  }, user: 'nobody:nogroup')
+```
+
+### DSL
+
+* `docker_commit` - Commit running container as image. In default `:commit` key of host will be used. You can pass argument to override. Currently this DSL method can commit container *which is ran by SSHKit::Backend::Docker from image*.
+* `docker_run_image` - In useal case, Docker container will start automatically when execute command. However you can run any image intentionally by `docker_run_iamge`.
+
+### Examples
+
+```ruby
+require 'sshkit'
+require 'sshkit-backend-docker'
+include SSHKit::DSL
+
+SSHKit.config.backend = SSHKit::Backend::Docker
+
+host = {docker: {image: 'ruby:slim'}}
+
+on [host] do
+   execute :ls
+   upload! '/etc/passwd', '/etc/passwd'
+   docker_commit 'my-new-image'
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sugi/sshkit-backend-docker.
+
+## Copyright
+
+2016 Tatsuki Sugiura, this library is distributed [MIT License](https://opensource.org/licenses/MIT).
+

data/lib/sshkit/backend/docker/version.rb

@@ -0,0 +1,7 @@
+module Sshkit
+  module Backend
+    module Docker
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/sshkit/backend/docker.rb

@@ -0,0 +1,281 @@
+require 'open3'
+require 'fileutils'
+require 'json'
+require 'sshkit'
+require 'sshkit/backend/docker/version'
+require 'sshkit/docker_host_ext'
+
+module SSHKit
+  module Backend
+    class Docker < Abstract
+      class Configuration
+        attr_accessor :pty, :use_sudo
+      end
+
+      CONTAINER_MAP = {}
+      CONTAINER_WAIT_IO = {}
+      attr_accessor :docker_open_stdin
+
+      def self.host_container_map_key(host)
+        key = host.docker_options.dup || {}
+        key.delete :container
+        key.delete :commit
+        key
+      end
+
+      def self.find_cntainer_by_host(host)
+        host.docker_options[:container] ||
+          CONTAINER_MAP[host_container_map_key(host)]
+      end
+
+      def initialize(host, &block)
+        super
+        @container = nil
+      end
+
+      def container
+        @container and return @container
+        if host.docker_options[:container]
+          @container = host.docker_options[:container]
+        else
+          @container = docker_run_image
+          host.hostname.chop! << ", container: #{@container})"
+        end
+        @container
+      end
+
+      def upload!(local, remote, _options = {})
+        local_io = local
+        local_io.is_a?(String) and
+          local_io = File.open(local_io, 'rb')
+        @docker_open_stdin = true
+
+        with_pty(false) do
+          IO.popen(to_docker_cmd('sh', '-c', "cat > '#{remote}'"), 'wb') do |f|
+            IO.copy_stream(local_io, f)
+          end
+        end
+
+        @docker_open_stdin = false
+        local.is_a?(String) and
+          local_io.close
+      end
+
+      def download!(remote, local=nil, _options = {})
+        local_io = local
+        local_io.nil? and
+          local_io = File.basename(remote)
+        local_io.is_a?(String) and
+          local_io = File.open(local_io, 'wb')
+
+        with_pty(false) do
+          IO.popen(to_docker_cmd('cat', remote), 'rb') do |f|
+            IO.copy_stream(f, local_io)
+          end
+        end
+
+        local.nil? || local.is_a?(String) and
+          local_io.close
+      end
+
+      def merged_env
+        menv = (SSHKit.config.default_env || {}).dup.symbolize_keys
+        [*host.docker_options[:env_file]].each do |ef|
+          File.foreach(ef) do |line|
+            line.include? "=" or next
+            key, val = line.chomp.split('=', 2)
+            menv[key.strip.to_sym] = val.strip
+          end
+        end
+        if host.docker_options[:env].is_a?(Hash)
+          host.docker_options[:env].each do |key, val|
+            menv[key.to_sym] = val
+          end
+        else
+          [*host.docker_options[:env]].each do |e|
+            key, val = e.split('=', 2)
+            menv[key.strip.to_sym] = val.strip
+          end
+        end
+        if menv[:rails_env]
+          menv[:RAILS_ENV] = menv.delete(:rails_env)
+        end
+        menv
+      end
+
+      def docker_run_image(host = nil)
+        host ||= self.host
+
+        if host.is_a?(String)
+          image_name = host
+          host = _deep_dup(self.host)
+          host.docker_options[:image] = image_name
+        elsif host.is_a?(Hash)
+          d_opts = host
+          host = _deep_dup(self.host)
+          host.docker_options = d_opts.symbolize_keys
+        end
+
+        map_key = self.class.host_container_map_key(host)
+        CONTAINER_MAP[map_key] and
+          return CONTAINER_MAP[map_key]
+
+        image_name = host.docker_options[:image]
+        cmd = %w(docker run -i)
+        host.docker_options.each do |key, val|
+          %w(container image env env_file commit).member?(key.to_s) and next
+          if %w(t tty h hostname attach d detach entrypoint rm).member?(key.to_s)
+            output.warn "Docker: run option '#{key}' is filtered."
+            next
+          end
+          [*val].each do |v|
+            cmd << "--#{key.to_s.tr('_', '-')}" << v
+          end
+        end
+        merged_env.each do |key, val|
+          cmd << "-e" << "#{key}=#{val}"
+        end
+        cmd += [image_name, 'sh', '-c', "# SSHkit \n hostname; read _"]
+        cmd.unshift('sudo') if Docker.config.use_sudo
+        io = IO.popen cmd, 'r+b'
+        cid = io.gets
+        if cid.nil?
+          output.fatal "Docker: Failed to run image #{image_name}"
+          raise "Failed to get container ID! (cmd: #{cmd.inspect})"
+        end
+        at_exit { io.close }
+        CONTAINER_WAIT_IO[map_key] = io
+        CONTAINER_MAP[map_key] = cid.strip
+        output.info "Docker: run new container #{CONTAINER_MAP[map_key]} from image #{image_name}"
+        CONTAINER_MAP[map_key]
+      end
+
+      def docker_commit(host = nil)
+        host ||= self.host
+
+        if host.is_a?(String)
+          commit_id = host
+          host = _deep_dup(self.host)
+          host.docker_options[:commit] = commit_id
+        elsif host.is_a?(Hash)
+          commit_info = host
+          host = _deep_dup(self.host)
+          host.docker_options[:commit] ||= {}
+          host.docker_options[:commit].update commit_info.symbolize_keys
+        end
+
+        host.docker_options[:commit] or return
+
+        container = self.class.find_cntainer_by_host(host) or
+          raise "Cannot find container for host #{host.inspect}"
+
+        cmd = %w(docker commit)
+
+        if host.docker_options[:image]
+          # if container is delivered from image, recover USER and CMD.
+          image_config = {}
+          IO.popen ['docker', 'inspect', '-f', '{{json .Config}}', host.docker_options[:image]], 'rb' do |f|
+            image_config = JSON.parse(f.read.chomp)
+          end
+
+          if image_config["User"].to_s.length > 1
+            cmd << '-c' << "USER #{image_config["User"]}"
+          end
+
+          c = image_config["Cmd"]
+          if c[0] == "/bin/sh" && c[1] == "-c"
+            c.shift; c.shift;
+          end
+          unless c.empty?
+            cmd << '-c' << "CMD #{c.join(' ')}"
+          end
+        end
+
+        image_name = host.docker_options[:commit]
+        if image_name.is_a?(Hash)
+          image_name.symbolize_keys.each do |key, val|
+            if key == :name
+              image_name = val
+            else
+              [*val].each do |v|
+                cmd << "--#{key.to_s.tr('_', '-')}" << v
+              end
+            end
+          end
+        end
+        cmd << container
+        image_name == true or
+          cmd << image_name
+
+        image_hash = nil
+        pid = nil
+        IO.popen cmd, 'rb' do |f|
+          pid = f.pid
+          image_hash = f.gets
+        end
+        image_hash.nil? and
+          output.error "Docker: Failed to get image hash. Commit may be failed!"
+        image_hash.chomp!
+        ret = image_name == true ? image_hash : image_name
+        output.info "Docker: commit #{container} as #{ret}"
+        ret
+      end
+
+      def to_docker_cmd(*args)
+        cmd = %w(docker exec)
+        cmd << '-it' if Docker.config.pty
+        cmd << '-i' if docker_open_stdin
+        cmd << '-u' << host.username
+        cmd << container
+        cmd += args
+        cmd.unshift('sudo') if Docker.config.use_sudo
+        cmd
+      end
+
+      private
+      def with_pty(flag)
+        orig = Docker.config.pty
+        Docker.config.pty = flag
+        begin
+          yield
+        ensure
+           Docker.config.pty = orig
+        end
+      end
+
+      def execute_command(cmd)
+        output.log_command_start(cmd)
+
+        cmd.started = Time.now
+
+        Open3.popen3(*to_docker_cmd('sh', '-c', cmd.to_command)) do |stdin, stdout, stderr, wait_thr|
+          stdout_thread = Thread.new do
+            while (line = stdout.gets) do
+              cmd.on_stdout(stdin, line)
+              output.log_command_data(cmd, :stdout, line)
+            end
+          end
+
+          stderr_thread = Thread.new do
+            while (line = stderr.gets) do
+              cmd.on_stderr(stdin, line)
+              output.log_command_data(cmd, :stderr, line)
+            end
+          end
+
+          stdout_thread.join
+          stderr_thread.join
+
+          cmd.exit_status = wait_thr.value.to_i
+
+          output.log_command_exit(cmd)
+        end
+      end
+
+      def _deep_dup(obj)
+        Marshal.load Marshal.dump(obj)
+      end
+
+    end
+  end
+end

data/lib/sshkit/docker_host_ext.rb

@@ -0,0 +1,27 @@
+require 'sshkit'
+module SSHKit
+  class Host
+    attr_writer :docker_options
+
+    def docker?
+      !docker_options.empty?
+    end
+
+    def docker_options
+      @docker_options ||= {}
+    end
+
+    def docker=(hash)
+      @hostname = "(docker "
+      @user ||= 'root'
+      docker_options.update hash.symbolize_keys
+      if docker_options.has_key?(:image)
+        @hostname << "image: #{@docker_options[:image]})"
+      elsif @docker_options.has_key?(:container)
+        @hostname << "container: #{@docker_options[:container]})"
+      else
+        raise ArgumentError, "Please specify image or container for docker! (ex; docker: {image: 'ruby:2.2'})"
+      end
+    end
+  end
+end

data/lib/sshkit-backend-docker.rb

@@ -0,0 +1 @@
+require 'sshkit/backend/docker'

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: sshkit-backend-docker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tatsuki Sugiura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: minitest-reporters
+  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: sshkit-backend-docker provides Docker connection and some utilities.
+  You can execute commands inside docker container without ssh connection.
+email:
+- sugi@nemui.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/sshkit-backend-docker.rb
+- lib/sshkit/backend/docker.rb
+- lib/sshkit/backend/docker/version.rb
+- lib/sshkit/docker_host_ext.rb
+homepage: http://github.com/sugi/sshki-backend-docker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Docker connector backend for SSHKit
+test_files: []