beaker 3.9.0 → 3.10.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDY0YzA0OTYzZWUyZDJiZmIzODQ1Y2I2MzkzMDE2ZDFjYTM4Y2VlOA==
+    ZmJlZmIyZTkxMzE4ZDg2YTRkNmU1YTkwZWE3YjM1N2JlZGFiM2E5Ng==
   data.tar.gz: !binary |-
-    MzE2ODZhNDQxOWY4OTczMzZiNWQ4NzViYzFlNTFkOGFmZGJlMjJjMQ==
+    N2ExOTAxZWZhODM5NjcwYjVmYTk2NzcyNzEyMzU3MzNjMDE5ZDhmMw==
 SHA512:
   metadata.gz: !binary |-
-    M2MyM2FiYjEyNDE5NzI4YWE5YzliYjEzMzI4M2M3MGI0NDQ0NmRiMTYzMDc1
-    OGM5Njc4MzBjMDUxYmU4ZjY5YjQ5YWQ0YTJmZDRkMWZiODE3MWFmNTNkNjA2
-    NWRiOGJiNDllZGM5MDFjYzEwYzBiYjJlZmI5NGQ2OTdkZGViNDU=
+    YmQwYTZlMDM0YTBlZWUzMWIyNzU5ZTE4NmMzMzllN2U2ZDA2OThmZWQ1NWNh
+    MWFlMzUwZDg2N2FlYWQ1OWYwMGZlMmNlNzQ1ODdkNTU1NjRkMGFkZDFkZmQ5
+    Nzc3YWI5YjE2ZDhlNGY4NDFjYzcxMjg0NmI1OTYwZjk2ODliZDc=
   data.tar.gz: !binary |-
-    M2Y5OWE2NGJiYjFjNjFlNzhlNWI2M2UwMWIyNjA1ZjU2OTExMWRjMjM5NDQy
-    MTYzY2JiODcxNmI5YjMxM2M2NDZjOTZiOWZlN2I3ZDI2YTlmZjI0ODIyYjYz
-    NzNhMzRjYWMyNjM2NWVkOTY3YWFjZTY4ZjEwNTgyNzYyMzdiZTQ=
+    MmViMTUyYzY3NDY0YzczMGRiZDcwMTJkZTU0MWI3ZTcwY2U2NThiY2MwZTY3
+    NWY0NmM4YzZkYzE1ZjkzODM1YzQwMWQzMTRjNWNhYzM3ODZkMDU4ODc3Yjk3
+    NzE5NDY2Nzg2YjA0MWFkYzJjMmFjODM2MWFmYmVhYzBjNDVlYTg=

data/beaker.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-its'
   s.add_development_dependency 'fakefs', '~> 0.6'
-  s.add_development_dependency 'rake', '~> 11.2'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'pry', '~> 0.10'
 
@@ -43,6 +42,7 @@ Gem::Specification.new do |s|
   ## indicating test from puppet acceptance:
   ##   tests/security/cve-2013-1652_improper_query_params.rb
 
+  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'
@@ -51,7 +51,6 @@ Gem::Specification.new do |s|
   # Run time dependencies that are Beaker libraries
   s.add_runtime_dependency 'stringify-hash', '~> 0.0'
   s.add_runtime_dependency 'beaker-hiera', '~> 0.0'
-  s.add_runtime_dependency 'beaker-facter', '~> 0.0'
   s.add_runtime_dependency 'beaker-hostgenerator'
 
   # Optional provisioner specific support

data/docs/concepts/testing_beaker_itself.md

