beaker 3.13.0 → 3.14.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDRiMDdjNTBhMTU4NTljNWFmZDM1MDNhZjk0ZDI1MjJiNWI2YzE5ZQ==
+    NjhmMGI0YmEzZmIzMGM1MjM3ZjU5MzZiZWE0OGNmMzYyNTc4MmJjZA==
   data.tar.gz: !binary |-
-    NzI4NDM0YTE4ZDMxZWEwODU0YTM1ODQ5YTcwNzIwNjM4YTgzYzU2ZA==
+    Y2IzYjA2YjBiZGQ1MmI4MGFlNDgxNDM0NDFlMTlmY2Q5ZTEyOWM5MA==
 SHA512:
   metadata.gz: !binary |-
-    MzQ4NmY3MzljYjJmZTk3ZWU4OTFlODc1Nzk4ZDAxZjAxMjlkZGM0ZTg3ZTQx
-    MjNlMzQzY2JkNGFmNDU4ZmRiYTE2YjYyNTQyMzRiOGY2NjI1YWYzY2ZjYWIx
-    ZmFiN2Q3MjFlMTgwOGNkMmM2YzU5ZTAxYTc5YmM0NjU4MjAyYjc=
+    OTRlZThiZGY3ODViOWNiZmI0Y2VmZWEwYzRlOGUwZDVkZDQ4ZTdlYTc3NmI3
+    NWQ3NzYyYjU3MDA1YTkwYmViYzk1MWZkNGY0NWYyNjM1NGI0ZDU2YzU4ZWJm
+    ZGMxMDJlNDc5ZWRmMDZjZmU4NjU0OWI2NWRiNjg2Njk0ZDg1N2M=
   data.tar.gz: !binary |-
-    MTFmYWUzMTQ3NTc1MzZiNmUyYzdmOTBmNmU2YjIxYjBhMTQ2ODI1NmQzMzc4
-    NzRkODcyYmYwNWZiOTA4NTJiYTZkNTEwMDI3MmU1NzVjNTM3MjY1NzdiNWU5
-    NGQwOGQ2NGJlYTAxYjExYzRhMTQyOTY3ZmVhMDc2OTk1NjllMzg=
+    OGNjYjc4NTY1N2ExYTQ4NzlkYjE3NjJkMmYzM2NhZTI0NDc0MWE1MWYwZmFh
+    ODE5OTUwMjA3Mzk0YTJhYWUyZTg3NDkwYTJhYTgyOWYxNjM1Yzk0OTUwZTJk
+    ODhiZDA2YzRkN2ZlOTU5ZmZlOGVkMmU0OGJjYzQ2NTQ2OTE2YzI=

data/acceptance/tests/subcommands/destroy.rb

@@ -0,0 +1,49 @@
+test_name 'use the destroy subcommand' do
+
+  def delete_root_folder_contents
+    on default, 'rm -rf /root/* /root/.beaker'
+  end
+
+  step 'ensure that `beaker destroy` fails correctly when a configuration has not been initialized' do
+    delete_root_folder_contents
+    result = on(default, 'beaker destroy', :accept_all_exit_codes => true)
+    assert_match(/Please provision an environment/, result.stdout)
+    assert_equal(1, result.exit_code, '`beaker destroy` in an uninitialised configuration should return a non-zero exit code')
+  end
+
+  step 'ensure that `beaker help destroy` works' do
+    result = on(default, 'beaker help destroy')
+    assert_match(/Usage/, result.stdout)
+    assert_equal(0, result.exit_code, '`beaker help destroy` should return a zero exit code')
+  end
+
+  step 'ensure that `beaker destroy --help` works' do
+    result = on(default, 'beaker destroy --help')
+    assert_match(/Usage/, result.stdout)
+    assert_equal(0, result.exit_code, '`beaker destroy --help` should return a zero exit code')
+  end
+
+  step 'ensure that `beaker destroy` destroys vmpooler configuration' do
+     delete_root_folder_contents
+     result = on(default, "beaker init --hosts centos6-64")
+     assert_match(/Writing configured options to disk/, result.stdout)
+     assert_equal(0, result.exit_code, "`beaker init` should return a zero exit code")
+     step 'ensure destroy fails to run against an unprovisioned environment' do
+       result = on(default, "beaker destroy", :accept_all_exit_codes => true)
+       assert_match(/Please provision an environment/, result.stdout)
+       assert_equal(1, result.exit_code, "`beaker destroy` should return a non zero exit code")
+     end
+     step 'ensure provision provisions, validates, and configures new hosts' do
+       result = on(default, "beaker provision")
+       assert_match(/Using available host/, result.stdout)
+       assert_equal(0, result.exit_code, "`beaker provision` should return a zero exit code")
+     end
+     step 'ensure destroy will destroy a provisioned environment' do
+       result = on(default, 'beaker destroy')
+       assert_match(/Handing/, result.stdout)
+       assert_equal(0, result.exit_code, "`beaker destroy` should return a zero exit code")
+     end
+    delete_root_folder_contents
+  end
+
+end

