docker-compose 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a06d21989982bb658ca42414f0a20e6e511263f6
-  data.tar.gz: 94d12b911c12197da022fe880548d68f80225182
+  metadata.gz: b952c56ce5427a6d9ce38a1ad58ace5c5cf15d79
+  data.tar.gz: 0863c488fa6a6f6a46e6cd7c153c28339be08d24
 SHA512:
-  metadata.gz: 400d618d335ebb064edccbb21f074c66d1b5e82ba4b6f5a93b69ac1227cab19438df7e23ea94529f40f5598405fcd4834234881ffdc011a7c00f0d00d0467919
-  data.tar.gz: 180aac4998d6a1ed559f006a617a987e0ea61aa0904c9030de8ba9698f23f254b08ee907aa613b12ca79f1863a61e761668388f1e4f6d8efa816bf6b13d7b6d9
+  metadata.gz: b533ef0d4fa4cdfa2672228fbf28da9dfa4495b666dd4ef356a79839d2c94fabbb106d05f0044d852ccd630a43092d1a12f30b671e02b23714ea781d93f1e594
+  data.tar.gz: 9cd0fd736c824ec0ebbebe9d9b22ae16f941f6ad1c6c0a3f372c124b1054c32e14f027016e0035e67c0f420b7ad35f5a7b7f0f7c430a022b1658e841dab05e90

data/lib/docker/compose.rb

@@ -1,4 +1,5 @@
 require_relative 'compose/version'
+require_relative 'compose/error'
 require_relative 'compose/shell'
 require_relative 'compose/session'
 require_relative 'compose/net_info'
@@ -6,7 +7,7 @@ require_relative 'compose/mapper'
 
 module Docker
   module Compose
-    # Create a new session.
+    # Create a new session with default options.
     def self.new
       Session.new
     end

data/lib/docker/compose/error.rb

@@ -0,0 +1,16 @@
+module Docker::Compose
+  class Error < RuntimeError
+    attr_reader :status, :detail
+
+    # @param [String] cmd
+    # @param [Integer] status
+    # @param [String] detail
+    def initialize(cmd, status, detail)
+      @status = status
+      @detail = detail
+      brief = detail.split("\n").first || '(no output)'
+      message = format("'%s' failed with status %d: %s", cmd, status, brief)
+      super(message)
+    end
+  end
+end

data/lib/docker/compose/future/session.rb

@@ -48,10 +48,10 @@ module Docker::Compose::Future
           project: File.basename(@dir)
         }
 
-        result, output =
+        result, output, error =
           @shell.command('docker-compose', project_opts, *cmd)
-        (result == 0) || raise(RuntimeError,
-                               "#{cmd.first} failed with status #{result}")
+        (result == 0) ||
+          raise(Docker::Compose::Error.new(cmd.first, result, error))
         output
       end
     ensure

data/lib/docker/compose/mapper.rb

@@ -12,6 +12,25 @@ module Docker::Compose
     BadSubstitution = Class.new(StandardError)
     NoService       = Class.new(RuntimeError)
 
+    # Instantiate a mapper; map some environment variables; yield to caller for
+    # additional processing.
+    #
+    # @param [Boolean] strict
+    # @param [Session] session
+    # @param [NetInfo] net_info
+    # @yield yields with each substituted (key, value) pair
+    def self.map(env, strict:true, session:Session.new, net_info:NetInfo.new)
+      mapper = self.new(session, net_info.host_routable_ip, strict:strict)
+      env.each_pair do |k, v|
+        begin
+          v = mapper.map(v)
+          yield(k, v)
+        rescue NoService
+          yield(k, nil)
+        end
+      end
+    end
+
     # Create an instance of Mapper
     # @param [Docker::Compose::Session] session
     # @param [String] host_ip IPv4 address of the host that is publishing

data/lib/docker/compose/rake_tasks.rb

@@ -24,18 +24,18 @@ module Docker::Compose
     # services running inside containers.
     #
     # @see Docker::Compose::Mapper for information about the substitution syntax
-    attr_accessor :env
+    attr_accessor :server_env
 
     # Extra environment variables that should be set before invoking the command
