sidedock 2.0.0.pre.beta1 → 2.0.0.pre.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '021845a2dc38661f8b5a7869e3a7602b36fd1cc3'
-  data.tar.gz: 7c93f4e8c3e97c89003cd4965a28388ce4ead82a
+  metadata.gz: 773d21903cb8ef30df471830bc42a5ecd7e37ee2
+  data.tar.gz: 4f716d782a3ca186190faccc4d36ea2aa41cb1b4
 SHA512:
-  metadata.gz: 1bd0f7b8e8148f11dab56bf0db2c558e8cce6dd4366e1fa44fe1a2c4a13db5ee3f61064f4a2ceaa5723b4766fd3e7fd5b3118f61c76f2e5a7823731029f9c7f0
-  data.tar.gz: 796aa3d93253a00a94cda04bc082a727ea9d8e4bddad26bd7cb1829a3df3016ac08f0a842dd486c2f12d2bfd316629df0ef89e6bbb537d35d7f55be840f39004
+  metadata.gz: 95735346161c7b6af544be9aac823467a8df1483e3b959f6d22d8a4b23539ceda62fb69376b226579f0c0d50337e31891cd5ac9c6983cb37323253d83a9e1008
+  data.tar.gz: 8a766c71866130d1ed196964782ba3fdc2e85dc0718a3c4e612ff70bdf2a3104b6e6a8c3a6e4f008c9bfd2d2c05b6f7b2d93fc7e025ff6a94768d8a4ddac584b

data/lib/sidedock/base.rb

@@ -1,11 +1,13 @@
 module Sidedock
   class Base
-    def machine
-      self.class.machine
+    def cli
+      self.class.cli
     end
 
-    def self.machine
-      @@machine ||= Machine.new 'sidedock'
+    def self.cli
+      args = '--debug' if Sidedock.configuration.debug
+      args ||= ''
+      @@cli ||= DockerCLI.new args
     end
   end
 end

data/lib/sidedock/cli/docker_cli.rb

@@ -1,5 +1,7 @@
 module Sidedock
   class DockerCLI < CLI
     self.program = 'docker'
+
+    command_wrapper :create
   end
 end

data/lib/sidedock/cli.rb

@@ -1,14 +1,16 @@
 require 'tty/command'
+require 'uber/inheritable_attr'
 
 module Sidedock
+  # Base class for command line utilities used by sidedock.
   class CLI
-    class_attribute :program
+    extend Uber::InheritableAttr
+    inheritable_attr :program # System command name
 
     def initialize(default_options = '')
       @default_options = default_options
     end
 
-
     def execute(command)
       full_command = "#{program} #{@default_options} #{command}"
       stdout, stderr = command_runner.run full_command
@@ -16,6 +18,25 @@ module Sidedock
       stdout.strip
     end
 
+    protected
+    # Create wrapper for a CLI command of the program.
+    # Mainly useful for testing purposes because you want to mock output of a given command
+    def self.command_wrapper(*commands)
+      commands.each do |command|
+        raise "#{command} cannot be used as command wrapper because method already exists for #{self}" if respond_to? command
+
+        define_method command do |args|
+          execute "#{command} #{args}"
+        end
+      end
+    end
+
+    private
+
+    def program
+      self.class.program
+    end
+
     def command_runner
       if Sidedock.configuration.debug
         debug_command_runner
@@ -34,4 +55,4 @@ module Sidedock
   end
 end
 
-%w( docker machine ).each { |file| require "sidedock/cli/#{file}_cli" }
+%w( docker ).each { |file| require "sidedock/cli/#{file}_cli" }

data/lib/sidedock/configuration.rb

@@ -7,7 +7,6 @@
 module Sidedock
   class << self
     attr_accessor :configuration
-
   end
 
   def self.configure

data/lib/sidedock/container.rb

@@ -9,22 +9,22 @@ module Sidedock
 
     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}"
+      id = cli.create "-P #{image_name_or_id}"
       new id, **options
     end
 
     def start
       raise "already started" if running?
-      machine.execute "start #{@id}"
+      cli.execute "start #{@id}"
     end
 
     def stop
       raise "not running" unless running?
-      machine.execute "stop #{@id}"
+      cli.execute "stop #{@id}"
     end
 
     def remove
-      machine.execute "rm -f #{@id}"
+      cli.execute "rm -f #{@id}"
     end
 
     def ports
@@ -32,19 +32,25 @@ module Sidedock
     end
 
     def running?
-      machine.execute('ps -q --no-trunc').include? @id
+      cli.execute('ps -q --no-trunc').include? @id
     end
 
-    def bash(command)
-      machine.execute "exec -t #{@id} bash -c '#{command}'"
+    def sh(command)
+      cli.execute "exec -t #{@id} bash -c '#{command}'"
     end
 
     def ip
-      machine.ip
+      cli.ip
+    end
+
+    def self.all
+      cli.execute('ps -q --no-trunc').split.map do |id|
+        new id
+      end
     end
 
     def self.using_image(image)
-      ps_output = machine.execute "ps -a -q --filter ancestor=#{image.id}"
+      ps_output = cli.execute "ps -a -q --filter ancestor=#{image.id}"
 
       ps_output.each_line.map do |id|
         new id

data/lib/sidedock/errors.rb

