docker-client 0.1.0

data/spec/cassettes/test_setup/start_container.yml

@@ -0,0 +1,235 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://10.0.5.5:4243/containers/12433dcd5b7a/start
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 204
+      message: !binary |-
+        Tm8gQ29udGVudA==
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAyNSBNYXkgMjAxMyAxNjowNToxMyBHTVQ=
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary ""
+    http_version: 
+  recorded_at: Sat, 25 May 2013 16:05:15 GMT
+- request:
+    method: post
+    uri: http://10.0.5.5:4243/containers/e6fa2f7eb0b6/start
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 204
+      message: !binary |-
+        Tm8gQ29udGVudA==
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAyNSBNYXkgMjAxMyAxNjowNToxNyBHTVQ=
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary ""
+    http_version: 
+  recorded_at: Sat, 25 May 2013 16:05:19 GMT
+- request:
+    method: post
+    uri: http://10.0.5.5:4243/containers/499c5c8ac48a/start
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 204
+      message: !binary |-
+        Tm8gQ29udGVudA==
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAyNSBNYXkgMjAxMyAxNjowNToyMCBHTVQ=
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary ""
+    http_version: 
+  recorded_at: Sat, 25 May 2013 16:05:22 GMT
+- request:
+    method: post
+    uri: http://10.0.5.5:4243/containers/167951f02581/start
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 204
+      message: !binary |-
+        Tm8gQ29udGVudA==
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAyNSBNYXkgMjAxMyAxNjowNToyNCBHTVQ=
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary ""
+    http_version: 
+  recorded_at: Sat, 25 May 2013 16:05:26 GMT
+- request:
+    method: post
+    uri: http://10.0.5.5:4243/containers/95fbeced7a97/start
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 204
+      message: !binary |-
+        Tm8gQ29udGVudA==
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAyNSBNYXkgMjAxMyAxNjowNToyNSBHTVQ=
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary ""
+    http_version: 
+  recorded_at: Sat, 25 May 2013 16:05:28 GMT
+- request:
+    method: post
+    uri: http://10.0.5.5:4243/containers/9f79b401cf57/start
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 204
+      message: !binary |-
+        Tm8gQ29udGVudA==
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAyNSBNYXkgMjAxMyAxNjowNTozMSBHTVQ=
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary ""
+    http_version: 
+  recorded_at: Sat, 25 May 2013 16:05:34 GMT
+- request:
+    method: post
+    uri: http://10.0.5.5:4243/containers/8fab97b08092/start
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 204
+      message: !binary |-
+        Tm8gQ29udGVudA==
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAyNSBNYXkgMjAxMyAxNjowNTozMiBHTVQ=
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary ""
+    http_version: 
+  recorded_at: Sat, 25 May 2013 16:05:34 GMT
+- request:
+    method: post
+    uri: http://10.0.5.5:4243/containers/3700641d93de/start
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 204
+      message: !binary |-
+        Tm8gQ29udGVudA==
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAyNSBNYXkgMjAxMyAxNjowNTozMyBHTVQ=
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary ""
+    http_version: 
+  recorded_at: Sat, 25 May 2013 16:05:35 GMT
+recorded_with: VCR 2.5.0

data/spec/cassettes/test_setup/wait_on_container.yml

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://10.0.5.5:4243/containers/167951f02581/wait
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAyNSBNYXkgMjAxMyAxNjowNToyNCBHTVQ=
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJTdGF0dXNDb2RlIjowfQ==
+    http_version: 
+  recorded_at: Sat, 25 May 2013 16:05:26 GMT
+- request:
+    method: post
+    uri: http://10.0.5.5:4243/containers/8fab97b08092/wait
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAyNSBNYXkgMjAxMyAxNjowNTozMyBHTVQ=
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJTdGF0dXNDb2RlIjowfQ==
+    http_version: 
+  recorded_at: Sat, 25 May 2013 16:05:35 GMT
+recorded_with: VCR 2.5.0

