docka 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbe6126d8816f1560b7b336ccfe6867e34bf8371
+  data.tar.gz: e21f76ed8acefbfc780c63b6d2f85678932248fd
+SHA512:
+  metadata.gz: 7f38f8cfafe6f6296a97980513462de9199492619979a59b788560a41c8d2d776345074cd57b0eee664fecb898f91a48c32415aa9a316a3183fd351d3a97726c
+  data.tar.gz: 3f36f606c7265fc4cdb566ae654f47404ee86db99d62bd9edebf4fe2849d989ab33bdf41554b83a964b88eabfbf9e69c5ceaad3a554e00611f2323b46dc815b6

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in docka.gemspec
+gemspec

data/README.md

@@ -0,0 +1,66 @@
+# Docka
+
+Docka は Docker ベースのアプリケーションをデプロイするためのフレームワークです。
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'docka'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install docka
+
+## Requirements
+
+* Mac OS X (Yosemite 以降)
+* Docker Toolbox (最新版)
+* VirtualBox (docker-machine 互換のバージョン)
+
+## Synopsis
+
+Docker ベースの開発では少なくとも何十ものイメージやコンテナの作成や起動が必要です。小さな Web アプリケーションでもイメージやコンテナのプロビジョニングとそのテストだけですぐに時間が経ってしまいます。
+
+Docker Toolbox はよいものですが、まだ何度も同じ手順を手作業で繰り返さなければならないことに気づきました。
+
+Docka は Docker Toolbox を使った開発を気軽に自動化するための API と CLI ツールのパッケージです。
+
+## Features
+
+### アプリケーションごとの NFS ディレクトリ
+
+アプリケーションごとに NFS の共有ディレクトリを自動で設定します。
+
+```bash
+# /etc/exports の例
+/Users/mosop/my-app/docka/sync -mapall=501:20 192.168.99.105
+/Users/mosop/my-another-app/docka/sync -mapall=501:20 192.168.99.105
+```
+
+Docker ホスト側のディレクトリは `/docka/sync` です。コンテナからボリュームとしてアクセスできます。
+
+## [WIP] Usage
+
+## [WIP] Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Todos
+
+* テストを書く
+* テスト/プロダクション環境のサポート (CI, AWS, etc...)
+* Docker イメージのプロビジョニングのサポート
+* セットアップ用のジェネレータ
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mosop/docka.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "docka"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docka.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docka/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "docka"
+  spec.version       = Docka::VERSION
+  spec.authors       = ["mosop"]
+  spec.email         = ["mosop@a.b.com"]
+
+  spec.summary       = %q{A dockerized application deployment framework.}
+  spec.homepage      = "https://github.com/mosop/docka"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor", "~> 0.19.0"
+  spec.add_dependency "activesupport", "~> 4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

data/exe/docka

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'docka'
+Docka::Commands::Docka.start(ARGV)

data/lib/docka.rb

@@ -0,0 +1,28 @@
+require "docka/version"
+require "active_support/core_ext/array/extract_options"
+require "active_support/core_ext/string/inflections"
+autoload :FileUtils, 'fileutils'
+autoload :Logger, 'logger'
+autoload :Open3, 'open3'
+autoload :SecureRandom, 'securerandom'
+autoload :Thor, 'thor'
+
+module Docka
+  autoload :App, 'docka/app'
+  autoload :AppConfig, 'docka/app_config'
+  autoload :Cli, 'docka/cli'
+  autoload :Command, 'docka/command'
+  autoload :Commands, 'docka/commands'
+  autoload :Config, 'docka/config'
+  autoload :Loggers, 'docka/loggers'
+  autoload :LogFormatters, 'docka/log_formatters'
+  autoload :Machine, 'docka/machine'
+  autoload :MachineDrivers, 'docka/machine_drivers'
+  autoload :NotConfiguredError, 'docka/not_configured_error'
+  autoload :ShellError, 'docka/shell_error'
+  autoload :Util, 'docka/util'
+
+  def self.dir
+    __dir__
+  end
+end

data/lib/docka/app.rb

@@ -0,0 +1,125 @@
+module Docka
+  class App
+    def self.instance
+      @@instance ||= self.new
+    end
+
+    def env
+      @env ||= ::ENV['DOCKA_ENV'] || 'development'
+    end
+
+    def dir
+      @dir ||= Dir.pwd
+    end
+
+    def dot_dir
+      @dot_dir ||= begin
+        dir = "#{self.dir}/.docka"
+        ::FileUtils.mkdir_p dir
+        dir
+      end
+    end
+
+    def sync_dir
+      @sync_dir ||= begin
+        dir = "#{self.dir}/docka/sync"
+        ::FileUtils.mkdir_p dir
+        dir
+      end
+    end
+
+    def log_dir
+      @log_dir ||= begin
+        dir = "#{self.dir}/docka/log"
+        ::FileUtils.mkdir_p dir
+        dir
+      end
+    end
+
+    def uuid_file
+      @uuid_file ||= "#{dot_dir}/uuid"
+    end
+
+    def uuid
+      @uuid ||= begin
+        if ::File.exist?(uuid_file)
+          ::File.read(uuid_file).strip
+        else
+          uuid = SecureRandom.uuid
+          ::File.write uuid_file, uuid
+          uuid
+        end
+      end
+    end
+
+    def config
+      @config ||= AppConfig.new(dir + '/docka.yml', env)
+    end
+
+    def logger
+      @logger ||= begin
+        multi = Util::MultiLogger.new
+        multi.loggers << ::Logger.new("#{log_dir}/#{env}.log").tap do |l|
+          l.level = %w[development test].include?(env) ? ::Logger::DEBUG : ::Logger::INFO
+          l.formatter = ::Proc.new do |severity, time, progname, msg|
+            msg.split(/\n/).map{|i| "%-6s %s" % ["#{severity}:", "#{i}"]}.join("\n") + "\n"
+          end
+        end
+        multi
+      end
+    end
+
+    def shell(command, options = {})
+      status = ::Open3.popen3(command) do |i, o, e, t|
+        i.write options[:in] if options[:in]
+        i.close
+        ios = {}
+        ios[:debug] = o if options[:debug]
+        ios[:error] = e
+        ios.each do |key, io|
+          ::Thread.new do
+            while l = io.gets
+              logger.__send__ key, l.chomp
+            end
+          end
+        end
+        t.value
+      end
+      raise ::Docka::ShellError.new(command) if options[:raise] && !status.success?
+      status
+    end
+
+    def shell!(command, options = {})
+      opts = {}
+      opts[:stdin_data] = options[:in] if options[:in]
+      o, e, s = ::Open3.capture3(command, opts)
+      logger.debug o.chomp if options[:debug] && o.size > 0
+      logger.error e.chomp if e.size > 0
+      raise ::Docka::ShellError.new(command) if options[:raise] && !s.success?
+      [o, e, s]
+    end
+
+    def machine
+      @machine ||= Machine.new(self)
+    end
+
+    def setup
+      machine.create
+    end
+
+    def setup_sync
+      text = ::File.exist?('/etc/exports') ? ::File.read('/etc/exports') : ''
+      text.gsub! /# Docka #{uuid}\n.+(\n|$)/, ''
+      a = []
+      a << text if text.size > 0
+      a << "# Docka #{uuid}"
+      a << sync_entry
+      shell! %( cat | sudo tee /etc/exports ), raise: true, in: "#{a.join("\n")}\n"
+      shell! %( sudo nfsd update ), raise: true
+    end
+
+    def sync_entry
+      @sync_entry ||= "#{sync_dir} -mapall=#{::Process.uid}:#{::Process.gid} #{machine.ip}"
+    end
+  end
+end

data/lib/docka/app_config.rb

@@ -0,0 +1,4 @@
+module Docka
+  class AppConfig < Config
+  end
+end

data/lib/docka/cli.rb

@@ -0,0 +1,20 @@
+module Docka
+  class Cli < ::Thor
+    def self.command(name)
+      klass = self
+      pascal = name.to_s.camelize
+      autoload pascal, "#{self.name.underscore}/#{name}" unless autoload?(pascal)
+      define_method name do |*args|
+        begin
+          "#{klass.name}::#{pascal}".constantize.new(self, *args).run
+        rescue => ex
+          a = []
+          a << "#{ex.backtrace[0]}: #{ex.message.strip} (#{ex.class.name})"
+          a << ex.backtrace[1..-1].map{|i| "  from #{i}"}.join("\n") if ex.backtrace.size >= 2
+          ::Docka::App.instance.logger.fatal a.join("\n")
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/docka/command.rb

