docker-api 1.15.0 → 1.16.0

data/lib/docker/util.rb

@@ -5,6 +5,85 @@ module Docker::Util
 
   module_function
 
+  # Attaches to a HTTP stream
+  #
+  # @param block
+  # @param msg_stack [Docker::Messages]
+  # @param tty [boolean]
+  def attach_for(block, msg_stack, tty = false)
+    # If TTY is enabled expect raw data and append to stdout
+    if tty
+      attach_for_tty(block, msg_stack)
+    else
+      attach_for_multiplex(block, msg_stack)
+    end
+  end
+
+  def attach_for_tty(block, msg_stack)
+    return lambda do |c,r,t|
+      msg_stack.stdout_messages << c
+      msg_stack.all_messages << c
+      block.call c if block
+    end
+  end
+
+  def attach_for_multiplex(block, msg_stack)
+    messages = Docker::Messages.new
+    lambda do |c,r,t|
+      messages = messages.decipher_messages(c)
+      msg_stack.append(messages)
+
+      unless block.nil?
+        messages.stdout_messages.each do |msg|
+          block.call(:stdout, msg)
+        end
+        messages.stderr_messages.each do |msg|
+          block.call(:stderr, msg)
+        end
+      end
+    end
+  end
+
+  def debug(msg)
+    Docker.logger.debug(msg) if Docker.logger
+  end
+
+  def hijack_for(stdin, block, msg_stack, tty)
+    attach_block = attach_for(block, msg_stack, tty)
+
+    lambda do |socket|
+      debug "hijack: hijacking the HTTP socket"
+      threads = []
+
+      debug "hijack: starting stdin copy thread"
+      threads << Thread.start do
+        debug "hijack: copying stdin => socket"
+        IO.copy_stream stdin, socket
+
+        debug "hijack: closing write end of hijacked socket"
+        socket.close_write
+      end
+
+      debug "hijack: starting hijacked socket read thread"
+      threads << Thread.start do
+        debug "hijack: reading from hijacked socket"
+
+        begin
+          while chunk = socket.readpartial(512)
+            debug "hijack: got #{chunk.bytesize} bytes from hijacked socket"
+            attach_block.call chunk, nil, nil
+          end
+        rescue EOFError
+        end
+
+        debug "hijack: killing stdin copy thread"
+        threads.first.kill
+      end
+
+      threads.each(&:join)
+    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.15.0'
+  VERSION = '1.16.0'
 
   # The version of the compatible Docker remote API.
-  API_VERSION = '1.12'
+  API_VERSION = '1.15'
 end

data/spec/docker/container_spec.rb

@@ -24,8 +24,11 @@ describe Docker::Container do
   end
 
   describe '#json' do
-    subject { described_class.create('Cmd' => %w[true], 'Image' => 'base') }
+    subject {
+      described_class.create('Cmd' => %w[true], 'Image' => 'debian:wheezy')
+    }
     let(:description) { subject.json }
+    after(:each) { subject.remove }
 
     it 'returns the description as a Hash', :vcr do
       expect(description).to be_a Hash
@@ -34,7 +37,10 @@ describe Docker::Container do
   end
 
   describe '#streaming_logs' do
-    subject { described_class.create('Cmd' => "echo hello", 'Image' => 'base') }
+    subject {
+      described_class.create('Cmd' => "echo hello", 'Image' => 'debian:wheezy')
+    }
+    after(:each) { subject.remove }
 
     context "when not selecting any stream" do
       let(:non_destination) { subject.logs }
@@ -53,7 +59,10 @@ describe Docker::Container do
   end
 
   describe '#logs' do
-    subject { described_class.create('Cmd' => "echo hello", 'Image' => 'base') }
+    subject {
+      described_class.create('Cmd' => "echo hello", 'Image' => 'debian:wheezy')
+    }
+    after(:each) { subject.remove }
 
     context "when not selecting any stream" do
       let(:non_destination) { subject.logs }
@@ -73,11 +82,15 @@ describe Docker::Container do
 
   describe '#create' do
     subject {
-      described_class.create({'Cmd' => %w[true], 'Image' => 'base'}.merge(opts))
+      described_class.create({
+        'Cmd' => %w[true],
+        'Image' => 'debian:wheezy'
+      }.merge(opts))
     }
 
     context 'when creating a container named bob' do
       let(:opts) { {"name" => "bob"} }
+      after(:each) { subject.remove }
 
       it 'should have name set to bob', :vcr do
         expect(subject.json["Name"]).to eq "/bob"
@@ -87,11 +100,15 @@ describe Docker::Container do
 
   describe '#changes' do
     subject {
-      described_class.create('Cmd' => %w[rm -rf /root], 'Image' => 'base')
+      described_class.create(
+        'Cmd' => %w[rm -rf /root],
+        'Image' => 'debian:wheezy'
+      )
     }
     let(:changes) { subject.changes }
 
     before { subject.tap(&:start).tap(&:wait) }
