beaker 2.3.0 → 2.4.0

data/lib/beaker/dsl/install_utils.rb

@@ -26,7 +26,7 @@ module Beaker
       GitHubSig   = 'github.com,207.97.227.239 ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ=='
 
       # The directories in the module directory that will not be scp-ed to the test system when using `copy_module_to`
-      PUPPET_MODULE_INSTALL_IGNORE = ['.bundle', '.git', '.idea', '.vagrant', '.vendor', 'vendor', 'acceptance', 'spec', 'tests', 'log']
+      PUPPET_MODULE_INSTALL_IGNORE = ['.bundle', '.git', '.idea', '.vagrant', '.vendor', 'vendor', 'acceptance', 'bundle', 'spec', 'tests', 'log']
 
       # @param [String] uri A uri in the format of <git uri>#<revision>
       #                     the `git://`, `http://`, `https://`, and ssh
@@ -805,14 +805,28 @@ module Beaker
         if not link_exists?( link )
           raise "Puppet #{version} at #{link} does not exist!"
         end
-        on host, "curl -O #{link}"
-        on host, "msiexec /qn /i #{host['dist']}.msi"
 
-        #Because the msi installer doesn't add Puppet to the environment path
-        #Add both potential paths for simplicity
-        #NOTE - this is unnecessary if the host has been correctly identified as 'foss' during set up
-        puppetbin_path = "\"/cygdrive/c/Program Files (x86)/Puppet Labs/Puppet/bin\":\"/cygdrive/c/Program Files/Puppet Labs/Puppet/bin\""
-        on host, %Q{ echo 'export PATH=$PATH:#{puppetbin_path}' > /etc/bash.bashrc }
+        if host['is_cygwin'].nil? or host['is_cygwin'] == true
+          dest = "/cygdrive/c/Windows/Temp/#{host['dist']}.msi"
+          on host, "curl -O #{dest} #{link}"
+
+          #Because the msi installer doesn't add Puppet to the environment path
+          #Add both potential paths for simplicity
+          #NOTE - this is unnecessary if the host has been correctly identified as 'foss' during set up
+          puppetbin_path = "\"/cygdrive/c/Program Files (x86)/Puppet Labs/Puppet/bin\":\"/cygdrive/c/Program Files/Puppet Labs/Puppet/bin\""
+          on host, %Q{ echo 'export PATH=$PATH:#{puppetbin_path}' > /etc/bash.bashrc }
+        else
+          dest = "C:\\Windows\\Temp\\#{host['dist']}.msi"
+
+          on host, "set PATH=\"%PATH%;#{host['puppetbindir']}\""
+          on host, "setx PATH \"%PATH%;#{host['puppetbindir']}\""
+
+          on host, powershell("$webclient = New-Object System.Net.WebClient;  $webclient.DownloadFile('#{link}','#{dest}')")
+
+          on host, "if not exist #{host['distmoduledir']} (md #{host['distmoduledir']})"
+        end
+
+        on host, "msiexec /qn /i #{dest}"
       end
 
       # Installs Puppet and dependencies from dmg

data/lib/beaker/dsl/structure.rb

@@ -1,3 +1,4 @@
+require 'beaker/dsl/assertions'
 module Beaker
   module DSL
     # These are simple structural elements necessary for writing
@@ -22,6 +23,11 @@ module Beaker
     #       step 'Test the things' do
     #         ...tests...
     #       end
+    #
+    #       step 'Expect this to fail' do
+    #         expect_failure('expected to fail due to PE-1234') do
+    #         assert_equal(400, response.code, 'bad response code from API call')
+    #       end
     #     end
     #
     module Structure
@@ -55,9 +61,70 @@ module Beaker
       #     on(master, puppet_resource('file', '/etc/puppet/modules',
       #       'ensure=absent', 'purge=true'))
       #   end
+      # @api dsl
       def teardown &block
         @teardown_procs << block
       end