@@ -0,0 +1,24 @@
+module Docka
+  class Command
+    def initialize(cli, *args)
+      @cli = cli
+      @args = args
+      set_logger
+    end
+
+    private def set_logger
+      ::Docka::App.instance.logger.loggers << ::Logger.new($stderr).tap do |l|
+        l.level = ::Logger::INFO
+        l.formatter = ::Proc.new do |severity, time, progname, msg|
+          "#{msg}\n"
+        end
+      end
+    end
+
+    attr_reader :cli, :args
+
+    def options
+      cli.options
+    end
+  end
+end

data/lib/docka/commands.rb

@@ -0,0 +1,5 @@
+module Docka
+  module Commands
+    autoload :Docka, 'docka/commands/docka'
+  end
+end

data/lib/docka/commands/docka.rb

@@ -0,0 +1,6 @@
+module Docka::Commands
+  class Docka < ::Docka::Cli
+    desc "setup", "setup!"
+    command :setup
+  end
+end

data/lib/docka/commands/docka/setup.rb

@@ -0,0 +1,7 @@
+class Docka::Commands::Docka
+  class Setup < ::Docka::Command
+    def run
+      ::Docka::App.instance.setup
+    end
+  end
+end

data/lib/docka/config.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+require 'erb'
+
+module Docka
+  class Config
+    def initialize(path, env)
+      @path = path
+      @env = env
+    end
+
+    def util
+      @util ||= Util::Config.new(data, [@env])
+    end
+
+    def data
+      @data ||= ::YAML.load(::ERB.new(::File.read(@path)).result)
+    end
+
+    def get(*args, &block)
+      util.get *args, &block
+    end
+  end
+end

data/lib/docka/machine.rb