data/acceptance/tests/subcommands/exec.rb

@@ -0,0 +1,33 @@
+test_name 'use the exec subcommand' do
+
+  def delete_root_folder_contents
+    on default, 'rm -rf /root/* /root/.beaker'
+  end
+
+  step 'ensure the workspace is clean' do
+    delete_root_folder_contents
+  end
+
+  step 'run init and provision to set up the system' do
+    on default, 'beaker init --hosts centos6-64; beaker provision'
+    subcommand_state = on(default, 'cat .beaker/.subcommand_state.yaml').stdout
+    subcommand_state = YAML.parse(subcommand_state).to_ruby
+    assert_equal(true, subcommand_state['provisioned'])
+  end
+
+  step 'create a test dir and populate it with tests' do
+    on default, 'mkdir -p testing_dir'
+  end
+
+  step 'create remote test file' do
+    testfile = <<-TESTFILE
+    on(agents, 'echo hello world')
+    TESTFILE
+    create_remote_file(default, '/root/testing_dir/testfile1.rb', testfile)
+  end
+
+  step 'specify that remote file with beaker exec' do
+    result = on(default, 'beaker exec testing_dir/testfile1.rb --log-level verbose')
+    assert_match(/hello world/, result.stdout)
+  end
+end

data/acceptance/tests/subcommands/init.rb

@@ -1,48 +1,24 @@
 test_name 'use the init subcommand' do
 
+  SubcommandUtil = Beaker::Subcommands::SubcommandUtil
   def delete_root_folder_contents
     on default, 'rm -rf /root/* /root/.beaker'
   end
 
-  step 'ensure that `beaker init` exit value should be 1 when not provided with a supported hypervisor' do
-    result = on(default, 'beaker init ec2', :accept_all_exit_codes => true)
-    assert_match(/Invalid hypervisor. Currently supported hypervisors are.+/, result.stdout)
-    refute_equal(0, result.exit_code, '`beaker init` with an unsupported hypervisor argument should return a non-zero exit code')
-	end
-
-  step 'ensure that `beaker help init` works' do
-    result = on(default, 'beaker help init')
-    assert_match(/Usage+/, result.stdout)
-  end
-
-  step 'ensure that `beaker init --help` works' do
-    result = on(default, 'beaker init --help')
-    assert_match(/Usage.+/, result.stdout)
-    assert_equal(0, result.exit_code, '`beaker init --help` should return a zero exit code')
-  end
-
-  step 'ensure that `beaker init` accepts no argument as well as accepts either vmpooler or vagrant hypervisor arguments' do
-    ['vmpooler', 'vagrant', ''].each do |hypervisor|
-      result = on(default, "beaker init #{hypervisor}")
-      assert_match(/Writing host config.+/, result.stdout)
-      step 'ensure that the Rakefile is present' do
-        on(default, '[ -e "Rakefile" ]')
-      end
+  step 'ensure beaker init writes YAML configuration files to disk' do
     delete_root_folder_contents
-    end
+    on(default, 'beaker init')
+    subcommand_options = on(default, "cat #{SubcommandUtil::SUBCOMMAND_OPTIONS}").stdout
+    subcommand_state = on(default, "cat #{SubcommandUtil::SUBCOMMAND_STATE}").stdout
+    assert(YAML.parse(subcommand_options).to_ruby.class == Hash)
+    assert(YAML.parse(subcommand_state).to_ruby.class == Hash)
   end
 
-  step 'ensure that a Rakefile is not overwritten if it does exist prior' do
-    delete_root_folder_contents
-    on(default, "beaker init vmpooler")
-    prepended_rakefile = on(default, 'cat Rakefile').stdout
+  step 'ensure beaker init saves beaker-run arguments to the subcommand_options.yaml' do
     delete_root_folder_contents