+
+      # Wrap an assert that is supposed to fail due to a product bug, an
+      # undelivered feature, or some similar situation.
+      #
+      # This converts failing asserts into passing asserts (so we can continue to
+      # run the test even though there are underlying product bugs), and converts
+      # passing asserts into failing asserts (so we know when the underlying product
+      # bug has been fixed).
+      #
+      # Pass an assert as a code block, and pass an explanatory message as a
+      # parameter. The assert's logic will be inverted (so passes turn into fails
+      # and fails turn into passes).
+      #
+      # @example Typical usage
+      #   expect_failure('expected to fail due to PE-1234') do
+      #     assert_equal(400, response.code, 'bad response code from API call')
+      #   end
+      #
+      # @example Output when a product bug would normally cause the assert to fail
+      #   Warning: An assertion was expected to fail, and did.
+      #   This is probably due to a known product bug, and is probably not a problem.
+      #   Additional info: 'expected to fail due to PE-6995'
+      #   Failed assertion: 'bad response code from API call.
+      #   <400> expected but was <409>.'
+      #
+      # @example Output when the product bug has been fixed
+      #   <RuntimeError: An assertion was expected to fail, but passed.
+      #   This is probably because a product bug was fixed, and "expect_failure()"
+      #   needs to be removed from this assert.
+      #   Additional info: 'expected to fail due to PE-6996'>
+      #
+      # @param [String] explanation A description of why this assert is expected to
+      #                             fail
+      # @param block [Proc] block of code is expected to either raise an
+      #                     {Beaker::Assertions} or else return a value that
+      #                     will be ignored
+      # @raise [RuntimeError] if the code block passed to this method does not raise
+      #                       a {Beaker::Assertions} (i.e., if the assert
+      #                       passes)
+      # @author Chris Cowell-Shah (<tt>ccs@puppetlabs.com</tt>)
+      # @api dsl
+      def expect_failure(explanation, &block)
+        begin
+          yield if block_given?  # code block should contain an assert that you expect to fail
+        rescue Beaker::DSL::Assertions, Minitest::Assertion => failed_assertion
+          # Yay! The assert in the code block failed, as expected.
+          # Swallow the failure so the test passes.
+          logger.notify 'An assertion was expected to fail, and did. ' +
+                          'This is probably due to a known product bug, ' +
+                          'and is probably not a problem. ' +
+                          "Additional info: '#{explanation}' " +
+                          "Failed assertion: '#{failed_assertion}'"
+          return
+        end
+        # Uh-oh! The assert in the code block unexpectedly passed.
+        fail('An assertion was expected to fail, but passed. ' +
+                 'This is probably because a product bug was fixed, and ' +
+                 '"expect_failure()" needs to be removed from this test. ' +
+                 "Additional info: '#{explanation}'")
+      end
     end
   end
 end

data/lib/beaker/host.rb

@@ -28,7 +28,12 @@ module Beaker
     def self.create name, options
       case options['HOSTS'][name]['platform']
       when /windows/
-        Windows::Host.new name, options
+        cygwin = options['HOSTS'][name]['is_cygwin']
+        if cygwin.nil? or cygwin == true
+          Windows::Host.new name, options
+        else
+          PSWindows::Host.new name, options
+        end
       when /aix/
         Aix::Host.new name, options
       when /osx/
@@ -49,7 +54,6 @@ module Beaker
       # related through 'type' and the differences between the assumption of our two
       # configurations we have for many of our products
       type = @options.get_type
-      type = :foss if type == :aio && !@options['HOSTS'][@name]['roles'].include?('agent')
       @defaults = merge_defaults_for_type @options, type
       pkg_initialize
     end
@@ -295,7 +299,13 @@ module Beaker
     # @param [String] dir The directory structure to create on the host
     # @return [Boolean] True, if directory construction succeeded, otherwise False
     def mkdir_p dir
-      result = exec(Beaker::Command.new("mkdir -p #{dir}"), :acceptable_exit_codes => [0, 1])
+      if host['is_cygwin'].nil? or host['is_cygwin'] == true
+        cmd = "mkdir -p #{dir}"
+      else
+        cmd = "if not exist #{dir.gsub!('/','\\')} (md #{dir.gsub!('/','\\')})"
+      end
+
+      result = exec(Beaker::Command.new(cmd), :acceptable_exit_codes => [0, 1])
       result.exit_code == 0
     end
 
@@ -381,7 +391,7 @@ module Beaker
 
   end
 
-  [ 'windows', 'unix', 'aix', 'mac' ].each do |lib|
+  [ 'windows', 'pswindows', 'unix', 'aix', 'mac' ].each do |lib|
     require "beaker/host/#{lib}"
   end
 end

data/lib/beaker/host/mac.rb

@@ -25,6 +25,8 @@ module Mac
         'puppetserver-confdir' => '/etc/puppetlabs/puppetserver/conf.d',
         'puppetservice'    => 'pe-httpd',
         'puppetpath'       => '/etc/puppetlabs/puppet',
