beaker-docker 0.5.2 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 64566eeaece32a9571e797f4c09a5e56babbcd1d
-  data.tar.gz: b7746e663d8fb916ebb7820fea64ab9f55babe8b
+SHA256:
+  metadata.gz: 1656bc0ada39719991d068356033f018e0e8a2d3ad36b9fb8abc7285f2bf4e0f
+  data.tar.gz: b2207cae132edc1bf03e4b6dd0f5bf34139e30868f20e6e6f585291a72cf310e
 SHA512:
-  metadata.gz: ffcf6fd38005a3f28868b00de297205dbc5df5407764758115017fdd391f42797bc1d5866ee42136af7749fa8ba4555130e406f415af4216c662f19795c587e9
-  data.tar.gz: ac43c591842f18a1cf1841cff074a1cca1393fab223a43e1e26b87fc9812138609c526ca51f46afa5ee87d6979a46c5318b50f11e0ac304054562802f7247d77
+  metadata.gz: 9054afd2e705cd0cdf2910bb243aa4e103aa58e9575c11b23b3192fa0215d7fe90465544b679e805f89f311c337cbd5af2acf92c3d0123e93e00e23a99d8647b
+  data.tar.gz: d5f352ca1ccc5a37ac60c76344fdcc2265fde3120f2c9c68ec963149c081b9477a490a84eaf926139274c30d27d59f3f37cefd593f17465edcc2038045ada7a2

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10

data/README.md

@@ -42,3 +42,14 @@ bundle exec rake test:acceptance
 # Contributing
 
 Please refer to puppetlabs/beaker's [contributing](https://github.com/puppetlabs/beaker/blob/master/CONTRIBUTING.md) guide.
