docker-api 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 195ce9ba3c1a2f7187272771e47f2486167fd318
-  data.tar.gz: 65d04d49e572602bec544c168357558060b7aab9
+  metadata.gz: f014fbf8eec822892584240bab7d8afa3ba9005e
+  data.tar.gz: 904edd7019308e5c17cdfb326d1ef49fc9a161b8
 SHA512:
-  metadata.gz: 19f5d443a6bf3febc0325be90b01c337dd11bf0ee008f61833b38c6ebd8ed23c363f6f29a6f6c29f171705463f11d91e4d33dc839fe0c899a8c96037d570d05e
-  data.tar.gz: 73addede4a78867f54b06777f663bb8210b652992ac3be06ec6e5a1ecd13d4bb229aae38a281f2ab2962fc7c481e99f32169ca69d34aa11420cd44cc5e4722d9
+  metadata.gz: 1a25da3ac701b0dc000b4e04b694b04c82fc25f7f18be51202eb94e379eee8c17c5e948089e7ef6dd5e656a279df94eb27d9b9c6b6dd70837a77e5a8be9fc3c0
+  data.tar.gz: eb715f87b92d6acbcde4522463ba0a07f18b1f464fd1c8d75937240054911191dd515ab291544439e2081c1ccaa35a7b76c82b4c9fb5da8aa1ec5167e8a8f359

data/README.md

@@ -333,31 +333,31 @@ container.commit
 container.run('pwd', 10)
 # => Docker::Image { :id => 4427be4199ac, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }
 
-# Run an Exec instance inside the container and capture its output
+# Run an Exec instance inside the container and capture its output and exit status
 container.exec('date')
-# => [["Wed Nov 26 11:10:30 CST 2014\n"], []]
+# => [["Wed Nov 26 11:10:30 CST 2014\n"], [], 0]
 
-# Launch an Exec instance without capturing its output
+# Launch an Exec instance without capturing its output or status
 container.exec('./my_service', detach: true)
 # => Docker::Exec { :id => be4eaeb8d28a, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }
 
 # Parse the output of an Exec instance
 container.exec('find / -name *') { |stream, chunk| puts "#{stream}: #{chunk}" }
 stderr: 2013/10/30 17:16:24 Unable to locate find / -name *
-# => [[], ["2013/10/30 17:16:24 Unable to locate find / -name *\n"]]
+# => [[], ["2013/10/30 17:16:24 Unable to locate find / -name *\n"], 1]
 
 # Run an Exec instance by grab only the STDOUT output
 container.exec('date', stderr: false)
-# => [["Wed Nov 26 11:10:30 CST 2014\n"], []]
+# => [["Wed Nov 26 11:10:30 CST 2014\n"], [], 0]
 
 # Pass input to an Exec instance command via Stdin
 container.exec('cat', stdin: StringIO.new("foo\nbar\n"))
-# => [["foo\nbar\n"], []]
+# => [["foo\nbar\n"], [], 0]
 
 # Get the raw stream of data from an Exec instance
 command = ["bash", "-c", "if [ -t 1 ]; then echo -n \"I'm a TTY!\"; fi"]
 container.exec(command, tty: true)
-# => [["I'm a TTY!"], []]
+# => [["I'm a TTY!"], [], 0]
 
 # Delete a Container.
 container.delete(:force => true)

data/lib/docker/exec.rb

@@ -25,6 +25,12 @@ class Docker::Exec
     new(conn, hash)
   end
 
+  # Get info about the Exec instance
+  #
+  def json
+    Docker::Util.parse_json(connection.get(path_for(:json), {}))
+  end
+
   # Start the Exec instance. The Exec instance is deleted after this so this
   # command can only be run once.
   #
@@ -35,7 +41,7 @@ class Docker::Exec
   # @option options [TrueClass, FalseClass] :tty (false) Whether to attach using
   #     a pseudo-TTY.
   #
-  # @return [Array, Array] The STDOUT and STDERR responses
+  # @return [Array, Array, Int] The STDOUT, STDERR and exit code
   def start!(options = {}, &block)
 
     # Parse the Options
@@ -62,7 +68,7 @@ class Docker::Exec
     end
 
     connection.post(path_for(:start), nil, excon_params)
-    [msgs.stdout_messages, msgs.stderr_messages]
+    [msgs.stdout_messages, msgs.stderr_messages, self.json['ExitCode']]
   end
 
   # #start! performs the associated action and returns the output.

data/lib/docker/util.rb

@@ -61,7 +61,7 @@ module Docker::Util
         IO.copy_stream stdin, socket
 
         debug "hijack: closing write end of hijacked socket"