+        'puppetconfdir'    => '/etc/puppetlabs/puppet',
+        'puppetcodedir'    => '/etc/puppetlabs/puppet',
         'puppetbin'        => '/opt/puppet/bin/puppet',
         'puppetbindir'     => '/opt/puppet/bin',
         'puppetsbindir'    => '/opt/puppet/sbin',
@@ -45,6 +47,8 @@ module Mac
         'puppetserver-confdir' => '/etc/puppetserver/conf.d',
         'puppetservice'     => 'puppetmaster',
         'puppetpath'        => '/etc/puppet',
+        'puppetconfdir'     => '/etc/puppet',
+        'puppetcodedir'     => '/etc/puppet',
         'puppetvardir'      => '/var/lib/puppet',
         'puppetbin'         => '/usr/bin/puppet',
         'puppetbindir'      => '/usr/bin',

data/lib/beaker/host/pswindows.rb

@@ -0,0 +1,79 @@
+[ 'host', 'command_factory', 'command', 'options' ].each do |lib|
+  require "beaker/#{lib}"
+end
+
+module PSWindows
+  class Host < Beaker::Host
+    [ 'user', 'group', 'exec', 'pkg', 'file' ].each do |lib|
+      require "beaker/host/pswindows/#{lib}"
+    end
+
+    include PSWindows::User
+    include PSWindows::Group
+    include PSWindows::File
+    include PSWindows::Exec
+    include PSWindows::Pkg
+
+    def self.pe_defaults
+      h = Beaker::Options::OptionsHash.new
+      h.merge({
+        'user'          => 'Administrator',
+        'group'         => 'Administrators',
+        'distmoduledir' => 'C:\\ProgramData\\PuppetLabs\\puppet\\etc\\modules',
+        'sitemoduledir'     => 'C:\\usr\\share\\puppet\\modules',
+        'puppetservice' => 'pe-httpd',
+        'pathseparator' => ';',
+        'puppetpath'    => 'C:\\ProgramData\\PuppetLabs\\puppet\\etc',
+        'puppetconfdir' => 'C:\\ProgramData\\PuppetLabs\\puppet\\etc',
+        'puppetcodedir' => 'C:\\ProgramData\\PuppetLabs\\puppet\\etc',
+        'hieraconf'     => 'C:\\ProgramData\\PuppetLabs\\puppet\\etc\\hiera.yaml',
+        'puppetvardir'  => 'C:\\ProgramData\\PuppetLabs\\puppet\\var',
+        })
+
+        if platform.include?('amd64')
+          h.merge({
+            'puppetbindir'  => 'C:\\Program Files (x86)\\PuppetLabs\\Puppet Enterprise\\bin'
+            })
+          else
+            h.merge({
+              'puppetbindir'  => 'C:\\Program Files\\PuppetLabs\\Puppet Enterprise\\bin'
+              })
+            end
+          end
+
+          def self.foss_defaults
+            h = Beaker::Options::OptionsHash.new
+            h.merge({
+              'user'              => 'Administrator',
+              'group'             => 'Administrators',
+              'distmoduledir'     => 'C:\\ProgramData\\PuppetLabs\\puppet\\etc\\modules',
+              'sitemoduledir'     => 'C:\\usr\\share\\puppet\\modules',
+              'hieralibdir'       => 'C:\\opt\\puppet-git-repos\\hiera\\lib',
+              'hierapuppetlibdir' => 'C:\\opt\\puppet-git-repos\\hiera-puppet\\lib',
+              'hierabindir'       => 'C:\\opt\\puppet-git-repos\\hiera\\bin',
+              'pathseparator'     => ';'
+              })
+
+              if h['platform'] && h['platform'].include?('amd64')
+                h.merge({
+                  'puppetpath'    => "C:\\Program Files (x86)\\Puppet Labs\\Puppet\\etc",
+                  'puppetconfdir' => "C:\\Program Files (x86)\\Puppet Labs\\Puppet\\etc",
+                  'puppetcodedir' => "C:\\Program Files (x86)\\Puppet Labs\\Puppet\\etc",
+                  'hieraconf'     => "C:\\Program Files (x86)\\Puppet Labs\\Puppet\\etc\\hiera.yaml",
+                  'puppetvardir'  => 'C:\\Program Files (x86)\\Puppet Labs\\Puppet\\var',
+                  'puppetbindir'  => "C:\\Program Files (x86)\\Puppet Labs\\Puppet\\bin"
+                  })
+                else
+                  h.merge({
+                    'puppetpath'    => "C:\\Program Files\\Puppet Labs\\Puppet\\etc",
+                    'puppetconfdir' => "C:\\Program Files\\Puppet Labs\\Puppet\\etc",
+                    'puppetcodedir' => "C:\\Program Files\\Puppet Labs\\Puppet\\etc",
+                    'hieraconf'     => "C:\\Program Files\\Puppet Labs\\Puppet\\etc\\hiera.yaml",
+                    'puppetvardir'  => 'C:\\Program Files\\Puppet Labs\\Puppet\\var',
+                    'puppetbindir'  => "C:\\Program Files\\Puppet Labs\\Puppet\\bin"
+                    })
+                  end
+
+                end
+              end
+            end

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

