beaker 2.37.0 → 2.38.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGNkMmMyYzVlMzE0ZjZjNzZjYjMwNGUzYWI5ZGJiYzljM2E4YmJhNw==
+    YjBkMjI0OGY1ZWIwZTA1Mjg5NmVhZGQ4MGQzODgyNDdhNGI4Y2ZmNw==
   data.tar.gz: !binary |-
-    MmQyMGI2ZTdmYjVjMjQ3MzIwNWI5OTQwNGFhNzQ3NDgyYzNjMTU4Zg==
+    Zjg4ZGJhNmExMGRjYWRmMmFiNWY5ODY0YmU2NDQ5ZWQ3OGEzYzdjMg==
 SHA512:
   metadata.gz: !binary |-
-    N2M5NjFjMWM4MGI2ZTllNDM2ODNhMGQ4YmQzMzlhNWUzNDdiZWZmMWU3ZTdk
-    MWQ5YzE2ZjgwMmY1NzE3YTU3NjVhMjkxYTUzYjZkZDZkZmYzNGExZjJiNzNh
-    ZDg0MDY0ZGM5YjZlYjhmMDkyNjIxNDViZTdjNzBhNWUzNDIwMjI=
+    NGI3NjQ1ZTYyYTRkYTA2OTUwYjI5Mzg2YjQxYjZkZTFiZjczNjE3NTQyNjFj
+    NTNkYTNhOGIxNDFkYmRhYzljMjYwYThmOTRjMmU5MzVmNjQxMTI2YzA3NzU2
+    YzAyNjY4YWYyMGYyMGQ0ZmE1N2JmYjNjMTdhM2U0OTNmYzNjODA=
   data.tar.gz: !binary |-
-    Mjk3ZTg3M2Y1MjIzMzZkY2NhNzhiNWViNjljODc3YzljNjk5ZmZkMzM1ODcx
-    OTA0ZmVhNDg0YmFhYzAwOTc5ZjEwNTEwMTM1MjVlNjdiNjVhODI4NTk1ZTQ4
-    MDIxNDE1YzViZmNmMTNlOGVmZTc2M2FhNTMxMzZkNzJkMzE2N2Y=
+    ODViYThmNzkxYWEzMjY5MmVhM2VkMzFmMjg2ZTE4ODU4YWY0ZTAxMTA1N2Rj
+    ZmVkY2RkZGIxNDQyN2ExMWQzNmVlMDE1MzVjOWFiMGRhNDBkYjAzMmU0NDlh
+    Zjc0OWUwZGM0NTJkMzk2N2U3N2U5ZGFjYTUyOGRkYWQ0YzQ5MWU=

data/HISTORY.md

@@ -1,6 +1,7 @@
 # default - History
 ## Tags