+    after(:each) { subject.tap(&:wait).remove }
 
     it 'returns the changes as an array', :vcr do
       expect(changes).to eq [
@@ -110,26 +127,29 @@ describe Docker::Container do
     let(:image) { Docker::Image.build_from_dir(dir) }
     let(:top) { sleep 1; container.top }
     let!(:container) { image.run('/while') }
+    after do
+      container.kill!.remove
+      image.remove
+    end
 
     it 'returns the top commands as an Array', :vcr do
       expect(top).to be_a Array
       expect(top).to_not be_empty
-      expect(top.first.keys).to eq %w(UID PID PPID C STIME TTY TIME CMD)
+      expect(top.first.keys).to include('PID')
     end
   end
 
   describe '#copy' do
-    subject {
-      Docker::Image.create(
-        'fromImage' => 'base'
-      ).run('touch /test').tap { |c| c.wait }
-    }
+    let(:image) { Docker::Image.create('fromImage' => 'debian:wheezy') }
+    subject { image.run('touch /test').tap { |c| c.wait } }
+
+    after(:each) { subject.remove }
 
     context 'when the file does not exist' do
       it 'raises an error', :vcr do
         skip 'Docker no longer returns a 500 when the file does not exist'
-        expect { subject.copy('/lol/not/a/real/file') { |chunk| puts chunk } }
-            .to raise_error
+        # expect { subject.copy('/lol/not/a/real/file') { |chunk| puts chunk } }
+        #     .to raise_error
       end
     end
 
@@ -145,21 +165,19 @@ describe Docker::Container do
     context 'when the input is a directory' do
       it 'yields each chunk of the tarred directory', :vcr do
         chunks = []
-        subject.copy('/etc/vim') { |chunk| chunks << chunk }
+        subject.copy('/etc/logrotate.d') { |chunk| chunks << chunk }
         chunks = chunks.join("\n")
-        expect(%w[vimrc vimrc.tiny]).to be_all { |file| chunks.include?(file) }
+        expect(%w[apt dpkg]).to be_all { |file| chunks.include?(file) }
       end
     end
   end
 
   describe '#export' do
     subject { described_class.create('Cmd' => %w[rm -rf / --no-preserve-root],
-                                     'Image' => 'base') }
+                                     'Image' => 'tianon/true') }
     before { subject.start }
+    after { subject.tap(&:wait).remove }
 
-    # If you have to re-record this VCR, PLEASE edit it so that it's only ~200
-    # lines. This is only because we don't want our gem to be a few hundred
-    # megabytes.
     it 'yields each chunk', :vcr do
       first = nil
       subject.export do |chunk|
@@ -170,9 +188,15 @@ describe Docker::Container do
   end
 
   describe '#attach' do
-    subject { described_class.create('Cmd' => %w[pwd], 'Image' => 'base') }
+    subject {
+      described_class.create(
+        'Cmd' => ['bash','-c','sleep 2; echo hello'],
+        'Image' => 'debian:wheezy'
+      )
+    }
 
     before { subject.start }
+    after(:each) { subject.stop.remove }
 
     context 'with normal sized chunks' do
       it 'yields each chunk', :vcr do
@@ -180,7 +204,7 @@ describe Docker::Container do
         subject.attach do |stream, c|
           chunk ||= c
         end
-        expect(chunk).to eq("/\n")
+        expect(chunk).to eq("hello\n")
       end
     end
 
@@ -198,7 +222,7 @@ describe Docker::Container do
         subject.attach do |stream, c|
           chunk ||= c
         end
-        expect(chunk).to eq("/\n")
+        expect(chunk).to eq("hello\n")
       end
     end
   end
@@ -211,7 +235,7 @@ describe Docker::Container do
       skip 'HTTP socket hijacking not compatible with VCR'
       container = described_class.create(
         'Cmd'       => %w[cat],
-        'Image'     => 'base',
+        'Image'     => 'debian:wheezy',
         'OpenStdin' => true,
         'StdinOnce' => true
       )
@@ -227,13 +251,14 @@ describe Docker::Container do
     subject {
       described_class.create(
         'Cmd' => %w[test -d /foo],
-        'Image' => 'base',
+        'Image' => 'debian:wheezy',
         'Volumes' => {'/foo' => {}}
       )
     }
     let(:all) { Docker::Container.all }
 
     before { subject.start('Binds' => ["/tmp:/foo"]) }
+    after(:each) { subject.remove }
 
     it 'starts the container', :vcr do
       expect(all.map(&:id)).to be_any { |id| id.start_with?(subject.id) }
@@ -242,9 +267,12 @@ describe Docker::Container do
   end
 
   describe '#stop' do