@@ -0,0 +1,84 @@
+module Docka
+  class Machine
+    def initialize(app)
+      @app = app
+    end
+
+    def name
+      @name ||= @app.config.get(:machine, :name, optional: false)
+    end
+
+    def driver
+      @driver ||= @app.config.get(:machine, :driver) || 'virtualbox'
+    end
+
+    def ip
+      @ip ||= @app.shell!(%( docker-machine ip #{name} ), raise: true).first.strip
+    end
+
+    def exists?
+      @app.shell!(%( docker-machine ls -q ), raise: true).first.split(/\n/).include?(name)
+    end
+
+    def create
+      @app.logger.info "creating machine..."
+
+      if exists?
+        @app.logger.info "machine already exists."
+      else
+        @app.shell(%( docker-machine create --driver #{driver} #{no_share_option} #{name} ), raise: true, debug: true)
+        @app.logger.info "machine created."
+      end
+
+      setup_sync
+    end
+
+    def setup_sync
+      @app.setup_sync
+      create_sync_dir
+      remount_sync
+    end
+
+    def create_sync_dir
+      unless @app.shell!(%( docker-machine ssh #{name} 'if [ -d /docka/sync ]; then echo 1; fi' ), raise: true).first.strip == '1'
+        @app.shell!(%( docker-machine ssh #{name} sudo mkdir -p /docka/sync ), raise: true)
+      end
+    end
+
+    def remount_sync
+      @app.logger.info "(re)mounting synced directory..."
+      unmount_sync if sync_mounted?
+      mount_sync
+      @app.logger.info "synced directory (re)mounted."
+    end
+
+    def unmount_sync
+      @app.shell! %( docker-machine ssh #{name} 'sudo umount /docka/sync' ), raise: true, debug: true
+    end
+
+    def mount_sync
+      @app.shell! %( docker-machine ssh #{name} 'sudo /usr/local/etc/init.d/nfs-client start' ), raise: true, debug: true
+      @app.shell! %( docker-machine ssh #{name} 'sudo mount -t nfs -o noacl,async "#{sync_mount_resource}" /docka/sync' ), raise: true, debug: true
+    end
+
+    def sync_mounted?
+      @app.shell!(%( docker-machine ssh #{name} 'cat /proc/mounts | cut -d " " -f2' ), raise: true).first.split("\n").include?('/docka/sync')
+    end
+
+    def sync_mount_resource
+      @sync_mount_resource ||= "#{host_ip}:#{@app.sync_dir}"
+    end
+
+    def method_missing(name, *args, &block)
+      if %i[host_ip no_share_option].include?(name)
+        extend_driver
+        return __send__ name, *args, &block
+      end
+      super
+    end
+
+    def extend_driver
+      extend "Docka::MachineDrivers::#{driver.camelize}".constantize
+    end
+  end
+end

data/lib/docka/machine_drivers.rb

@@ -0,0 +1,5 @@
+module Docka
+  module MachineDrivers
+    autoload :Virtualbox, 'docka/machine_drivers/virtualbox'
+  end
+end

data/lib/docka/machine_drivers/virtualbox.rb

@@ -0,0 +1,14 @@
+module Docka::MachineDrivers
+  module Virtualbox
+    def host_ip
+      @host_ip ||= begin
+        network = @app.shell!(%( VBoxManage showvminfo #{name} --machinereadable | grep hostonlyadapter | cut -d '"' -f2 ), raise: true).first.strip
+        @app.shell!(%( VBoxManage list hostonlyifs | grep '^Name:.*#{network}' -A 3 | grep IPAddress | cut -d ':' -f2 | xargs )).first.strip
+      end
+    end
+
+    def no_share_option
+      '--virtualbox-no-share'
+    end
+  end
+end

data/lib/docka/not_configured_error.rb

@@ -0,0 +1,7 @@
+module Docka
+  class NotConfiguredError < ::StandardError
+    def initialize(key)
+      super "#{key} is not configured."
+    end
+  end
+end

data/lib/docka/shell_error.rb

@@ -0,0 +1,4 @@
+module Docka
+  class ShellError < ::StandardError
+  end
+end

data/lib/docka/util.rb

@@ -0,0 +1,6 @@
+module Docka
+  module Util
+    autoload :Config, 'docka/util/config'
+    autoload :MultiLogger, 'docka/util/multi_logger'
+  end
+end

data/lib/docka/util/config.rb

@@ -0,0 +1,34 @@
+require 'yaml'
+require 'erb'
+
+module Docka::Util
+  class Config
+    def initialize(data, pos)
+      @data = data
+      @pos = pos
+    end
+
+    attr_reader :data, :pos
+
+    def current_data
+      @current_data ||= begin
+        data = self.data
+        pos.each{|i| data = data[i]}
+        data
+      end
+    end
+
+    def get(*args, &block)
+      options = args.extract_options!
+      v = current_data
+      pos = self.pos.dup
+      args.each do |key|
+        key = key.to_s
+        pos << key
+        v = v[key]
+        raise ::Docka::NotConfiguredError.new(pos.join('.')) if !v && options[:optional] == false
+      end
+      block ? block.call(self.class.new(data, pos)) : v
+    end
+  end
+end

data/lib/docka/util/multi_logger.rb

@@ -0,0 +1,15 @@
+module Docka::Util
+  class MultiLogger
+    def loggers
+      @loggers ||= []
+    end
+
+    ::Logger.public_instance_methods(false).each do |name|
+      define_method name do |*args, &block|
+        loggers.each do |l|
+          l.__send__ name, *args, &block
+        end
+      end
+    end
+  end
+end

data/lib/docka/version.rb

@@ -0,0 +1,3 @@
+module Docka
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: docka
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mosop
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email:
+- mosop@a.b.com
+executables:
+- docka
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docka.gemspec
+- exe/docka
+- lib/docka.rb
+- lib/docka/app.rb
+- lib/docka/app_config.rb
+- lib/docka/cli.rb
+- lib/docka/command.rb
+- lib/docka/commands.rb
+- lib/docka/commands/docka.rb
+- lib/docka/commands/docka/setup.rb
+- lib/docka/config.rb
+- lib/docka/machine.rb
+- lib/docka/machine_drivers.rb
+- lib/docka/machine_drivers/virtualbox.rb
+- lib/docka/not_configured_error.rb
+- lib/docka/shell_error.rb
+- lib/docka/util.rb
+- lib/docka/util/config.rb
+- lib/docka/util/multi_logger.rb
+- lib/docka/version.rb
+homepage: https://github.com/mosop/docka
+licenses: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A dockerized application deployment framework.
+test_files: []