beaker-docker 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07fca4dada242e02c4caa429ebd0209cc3911fb9
-  data.tar.gz: 9aa1e6633cfa7c267cb9b47f07d17eee0a540e0d
+  metadata.gz: 8a15b0037f264bd2e696038da349f7fc9ab219c7
+  data.tar.gz: a8a4d98c0cc5a0611938607362e334a2dd289d74
 SHA512:
-  metadata.gz: c2eb49d22fb4827aa73774e4dcdbac5c5063f84662db010eb87ae440cfac083b1b7eb50152725225d6d3411f0249ce111497685127d79ec5bacc093359251ba0
-  data.tar.gz: fbd2f2246972460cfb0c8efb0d5db8aac08fbb04f7012a95bb5ca391b2c6d7df32beb192e54b3e9d5b54082347d1b164fbab4cfabdb9a65615137f66bd4c69dc
+  metadata.gz: 7af3da434dbbe522bf039ff513c07d113bdb3da709e622bb9de5eba21a7262237b02e2063d42ef580d0dcd31bd2623a30c8fb897959973bc4dc9d1d7d1d4d33b
+  data.tar.gz: 833277de264b0000bda06bdbef7a072d0d53c1ac5dab68f0ba5f81dda2e34ca5a815657551a5dcee3a313e57be711bd4843bcd09cc1e9d85cb53a5a81dcc4784

data/lib/beaker-docker/version.rb

@@ -1,3 +1,3 @@
 module BeakerDocker
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/beaker/hypervisor/docker.rb

@@ -12,7 +12,7 @@ module Beaker
     def initialize(hosts, options)
       require 'docker'
       @options = options
-      @logger = options[:logger]
+      @logger = options[:logger] || Beaker::Logger.new
       @hosts = hosts
 
       # increase the http timeouts as provisioning images can be slow
@@ -52,44 +52,43 @@ module Beaker
 
         container_opts = {}
         @logger.debug("Creating image")
-          if dockerfile = host['dockerfile']
-            install_and_run_ssh = true
-            container_opts['ExposedPorts'] = {'22/tcp' => {} }
-            # assume that the dockerfile is in the repo and tests are running
-            # from the root of the repo; maybe add support for external Dockerfiles
-            # with external build dependencies later.
-            if File.exist?(dockerfile)
-              dir = File.expand_path(dockerfile).chomp(dockerfile)
-              image = ::Docker::Image.build_from_dir(
-                dir,
-                { 'dockerfile' => dockerfile,
-                  :rm => true,
-                  :buildargs => buildargs_for(host)
-                }
-              )
-            else
-              raise "Unable to find dockerfile at #{dockerfile}"
-            end
-          elsif host['use_image_entry_point']
-            install_and_run_ssh = true
-            df = <<-DF
+
+        dockerfile = host['dockerfile']
+        if dockerfile
+          install_and_run_ssh = true
+          container_opts['ExposedPorts'] = {'22/tcp' => {} }
+          # assume that the dockerfile is in the repo and tests are running
+          # from the root of the repo; maybe add support for external Dockerfiles
+          # with external build dependencies later.
+          if File.exist?(dockerfile)
+            dir = File.expand_path(dockerfile).chomp(dockerfile)
+            image = ::Docker::Image.build_from_dir(
+              dir,
+              { 'dockerfile' => dockerfile,
+                :rm => true,
+                :buildargs => buildargs_for(host)
+              }
+            )
+          else
+            raise "Unable to find dockerfile at #{dockerfile}"
+          end
+        elsif host['use_image_entry_point']
+          install_and_run_ssh = true
+          df = <<-DF
             FROM #{host['image']}
             EXPOSE 22
           DF
 
-            if cmd = host['docker_cmd']
-              df += cmd
-            end
-            image = ::Docker::Image.build(df, {
-              :rm => true, :buildargs => buildargs_for(host)
-            })
+          cmd = host['docker_cmd']
+          df += cmd if cmd
 
-          else
+          image = ::Docker::Image.build(df, { rm: true, buildargs: buildargs_for(host) })
 
-          image = ::Docker::Image.build(dockerfile_for(host), {
-             :rm => true, :buildargs => buildargs_for(host)
-          })
-          end
+        else
+
+          image = ::Docker::Image.build(dockerfile_for(host),
+                                        { rm: true, buildargs: buildargs_for(host) })
+        end
 
         if @docker_type == 'swarm'
           image_name = "#{@registry}/beaker/#{image.id}"
@@ -123,10 +122,13 @@ module Beaker
             container_opts[k] = v
           end
         end
+
         container = find_container(host)
 
-        # If the specified container exists, then use it rather creating a new one
-        if container.nil?
+        # Provisioning - Only provision if:
+        # - provisioning was explicitly requested via options, or
+        # - the host's container can't be found via its name or ID
+        if @options[:provision] || container.nil?
           unless host['mount_folders'].nil?
             container_opts['HostConfig'] ||= {}
             container_opts['HostConfig']['Binds'] = host['mount_folders'].values.map do |mount|
@@ -145,14 +147,12 @@ module Beaker
             container_opts['HostConfig']['CapAdd'] = host['docker_cap_add']
           end
 
-          if @options[:provision]
-            if host['docker_container_name']
-              container_opts['name'] = host['docker_container_name']
-            end
-
-            @logger.debug("Creating container from image #{image_name}")
-            container = ::Docker::Container.create(container_opts)
+          if host['docker_container_name']
+            container_opts['name'] = host['docker_container_name']
           end
+
+          @logger.debug("Creating container from image #{image_name}")
+          container = ::Docker::Container.create(container_opts)
         end
 
         if container.nil?
@@ -203,8 +203,8 @@ module Beaker
         }
 
         @logger.debug("node available as  ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no root@#{ip} -p #{port}")
