mcrain 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1c033a9e832b8d1e2e30052bef3528c766e349e
-  data.tar.gz: 4393f78f710d1d29ddff5df9629fb0db7ab9a1d8
+  metadata.gz: d07708c123940b6ae6e2fa57fd8aa76590439d36
+  data.tar.gz: b8ef280372ad693c31b52e8f62f38f7dba9cab80
 SHA512:
-  metadata.gz: 3ad8e53db4f4e784b50d7ad1175c9955e651e675d9ee2a645c524d3e348ddaf09f2095b7cbac312c4912c1d30c607078bd9c7e5a200ebb4823bc7ed328851f5c
-  data.tar.gz: 9dc9ebfbbff97677cf93d921c42e9af2b18da60ca84fda297501f229d05706a8c5e6590809529cd268b494ba83d2a15978a31eb4c05ea76b7eae0c51d50d5dda
+  metadata.gz: a26b6d8f4dab3aa1a0e6b087df9a3af12dc7a0b0690551e38aa06e6252b61524b59c0a8ddd515e88037683f26a317f5f3b9c7fb26e8eb83207cc7145eb113591
+  data.tar.gz: f67ce63e4b1d2dcc5d6f3020b56cda0a672bbfb946abeb977d60a12da59b94c9488cb12757c2df34aea4ec0714bc77c8d64de467880c2c190327cfadb0298b1c

data/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "spec/support/docker-riak"]
-	path = spec/support/docker-riak
-	url = git@github.com:hectcastro/docker-riak.git

data/README.md

@@ -3,9 +3,43 @@
 Mcrain helps you to use docker container in test cases.
 It supports redis, rabbitmq and riak (stand alone node or clustering) currently.
 
-## prerequisite
+## Prerequisite
+
+### With boot2docker
+
+- [install docker into Mac](https://docs.docker.com/installation/mac/)
+- [install docker into Windows](https://docs.docker.com/installation/windows/)
+
+
+### Without boot2docker
+
+The docker daemon must be started with tcp socket option like `-H tcp://0.0.0.0:2375`.
+Because mcrain uses [Docker Remote API](https://docs.docker.com/reference/api/docker_remote_api/).
+
+After [installing docker](https://docs.docker.com/installation/#installation),
+edit the configuration file `/etc/default/docker` for Debian or Ubuntu,
+or `/etc/sysconfig/docker` for CentOS. 
+
+And add tcp option to DOCKER_OPTS like this:
+
+```
+DOCKER_OPTS="-H unix:///var/run/docker.sock -H tcp://0.0.0.0:2375"
+```
+
+Then restart the docker daemon.
+
+
+Set `DOCKER_HOST` environment variable for mcrain.
+```
+export DOCKER_HOST='tcp://127.0.0.1:2375'
+```
+
+The port num must be equal to the port of tcp option in DOCKER_OPTS.
+
+See the following documents for more information:
+- https://docs.docker.com/reference/commandline/daemon/
+- https://docs.docker.com/articles/networking/
 
-- [docker](https://docs.docker.com/installation/#installation)
 
 ## Installation
 

data/exe/mcrain

@@ -4,8 +4,8 @@
 require "mcrain"
 
 action, service, *args  = *ARGV
+verbose = ARGV.include?('-V') || ARGV.include?('--verbose') 
 if action.nil? || service.nil?
-
   $stderr.puts(<<MESSAGE)
 #{$PROGRAM_NAME} <action> <target> [n] [-v or --verbose]
   action: start or stop
@@ -41,6 +41,7 @@ begin
   end
 rescue => e
   $stderr.puts "\e[31m[#{e.class}] #{e.message}\e[0m"
+  $stderr.puts e.backtrace.join("\n  ") if verbose
   exit(1)
 else
   $stderr.puts "\e[32mOK\e[0m"

data/lib/mcrain/base.rb

@@ -6,63 +6,33 @@ require 'timeout'
 require 'socket'
 
 require 'logger_pipe'
+require 'docker'
 
 module Mcrain
   class Base
+    include ContainerController
+    include ClientProvider
 
-    class << self
-      attr_writer :server_name
-      def server_name
-        @server_name ||= self.name.split(/::/).last.underscore.to_sym
-      end
-
-      attr_accessor :container_image, :port
+    def logger
+      Mcrain.logger
     end
 
-    attr_accessor :skip_reset_after_stop
+    attr_accessor :skip_reset_after_teardown
     def reset
       instance_variables.each do |var|
         instance_variable_set(var, nil)
       end
     end
 
-    def container_image
-      self.class.container_image or raise "No container_image for #{self.class.name}"
-    end
-
-    def container_name
-      "test-#{self.class.server_name}"
-    end
-
-    def host
-      @host ||= URI.parse(ENV["DOCKER_HOST"] || "tcp://localhost").host
-    end
-
-    def find_portno
-      # 未使用のポートをシステムに割り当てさせてすぐ閉じてそれを利用する
-      tmpserv = TCPServer.new(0)
-      portno = tmpserv.local_address.ip_port
-      tmpserv.close
-      portno
-    end
-
-    def port
-      @port ||= find_portno
-    end
-
-    def url
-      @url ||= "#{self.class.server_name}://#{host}:#{port}"
-    end
-
     def start
-      clear_old_container
-      run_container
+      setup
       if block_given?
         begin
+          wait_port
           wait
           return yield(self)
         ensure
-          stop
+          teardown
         end
       else
         wait
@@ -70,37 +40,22 @@ module Mcrain
       end
     end
 
-    def clear_old_container
-      LoggerPipe.run(logger, "docker rm #{container_name}", timeout: 10)
-    rescue => e
-      logger.warn("[#{e.class}] #{e.message}")
-    end
-
-    def run_container
-      LoggerPipe.run(logger, build_docker_command, timeout: 10)
-    end
-
-    def build_docker_command
-      "docker run #{build_docker_command_options} #{container_image}"
-    end
-
-    def build_docker_command_options
-      r = "-d -p #{port}:#{self.class.port} --name #{container_name}"
-      if ext = docker_extra_options
-        r << ext
+    def setup
+      Timeout.timeout(30) do
+        Boot2docker.setup_docker_options
+        container.start!
       end
-      r
+      return container
     end
 
-    def docker_extra_options
-      nil
+    # ポートがLISTENされるまで待つ
+    def wait_port
+      Mcrain.wait_port_opened(host, port, interval: 0.5, timeout: 30)
     end
 
+    # ポートはdockerがまずLISTENしておいて、その後コンテナ内のミドルウェアが起動するので、
+    # 実際にそのAPIを叩いてみて例外が起きないことを確認します。
     def wait
-      # ポートがLISTENされるまで待つ
-      Mcrain.wait_port_opened(host, port, interval: 0.5, timeout: 30)
-      # ポートはdockerがまずLISTENしておいて、その後コンテナ内のredisが起動するので、
-      # 実際にAPIを叩いてみて例外が起きないことを確認します。
       Timeout.timeout(30) do
         begin
           wait_for_ready
@@ -116,40 +71,18 @@ module Mcrain
       raise NotImplementedError
     end
 
-    def client
-      @client ||= build_client
-    end
-
-    def build_client
-      require client_require
-      yield if block_given?
-      client_class.new(*client_init_args)
-    end
-
-    def client_require
-      raise NotImplementedError
-    end
-
-    def client_class
-      raise NotImplementedError
+    def teardown
+      stop_or_kill_and_remove
+      reset unless skip_reset_after_teardown
     end
 
-    def client_init_args
-      raise NotImplementedError
-    end
-
-    def client_script
-      client
-      "#{client_class.name}.new(*#{client_init_args.inspect})"
-    end
-
-    def stop
-      LoggerPipe.run(logger, "docker kill #{container_name}", timeout: 10)
-      reset unless skip_reset_after_stop
-    end
-
-    def logger
-      Mcrain.logger
+    def stop_or_kill_and_remove
+      begin
+        container.stop!
+      rescue => e
+        container.kill!
+      end
+      container.remove
     end
 
   end

data/lib/mcrain/client_provider.rb

@@ -0,0 +1,32 @@
+module Mcrain
+  module ClientProvider
+
+    def client
+      @client ||= build_client
+    end
+
+    def build_client
+      require client_require
+      yield if block_given?
+      client_class.new(*client_init_args)
+    end
+
+    def client_require
+      raise NotImplementedError
+    end
+
+    def client_class
+      raise NotImplementedError
+    end
+
+    def client_init_args
+      raise NotImplementedError
+    end
+
+    def client_script
+      client
+      "#{client_class.name}.new(*#{client_init_args.inspect})"
+    end
+
+  end
+end

data/lib/mcrain/container_controller.rb

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+module Mcrain
+  module ContainerController
+
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      attr_writer :server_name
+      def server_name
+        @server_name ||= self.name.split(/::/).last.underscore.to_sym
+      end
+
+      attr_accessor :container_image, :port
+    end
+
+    # @return [Docker::Container]
+    def container
+      unless @container
+        options = build_docker_options
+        Mcrain.logger.info("#{self.class.name}#container Docker::Container.create(#{options.inspect})")
+        @container = Docker::Container.create(options)
+      end
+      @container
+    end
+
+    def container_image
+      self.class.container_image or raise "No container_image for #{self.class.name}"
+    end
+
+    def host
+      @host ||= URI.parse(ENV["DOCKER_HOST"] || "tcp://localhost").host
+    end
+
+    def find_portno
+      # 未使用のポートをシステムに割り当てさせてすぐ閉じてそれを利用する
+      tmpserv = TCPServer.new(0)
+      portno = tmpserv.local_address.ip_port
+      tmpserv.close
+      portno
+    end
+
+    def port
+      @port ||= find_portno
+    end
+
+    def url
+      @url ||= "#{self.class.server_name}://#{host}:#{port}"
+    end
+
+    def build_docker_options
+      {
+        'Image' => container_image,
+        'HostConfig' => {
+          'PortBindings' => {
+            "#{self.class.port}/tcp" => [{ 'HostPort' => port.to_s }]
+          }
+        }
+      }
+    end
+
+  end
+end

data/lib/mcrain/mysql.rb

@@ -37,17 +37,20 @@ module Mcrain
     attr_accessor :database
     attr_accessor :username, :password
 
-    def docker_extra_options
-      opts = ['']
+    def build_docker_options
+      r = super
+
       username = self.username || "root" # overwrite locally
       key_user = (username == "root") ? nil                   : "MYSQL_USER"
       key_pw   = (username == "root") ? "MYSQL_ROOT_PASSWORD" : "MYSQL_PASSWORD"
-
-      opts << (password.blank? ? "-e MYSQL_ALLOW_EMPTY_PASSWORD=yes" : "-e #{key_pw}=#{password}")
-      opts << (key_user ? "-e #{key_user}=#{username}" : nil)
-      opts << "-e MYSQL_DATABASE=#{database}" if database
-      opts << "-v #{File.expand_path(db_dir)}:/var/lib/mysql" if db_dir
-      opts.compact.join(' ')
+      envs = []
+      envs << (password.blank? ? "MYSQL_ALLOW_EMPTY_PASSWORD=yes" : "#{key_pw}=#{password}")
+      envs << "#{key_user}=#{username}"  if key_user
+      envs << "MYSQL_DATABASE=#{database}" if database
+      envs << "#{File.expand_path(db_dir)}:/var/lib/mysql" if db_dir
+      r['Env'] = envs unless envs.empty?
+      return r
     end
+
   end
 end

data/lib/mcrain/rabbitmq.rb

@@ -8,9 +8,12 @@ module Mcrain
     self.server_name = :rabbitmq
 
     self.container_image = "rabbitmq:3.4.4-management"
+    self.port = 15672
 
-    def build_docker_command_options
-      "-d -p #{runtime_port}:5672 -p #{port}:15672 --name #{container_name}"
+    def build_docker_options
+      r = super
+      r['HostConfig']['PortBindings']["5672/tcp"] = [{ 'HostPort' => runtime_port.to_s }]
+      return r
     end
 
     def runtime_port

data/lib/mcrain/redis.rb

@@ -28,8 +28,13 @@ module Mcrain
 
     attr_accessor :db_dir
 
-    def docker_extra_options
-      db_dir ? " -v #{File.expand_path(db_dir)}:/data" : nil
+    def build_docker_options
+      r = super
+      if db_dir
+        r['Volumes'] ||= {}
+        r['Volumes']["/data"] = File.expand_path(db_dir)
+      end
+      return r
     end
   end
 end

data/lib/mcrain/riak.rb

@@ -1,27 +1,84 @@
+# -*- coding: utf-8 -*-
 require 'mcrain'
 
 # require 'riak'
+require 'net/http'
 
 module Mcrain
   class Riak < Base
 
-    class << self
-      # path to clone of https://github.com/hectcastro/docker-riak
-      attr_accessor :docker_riak_path
+    self.server_name = :riak
+
+    self.container_image = "hectcastro/riak"
+
+    attr_accessor :automatic_clustering
+    attr_writer :cluster_size, :backend
+    def cluster_size
+      @cluster_size ||= 1
+    end
+    def backend
+      @backend ||= "bitcask" # "leveldb"
     end
 
-    self.server_name = :riak
+    # docker run -e "DOCKER_RIAK_CLUSTER_SIZE=${DOCKER_RIAK_CLUSTER_SIZE}" \
+    #            -e "DOCKER_RIAK_AUTOMATIC_CLUSTERING=${DOCKER_RIAK_AUTOMATIC_CLUSTERING}" \
+    #            -e "DOCKER_RIAK_BACKEND=${DOCKER_RIAK_BACKEND}" \
+    #            -p $publish_http_port \
+    #            -p $publish_pb_port \
+    #            --link "riak01:seed" \
+    #            --name "riak${index}" \
+    #            -d hectcastro/riak > /dev/null 2>&1
+    class Node
+      include ContainerController
+
+      self.container_image = "hectcastro/riak"
+
+      self.port = 8087 # protocol buffer
+      # self.http_port = 8098 # HTTP
+
+      attr_reader :owner
+      attr_accessor :primary_node
+      def initialize(owner)
+        @owner = owner
+      end
+
+      def http_port
+        @http_port ||= find_portno
+      end
 
-    self.container_image = nil # not use docker directly
-    self.port = 8087
+      def build_docker_options
+        r = super
+        r['HostConfig']['PortBindings']["8098/tcp"] = [{ 'HostPort' => http_port.to_s }]
+        envs = []
+        envs << "RIAK_CLUSTER_SIZE=#{owner.cluster_size}"
+        envs << "DOCKER_RIAK_AUTOMATIC_CLUSTERING=#{owner.automatic_clustering ? 1 : 0}"
+        envs << "DOCKER_RIAK_BACKEND=#{owner.backend}"
+        r['Env'] = envs unless envs.empty?
+        if primary_node
+          r['HostConfig']['Links'] = ["#{primary_node.container.name}:seed"]
+        end
+        return r
+      end
 
-    def wait
-      build_uris
-      super
+      def ping
+        owner.logger.debug("sending a ping http://#{host}:#{http_port}/stats")
+        res = Net::HTTP.start(host, http_port) {|http| http.get('/stats') }
+        r = res.is_a?(Net::HTTPSuccess)
+        owner.logger.debug("#{res.inspect} #=> #{r}")
+        return r
+      rescue => e
+        return false
+      end
     end
 
-    def build_client
-      super{ build_uris }
+    def nodes
+      unless @nodes
+        @nodes = (cluster_size || 1).times.map{ Node.new(self) }
+        array = @nodes.dup
+        primary_node = array.shift
+        array.each{|node| node.primary_node = primary_node}
+      end
+      @nodes
     end
 
     def client_class
@@ -29,53 +86,20 @@ module Mcrain
     end
 
     def client_init_args
-      options = {
-        nodes: uris.map{|uri| {host: uri.host, pb_port: uri.port} }
-      }
-      if uri = uris.first
-        if !uri.user.blank? or !uri.password.blank?
-          options[:authentication] = {user: uri.user, password: uri.password}
-        end
-      end
-      [options]
+      return [
+       {
+         nodes: nodes.map{|node| {host: node.host, pb_port: node.port} }
+       }
+      ]
     end
 
     def client_require
       'riak'
     end
 
-    def build_uris
-      # https://github.com/hectcastro/docker-riak/blob/develop/bin/test-cluster.sh#L9
-
-      # http://docs.docker.com/reference/api/docker_remote_api/
-      # https://github.com/boot2docker/boot2docker#ssh-into-vm
-      Boot2docker.setup_docker_options
-
-      uri = URI.parse(ENV["DOCKER_HOST"])
-      @host = (uri.scheme == "unix") ? "localhost" : uri.host
-      list = Docker::Container.all
-      riak_containers = list.select{|r| r.info['Image'] =~ /\Ahectcastro\/riak(\:.+)?\z/}
-      @cids = riak_containers.map(&:id)
-      @pb_ports = riak_containers.map do |r|
-        map = r.info['Ports'].each_with_object({}){|rr,d| d[ rr['PrivatePort'] ] = rr['PublicPort']}
-        map[8087]
-      end
-      @port = @pb_ports.first
-      @admin_uris = @cids.map do |cid|
-        r = Docker::Container.get(cid)
-        host = r.info["NetworkSettings"]["IPAddress"]
-        # login with insecure_key
-        # https://github.com/phusion/baseimage-docker#using-the-insecure-key-for-one-container-only
-        "ssh://root@#{host}:22"
-      end
-      @uris = @pb_ports.map do |port|
-        URI::Generic.build(scheme: "riak", host: @host, port: port)
-      end
-    end
-
     def wait_for_ready
       c = client
-      logger.debug("sending a ping")
+      logger.debug("sending a ping from client")
       begin
         r = c.ping
         raise "Ping failure with #{c.inspect}" unless r
@@ -105,54 +129,42 @@ module Mcrain
       end
     end
 
-    def clear_old_container
-    end
-
-    attr_reader :host, :cids, :pb_ports, :uris, :admin_uris
-    attr_accessor :automatic_clustering, :cluster_size
-
     def setup
-      w = @work_dir = Mcrain::Riak.docker_riak_path
-      raise "#{self.class.name}.docker_riak_path is blank. You have to set it to use the class" if w.blank?
-      raise "#{w}/Makefile not found" unless File.readable?(File.join(w, "Makefile"))
-      @prepare_cmd = Boot2docker.preparing_command
-      @automatic_clustering = false
-      @cluster_size = 1
-    end
-
-    def build_command
-      "DOCKER_RIAK_AUTOMATIC_CLUSTERING=#{automatic_clustering ? 1 : 0} DOCKER_RIAK_CLUSTER_SIZE=#{cluster_size} make start-cluster"
+      Boot2docker.setup_docker_options
+      nodes.map(&:container).each(&:start!)
+      # http://basho.co.jp/riak-quick-start-with-docker/
+      #
+      # "Please wait approximately 30 seconds for the cluster to stabilize"
+      #   from https://gist.github.com/agutow/11133143#file-docker3-sh-L12
+      sleep(30)
+      nodes.each do |node|
+        success = false
+        20.times do
+          success = node.ping
+          break if success
+          sleep(3)
+        end
+        raise "failed to run a riak server" unless success
+      end
     end
 
-    def run_container
-      setup
-      logger.debug("cd #{@work_dir.inspect}")
-      Dir.chdir(@work_dir) do
-        # http://basho.co.jp/riak-quick-start-with-docker/
-        #
-        # "Please wait approximately 30 seconds for the cluster to stabilize"
-        #   from https://gist.github.com/agutow/11133143#file-docker3-sh-L12
-        LoggerPipe.run(logger, "#{@prepare_cmd} #{build_command}")
-        sleep(1)
-        20.times do
-          begin
-            LoggerPipe.run(logger, "#{@prepare_cmd} make test-cluster")
-            sleep(5)
-            return
-          rescue
-            sleep(0.5)
-            retry
-          end
+    def teardown
+      nodes.map(&:container).each do |c|
+        begin
+          c.stop!
+        rescue => e
+          c.kill!
         end
-        raise "failed to run a riak server"
+        c.remove
       end
+      reset unless skip_reset_after_teardown
     end
 
-    def stop
-      Dir.chdir(@work_dir) do
-        LoggerPipe.run(logger, "#{@prepare_cmd} make stop-cluster")
+    # ポートがLISTENされるまで待つ
+    def wait_port
+      nodes.each do |node|
+        Mcrain.wait_port_opened(node.host, node.port, interval: 0.5, timeout: 30)
       end
-      reset unless skip_reset_after_stop
     end
 
   end

data/lib/mcrain/version.rb

@@ -1,3 +1,3 @@
 module Mcrain
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/lib/mcrain.rb

@@ -77,6 +77,8 @@ module Mcrain
 
   autoload :Base, 'mcrain/base'
   autoload :Boot2docker, 'mcrain/boot2docker'
+  autoload :ContainerController, 'mcrain/container_controller'
+  autoload :ClientProvider, 'mcrain/client_provider'
 
   autoload :Riak, 'mcrain/riak'
   autoload :Redis, 'mcrain/redis'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mcrain
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - akm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2015-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger_pipe
@@ -122,6 +122,8 @@ files:
 - lib/mcrain.rb
 - lib/mcrain/base.rb
 - lib/mcrain/boot2docker.rb
+- lib/mcrain/client_provider.rb
+- lib/mcrain/container_controller.rb
 - lib/mcrain/mysql.rb
 - lib/mcrain/rabbitmq.rb
 - lib/mcrain/redis.rb