+
+# Releasing
+
+To release new versions of beaker-docker, please use this [jenkins job](https://cinext-jenkinsmaster-sre-prod-1.delivery.puppetlabs.net/view/all/job/qe_beaker-docker_init-multijob_master/). This job
+lives on Puppet-internal infrastructure, so you'll need to be a part of the Puppet org to do this.
+
+To run the job, click on `Build with Parameters` in the menu on the left. Make
+sure you check the box next to `PUBLIC` and enter the appropriate version. The
+version should adhere to [semantic version standards](https://semver.org).
+When in doubt, consult the [maintainers of Beaker](https://github.com/puppetlabs/beaker/blob/master/CODEOWNERS)
+for guidance.

data/beaker-docker.gemspec

@@ -30,14 +30,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'pry', '~> 0.10'
 
-  # Documentation dependencies
-  s.add_development_dependency 'yard'
-  s.add_development_dependency 'markdown'
-  s.add_development_dependency 'thin'
-
   # Run time dependencies
   s.add_runtime_dependency 'stringify-hash', '~> 0.0.0'
-  s.add_runtime_dependency 'docker-api'
+  s.add_runtime_dependency 'docker-api', '< 2.0.0'
 
 end
 

data/lib/beaker-docker/version.rb

@@ -1,3 +1,3 @@
 module BeakerDocker
-  VERSION = '0.5.2'
+  VERSION = '0.7.1'
 end

data/lib/beaker/hypervisor/docker.rb

@@ -44,56 +44,84 @@ module Beaker
 
     end
 
+    def install_and_run_ssh(host)
+      host['dockerfile'] || host['use_image_entry_point']
+    end
+
+    def get_container_opts(host, image_name)
+      container_opts = {}
+      if host['dockerfile']
+        container_opts['ExposedPorts'] = {'22/tcp' => {} }
+      end
+
+      container_opts.merge! ( {
+        'Image' => image_name,
+        'Hostname' => host.name,
+        'HostConfig' => {
+          'PortBindings' => {
+            '22/tcp' => [{ 'HostPort' => rand.to_s[2..5], 'HostIp' => '0.0.0.0'}]
+          },
+          'PublishAllPorts' => true,
+          'Privileged' => true,
+          'RestartPolicy' => {
+            'Name' => 'always'
+          }
+        }
+      } )
+    end
+
+    def get_container_image(host)
+      @logger.debug("Creating image")
+
+      if host['use_image_as_is']
+        return ::Docker::Image.create('fromImage' => host['image'])
+      end
+
+      dockerfile = host['dockerfile']
+      if dockerfile
+        # 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)
+          return ::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']
+        df = <<-DF
+          FROM #{host['image']}
+          EXPOSE 22
+        DF
+
+        cmd = host['docker_cmd']
+        df += cmd if cmd
+        return ::Docker::Image.build(df, { rm: true, buildargs: buildargs_for(host) })
+      end
+
+      return ::Docker::Image.build(dockerfile_for(host),
+                  { rm: true, buildargs: buildargs_for(host) })
+    end
+
     def provision
       @logger.notify "Provisioning docker"
 
       @hosts.each do |host|
         @logger.notify "provisioning #{host.name}"
 
-        container_opts = {}
-        @logger.debug("Creating image")
-
-        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
-
-          cmd = host['docker_cmd']
-          df += cmd if cmd
-
-          image = ::Docker::Image.build(df, { rm: true, buildargs: buildargs_for(host) })
 
-        else
+        image = get_container_image(host)
 
-          image = ::Docker::Image.build(dockerfile_for(host),
-                                        { rm: true, buildargs: buildargs_for(host) })
+        if host['tag']
+          image.tag({:repo => host['tag']})
         end
 
-          if host['tag']
-            image.tag({:repo => host['tag']})
-          end
-
         if @docker_type == 'swarm'
           image_name = "#{@registry}/beaker/#{image.id}"
           ret = ::Docker::Image.search(:term => image_name)
@@ -106,20 +134,7 @@ module Beaker
           image_name = image.id
         end
 
-        container_opts.merge! ( {
-          'Image' => image_name,
-          'Hostname' => host.name,
-          'HostConfig' => {
-            'PortBindings' => {
-              '22/tcp' => [{ 'HostPort' => rand.to_s[2..5], 'HostIp' => '0.0.0.0'}]
-            },
-            'PublishAllPorts' => true,
-            'Privileged' => true,
-            'RestartPolicy' => {
-              'Name' => 'always'
-            }
-          }
-        } )
+        container_opts = get_container_opts(host, image_name)
         if host['dockeropts'] || @options[:dockeropts]
           dockeropts = host['dockeropts'] ? host['dockeropts'] : @options[:dockeropts]
           dockeropts.each do |k,v|
@@ -129,10 +144,9 @@ module Beaker
 
         container = find_container(host)
 
-        # 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?
+        # Provisioning - Only provision if the host's container can't be found
+        # via its name or ID
+        if container.nil?
           unless host['mount_folders'].nil?
             container_opts['HostConfig'] ||= {}
             container_opts['HostConfig']['Binds'] = host['mount_folders'].values.map do |mount|
@@ -147,6 +161,10 @@ module Beaker
             end
           end
 
+          if host['docker_env']
+            container_opts['Env'] = host['docker_env']
+          end
+
           if host['docker_cap_add']
             container_opts['HostConfig']['CapAdd'] = host['docker_cap_add']
           end
@@ -157,6 +175,8 @@ module Beaker
 
           @logger.debug("Creating container from image #{image_name}")
           container = ::Docker::Container.create(container_opts)
+        else
+          host['use_existing_container'] = true
         end
 
         if container.nil?
@@ -169,7 +189,7 @@ module Beaker
         @logger.debug("Starting container #{container.id}")
         container.start
 
-        if install_and_run_ssh
+        if install_and_run_ssh(host)
           @logger.notify("Installing ssh components and starting ssh daemon in #{host} container")
           install_ssh_components(container, host)
           # run fixssh to configure and start the ssh service
@@ -204,6 +224,7 @@ module Beaker
           :password => root_password,
           :port => port,
           :forward_agent => forward_ssh_agent,
+          :auth_methods => ['password', 'publickey', 'hostbased', 'keyboard-interactive']
         }
 
         @logger.debug("node available as  ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no root@#{ip} -p #{port}")
@@ -264,38 +285,44 @@ module Beaker
     def cleanup
       @logger.notify "Cleaning up docker"
       @hosts.each do |host|
-        container = find_container(host)
-        if container
-          @logger.debug("stop container #{container.id}")
-          begin
-            container.kill
-            sleep 2 # avoid a race condition where the root FS can't unmount
-          rescue Excon::Errors::ClientError => e
-            @logger.warn("stop of container #{container.id} failed: #{e.response.body}")
-          end
-          @logger.debug("delete container #{container.id}")
-          begin
-            container.delete
-          rescue Excon::Errors::ClientError => e
-            @logger.warn("deletion of container #{container.id} failed: #{e.response.body}")
-          end
-        end
-
-        # 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}")
+        # leave the container running if docker_preserve_container is set
+        # setting docker_preserve_container also implies docker_preserve_image
+        # is set, since you can't delete an image that's the base of a running
+        # container
+        unless host['docker_preserve_container']
+          container = find_container(host)
+          if container
+            @logger.debug("stop container #{container.id}")
             begin
-              ::Docker::Image.remove(image_id)
+              container.kill
+              sleep 2 # avoid a race condition where the root FS can't unmount
             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}")
+              @logger.warn("stop of container #{container.id} failed: #{e.response.body}")
+            end
+            @logger.debug("delete container #{container.id}")
+            begin
+              container.delete
+            rescue Excon::Errors::ClientError => e
+              @logger.warn("deletion of container #{container.id} failed: #{e.response.body}")
+            end
+          end
+
+          # 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
-          else
-            @logger.warn("Intended to delete the host's docker image, but host['docker_image_id'] was not set")
           end
         end
       end
@@ -349,7 +376,7 @@ module Beaker
           RUN apt-get update
           RUN apt-get install -y openssh-server openssh-client #{Beaker::HostPrebuiltSteps::DEBIAN_PACKAGES.join(' ')}
         EOF
-        when  /cumulus/
+      when  /cumulus/
           dockerfile += <<-EOF
           RUN apt-get update
           RUN apt-get install -y openssh-server openssh-client #{Beaker::HostPrebuiltSteps::CUMULUS_PACKAGES.join(' ')}
@@ -361,6 +388,13 @@ module Beaker
           RUN ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key
           RUN ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key
         EOF
+      when /el-8/
+        dockerfile += <<-EOF
+          RUN yum clean all
+          RUN yum install -y sudo openssh-server openssh-clients #{Beaker::HostPrebuiltSteps::RHEL8_PACKAGES.join(' ')}
+          RUN ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key
+          RUN ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key
+        EOF
       when /^el-/, /centos/, /fedora/, /redhat/, /eos/
         dockerfile += <<-EOF
           RUN yum clean all
@@ -483,6 +517,7 @@ module Beaker
 
       return container unless container.nil?
       @logger.debug("Existing container not found")
+      return nil
     end
 
     # return true if we are inside a docker container

data/spec/beaker/hypervisor/docker_spec.rb

@@ -100,6 +100,7 @@ module Beaker
       allow( ::Docker ).to receive(:logger=)
       allow( ::Docker ).to receive(:version).and_return(version)
       allow( ::Docker::Image ).to receive(:build).and_return(image)
+      allow( ::Docker::Image ).to receive(:create).and_return(image)
       allow( ::Docker::Container ).to receive(:create).and_return(container)
       allow_any_instance_of( ::Docker::Container ).to receive(:start)
     end
@@ -244,6 +245,19 @@ module Beaker
         end
       end
 
+      it 'should call image create for hosts when use_image_as_is is defined' do
+        hosts.each do |host|
+          host['use_image_as_is'] = true
+          expect( docker ).not_to receive(:install_ssh_components)
+          expect( docker ).not_to receive(:fix_ssh)
+          expect( ::Docker::Image ).to receive(:create).with('fromImage' => host['image']) #once per host
+          expect( ::Docker::Image ).not_to receive(:build)
+          expect( ::Docker::Image ).not_to receive(:build_from_dir)
+        end
+
+        docker.provision
+      end
+
       it 'should call dockerfile_for with all the hosts' do
         hosts.each do |host|
           expect( docker ).not_to receive(:install_ssh_components)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker-docker
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.7.1
 platform: ruby
 authors:
 - Rishi Javia, Kevin Imber, Tony Vu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-11 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -94,48 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: markdown
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: thin
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: stringify-hash
   requirement: !ruby/object:Gem::Requirement
@@ -154,16 +112,16 @@ dependencies:
   name: docker-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 description: For use for the Beaker acceptance testing tool
 email:
 - rishi.javia@puppet.com, kevin.imber@puppet.com, tony.vu@puppet.com
@@ -172,6 +130,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".simplecov"
 - Gemfile
@@ -205,8 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Beaker DSL Extension Helpers!