beaker-vagrant 0.6.4 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98a299de5416fe4cbbd2a865bbba1afdb75ad1ed0d32f43495d055b12652eb17
-  data.tar.gz: 8277b502cb524396bd7ec8b1e4beae7966d3a365c5a5ce6330272b85c2b16141
+  metadata.gz: 7a00ef186adc7650704953e106d18e8c4a93f345a757bb7ea3c47837fb064543
+  data.tar.gz: 0744ee0ef7ece6991dc3fc62ca92da90e7c6ea00a68ac381ecc1fbdeba330f32
 SHA512:
-  metadata.gz: c703f74e712e9cae4f596f50bdbf6f6ede7d9586507c47be5614f6fcfa309dde383e64140a08d8dc8464f17bd5a1d4a3b85434d2f1be8463247c63eef8320f80
-  data.tar.gz: 3395d540e69595342585485776a50f79067c137d4443d12664c38030c0c7120c4b07c92127973ca0d02813e09d33c2c1aa1505151dacce4cf20a50efe3d29b7e
+  metadata.gz: 5d4a32047a14b49cdcb325cb4cd1d341664a6cf1df32d4e3d6e094afe71f0e0712b19d13de2af683b43512818989e64a961d9f62e7e9df955c7589ec6e78646b
+  data.tar.gz: a36190c0a555b3154762c913558a28c46d2791714692000df6bca474a1700bf2991f97edad53025b70c67dac5fb0403200d05ee37e49062483f62abdea36f517

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10

data/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Release
+
+on:
+  create:
+    ref_type: tag
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    if: github.repository == 'voxpupuli/beaker-vagrant'
+    env:
+      BUNDLE_WITHOUT: release
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Ruby 2.7
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+      - name: Build gem
+        run: gem build *.gemspec
+      - name: Publish gem
+        run: gem push *.gem
+        env:
+          GEM_HOST_API_KEY: '${{ secrets.RUBYGEMS_AUTH_TOKEN }}'

data/.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Test
+
+on:
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "2.4"
+          - "2.5"
+          - "2.6"
+          - "2.7"
+    env:
+      BUNDLE_WITHOUT: release
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run spec tests
+        run: bundle exec rake test:spec
+      # It seems some additonal setup of Docker may be needed for
+      # the acceptance tests to work.
+      # - name: Run acceptance tests
+      #   run: bundle exec rake test:acceptance

data/.rspec

@@ -1,3 +1,4 @@
 --format documentation
 --color
 --tty
