dockistrano 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 031a5bef368643972d84782c3fe8aec9f9a83cdc
+  data.tar.gz: d2f202905234e891b5a2ad5c07b453365d9aec1c
+SHA512:
+  metadata.gz: d60c0c8983b6c70f78dca0a130f7db92fd0613117b11e3bb2859eb8b00dd9bfa1df6a81d8f9660978fdeeee7748974adffc60c8e45a2fd098b28d4b3f5501c8a
+  data.tar.gz: a341da5a23a8f8cadaed99e1d1febf57f69a5922c497b8732a1d4eb21651c7c425446a129245a77197428a9ade403f49b97dc5b7d5b77dad15b03ee346416b84

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Edwin Vlieg
+
+MIT License
+
+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,101 @@
+# Dockistrano
+
+Dockistrano uses docker to create a development and testing environment for applications. It is inspired by Capistrano, because booting a container should be as easy as doing a `cap deploy`. The approach has a lot of conventions and as little as configuration as possible.
+
+## Current status
+
+Dockistrano is actively used for software development at [MoneyBird](http://www.moneybird.com), but is still very immature. Feel free to play around and provide us feedback. A pull request with tested code is the best way to help us improve the software!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dockistrano'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dockistrano
+
+## Preparing your application
+
+To use Dockistrano for your application, two files should be created:
+
+### `Dockerfile`
+
+The `Dockerfile` describes the container that is created for the application and should contain all dependencies. Example:
+
+```
+FROM ubuntu
+RUN apt-get update
+RUN apt-get install mydependency
+ADD ./ ./
+EXPOSE 8000
+CMD ["webserver", "start"]
+```
+
+For more information about writing Dockerfiles, see [the documentation on docker.io](http://docs.docker.io/en/latest/use/builder/).
+
+### `config/dockistrano.yml`
+
+The configuration file contains information about the registry, dependencies, ports and environment variables.
+
+```
+---
+registry: my.privateregistry.com:5000
+dependencies:
+  postgresql:
+    database: "my_databasename"
+  redis:
+environment:
+  rails_env: development
+```
+
+## Usage
+
+Dockistrano provides a range of commands to create containers and run commands in containers:
+
+### `doc build`
+
+Builds the current container by using the `Dockerfile`. The resulting container will be tagged with the registry name, name of the image and tag of the current git branch.
+
+When building is successfull, the container will be tested by running the `test_command` provided in the config. When tests are successfull, the container is pushes to the registry.
+
+### `doc start` and `doc start-services`
+
+Starts the container by running the default command. Environment variables from dependencies are automatically added to the run command. Optionally the backing services can be started seperatly with `doc start-services`
+
+### `doc stop` and `doc stop-all`
+
+Stops the current container or stops all containers, including the backing services.
+
+### `doc logs [NAME]`
+
+Prints logs for the container or for a backing service when a name of the service is provided. When the container is running a `docker attach` is used, otherwise a `docker logs`.
+
+### `doc exec COMMAND`
+
+Executes the command in the container, printing the result in the console.
+
+### `doc console [CONSOLE]`
+
+Starts a console in the container, by default /bin/bash is started. Optionally a console can be provided, for example `doc console rails console` to start a Rails console.
+
+### `doc ps`
+
+Prints all running processes on Docker
+
+### `doc clean`
+
+Cleans unused containers and images from Docker
+
+### `doc status`
+
+Prints information about the current container and lists environment variables that are provided to the container when started.
+
+### `doc pull`
+
+Pulls new versions of containers from the registry

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/doc

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path("../../lib/", __FILE__)
+
+require "bundler"
+Bundler.setup(:default)
+
+require "dockistrano"
+begin
+  Dockistrano::Cli.start
+rescue Thor::InvocationError => e
+  puts e
+end

data/dockistrano.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dockistrano/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dockistrano"
+  spec.version       = Dockistrano::VERSION
+  spec.authors       = ["Edwin Vlieg"]
+  spec.email         = ["edwin@moneybird.com"]
+  spec.summary       = %q{Manage Docker containers for a development workflow}
+  spec.homepage      = "http://github.com/moneybird/dockistrano"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "cocaine"
+  spec.add_dependency "multi_json"
+  spec.add_dependency "redis"
+  spec.add_dependency "dotenv"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "terminal-notifier-guard"
+  spec.add_development_dependency "webmock"
+end

data/lib/dockistrano/cli.rb

@@ -0,0 +1,220 @@
+require 'thor'
+require "dotenv"
+Dotenv.load(".dockistrano")
+ENV["DOCKISTRANO_ENVIRONMENT"] ||= "default"
+ENV["DOCKER_HOST_IP"] ||= "127.0.0.1"
+ENV["DOCKER_BINARY"] ||= begin
+  if RUBY_PLATFORM =~ /darwin|mac os/
+    bin_dir = File.expand_path(File.dirname(__FILE__) + "/../../bin")
+    "#{bin_dir}/docker"
+  else
+    "docker"
+  end
+end
+
+module Dockistrano
+
+  class Cli < ::Thor
+
+    desc "ps", "List all running containers in docker"
+    def ps
+      puts Docker.ps
+    end
+
+    desc "setup", "Sets up a host for starting the application"
+    method_option "environment", aliases: "-e", default: ENV["DOCKISTRANO_ENVIRONMENT"], type: :string, desc: "Environment to start the container in"
+    def setup
+      say "Please execute the following command on the host to setup", :green
+      say "\tmkdir -p #{current_service.directories_required_on_host.join(" ")}"
+    end
+
+    desc "status", "Status of the application"
+    method_option "environment", aliases: "-e", default: ENV["DOCKISTRANO_ENVIRONMENT"], type: :string, desc: "Environment to start the container in"
+    def status
+      say "DOCKISTRANO_ENVIRONMENT: #{options["environment"]}", :green
+      say "DOCKER_HOST_IP: #{ENV['DOCKER_HOST_IP']}", :green
+      say "DOCKER_BINARY: #{ENV['DOCKER_BINARY']}", :green
+      say ""
+      say "Current application", :blue
+      say "  registry: #{current_service.registry}"
+      say "  image name: #{current_service.image_name}"
+      say "  tag: #{current_service.tag}"
+      say "  volumes:"
+      current_service.volumes.each do |volume|
+        say "    #{volume}"
+      end
+      say ""
+      say "Dependencies", :blue
+      current_service.backing_services.each do |name, service|
+        say "  #{service.full_image_name}"
+      end
+      say ""
+      say "Environment", :blue
+      current_service.environment_variables.each do |key, value|
+        say "  #{key}=#{value}"
+      end
+      say ""
+      say "Hipache", :blue
+      Hipache.new(ENV["DOCKER_HOST_IP"]).status.each do |host, ips|
+        say "  #{host}: #{ips.join(", ")}"
+      end
+      say ""
+    end
+
+    desc "build", "Build and test a new application container"
+    def build
+      if current_service.build
+        say_status "built", current_service.image_name
+        if current_service.test
+          say_status "tests passed", current_service.image_name
+          current_service.push
+          say_status "pushed", current_service.image_name
+        else
+          say_status "tests failed", current_service.image_name
+          exit 1
+        end
+      else
+        say_status "failed", current_service.image_name, :red
+        exit 1
+      end
+    end
+
+    desc "pull", "Pull new versions of dependencies"
+    def pull
+      current_service.backing_services.each do |name, service|
+        if service.newer_version_available?
+          service.pull
+          say_status "Pulled", name
+        else
+          say_status "Uptodate", name, :white
+        end
+      end
+
+      if current_service.newer_version_available?
+        current_service.pull
+        say_status "Pulled", current_service.image_name
+      else
+        say_status "Uptodate", current_service.image_name, :white
+      end
+    end
+
+    desc "push", "Pushes a new version of this container"
+    def push
+      current_service.push
+    end
+
+    desc "start-services", "Starts the backing services"
+    method_option "environment", aliases: "-e", default: ENV["DOCKISTRANO_ENVIRONMENT"], type: :string, desc: "Environment to start the container in"
+    def start_services
+      current_service.backing_services.each do |name, service|
+        if service.running?
+          say_status("Running", name, :white)
+        else
+          service.start
+          say_status("Started", name)
+        end
+      end
+    end
+
+    desc "stop-all", "Stops the backing services"
+    def stop_all
+      current_service.stop
+      say_status("Stopped", current_service.image_name)
+      current_service.backing_services.each do |name, service|
+        if service.running?
+          service.stop
+          say_status("Stopped", name)
+        end
+      end
+    end
+
+    desc "start", "Starts the application"
+    method_option "environment", aliases: "-e", default: ENV["DOCKISTRANO_ENVIRONMENT"], type: :string, desc: "Environment to start the container in"
+    def start
+      if current_service.running?
+        say_status("Running", current_service.image_name, :white)
+      else
+        current_service.start(options)
+        say_status("Started", current_service.image_name)
+      end
+    rescue Dockistrano::Service::EnvironmentVariablesMissing => e
+      say e.message, :red
+    end
+
+    desc "stop [ID]", "Stops the application or container with specified ID"
+    def stop(id=nil)
+      if id
+        Docker.stop(id)
+        say_status("Stopped", id, :green)
+      else
+        current_service.stop
+        say_status("Stopped", current_service.image_name, :green)
+      end
+    end
+
+    desc "restart", "Restarts the application"
+    method_option "environment", aliases: "-e", default: ENV["DOCKISTRANO_ENVIRONMENT"], type: :string, desc: "Environment to start the container in"
+    def restart
+      current_service.stop
+      say_status("Stopped", current_service.image_name)
+      current_service.start(options)
+      say_status("Started", current_service.image_name)
+    end
+
+    desc "exec COMMAND", "Executes a command in the application and returns"
+    method_option "environment", aliases: "-e", default: ENV["DOCKISTRANO_ENVIRONMENT"], type: :string, desc: "Environment to start the container in"
+    def exec(*command)
+      current_service.exec(command.join(" "), options)
+    rescue Dockistrano::Service::EnvironmentVariablesMissing => e
+      say e.message, :red
+    end
+
+    desc "console [COMMAND]", "Starts an interactive shell in the application"
+    method_option "environment", aliases: "-e", default: ENV["DOCKISTRANO_ENVIRONMENT"], type: :string, desc: "Environment to start the container in"
+    def console(*command)
+      command = ["/bin/bash"] if command.empty?
+      current_service.console(command.join(" "), options)
+    rescue Dockistrano::Service::EnvironmentVariablesMissing => e
+      say e.message, :red
+    end
+
+    desc "clean", "Cleans images and containers from docker"
+    def clean
+      Docker.clean
+      Dockistrano::ServiceDependency.clear_cache
+    end
+
+    desc "logs [NAME]", "Prints the logs for the service"
+    def logs(name=nil)
+      service = name ? current_service.backing_services[name] : current_service
+      if service.running?
+        say "Container #{service.image_name} running, attaching to output", :blue
+        service.attach
+      else
+        say "Container #{service.image_name} stopped, printing logs of last run", :blue
+        service.logs
+      end
+    end
+
+    def method_missing(*args)
+      command = args[0]
+      if command and current_service.config["aliases"] and current_service.config["aliases"][command.to_s]
+        args.shift
+        Kernel.exec("doc #{current_service.config["aliases"][command.to_s]} #{args.join(" ")}")
+      else
+        super
+      end
+    end
+
+    private
+
+    # Returns the current service
+    def current_service
+      @service ||= Service.factory(Dir.pwd, options["environment"])
+    rescue Dockistrano::Service::ConfigurationFileMissing
+      say "No configuration file found in current directory. config/dockistrano.yml missing", :red
+      exit 1
+    end
+
+  end
+end

data/lib/dockistrano/command_line.rb

@@ -0,0 +1,28 @@
+module Dockistrano
+
+  class CommandLine
+
+    def self.command_with_result(command)
+      debug(command)
+      `#{command}`
+    end
+
+    def self.command_with_stream(command)
+      debug(command)
+      begin
+        Kernel.system(command)
+      rescue Interrupt
+      end
+    end
+
+    def self.command_with_interaction(command)
+      debug(command)
+      Kernel.exec(command)
+    end
+
+    def self.debug(command)
+      puts "$ #{command}" if false
+    end
+
+  end
+end

data/lib/dockistrano/docker.rb

@@ -0,0 +1,188 @@
+require 'cocaine'
+require 'multi_json'
+
+module Dockistrano
+
+  # Class for communication with Docker. Uses two means of communication:
+  #
+  # - Actions on containers are executed by calling the docker binary with an
+  #   ip address of the Docker location. The docker command line client is best
+  #   capable of executing the actions for building images, running containers and
+  #   managing containers.
+  # - Queries are executed using the HTTP API of docker. This API is exposed via HTTP
+  #   and returns JSON. This allows us to easily parse and return the information.
+  #
+  # This class uses two environment variables:
+  #
+  #   DOCKER_BINARY  - Location of the docker binary on your system
+  #   DOCKER_HOST_IP - IP address or host of the docker server
+  #
+  class Docker
+
+    class EnvironmentVariableMissing < StandardError
+    end
+
+    # Returns the docker command as a string: 'docker -H 127.0.0.1'
+    def self.docker_command
+      raise EnvironmentVariableMissing.new("Missing DOCKER_BINARY in environment, please provide the location of the docker binary") unless ENV["DOCKER_BINARY"]
+      raise EnvironmentVariableMissing.new("Missing DOCKER_HOST_IP in environment, please provide the host or ip address of the docker server") unless ENV["DOCKER_HOST_IP"]
+      "#{ENV['DOCKER_BINARY']} -H #{ENV['DOCKER_HOST_IP']}"
+    end
+
+    # Executes the given command on the command line
+    def self.execute(command, mode=:string_result)
+      case mode
+      when :string_result
+        Dockistrano::CommandLine.command_with_result("#{docker_command} #{command.collect { |c| c.kind_of?(String) ? c : arguments(c) }.join(" ")}".strip)
+      when :stream
+        Dockistrano::CommandLine.command_with_stream("#{docker_command} #{command.collect { |c| c.kind_of?(String) ? c : arguments(c) }.join(" ")}".strip)
+      else
+        Dockistrano::CommandLine.command_with_interaction("#{docker_command} #{command.collect { |c| c.kind_of?(String) ? c : arguments(c) }.join(" ")}".strip)
+      end
+    end
+
+    def self.ps(options={})
+      execute(["ps", options])
+    end
+
+    def self.stop(id)
+      execute(["stop", id])
+    end
+
+    def self.run(full_image_name, options={})
+      if (command = options.delete(:command))
+        execute(["run", options, full_image_name, command])
+      else
+        execute(["run", options, full_image_name])
+      end
+    end
+
+    def self.exec(full_image_name, options={})
+      if (command = options.delete(:command))
+        execute(["run", options, full_image_name, command], :stream)
+      else
+        execute(["run", options, full_image_name], :stream)
+      end
+    end
+
+    def self.console(full_image_name, options={})
+      options["t"] = true
+      options["i"] = true
+      if (command = options.delete(:command))
+        execute(["run", options, full_image_name, command], :interaction)
+      else
+        execute(["run", options, full_image_name], :interaction)
+      end
+    end
+
+    def self.build(full_image_name)
+      execute(["build", { t: full_image_name }, "."], :stream)
+    end
+
+    def self.pull(full_image_name, tag)
+      execute(["pull", { t: tag }, full_image_name])
+    end
+
+    def self.push(image_name, tag)
+      execute(["push", image_name, tag], :stream)
+    end
+
+    def self.logs(id)
+      execute(["logs", id], :stream)
+    end
+
+    def self.attach(id)
+      execute(["attach", id], :stream)
+    end
+
+    def self.clean
+      Dockistrano::CommandLine.command_with_stream("#{docker_command} rmi $(#{docker_command} images -a | grep \"^<none>\" | awk '{print $3}')")
+      Dockistrano::CommandLine.command_with_stream("#{docker_command} rm $(#{docker_command} ps -a -q)")
+    end
+
+    def self.running_container_id(full_image_name)
+      request(["containers", "json"]).each do |container|
+        return container["Id"] if container["Image"] == full_image_name
+      end
+      nil
+    end
+
+    # Returns the id of the last container with an error
+    def self.last_run_container_id(full_image_name)
+      request(["containers", "json?all=1"]).each do |container|
+        return container["Id"] if container["Image"] == full_image_name and container["Command"] != "cat /dockistrano.yml"
+      end
+      nil
+    end
+
+    def self.image_id(full_image_name)
+      inspect_image(full_image_name)["id"]
+    end
+
+    class ImageNotFound < StandardError
+    end
+
+    def self.inspect_image(full_image_name)
+      response = request(["images", full_image_name, "json"])
+    rescue ResourceNotFound => e
+      raise ImageNotFound.new(e.message)
+    end
+
+    def self.inspect_container(id)
+      request(["containers", id, "json"])
+    end
+
+    def self.stop_all_containers_from_image(full_image_name)
+      containers = request(["containers", "json"])
+      containers.each do |container|
+        execute(["stop", container["Id"]]) if container["Image"] == full_image_name
+      end
+    end
+
+    def self.tags_for_image(image_name)
+      images = request(["images", "json"])
+      [].tap do |tags|
+        images.each do |image|
+          tags << image["Tag"] if image["Repository"] == image_name
+        end
+      end
+    end
+
+    private
+
+    def self.request(path)
+      uri = URI.parse("http://#{ENV['DOCKER_HOST_IP']}:4243/#{path.join("/")}")
+      response = Net::HTTP.get_response(uri)
+      if response.kind_of?(Net::HTTPNotFound)
+        raise ResourceNotFound.new("Could not find #{path.join("/")}: #{response.body}")
+      end
+
+      MultiJson.load(response.body)
+    end
+
+    class ResourceNotFound < StandardError
+    end
+
+    def self.arguments(options)
+      options.collect do |k,v|
+        case v
+        when TrueClass
+          "-#{k}"
+        when Array
+          v.collect { |av| "-#{k} #{av}" }.join(" ").strip
+        when Hash
+          v.collect { |ak, av|
+            if av
+              "-#{k} #{ak}='#{av}'"
+            else
+              ""
+            end
+          }.join(" ").strip
+        else
+          "-#{k} #{v}"
+        end
+      end.join(" ").strip
+    end
+
+  end
+end

data/lib/dockistrano/git.rb

@@ -0,0 +1,27 @@
+module Dockistrano
+
+  class Git
+
+    def self.repository_name
+      git_url = Cocaine::CommandLine.new("git config --get remote.origin.url").run.strip
+
+      if git_url =~ /^[A-z0-9]+@[A-z0-9.:\-]+\/([A-z0-9\-_\.]+)(\.git)?$/
+        $1.gsub(/\.git$/, "")
+      elsif git_url =~ /^https?:\/\/[a-z\-\.]+\/[a-z\-\.]+\/([A-z0-9.\-\_]+)$/
+        $1
+      else
+        raise "Unknown git url '#{git_url}'"
+      end
+    end
+
+    def self.branch
+      if ENV['JANKY_BRANCH']
+        ENV['JANKY_BRANCH'].gsub("/", "-")
+      else
+        branch = Cocaine::CommandLine.new("git rev-parse --abbrev-ref HEAD").run.strip
+        branch.gsub("/", "-")
+      end
+    end
+
+  end
+end