-        socket.close_write
+        close_write(socket)
       end
 
       debug "hijack: starting hijacked socket read thread"
@@ -84,6 +84,16 @@ module Docker::Util
     end
   end
 
+  def close_write(socket)
+    if socket.respond_to?(:close_write)
+      socket.close_write
+    elsif socket.respond_to?(:io)
+      socket.io.close_write
+    else
+      raise IOError, 'Cannot close socket'
+    end
+  end
+
   def parse_json(body)
     JSON.parse(body) unless body.nil? || body.empty? || (body == 'null')
   rescue JSON::ParserError => ex

data/lib/docker/version.rb

@@ -1,7 +1,7 @@
 module Docker
   # The version of the docker-api gem.
-  VERSION = '1.18.0'
+  VERSION = '1.19.0'
 
   # The version of the compatible Docker remote API.
-  API_VERSION = '1.15'
+  API_VERSION = '1.16'
 end

data/spec/docker/container_spec.rb

@@ -296,8 +296,8 @@ describe Docker::Container do
     context 'when passed only a command' do
       let(:output) { subject.exec(['bash','-c','sleep 2; echo hello']) }
 
-      it 'returns the stdout/stderr messages', :vcr do
-        expect(output).to eq([["hello\n"], []])
+      it 'returns the stdout/stderr messages and exit code', :vcr do
+        expect(output).to eq([["hello\n"], [], 0])
       end
     end
 
@@ -325,7 +325,7 @@ describe Docker::Container do
 
       it 'returns the stdout/stderr messages', :vcr do
         skip 'HTTP socket hijacking not compatible with VCR'
-        expect(output).to eq([["hello"],[]])
+        expect(output).to eq([["hello"],[],0])
       end
     end
 
@@ -337,7 +337,7 @@ describe Docker::Container do
       let(:output) { subject.exec(command, tty: true) }
 
       it 'returns the raw stdout/stderr output', :vcr do
-        expect(output).to eq([["I'm a TTY!"], []])
+        expect(output).to eq([["I'm a TTY!"], [], 0])
       end
     end
   end
@@ -534,13 +534,14 @@ describe Docker::Container do
     }
     let(:image) { subject.commit }
 
-    before { subject.start }
     after(:each) do
       subject.remove
       image.remove
     end
 
     it 'creates a new Image from the  Container\'s changes', :vcr do
+      subject.tap(&:start).wait
+
       expect(image).to be_a Docker::Image
       expect(image.id).to_not be_nil
     end

data/spec/docker/exec_spec.rb

@@ -1,6 +1,12 @@
 require 'spec_helper'
 
 describe Docker::Exec do
