sidedock 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59b6425b145656fef62e0ee9e5b0956685f45fda
-  data.tar.gz: 4a169cd4c4d91bb6b4c524f3da33e48264bd8d35
+  metadata.gz: 92788013f2d5b7639cfc7019d1a31ca8ae3530cf
+  data.tar.gz: e8a6675dac27fb06acca0fb3cd7e8815e62d1094
 SHA512:
-  metadata.gz: 42fa733a06553078161cec106ed47f46cee448284900fec04e396f9d4943390c184e2b8933aeae55692ca1998af30f21d9c53d7cf73960d781f26876bf301942
-  data.tar.gz: fc73b043294323a1e947aed92310f902b1bf7760c4567ef00dd2763d29eff6cad280e0fdd4f462dcdea2e9ae045dda3e88c293b052d762c48ebb17bcef9e37d3
+  metadata.gz: 928fd851e3813ca8548783e60ea911c85966541ddde878e3a5ef19ead5a2e4b91534f22e15877d6aaa8596142b866b3fa664c6ccaa47211ea5863fafe094b89b
+  data.tar.gz: 4f8ccc2cfe822ff9e7464ec1a04efa0f0b46232656d791fd8c02d8656f36dcb165d0e971d67adc9b912d49d1899d1b48e6e8207ce0b8d0b375d0b9c8382ad535

data/lib/sidedock/base.rb

@@ -0,0 +1,11 @@
+module Sidedock
+  class Base
+    def machine
+      self.class.machine
+    end
+
+    def self.machine
+      @@machine ||= Machine.new 'sidedock'
+    end
+  end
+end

data/lib/sidedock/cli/docker_cli.rb

@@ -0,0 +1,5 @@
+module Sidedock
+  class DockerCLI < CLI
+    self.program = 'docker'
+  end
+end

data/lib/sidedock/cli/machine_cli.rb

@@ -0,0 +1,5 @@
+module Sidedock
+  class MachineCLI < CLI
+    self.program = 'docker-machine'
+  end
+end

data/lib/sidedock/cli.rb

@@ -0,0 +1,21 @@
+require 'tty/command'
+
+module Sidedock
+  class CLI
+    class_attribute :program
+
+    def initialize(default_options = '')
+      @default_options = default_options
+      @cmd = TTY::Command.new
+    end
+
+    def execute(command)
+      full_command = "#{program} #{@default_options} #{command}"
+      stdout, stderr = @cmd.run full_command
+      raise "`#{command}` failed" if stderr.present?
+      stdout.strip
+    end
+  end
+end
+
+%w( docker machine ).each { |file| require "sidedock/cli/#{file}_cli" }

data/lib/sidedock/container.rb

@@ -0,0 +1,54 @@
+module Sidedock
+  class Container < Base
+    attr_accessor :ports, :id
+
+    def initialize(id, port_mapping: {})
+      @id = id
+      @port_mapping = port_mapping
+    end
+
+    def self.create(image_name_or_id, options)
+      raise "No image name given" unless image_name_or_id.present?
+      id = machine.execute "create -P #{image_name_or_id}"
+      new id, **options
+    end
+
+    def start
+      raise "already started" if running?
+      machine.execute "start #{@id}"
+    end
+
+    def stop
+      raise "not running" unless running?
+      machine.execute "stop #{@id}"
+    end
+
+    def remove
+      machine.execute "rm -f #{@id}"
+    end
+
+    def ports
+      Ports.new(@id, @port_mapping) if @port_mapping.present?
+    end
+
+    def running?
+      machine.execute('ps -q --no-trunc').include? @id
+    end
+
+    def bash(command)
+      machine.execute "exec -t #{@id} bash -c '#{command}'"
+    end
+
+    def ip
+      machine.ip
+    end
+
+    def self.using_image(image)
+      ps_output = machine.execute "ps -a -q --filter ancestor=#{image.id}"
+
+      ps_output.each_line.map do |id|
+        new id
+      end
+    end
+  end
+end

data/lib/sidedock/image.rb

@@ -0,0 +1,24 @@
+module Sidedock
+  class Image < Base
+    attr_accessor :id
+
+    def initialize(id)
+      @id = id
+    end
+
+    def remove
+      remove_containers_using_it
+      machine.execute "rmi -f #{@id}"
+    end
+
+    def remove_containers_using_it
+      Container.using_image(self).each(&:remove)
+    end
+
+    def self.build(dockerfile_path)
+      built_id = machine.execute "build -q #{dockerfile_path}"
+      Rails.logger.info "Built #{dockerfile_path}, image ID: #{built_id}"
+      new built_id
+    end
+  end
+end

data/lib/sidedock/machine.rb