-    # specified for docker:compose:server. These are set _in addition_ to env
-    # (and should be disjoint from env), and do not necessarily need to map the
-    # location of a container; they can be simple extra env values that are
+    # specified for docker:compose:server. These are set _in addition_ to server_env
+    # (and should be disjoint from server_env), and do not necessarily need to map the
+    # location of a container; they are simply extra environment values that are
     # useful to change the server's behavior when it runs in cooperation
     # with containers.
     #
-    # If there is overlap between env and server_env, then keys of server_env
-    # will "win"; they are set last.
-    attr_accessor :server_env
+    # If there is overlap between server_env and extra_server_env, then keys
+    # of extra_server_env will "win"; they are set last.
+    attr_accessor :extra_server_env
 
     # Command to exec on the _host_ when someone invokes docker:compose:server.
     # This is used to start up all containers and then run a server that
@@ -44,18 +44,20 @@ module Docker::Compose
 
     # Construct Rake wrapper tasks for docker-compose. If a block is given,
     # yield self to the block before defining any tasks so their behavior
-    # can be configured by calling #env=, #file= and so forth.
+    # can be configured by calling #server_env=, #file= and so forth.
     def initialize
       self.dir = Rake.application.original_dir
       self.file = 'docker-compose.yml'
-      self.env = {}
       self.server_env = {}
+      self.extra_server_env = {}
       yield self if block_given?
 
       @shell = Docker::Compose::Shell.new
       @session = Docker::Compose::Session.new(@shell, dir:dir, file:file)
       @net_info = Docker::Compose::NetInfo.new
 
+      @shell.interactive = true
+
       define
     end
 
@@ -67,25 +69,25 @@ module Docker::Compose
             @shell.interactive = false # suppress useless 'port' output
 
             if Rake.application.top_level_tasks.include? 'docker:compose:env'
-              # This task is being run as top-level; print some bash export
-              # statements or usage information depending on whether STDOUT
-              # is a tty.
-              if STDOUT.tty?
-                print_usage
-              else
-                export_env(print:true)
-              end
+              # This task is being run as top-level task; set process
+              # environment _and_ print bash export commands to stdout.
+              # Also print usage hints if user invoked rake directly vs.
+              # eval'ing it's output
+              print_usage
+              export_env(print:true)
             else
               # This task is a dependency of something else; just export the
               # environment variables for use in-process by other Rake tasks.
               export_env(print:false)
             end
+
+            @shell.interactive = true
           end
 
-          desc 'Launch services needed to run this application'
+          desc 'Launch services (ONLY=a,b,...)'
           task :up do
-            @shell.interactive = true # let user see what's happening
-            @session.up(detached:true)
+            only = (ENV['ONLY'] || '').split(',').compact.uniq
+            @session.up(*only, detached:true)
           end
 
           desc 'Tail logs of all running services'
@@ -93,7 +95,7 @@ module Docker::Compose
             @session.logs
           end
 
-          desc 'Stop services needed to run this application'
+          desc 'Stop services'
           task :stop do
             @session.stop
           end
@@ -110,28 +112,17 @@ module Docker::Compose
     # published by docker-compose services. Optionally also print bash export
     # statements so this information can be made available to a user's shell.
     private def export_env(print:)
-      # First, do env substitutions in strict mode; don't catch BadSubstitution
-      # so the caller knows when he has a bogus value
-      mapper = Docker::Compose::Mapper.new(@session,
-                                           @net_info.docker_routable_ip)
-      self.env.each_pair do |k, v|
-        begin
-          v = mapper.map(v)
-          ENV[k] = v
-          print_env(k, v) if print
-        rescue Docker::Compose::Mapper::NoService
-          ENV[k] = nil
-          print_env(k, nil) if print
-        end
+      Docker::Compose::Mapper.map(self.server_env,
+                                  session:@session,
+                                  net_info:@net_info) do |k, v|
+        ENV[k] = v
+        print_env(k, v) if print
       end
 