-        host['docker_container'] = container
-        host['docker_image'] = image
+        host['docker_container_id'] = container.id
+        host['docker_image_id'] = image.id
         host['vm_ip'] = container.json["NetworkSettings"]["IPAddress"].to_s
 
       end
@@ -260,7 +260,8 @@ module Beaker
     def cleanup
       @logger.notify "Cleaning up docker"
       @hosts.each do |host|
-        if container = host['docker_container']
+        container = find_container(host)
+        if container
           @logger.debug("stop container #{container.id}")
           begin
             container.kill
@@ -276,15 +277,21 @@ module Beaker
           end
         end
 
-        # Do not remove the image if docker_reserve_image is set to true, otherwise remove it
-        if image = (host['docker_preserve_image'] ? nil : host['docker_image'])
-          @logger.debug("delete image #{image.id}")
-          begin
-            image.delete
-          rescue Excon::Errors::ClientError => e
-            @logger.warn("deletion of image #{image.id} failed: #{e.response.body}")
-          rescue ::Docker::Error::DockerError => e
-            @logger.warn("deletion of image #{image.id} caused internal Docker error: #{e.message}")
+        # Do not remove the image if docker_preserve_image is set to true, otherwise remove it
+        unless host['docker_preserve_image']
+          image_id = host['docker_image_id']
+
+          if image_id
+            @logger.debug("deleting image #{image_id}")
+            begin
+              ::Docker::Image.remove(image_id)
+            rescue Excon::Errors::ClientError => e
+              @logger.warn("deletion of image #{image_id} failed: #{e.response.body}")
+            rescue ::Docker::Error::DockerError => e
+              @logger.warn("deletion of image #{image_id} caused internal Docker error: #{e.message}")
+            end
+          else
+            @logger.warn("Intended to delete the host's docker image, but host['docker_image_id'] was not set")
           end
         end
       end
@@ -446,12 +453,26 @@ module Beaker
     # return the existing container if we're not provisioning
     # and docker_container_name is set
     def find_container(host)
-      return nil if host['docker_container_name'].nil? || @options[:provision]
-      @logger.debug("Looking for an existing container called #{host['docker_container_name']}")
+      id = host['docker_container_id']
+      name = host['docker_container_name']
+      return unless id || name
+
+      containers = ::Docker::Container.all
+
+      if id
+        @logger.debug("Looking for an existing container with ID #{id}")
+        container = containers.select { |c| c.id == id }.first
+      end
+
+      if name && container.nil?
+        @logger.debug("Looking for an existing container with name #{name}")
+        container = containers.select do |c|
+          c.info['Names'].include? "/#{name}"
+        end.first
+      end
 
-      ::Docker::Container.all.select do |c|
-        c.info['Names'].include? "/#{host['docker_container_name']}"
-      end.first
+      return container unless container.nil?
+      @logger.debug("Existing container not found")
     end
 
     # return true if we are inside a docker container

data/spec/beaker/hypervisor/docker_spec.rb

@@ -55,15 +55,14 @@ module Beaker
 
     let(:image) do
       image = double('Docker::Image')
-      allow( image ).to receive(:id)
+      allow( image ).to receive(:id).and_return("zyxwvu")
       allow( image ).to receive(:tag)
-      allow( image ).to receive(:delete)
       image
     end
 
     let(:container) do
       container = double('Docker::Container')
-      allow( container ).to receive(:id)
+      allow( container ).to receive(:id).and_return('abcdef')
       allow( container ).to receive(:start)
       allow( container ).to receive(:info).and_return(
         *(0..2).map { |index| { 'Names' => ["/spec-container-#{index}"] } }
@@ -320,6 +319,7 @@ module Beaker
           container_name = "spec-container-#{index}"
           host['docker_container_name'] = container_name
 
+          allow(::Docker::Container).to receive(:all).and_return([])
           expect( ::Docker::Container ).to receive(:create).with({
             'Image' => image.id,
             'Hostname' => host.name,
@@ -492,8 +492,8 @@ module Beaker
       it 'should record the image and container for later' do
         docker.provision
 
-        expect( hosts[0]['docker_image'] ).to be === image
-        expect( hosts[0]['docker_container'] ).to be === container
+        expect( hosts[0]['docker_image_id'] ).to be === image.id
+        expect( hosts[0]['docker_container_id'] ).to be === container.id
       end
 
       context 'provision=false' do
@@ -533,6 +533,8 @@ module Beaker
       before :each do
         # get into a state where there's something to clean
         allow( ::Docker ).to receive(:validate_version!)
+        allow( ::Docker::Container ).to receive(:all).and_return([container])
+        allow( ::Docker::Image ).to receive(:remove).with(image.id)
         allow( docker ).to receive(:dockerfile_for)
         docker.provision
       end
@@ -551,7 +553,7 @@ module Beaker
 
       it 'should delete the images' do
         allow( docker ).to receive( :sleep ).and_return(true)
-        expect( image ).to receive(:delete)
+        expect( ::Docker::Image ).to receive(:remove).with(image.id)
         docker.cleanup
       end
 
@@ -560,7 +562,7 @@ module Beaker
         hosts.each do |host|
           host['docker_preserve_image']=true
         end
-        expect( image ).to_not receive(:delete)
+        expect( ::Docker::Image ).to_not receive(:remove)
         docker.cleanup
       end
 
@@ -569,7 +571,7 @@ module Beaker
         hosts.each do |host|
           host['docker_preserve_image']=false
         end
-        expect( image ).to receive(:delete)
+        expect( ::Docker::Image ).to receive(:remove).with(image.id)
         docker.cleanup
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker-docker
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Rishi Javia, Kevin Imber, Tony Vu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-26 00:00:00.000000000 Z
+date: 2018-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec