beaker 3.17.0 → 3.18.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTlmZTY1M2UyMzhmMzVjOWYzZWM0M2MxMmYzZWU3YzBmZmQ3MmE3MA==
+    ZWRlZjc1Y2Y2YTk4YjdmZjBjMWE4OGYxNWQ0YzFjNjllYjRmNGI2NQ==
   data.tar.gz: !binary |-
-    Y2NhNzU3MmUwMmM3NWEyYjlkN2ZiMzFjN2YxMzM3NWMyZTY1NTEyZA==
+    ZjQ4ZjYxNTFkZGU4NjVhMzBjOGRhYzc1NTM1NWNhYzE2YTA2NzkxZA==
 SHA512:
   metadata.gz: !binary |-
-    Nzk5NTRhYjBjMDIxNWI5OGRkMGMzMzY3MDZkODJjMDNjODVkZjJhNTQzZjY5
-    MmUwOTE1NGYxNjEzYWU2YTgwN2IxNjJjYzczNWNmOWNmYTA3Y2JjZjBiNDZi
-    ODIzNmM3YjQyNjJlM2ZjNGJkYmY4MjI1NjZlYTQ0YTEyY2M0YTk=
+    MDVjMzVlYjg2MjYyYjM5NjUwYzQ4ZmVhYjk1NDY4MDJlZWQ5YTYzOTZlM2Ey
+    MTM0NDFmNDRjODhkN2RkOTBlMGFmNGJkMGIzY2RmYmZhZDY1NDVjZGVkNjg0
+    YmI5ODIzOTRmMTE1MmRlYjNhZmM1MGRkMjZkNzIzZTYyMTRjMDM=
   data.tar.gz: !binary |-
-    MTRmODZkMTQxOGYwYTIzMjRiYjgzMmUyNThkNGExMDBiYjNlMzg0NmY1YWEy
-    NDMwYmQ5MWVlNzQyNjI5NzU4NDYyNzMwY2U2NjhjNmFkNzA3YzYyYzFhNGJh
-    NGU0NmYyZmM1NWU5NjU5NzUzMzJhNDBiNzJjNjk5ZjRiZGI1MmI=
+    YTc4ZDBkYjYzM2E1NGYzZWVjMWQ4ZjRiMWVhMzhjZDlhYjYwNzY2ODhiMjli
+    MzA3MGYxNjVlOTk5NDllMWM3ZjI3YzVhMTFhODM1ODAxYzAwYjUxMzI0YTcx
+    OTU4Y2U3NTFlNWIyZWE2M2EzNDJhZmZiODg1NjZiNTY4MjZjYzg=

data/README.md

@@ -32,7 +32,7 @@ works and how to use it but assume that you have a basic understanding of key co
 involved in addressing key problems and use-cases. They are more advanced than
 tutorials and assume some knowledge of how Beaker works.
 
-#Beaker Libraries
+# Beaker Libraries
 
 Beaker functionality has been extended through the use of libraries available as
 gems. See the [complete list](docs/concepts/beaker_libraries.md) for available

data/acceptance/tests/subcommands/init.rb

@@ -5,18 +5,25 @@ test_name 'use the init subcommand' do
     on default, 'rm -rf /root/* /root/.beaker'
   end
 
+  step 'ensure beaker init requires hosts flag' do
+    result = on(default, 'beaker init')
+    assert_match(/No value(.+)--hosts/, result.raw_output)
+  end
+
   step 'ensure beaker init writes YAML configuration files to disk' do
     delete_root_folder_contents
-    on(default, 'beaker init')
+    on(default, 'beaker init --hosts centos6-64')
     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)
+    parsed_options = YAML.parse(subcommand_options).to_ruby
+    assert(parsed_options["HOSTS"].count == 1)
+    assert(parsed_options.class == Hash)
     assert(YAML.parse(subcommand_state).to_ruby.class == Hash)
   end
 
   step 'ensure beaker init saves beaker-run arguments to the subcommand_options.yaml' do
     delete_root_folder_contents
-    on(default, 'beaker init --log-level verbose')
+    on(default, 'beaker init --log-level verbose --hosts centos6-64')
     subcommand_options = on(default, "cat #{SubcommandUtil::SUBCOMMAND_OPTIONS}").stdout
     hash = YAML.parse(subcommand_options).to_ruby
     assert_equal('verbose', hash['log_level'])

data/acceptance/tests/subcommands/provision.rb

@@ -8,10 +8,11 @@ test_name 'use the provision subcommand' do
 
   step 'run beaker init and provision' do
     delete_root_folder_contents
-    on(default, 'beaker init')
     result = on(default, 'beaker provision --hosts centos6-64')
+    assert_match(/ERROR(.+)--hosts/, result.raw_output)
+    on(default, 'beaker init --hosts centos6-64')
+    result = on(default, 'beaker provision')
     assert_match(/Using available host/, result.stdout)
-
     subcommand_state = on(default, "cat #{SubcommandUtil::SUBCOMMAND_STATE}").stdout
     subcommand_state = YAML.parse(subcommand_state).to_ruby
     assert_equal(true, subcommand_state['provisioned'])

data/docs/how_to/run_in_parallel.md

@@ -42,7 +42,7 @@ def some_method_call
     return "some_method_call"
 end
 
-def some_method_call
+def some_other_method_call
     return "some_other_method_call"
 end
 

data/docs/tutorials/lets_write_a_test.md

@@ -1,74 +1,82 @@
 ## The Task
 
-Consider if mcollectived incorrectly spawned a new process with every puppet agent run on Ubuntu 10.04.  We need an acceptance test to check that a new process is not spawned and to ensure that this issue does not regress in new builds.
+We will write a test to check if a package (specifically HTTPD) is installed and running. To do this we will write two files:
+1. `install.rb` - This file will install the package and start the service
+2. `mytest.rb` - This file will have our core tests that checks if the package is installed and running
 
-## Figure Out Test Steps
+Note: We will exclude Windows OS from our testing due to variation of package name.
+
+## Figure out steps
 
 What needs to happen in this test:
 
-* Install PE
-* Restart mcollective twice
-* Check to see if more than one mcollective process is running
+* Install and run HTTPD
+  * Install HTTPD if its not available on our SUT
+  * Start HTTPD service
+* Testing
+  * Test HTTPD is installed
+  * Test HTTPD service is running
 
 ## Create a host configuration file
-    $ beaker-hostgenerator redhat7-64ma > redhat7-64ma.yaml
-
-## Install PE
-
-We prefer to install PE once and then run a set of tests, so PE installation should not be part of the actual acceptance test.
+    $ beaker-hostgenerator redhat7-64 > redhat7-64.yaml
 