@@ -0,0 +1,29 @@
+# Testing Beaker Itself
+
+While Beaker provides the testing harness for much of the acceptance testing that happens at Puppet, Beaker itself must also go through a testing process for changes submitted to itself to ensure that releases of Beaker do not break pipelines, jobs, and tests that rely on it. This document describes what is actually covered in Beaker's own testing and how that testing is accomplished.
+
+## Testing Coverage
+
+### Product Coverage
+
+Beaker test coverage covers the LTS PE version, currently 2016.4.0, and the latest released version of PE, currently 2016.5.0. 
+Since there is only a single major version of Puppet itself currently supported, beaker only run tests on the latest y-release of Puppet 4, currently 4.8.z. This currently resolves to puppet-agent 1.8.x.
+
+### Platform Coverage
+
+The platforms that beaker covers in its regression testing are largely what is supported by either Puppet or Puppet Enterprise. All variants that are supported by Puppet Enterprise as master platforms are tested. Variants that are agent only are more sparsely covered, generally testing the latest released version.
+
+## Test Suite Phases
+
+### Beaker Spec
+The initial step in Beaker's pipeline is to execute spec testing with supported and future rubies; 2.2.5 and 2.3.1. 
+
+### Beaker Acceptance 
+All acceptance tests use actual OS's with beaker installed and use beaker itself to verify that its own methods and classes are working. 
+
+* The Base tests are tests that do not require puppet be installed on the SUT. This includes much of the DSL and host helpers.
+* The puppet tests rely on puppet being installed in the pre-suite
+
+### Beaker Regression
+
+The Beaker regression tests are an ever evolving set of Jenkins jobs that use acceptance jobs defined in other pipelines with the Beaker PR changes. We run these jobs to ensure the PR changes do not cause breakage in existing acceptance jobs. The tests themselves are maintained by each separate team.

data/lib/beaker/dsl/helpers.rb

@@ -1,10 +1,9 @@
 # -*- coding: utf-8 -*-
-[ 'host', 'puppet', 'test', 'tk', 'web', 'hocon' ].each do |lib|
+[ 'facter', 'host', 'puppet', 'test', 'tk', 'web', 'hocon' ].each do |lib|
       require "beaker/dsl/helpers/#{lib}_helpers"
 end
 
-require 'beaker-hiera'
-require 'beaker-facter'
+require "beaker-hiera"
 module Beaker
   module DSL
 
@@ -24,6 +23,7 @@ module Beaker
     #
     #
     module Helpers
+      include Beaker::DSL::Helpers::FacterHelpers
       include Beaker::DSL::Helpers::HostHelpers
       include Beaker::DSL::Helpers::PuppetHelpers
       include Beaker::DSL::Helpers::TestHelpers
@@ -31,7 +31,6 @@ module Beaker
       include Beaker::DSL::Helpers::WebHelpers
       include Beaker::DSL::Helpers::HoconHelpers
       include Beaker::DSL::Helpers::Hiera
-      include Beaker::DSL::Helpers::Facter
     end
   end
 end

data/lib/beaker/dsl/helpers/facter_helpers.rb

@@ -0,0 +1,57 @@
+module Beaker
+  module DSL
+    module Helpers
+      # Methods that help you interact with your facter installation, facter must be installed
+      # for these methods to execute correctly
+      #
+      module FacterHelpers
+
+        # @!macro [new] common_opts
+        #   @param [Hash{Symbol=>String}] opts Options to alter execution.
+        #   @option opts [Boolean] :silent (false) Do not produce log output
+        #   @option opts [Array<Fixnum>] :acceptable_exit_codes ([0]) An array
+        #     (or range) of integer exit codes that should be considered
+        #     acceptable.  An error will be thrown if the exit code does not
+        #     match one of the values in this list.
+        #   @option opts [Boolean] :accept_all_exit_codes (false) Consider all 
+        #     exit codes as passing.
+        #   @option opts [Boolean] :dry_run (false) Do not actually execute any
+        #     commands on the SUT
+        #   @option opts [String] :stdin (nil) Input to be provided during command
+        #     execution on the SUT.
+        #   @option opts [Boolean] :pty (false) Execute this command in a pseudoterminal.
+        #   @option opts [Boolean] :expect_connection_failure (false) Expect this command
+        #     to result in a connection failure, reconnect and continue execution.
+        #   @option opts [Hash{String=>String}] :environment ({}) These will be
+        #     treated as extra environment variables that should be set before
+        #     running the command.
+        #
+
+        # Get a facter fact from a provided host
+        #
+        # @param [Host, Array<Host>, String, Symbol] host    One or more hosts to act upon,
+        #                            or a role (String or Symbol) that identifies one or more hosts.
+        # @param [String] name The name of the fact to query for
+        # @!macro common_opts
+        #
+        # @return String The value of the fact 'name' on the provided host
+        # @raise  [FailTest] Raises an exception if call to facter fails
+        def fact_on(host, name, opts = {})
+          result = on host, facter(name, opts)
+          if result.kind_of?(Array)
+            result.map { |res| res.stdout.chomp }
+          else
+            result.stdout.chomp
+          end
+        end
+
+        # Get a facter fact from the default host
+        # @see #fact_on
+        def fact(name, opts = {})
+          fact_on(default, name, opts)
+        end
+
+      end
+    end
+  end
+end