-    on(default, 'echo "require \'tempfile\'" >> Rakefile')
-    on(default, 'beaker init vmpooler', :accept_all_exit_codes => true)
-    rakefile = on(default, 'cat Rakefile')
-
-    # Assert that the Rakefile contents includes the original and inserted requirements
-    assert(result.stdout.include?(prepended_rakefile), 'Rakefile should not contain prepended require')
-    assert(result.stdout.include?("require 'tempfile'"), 'Rakefile should not contain prepended require')
+    on(default, 'beaker init --log-level verbose')
+    subcommand_options = on(default, "cat #{SubcommandUtil::SUBCOMMAND_OPTIONS}").stdout
+    hash = YAML.parse(subcommand_options).to_ruby
+    assert_equal('verbose', hash['log_level'])
   end
 end

data/acceptance/tests/subcommands/provision.rb

@@ -1,45 +1,19 @@
 test_name 'use the provision subcommand' do
 
+  SubcommandUtil = Beaker::Subcommands::SubcommandUtil
+
   def delete_root_folder_contents
     on default, 'rm -rf /root/* /root/.beaker'
   end
 
-  step 'ensure that `beaker provision` fails correctly when a configuration has not been initialized' do
+  step 'run beaker init and provision' do
     delete_root_folder_contents
-    result = on(default, 'beaker provision', :accept_all_exit_codes => true)
-    assert_match(/Please initialise a configuration/, result.stdout)
-    refute_equal(0, result.exit_code, '`beaker provision` in an uninitialised configuration should return a non-zero exit code')
-  end
-
-  step 'ensure that `beaker help provision` works' do
-    result = on(default, 'beaker help provision')
-    assert_match(/Usage/, result.stdout)
-    assert_equal(0, result.exit_code, '`beaker help provision` should return a zero exit code')
-  end
+    on(default, 'beaker init')
+    result = on(default, 'beaker provision --hosts centos6-64')
+    assert_match(/Using available host/, result.stdout)
 
-  step 'ensure that `beaker provision --help` works' do
-    result = on(default, 'beaker provision --help')
-    assert_match(/Usage/, result.stdout)
-    assert_equal(0, result.exit_code, '`beaker provision --help` should return a zero exit code')
+    subcommand_state = on(default, "cat #{SubcommandUtil::SUBCOMMAND_STATE}").stdout
+    subcommand_state = YAML.parse(subcommand_state).to_ruby
+    assert_equal(true, subcommand_state['provisioned'])
   end
-
-  step 'ensure that `beaker provision` provisions vmpooler configuration' do
-     result = on(default, "beaker init vmpooler")
-     assert_match(/Writing host config/, result.stdout)
-     assert_equal(0, result.exit_code, "`beaker init vmpooler` should return a zero exit code")
-     step 'ensure that the Rakefile is present' do
-       on(default, '[ -e "Rakefile" ]')
-     end
-     step 'ensure provision provisions, validates, and configures new hosts' do
-       result = on(default, "beaker provision")
-       assert_equal(0, result.exit_code, "`beaker provision` should return a zero exit code")
-     end
-     step 'ensure provision will not provision new hosts if hosts have already been provisioned' do
-       result = on(default, 'beaker provision')
-       assert_match(/Hosts have already been provisioned/, result.stdout)
-       assert_equal(0, result.exit_code, "`beaker provision` should return a zero exit code")
-     end
-    delete_root_folder_contents
-  end
-
 end

data/beaker.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'fakefs', '~> 0.6'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'pry', '~> 0.10'
+  s.add_development_dependency 'rake', '~> 10.0'
 
   # Documentation dependencies
   s.add_development_dependency 'yard', '< 0.9.6'
@@ -38,11 +39,10 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'net-scp', '~> 1.2'
   s.add_runtime_dependency 'inifile', '~> 3.0'
 
-  s.add_runtime_dependency 'rake', '~> 10.0'
   s.add_runtime_dependency 'rsync', '~> 1.0.9'
   s.add_runtime_dependency 'open_uri_redirections', '~> 0.2.1'
   s.add_runtime_dependency 'in-parallel', '~> 0.1'
