beaker 1.10.0 → 1.11.0

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

@@ -1,7 +1,7 @@
 module Unix::Pkg
   include Beaker::CommandFactory
 
-  # This method overrides {Host::pkg_initialize} to provide
+  # This method overrides {Beaker::Host#pkg_initialize} to provide
   # unix-specific package management setup
   def pkg_initialize
     @apt_needs_update = true
@@ -111,7 +111,7 @@ module Unix::Pkg
   #       DEBIAN_PLATFORM_CODENAMES map must be kept up-to-date as
   #       support for new versions is added.
   #
-  # @note See {Beaker::DSL::Helpers::deploy_package_repo} for info on
+  # @note See {Beaker::DSL::Helpers#deploy_package_repo} for info on
   #       params
   def deploy_apt_repo(path, name, version)
     codename = DEBIAN_PLATFORM_CODENAMES[self['platform']]
@@ -127,7 +127,7 @@ module Unix::Pkg
 
   # Deploy yum configuration generated by the packaging tooling
   #
-  # @note See {Beaker::DSL::Helpers::deploy_package_repo} for info on
+  # @note See {Beaker::DSL::Helpers#deploy_package_repo} for info on
   #       params
   def deploy_yum_repo(path, name, version)
     repo_file = "#{path}/rpm/pl-#{name}-#{version}-repos-pe-#{self['platform']}.repo"
@@ -136,7 +136,7 @@ module Unix::Pkg
 
   # Deploy zypper repo configuration generated by the packaging tooling
   #
-  # @note See {Beaker::DSL::Helpers::deploy_package_repo} for info on
+  # @note See {Beaker::DSL::Helpers#deploy_package_repo} for info on
   #       params
   def deploy_zyp_repo(path, name, version)
     repo_file = "#{path}/rpm/pl-#{name}-#{version}-repos-pe-#{self['platform']}.repo"
@@ -148,10 +148,10 @@ module Unix::Pkg
 
   # Deploy configuration generated by the packaging tooling to this host.
   #
-  # This method calls one of {deploy_apt_repo}, {deploy_yum_repo}, or
-  # {deploy_zyp_repo} depending on the platform of this Host.
+  # This method calls one of #deploy_apt_repo, #deploy_yum_repo, or
+  # #deploy_zyp_repo depending on the platform of this Host.
   #
-  # @note See {Beaker::DSL::Helpers::deploy_package_repo} for info on
+  # @note See {Beaker::DSL::Helpers#deploy_package_repo} for info on
   #       params
   def deploy_package_repo(path, name, version)
     if not File.exists? path

data/lib/beaker/host/windows.rb

@@ -26,6 +26,8 @@ module Windows
         'puppetservice' => 'pe-httpd',
         'puppetpath'    => '`cygpath -smF 35`/PuppetLabs/puppet/etc',
         'puppetvardir'  => '`cygpath -smF 35`/PuppetLabs/puppet/var',
+        'distmoduledir' => '`cygpath -smF 35`/PuppetLabs/puppet/etc/modules',
+        'sitemoduledir' => 'C:/usr/share/puppet/modules',
         #if an x86 Program Files dir exists then use it, default to just Program Files
         'puppetbindir'  => '$( [ -d "/cygdrive/c/Program Files (x86)" ] && echo "/cygdrive/c/Program Files (x86)" || echo "/cygdrive/c/Program Files" )/Puppet Labs/Puppet Enterprise/bin',
         'pathseparator' => ';',
@@ -39,6 +41,8 @@ module Windows
         'group'             => 'Administrators',
         'puppetpath'        => '`cygpath -smF 35`/PuppetLabs/puppet/etc',
         'puppetvardir'      => '`cygpath -smF 35`/PuppetLabs/puppet/var',
+        'distmoduledir'     => '`cygpath -smF 35`/PuppetLabs/puppet/etc/modules',
+        'sitemoduledir'     => 'C:/usr/share/puppet/modules',
         'hieralibdir'       => '`cygpath -w /opt/puppet-git-repos/hiera/lib`',
         'hierapuppetlibdir' => '`cygpath -w /opt/puppet-git-repos/hiera-puppet/lib`',
         # PATH related variables need to be Unix, which cygwin converts

data/lib/beaker/host_prebuilt_steps.rb

@@ -107,13 +107,19 @@ module Beaker
     end
 
     #Update /etc/hosts on the master node to include a rule for lookup of the master by name/ip.
-    # @param [Host, Array<Host>, String, Symbol] host One or more hosts to act upon
+    # @param [Host, Array<Host>, String, Symbol] hosts One or more hosts to act upon
     # @param [Hash{Symbol=>String}] opts Options to alter execution.
     # @option opts [Beaker::Logger] :logger A {Beaker::Logger} object
     def add_master_entry hosts, opts
       logger = opts[:logger]
       master = only_host_with_role(hosts, :master)
       logger.notify "Add Master entry to /etc/hosts on #{master.name}"
+      if master["hypervisor"] and master["hypervisor"] =~ /docker/
+        # skip on docker because as of 0.8.1 /etc/hosts isn't modifiable
+        # https://github.com/dotcloud/docker/issues/2267
+        logger.debug "Don't update master entry on docker masters"
+        return
+      end
       if master["hypervisor"] and master["hypervisor"] =~ /vagrant/
         logger.debug "Don't update master entry on vagrant masters"
         return
@@ -325,7 +331,8 @@ module Beaker
       else
         logger.debug "Give root a copy of current user's keys, on #{host.name}"
         if host['platform'] =~ /windows/
-          host.exec(Command.new('sudo su -c "cp -r .ssh /home/Administrator/."'))
+          host.exec(Command.new('cp -r .ssh /cygdrive/c/Users/Administrator/.'))
+          host.exec(Command.new('chown -R Administrator /cygdrive/c/Users/Administrator/.ssh'))
         else
           host.exec(Command.new('sudo su -c "cp -r .ssh /root/."'), {:pty => true})
         end

data/lib/beaker/hypervisor.rb

@@ -46,6 +46,8 @@ module Beaker
           Beaker::Vagrant
         when /google/
           Beaker::GoogleCompute
+        when /docker/
+          Beaker::Docker
         when /none/
           Beaker::Hypervisor
         else
@@ -104,7 +106,7 @@ module Beaker
   end
 end
 
-%w( vsphere_helper vagrant fusion blimper aws_sdk vsphere vcloud vcloud_pooled aixer solaris google_compute_helper google_compute).each do |lib|
+%w( vsphere_helper vagrant fusion blimper aws_sdk vsphere vcloud vcloud_pooled aixer solaris docker google_compute_helper google_compute).each do |lib|
   begin
     require "hypervisor/#{lib}"
   rescue LoadError

data/lib/beaker/hypervisor/docker.rb

@@ -0,0 +1,154 @@
+module Beaker
+  class Docker < Beaker::Hypervisor
+
+    def initialize(hosts, options)
+      require 'docker'
+      @options = options
+      @logger = options[:logger]
+      @hosts = hosts
+
+      # increase the http timeouts as provisioning images can be slow
+      ::Docker.options = { :write_timeout => 300, :read_timeout => 300 }
+      # assert that the docker-api gem can talk to your docker
+      # enpoint.  Will raise if there is a version mismatch
+      ::Docker.validate_version!
+      # Pass on all the logging from docker-api to the beaker logger instance
+      ::Docker.logger = @logger
+    end
+
+    def provision
+      @logger.notify "Provisioning docker"
+
+      @hosts.each do |host|
+        @logger.notify "provisioning #{host.name}"
+
+        @logger.debug("Creating image")
+        image = ::Docker::Image.build(dockerfile_for(host), { :rm => true })
+        @logger.debug("Tagging image #{image.id} as #{host.name}")
+        image.tag({
+          :repo => host.name,
+          :force => true,
+        })
+
+        @logger.debug("Creating container from image")
+        container = ::Docker::Container.create({
+          'Image' => host.name,
+          'Hostname' => host.name,
+        })
+
+        @logger.debug("Starting container #{container.id}")
+        container.start({"PublishAllPorts" => true})
+
+        # Find out where the ssh port is from the container
+        ip   = container.json["NetworkSettings"]["Ports"]["22/tcp"][0]["HostIp"]
+        port = container.json["NetworkSettings"]["Ports"]["22/tcp"][0]["HostPort"]
+
+        # Update host metadata
+        host['ip']  = ip
+        host['port'] = port
+        host['ssh']  = {
+          :password => root_password,
+          :port => port,
+        }
+
+        @logger.debug("node available as  ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no root@#{ip} -p #{port}")
+        host['docker_container'] = container
+        host['docker_image'] = image
+      end
+    end
+
+    def cleanup
+      @logger.notify "Cleaning up docker"
+      @hosts.each do |host|
+        if container = host['docker_container']
+          @logger.debug("stop container #{container.id}")
+          begin
+            container.stop
+          rescue Excon::Errors::ClientError => e
+            @logger.warn("stop of container #{container.id} failed: #{e.response.body}")
+          end
+          @logger.debug("delete container #{container.id}")
+          begin
+            container.delete
+          rescue Excon::Errors::ClientError => e
+            @logger.warn("deletion of container #{container.id} failed: #{e.response.body}")
+          end
+        end
+
+        if image = host['docker_image']
+          @logger.debug("delete image #{image.id}")
+          begin
+            image.delete
+          rescue Excon::Errors::ClientError => e
+            @logger.warn("deletion of image #{image.id} failed: #{e.response.body}")
+          end
+        end
+      end
+    end
+
+    private
+
+    def root_password
+      'root'
+    end
+
+    def dockerfile_for(host)
+      # specify base image
+      dockerfile = <<-EOF
+        FROM #{host['image']}
+      EOF
+
+      # additional options to specify to the sshd
+      # may vary by platform
+      sshd_options = ''
+
+      # add platform-specific actions
+      case host['platform']
+      when /ubuntu/, /debian/
+        dockerfile += <<-EOF
+          RUN apt-get update
+          RUN apt-get install -y openssh-server openssh-client
+        EOF
+      when /^el-/, /centos/, /fedora/, /redhat/
+        dockerfile += <<-EOF
+          RUN yum clean all
+          RUN yum install -y sudo openssh-server openssh-clients
+          RUN ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key
+          RUN ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key
+        EOF
+      when /opensuse/, /sles/
+        sshd_options = '-o "PermitRootLogin yes" -o "PasswordAuthentication yes" -o "UsePAM no"'
+        dockerfile += <<-EOF
+          RUN zypper -n in openssh
+          RUN ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key
+          RUN ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key
+        EOF
+      else
+        # TODO add more platform steps here
+        raise "platform #{host['platform']} not yet supported on docker"
+      end
+
+      # Make sshd directory, set root password
+      dockerfile += <<-EOF
+        RUN mkdir -p /var/run/sshd
+        RUN echo root:#{root_password} | chpasswd
+      EOF
+
+      # Any extra commands specified for the host
+      dockerfile += (host['docker_image_commands'] || []).map { |command|
+        "RUN #{command}\n"
+      }.join('')
+
+      # How to start a sshd on port 22.  May be an init for more supervision
+      cmd = host['docker_cmd'] || "/usr/sbin/sshd -D #{sshd_options}"
+      dockerfile += <<-EOF
+        EXPOSE 22
+        CMD #{cmd}
+      EOF
+
+      @logger.debug("Dockerfile is #{dockerfile}")
+      return dockerfile
+    end
+
+  end
+end

data/lib/beaker/hypervisor/ec2_helper.rb

@@ -3,7 +3,7 @@ module Beaker
     # Return a list of open ports for testing based on a hosts role
     #
     # @todo horribly hard-coded
-    # @param [Array<String>] an array of roles
+    # @param [Array<String>] roles An array of roles
     # @return [Array<Number>] array of port numbers
     # @api private
     def self.amiports(roles)

data/lib/beaker/hypervisor/google_compute_helper.rb

@@ -513,7 +513,7 @@ module Beaker
     end
 
     #Set tags on a Google Compute instance
-    #@param [Array<String>] tags An array of tags to be added to an instance
+    #@param [Array<String>] data An array of tags to be added to an instance
     #@return [Hash] A correctly formatted Google Compute request hash
     def instance_setMetadata_req(name, fingerprint, data)
       { :api_method => @compute.instances.set_metadata,

data/lib/beaker/options/parser.rb

@@ -195,6 +195,7 @@ module Beaker
       #  - --fail-mode is one of 'fast', 'stop' or nil
       #  - if using blimpy hypervisor an EC2 YAML file exists
       #  - if using the aix, solaris, or vcloud hypervisors a .fog file exists
+      #  - if using docker hypervisor are using RUBY 1.9+
       #  - that one and only one master is defined per set of hosts
       #  - that solaris/windows/aix hosts are agent only for PE tests OR
       #  - that windows/aix host are agent only if type is not 'pe'
@@ -260,6 +261,12 @@ module Beaker
             check_yaml_file(@options[:dot_fog], "required by #{visor}")
           end
         end
+        #if using docker need ruby 1.9+
+        if hypervisors.include?('docker')
+          if RUBY_VERSION < '1.9'
+            parser_error "Cannot use the 'docker' hypervisor on Ruby < 1.9 (using #{RUBY_VERSION})"
+          end
+        end
 
         #check that roles of hosts make sense
         # - must be one and only one master

data/lib/beaker/options/presets.rb

@@ -5,73 +5,93 @@ module Beaker
     module Presets
 
       # Generates an OptionsHash of the environment variables of interest to Beaker
-      # 
-      # Currently supports:
-      #
-      #   consoleport, IS_PE, pe_dist_dir, pe_version_file, pe_version_file_win, pe_ver
       #
       # @return [OptionsHash] The supported environment variables in an OptionsHash,
       #                       empty or nil environment variables are removed from the OptionsHash
       def self.env_vars
         h = Beaker::Options::OptionsHash.new
+        consoleport = ENV['BEAKER_CONSOLEPORT'] || ENV['consoleport']
         h.merge({
-          :consoleport => ENV['consoleport'] ? ENV['consoleport'].to_i : nil,
-          :type => ENV['IS_PE'] ? 'pe' : nil,
-          :pe_dir => ENV['pe_dist_dir'],
-          :pe_version_file => ENV['pe_version_file'],
-          :pe_version_file_win => ENV['pe_version_file'],
-          :pe_ver => ENV['pe_ver'],
-          :project => ENV['BEAKER_project'],
-          :department => ENV['BEAKER_department'],
-          :jenkins_build_url => ENV['BUILD_URL'],
+          :home                => ENV['HOME'],
+          :project             => ENV['BEAKER_PROJECT'] || ENV['BEAKER_project'],
+          :department          => ENV['BEAKER_DEPARTMENT'] || ENV['BEAKER_department'],
+          :jenkins_build_url   => ENV['BEAKER_BUILD_URL'] || ENV['BUILD_URL'],
+          :consoleport         => consoleport ? consoleport.to_i : nil,
+          :type                => (ENV['BEAKER_IS_PE'] || ENV['IS_PE']) ? 'pe' : nil,
+          :pe_dir              => ENV['BEAKER_PE_DIR'] || ENV['pe_dist_dir'],
+          :pe_version_file     => ENV['BEAKER_PE_VERSION_FILE'] || ENV['pe_version_file'],
+          :pe_version_file_win => ENV['BEAKER_PE_VERSION_FILE'] || ENV['pe_version_file'],
+          :pe_ver              => ENV['BEAKER_PE_VER'] || ENV['pe_ver'],
+          :forge_host          => ENV['BEAKER_FORGE_HOST'] || ENV['forge_host'],
+          :answers             => {
+                                    :q_puppet_enterpriseconsole_auth_user_email =>
+                                      ENV['q_puppet_enterpriseconsole_auth_user_email'] || 'admin@example.com',
+                                    :q_puppet_enterpriseconsole_auth_password =>
+                                      ENV['q_puppet_enterpriseconsole_auth_password'] || '~!@#$%^*-/ aZ',
+                                    :q_puppet_enterpriseconsole_smtp_host =>
+                                      ENV['q_puppet_enterpriseconsole_smtp_host'],
+                                    :q_puppet_enterpriseconsole_smtp_port =>
+                                      ENV['q_puppet_enterpriseconsole_smtp_port'] || 25,
+                                    :q_puppet_enterpriseconsole_smtp_username =>
+                                      ENV['q_puppet_enterpriseconsole_smtp_username'],
+                                    :q_puppet_enterpriseconsole_smtp_password =>
+                                      ENV['q_puppet_enterpriseconsole_smtp_password'],
+                                    :q_puppet_enterpriseconsole_smtp_use_tls =>
+                                      ENV['q_puppet_enterpriseconsole_smtp_use_tls'] || 'n',
+                                    :q_verify_packages =>
+                                      ENV['q_verify_packages'] || 'y',
+                                    :q_puppetdb_password =>
+                                      ENV['q_puppetdb_password'] || '~!@#$%^*-/ aZ',
+                                  }
         }.delete_if {|key, value| value.nil? or value.empty? })
       end
 
       # Generates an OptionsHash of preset values for arguments supported by Beaker
-      # 
+      #
       # @return [OptionsHash] The supported arguments in an OptionsHash
       def self.presets
         h = Beaker::Options::OptionsHash.new
         h.merge({
-          :project => 'Beaker',
-          :department => ENV['USER'] || ENV['USERNAME'] || 'unknown',
-          :validate => true,
-          :jenkins_build_url => nil,
-          :log_level => 'verbose',
-          :trace_limit => 10,
-          :hosts_file => 'sample.cfg',
-          :options_file => nil,
-          :type => 'pe',
-          :provision => true,
-          :preserve_hosts => 'never',
-          :root_keys => false,
-          :quiet => false,
-          :xml => false,
-          :color => true,
-          :dry_run => false,
-          :timeout => 300,
-          :fail_mode => 'slow',
-          :timesync => false,
-          :repo_proxy => false,
-          :add_el_extras => false,
-          :add_master_entry => false,
-          :consoleport => 443,
-          :pe_dir => '/opt/enterprise/dists',
-          :pe_version_file => 'LATEST',
+          :project             => 'Beaker',
+          :department          => ENV['USER'] || ENV['USERNAME'] || 'unknown',
+          :validate            => true,
+          :jenkins_build_url   => nil,
+          :forge_host          => 'vulcan-acceptance.delivery.puppetlabs.net',
+          :log_level           => 'verbose',
+          :trace_limit         => 10,
+          :hosts_file          => 'sample.cfg',
+          :options_file        => nil,
+          :type                => 'pe',
+          :provision           => true,
+          :preserve_hosts      => 'never',
+          :root_keys           => false,
+          :quiet               => false,
+          :xml                 => false,
+          :color               => true,
+          :dry_run             => false,
+          :timeout             => 300,
+          :fail_mode           => 'slow',
+          :timesync            => false,
+          :repo_proxy          => false,
+          :add_el_extras       => false,
+          :add_master_entry    => false,
+          :consoleport         => 443,
+          :pe_dir              => '/opt/enterprise/dists',
+          :pe_version_file     => 'LATEST',
           :pe_version_file_win => 'LATEST-win',
-          :dot_fog => File.join(ENV['HOME'], '.fog'),
-          :ec2_yaml => 'config/image_templates/ec2.yaml',
-          :help => false,
-          :ssh => {
-            :config                => false,
-            :paranoid              => false,
-            :timeout               => 300,
-            :auth_methods          => ["publickey"],
-            :port                  => 22,
-            :forward_agent         => true,
-            :keys                  => ["#{ENV['HOME']}/.ssh/id_rsa"],
-            :user_known_hosts_file => "#{ENV['HOME']}/.ssh/known_hosts",
-          }
+          :dot_fog             => File.join(ENV['HOME'], '.fog'),
+          :ec2_yaml            => 'config/image_templates/ec2.yaml',
+          :help                => false,
+          :ssh                 => {
+                                    :config                => false,
+                                    :paranoid              => false,
+                                    :timeout               => 300,
+                                    :auth_methods          => ["publickey"],
+                                    :port                  => 22,
+                                    :forward_agent         => true,
+                                    :keys                  => ["#{ENV['HOME']}/.ssh/id_rsa"],
+                                    :user_known_hosts_file => "#{ENV['HOME']}/.ssh/known_hosts",
+                                  }
         })
       end