docker-compose-api 1.0.2 → 1.0.4

data/README.md

@@ -61,6 +61,11 @@ compose.stop(['container1', 'container2', ...]) # stop a list of specific contai
 compose.kill                                    # kill all containers
 compose.kill(['container1', 'container2', ...]) # kill a list of specific containers
 
+# Deleting containers
+# (ps: container dependencies will keep running)
+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.running?

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

@@ -58,16 +58,27 @@ class Compose
   end
 
   #
-  # Stop a container
+  # Kill a container
   #
   # This method accepts an array of labels.
-  # If labels is informed, only those containers with label present in array will be stopped.
-  # Otherwise, all containers are stopped
+  # If labels is informed, only those containers with label present in array will be killed.
+  # Otherwise, all containers are killed
   #
   def kill(labels  = [])
     call_container_method(:kill, labels)
   end
 
+  #
+  # Delete a container
+  #
+  # This method accepts an array of labels.
+  # If labels is informed, only those containers with label present in array will be deleted.
+  # Otherwise, all containers are deleted
+  #
+  def delete(labels = [])
+    call_container_method(:delete, labels)
+  end
+
   private
 
   def call_container_method(method, labels = [])

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

@@ -15,7 +15,7 @@ class ComposeContainer
       ports: prepare_ports(hash_attributes[:ports]),
       volumes: hash_attributes[:volumes],
       command: ComposeUtils.format_command(hash_attributes[:command]),
-      environment: hash_attributes[:environment]
+      environment: prepare_environment(hash_attributes[:environment])
     }.reject{ |key, value| value.nil? }
 
     # Docker client variables
@@ -49,28 +49,15 @@ class ComposeContainer
 
   #
   # Start a new container with parameters informed in object construction
-  # (TODO: start container from a Dockerfile)
   #
   def prepare_container
-    exposed_ports = {}
-    port_bindings = {}
-    links = []
+    # Prepare attributes
+    port_bindings = prepare_port_bindings
+    links = prepare_links
 