-  s.add_runtime_dependency 'thor', '0.19.1'
+  s.add_runtime_dependency 'thor', '~> 0.19'
 
   # Run time dependencies that are Beaker libraries
   s.add_runtime_dependency 'stringify-hash', '~> 0.0'

data/bin/beaker

@@ -6,7 +6,7 @@ require 'beaker'
 if Beaker::Subcommands::SubcommandUtil.execute_subcommand?(ARGV[0])
   Beaker::Subcommand.start(ARGV)
 else
-  Beaker::CLI.new.parse_options.execute!
+  Beaker::CLI.new.parse_options.provision.execute!
   puts "Beaker completed successfully, thanks."
 end
 

data/docs/how_to/cloning_private_repos.md

@@ -0,0 +1,3 @@
+# Cloning private repos
+
+If you need to clone private repos when running Beaker acceptance tests, please refer to the [enabling cross SUT access](enabling_cross_sut_access.md) document

data/docs/how_to/enabling_cross_sut_access.md

@@ -0,0 +1,23 @@
+# Enabling access bewteen SUTs during an acceptance test run
+
+If you are running acceptance tests for Beaker that, at some point, will perform one of the following:
+
+* SSH between SUTs
+* Clone private repos
+
+You will need to run an SSH agent, and add the SSH key for accessing your SUTs/private repos, prior to running the tests.
+
+To load the SSH agent and add your SSH key, run the following:
+
+~~~bash
+eval `ssh-agent`
+ssh-add <SSH key file path>
+~~~
+  
+A common example of where this functionality would be required for beaker developers, is in testing subcommands. There, we setup multiple SUTs that need to communicate between themselves. To run our subcommand testing to verify that you have agent forwarding setup correctly, run the following:
+
+~~~bash
+beaker --tests acceptance/tests/subcommands/ --log-level debug --preserve-hosts onfail --pre-suite acceptance/pre_suite/subcommands/ --load-path acceptance/lib --keyfile ~/.ssh/id_rsa-acceptance
+~~~
+
+And Beaker will be able to SSH between SUTs and clone private repos

data/docs/how_to/ssh_agent_forwarding.md

@@ -29,3 +29,7 @@ vcsrepo { '/var/www/app':
   user     => 'deploy'
 }
 ~~~
+
+## Cross SUT access
+
+If you need to be able to SSH between SUTs while running Beaker acceptance tests, please refer to the [enabling cross SUT access](enabling_cross_sut_access.md) document

data/lib/beaker/cli.rb

@@ -9,7 +9,7 @@ module Beaker
     |   V   |
     |   |   | "
 
-    attr_reader :logger
+    attr_reader :logger, :options, :network_manager
     def initialize
       @timestamp = Time.now
       # Initialize a logger object prior to parsing; this should be overwritten whence
@@ -71,16 +71,29 @@ module Beaker
 
     #Provision, validate and configure all hosts as defined in the hosts file
     def provision
+      # return self if only invoking the OptionsParser help
+      return self if @options[:help]
+
       begin
         @hosts =  []
-        @network_manager = Beaker::NetworkManager.new(@options, @logger)
-        @hosts = @network_manager.provision
+        initialize_network_manager
         @network_manager.proxy_package_manager
         @network_manager.validate
         @network_manager.configure
       rescue => e
         report_and_raise(@logger, e, "CLI.provision")
       end
+      self
+    end
+
+    #Initialize the network manager so it can initialize hosts for testing for subcommands
+    def initialize_network_manager
+      begin
+        @network_manager = Beaker::NetworkManager.new(@options, @logger)
+        @hosts = @network_manager.provision
+      rescue => e
+        report_and_raise(@logger, e, "CLI.initialize_network_manager")
+      end
     end
 
     #Run Beaker tests.
@@ -103,8 +116,6 @@ module Beaker
           exit(1)
         end
 
-        provision
-
         # Setup perf monitoring if needed
         if @options[:collect_perf_data].to_s =~ /(aggressive)|(normal)/
           @perf = Beaker::Perf.new( @hosts, @options )
@@ -194,6 +205,18 @@ module Beaker
       ).run_and_raise_on_failure
     end
 
+    # Get the list of options that are not equal to presets.
+    # @return Beaker::Options::OptionsHash
+    def configured_options
+      result = Beaker::Options::OptionsHash.new
+      @attribution.each do |attribute, setter|
+        if setter != 'preset'
+          result[attribute] = @options[attribute]
+        end
+      end
+      result
+    end
+
     # Sets aside the current hosts file for re-use with the --no-provision flag.
     # This is originally intended for use on a successful tests where the hosts
     # are preserved (the --preserve-hosts option is set accordingly).