+--fail-fast

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on
+[Keep a Changelog](http://keepachangelog.com)
+& makes a strong effort to adhere to
+[Semantic Versioning](http://semver.org).
+
+Tracking in this Changelog began for this project in version 0.7.1
+If you're looking for changes from before this, refer to the project's
+git logs & PR history.
+
+The headers used in [Keep a Changelog](http://keepachangelog.com) are:
+
+- Added - for new features.
+- Changed - for changes in existing functionality.
+- Deprecated - for soon-to-be removed features.
+- Removed - for now removed features.
+- Fixed - for any bug fixes.
+- Security - in case of vulnerabilities.
+
+# [0.7.1](https://github.com/voxpupuli/beaker/compare/0.7.0...0.7.1) - 25-05-2021
+
+### Fixed
+
+- Re-added the secondary libvirt interface due to 0.7.0 breaking multi-node tests

data/Rakefile

@@ -6,14 +6,14 @@ namespace :test do
 
     desc "Run spec tests"
     RSpec::Core::RakeTask.new(:run) do |t|
-      t.rspec_opts = ['--color']
+      t.rspec_opts = ['--color', '--format documentation']
       t.pattern = 'spec/'
     end
 
     desc "Run spec tests with coverage"
     RSpec::Core::RakeTask.new(:coverage) do |t|
       ENV['BEAKER_TEMPLATE_COVERAGE'] = 'y'
-      t.rspec_opts = ['--color']
+      t.rspec_opts = ['--color', '--format documentation']
       t.pattern = 'spec/'
     end
 

data/beaker-vagrant.gemspec

@@ -24,18 +24,14 @@ Gem::Specification.new do |s|
   if RUBY_VERSION < "2.3"
     s.add_development_dependency 'fakefs', '~> 0.6', '< 0.14'
   else
-    s.add_development_dependency 'fakefs', '~> 0.6'
+    s.add_development_dependency 'fakefs', '>= 0.6', '< 2.0'
   end
-  s.add_development_dependency 'rake', '~> 10.1'
+  s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'pry', '~> 0.10'
 
   # Documentation dependencies
   s.add_development_dependency 'yard'
   s.add_development_dependency 'thin'
-
-  # Run time dependencies
-  s.add_runtime_dependency 'stringify-hash', '~> 0.0.0'
-
 end
 

data/docs/vagrant.md

@@ -1,5 +1,21 @@
 # Vagrant
 
+<!-- vim-markdown-toc GFM -->
+
+  * [Getting Started](#getting-started)
+    * [Requirements](#requirements)
+    * [Setup a Vagrant Hosts File](#setup-a-vagrant-hosts-file)
+* [Vagrant-Specific Hosts File Settings](#vagrant-specific-hosts-file-settings)
+    * [Running With a GUI](#running-with-a-gui)
+    * [Mounting Local Folders](#mounting-local-folders)
+    * [Forwarding Ports to Guest](#forwarding-ports-to-guest)
+    * [Volumes Support](#volumes-support)
+    * [Adding vagrant shell provisioner](#adding-vagrant-shell-provisioner)
+    * [Using the host's resolver as a DNS proxy in NAT mode (virtualbox only)](#using-the-hosts-resolver-as-a-dns-proxy-in-nat-mode-virtualbox-only)
+* [vagrant plugins](#vagrant-plugins)
+
+<!-- vim-markdown-toc -->
+
 Vagrant's slogan is "development environments made easy". Vagrant provides an
 abstraction on top of a VM or cloud provider that allows you to manage
 hosts and their provisioning. <https://www.vagrantup.com/>.
@@ -211,8 +227,30 @@ When using the Vagrant Hypervisor, beaker can create the Vagrantfile with a shel
 
 In the above, beaker will create a Vagrantfile which runs the above shell script on the Agent guest.
 
+### Using the host's resolver as a DNS proxy in NAT mode (virtualbox only)
+
+When using the Vagrant hypervisor with the virtualbox provider, beaker can
+configure the VirtualBox NAT engine's DHCP sever to proxy DNS queries through
+to the host's resolver using the `natdns` setting in the nodeset file.
+
+**Example hosts file**
+
+    HOSTS:
+      el7-server:
+        roles:
+          - default
+        platform: el-7-x86_64
+        box: centos/7
+        hypervisor: vagrant
+        natdns: on
+        yum_repos:
+          epel:
+            mirrorlist: 'https://mirrors.fedoraproject.org/mirrorlist?repo=epel-7&arch=$basearch&country=us'
+            gpgkeys:
+              - https://dl.fedoraproject.org/pub/epel/RPM-GPG-KEY-EPEL-$releasever
+
 # vagrant plugins #
 
-You can check more information for some suported vagrant plugins:
+You can check more information for some supported vagrant plugins:
 
  - [vagrant-libvirt](vagrant_libvirt.md)

data/lib/beaker-vagrant/version.rb

@@ -1,3 +1,3 @@
 module BeakerVagrant
-  VERSION = '0.6.4'
+  VERSION = '0.7.1'
 end

data/lib/beaker/hypervisor/vagrant.rb

@@ -5,36 +5,33 @@ module Beaker
 
     require 'beaker/hypervisor/vagrant/mount_folder'
     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}"
+    def randip(hypervisor=nil)
+      case hypervisor
+      when /libvirt/
+        "10.254.#{rand_chunk}.#{rand_chunk}"
+      else
+        "10.255.#{rand_chunk}.#{rand_chunk}"
+      end
     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'
-        @mac = randmac
-        private_network_string << "\n"
-      when nil
-        @mac = randmac
-        private_network_string << ", :mac => \"#{@mac}\"\n"
+      if host['network_mac']
+        private_network_string << ", :mac => \"#{host['network_mac']}\"\n"
       else
-        @mac = host['network_mac']
-        private_network_string << ", :mac => \"#{@mac}\"\n"
+        private_network_string << "\n"
       end
     end
 
+    def connection_preference(host)
+      [:hostname]
+    end
+
     def shell_provisioner_generator(provisioner_config)
       unless provisioner_config['path'].nil? || provisioner_config['path'].empty?
         unless provisioner_config['args'].nil?
@@ -57,7 +54,7 @@ module Beaker
 
       hosts.each do |host|
         host.name.tr!('_','-') # Rewrite Hostname with hyphens instead of underscores to get legal hostname
-        host['ip'] ||= randip #use the existing ip, otherwise default to a random ip
+        set_host_default_ip(host)
         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"
@@ -67,7 +64,7 @@ module Beaker
         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 << shell_provisioner_generator(host['shell_provisioner']) if host['shell_provisioner']
-        v_file << private_network_generator(host)
+        v_file << private_network_generator(host) if host['ip']
 
         unless host['mount_folders'].nil?
           host['mount_folders'].each do |name, folder|
@@ -127,7 +124,6 @@ module Beaker
           else
             v_file << "    v.vm.synced_folder '.', '/vagrant', :nfs => true\n"
           end
-          v_file << "    v.vm.base_mac = '#{@mac}'\n"
         end
 
         v_file << self.class.provider_vfile_section(host, options)
@@ -136,6 +132,9 @@ module Beaker
         @logger.debug "created Vagrantfile for VagrantHost #{host.name}"
       end
       v_file << "end\n"
+
+      # In case this is called directly
+      FileUtils.mkdir_p(@vagrant_path)
       File.open(@vagrant_file, 'w') do |f|
         f.write(v_file)
       end
@@ -181,77 +180,53 @@ module Beaker
     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}")
+      return unless Dir.exist?(@vagrant_path)
 
-        if @options[:forward_ssh_agent] == true
-          ssh_config = ssh_config.gsub(/IdentitiesOnly yes/, "IdentitiesOnly no")
+      ssh_config = Dir.chdir(@vagrant_path) do
+        stdout, _, status = Open3.capture3(@vagrant_env, 'vagrant', 'ssh-config', host.name)
+        unless status.success?
+          raise "Failed to 'vagrant ssh-config' for #{host.name}"
         end
 
-        f.write(ssh_config)
-        f.rewind
-        host['ssh'] = {:config => f.path()}
-        host['user'] = user
-        @temp_files << f
-    end
+        Tempfile.create do |f|
+          f.write(stdout)
+          f.flush
 
-    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}")
+          Net::SSH::Config.for(host.name, [f.path])
         end
-      else
-        raise("No vagrant file found (should be located at #{@vagrant_file})")
       end
-      ip
+
+      ssh_config[:user] = user
+      ssh_config[:keys_only] = false if @options[:forward_ssh_agent] == true
+
+      host['ssh'] = host['ssh'].merge(ssh_config)
+      host['user'] = user
     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_path = File.expand_path(File.join('.vagrant', 'beaker_vagrant_files', 'beaker_' + File.basename(options[:hosts_file])))
       @vagrant_file = File.expand_path(File.join(@vagrant_path, "Vagrantfile"))
       @vagrant_env = { "RUBYLIB" => "", "RUBYOPT" => "" }
     end
 
     def configure(opts = {})
-      if !@options[:provision]
-        if !File.file?(@vagrant_file)
+      unless @options[:provision]
+        unless 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
 
-        @hosts.each do |host|
-          host[:ip] = get_ip_from_vagrant_file(host.name)
-        end
-
         set_all_ssh_config
       end
       super
     end
 
     def provision(provider = nil)
+      FileUtils.mkdir_p(@vagrant_path)
+
       #setting up new vagrant hosts
       #make sure that any old boxes are dead dead dead
       begin
@@ -281,9 +256,6 @@ module Beaker
 
     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)
@@ -339,5 +311,11 @@ module Beaker
         end
       end
     end
+
+    private
+
+    def set_host_default_ip(host)
+      host['ip'] ||= randip(host.host_hash[:hypervisor]) # use the existing ip, otherwise default to a random ip
+    end
   end
 end

data/lib/beaker/hypervisor/vagrant_custom.rb

@@ -6,6 +6,7 @@ class Beaker::VagrantCustom < Beaker::Vagrant
   end
 
   def make_vfile hosts, options = {}
+    FileUtils.mkdir_p(@vagrant_path)
     FileUtils.cp(@options[:vagrantfile_path], @vagrant_file)
   end
 end

data/lib/beaker/hypervisor/vagrant_libvirt.rb

@@ -1,18 +1,14 @@
 require 'beaker/hypervisor/vagrant'
 
 class Beaker::VagrantLibvirt < Beaker::Vagrant
-  @memory = nil
-  @cpu    = nil
-
-  class << self
-    attr_reader :memory
-  end
+  def initialize(*)
+    super
 
-  # Return a random mac address with colons
-  #
-  # @return [String] a random mac address
-  def randmac
-    "08:00:27:" + (1..3).map{"%0.2X"%rand(256)}.join(':')
+    # This needs to be unique for every system with the same hostname but does
+    # not affect VirtualBox
+    vagrant_path_digest = Digest::SHA256.hexdigest(@vagrant_path)
+    @vagrant_path += '_' + vagrant_path_digest[0..2] + vagrant_path_digest[-3..-1]
+    @vagrant_file = File.expand_path(File.join(@vagrant_path, "Vagrantfile"))
   end
 
   def provision(provider = 'libvirt')
@@ -24,19 +20,13 @@ class Beaker::VagrantLibvirt < Beaker::Vagrant
       "      node.cpus = #{cpus(host, options)}\n" +
       "      node.memory = #{memsize(host, options)}\n" +
       "      node.qemu_use_session = false\n" +
-      build_options_str(options) +
+      build_options(options).join("\n") + "\n" +
       "    end\n"
   end
 
-  def self.build_options_str(options)
-    other_options_str = ''
-    if options['libvirt']
-      other_options = []
-      options['libvirt'].each do |k, v|
-        other_options << "      node.#{k} = '#{v}'"
-      end
-      other_options_str = other_options.join("\n")
-    end
-    "#{other_options_str}\n"
+  def self.build_options(options)
+    return [] unless options['libvirt']
+
+    options['libvirt'].map { |k, v| "      node.#{k} = '#{v}'" }
   end
 end