@@ -0,0 +1,29 @@
+module PSWindows::Exec
+  include Beaker::CommandFactory
+
+  ABS_CMD = 'c:\\\\windows\\\\system32\\\\cmd.exe'
+  CMD = 'cmd.exe'
+
+  def echo(msg, abs=true)
+    (abs ? ABS_CMD : CMD) + " /c echo #{msg}"
+  end
+
+  def touch(file, abs=true)
+    (abs ? ABS_CMD : CMD) + " /c echo. 2> #{file}"
+  end
+
+  def path
+    'c:/windows/system32;c:/windows'
+  end
+
+  def get_ip
+    ip = execute("for /f \"tokens=14\" %f in ('ipconfig ^| find \"IP Address\"') do @echo %f").strip
+    if ip == ''
+      ip = execute("for /f \"tokens=14\" %f in ('ipconfig ^| find \"IPv4 Address\"') do @echo %f").strip
+    end
+    if ip == ''
+      ip = execute("for /f \"tokens=14\" %f in ('ipconfig ^| find \"IPv6 Address\"') do @echo %f").strip
+    end
+    ip
+  end
+end

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

@@ -0,0 +1,15 @@
+module PSWindows::File
+  include Beaker::CommandFactory
+
+  def tmpfile(name)
+    execute("echo C:\\Windows\\Temp\\#{name}.XXXXXX")
+  end
+
+  def tmpdir(name)
+    execute("echo C:\\Windows\\Temp\\#{name}.XXXXXX")
+  end
+
+  def path_split(paths)
+    paths.split(';')
+  end
+end

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

@@ -0,0 +1,36 @@
+module PSWindows::Group
+  include Beaker::CommandFactory
+
+  def group_list(&block)
+    execute('cmd /c echo "" | wmic group where localaccount="true" get name /format:value') do |result|
+      groups = []
+      result.stdout.each_line do |line|
+        groups << (line.match(/^Name=(.+)$/) or next)[1]
+      end
+
+      yield result if block_given?
+
+      groups
+    end
+  end
+
+  def group_get(name, &block)
+    execute("net localgroup \"#{name}\"") do |result|
+      fail_test "failed to get group #{name}" unless result.stdout =~ /^Alias name\s+#{name}/
+
+      yield result if block_given?
+    end
+  end
+
+  def group_gid(name)
+    raise NotImplementedError, "Can't retrieve group gid on a Windows host"
+  end
+
+  def group_present(name, &block)
+    execute("net localgroup /add \"#{name}\"", {:acceptable_exit_codes => [0,2]}, &block)
+  end
+
+  def group_absent(name, &block)
+    execute("net localgroup /delete \"#{name}\"", {:acceptable_exit_codes => [0,2]}, &block)
+  end
+end

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

@@ -0,0 +1,47 @@
+module PSWindows::Pkg
+  include Beaker::CommandFactory
+
+  def check_for_command(name)
+    result = exec(Beaker::Command.new("where #{name}"), :acceptable_exit_codes => (0...127))
+    result.exit_code == 0
+  end
+
+  def check_for_package(name)
+    raise "Cannot check for package #{name} on #{self}"
+  end
+
+  def install_package(name, cmdline_args = '')
+    raise "Package #{name} cannot be installed on #{self}"
+  end
+
+  def uninstall_package(name, cmdline_args = '')
+    raise "Package #{name} cannot be uninstalled on #{self}"
+  end
+
+  private
+
+  # @api private
+  def identify_windows_architecture
+    arch = nil
+    execute("echo '' | wmic os get osarchitecture",
+    :acceptable_exit_codes => (0...127)) do |result|
+
+      arch = if result.exit_code == 0
+        result.stdout =~ /64/ ? '64' : '32'
+      else
+        identify_windows_architecture_from_os_name_for_win2003
+      end
+    end
+    arch
+  end
+
+  # @api private
+  def identify_windows_architecture_from_os_name_for_win2003
+    arch = nil
+    execute("echo '' | wmic os get name | grep x64",
+    :acceptable_exit_codes => (0...127)) do |result|
+      arch = result.exit_code == 0 ? '64' : '32'
+    end
+    arch
+  end
+end

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

@@ -0,0 +1,32 @@
+module PSWindows::User
+  include Beaker::CommandFactory
+
+  def user_list(&block)
+    execute('cmd /c echo "" | wmic useraccount where localaccount="true" get name /format:value') do |result|
+      users = []
+      result.stdout.each_line do |line|
+        users << (line.match(/^Name=([\w ]+)/) or next)[1]
+      end
+
+      yield result if block_given?
+
+      users
+    end
+  end
+
+  def user_get(name, &block)
+    execute("net user \"#{name}\"") do |result|
+      fail_test "failed to get user #{name}" unless result.stdout =~ /^User name\s+#{name}/
+
+      yield result if block_given?
+    end
+  end
+
+  def user_present(name, &block)
+    execute("net user /add \"#{name}\"", {:acceptable_exit_codes => [0,2]}, &block)
+  end
+
+  def user_absent(name, &block)
+    execute("net user /delete \"#{name}\"", {:acceptable_exit_codes => [0,2]}, &block)
+  end
+end

data/lib/beaker/host/unix.rb

@@ -22,9 +22,11 @@ module Unix
         'puppetserver-confdir' => '/etc/puppetlabs/puppetserver/conf.d',
         'puppetservice'    => 'pe-httpd',
         'puppetpath'       => '/etc/puppetlabs/puppet',
+        'puppetconfdir'    => '/etc/puppetlabs/puppet',
         'puppetbin'        => '/opt/puppet/bin/puppet',
         'puppetbindir'     => '/opt/puppet/bin',
         'puppetsbindir'    => '/opt/puppet/sbin',
+        'systembindir'     => '/opt/puppet/bin',
         'puppetvardir'     => '/var/opt/lib/pe-puppet',
         'hieradatadir'     => '/var/lib/hiera',
         'hieraconf'        => '/etc/puppetlabs/puppet/hiera.yaml',
@@ -42,9 +44,11 @@ module Unix
         'puppetserver-confdir' => '/etc/puppetserver/conf.d',
         'puppetservice'     => 'puppetmaster',
         'puppetpath'        => '/etc/puppet',
+        'puppetconfdir'     => '/etc/puppet',
         'puppetvardir'      => '/var/lib/puppet',
         'puppetbin'         => '/usr/bin/puppet',
         'puppetbindir'      => '/usr/bin',
+        'systembindir'      => '/usr/bin',
         'hieralibdir'       => '/opt/puppet-git-repos/hiera/lib',
         'hierapuppetlibdir' => '/opt/puppet-git-repos/hiera-puppet/lib',
         'hierabindir'       => '/opt/puppet-git-repos/hiera/bin',
@@ -58,12 +62,18 @@ module Unix
 
     def self.aio_defaults
       h = self.foss_defaults
-      h['puppetbindir'] = '/opt/puppetlabs/agent/bin'
-      h['puppetpath'] = '/opt/puppetlabs/agent'
-      h['puppetvardir'] = '/opt/puppetlabs/agent/cache'
-      h['distmoduledir'] = '/opt/puppetlabs/agent/modules'
-      h['sitemoduledir'] = '/etc/puppetlabs/agent/modules'
-      h['hieraconf'] = ' /etc/puppetlabs/agent/hiera.conf'
+      h['puppetserver-confdir'] = '/etc/puppetlabs/puppetserver/conf.d'
+      h['puppetservice']  = 'puppetserver'
+      h['puppetbindir']   = '/opt/puppetlabs/agent/bin'
+      h['puppetbin']      = "#{h['puppetbindir']}/puppet"
+      h['puppetpath']     = '/etc/puppetlabs/agent'
+      h['puppetconfdir']  = "#{h['puppetpath']}/config"
+      h['puppetcodedir']  = "#{h['puppetpath']}/code"
+      h['puppetvardir']   = '/opt/puppetlabs/agent/cache'
+      h['distmoduledir']  = "#{h['puppetcodedir']}/modules"
+      h['sitemoduledir']  = '/opt/puppetlabs/agent/modules'
+      h['hieraconf']      = "#{h['puppetcodedir']}/hiera.yaml"
+      h['hieradatadir']   = "#{h['puppetcodedir']}/hieradata"
       h
     end
   end