@@ -0,0 +1,57 @@
+module Sidedock
+  class Machine
+    def initialize(name)
+      @name = name
+    end
+
+    def ensure_exists
+      create unless exists?
+      raise "Could not create docker machine #{@name}" unless exists?
+    end
+
+    def ensure_running
+      ensure_exists
+      start unless running?
+      raise "Could not start docker machine #{@name}" unless running?
+    end
+
+    def running?
+      docker_machine("ls -q --filter state=Running").include? @name
+    end
+
+    def start
+      docker_machine "start #{@name}"
+    end
+
+    def create
+      puts "Creating docker machine `#{@name}`. This may take a while."
+      docker_machine "create -d virtualbox #{@name}"
+    end
+
+    def exists?
+      docker_machine("ls -q").include? @name
+    end
+
+    def ip
+      docker_machine "ip #{@name}"
+    end
+
+    def execute(command)
+      ensure_running
+      cli.execute command
+    end
+
+    def docker_machine(command)
+      @machine_cli ||= MachineCLI.new
+      @machine_cli.execute command
+    end
+
+    def cli
+      @cli ||= DockerCLI.new options_to_let_docker_connect_to_it
+    end
+
+    def options_to_let_docker_connect_to_it
+      docker_machine("config #{@name}").gsub("\n", ' ')
+    end
+  end
+end

data/lib/sidedock/port_configuration.rb

@@ -0,0 +1,13 @@
+module Sidedock
+  class PortConfiguration < Base
+    attr_accessor :internal, :external, :protocol
+    CLI_FORMAT = /(?<internal>\d*)\/(?<protocol>tcp|udp) -> .*\:(?<external>\d*)/
+
+    def initialize(raw_configuration)
+      match = CLI_FORMAT.match raw_configuration
+      @internal = match[:internal].to_i
+      @external = match[:external].to_i
+      @protocol = match[:protocol]
+    end
+  end
+end

data/lib/sidedock/ports.rb

@@ -0,0 +1,43 @@
+module Sidedock
+  class Ports < Base
+    include Enumerable
+
+    def initialize(machine_id, port_mapping)
+      @port_mapping = port_mapping
+      @machine_id = machine_id
+      define_port_accessors if @port_mapping.present?
+    end
+
+    def define_port_accessors
+      @port_mapping.each do |name, port_number|
+        raise "#{name} cannot be used as port mapping key" if respond_to? :name
+
+        port = find do |port|
+          port.internal == port_number
+        end
+
+        raise "Port #{port_number} not exposed by Dockerfile, " \
+              "change or remove it in the `port_mapping` option. "\
+              "Available: #{each.to_h}" unless port.present?
+
+        define_singleton_method name do
+          port.external
+        end
+      end
+    end
+
+    def each(&block)
+      ports.each &block
+    end
+
+    def ports
+      @ports ||= raw_configuration_lines.map do |raw_configuration|
+        PortConfiguration.new raw_configuration
+      end
+    end
+
+    def raw_configuration_lines
+      @raw_configuration_lines ||= machine.execute("port #{@machine_id}").strip.split("\n")
+    end
+  end
+end

data/lib/sidedock.rb

@@ -0,0 +1,39 @@
+%w( cli machine base image container ports port_configuration
+).each { |file| require "sidedock/#{file}" }
+
+module Sidedock
+  class << self
+    def with_docker_image(image, options = {}, &block)
+      container = Sidedock::Container.create image, options
+      container.start
+      yield container
+      container.stop
+      container.remove
+    end
+
+    def with_dockerfile(name, options = {}, &block)
+      image = Sidedock::Image.build path_to_dockerfile(name)
+
+      with_docker_image image.id, options do |container|
+        yield container
+      end
+
+      image.remove
+    end
+
+    def path_to_dockerfile(name)
+      path = Rails.root.join base_directory, 'docker', name
+      raise "Dockerfile path `#{path}` not found" unless File.exist? path
+      path
+    end
+
+    def base_directory
+      case ENV['RAILS_ENV']
+      when 'test'
+        'spec'
+      else
+        'app'
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidedock
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Tim Raasveld
@@ -9,13 +9,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2016-06-23 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 description: Simplify working with Docker by running Dockerfiles from your Rails app
 email: ttimitri@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- lib/sidedock.rb
+- lib/sidedock/base.rb
+- lib/sidedock/cli.rb
+- lib/sidedock/cli/docker_cli.rb
+- lib/sidedock/cli/machine_cli.rb
+- lib/sidedock/container.rb
+- lib/sidedock/image.rb
+- lib/sidedock/machine.rb
+- lib/sidedock/port_configuration.rb
+- lib/sidedock/ports.rb
 homepage: https://github.com/timraasveld/sidedock
 licenses:
 - MIT