-    $ mkdir setup
-    $ cd setup
-    $ cat > install.rb << RUBY
-    test_name "Installing Puppet Enterprise" do
-    install_pe
-    RUBY
-    $ cd ..
+This command will generate a host file for our system under test (SUT). It will use vmpooler as hypervisor for the host. Please check out [this](https://github.com/puppetlabs/beaker/tree/master/docs/how_to/hypervisors) doc to learn more about hypervisors for beaker.
 
-This places our install steps in a ruby script (install.rb) which will run on localhost, but the #install_pe method knows where to install puppet enterprise based on the host configuration in use.
-The install.rb script is used in our commandline to beaker, below.
-
-## Create a test file
+## Install and run HTTPD
 
-We need to create a test file to run.
+Make a file named `install.rb` and put the following code into it:
 
-### Define some test commands to run
-#### Restart mcollective twice
+```ruby
+test_name "Installing and runnning HTTPD" do
 
-Here's our magic command that restarts mcollective:
+  # Don't run the install script on the following platform
+  confine :except, :platform => 'windows'
 
-    restart_command = "bash -c '[[ -x /etc/init.d/pe-mcollective ]] && /etc/init.d/pe-mcollective restart'"
+  step "Install HTTPD" do
+    hosts.each do |host|
+      # Install HTTPD if it is not available on our SUT
+      install_package(host, 'httpd') unless check_for_package(host, 'httpd')
+    end
+  end
 
-#### Check to see if more than one mcollective process is running
+  step "Start HTTPD" do
+    hosts.each do |host|
+      # Start HTTPD service
+      on(host, "service httpd start")
+    end
+  end
 
-Here's our magic command that throws an error if more than one mcollective process is running:
+end
+```
 
-    process_count_check = "bash -c '[[ $(ps auxww | grep [m]collectived | wc -l) -eq 1 ]]'"
+This places our install steps in a ruby script (`install.rb`) which will run on your SUT. The install.rb script is used in our commandline to beaker, below.
 
-### Put it all together
+## Create a test file
 
-Here's the finished acceptance test.
+Lets create test file that tests if HTTPD is installed and running on our hosts. Make a file called `mytest.rb` and add the following code to it:
 
 ```ruby
-test_name "/etc/init.d/pe-mcollective restart check"
-
-# Don't run these tests on the following platforms
-confine :except, :platform => 'solaris'
-confine :except, :platform => 'windows'
-confine :except, :platform => 'aix'
-
-step "Make sure the service restarts properly"
-hosts.each do |host|
-  # Commands to execute on the target system.
-  restart_command = "bash -c '[[ -x /etc/init.d/pe-mcollective ]] && /etc/init.d/pe-mcollective restart'"
-  process_count_check = "bash -c '[[ $(ps auxww | grep [m]collectived | wc -l) -eq 1 ]]'"
-
-  # Restart once
-  on(host, restart_command) { assert_equal(0, exit_code) }
-  # Restart again
-  on(host, restart_command) { assert_equal(0, exit_code) }
-  # Check to make sure only one process is running
-  on(host, process_count_check) { assert_equal(0, exit_code) }
+test_name "Check if HTTPD is installed and running" do
+
+  # Don't run these tests on the following platform
+  confine :except, :platform => 'windows'
+
+  step "Make sure HTTPD is installed" do
+    hosts.each do |host|
+      # Check if HTTPD is installed
+      assert check_for_package(host, 'httpd')
+    end
+  end
+
+  step "Make sure HTTPD is running" do
+    hosts.each do |host|
+      on(host, "systemctl is-active httpd") do |result|
+        # Check if HTTPD is running
+        assert_equal(0, result.exit_code)
+      end
+    end
+  end
+
 end
 ```
 

data/lib/beaker/host/pswindows/exec.rb

@@ -164,11 +164,33 @@ module PSWindows::Exec
 
     environment_string = ''
     env_array.each_with_index do |env|
-      environment_string += "set #{env} && "
+      environment_string += "set \"#{env}\" && "
     end
     environment_string
   end
 
+  def environment_variable_string_pair_array env
+    env_array = []
+    env.each_key do |key|
+      val = env[key]
+      if val.is_a?(Array)
+        val = val.join(':')
+      else
+        val = val.to_s
+      end
+      # doing this for the key itself & the upcase'd version allows us to remain
+      # backwards compatible
+      # TODO: (Next Major Version) get rid of upcase'd version
+      key_str = key.to_s
+      keys = [key_str]
+      keys << key_str.upcase if key_str.upcase != key_str
+      keys.each do |env_key|
+        env_array << "#{env_key}=\"#{val}\""
+      end
+    end
+    env_array
+  end
+
   # Overrides the {Windows::Exec#ssh_permit_user_environment} method,
   # since no steps are needed in this setup to allow user ssh environments
   # to work.

data/lib/beaker/hypervisor/docker.rb

@@ -145,7 +145,7 @@ module Beaker
         if container = host['docker_container']
           @logger.debug("stop container #{container.id}")
           begin
-            container.stop
+            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}")

data/lib/beaker/subcommand.rb

@@ -20,7 +20,6 @@ module Beaker
     # a Beaker::CLI object executes, it can pick up these options. Notably excluded from this
     # group are `help` and `version`. Please note that whenever the command_line_parser.rb is
     # updated, this list should also be updated as well.
-    class_option :hosts, :aliases => '-h', :type => :string, :group => 'Beaker run'
     class_option :'options-file', :aliases => '-o', :type => :string, :group => 'Beaker run'
     class_option :helper, :type => :string, :group => 'Beaker run'
     class_option :'load-path', :type => :string, :group => 'Beaker run'
@@ -62,6 +61,7 @@ module Beaker
       as necessary.
     LONGDESC
     option :help, :type => :boolean, :hide => true
+    method_option :hosts, :aliases => '-h', :type => :string, :required => true
     def init()
       if options[:help]
         invoke :help, [], ["init"]

data/lib/beaker/test_suite.rb

@@ -116,22 +116,22 @@ module Beaker
 
         summary_logger.notify "Failed Tests Cases:"
         (grouped_summary[:fail] || []).each do |test_case|
-          print_test_result(test_case)
+          summary_logger.notify print_test_result(test_case)
         end
 
         summary_logger.notify "Errored Tests Cases:"
         (grouped_summary[:error] || []).each do |test_case|
-          print_test_result(test_case)
+          summary_logger.notify print_test_result(test_case)
         end
 
         summary_logger.notify "Skipped Tests Cases:"
         (grouped_summary[:skip] || []).each do |test_case|
-          print_test_result(test_case)
+          summary_logger.notify print_test_result(test_case)
         end
 
         summary_logger.notify "Pending Tests Cases:"
         (grouped_summary[:pending] || []).each do |test_case|