+  let(:container) {
+    Docker::Container.create(
+      'Cmd' => %w(sleep 300),
+      'Image' => 'debian:wheezy'
+    ).start!
+  }
 
   describe '#to_s' do
     subject {
@@ -26,12 +32,6 @@ describe Docker::Exec do
     subject { described_class }
 
     context 'when the HTTP request returns a 201' do
-      let(:container) {
-        Docker::Container.create(
-          'Cmd' => %w[sleep 5],
-          'Image' => 'debian:wheezy'
-        ).start!
-      }
       let(:options) do
         {
           'AttachStdin' => false,
@@ -70,14 +70,26 @@ describe Docker::Exec do
     end
   end
 
-  describe '#start!' do
-    let(:container) {
-      Docker::Container.create(
-        'Cmd' => %w[sleep 10],
-        'Image' => 'debian:wheezy'
-      ).start!
+  describe '#json' do
+    subject {
+      described_class.create(
+        'Container' => container.id,
+        'Detach' => true,
+        'Cmd' => %w[true]
+      )
     }
 
+    let(:description) { subject.json }
+    before { subject.start! }
+    after { container.kill!.remove }
+
+    it 'returns the description as a Hash', :vcr do
+      expect(description).to be_a Hash
+      expect(description['ID']).to start_with(subject.id)
+    end
+  end
+
+  describe '#start!' do
     context 'when the exec instance does not exist' do
       subject do
         described_class.send(:new, Docker.connection, 'id' => rand(10000).to_s)
@@ -100,16 +112,17 @@ describe Docker::Exec do
       after { container.kill!.remove }
 
       it 'returns the stdout and stderr messages', :vcr do
-        expect(subject.start!).to eq([["hello\n"],[]])
+        expect(subject.start!).to eq([["hello\n"],[],0])
       end
 
       context 'block is passed' do
         it 'attaches to the stream', :vcr do
           chunk = nil
-          subject.start! do |stream, c|
+          result = subject.start! do |stream, c|
             chunk ||= c
           end
           expect(chunk).to eq("hello\n")
+          expect(result).to eq([["hello\n"], [], 0])
         end
       end
     end
@@ -120,8 +133,8 @@ describe Docker::Exec do
       }
       after { container.kill!.remove }
 
-      it 'returns empty stdout and stderr messages', :vcr do
-        expect(subject.start!(:detach => true)).to eq([[],[]])
+      it 'returns empty stdout/stderr messages with exitcode', :vcr do
+        expect(subject.start!(:detach => true)).to eq([[],[], 0])
       end
     end
 
@@ -149,49 +162,4 @@ describe Docker::Exec do
       end
     end
   end
-
-  describe '#resize' do
-    let(:container) {
-      Docker::Container.create(
-        'Cmd' => %w[sleep 20],
-        'Image' => 'debian:wheezy'
-      ).start!
-    }
-
-    context 'when exec instance has TTY enabled' do
-      let(:instance) do
-        described_class.create(
-          'Container' => container.id,
-          'AttachStdin' => true,
-          'Tty' => true,
-          'Cmd' => %w[/bin/bash]
-        )
-      end
-      after do
-        container.kill!
-        sleep 1
-        container.remove
-      end
-
-      it 'returns a 200', :vcr do
-        t = Thread.new do
-          instance.start!(:tty => true)
-        end
-        sleep 1
-        expect { instance.resize(:h => 10, :w => 30) }.not_to raise_error
-        t.kill
-      end
-    end
-
-    context 'when the exec instance does not exist' do
-      subject do
-        described_class.send(:new, Docker.connection, 'id' => rand(10000).to_s)
-      end
-
-      it 'raises an error', :vcr do
-        skip 'The Docker API returns a 200 (docker/docker#9341)'
-        expect { subject.resize }.to raise_error(Docker::Error::NotFoundError)
-      end
-    end
-  end
 end

data/spec/docker/image_spec.rb

@@ -221,9 +221,10 @@ describe Docker::Image do
 
     context 'when the argument is a String', :vcr do
       let(:cmd) { 'ls /lib64/' }
-      after { container.tap(&:wait).remove }
+      after { container.remove }
 
       it 'splits the String by spaces and creates a new Container' do
+        container.wait
         expect(output).to eq("ld-linux-x86-64.so.2\n")
       end
     end
@@ -249,9 +250,10 @@ describe Docker::Image do
 
       context "command configured in image" do
         let(:cmd) { 'pwd' }
-        after { container.tap(&:wait).remove }
+        after { container.remove }
 
         it 'should normally show result if image has Cmd configured' do
+          container.wait
           expect(output).to eql "/\n"
         end
       end
@@ -562,8 +564,9 @@ describe Docker::Image do
         Docker::Container.create('Image' => image.id,
                                  'Cmd' => %w[cat /Dockerfile])
       end
-      let(:output) { container.tap(&:start)
-                              .streaming_logs(stdout: true) }
+      let!(:output) {
+        container.tap(&:start).streaming_logs(stdout: true)
+      }
       after(:each) do
         container.tap(&:wait).remove
         image.remove(:noprune => true)
@@ -571,6 +574,7 @@ describe Docker::Image do
 
       context 'with no query parameters' do
         it 'builds the image', :vcr do
+          container.wait
           expect(output).to eq(docker_file.read)
         end
       end

data/spec/docker_spec.rb

@@ -145,9 +145,10 @@ describe Docker do
 
     let(:info) { subject.info }
     let(:keys) do
-      %w(Containers Debug Driver DriverStatus ExecutionDriver IPv4Forwarding
-         Images IndexServerAddress InitPath InitSha1 KernelVersion MemoryLimit
-         NEventsListener NFd NGoroutines OperatingSystem SwapLimit)
+      %w(Containers Debug DockerRootDir Driver DriverStatus ExecutionDriver ID
+         IPv4Forwarding Images IndexServerAddress InitPath InitSha1
+         KernelVersion Labels MemTotal MemoryLimit NCPU NEventsListener NFd
+         NGoroutines Name OperatingSystem SwapLimit)
     end
 
     it 'returns the info as a Hash', :vcr do

data/spec/fixtures/build_from_dir/Dockerfile

@@ -1,2 +1,2 @@
 FROM debian:wheezy
-ADD / /
+ADD . /

data/spec/vcr/Docker/_authenticate_/with_valid_credentials/logs_in_and_sets_the_creds.yml

@@ -2,13 +2,13 @@
 http_interactions:
 - request:
     method: post
-    uri: "<DOCKER_HOST>/v1.15/auth"
+    uri: <DOCKER_HOST>/v1.16/auth
     body:
       encoding: UTF-8
-      string: '{"username":"<USERNAME>","password":"<PASSWORD>","email":"<EMAIL>","serveraddress":"https://index.docker.io/v1/"}'
+      string: ! '{"username":"<USERNAME>","password":"<PASSWORD>","email":"<USERNAME>@gmail.com","serveraddress":"https://index.docker.io/v1/"}'
     headers:
       User-Agent:
-      - Swipely/Docker-API 1.15.0
+      - Swipely/Docker-API 1.18.0
       Content-Type:
       - application/json
   response:
@@ -19,13 +19,14 @@ http_interactions:
       Content-Type:
       - application/json
       Date:
-      - Mon, 01 Dec 2014 18:09:05 GMT
+      - Thu, 12 Feb 2015 00:56:24 GMT
       Content-Length:
       - '29'
     body:
-      encoding: UTF-8
-      string: |
-        {"Status":"Login Succeeded"}
+      encoding: US-ASCII
+      string: ! '{"Status":"Login Succeeded"}
+
+'
     http_version: 
-  recorded_at: Mon, 01 Dec 2014 18:09:05 GMT
-recorded_with: VCR 2.9.3
+  recorded_at: Thu, 12 Feb 2015 00:56:24 GMT
+recorded_with: VCR 2.9.2

data/spec/vcr/Docker/_info/returns_the_info_as_a_Hash.yml

@@ -2,13 +2,13 @@
 http_interactions:
 - request:
     method: get
-    uri: "<DOCKER_HOST>/v1.15/info"
+    uri: <DOCKER_HOST>/v1.16/info
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
-      - Swipely/Docker-API 1.15.0
+      - Swipely/Docker-API 1.18.0
       Content-Type:
       - text/plain
   response:
@@ -21,13 +21,19 @@ http_interactions:
       Job-Name:
       - info
       Date:
-      - Mon, 01 Dec 2014 18:09:04 GMT
+      - Thu, 12 Feb 2015 00:56:23 GMT
       Content-Length:
-      - '490'
+      - '957'
     body:
-      encoding: UTF-8
-      string: |
-        {"Containers":1,"Debug":1,"Driver":"aufs","DriverStatus":[["Root Dir","/mnt/sda1/var/lib/docker/aufs"],["Dirs","73"]],"ExecutionDriver":"native-0.2","IPv4Forwarding":1,"Images":71,"IndexServerAddress":"https://index.docker.io/v1/","InitPath":"/usr/local/bin/docker","InitSha1":"","KernelVersion":"3.16.7-tinycore64","MemoryLimit":1,"NEventsListener":0,"NFd":17,"NGoroutines":58,"OperatingSystem":"Boot2Docker 1.3.2 (TCL 5.4); master : 495c19a - Mon Nov 24 20:40:58 UTC 2014","SwapLimit":1}
+      encoding: US-ASCII
+      string: ! '{"Containers":2,"Debug":1,"DockerRootDir":"/var/lib/docker","Driver":"devicemapper","DriverStatus":[["Pool
+        Name","docker-8:1-1049879-pool"],["Pool Blocksize","65.54 kB"],["Data file","/var/lib/docker/devicemapper/devicemapper/data"],["Metadata
+        file","/var/lib/docker/devicemapper/devicemapper/metadata"],["Data Space Used","955.4
+        MB"],["Data Space Total","107.4 GB"],["Metadata Space Used","1.933 MB"],["Metadata
+        Space Total","2.147 GB"],["Library Version","1.02.92 (2014-11-28)"]],"ExecutionDriver":"native-0.2","ID":"6WA4:W5WW:QDFQ:BD5S:L2MJ:KXLK:UUYQ:AQ3U:4V62:XISI:YHFH:HUYG","IPv4Forwarding":1,"Images":27,"IndexServerAddress":"https://index.docker.io/v1/","InitPath":"/usr/lib/docker/dockerinit","InitSha1":"7f82b25cad873786f2c2d72d9ceecc1d46e0a65b","KernelVersion":"3.17.6-1-ARCH","Labels":null,"MemTotal":6255366144,"MemoryLimit":1,"NCPU":1,"NEventsListener":0,"NFd":19,"NGoroutines":45,"Name":"docker","OperatingSystem":"Arch
+        Linux","SwapLimit":0}
+
+'
     http_version: 
-  recorded_at: Mon, 01 Dec 2014 18:09:04 GMT
-recorded_with: VCR 2.9.3
+  recorded_at: Thu, 12 Feb 2015 00:56:23 GMT
+recorded_with: VCR 2.9.2