data/lib/beaker/dsl/install_utils/foss_utils.rb

@@ -1143,7 +1143,12 @@ module Beaker
             when /^(sles|aix|el)$/
               # NOTE: AIX does not support repo management. This block assumes
               # that the desired rpm has been mirrored to the 'repos' location.
-              on host, "rpm -ivh #{onhost_copied_file}"
+              # NOTE: the AIX 7.1 package will only install on 7.2 with
+              # --ignoreos. This is a bug in package building on AIX 7.1's RPM
+              if variant == "aix" and version == "7.2"
+                aix_72_ignoreos_hack = "--ignoreos"
+              end
+              on host, "rpm -ivh #{aix_72_ignoreos_hack} #{onhost_copied_file}"
             when /^windows$/
               result = on host, "echo #{onhost_copied_file}"
               onhost_copied_file = result.raw_output.chomp

data/lib/beaker/host/unix/pkg.rb

@@ -403,6 +403,7 @@ module Unix::Pkg
     when /^(sles|aix|el|centos|oracle|redhat|scientific)$/
       variant = 'el' if variant.match(/(?:el|centos|oracle|redhat|scientific)/)
       arch = 'ppc' if variant == 'aix' && arch == 'power'
+      version = '7.1' if variant == 'aix' && version == '7.2'
       release_path_end = "#{variant}/#{version}/#{puppet_collection}/#{arch}"
       release_file = "puppet-agent-#{puppet_agent_version}-1.#{variant}#{version}.#{arch}.rpm"
     else

data/lib/beaker/hypervisor/aws_sdk.rb

@@ -407,7 +407,7 @@ module Beaker
         end
         wait_for_status(:running, instances)
       rescue Exception => ex
-        @logger.notify("aws-sdk: exception - #{ex}")
+        @logger.notify("aws-sdk: exception #{ex.class}: #{ex}")
         kill_instances(instances.map{|x| x[:instance]})
         raise ex
       end
@@ -805,10 +805,18 @@ module Beaker
     # @param [String] pair_name the name of the key to be created
     #
     # @return [AWS::EC2::KeyPair] key pair created
+    # @raise [RuntimeError] raised if AWS keypair not created
     def create_new_key_pair(region, pair_name)
-      @logger.debug("aws-sdk: generating new key pair: #{pair_name}")
+      @logger.debug("aws-sdk: importing new key pair: #{pair_name}")
       ssh_string = public_key()
       region.key_pairs.import(pair_name, ssh_string)
+      kp = region.key_pairs[pair_name]
+      if kp.exists?
+        @logger.debug("aws-sdk: key pair #{pair_name} imported")
+        kp
+      else
+        raise RuntimeError, "AWS key pair #{pair_name} can not be queried, even after import"
+      end
     end
 
     # Return a reproducable security group identifier based on input ports

data/lib/beaker/subcommands/subcommand_util.rb