-          print_test_result(test_case)
+          summary_logger.notify print_test_result(test_case)
         end
 
         summary_logger.notify("\n\n")
@@ -152,7 +152,7 @@ module Beaker
         else
           test_case.test_status
         end
-        @logger.notify "  Test Case #{test_case.path} #{test_reported}"
+        "  Test Case #{test_case.path} #{test_reported}"
       end
 
       # Writes Junit XML of this {TestSuiteResult}

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '3.17.0'
+    STRING = '3.18.0'
   end
 end

data/spec/beaker/host/pswindows/exec_spec.rb

@@ -50,5 +50,22 @@ module Beaker
         expect( instance.mv(origin, destination, false) ).to be === 0
       end
     end
+    describe '#environment_string' do
+      let(:host) { {'pathseparator' => ':'} }
+
+      it 'returns a blank string if theres no env' do
+        expect( instance.environment_string( {} ) ).to be == ''
+      end
+
+      it 'takes an env hash with var_name/value pairs' do
+        expect( instance.environment_string( {:HOME => '/', :http_proxy => 'http://foo'} ) ).
+          to be == 'set "HOME="/"" && set "http_proxy="http://foo"" && set "HTTP_PROXY="http://foo"" && '
+      end
+
+      it 'takes an env hash with var_name/value[Array] pairs' do
+        expect( instance.environment_string( {:LD_PATH => ['/', '/tmp']}) ).
+          to be == "set \"LD_PATH=\"/:/tmp\"\" && "
+      end
+    end
   end
 end

data/spec/beaker/hypervisor/docker_spec.rb

@@ -65,7 +65,7 @@ module Beaker
           },
         },
       })
-      allow( container ).to receive(:stop)
+      allow( container ).to receive(:kill)
       allow( container ).to receive(:delete)
       allow( container ).to receive(:exec)
       container
@@ -338,7 +338,7 @@ module Beaker
 
       it 'should stop the containers' do
         allow( docker ).to receive( :sleep ).and_return(true)
-        expect( container ).to receive(:stop)
+        expect( container ).to receive(:kill)
         docker.cleanup
       end
 

data/spec/beaker/subcommand_spec.rb

@@ -47,6 +47,9 @@ module Beaker
         subcommand.init
         expect(mock_options).not_to have_key(:timestamp)
       end
+      it 'requires hosts flag' do
+        expect{subcommand.init}.to raise_error(NotImplementedError)
+      end
     end
 
     context '#provision' do
@@ -84,6 +87,10 @@ module Beaker
         expect(yaml_store_mock).to receive(:[]=).with('provisioned', true)
         subcommand.provision
       end
+      it 'does not allow hosts to be passed' do
+        subcommand.options = {:hosts => "myhost"}
+        expect{subcommand.provision()}.to raise_error(NotImplementedError)
+      end
     end
 
 

data/spec/beaker/test_suite_spec.rb

@@ -233,7 +233,7 @@ module Beaker
           allow(ex).to receive(:backtrace).and_return(['path_to_test_file.rb line 1 - blah'])
           tc.instance_variable_set(:@exception, ex)
           test_suite_result.add_test_case( tc )
-          expect(options[:logger]).to_not receive(:notify).with(/Test line:/)
+          expect(test_suite_result.print_test_result(tc)).not_to match(/Test line:/)
           expect{ test_suite_result.print_test_result(tc) }.to_not raise_error
         end
 
@@ -243,8 +243,7 @@ module Beaker
           allow(ex).to receive(:backtrace).and_return(['path_to_test_file.rb line 1 - blah'])
           tc.instance_variable_set(:@exception, ex)
           test_suite_result.add_test_case( tc )
-
-          expect(options[:logger]).to receive(:notify).with(/Test line:/)
+          expect(test_suite_result.print_test_result(tc)).to match(/Test line:/)
           expect{ test_suite_result.print_test_result(tc) }.to_not raise_error
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker
 version: !ruby/object:Gem::Version
-  version: 3.17.0
+  version: 3.18.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-31 00:00:00.000000000 Z
+date: 2017-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -678,6 +678,7 @@ files:
 - lib/beaker/network_manager.rb
 - lib/beaker/options.rb
 - lib/beaker/options/command_line_parser.rb
+- lib/beaker/options/homedir_options_file_parser.rb
 - lib/beaker/options/hosts_file_parser.rb
 - lib/beaker/options/options_file_parser.rb
 - lib/beaker/options/options_hash.rb