docker-compose-api 1.0.4 → 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8cd19119cd22c6ff9c235e71f0f3b7dda2170cd9
+  data.tar.gz: d8a5b668de10c6fecad255cc96f0359f59c1888c
+SHA512:
+  metadata.gz: 38ccca06b4af322ed96bab86176f2ded9b61da314cd51b57cb485d4dc445a074cca17a800d20450f6731078fc7c3b36ca484f50baf218ec0db7cccba7703daf6
+  data.tar.gz: 169c08e927c55f7544036e2a4c4572300cfc886bd6ae035e02cb3ab1cd93bf95e9b0dbcbbbfd073a85b3f7fb5a81224d90bca6182a3ce5c56714690fa0292d6c

data/README.md

@@ -19,7 +19,7 @@ gem install docker-compose-api
 
 ```ruby
 # Add the line below on your Gemfile...
-gem 'docker-compose-api', git: 'https://github.com/mauricioklein/docker-compose-api'
+gem 'docker-compose-api'
 
 # ... and run bundle install
 bundle install
@@ -44,8 +44,9 @@ DockerCompose.version
 compose = DockerCompose.load('[path to docker compose file]')
 
 # Accessing containers
-compose.containers                     # access all containers
-compose.containers['[container name]'] # access a specific container
+compose.containers                                   # access all containers
+compose.containers['container_label']                # access a container by its label (DEPRECATED)
+compose.get_containers_by(label: 'foo', name: 'bar') # Returns an array of all containers with label = 'foo' and name = bar
 
 # Starting containers (and their dependencies)
 compose.start                                    # start all containers
@@ -67,7 +68,7 @@ compose.delete                                    # delete all containers
 compose.delete(['container1', 'container2', ...]) # delete a list of specific containers
 
 # Checking if a container is running or not
-a_container = compose.containers['a_container']
+a_container = compose.get_containers_by(name: 'a_container').first
 a_container.running?
 
 # Accessing container informations

data/docker-compose-api.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "docker-api", "~> 1.22.2"
+  spec.add_dependency "docker-api", "1.22.2"
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "simplecov", "~> 0.10"
 end

data/lib/docker-compose.rb

@@ -38,6 +38,7 @@ module DockerCompose
   def self.create_container(attributes)
     ComposeContainer.new({
       label: attributes[0],
+      name: attributes[1]['container_name'],
       image: attributes[1]['image'],
       build: attributes[1]['build'],
       links: attributes[1]['links'],

data/lib/docker-compose/models/compose.rb

@@ -19,6 +19,15 @@ class Compose
     true
   end
 
+  #
+  # Select containers based on attributes given by "params"
+  #
+  def get_containers_by(params)
+    @containers.values.select do |container|
+      (params.to_a - container.attributes.to_a).empty?
+    end
+  end
+
   #
   # Create link relations among containers
   #

data/lib/docker-compose/models/compose_container.rb

@@ -9,6 +9,7 @@ class ComposeContainer
   def initialize(hash_attributes)
     @attributes = {
       label: hash_attributes[:label],
+      name: hash_attributes[:name].nil? ? hash_attributes[:label] : hash_attributes[:name],
       image: ComposeUtils.format_image(hash_attributes[:image]),
       build: hash_attributes[:build],
       links: ComposeUtils.format_links(hash_attributes[:links]),
@@ -54,6 +55,8 @@ class ComposeContainer
     # Prepare attributes
     port_bindings = prepare_port_bindings
     links = prepare_links
+    volumes = prepare_volumes
+    volume_binds = @attributes[:volumes] && @attributes[:volumes].reject { |volume| volume.split(':').one? }
 
     # Exposed ports are port bindings with an empty hash as value
     exposed_ports = {}
@@ -63,15 +66,19 @@ class ComposeContainer
       Image: @internal_image,
       Cmd: @attributes[:command],
       Env: @attributes[:environment],
-      Volumes: @attributes[:volumes],
+      Volumes: volumes,
       ExposedPorts: exposed_ports,
       HostConfig: {
+        Binds: volume_binds,
         Links: links,
         PortBindings: port_bindings
       }
     }
 
-    @container = Docker::Container.create(container_config)
+    query_params = { 'name' => @attributes[:name] }
+
+    params = container_config.merge(query_params)
+    @container = Docker::Container.create(params)
   end
 
   #
@@ -108,6 +115,28 @@ class ComposeContainer
     links
   end
 
+  #
+  # Transforms an array of [(host:)container(:accessmode)] to a hash
+  # required by the Docker api.
+  #
+  def prepare_volumes
+    return unless @attributes[:volumes]
+
+    volumes = {}
+
+    @attributes[:volumes].each do |volume|
+      parts = volume.split(':')
+
+      if parts.one?
+        volumes[parts[0]] = {}
+      else
+        volumes[parts[1]] = { parts[0] => parts[2] || 'rw' }
+      end
+    end
+
+    volumes
+  end
+
   #
   # Process each port entry in docker compose file and
   # create structure recognized by docker client

data/lib/version.rb

@@ -1,5 +1,5 @@
 module DockerCompose
   def self.version
-    "1.0.4"
+    "1.0.5"
   end
 end

data/spec/docker-compose/docker_compose_spec.rb

@@ -205,6 +205,19 @@ describe DockerCompose do
     container1.stop
   end
 
+  it 'binds volumes' do
+    container1 = @compose.containers.values.first
+
+    # Start container
+    container1.start
+
+    volumes = container1.stats['HostConfig']['Binds']
+    expect(volumes).to match_array(['/tmp/test:/tmp:ro'])
+
+    # Stop container
+    container1.stop
+  end
+
   it 'supports setting environment as array' do
     container1 = @compose.containers.values.first
 
@@ -231,6 +244,42 @@ describe DockerCompose do
     container1.stop
   end
 
+  it 'should assing given name to container' do
+    container = @compose.containers.values[0]
+
+    # Start container
+    container.start
+
+    container_name = container.stats['Name']
+    expect(container_name).to eq('/busybox-container')
+
+    # Stop container
+    container.stop
+  end
+
+  it 'should assing a random name to container when name is not given' do
+    container = @compose.containers.values[1]
+
+    # Start container
+    container.start
+
+    container_name = container.stats['Name']
+    expect(container_name).to_not be_nil
+
+    # Stop container
+    container.stop
+  end
+
+  it 'should filter containers by its attributes' do
+    expect(@compose.get_containers_by(label: 'busybox2')).to eq([@compose.containers['busybox2']])
+    expect(@compose.get_containers_by(name: 'busybox-container')).to eq([@compose.containers['busybox1']])
+    expect(@compose.get_containers_by(image: 'busybox:latest')).to eq([
+        @compose.containers['busybox1'],
+        @compose.containers['busybox2'],
+        @compose.containers['busybox3']
+    ])
+  end
+
   after(:all) do
     @compose.delete
   end

data/spec/docker-compose/fixtures/compose_1.yaml

@@ -1,5 +1,6 @@
 busybox1:
   image: busybox
+  container_name: busybox-container
   ports:
     - "3000"
     - "8000:8000"
@@ -11,6 +12,8 @@ busybox1:
   command: ping busybox2
   environment:
     - MYENV1=variable1
+  volumes:
+    - "/tmp/test:/tmp:ro"
 
 busybox2:
   image: busybox

data/spec/docker-compose/models/compose_container_spec.rb

@@ -4,10 +4,12 @@ describe ComposeContainer do
   context 'Object creation' do
     before(:all) do
       @attributes = {
+        label: SecureRandom.hex,
         image: 'busybox:latest',
+        name: SecureRandom.hex,
         links: ['service1:label', 'service2'],
         ports: ['3000', '8000:8000', '127.0.0.1:8001:8001'],
-        volumes: {'/tmp' => {}},
+        volumes: ['/tmp'],
         command: 'ping -c 3 localhost',
         environment: ['ENVIRONMENT']
       }
@@ -17,6 +19,7 @@ describe ComposeContainer do
 
     it 'should prepare attributes correctly' do
       expect(@entry.attributes[:image]).to eq(@attributes[:image])
+      expect(@entry.attributes[:name]).to eq(@attributes[:name])
       expect(@entry.attributes[:links])
         .to eq({'service1' => 'label', 'service2' => 'service2'})
       expect(@entry.attributes[:volumes]).to eq(@attributes[:volumes])
@@ -50,15 +53,18 @@ describe ComposeContainer do
 
   context 'From image' do
     before(:all) do
-      attributes = {
+      @attributes = {
+        label: SecureRandom.hex,
         image: 'busybox:latest',
+        name: SecureRandom.hex,
         links: ['links:links'],
-        volumes: {'/tmp' => {}},
+        volumes: ['/tmp'],
         command: 'ping -c 3 localhost',
         environment: ['ENVIRONMENT']
       }
 
-      @entry = ComposeContainer.new(attributes)
+      @entry = ComposeContainer.new(@attributes)
+      @entry_autogen_name = ComposeContainer.new(@attributes.reject{|key| key == :name})
     end
 
     it 'should start/stop a container' do
@@ -82,6 +88,26 @@ describe ComposeContainer do
       @entry.stop
       expect(@entry.running?).to be false
     end
+
+    it 'should assign a given name to container' do
+      #Start container
+      @entry.start
+
+      expect(@entry.stats['Name']).to eq("/#{@attributes[:name]}")
+
+      # Stop container
+      @entry.stop
+    end
+
+    it 'should assign label to container name when name is not given' do
+      #Start container
+      @entry_autogen_name.start
+
+      expect(@entry_autogen_name.stats['Name']).to eq("/#{@entry_autogen_name.attributes[:label]}")
+
+      # Stop container
+      @entry_autogen_name.stop
+    end
   end
 
   context 'From Dockerfile' do
@@ -89,7 +115,7 @@ describe ComposeContainer do
       attributes = {
         build: File.expand_path('spec/docker-compose/fixtures/'),
         links: ['links:links'],
-        volumes: {'/tmp' => {}}
+        volumes: ['/tmp']
       }
 
       @entry = ComposeContainer.new(attributes)
@@ -122,7 +148,7 @@ describe ComposeContainer do
     before(:all) do
       attributes = {
         links: ['links:links'],
-        volumes: {'/tmp' => {}},
+        volumes: ['/tmp'],
         command: 'ps aux',
         environment: ['ENVIRONMENT']
       }
@@ -150,4 +176,31 @@ describe ComposeContainer do
       expect(@entry.attributes[:environment]).to eq(%w(ENVIRONMENT=VALUE))
     end
   end
+
+  describe '#prepare_volumes' do
+    let(:attributes) do
+      { image: 'busybox:latest' }
+    end
+
+    it 'correctly parses container-only volumes' do
+      attributes[:volumes] = ['/tmp']
+      entry = ComposeContainer.new(attributes)
+      volumes = entry.send(:prepare_volumes)
+      expect(volumes).to eq({ '/tmp' => {} })
+    end
+
+    it 'correctly parses host-container mapped volumes' do
+      attributes[:volumes] = ['./tmp:/tmp']
+      entry = ComposeContainer.new(attributes)
+      volumes = entry.send(:prepare_volumes)
+      expect(volumes).to eq({ '/tmp' => { './tmp' => 'rw' } })
+    end
+
+    it 'correctly parses host-container mapped volumes with access rights' do
+      attributes[:volumes] = ['./tmp:/tmp:ro']
+      entry = ComposeContainer.new(attributes)
+      volumes = entry.send(:prepare_volumes)
+      expect(volumes).to eq({ '/tmp' => { './tmp' => 'ro' } })
+    end
+  end
 end

metadata

@@ -1,80 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: docker-compose-api
 version: !ruby/object:Gem::Version
-  version: 1.0.4
-  prerelease: 
+  version: 1.0.5
 platform: ruby
 authors:
 - Mauricio S. Klein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-29 00:00:00.000000000 Z
+date: 2016-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.22.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.22.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 description: A simple ruby client for docker-compose api
 email:
 - mauricio.klein.msk@gmail.com
@@ -82,9 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -105,27 +96,26 @@ files:
 homepage: https://github.com/mauricioklein/docker-compose-api
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A simple ruby client for docker-compose api
 test_files:
 - spec/docker-compose/docker_compose_spec.rb