data/spec/docker/api_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Docker::API do
+  subject { Docker::API.new(base_url: 'http://10.0.5.5:4243') }
+  
+  it "provides a container resource" do
+    subject.containers.should be_kind_of(Docker::Resource::Container)
+  end
+  
+  it "provides an image resource"  do
+    subject.images.should be_kind_of(Docker::Resource::Image)
+  end
+  
+  xit "provides a system resource" do
+    
+  end
+  
+  xit "provides a misc resource" do
+    
+  end
+  
+  it "sets up a connection object" do
+    subject.connection.should_not be_nil
+    subject.connection.should be_kind_of(Docker::Connection)
+  end
+  
+  it "throws an error without a base_url configured" do
+    expect {
+      Docker::API.new({})
+    }.to raise_error(ArgumentError, ':base_url missing')
+  end
+  
+  
+  # Alternative syntax
+  # "Hello".should == 'Hello' 
+  # expect("Hello").to eq("Hello")
+end

data/spec/docker/connection_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Docker::Connection, :vcr do
+  subject { Docker::Connection.new(base_url: 'http://10.0.5.5:4243') }
+  
+  it "throws an error without a base_url configured" do
+    expect {
+      Docker::Connection.new({})
+    }.to raise_error(ArgumentError, ':base_url missing')
+  end
+  
+  it "sets given request headers" do
+    subject.get('/pseudo_request', {}, {'Content-Type' => 'application/json'})
+    WebMock.should have_requested(:get, "10.0.5.5:4243/pseudo_request").with(:headers => {'Content-Type' => 'application/json'})
+  end
+  
+  it "sets given query parameters" do
+    subject.get('/pseudo_params', {first: 'argument', second: 'param'})
+    WebMock.should have_requested(:get, "10.0.5.5:4243/pseudo_params").with(:query => hash_including({'first' => 'argument', 'second' => 'param'}))
+  end
+  
+  it "returns a valid response for a basic request" do
+    response = subject.send(:perform_request, :GET, '/containers/ps', {}, nil, {})
+    response.should be_kind_of(Docker::Connection::Response)
+    response.status.should == 200
+    response.content_type.should == "application/json"
+    response.body.should_not be_empty
+  end
+  
+  it "returns status 404 for non existent path" do
+    response = subject.send(:perform_request, :GET, '/invalid_path', {}, nil, {})
+    response.status.should == 404
+  end
+  
+  it "returns a valid response for get request" do
+    response = subject.get('/containers/ps?all=true', {})
+    response.status.should == 200
+    response.body.should_not be_empty
+  end
+  
+  it "returns a valid response for post request" do
+    id = create_container('connection_post')
+    response = subject.post("/containers/#{id}/start", {}, '', {})
+    response.status.should == 204
+    response.body.should be_empty
+    # clean up
+    delete_containers(id)
+  end
+  
+  it "raises an error for stream without block" do
+    expect {
+      subject.stream('/nothing') 
+    }.to raise_error(ArgumentError, 'Block required to handle streaming response')
+  end
+  
+  it "returns a stream", :live do
+    id = create_and_start_container(command: hello_world_command)
+    received_data = []
+    params = {stream: 1, stdout: 1}
+    timeout = 2
+    
+    response = subject.stream("/containers/#{id}/attach", params, timeout, {}) do |data|
+      received_data << data
+    end
+    
+    response.timeout.should be_true
+    response.status.should == 200
+    response.content_type.should == 'application/vnd.docker.raw-stream'
+    response.body.should be_nil
+    
+    received_data.first.should == "hello world\n"
+    received_data.size.should >= 1
+    
+    delete_containers(id)
+  end
+  
+  
+  # Alternative syntax
+  # "Hello".should == 'Hello' 
+  # expect("Hello").to eq("Hello")
+end

data/spec/docker/resource/container_spec.rb

@@ -0,0 +1,288 @@
+require 'spec_helper'
+
+describe Docker::Resource::Container do
+  subject { Docker::API.new(base_url: 'http://10.0.5.5:4243').containers }
+  
+  describe "lists", :vcr do
+    before(:all) {
+      @c1 = create_and_start_container('container_lists1', command: hello_world_command)
+      @c2 = create_container('container_lists2')
+    }
+    after(:all) { delete_containers(@c1, @c2) }
+    
+    it "all running containers" do
+      containers = subject.list
+      containers.should be_kind_of(Array)
+      containers.size.should >= 1
+      containers.first.should have_key("Id")
+      containers.first['Status'].should include('Up')
+    end
+    
+    it "non-running processes too" do
+      containers = subject.list(all: true)
+      containers.size.should >= 2
+      containers.first['Status'].should include('Exit')
+    end
+    
+    it "limit last created containers" do
+      containers = subject.list(limit: 1)
+      containers.size.should == 1
+    end
+    
+    it "processes before a certain created container" do
+      containers = subject.list(before: @c2)
+      containers.first["Id"].should include(@c1)
+    end
+    
+    it "processes since a certain created container" do
+      containers = subject.list(since: @c1)
+      containers.first["Id"].should include(@c2)
+    end
+  end
+  
+  describe "create", :vcr do
+    after {
+      delete_containers(@container_id)
+    }
+    
+    it "with minimal settings" do
+      status = subject.create(hello_world_command, 'base')
+      status.should be_kind_of(Hash)
+      status.should have_key('Id')
+      status.should have_key('Warnings')
+      status['Warnings'].should be_nil
+      @container_id = status['Id']
+    end
+    
+    it "with many settings" do
+      options = {
+        'Hostname' => 'test-container',
+        'User' => 'test',
+        'Memory' => 32.megabytes,
+        'MemorySwap' => 64.megabytes,
+        'CpuShares' => 1,
+        'AttachStdin' => false,
+        'AttachStdout' => true,
+        'AttachStderr' => true,
+        'PortSpecs' => ['80', '443'],
+        'Tty' => false,
+        'OpenStdin' => false,
+        'StdinOnce' => false,
+        'Env' => ['PORT=5000', 'ENVIRONTMENT=production'],
+        'Dns' => nil,
+        'Volumes' => {'/var/lib/app' => {}},
+        'VolumesFrom' => ''
+      }
+      status = subject.create(['echo', 'hello world'], 'base', options)
+      status.should be_kind_of(Hash)
+      status.should have_key('Id')
+      
+      # TODO Compare with show
+      @container_id = status['Id']
+    end
+    
+    it "raises an exception when called with invalid options" do
+      options = {
+        'PortSpecs' => '443',
+      }
+      expect {
+        subject.create(['echo', 'hello world'], 'base', options)
+      }.to raise_error(Docker::Error::InternalServerError)
+    end
+    
+  end
+  
+  describe "shows", :vcr do
+    before(:all) { @c = create_container('container_shows') }
+    after(:all) { delete_containers(@c)}
+    
+    it "the low level details" do
+      details = subject.show(@c)
+      details.should be_kind_of(Hash)
+      details['Id'].should include(@c)
+    end
+  end
+  
+  describe "changes", :vcr do
+    before(:all) { 
+      @c = create_and_start_container('container_changes', command: ['touch', '/tmp/changes'], wait: true)
+    }
+    after(:all) { delete_containers(@c) }
+    
+    it "inspects the container's filesystem changes" do
+      changes = subject.changes(@c)
+      changes.should be_kind_of(Array)
+      changes.any? {|c| c['path'] == '/tmp/changes'}
+    end
+  end
+  
+  describe "export" do
+    # not yet implemented
+  end
+  
+  describe "start", :vcr do
+    before(:all) { @c = create_container('container_start') }
+    after(:all) { delete_containers(@c)}
+    
+    it "brings a container into state running" do
+      started = subject.start(@c)
+      started.should be_true
+    end
+    
+    it "raises an exception for an unknown container" do
+      expect {
+        subject.start('invalid_id')
+      }.to raise_error(Docker::Error::ContainerNotFound)
+    end
+  end
+  
+  describe "stop", :vcr do
+    before(:all) {
+      @c = create_and_start_container('container_stop', command: hello_world_command)
+    }
+    after(:all) { delete_containers(@c) }
+    
+    it "halts a container" do
+      stopped = subject.stop(@c, 5)
+      stopped.should be_true
+    end
+    
+    it "raises an exception for an unknown container" do
+      expect {
+        subject.stop('invalid_id')
+      }.to raise_error(Docker::Error::ContainerNotFound)
+    end
+  end
+  
+  describe "restarts", :vcr do
+    before(:all) {
+      @c = create_and_start_container('container_restarts', command: hello_world_command)
+    }
+    after(:all) { delete_containers(@c) }
+    
+    it "the container" do
+      status = subject.restart(@c, 3)
+      status.should be_true
+    end
+    
+    it "raises an exception for an unknown container" do
+      expect {
+        subject.restart('invalid_id')
+      }.to raise_error(Docker::Error::ContainerNotFound)
+    end
+    
+  end
+  
+  describe "kill", :vcr do
+    before(:all) {
+      @c = create_and_start_container('container_kill', command: hello_world_command)
+    }
+    after(:all) { delete_containers(@c) }
+    
+    it "the container" do
+      status = subject.kill(@c)
+      status.should be_true
+    end
+    
+    it "raises an exception for an unknow container" do
+      expect {
+        subject.kill('invalid_id')
+      }.to raise_error(Docker::Error::ContainerNotFound)
+    end
+  end
+  
+  describe "attach", :vcr, :live do
+    before(:all) {
+      @c = create_and_start_container('container_attach', command: hello_world_command)
+    }
+    after(:all) { delete_containers(@c) }
+    
+    it "returns stdout/stderr by default as a stream" do
+      received_data = []
+      timeout = 3
+    
+      response = subject.attach(@c, {}, timeout) do |data|
+        received_data << data
+      end
+      
+      response.timeout.should be_true
+      response.status.should == 200
+      response.content_type.should == 'application/vnd.docker.raw-stream'
+      response.body.should be_nil
+      
+      received_data.first.should == "hello world\n"
+      received_data.size.should >= 2
+    end
+    
+    # TODO fails because docker always returns status 200
+    # See https://github.com/dotcloud/docker/issues/718
+    xit "raises an exception for an unknown container" do
+      expect {
+        subject.attach('invalid_id') {  }
+      }.to raise_error(Docker::Error::ContainerNotFound)
+    end 
+  end
+  
+  describe "logs", :vcr do
+    before(:all) { 
+      @c = create_and_start_container('container_logs', command: ['/bin/sh', '-c', 'echo stdout; echo stderr 1>&2'], wait: true)
+    }
+    after(:all) { delete_containers(@c) }
+    
+    it "returns the stdout of a container" do
+      output = subject.logs(@c, {stdout: true})
+      output.should include("stdout")
+    end
+    
+    it "returns the stderr of a container" do
+      output = subject.logs(@c, {stderr: true})
+      output.should include("stderr")
+    end
+    
+    # TODO fails because docker always returns status 200
+    # See https://github.com/dotcloud/docker/issues/718
+    xit "raises an exception for an unknown container" do
+      expect {
+        subject.logs('invalid_id')
+      }.to raise_error(Docker::Error::ContainerNotFound)
+    end
+  end
+  
+  describe "wait", :vcr do
+    before { 
+      @c = create_and_start_container('container_wait', command: ['sleep', '3'])
+    }
+    after { delete_containers(@c) }
+    
+    it "blocks until the container stops" do
+      status = subject.wait(@c)
+      status.should be_kind_of(Hash)
+      status.should have_key('StatusCode')
+      status['StatusCode'].should == 0
+    end
+    
+    it "raises an exception for an unknown container" do
+      expect {
+        subject.wait('invalid_id')
+      }.to raise_error(Docker::Error::ContainerNotFound)
+    end
+  end
+  
+  describe "remove", :vcr do
+    let(:container_id) {
+      create_container('container_remove', 'Volumes' => {'/var/lib/app' => {}})
+    }
+    
+    it "deletes the container" do
+      status = subject.remove(container_id, true)
+      status.should be_true
+    end
+    
+    it "raises an exception with an invalid container" do
+      expect {
+        subject.remove('invalid_ID')
+      }.to raise_error(Docker::Error::ContainerNotFound)
+    end
+  end
+  
+end