-    # Build expose and port binding parameters
-    if !@attributes[:ports].nil?
-      @attributes[:ports].each do |port|
-        exposed_ports["#{port.container_port}/tcp"] = {}
-        port_bindings["#{port.container_port}/tcp"] = [{
-          "HostIp" => port.host_ip || '',
-          "HostPort" => port.host_port || ''
-        }]
-      end
-    end
-
-    # Build link parameters
-    @dependencies.each do |dependency|
-      links << "#{dependency.stats['Id']}:#{dependency.attributes[:label]}"
-    end
+    # Exposed ports are port bindings with an empty hash as value
+    exposed_ports = {}
+    port_bindings.each {|k, v| exposed_ports[k] = {}}
 
     container_config = {
       Image: @internal_image,
@@ -87,6 +74,40 @@ class ComposeContainer
     @container = Docker::Container.create(container_config)
   end
 
+  #
+  # Prepare port binding attribute based on ports
+  # received from compose file
+  #
+  def prepare_port_bindings
+    port_bindings = {}
+
+    return port_bindings if @attributes[:ports].nil?
+
+    @attributes[:ports].each do |port|
+      port_bindings["#{port.container_port}/tcp"] = [{
+        "HostIp" => port.host_ip || '',
+        "HostPort" => port.host_port || ''
+      }]
+    end
+
+    port_bindings
+  end
+
+  #
+  # Prepare link entries based on
+  # attributes received from compose
+  #
+  def prepare_links
+    links = []
+
+    @dependencies.each do |dependency|
+      link_name = @attributes[:links][dependency.attributes[:label]]
+      links << "#{dependency.stats['Id']}:#{link_name}"
+    end
+
+    links
+  end
+
   #
   # Process each port entry in docker compose file and
   # create structure recognized by docker client
@@ -105,6 +126,14 @@ class ComposeContainer
     ports
   end
 
+  #
+  # Forces the environment structure to use the array format.
+  #
+  def prepare_environment(env_entries)
+    return env_entries unless env_entries.is_a?(Hash)
+    env_entries.to_a.map { |x| x.join('=') }
+  end
+
   #
   # Check if a given image already exists in host
   #
@@ -136,7 +165,7 @@ class ComposeContainer
   # Stop the container
   #
   def stop
-    @container.kill unless @container.nil?
+    @container.stop unless @container.nil?
   end
 
   #
@@ -175,4 +204,11 @@ class ComposeContainer
   def running?
     @container.nil? ? false : self.stats['State']['Running']
   end
+
+  #
+  # Check if the container exists or not
+  #
+  def exist?
+    !@container.nil?
+  end
 end

data/lib/docker-compose/utils/compose_utils.rb

@@ -62,6 +62,8 @@ module ComposeUtils
   # Generate a pair key:hash with
   # format {service:label}
   #
+  # The label will be the conainer name if not specified.
+  #
   def self.format_links(links_array)
     links = {}
 
@@ -72,7 +74,7 @@ module ComposeUtils
 
       case parts.length
         when 1
-          links[parts[0]] = SecureRandom.hex
+          links[parts[0]] = parts[0]
 
         when 2
           links[parts[0]] = parts[1]

data/lib/version.rb

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

data/spec/docker-compose/docker_compose_spec.rb

@@ -14,7 +14,7 @@ describe DockerCompose do
   end
 
   it 'should read a YAML file correctly' do
-    expect(@compose.containers.length).to eq(2)
+    expect(@compose.containers.length).to eq(3)
   end
 
   it 'should raise error when reading an invalid YAML file' do
@@ -49,13 +49,27 @@ describe DockerCompose do
         expect(container.running?).to be false
       end
     end
+
+    it 'should start/delete all containers' do
+      # Start containers to test Delete
+      @compose.start
+      @compose.containers.values.each do |container|
+        expect(container.running?).to be true
+      end
+
+      # Delete containers
+      @compose.delete
+      @compose.containers.values.each do |container|
+        expect(container.exist?).to be false
+      end
+    end
   end
 
   context 'Single container' do
     context 'Without dependencies' do
       it 'should start/stop a single container' do
         container1 = @compose.containers.values.first.attributes[:label]
-        container2 = @compose.containers.values.last.attributes[:label]
+        container2 = @compose.containers.values[1].attributes[:label]
 
         # Should start Redis only, since it hasn't dependencies
         @compose.start([container2])
@@ -70,7 +84,7 @@ describe DockerCompose do
 
       it 'should start/kill a single container' do
         container1 = @compose.containers.values.first.attributes[:label]
-        container2 = @compose.containers.values.last.attributes[:label]
+        container2 = @compose.containers.values[1].attributes[:label]
 
         # Should start Redis only, since it hasn't dependencies
         @compose.start([container2])
@@ -87,7 +101,7 @@ describe DockerCompose do
     context 'With dependencies' do
       it 'should start/stop a single container' do
         container1 = @compose.containers.values.first.attributes[:label]
-        container2 = @compose.containers.values.last.attributes[:label]
+        container2 = @compose.containers.values[1].attributes[:label]
 
         # Should start Ubuntu and Redis, since Ubuntu depends on Redis
         @compose.start([container1])
@@ -106,7 +120,7 @@ describe DockerCompose do
 
       it 'should start/kill a single container' do
         container1 = @compose.containers.values.first.attributes[:label]
-        container2 = @compose.containers.values.last.attributes[:label]
+        container2 = @compose.containers.values[1].attributes[:label]
 
         # Should start Ubuntu and Redis, since Ubuntu depends on Redis
         @compose.start([container1])
@@ -125,7 +139,7 @@ describe DockerCompose do
 
       it 'should be able to ping a dependent container' do
         container1 = @compose.containers.values.first.attributes[:label]
-        container2 = @compose.containers.values.last.attributes[:label]
+        container2 = @compose.containers.values[1].attributes[:label]
 
         # Start all containers
         @compose.start
@@ -136,6 +150,20 @@ describe DockerCompose do
         ping_response = @compose.containers[container1].container.exec(['ping', '-c', '3', 'busybox2'])
         expect(ping_response[2]).to eq(0) # Status 0 = OK
       end
+
+      it 'should be able to ping a dependent aliased container' do
+        container2 = @compose.containers.values[1].attributes[:label]
+        container3 = @compose.containers.values[2].attributes[:label]
+
+        # Start all containers
+        @compose.start
+        expect(@compose.containers[container2].running?).to be true
+        expect(@compose.containers[container3].running?).to be true
+
+        # Ping container3 from container1
+        ping_response = @compose.containers[container3].container.exec(['ping', '-c', '3', 'bb2'])
+        expect(ping_response[2]).to eq(0) # Status 0 = OK
+      end
     end # context 'with dependencies'
   end # context 'Single container'
 
@@ -177,9 +205,33 @@ describe DockerCompose do
     container1.stop
   end
 
+  it 'supports setting environment as array' do
+    container1 = @compose.containers.values.first
+
+    # Start container
+    container1.start
+
+    env = container1.stats['Config']['Env']
+    expect(env).to eq(%w(MYENV1=variable1))
+
+    # Stop container
+    container1.stop
+  end
+
+  it 'supports setting environment as hash' do
+    container1 = @compose.containers.values[1]
+
+    # Start container
+    container1.start
+
+    env = container1.stats['Config']['Env']
+    expect(env).to eq(%w(MYENV2=variable2))
+
+    # Stop container
+    container1.stop
+  end
+
   after(:all) do
-    @compose.containers.values.each do |entry|
-      entry.delete
-    end
+    @compose.delete
   end
 end

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

@@ -9,9 +9,19 @@ busybox1:
   links:
     - busybox2
   command: ping busybox2
+  environment:
+    - MYENV1=variable1
 
 busybox2:
   image: busybox
   expose:
     - "6000"
   command: ping localhost
+  environment:
+    MYENV2: variable2
+
+busybox3:
+  image: busybox
+  links:
+    - busybox2:bb2
+  command: ping localhost

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

@@ -5,7 +5,7 @@ describe ComposeContainer do
     before(:all) do
       @attributes = {
         image: 'busybox:latest',
-        links: ['service:label'],
+        links: ['service1:label', 'service2'],
         ports: ['3000', '8000:8000', '127.0.0.1:8001:8001'],
         volumes: {'/tmp' => {}},
         command: 'ping -c 3 localhost',
@@ -17,7 +17,8 @@ describe ComposeContainer do
 
     it 'should prepare attributes correctly' do
       expect(@entry.attributes[:image]).to eq(@attributes[:image])
-      expect(@entry.attributes[:links]).to eq({'service' => 'label'})
+      expect(@entry.attributes[:links])
+        .to eq({'service1' => 'label', 'service2' => 'service2'})
       expect(@entry.attributes[:volumes]).to eq(@attributes[:volumes])
       expect(@entry.attributes[:command]).to eq(@attributes[:command].split(' '))
       expect(@entry.attributes[:environment]).to eq(@attributes[:environment])
@@ -133,4 +134,20 @@ describe ComposeContainer do
       expect{@entry.start}.to raise_error(ArgumentError)
     end
   end
+
+  context 'With environment as a hash' do
+    before(:all) do
+      @attributes = {
+        image: 'busybox:latest',
+        command: 'ping -c 3 localhost',
+        environment: { ENVIRONMENT: 'VALUE' }
+      }
+
+      @entry = ComposeContainer.new(@attributes)
+    end
+
+    it 'should prepare environment attribute correctly' do
+      expect(@entry.attributes[:environment]).to eq(%w(ENVIRONMENT=VALUE))
+    end
+  end
 end

data/spec/docker-compose/utils/compose_utils_spec.rb

@@ -56,7 +56,7 @@ describe ComposeUtils do
     it 'should recognize pattern "[service]"' do
       links = ComposeUtils.format_links(['service'])
       expect(links.key?('service')).to be true
-      expect(links['service']).to_not be_nil
+      expect(links['service']).to eq('service')
     end
 
     it 'should recognize pattern "[service:label]"' do

data/spec/spec_helper.rb

@@ -3,7 +3,10 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'simplecov'
 require 'codeclimate-test-reporter'
 
-SimpleCov.start
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
 CodeClimate::TestReporter.start
 
 require 'docker-compose'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docker-compose-api
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-27 00:00:00.000000000 Z
+date: 2015-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api