@@ -211,6 +234,22 @@ module Beaker
       @options[:pre_cleanup] = []
       preserved_hosts_filename = File.join(@options[:log_dated_dir], 'hosts_preserved.yml')
 
+      hosts_yaml = @options
+      hosts_yaml['HOSTS'] = combined_instance_and_options_hosts
+      hosts_yaml['CONFIG'] = Beaker::Options::OptionsHash.new.merge(hosts_yaml['CONFIG'] || {})
+      # save the rest of the options, excepting the HOSTS that we have already processed
+      hosts_yaml['CONFIG'] = hosts_yaml['CONFIG'].merge(@options.reject{ |k,v| k =~ dontpreserve })
+      # remove copy of HOSTS information
+      hosts_yaml['CONFIG']['provision'] = false
+      File.open(preserved_hosts_filename, 'w') do |file|
+        YAML.dump(hosts_yaml, file)
+      end
+      @options[:hosts_preserved_yaml_file] = preserved_hosts_filename
+    end
+
+    # Return a host_hash that is a merging of options host hashes with instance host objects
+    # @return Hash
+    def combined_instance_and_options_hosts
       hosts_yaml = @options
       newly_keyed_hosts_entries = {}
       hosts_yaml['HOSTS'].each do |host_name, file_host_hash|
@@ -223,16 +262,7 @@ module Beaker
           end
         end
       end
-      hosts_yaml['HOSTS'] = newly_keyed_hosts_entries
-      hosts_yaml['CONFIG'] = Beaker::Options::OptionsHash.new.merge(hosts_yaml['CONFIG'] || {})
-      # save the rest of the options, excepting the HOSTS that we have already processed
-      hosts_yaml['CONFIG'] = hosts_yaml['CONFIG'].merge(@options.reject{ |k,v| k =~ dontpreserve })
-      # remove copy of HOSTS information
-      hosts_yaml['CONFIG']['provision'] = false
-      File.open(preserved_hosts_filename, 'w') do |file|
-        YAML.dump(hosts_yaml, file)
-      end
-      @options[:hosts_preserved_yaml_file] = preserved_hosts_filename
+     newly_keyed_hosts_entries
     end
 
     # Prints all information required to reproduce the current run & results to the log

data/lib/beaker/host.rb

@@ -139,7 +139,7 @@ module Beaker
       host_hash[k] = v
     end
 
-    # Does this host have this key?  Either as defined in the host itself, or globally? 
+    # Does this host have this key?  Either as defined in the host itself, or globally?
     def [] k
       host_hash[k] || options[k]
     end

data/lib/beaker/hypervisor.rb

@@ -20,6 +20,7 @@ module Beaker
     def self.create(type, hosts_to_provision, options)
       @logger = options[:logger]
       @logger.notify("Beaker::Hypervisor, found some #{type} boxes to create")
+
       hyper_class = case type
         when /^aix$/
           Beaker::Aixer
@@ -74,7 +75,7 @@ module Beaker
         end
 
       hypervisor = hyper_class.new(hosts_to_provision, options)
-      hypervisor.provision
+      hypervisor.provision if options[:provision]
 
       hypervisor
     end

data/lib/beaker/network_manager.rb

@@ -21,6 +21,8 @@ module Beaker
       (command_line_says && host_says) or (host['hypervisor'] =~/(vagrant|docker)/)
     end
 
+    attr_accessor :hosts, :hypervisors
+
     def initialize(options, logger)
       @logger = logger
       @options = options
@@ -56,7 +58,9 @@ module Beaker
       @options['HOSTS'].each_key do |name|
         host_hash = @options['HOSTS'][name]
         hypervisor = host_hash['hypervisor']
-        hypervisor = provision?(@options, host_hash) ? host_hash['hypervisor'] : 'none'
+        if @options[:provision]
+          hypervisor = provision?(@options, host_hash) ? host_hash['hypervisor'] : 'none'
+        end
         @logger.debug "Hypervisor for #{name} is #{hypervisor}"
         @machines[hypervisor] = [] unless @machines[hypervisor]
         hostless_options[:timesync] = host_hash[:timesync] if host_hash[:timesync]!=nil