-    subject { described_class.create('Cmd' => %w[true], 'Image' => 'base') }
+    subject {
+      described_class.create('Cmd' => %w[true], 'Image' => 'debian:wheezy')
+    }
 
     before { subject.tap(&:start).stop('timeout' => '10') }
+    after { subject.remove }
 
     it 'stops the container', :vcr do
       expect(described_class.all(:all => true).map(&:id)).to be_any { |id|
@@ -256,13 +284,72 @@ describe Docker::Container do
     end
   end
 
+  describe '#exec' do
+    subject {
+      described_class.create(
+        'Cmd' => %w[sleep 20],
+        'Image' => 'debian:wheezy'
+      ).start
+    }
+    after { subject.kill!.remove }
+
+    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"], []])
+      end
+    end
+
+    context 'when detach is true' do
+      let(:output) { subject.exec('date', detach: true) }
+
+      it 'returns the Docker::Exec object', :vcr do
+        expect(output).to be_a Docker::Exec
+        expect(output.id).to_not be_nil
+      end
+    end
+
+    context 'when passed a block' do
+      it 'streams the stdout/stderr messages', :vcr do
+        chunk = nil
+        subject.exec(['bash','-c','sleep 2; echo hello']) do |stream, c|
+          chunk ||= c
+        end
+        expect(chunk).to eq("hello\n")
+      end
+    end
+
+    context 'when stdin object is passed' do
+      let(:output) { subject.exec('cat', stdin: StringIO.new("hello")) }
+
+      it 'returns the stdout/stderr messages', :vcr do
+        skip 'HTTP socket hijacking not compatible with VCR'
+        expect(output).to eq([["hello"],[]])
+      end
+    end
+
+    context 'when tty is true' do
+      let(:command) { [
+        "bash", "-c",
+        "if [ -t 1 ]; then echo -n \"I'm a TTY!\"; fi"
+      ] }
+      let(:output) { subject.exec(command, tty: true) }
+
+      it 'returns the raw stdout/stderr output', :vcr do
+        expect(output).to eq([["I'm a TTY!"], []])
+      end
+    end
+  end
+
   describe '#kill' do
     let(:command) { ['/bin/bash', '-c', 'while [ 1 ]; do echo hello; done'] }
-    subject { described_class.create('Cmd' => command, 'Image' => 'base') }
+    subject {
+      described_class.create('Cmd' => command, 'Image' => 'debian:wheezy')
+    }
 
-    before do
-      subject.start
-    end
+    before { subject.start }
+    after(:each) {subject.remove }
 
     it 'kills the container', :vcr do
       subject.kill
@@ -303,7 +390,9 @@ describe Docker::Container do
   end
 
   describe '#delete' do
-    subject { described_class.create('Cmd' => ['ls'], 'Image' => 'base') }
+    subject {
+      described_class.create('Cmd' => ['ls'], 'Image' => 'debian:wheezy')
+    }
 
     it 'deletes the container', :vcr do
       subject.delete(:force => true)
@@ -314,9 +403,12 @@ describe Docker::Container do
   end
 
   describe '#restart' do
-    subject { described_class.create('Cmd' => %w[sleep 50], 'Image' => 'base') }
+    subject {
+      described_class.create('Cmd' => %w[sleep 10], 'Image' => 'debian:wheezy')
+    }
 
     before { subject.start }
+    after { subject.kill!.remove }
 
     it 'restarts the container', :vcr do
       expect(described_class.all.map(&:id)).to be_any { |id|
@@ -335,8 +427,12 @@ describe Docker::Container do
 
   describe '#pause' do
     subject {
-      described_class.create('Cmd' => %w[sleep 50], 'Image' => 'base').start
+      described_class.create(
+        'Cmd' => %w[sleep 50],
+        'Image' => 'debian:wheezy'
+      ).start
     }
+    after { subject.unpause.kill!.remove }
 
     it 'pauses the container', :vcr do
       subject.pause
@@ -346,9 +442,13 @@ describe Docker::Container do
 
   describe '#unpause' do
     subject {
-      described_class.create('Cmd' => %w[sleep 50], 'Image' => 'base').start
+      described_class.create(
+        'Cmd' => %w[sleep 50],
+        'Image' => 'debian:wheezy'
+      ).start
     }
     before { subject.pause }
+    after { subject.kill!.remove }
 
     it 'unpauses the container', :vcr do
       subject.unpause
@@ -359,10 +459,15 @@ describe Docker::Container do
   end
 
   describe '#wait' do
-    subject { described_class.create('Cmd' => %w[tar nonsense],
-                                     'Image' => 'base') }
+    subject {
+      described_class.create(
+        'Cmd' => %w[tar nonsense],
+        'Image' => 'debian:wheezy'
+      )
+    }
 
     before { subject.start }
+    after(:each) { subject.remove }
 
     it 'waits for the command to finish', :vcr do
       expect(subject.wait['StatusCode']).to_not be_zero
@@ -370,26 +475,33 @@ describe Docker::Container do
 
     context 'when an argument is given' do
       subject { described_class.create('Cmd' => %w[sleep 5],
-                                       'Image' => 'base') }
+                                       'Image' => 'debian:wheezy') }
 
       it 'sets the :read_timeout to that amount of time', :vcr do
         expect(subject.wait(6)['StatusCode']).to be_zero
       end
 