@@ -51,6 +51,7 @@ module Beaker
       # quick start tasks
       def self.require_tasks()
         rake_file = determine_rake_file()
+        FileUtils.touch(rake_file)
         unless File.readlines(rake_file).grep(/#{BEAKER_REQUIRE}/).any?
           File.open(rake_file, "a+") { |f| f.puts(BEAKER_REQUIRE) }
         end

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '3.9.0'
+    STRING = '3.10.0'
   end
 end

data/spec/beaker/dsl/helpers/facter_helpers_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+class ClassMixedWithDSLHelpers
+  include Beaker::DSL::Helpers
+  include Beaker::DSL::Wrappers
+  include Beaker::DSL::Roles
+  include Beaker::DSL::Patterns
+
+  def logger
+    RSpec::Mocks::Double.new('logger').as_null_object
+  end
+
+end
+
+describe ClassMixedWithDSLHelpers do
+  let( :command ){ 'ls' }
+  let( :host )   { double.as_null_object }
+  let( :result ) { Beaker::Result.new( host, command ) }
+
+  let( :master ) { make_host( 'master',   :roles => %w( master agent default)    ) }
+  let( :agent )  { make_host( 'agent',    :roles => %w( agent )           ) }
+  let( :custom ) { make_host( 'custom',   :roles => %w( custom agent )    ) }
+  let( :dash )   { make_host( 'console',  :roles => %w( dashboard agent ) ) }
+  let( :db )     { make_host( 'db',       :roles => %w( database agent )  ) }
+  let( :hosts )  { [ master, agent, dash, db, custom ] }
+
+
+  describe '#fact_on' do
+    it 'retrieves a fact on a single host' do
+      result.stdout = "family\n"
+      expect( subject ).to receive(:facter).with('osfamily',{}).once
+      expect( subject ).to receive(:on).and_return(result)
+
+      expect( subject.fact_on('host','osfamily') ).to be === result.stdout.chomp
+    end
+
+    it 'retrieves an array of facts from multiple hosts' do
+      allow( subject ).to receive( :hosts ).and_return( hosts )
+      times = hosts.length
+      result.stdout = "family\n"
+      hosts.each do |host|
+        expect( host ).to receive(:exec).and_return(result)
+      end
+
+      expect( subject.fact_on(hosts,'osfamily') ).to be === [result.stdout.chomp] * hosts.length
+
+    end
+  end
+
+  describe '#fact' do
+    it 'delegates to #fact_on with the default host' do
+      allow( subject ).to receive(:hosts).and_return(hosts)
+      expect( subject ).to receive(:fact_on).with(master,"osfamily",{}).once
+
+      subject.fact('osfamily')
+    end
+  end
+
+end

data/spec/beaker/hypervisor/aws_sdk_spec.rb

@@ -825,16 +825,29 @@ module Beaker
     end
 
     describe '#create_new_key_pair' do
-      let( :region ) { double('region', :name => 'test_region_name') }
+      let(:region) { double('region', :name => 'test_region_name') }
+      let(:ssh_string) { 'ssh_string_test_0867' }
+      let(:pairs) { double('keypairs') }
+      let(:pair) { double('keypair') }
+      let(:pair_name) { 'pair_name_1555432' }
+
+      before :each do
+        allow(aws).to receive(:public_key).and_return(ssh_string)
+        expect(pairs).to receive(:import).with(pair_name, ssh_string)
+        expect(pairs).to receive(:[]).with(pair_name).and_return(pair)
+        expect(region).to receive(:key_pairs).and_return(pairs).twice
+      end
 
       it 'imports the key given from public_key' do
-        ssh_string = 'ssh_string_test_0867'
-        allow( aws ).to receive( :public_key ).and_return( ssh_string )
-        pairs = double('keypairs')
-        pair_name = 'pair_name_1555432'
-        expect( pairs ).to receive( :import ).with( pair_name, ssh_string )
-        expect( region ).to receive(:key_pairs).and_return(pairs).once
-        aws.create_new_key_pair( region, pair_name )
+        expect(pair).to receive(:exists?).and_return (true)
+        aws.create_new_key_pair(region, pair_name)
+      end
+
+      it 'raises an exception if subsequent keypair check is false' do
+        expect(pair).to receive(:exists?).and_return (false)
+        expect { aws.create_new_key_pair(region, pair_name) }.
+          to raise_error(RuntimeError,
+            "AWS key pair #{pair_name} can not be queried, even after import")
       end
     end
 

data/spec/beaker/subcommand/subcommand_util_spec.rb

@@ -181,6 +181,7 @@ module Beaker
           allow(File).to receive(:readlines).with("Rakefile").and_return([""])
           allow(File).to receive(:open).with("Rakefile", "a+").and_yield(file)
           allow(File).to receive(:puts).with("require 'beaker/tasks/quick_start'").and_return(true)
+          expect(FileUtils).to receive(:touch).with("Rakefile").exactly(1).times
           expect(File).to receive(:open).with("Rakefile", "a+").and_yield(file).exactly(1).times
           expect(file).to receive(:puts).with("require 'beaker/tasks/quick_start'").exactly(1).times
           subject.require_tasks
@@ -191,6 +192,7 @@ module Beaker
           allow(File).to receive(:readlines).with("Rakefile").and_return(["require 'beaker/tasks/quick_start'"])
           allow(File).to receive(:open).with("Rakefile", "a+").and_yield(file)
           allow(File).to receive(:puts).with("require 'beaker/tasks/quick_start'").and_return(true)
+          expect(FileUtils).to receive(:touch).with("Rakefile").exactly(1).times
           expect(File).to receive(:open).with("Rakefile", "a+").and_yield(file).exactly(0).times
           expect(file).to receive(:puts).with("require 'beaker/tasks/quick_start'").exactly(0).times
           subject.require_tasks

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker
 version: !ruby/object:Gem::Version
-  version: 3.9.0
+  version: 3.10.0
 platform: ruby
 authors:
 - Puppetlabs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-18 00:00:00.000000000 Z
+date: 2017-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -52,20 +52,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '11.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '11.2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +178,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rsync
   requirement: !ruby/object:Gem::Requirement
@@ -276,20 +276,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.0'
-- !ruby/object:Gem::Dependency
-  name: beaker-facter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: beaker-hostgenerator
   requirement: !ruby/object:Gem::Requirement
@@ -545,6 +531,7 @@ files:
 - docs/concepts/shared_options_for_executing_beaker_commands.md
 - docs/concepts/style_guide.md
 - docs/concepts/test_tagging.md
+- docs/concepts/testing_beaker_itself.md
 - docs/concepts/ticket_process.md
 - docs/concepts/types_puppet_4_and_the_all_in_one_agent.md
 - docs/how_to/access_the_live_test_console_with_pry.md
@@ -597,6 +584,7 @@ files:
 - lib/beaker/dsl.rb
 - lib/beaker/dsl/assertions.rb
 - lib/beaker/dsl/helpers.rb
+- lib/beaker/dsl/helpers/facter_helpers.rb
 - lib/beaker/dsl/helpers/hocon_helpers.rb
 - lib/beaker/dsl/helpers/host_helpers.rb
 - lib/beaker/dsl/helpers/puppet_helpers.rb
@@ -707,6 +695,7 @@ files:
 - spec/beaker/command_spec.rb
 - spec/beaker/dsl/assertions_spec.rb
 - spec/beaker/dsl/ezbake_utils_spec.rb
+- spec/beaker/dsl/helpers/facter_helpers_spec.rb
 - spec/beaker/dsl/helpers/host_helpers_spec.rb
 - spec/beaker/dsl/helpers/puppet_helpers_spec.rb
 - spec/beaker/dsl/helpers/test_helpers_spec.rb