-      # Next, do server substitutions in non-strict mode since server_env
-      # can contain arbitrary values.
-      mapper = Docker::Compose::Mapper.new(@session,
-                                           @net_info.docker_routable_ip,
-                                           strict:false)
-      self.server_env.each_pair do |k, v|
-        v = mapper.map(v)
+      Docker::Compose::Mapper.map(self.extra_server_env,
+                                  strict:false,
+                                  session:@session,
+                                  net_info:@net_info) do |k, v|
         ENV[k] = v
         print_env(k, v) if print
       end
@@ -148,11 +139,8 @@ module Docker::Compose
 
     private def print_usage
       be = 'bundle exec ' if defined?(Bundler)
-      puts "# To export container network locations to your environment:"
-      puts %Q{eval "$(#{be}rake docker:compose:env)"}
-      puts
-      puts '# To learn which environment variables we will export:'
-      puts %Q{echo "$(#{be}rake docker:compose:env)"}
+      puts %Q{# To export these variables to your shell, run:}
+      puts %Q{#   eval "$(#{be}rake docker:compose:env)"}
     end
   end
 end

data/lib/docker/compose/session.rb

@@ -13,6 +13,8 @@ module Docker::Compose
   # allowed by the docker-compose CLI, and that options are sometimes renamed
   # for clarity, e.g. the "-d" flag always becomes the "detached:" kwarg.
   class Session
+    attr_reader :dir, :file
+
     def initialize(shell=Docker::Compose::Shell.new,
                    dir:Dir.pwd, file:'docker-compose.yml')
       @shell = shell
@@ -99,10 +101,9 @@ module Docker::Compose
       }
 
       Dir.chdir(@dir) do
-        result, output =
+        result, output, error =
           @shell.command('docker-compose', project_opts, *cmd)
-        (result == 0) || raise(RuntimeError,
-                               "#{cmd.first} failed with status #{result}")
+        (result == 0) || raise(Error.new(cmd.first, result, error))
         output
       end
     end

data/lib/docker/compose/shell.rb

@@ -75,6 +75,8 @@ module Docker::Compose
     # Arrays and simple objects are appended to argv as "bare" words; Hashes
     # are translated to golang flags and then appended to argv.
     #
+    # @return [Array] an (Integer,String,String) triple of exitstatus, stdout and stderr
+    #
     # @example Run docker-compose with complex parameters
     #   command('docker-compose', {file: 'joe.yml'}, 'up', {d:true}, 'mysvc')
     #
@@ -104,7 +106,7 @@ module Docker::Compose
     #
     # @param [Array] argv command to run; argv[0] is program name and the
     #   remaining elements are parameters and flags
-    # @return [Array] a pair of Integer exitstatus and String output
+    # @return [Array] an (Integer,String,String) triple of exitstatus, stdout and stderr
     private def run(argv)
       stdin, stdout, stderr, thr = Open3.popen3(*argv)
 
@@ -117,6 +119,7 @@ module Docker::Compose
       end
 
       output = String.new.force_encoding(Encoding::BINARY)
+      error = String.new.force_encoding(Encoding::BINARY)
 
       until streams.empty? || (streams.length == 1 && streams.first == STDIN)
         ready, _, _ = IO.select(streams, [], [], 1)
@@ -134,6 +137,7 @@ module Docker::Compose
         if ready && ready.include?(stderr)
           data = stderr.readpartial(1_024) rescue nil
           if data
+            error << data
             STDERR.write(data) if @interactive
           else
             streams.delete(stderr)
@@ -155,7 +159,7 @@ module Docker::Compose
       # given that we have received EOF on its output streams).
       status = thr.value.exitstatus
 
-      [status, output]
+      [status, output, error]
     rescue Interrupt
       # Proxy Ctrl+C to our child process
       Process.kill('INT', thr.pid) rescue nil

data/lib/docker/compose/version.rb

@@ -1,5 +1,5 @@
 module Docker
   module Compose
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-compose
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tony Spataro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-08 00:00:00.000000000 Z
+date: 2015-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,7 @@ files:
 - bin/setup
 - docker-compose.gemspec
 - lib/docker/compose.rb
+- lib/docker/compose/error.rb
 - lib/docker/compose/future/session.rb
 - lib/docker/compose/mapper.rb
 - lib/docker/compose/net_info.rb