@@ -0,0 +1,32 @@
+module Sidedock
+  class Error < StandardError; end
+  class DockerfileNotFound < Error
+    def initialize(dockerfile)
+      @dockerfile = dockerfile
+    end
+
+    def message
+      "Expected Dockerfile to be defined in #{@dockerfile}"
+    end
+  end
+
+  class DirectoryNotFound < Error
+    def initialize(search_paths)
+      @search_paths = search_paths
+    end
+
+    def message
+      "Expected one of directories #{@search_paths} to exists"
+    end
+  end
+
+  class MethodInUse < Error
+    def initialize(klass, method)
+      @klass, @method = klass, method
+    end
+
+    def message
+      "Cannot define #{@klass}##{@method} because it is already implemented"
+    end
+  end
+end

data/lib/sidedock/image.rb

@@ -8,15 +8,15 @@ module Sidedock
 
     def remove
       remove_containers_using_it
-      machine.execute "rmi -f #{@id}"
+      cli.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}"
+    def self.build(dockerfile_path, dockerfile = 'Dockerfile')
+      built_id = cli.execute "build -q #{dockerfile_path} --file #{dockerfile}"
       new built_id
     end
   end

data/lib/sidedock/port_configuration.rb

@@ -9,5 +9,9 @@ module Sidedock
       @external = match[:external].to_i
       @protocol = match[:protocol]
     end
+
+    def to_h
+      { internal: @internal, external: @external, protocol: @protocol }
+    end
   end
 end

data/lib/sidedock/ports.rb

@@ -2,15 +2,15 @@ module Sidedock
   class Ports < Base
     include Enumerable
 
-    def initialize(machine_id, port_mapping)
+    def initialize(container_id, port_mapping)
       @port_mapping = port_mapping
-      @machine_id = machine_id
+      @container_id = container_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
+        raise MethodInUse.new(self.class) if respond_to? name
 
         port = find do |port|
           port.internal == port_number
@@ -37,7 +37,7 @@ module Sidedock
     end
 
     def raw_configuration_lines
-      @raw_configuration_lines ||= machine.execute("port #{@machine_id}").strip.split("\n")
+      @raw_configuration_lines ||= cli.execute("port #{@container_id}").strip.split("\n")
     end
   end
 end

data/lib/sidedock/service.rb

@@ -0,0 +1,68 @@
+require 'active_support/all'
+
+module Sidedock
+  class Service
+    attr_reader :container
+
+    delegate :sh, :ports, to: :container
+
+    def self.use(options = {})
+      options[:port_mapping] ||= {}
+      options[:port_mapping].merge! port_mapping
+
+      Sidedock.with_docker_image image.id, options do |container|
+        yield new(container)
+      end
+
+      remove_image unless options[:keep_image]
+    end
+
+    protected
+
+    def self.cli_method(*commands)
+      commands.each do |command|
+        raise MethodInUse.new self, command if method_defined? command
+
+        define_method command do |args|
+          container.sh "#{command} #{args}"
+        end
+      end
+    end
+
+    cattr_accessor :port_mapping
+    self.port_mapping = {}
+
+    def self.port(name, internal_port)
+      port_mapping[name] = internal_port
+    end
+
+    def self.dockerfile_path
+      "#{directory}/#{dockerfile}"
+    end
+
+    def self.dockerfile
+      'Dockerfile'
+    end
+
+    cattr_accessor :directory
+    def self.inherited(k)
+      k.directory = caller.first.match(/^([^:]+)\/.+\.rb/)[1]
+    end
+
+    def self.image
+      raise DockerfileNotFound.new(dockerfile_path) unless File.exist? dockerfile_path
+      @@image ||= Image.build directory, dockerfile_path
+    end
+
+    private
+
+    def initialize(container)
+      @container = container
+    end
+
+    def self.remove_image
+      image.remove
+      @@image = nil
+    end
+  end
+end

data/lib/sidedock.rb

@@ -1,4 +1,5 @@
-%w( configuration cli machine base image container ports port_configuration
+require 'active_support/core_ext/object/blank'
+%w( service configuration cli base image container ports port_configuration errors
 ).each { |file| require "sidedock/#{file}" }
 
 module Sidedock
@@ -8,32 +9,7 @@ module Sidedock
       container.start
       yield container
       container.stop
-      container.remove unless options[:keep_image]
-    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
+      container.remove
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidedock
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.beta1
+  version: 2.0.0.pre.beta2
 platform: ruby
 authors:
 - Tim Raasveld
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: uber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.15
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.15
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
@@ -48,21 +76,21 @@ files:
 - lib/sidedock/base.rb
 - lib/sidedock/cli.rb
 - lib/sidedock/cli/docker_cli.rb
-- lib/sidedock/cli/machine_cli.rb
 - lib/sidedock/configuration.rb
 - lib/sidedock/container.rb
+- lib/sidedock/errors.rb
 - lib/sidedock/image.rb
-- lib/sidedock/machine.rb
 - lib/sidedock/port_configuration.rb
 - lib/sidedock/ports.rb
+- lib/sidedock/service.rb
 homepage: https://github.com/timraasveld/sidedock
 licenses:
 - MIT
 metadata: {}
 post_install_message: |-
-  Make sure Docker is installed before installing sidedock.
+  Make sure Docker is installed before using sidedock.
   For example, try: brew cask install docker && open -a 'docker' (Mac)
-  apt-get install -y docker (Debian / Ubuntu)
+                    apt-get install -y docker (Debian / Ubuntu)
 rdoc_options: []
 require_paths:
 - lib

data/lib/sidedock/cli/machine_cli.rb

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

data/lib/sidedock/machine.rb

@@ -1,63 +0,0 @@
-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 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 running?
-      return true if @running
-      if docker_machine("ls -q --filter state=Running").include? @name
-        @running = true
-      end
-    end
-
-    def exists?
-      return true if @exists
-      if docker_machine("ls -q").include? @name
-        @exists = true
-      end
-    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