-      context 'and a command runs for too long' do
-        it 'raises a ServerError', :vcr do
-          skip "VCR doesn't like to record errors"
-          expect { subject.wait(4) }.to raise_error(Docker::Error::TimeoutError)
-        end
-      end
+      # context 'and a command runs for too long' do
+      #   after(:each) { subject.remove }
+      #
+      #   it 'raises a ServerError', :vcr do
+      #     skip "VCR doesn't like to record errors"
+      #     expect{subject.wait(4)}.to raise_error(Docker::Error::TimeoutError)
+      #   end
+      # end
     end
   end
 
   describe '#run' do
     let(:run_command) { subject.run('ls') }
+
     context 'when the Container\'s command does not return status code of 0' do
-      subject { described_class.create('Cmd' => %w[lol not a real command],
-                                       'Image' => 'base') }
+      subject { described_class.create('Cmd' => %w[false],
+                                       'Image' => 'debian:wheezy') }
+
+      after do
+        subject.remove
+      end
 
       it 'raises an error', :vcr do
         expect { run_command }
@@ -399,7 +511,16 @@ describe Docker::Container do
 
     context 'when the Container\'s command returns a status code of 0' do
       subject { described_class.create('Cmd' => %w[pwd],
-                                       'Image' => 'base') }
+                                       'Image' => 'debian:wheezy') }
+      after do
+        subject.remove
+        image = run_command.json['Image']
+        run_command.remove
+        Docker::Image.get(image).history.each do |layer|
+          next unless layer['CreatedBy'] == 'pwd'
+          Docker::Image.get(layer['Id']).remove(:noprune => true)
+        end
+      end
 
       it 'creates a new container to run the specified command', :vcr do
         expect(run_command.wait['StatusCode']).to be_zero
@@ -408,23 +529,30 @@ describe Docker::Container do
   end
 
   describe '#commit' do
-    subject { described_class.create('Cmd' => %w[true], 'Image' => 'base') }
+    subject {
+      described_class.create('Cmd' => %w[true], 'Image' => 'debian:wheezy')
+    }
     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
       expect(image).to be_a Docker::Image
       expect(image.id).to_not be_nil
     end
 
-    context 'if run is passed, it saves the command in the image', :vcr do
-      let(:image) { subject.commit }
-      it 'saves the command' do
-        skip 'This is no longer working in v0.8'
-        expect(image.run('pwd').attach).to eql [["/\n"],[]]
-      end
-    end
+    # context 'if run is passed, it saves the command in the image', :vcr do
+    #   let(:image) { subject.commit }
+    #
+    #   it 'saves the command' do
+    #     skip 'This is no longer working in v0.8'
+    #     expect(image.run('pwd').attach).to eql [["/\n"],[]]
+    #   end
+    # end
 
   end
 
@@ -464,12 +592,13 @@ describe Docker::Container do
             "Env"          => nil,
             "Cmd"          => ["date"],
             "Dns"          => nil,
-            "Image"        => "base",
+            "Image"        => "debian:wheezy",
             "Volumes"      => {},
             "VolumesFrom"  => ""
           }
         end
         let(:container) { subject.create(options) }
+        after { container.remove }
 
         it 'sets the id', :vcr do
           expect(container).to be_a Docker::Container
@@ -500,7 +629,10 @@ describe Docker::Container do
     end
 
     context 'when the HTTP response is a 200' do
-      let(:container) { subject.create('Cmd' => ['ls'], 'Image' => 'base') }
+      let(:container) {
+        subject.create('Cmd' => ['ls'], 'Image' => 'debian:wheezy')
+      }
+      after { container.remove }
 
       it 'materializes the Container into a Docker::Container', :vcr do
         expect(subject.get(container.id)).to be_a Docker::Container
@@ -529,7 +661,11 @@ describe Docker::Container do
     end
 
     context 'when the HTTP response is a 200' do
-      before { described_class.create('Cmd' => ['ls'], 'Image' => 'base') }
+      let(:container) {
+        subject.create('Cmd' => ['ls'], 'Image' => 'debian:wheezy')
+      }
+      before { container }
+      after { container.remove }
 
       it 'materializes each Container into a Docker::Container', :vcr do
         expect(subject.all(:all => true)).to be_all { |container|