-* [LATEST - 15 Mar, 2016 (b7ed692c)](#LATEST)
+* [LATEST - 30 Mar, 2016 (fa9fbc7d)](#LATEST)
+* [2.37.0 - 15 Mar, 2016 (a6c2297b)](#2.37.0)
 * [2.36.0 - 9 Mar, 2016 (5fd86b67)](#2.36.0)
 * [2.35.0 - 24 Feb, 2016 (b20fa892)](#2.35.0)
 * [2.34.0 - 10 Feb, 2016 (b897a98a)](#2.34.0)
@@ -112,7 +113,62 @@
 * [pe1.2 - 6 Sep, 2011 (ba3dadd2)](#pe1.2)
 
 ## Details
-### <a name = "LATEST">LATEST - 15 Mar, 2016 (b7ed692c)
+### <a name = "LATEST">LATEST - 30 Mar, 2016 (fa9fbc7d)
+
+* (GEM) update beaker version to 2.38.0 (fa9fbc7d)
+
+* Merge pull request #1085 from LuvCurves/BKR-749 (123bca82)
+
+
+```
+Merge pull request #1085 from LuvCurves/BKR-749
+
+(BKR-749) Wrap Nexus Pre-commands
+```
+* Merge pull request #1077 from aaronbbrown/BKR-658 (75ca10fa)
+
+
+```
+Merge pull request #1077 from aaronbbrown/BKR-658
+
+(BKR-658) Fix BEAKER_provision=no when using Docker
+```
+* (BKR-749) Wrap Nexus Pre-commands (c4eb29f2)
+
+* Merge pull request #1081 from glennmatthews/cisco-user_pc (e6988252)
+
+
+```
+Merge pull request #1081 from glennmatthews/cisco-user_pc
+
+(BKR-722) Don't clobber user_pc in prepend_commands for cisco host
+```
+* (BKR-658) refactor error message (eed36669)
+
+* (BKR-722) cisco host#prepend_commands needs fixes for 'sudo' and user_pc (52b8a039)
+
+* (BKR-658) remove empty before block (39713760)
+
+* (BKR-658) fix BEAKER_provision=no for docker provisioner (5d1c4681)
+
+
+```
+(BKR-658) fix BEAKER_provision=no for docker provisioner
+
+The Docker provisioner does not behave correctly when
+BEAKER_provision=no is used from beaker-rspec. This corrects that
+behavior so the container is reused. It defers to
+::Docker::Container.create throwing raising an exception if
+BEAKER_provision=yes and the container currently exists, rather than
+blindly reusing the container (the previous behavior).
+
+Also added is a best effort at sshd_config repair for root logins.
+Puppet users will often disable root logins, which breaks Beaker, so
+this attempts to revert such changes via Docker::Container#exec.
+```
+### <a name = "2.37.0">2.37.0 - 15 Mar, 2016 (a6c2297b)
+
+* (HISTORY) update beaker history for gem release 2.37.0 (a6c2297b)
 
 * (GEM) update beaker version to 2.37.0 (b7ed692c)
 

data/lib/beaker/command.rb

@@ -72,9 +72,13 @@ module Beaker
     def cmd_line host, cmd = @command, env = @environment, pc = @prepend_cmds
       env_string = host.environment_string( env )
       prepend_commands = host.prepend_commands( cmd, pc, :cmd_exe => @cmdexe )
+      if host[:platform] =~ /cisco_nexus/ && host[:user] != 'root'
+          append_command = '"'
+        cmd = cmd.gsub('"') { '\\"' }
+      end
 
       # This will cause things like `puppet -t -v agent` which is maybe bad.
-      cmd_line_array = [env_string, prepend_commands, cmd, options_string, args_string]
+      cmd_line_array = [env_string, prepend_commands, cmd, options_string, args_string, append_command]
       cmd_line_array.compact.reject( &:empty? ).join( ' ' )
     end
 

data/lib/beaker/host/cisco.rb

@@ -71,11 +71,14 @@ module Cisco
     def prepend_commands(command = '', user_pc = '', opts = {})
       return user_pc unless command.index('vsh').nil?
 
-      prepend_cmds = 'source /etc/profile;'
+      prepend_cmds = ''
       if self[:vrf]
-        prepend_cmds << "sudo ip netns exec #{self[:vrf]}"
+        prepend_cmds << "ip netns exec #{self[:vrf]} "
       end
-      return prepend_cmds
+      if user_pc && !user_pc.empty?
+        prepend_cmds << "#{user_pc} "
+      end
+      prepend_cmds.strip
     end
 
     # Construct the environment string for this command
@@ -90,12 +93,20 @@ module Cisco
     #                  will ensure the environment is correctly set for the
     #                  given host.
     def environment_string env
-      return '' if env.empty?
+      prestring = 'source /etc/profile;'
+      prestring << " sudo sh -c \"" if self[:user] != 'root'
+      return prestring if env.empty?
       env_array = self.environment_variable_string_pair_array( env )
       environment_string = env_array.join(' ')
 
-      command = self[:platform] =~ /cisco_nexus/ ? 'export' : 'env'
-      "#{command} #{environment_string};"
+      if self[:platform] =~ /cisco_nexus/
+        prestring << " export"
+      else
+        prestring << " env"
+      end
+      environment_string = "#{prestring} #{environment_string}"
+      environment_string << ';' if prestring =~ /export/
+      environment_string
     end
 
     # Validates that the host was setup correctly

data/lib/beaker/hypervisor/docker.rb

@@ -68,34 +68,36 @@ module Beaker
           'Image' => image_name,
           'Hostname' => host.name,
         }
+        container = find_container(host)
 
-        unless host['docker_container_name'].nil?
-          @logger.debug("Looking for an existing container called #{host['docker_container_name']}")
-          existing_container = ::Docker::Container.all.select do |container| container.info['Names'].include? "/#{host['docker_container_name']}" end
-
-          # Prepare to use the existing container or else create it
-          if existing_container.any?
-            container = existing_container[0]
-          else
-            container_opts['name'] = host['docker_container_name']
+        # If the specified container exists, then use it rather creating a new one
+        if container.nil?
+          unless host['mount_folders'].nil?
+            container_opts['HostConfig'] ||= {}
+            container_opts['HostConfig']['Binds'] = host['mount_folders'].values.map do |mount|
+              a = [ File.expand_path(mount['host_path']), mount['container_path'] ]
+              a << mount['opts'] if mount.has_key?('opts')
+              a.join(':')
+            end
           end
-        end
 
-        unless host['mount_folders'].nil?
-          container_opts['HostConfig'] ||= {}
-          container_opts['HostConfig']['Binds'] = host['mount_folders'].values.map do |mount|
-            a = [ File.expand_path(mount['host_path']), mount['container_path'] ]
-            a << mount['opts'] if mount.has_key?('opts')
-            a.join(':')
+          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)
           end
         end
 
-        # If the specified container exists, then use it rather creating a new one
         if container.nil?
-          @logger.debug("Creating container from image #{image_name}")
-          container = ::Docker::Container.create(container_opts)
+          raise RuntimeError, 'Cannot continue because no existing container ' +
+                              'could be found and provisioning is disabled.'
         end
 
+        fix_ssh(container) if @options[:provision] == false
+
         @logger.debug("Starting container #{container.id}")
         container.start({"PublishAllPorts" => true, "Privileged" => true})
 
@@ -268,10 +270,35 @@ module Beaker
         EOF
 
       end
-      
+
       @logger.debug("Dockerfile is #{dockerfile}")
       return dockerfile
     end
 
+    # a puppet run may have changed the ssh config which would
+    # keep us out of the container.  This is a best effort to fix it.
+    def fix_ssh(container)
+      @logger.debug("Fixing ssh on container #{container.id}")
+      container.exec(['sed','-ri',
+                      's/^#?PermitRootLogin .*/PermitRootLogin yes/',
+                      '/etc/ssh/sshd_config'])
+      container.exec(['sed','-ri',
+                      's/^#?PasswordAuthentication .*/PasswordAuthentication yes/',
+                      '/etc/ssh/sshd_config'])
+      container.exec(%w(service ssh restart))
+    end
+
+
+    # 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']}")
+
+      ::Docker::Container.all.select do |c|
+        c.info['Names'].include? "/#{host['docker_container_name']}"
+      end.first
+    end
+
   end
 end

data/lib/beaker/network_manager.rb

@@ -12,11 +12,13 @@ module Beaker
     # - only if we are running with ---provision
     # - only if we have a hypervisor
     # - only if either the specific hosts has no specification or has 'provision' in its config
-    # - always if it is a vagrant box (vagrant boxes are always provisioned as they always need ssh key hacking)
+    # - always if it is a vagrant or docker box (vagrant boxes are always provisioned
+    #     as they always need ssh key hacking. docker boxes need to have docker_container_name
+    #     specified)
     def provision? options, host
       command_line_says = options[:provision]
       host_says = host['hypervisor'] && (host.has_key?('provision') ? host['provision'] : true)
-      (command_line_says && host_says) or (host['hypervisor'] =~/vagrant/)
+      (command_line_says && host_says) or (host['hypervisor'] =~/(vagrant|docker)/)
     end
 
     def initialize(options, logger)

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '2.37.0'
+    STRING = '2.38.0'
   end
 end

data/spec/beaker/host/cisco_spec.rb

@@ -24,32 +24,24 @@ module Cisco
           vrf_answer = 'vrf_answer_135246'
           @options = {
             :vrf  => vrf_answer,
-            :user => 'notroot',
           }
           answer_test = host.prepend_commands( 'fake_command' )
-          expect( answer_test ).to match( /#{vrf_answer}$/ )
+          expect( answer_test ).to match( /ip netns exec #{vrf_answer}$/ )
         end
 
-        it 'begins with sourcing the /etc/profile script' do
-          answer_test = host.prepend_commands( 'fake_command' )
-          expect( answer_test ).to match( 'source /etc/profile;' )
+        it 'guards against "vsh" usage (only scenario we dont want prefixing)' do
+          answer_prepend_commands = 'pc_param_unchanged_13584'
+          answer_test = host.prepend_commands( 'fake/vsh/command', answer_prepend_commands )
+          expect( answer_test ).to be === answer_prepend_commands
         end
 
-        it 'uses sudo at the beginning of the actual command to execute' do
+        it 'retains user-specified prepend commands when adding vrf' do
           @options = {
             :vrf  => 'fakevrf',
-            :user => 'notroot',
           }
-          answer_test = host.prepend_commands( 'fake_command' )
-          command_start_index = answer_test.index( ';' ) + 1
-          command_actual = answer_test[command_start_index, answer_test.length - command_start_index]
-          expect( command_actual ).to match( /^sudo / )
-        end
-
-        it 'guards against "vsh" usage (only scenario we dont want prefixing)' do
-          answer_prepend_commands = 'pc_param_unchanged_13584'
-          answer_test = host.prepend_commands( 'fake/vsh/command', answer_prepend_commands )
-          expect( answer_test ).to be === answer_prepend_commands
+          answer_prepend_commands = 'prepend'
+          answer_test = host.prepend_commands( 'fake_command', answer_prepend_commands )
+          expect( answer_test ).to match( /^ip netns exec fakevrf #{answer_prepend_commands}/ )
         end
       end
 
@@ -59,52 +51,101 @@ module Cisco
           @platform = 'cisco_ios_xr-6-x86_64'
         end
 
-        it 'begins with sourcing the /etc/profile script' do
-          answer_test = host.prepend_commands( 'fake_command' )
-          expect( answer_test ).to match( /^#{Regexp.escape('source /etc/profile;')}/ )
-        end
-
-        it 'does not use sudo, as root is allowed' do
+        it 'does use the :vrf host parameter if provided' do
+          @options = { :vrf => 'tpnns' }
           answer_test = host.prepend_commands( 'fake_command' )
-          expect( answer_test ).not_to match( /sudo/ )
+          expect( answer_test ).to match( /ip netns exec tpnns/ )
         end
 
-        it 'does prepend with the :vrf host parameter' do
-          expect( host ).to receive( :[] ).with( :vrf )
-          host.prepend_commands( 'fake_command' )
+        it 'retains user-specified prepend commands when adding vrf' do
+          @options = { :vrf  => 'fakevrf', }
+          answer_prepend_commands = 'prepend'
+          answer_test = host.prepend_commands( 'fake_command', answer_prepend_commands )
+          expect( answer_test ).to match( /^ip netns exec fakevrf #{answer_prepend_commands}/ )
         end
-
       end
     end
 
     describe '#environment_string' do
 
-      it 'starts with `env` for cisco_ios_xr-6' do
-        @platform = 'cisco_ios_xr-6-x86'
-        env_map = { 'PATH' => '/opt/pants/1' }
-        answer_test = host.environment_string( env_map )
-        expect( answer_test ).to match( /^env\ / )
+      it 'starts with sourcing the /etc/profile script' do
+        answer_test = host.environment_string( {} )
+        expect( answer_test ).to match( %r{^source /etc/profile;} )
       end
 
-      it 'starts with `export` for cisco_nexus-7' do
-        @platform = 'cisco_nexus-7-x86_64'
-        env_map = { 'PATH' => '/opt/pants/2' }
-        answer_test = host.environment_string( env_map )
-        expect( answer_test ).to match( /^export\ / )
+      it 'uses `sudo` if not root' do
+        @options = { :user => 'notroot' }
+        answer_test = host.environment_string( {} )
+        expect( answer_test ).to match( /sudo/ )
       end
 
-      it 'ends with a semi-colon' do
-        env_map = { 'PATH' => '/opt/pants/3' }
-        answer_test = host.environment_string( env_map )
-        expect( answer_test ).to match( /\;$/ )
+      context 'for cisco_nexus-7' do
+
+        before :each do
+          @platform = 'cisco_nexus-7-x86_64'
+        end
+
+        it 'uses `sudo` if not root' do
+          @options = { :user => 'notroot' }
+          env_map = { 'PATH' => '/opt/pants/2' }
+          answer_test = host.environment_string( env_map )
+          expect( answer_test ).to match( %r{^source /etc/profile; sudo } )
+        end
+
+        it 'uses `export` if root' do
+          @options = { :user => 'root' }
+          env_map = { 'PATH' => '/opt/pants/2' }
+          answer_test = host.environment_string( env_map )
+          expect( answer_test ).to match( %r{^source /etc/profile; export } )
+        end
+
+        it 'ends with a semi-colon' do
+          env_map = { 'PATH' => '/opt/pants/3' }
+          answer_test = host.environment_string( env_map )
+          expect( answer_test ).to match( /\;$/ )
+        end
+
+        it 'turns env maps into paired strings correctly' do
+          @options = { :user => 'root' }
+          env_map = { 'var1' => 'ans1', 'var2' => 'ans2' }
+          answer_correct = 'source /etc/profile; export VAR1="ans1" VAR2="ans2";'
+          answer_test = host.environment_string( env_map )
+          expect( answer_test ).to be === answer_correct
+        end
       end
 
-      it 'turns env maps into paired strings correctly' do
-        @platform = 'cisco_ios_xr-6-x86_64'
-        env_map = { 'var1' => 'ans1', 'var2' => 'ans2' }
-        answer_correct = 'env VAR1="ans1" VAR2="ans2";'
-        answer_test = host.environment_string( env_map )
-        expect( answer_test ).to be === answer_correct
+      context 'for cisco_ios_xr-6' do
+        before :each do
+          @platform = 'cisco_ios_xr-6-x86_64'
+        end
+
+        it 'uses `sudo` if not root' do
+          @options = { :user => 'notroot' }
+          env_map = { 'PATH' => '/opt/pants/2' }
+          answer_test = host.environment_string( env_map )
+          expect( answer_test ).to match( %r{^source /etc/profile; sudo } )
+        end
+
+        it 'uses `env` if root' do
+          @options = { :user => 'root' }
+          env_map = { 'PATH' => '/opt/pants/1' }
+          answer_test = host.environment_string( env_map )
+          expect( answer_test ).to match( %r{^source /etc/profile; env } )
+        end
+
+        it 'does not end with a semi-colon' do
+          env_map = { 'PATH' => '/opt/pants/3' }
+          answer_test = host.environment_string( env_map )
+          expect( answer_test ).not_to match( /\;$/ )
+        end
+
+        it 'turns env maps into paired strings correctly' do
+          @options = { :user => 'root' }
+          env_map = { 'var1' => 'ans1', 'var2' => 'ans2' }
+          answer_correct = 'source /etc/profile; env VAR1="ans1" VAR2="ans2"'
+          answer_test = host.environment_string( env_map )
+          expect( answer_test ).to be === answer_correct
+        end
       end
     end
 
@@ -191,4 +232,4 @@ module Cisco
       end
     end
   end
-end
+end

data/spec/beaker/hypervisor/docker_spec.rb

@@ -34,6 +34,7 @@ module Beaker
     let(:options) {{
       :logger => logger,
       :forward_ssh_agent => true,
+      :provision => true
     }}
 
     let(:image) do
@@ -66,6 +67,7 @@ module Beaker
       })
       allow( container ).to receive(:stop)
       allow( container ).to receive(:delete)
+      allow( container ).to receive(:exec)
       container
     end
 
@@ -181,8 +183,6 @@ module Beaker
           container_name = "spec-container-#{index}"
           host['docker_container_name'] = container_name
 
-          expect( ::Docker::Container ).to receive(:all).and_return([])
-
           expect( ::Docker::Container ).to receive(:create).with({
             'Image' => image.id,
             'Hostname' => host.name,
@@ -193,17 +193,6 @@ module Beaker
         docker.provision
       end
 
-      it 'should not create a container if a named one already exists' do
-        hosts.each_with_index do |host, index|
-          container_name = "spec-container-#{index}"
-          host['docker_container_name'] = container_name
-
-          expect( ::Docker::Container ).to receive(:all).and_return([container])
-          expect( ::Docker::Container ).not_to receive(:create)
-        end
-
-        docker.provision
-      end
 
       it 'should create a container with volumes bound' do
         hosts.each_with_index do |host, index|
@@ -305,6 +294,38 @@ module Beaker
         expect( hosts[0]['docker_image'] ).to be === image
         expect( hosts[0]['docker_container'] ).to be === container
       end
+
+      context 'provision=false' do
+        let(:options) {{
+          :logger => logger,
+          :forward_ssh_agent => true,
+          :provision => false
+        }}
+
+
+        it 'should fix ssh' do
+          hosts.each_with_index do |host, index|
+            container_name = "spec-container-#{index}"
+            host['docker_container_name'] = container_name
+
+            expect( ::Docker::Container ).to receive(:all).and_return([container])
+            expect(container).to receive(:exec).exactly(3).times
+          end
+          docker.provision
+        end
+
+        it 'should not create a container if a named one already exists' do
+          hosts.each_with_index do |host, index|
+            container_name = "spec-container-#{index}"
+            host['docker_container_name'] = container_name
+
+            expect( ::Docker::Container ).to receive(:all).and_return([container])
+            expect( ::Docker::Container ).not_to receive(:create)
+          end
+
+          docker.provision
+        end
+      end
     end
 
     describe '#cleanup' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker
 version: !ruby/object:Gem::Version
-  version: 2.37.0
+  version: 2.38.0
 platform: ruby
 authors:
 - Puppetlabs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-15 00:00:00.000000000 Z
+date: 2016-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec