beaker-vagrant 0.1.0

data/acceptance/config/nodes/redhat-nodes.yml

@@ -0,0 +1,25 @@
+HOSTS:
+  redhat7-64-1:
+    roles:
+      - master
+      - agent
+      - dashboard
+      - databse
+      - classifier
+      - default
+    platform: el-7-x86_64 
+    template: redhat-7-x86_64
+    box: puppetlabs/centos-7.0-64-nocm
+    box_url: https://vagrantcloud.com/puppetlabs/boxes/centos-7.0-64-nocm
+    hypervisor: vagrant
+  redhat7-64-2:
+    roles:
+      - agent
+    platform: el-7-x86_64
+    template: redhat-7-x86_64
+    box: puppetlabs/centos-7.0-64-nocm 
+    box_url: https://vagrantcloud.com/puppetlabs/boxes/centos-7.0-64-nocm
+    hypervisor: vagrant
+CONFIG:
+  nfs_server: none
+  consoleport: 443

data/beaker-vagrant.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'beaker-vagrant/version'
+
+Gem::Specification.new do |s|
+  s.name        = "beaker-vagrant"
+  s.version     = BeakerVagrant::VERSION
+  s.authors     = ["Rishi Javia, Kevin Imber, Tony Vu"]
+  s.email       = ["rishi.javia@puppet.com, kevin.imber@puppet.com, tony.vu@puppet.com"]
+  s.homepage    = "https://github.com/puppetlabs/beaker-vagrant"
+  s.summary     = %q{Beaker DSL Extension Helpers!}
+  s.description = %q{For use for the Beaker acceptance testing tool}
+  s.license     = 'Apache2'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Testing dependencies
+  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', '~> 10.1'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'pry', '~> 0.10'
+
+  # Documentation dependencies
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'markdown'
+  s.add_development_dependency 'thin'
+
+  # Run time dependencies
+  s.add_runtime_dependency 'stringify-hash', '~> 0.0.0'
+
+end
+

data/bin/beaker-vagrant

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'rubygems' unless defined?(Gem)
+require 'beaker-vagrant'
+
+VERSION_STRING =
+"
+                                 _ .--.
+                                ( `    )
+        beaker-vagrant        .-'      `--,
+                  _..----.. (             )`-.
+                .'_|` _|` _|(  .__,           )
+               /_|  _|  _|  _(        (_,  .-'
+              ;|  _|  _|  _|  '-'__,--'`--'
+              | _|  _|  _|  _| |
+          _   ||  _|  _|  _|  _| %s
+        _( `--.\\_|  _|  _|  _|/
+     .-'       )--,|  _|  _|.`
+    (__, (_      ) )_|  _| /
+      `-.__.\\ _,--'\\|__|__/
+                    ;____;
+                     \\YT/
+                      ||
+                     |\"\"|
+                     '=='
+"
+
+
+
+puts BeakerVagrant::Version
+
+exit 0

data/docs/vagrant.md

@@ -0,0 +1,165 @@
+# Vagrant
+
+Vagrant's slogan is "development environments made easy". They provide an
+abstraction on top of a VM or cloud provider that allows you to manage
+hosts and their provisioning. [Their Site](https://www.vagrantup.com/).
+
+# Getting Started
+
+### Requirements
+
+A prerequisite for using the vagrant hypervisor with beaker is that the
+**Vagrant 1.7+** package needs to installed - 
+see [downloads.vagrantup.com](http://downloads.vagrantup.com/) for downloads.
+
+Currently, we provide a suite of pre-built, publicly available vagrant boxes for
+use in constructing tests: [Puppet Labs Vagrant Boxes](https://vagrantcloud.com/puppetlabs/).
+You can use these boxes easily by pulling one of our
+[Example Vagrant Hosts Files](vagrant_hosts_file_examples.md).
+
+### Setup a Vagrant Hosts File
+
+A vm is identified by `box` or `box_url` in the config file.  No snapshot name
+is required as the vm is reverted back to original state post testing using
+`vagrant destroy --force`.
+
+**Example Vagrant hosts file**
+
+    HOSTS:
+      ubuntu-1404-x64:
+        roles:
+          - master
+          - agent
+          - dashboard
+          - cloudpro
+        platform: ubuntu-1404-x86_64
+        hypervisor: vagrant
+        box: puppetlabs/ubuntu-14.04-64-nocm
+        box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
+    CONFIG:
+      nfs_server: none
+      consoleport: 443
+
+VagrantFiles are created per host configuration file.  They can be found in the
+`.vagrant/beaker_vagrant_files` directory of the current working directory in a
+subdirectory named after the host configuration file.
+
+    > beaker --hosts sample.cfg
+    > cd .vagrant/beaker_vagrant_files; ls
+    sample.cfg
+    > cd sample.c
+
+Below are details of vagrants features as they're supported through beaker. If
+you'd like to see more examples of vagrant hosts files, checkout our
+[vagrant hosts file examples doc](vagrant_hosts_file_examples.md).
+
+# Vagrant-Specific Hosts File Settings
+
+### Running With a GUI
+
+It is possible to have the VirtualBox VM run with a GUI (i.e. non-headless mode)
+by specifying ``vb_gui`` of any non-nil value in the config file, i.e.:
+
+**Example Vagrant hosts file with vb_gui**
+
+    HOSTS:
+      ubuntu-1404-x64:
+        roles:
+          - master
+          - agent
+          - dashboard
+          - cloudpro
+        platform: ubuntu-1404-x86_64
+        hypervisor: vagrant
+        box: puppetlabs/ubuntu-14.04-64-nocm
+        box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
+        vb_gui: true
+    CONFIG:
+      nfs_server: none
+      consoleport: 443
+
+### Mounting Local Folders
+
+When using the Vagrant Hypervisor, beaker can mount specific local directories
+as synced_folders inside the vagrant box. This is done by using the
+`mount_folders` option in the nodeset file.
+
+**Example hosts file**
+
+    HOSTS:
+      ubuntu-1404-x64-master:
+        roles:
+          - master
+          - agent
+          - dashboard
+          - database
+        platform: ubuntu-1404-x86_64
+        hypervisor: vagrant
+        box: puppetlabs/ubuntu-14.04-64-nocm
+        box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
+        mount_folders:
+          folder1:
+            from: ./
+            to: /vagrant/folder1
+          tmp:
+            from: /tmp
+            to: /vagrant/tmp
+        ip: 192.168.20.20
+      ubuntu-1404-x64-agent:
+        roles:
+          - agent
+        platform: ubuntu-1404-x86_64
+        hypervisor: vagrant
+        box: puppetlabs/ubuntu-14.04-64-nocm
+        box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
+        ip: 192.168.21.21
+    CONFIG:
+      nfs_server: none
+      consoleport: 443
+
+In the above beaker will mount the folders `./` to `/vagrant/folder1` and the
+folder `/tmp` to `/vagrant/tmp`.
+
+### Forwarding Ports to Guest
+
+When using the Vagrant Hypervisor, beaker can create the Vagrantfile to forward specified ports to a specific box. This is done by using the `forwarded_ports` option in the nodeset file.
+
+**Example hosts file**
+
+    HOSTS:
+      ubuntu-1404-x64-master:
+        roles:
+          - master
+          - agent
+          - dashboard
+          - database
+        platform: ubuntu-1404-x86_64
+        hypervisor: vagrant
+        box: puppetlabs/ubuntu-14.04-64-nocm
+        box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
+        ip: 192.168.20.20
+      ubuntu-1404-x64-agent:
+        roles:
+          - agent
+        platform: ubuntu-1404-x86_64
+        hypervisor: vagrant
+        box: puppetlabs/ubuntu-14.04-64-nocm
+        box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
+        ip: 192.168.21.21
+        forwarded_ports:
+          apache:
+            from: 10080
+            to: 80
+          tomcat:
+            from: 8080
+            to: 8080
+            from_ip: '127.0.0.1'
+            to_ip: '0.0.0.0'
+
+In the above, beaker will forward port 10080 and 8080 on the Host to port 80 and 8080 (respectively) on the Agent guest.
+
+# vagrant plugins #
+
+You can check more information for some suported vagrant plugins:
+
+ - [vagrant-libvirt](vagrant_libvirt.md)

data/docs/vagrant_hosts_file_examples.md

@@ -0,0 +1,60 @@
+#centos-511-x64.yml
+```
+HOSTS:
+  centos-511-x64:
+    roles:
+      - master
+    platform: el-5-x86_64
+    box: puppetlabs/centos-5.11-64-nocm
+    hypervisor: vagrant
+```
+#centos-65-x64.yml
+```
+HOSTS:
+  centos-65-x64:
+    roles:
+      - master
+    platform: el-6-x86_64
+    box: puppetlabs/centos-6.5-64-nocm
+    hypervisor: vagrant
+```
+#debian-609-x64.yml
+```
+HOSTS:
+  debian-609-x64:
+    roles:
+      - master
+    platform: debian-6-amd64
+    box: puppetlabs/debian-6.0.9-64-nocm
+    hypervisor: vagrant
+```
+#debian-78-x64.yml
+```
+HOSTS:
+  debian-78-x64:
+    roles:
+      - master
+    platform: debian-7-amd64
+    box: puppetlabs/debian-7.8-64-nocm
+    hypervisor: vagrant
+```
+#ubuntu-server-1204-x64.yml
+```
+HOSTS:
+  ubuntu-server-1204-x64:
+    roles:
+      - master
+    platform: ubuntu-1204-amd64
+    box: puppetlabs/ubuntu-12.04-64-nocm
+    hypervisor: vagrant
+```
+#ubuntu-server-1404-x64.yml
+```
+HOSTS:
+  ubuntu-server-1404-x64:
+    roles:
+      - master
+    platform: ubuntu-14.04-amd64
+    box: puppetlabs/ubuntu-14.04-64-nocm
+    hypervisor: vagrant
+```

data/docs/vagrant_libvirt.md

@@ -0,0 +1,58 @@
+# Vagrant Libvirt #
+
+This driver enabled a tester to trigger tests using libvirtd daemon.
+It is based
+on [libvirt](https://github.com/vagrant-libvirt/vagrant-libvirt)'s
+plugin for vagrant.
+
+## Basic Options ##
+
+Once you've setup the libvirt daemon on your beaker coordinator, you
+can use the vagrant_libvirt hypervisor by providing beaker with a
+configuration similar to this:
+
+```yaml
+HOSTS
+  centos-puppet-keystone:
+    hostname: puppet-keystone.example.net
+    roles:
+      - master
+    platform: el-7-x86_64
+    box: centos/7
+    box_url:  http://cloud.centos.org/centos/7/vagrant/x86_64/images/CentOS-7.LibVirt.box
+    hypervisor: vagrant_libvirt
+    vagrant_memsize: 4096
+    vagrant_cpus: 2
+```
+
+Those are the usual beaker parameters. Note the `hypervisor`
+parameter. Multiple VMs is supported.
+
+
+## Advanced Options and remote libvirt daemon ##
+
+This driver gives the tester access to all available parameters from
+the vagrant-libvirt plugin. Beware there could be dragons here as
+beaker has some expectations about the created VMs.
+
+To pass them down the operator adds them in the config section, here
+is a example.
+
+```yaml
+CONFIG:
+  libvirt:
+    uri: qemu+ssh://root@libvirt.system.com/system
+```
+
+The `uri` parameter is one of the most useful. The user can have its
+test done on a remote libvirt daemon. The network setup between the
+VMs and the host running beaker will have to be done manually though.
+`management_network_name` and `management_network_address` parameters
+can be useful here.
+
+Another good cadidate is `volume_cache: unsafe`.
+
+A complete list of options is available in
+the
+[vagrant plugin](https://github.com/vagrant-libvirt/vagrant-libvirt)
+repository.

data/lib/beaker-vagrant/version.rb

@@ -0,0 +1,3 @@
+module BeakerVagrant
+  VERSION = '0.1.0'
+end

data/lib/beaker/hypervisor/vagrant.rb

@@ -0,0 +1,287 @@
+require 'open3'
+
+module Beaker
+  class Vagrant < Beaker::Hypervisor
+
+    require 'beaker/hypervisor/vagrant_virtualbox'
+    # Return a random mac address
+    #
+    # @return [String] a random mac address
+    def randmac
+      "080027" + (1..3).map{"%0.2X"%rand(256)}.join
+    end
+
+    def rand_chunk
+      (2 + rand(252)).to_s #don't want a 0, 1, or a 255
+    end
+
+    def randip
+      "10.255.#{rand_chunk}.#{rand_chunk}"
+    end
+
+    def private_network_generator(host)
+      private_network_string = "    v.vm.network :private_network, ip: \"#{host['ip'].to_s}\", :netmask => \"#{host['netmask'] ||= "255.255.0.0"}\""
+      case host['network_mac']
+      when 'false'
+        private_network_string << "\n"
+      when nil
+        private_network_string << ", :mac => \"#{randmac}\"\n"
+      else
+        private_network_string << ", :mac => \"#{host['network_mac']}\"\n"
+      end
+    end
+
+    def make_vfile hosts, options = {}
+      #HACK HACK HACK - add checks here to ensure that we have box + box_url
+      #generate the VagrantFile
+      v_file = "Vagrant.configure(\"2\") do |c|\n"
+      v_file << "  c.ssh.forward_agent = true\n" if options[:forward_ssh_agent] == true
+      v_file << "  c.ssh.insert_key = false\n"
+      hosts.each do |host|
+        host['ip'] ||= randip #use the existing ip, otherwise default to a random ip
+        v_file << "  c.vm.define '#{host.name}' do |v|\n"
+        v_file << "    v.vm.hostname = '#{host.name}'\n"
+        v_file << "    v.vm.box = '#{host['box']}'\n"
+        v_file << "    v.vm.box_url = '#{host['box_url']}'\n" unless host['box_url'].nil?
+        v_file << "    v.vm.box_version = '#{host['box_version']}'\n" unless host['box_version'].nil?
+        v_file << "    v.vm.box_check_update = '#{host['box_check_update'] ||= 'true'}'\n"
+        v_file << "    v.vm.synced_folder '.', '/vagrant', disabled: true\n" if host['synced_folder'] == 'disabled'
+        v_file << private_network_generator(host)
+
+        unless host['mount_folders'].nil?
+          host['mount_folders'].each do |name, folder|
+            v_file << "    v.vm.synced_folder '#{folder[:from]}', '#{folder[:to]}', create: true\n"
+          end
+        end
+
+        unless host['forwarded_ports'].nil?
+          host['forwarded_ports'].each do |_name, port|
+            fwd = "    v.vm.network :forwarded_port,"
+            fwd << " protocol: '#{port[:protocol]}'," unless port[:protocol].nil?
+            fwd << " guest_ip: '#{port[:to_ip]}'," unless port[:to_ip].nil?
+            fwd << " guest: #{port[:to]},"
+            fwd << " host_ip: '#{port[:from_ip]}'," unless port[:from_ip].nil?
+            fwd << " host: #{port[:from]}"
+            fwd << "\n"
+
+            v_file << fwd
+          end
+        end
+
+        if /windows/i.match(host['platform'])
+          #due to a regression bug in versions of vagrant 1.6.2, 1.6.3, 1.6.4, >= 1.7.3 ssh fails to forward
+          #automatically (note <=1.6.1, 1.6.5, 1.7.0 - 1.7.2 are uneffected)
+          #Explicitly setting SSH port forwarding due to this bug
+          v_file << "    v.vm.network :forwarded_port, guest: 22, host: 2222, id: 'ssh', auto_correct: true\n"
+          v_file << "    v.vm.network :forwarded_port, guest: 3389, host: 3389, id: 'rdp', auto_correct: true\n"
+          v_file << "    v.vm.network :forwarded_port, guest: 5985, host: 5985, id: 'winrm', auto_correct: true\n"
+          v_file << "    v.vm.guest = :windows\n"
+        end
+
+        if /osx/i.match(host['platform'])
+          v_file << "    v.vm.network 'private_network', ip: '10.0.1.10'\n"
+          v_file << "    v.vm.synced_folder '.', '/vagrant', :nfs => true\n"
+        end
+
+        if /freebsd/i.match(host['platform'])
+          v_file << "    v.ssh.shell = 'sh'\n"
+          v_file << "    v.vm.guest = :freebsd\n"
+
+          # FreeBSD NFS has a character restriction of 88 characters
+          # So you can enable it but if your module has a long name it probably won't work...
+          # So to keep things simple let's rsync by default!
+          #
+          # Further reading if interested:
+          # http://www.secnetix.de/olli/FreeBSD/mnamelen.hawk
+          # https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=167105
+          #
+          if host['vagrant_freebsd_nfs'].nil?
+            v_file << "    v.vm.synced_folder '.', '/vagrant', type: 'rsync'\n"
+          else
+            v_file << "    v.vm.synced_folder '.', '/vagrant', :nfs => true\n"
+          end
+        end
+
+        v_file << self.class.provider_vfile_section(host, options)
+
+        v_file << "  end\n"
+        @logger.debug "created Vagrantfile for VagrantHost #{host.name}"
+      end
+      v_file << "end\n"
+      File.open(@vagrant_file, 'w') do |f|
+        f.write(v_file)
+      end
+    end
+
+    def self.provider_vfile_section host, options
+      # Backwards compatibility; default to virtualbox
+      Beaker::VagrantVirtualbox.provider_vfile_section(host, options)
+    end
+
+    def set_ssh_config host, user
+        f = Tempfile.new("#{host.name}")
+        ssh_config = Dir.chdir(@vagrant_path) do
+          stdin, stdout, stderr, wait_thr = Open3.popen3(@vagrant_env, 'vagrant', 'ssh-config', host.name)
+          if not wait_thr.value.success?
+            raise "Failed to 'vagrant ssh-config' for #{host.name}"
+          end
+          stdout.read
+        end
+        #replace hostname with ip
+        ssh_config = ssh_config.gsub(/Host #{host.name}/, "Host #{host['ip']}") unless not host['ip']
+
+        #set the user
+        ssh_config = ssh_config.gsub(/User vagrant/, "User #{user}")
+        f.write(ssh_config)
+        f.rewind
+        host['ssh'] = {:config => f.path()}
+        host['user'] = user
+        @temp_files << f
+    end
+
+    def get_ip_from_vagrant_file(hostname)
+      ip = ''
+      if File.file?(@vagrant_file) #we should have a vagrant file available to us for reading
+        f = File.read(@vagrant_file)
+        m = /'#{hostname}'.*?ip:\s*('|")\s*([^'"]+)('|")/m.match(f)
+        if m
+          ip = m[2]
+          @logger.debug("Determined existing vagrant box #{hostname} ip to be: #{ip} ")
+        else
+          ip = nil
+          @logger.debug("Unable to determine ip for vagrant box #{hostname}")
+        end
+      else
+        raise("No vagrant file found (should be located at #{@vagrant_file})")
+      end
+      ip
+    end
+
+    def initialize(vagrant_hosts, options)
+      require 'tempfile'
+      @options = options
+      @logger = options[:logger]
+      @temp_files = []
+      @hosts = vagrant_hosts
+      @vagrant_path = File.expand_path(File.join(File.basename(__FILE__), '..', '.vagrant', 'beaker_vagrant_files', File.basename(options[:hosts_file])))
+      FileUtils.mkdir_p(@vagrant_path)
+      @vagrant_file = File.expand_path(File.join(@vagrant_path, "Vagrantfile"))
+      @vagrant_env = { "RUBYLIB" => "" }
+    end
+
+    def provision(provider = nil)
+      if !@options[:provision] and !File.file?(@vagrant_file)
+        raise "Beaker is configured with provision = false but no vagrant file was found at #{@vagrant_file}. You need to enable provision"
+      end
+      if @options[:provision]
+        #setting up new vagrant hosts
+        #make sure that any old boxes are dead dead dead
+        begin
+          vagrant_cmd("destroy --force") if File.file?(@vagrant_file)
+        rescue RuntimeError => e
+          # LATER: use <<~MESSAGE once we're on Ruby 2.3
+          @logger.debug(%Q{
+            Beaker failed to destroy the existing VM's. If you think this is
+            an error or you upgraded from an older version of beaker try
+            verifying the VM exists and deleting the existing Vagrantfile if
+            you believe it is safe to do so. WARNING: If a VM still exists
+            please run 'vagrant destroy'.
+
+            cd #{@vagrant_path}
+            vagrant status
+            vagrant destroy # only need to run this is a VM is not created
+            rm #{@vagrant_file} # only do this if all VM's are actually destroyed
+          }.each_line.map(&:strip).join("\n"))
+          raise e
+        end
+
+        make_vfile @hosts, @options
+
+        vagrant_cmd("up#{" --provider #{provider}" if provider}")
+      else #set host ip of already up boxes
+        @hosts.each do |host|
+          host[:ip] = get_ip_from_vagrant_file(host.name)
+        end
+      end
+
+      @logger.debug "configure vagrant boxes (set ssh-config, switch to root user, hack etc/hosts)"
+      @hosts.each do |host|
+        if host[:platform] =~ /windows/
+          @logger.debug "skip ssh hacks on windows box #{host[:name]}"
+          set_ssh_config host, host['user']
+          next
+        end
+
+        default_user = host['user']
+
+        set_ssh_config host, 'vagrant'
+
+        #copy vagrant's keys to roots home dir, to allow for login as root
+        copy_ssh_to_root host, @options
+        #ensure that root login is enabled for this host
+        enable_root_login host, @options
+        #shut down connection, will reconnect on next exec
+        host.close
+
+        set_ssh_config host, default_user
+      end
+
+      hack_etc_hosts @hosts, @options
+
+    end
+
+    def cleanup
+      @logger.debug "removing temporary ssh-config files per-vagrant box"
+      @temp_files.each do |f|
+        f.close()
+      end
+      @logger.notify "Destroying vagrant boxes"
+      vagrant_cmd("destroy --force")
+      FileUtils.rm_rf(@vagrant_path)
+    end
+
+    def vagrant_cmd(args)
+      Dir.chdir(@vagrant_path) do
+        exit_status = 1
+        Open3.popen3(@vagrant_env, "vagrant #{args}") {|stdin, stdout, stderr, wait_thr|
+          while line = stdout.gets
+            @logger.info(line)
+          end
+          if not wait_thr.value.success?
+            raise "Failed to exec 'vagrant #{args}'. Error was #{stderr.read}"
+          end
+          exit_status = wait_thr.value
+        }
+        if exit_status != 0
+          raise "Failed to execute vagrant_cmd ( #{args} ). Error was #{stderr.read}"
+        end
+      end
+    end
+
+    def self.cpus(host, options)
+      case
+      when host['vagrant_cpus']
+        host['vagrant_cpus']
+      when options['vagrant_cpus']
+        options['vagrant_cpus']
+      else
+        '1'
+      end
+    end
+
+    def self.memsize(host, options)
+      case
+      when host['vagrant_memsize']
+        host['vagrant_memsize']
+      when options['vagrant_memsize']
+        options['vagrant_memsize']
+      else
+        if host['platform'] =~ /windows/
+          '2048'
+        else
+          '1024'
+        end
+      end
+    end
+  end
+end