vagrant 1.5.0 → 2.4.4

data/plugins/synced_folders/smb/synced_folder.rb

@@ -0,0 +1,189 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "digest/md5"
+require "json"
+
+require "log4r"
+
+require "vagrant/util/platform"
+require "vagrant/util/powershell"
+
+require_relative "errors"
+
+module VagrantPlugins
+  module SyncedFolderSMB
+    class SyncedFolder < Vagrant.plugin("2", :synced_folder)
+
+      # Maximum number of times to retry requesting username/password
+      CREDENTIAL_RETRY_MAX = 5
+
+      def initialize(*args)
+        super
+
+        @logger = Log4r::Logger.new("vagrant::synced_folders::smb")
+      end
+
+      def usable?(machine, raise_error=false)
+        # If the machine explicitly states SMB is not supported, then
+        # believe it
+        return false if !machine.config.smb.functional
+        return true if machine.env.host.capability?(:smb_installed) &&
+          machine.env.host.capability(:smb_installed)
+        return false if !raise_error
+        raise Errors::SMBNotSupported
+      end
+
+      def prepare(machine, folders, opts)
+        machine.ui.output(I18n.t("vagrant_sf_smb.preparing"))
+
+        smb_username = smb_password = nil
+
+        # If we need auth information, then ask the user.
+        have_auth = false
+        folders.each do |id, data|
+          smb_username = data[:smb_username] if data[:smb_username]
+          smb_password = data[:smb_password] if data[:smb_password]
+          if smb_username && smb_password
+            have_auth = true
+            break
+          end
+        end
+
+        modify_username = false
+        if !have_auth
+          machine.ui.detail(I18n.t("vagrant_sf_smb.warning_password") + "\n ")
+          retries = 0
+          while retries < CREDENTIAL_RETRY_MAX do
+            if smb_username
+              username = machine.ui.ask("Username (#{smb_username}): ")
+              smb_username = username if username != ""
+              modify_username = true
+            else
+              smb_username = machine.ui.ask("Username (user[@domain]): ")
+            end
+
+            smb_password = machine.ui.ask("Password (will be hidden): ", echo: false)
+            auth_success = true
+
+            if machine.env.host.capability?(:smb_validate_password)
+              Vagrant::Util::CredentialScrubber.sensitive(smb_password)
+              auth_success = machine.env.host.capability(:smb_validate_password,
+                machine, smb_username, smb_password)
+            end
+
+            break if auth_success
+            machine.ui.output(I18n.t("vagrant_sf_smb.incorrect_credentials") + "\n ")
+            retries += 1
+          end
+
+          if retries >= CREDENTIAL_RETRY_MAX
+            raise Errors::CredentialsRequestError
+          end
+        end
+
+        # Check if this host can start and SMB service
+        if machine.env.host.capability?(:smb_start)
+          machine.env.host.capability(:smb_start)
+        end
+
+        folders.each do |id, data|
+          if modify_username
+            # Only override original username if user requests to
+            data[:smb_username] = smb_username
+          else
+            data[:smb_username] ||= smb_username
+          end
+          data[:smb_password] ||= smb_password
+
+          # Register password as sensitive
+          Vagrant::Util::CredentialScrubber.sensitive(data[:smb_password])
+        end
+
+        machine.env.host.capability(:smb_prepare, machine, folders, opts)
+      end
+
+      def enable(machine, folders, opts)
+        machine.ui.output(I18n.t("vagrant_sf_smb.mounting"))
+
+        # Make sure that this machine knows this dance
+        if !machine.guest.capability?(:mount_smb_shared_folder)
+          raise Vagrant::Errors::GuestCapabilityNotFound,
+            cap: "mount_smb_shared_folder",
+            guest: machine.guest.name.to_s
+        end
+
+        # Setup if we have it
+        if machine.guest.capability?(:smb_install)
+          machine.guest.capability(:smb_install)
+        end
+
+        # Detect the host IP for this guest if one wasn't specified
+        # for every folder.
+        host_ip = nil
+        need_host_ip = false
+        folders.each do |id, data|
+          if !data[:smb_host]
+            need_host_ip = true
+            break
+          end
+        end
+
+        if need_host_ip
+          candidate_ips = machine.env.host.capability(:configured_ip_addresses)
+          @logger.debug("Potential host IPs: #{candidate_ips.inspect}")
+          host_ip = machine.guest.capability(
+            :choose_addressable_ip_addr, candidate_ips)
+          if !host_ip
+            raise Errors::NoHostIPAddr
+          end
+        end
+
+        # This is used for defaulting the owner/group
+        ssh_info = machine.ssh_info
+
+        folders.each do |id, data|
+          data[:smb_host] ||= host_ip
+
+          # Default the owner/group of the folder to the SSH user
+          data[:owner] ||= ssh_info[:username]
+          data[:group] ||= ssh_info[:username]
+
+          machine.ui.detail(I18n.t(
+            "vagrant_sf_smb.mounting_single",
+            host: data[:hostpath].to_s,
+            guest: data[:guestpath].to_s))
+          machine.guest.capability(
+            :mount_smb_shared_folder, data[:smb_id], data[:guestpath], data)
+
+          clean_folder_configuration(data)
+        end
+      end
+
+      # Nothing to do here but ensure folder options are scrubbed
+      def disable(machine, folders, opts)
+        folders.each do |_, data|
+          clean_folder_configuration(data)
+        end
+      end
+
+      def cleanup(machine, opts)
+        if machine.env.host.capability?(:smb_cleanup)
+          machine.env.host.capability(:smb_cleanup, machine, opts)
+        end
+      end
+
+      protected
+
+      # Remove data that should not be persisted within folder
+      # specific configuration
+      #
+      # @param [Hash] data Folder configuration
+      def clean_folder_configuration(data)
+        return if !data.is_a?(Hash)
+        data.delete(:smb_password)
+        nil
+      end
+    end
+  end
+end

data/plugins/synced_folders/unix_mount_helpers.rb

@@ -0,0 +1,122 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "shellwords"
+require "vagrant/util/retryable"
+
+module VagrantPlugins
+  module SyncedFolder
+    module UnixMountHelpers
+
+      def self.extended(klass)
+        if !klass.class_variable_defined?(:@@logger)
+          klass.class_variable_set(:@@logger, Log4r::Logger.new(klass.name.downcase))
+        end
+        klass.extend Vagrant::Util::Retryable
+      end
+
+      def detect_owner_group_ids(machine, guest_path, mount_options, options)
+        mount_uid = find_mount_options_id("uid", mount_options)
+        mount_gid = find_mount_options_id("gid", mount_options)
+
+        if mount_uid.nil?
+          if options[:owner].to_i.to_s == options[:owner].to_s
+            mount_uid = options[:owner]
+            self.class_variable_get(:@@logger).debug("Owner user ID (provided): #{mount_uid}")
+          else
+            output = {stdout: '', stderr: ''}
+            uid_command = "id -u #{options[:owner]}"
+            machine.communicate.execute(uid_command,
+              error_class: Vagrant::Errors::VirtualBoxMountFailed,
+              error_key: :virtualbox_mount_failed,
+              command: uid_command,
+              output: output[:stderr]
+            ) { |type, data| output[type] << data if output[type] }
+            mount_uid = output[:stdout].chomp
+            self.class_variable_get(:@@logger).debug("Owner user ID (lookup): #{options[:owner]} -> #{mount_uid}")
+          end
+        else
+          machine.ui.warn "Detected mount owner ID within mount options. (uid: #{mount_uid} guestpath: #{guest_path})"
+        end
+
+        if mount_gid.nil?
+          if options[:group].to_i.to_s == options[:group].to_s
+            mount_gid = options[:group]
+            self.class_variable_get(:@@logger).debug("Owner group ID (provided): #{mount_gid}")
+          else
+            begin
+              output = {stdout: '', stderr: ''}
+              gid_command = "getent group #{options[:group]}"
+              machine.communicate.execute(gid_command,
+                error_class: Vagrant::Errors::VirtualBoxMountFailed,
+                error_key: :virtualbox_mount_failed,
+                command: gid_command,
+                output: output[:stderr]
+              ) { |type, data| output[type] << data if output[type] }
+              mount_gid = output[:stdout].split(':').at(2).to_s.chomp
+              self.class_variable_get(:@@logger).debug("Owner group ID (lookup): #{options[:group]} -> #{mount_gid}")
+            rescue Vagrant::Errors::VirtualBoxMountFailed
+              if options[:owner] == options[:group]
+                self.class_variable_get(:@@logger).debug("Failed to locate group `#{options[:group]}`. Group name matches owner. Fetching effective group ID.")
+                output = {stdout: ''}
+                result = machine.communicate.execute("id -g #{options[:owner]}",
+                  error_check: false
+                ) { |type, data| output[type] << data if output[type] }
+                mount_gid = output[:stdout].chomp if result == 0
+                self.class_variable_get(:@@logger).debug("Owner group ID (effective): #{mount_gid}")
+              end
+              raise unless mount_gid
+            end
+          end
+        else
+          machine.ui.warn "Detected mount group ID within mount options. (gid: #{mount_gid} guestpath: #{guest_path})"
+        end
+        {:gid => mount_gid, :uid => mount_uid}
+      end
+
+      def find_mount_options_id(id_name, mount_options)
+        id_line = mount_options.detect{|line| line.include?("#{id_name}=")}
+        if id_line
+          match = id_line.match(/,?#{Regexp.escape(id_name)}=(?<option_id>\d+),?/)
+          found_id = match["option_id"]
+          updated_id_line = [
+            match.pre_match,
+            match.post_match
+          ].find_all{|string| !string.empty?}.join(',')
+          if updated_id_line.empty?
+            mount_options.delete(id_line)
+          else
+            idx = mount_options.index(id_line)
+            mount_options.delete(idx)
+            mount_options.insert(idx, updated_id_line)
+          end
+        end
+        found_id
+      end
+
+      def emit_upstart_notification(machine, guest_path)
+        # Emit an upstart event if we can
+        machine.communicate.sudo <<-EOH.gsub(/^ {12}/, "")
+            if test -x /sbin/initctl && command -v /sbin/init && /sbin/init 2>/dev/null --version | grep upstart; then
+              /sbin/initctl emit --no-wait vagrant-mounted MOUNTPOINT=#{guest_path}
+            fi
+          EOH
+      end
+
+      def merge_mount_options(base, overrides)
+        base = base.join(",").split(",")
+        overrides = overrides.join(",").split(",")
+        b_kv = Hash[base.map{|item| item.split("=", 2) }]
+        o_kv = Hash[overrides.map{|item| item.split("=", 2) }]
+        merged = {}.tap do |opts|
+          (b_kv.keys + o_kv.keys).uniq.each do |key|
+            opts[key] = o_kv.fetch(key, b_kv[key])
+          end
+        end
+        merged.map do |key, value|
+          [key, value].compact.join("=")
+        end
+      end
+    end
+  end
+end

data/scripts/install_rvm

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+export DEBIAN_FRONTEND=noninteractive
+
+if ! rvm --version
+then
+  # https://github.com/rvm/ubuntu_rvm#install
+  apt-add-repository -y ppa:rael-gc/rvm &&
+    apt-get update -y &&
+    apt-get install -y rvm || {
+      echo 'Failed to install rvm' >&2
+      exit 1
+    }
+fi
+
+usermod -a -G rvm vagrant || {
+  echo 'Failed to add vagrant to the rvm group' >&2
+  exit 1
+}

data/scripts/setup_tests

@@ -0,0 +1,49 @@
+#!/usr/bin/env bash
+
+rvm --version || {
+  echo 'rvm not installed' >&2
+  exit 1
+}
+
+# bsdtar is required for a small subset of the tests
+if ! bsdtar --version
+then
+  apt-get install -y bsdtar &&
+    bsdtar --version || {
+      echo 'Failed to install bsdtar' >&2
+      exit 1
+    }
+fi
+
+# Install next-to-last Ruby that complies with Vagrant's version
+# constraint
+RUBY_VER_REQ=$(
+  awk '
+    $1 == "s.required_ruby_version" { print $4 }
+  ' /vagrant/vagrant.gemspec |
+    tr -d '"')
+RUBY_VER=$(sudo -u vagrant -i rvm list known |
+             tr '[]-' ' ' |
+             awk "/^ ruby  ${RUBY_VER_REQ:0:1}\./ { print \$2 }" |
+             sort -r |
+             sed -n '2p')
+sudo -u vagrant -i rvm install "${RUBY_VER}"
+sudo -u vagrant -i rvm --default use "${RUBY_VER}"
+
+# Output the Ruby version (for sanity)
+sudo -u vagrant -i ruby --version
+
+# Upgrade Rubygems
+sudo -u vagrant -i rvm "${RUBY_VER}" do gem update --system
+
+# Prepare to run unit tests
+sudo -u vagrant -i bash -c 'cd /vagrant; bundle install'
+
+# Automatically move into the shared folder, but only add the command if
+# it's not already there.
+if ! grep -q 'cd /vagrant' /home/vagrant/.bash_profile
+then
+  cat <<EOF >> /home/vagrant/.bash_profile
+cd /vagrant
+EOF
+fi

data/scripts/sign.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+set -e
+
+# Get the parent directory of where this script is.
+SOURCE="${BASH_SOURCE[0]}"
+while [ -h "$SOURCE" ] ; do SOURCE="$(readlink "$SOURCE")"; done
+DIR="$( cd -P "$( dirname "$SOURCE" )/.." && pwd )"
+
+# Change into that dir because we expect that
+cd $DIR
+
+# Get the version from the command line
+VERSION=$1
+if [ -z $VERSION ]; then
+    echo "Please specify a version."
+    exit 1
+fi
+
+# Make the checksums
+pushd ./pkg/dist
+shasum -a256 * > ./vagrant_${VERSION}_SHA256SUMS
+# if [ -z $NOSIGN ]; then
+#   echo "==> Signing..."
+#   gpg --default-key 348FFC4C --detach-sig ./vagrant_${VERSION}_SHA256SUMS
+# fi
+popd

data/scripts/website_push_www.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+
+# Set the tmpdir
+if [ -z "$TMPDIR" ]; then
+  TMPDIR="/tmp"
+fi
+
+# Create a temporary build dir and make sure we clean it up. For
+# debugging, comment out the trap line.
+DEPLOY=`mktemp -d /tmp/vagrant-www-XXXXXX`
+trap "rm -rf $DEPLOY" INT TERM EXIT
+
+# Get the parent directory of where this script is.
+SOURCE="${BASH_SOURCE[0]}"
+while [ -h "$SOURCE" ] ; do SOURCE="$(readlink "$SOURCE")"; done
+DIR="$( cd -P "$( dirname "$SOURCE" )/.." && pwd )"
+
+# Copy into tmpdir
+shopt -s dotglob
+cp -R $DIR/website/www/* $DEPLOY/
+
+# Change into that directory
+cd $DEPLOY
+
+# Ignore some stuff
+touch .gitignore
+echo ".sass-cache" >> .gitignore
+echo "build" >> .gitignore
+echo "vendor" >> .gitignore
+
+# Add everything
+git init .
+git add .
+git commit -q -m "Deploy by $USER"
+
+git remote add heroku git@heroku.com:vagrantup-www-2.git
+git push -f heroku main
+
+# Cleanup the deploy
+rm -rf $DEPLOY

data/tasks/acceptance.rake

@@ -0,0 +1,22 @@
+namespace :acceptance do
+  desc "shows components that can be tested"
+  task :components do
+    exec("vagrant-spec components --config=vagrant-spec.config.rb")
+  end
+
+  desc "runs acceptance tests"
+  task :run do
+    args = [
+      "--config=vagrant-spec.config.rb",
+    ]
+
+    if ENV["COMPONENTS"]
+      args << "--components=\"#{ENV["COMPONENTS"]}\""
+    end
+
+    command = "vagrant-spec test #{args.join(" ")}"
+    puts command
+    puts
+    exec(command)
+  end
+end

data/tasks/bundler.rake

@@ -0,0 +1,3 @@
+# This installs the tasks that help with gem creation and
+# publishing.
+Bundler::GemHelper.install_tasks

data/tasks/test.rake

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+namespace :test do
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = "test/unit/**/*_test.rb"
+  end
+end

data/templates/commands/init/Vagrantfile.erb

@@ -0,0 +1,86 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# All Vagrant configuration is done below. The "2" in Vagrant.configure
+# configures the configuration version (we support older styles for
+# backwards compatibility). Please don't change it unless you know what
+# you're doing.
+Vagrant.configure("2") do |config|
+  # The most common configuration options are documented and commented below.
+  # For a complete reference, please see the online documentation at
+  # https://docs.vagrantup.com.
+
+  # Every Vagrant development environment requires a box. You can search for
+  # boxes at https://vagrantcloud.com/search.
+  config.vm.box = "<%= box_name %>"
+  <% if box_version -%>
+  config.vm.box_version = "<%= box_version %>"
+  <% end -%>
+
+  <% if box_url -%>
+  # The url from where the 'config.vm.box' box will be fetched if it
+  # doesn't already exist on the user's system.
+  config.vm.box_url = "<%= box_url %>"
+  <% else -%>
+  # Disable automatic box update checking. If you disable this, then
+  # boxes will only be checked for updates when the user runs
+  # `vagrant box outdated`. This is not recommended.
+  # config.vm.box_check_update = false
+  <% end -%>
+
+  # Create a forwarded port mapping which allows access to a specific port
+  # within the machine from a port on the host machine. In the example below,
+  # accessing "localhost:8080" will access port 80 on the guest machine.
+  # NOTE: This will enable public access to the opened port
+  # config.vm.network "forwarded_port", guest: 80, host: 8080
+
+  # Create a forwarded port mapping which allows access to a specific port
+  # within the machine from a port on the host machine and only allow access
+  # via 127.0.0.1 to disable public access
+  # config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1"
+
+  # Create a private network, which allows host-only access to the machine
+  # using a specific IP.
+  # config.vm.network "private_network", ip: "192.168.33.10"
+
+  # Create a public network, which generally matched to bridged network.
+  # Bridged networks make the machine appear as another physical device on
+  # your network.
+  # config.vm.network "public_network"
+
+  # Share an additional folder to the guest VM. The first argument is
+  # the path on the host to the actual folder. The second argument is
+  # the path on the guest to mount the folder. And the optional third
+  # argument is a set of non-required options.
+  # config.vm.synced_folder "../data", "/vagrant_data"
+
+  # Disable the default share of the current code directory. Doing this
+  # provides improved isolation between the vagrant box and your host
+  # by making sure your Vagrantfile isn't accessible to the vagrant box.
+  # If you use this you may want to enable additional shared subfolders as
+  # shown above.
+  # config.vm.synced_folder ".", "/vagrant", disabled: true
+
+  # Provider-specific configuration so you can fine-tune various
+  # backing providers for Vagrant. These expose provider-specific options.
+  # Example for VirtualBox:
+  #
+  # config.vm.provider "virtualbox" do |vb|
+  #   # Display the VirtualBox GUI when booting the machine
+  #   vb.gui = true
+  #
+  #   # Customize the amount of memory on the VM:
+  #   vb.memory = "1024"
+  # end
+  #
+  # View the documentation for the provider you are using for more
+  # information on available options.
+
+  # Enable provisioning with a shell script. Additional provisioners such as
+  # Ansible, Chef, Docker, Puppet and Salt are also available. Please see the
+  # documentation for more information about their specific syntax and use.
+  # config.vm.provision "shell", inline: <<-SHELL
+  #   apt-get update
+  #   apt-get install -y apache2
+  # SHELL
+end

data/templates/commands/init/Vagrantfile.min.erb

@@ -0,0 +1,12 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "<%= box_name %>"
+  <% if box_version -%>
+  config.vm.box_version = "<%= box_version %>"
+  <% end -%>
+  <% if box_url -%>
+  config.vm.box_url = "<%= box_url %>"
+  <% end -%>
+end

data/templates/commands/ssh_config/config.erb

@@ -0,0 +1,42 @@
+Host <%= host_key %>
+<% if config -%>
+  Include <%= config %>
+<% end -%>
+  HostName <%= ssh_host %>
+  User <%= ssh_user %>
+  Port <%= ssh_port %>
+<% if ! verify_host_key || verify_host_key == :never -%>
+  UserKnownHostsFile /dev/null
+  StrictHostKeyChecking no
+<% end -%>
+  PasswordAuthentication no
+<% if private_key_path -%>
+<% private_key_path.each do |path| %>
+<% if path.include?(" ") -%>
+  IdentityFile "<%= path %>"
+<% else -%>
+  IdentityFile <%= path %>
+<% end -%>
+<% end -%>
+<% end -%>
+<% if keys_only -%>
+  IdentitiesOnly yes
+<% end -%>
+<% if log_level -%>
+  LogLevel <%= log_level %>
+<% else -%>
+  LogLevel FATAL
+<% end -%>
+<% if forward_agent -%>
+  ForwardAgent yes
+<% end -%>
+<% if forward_x11 -%>
+  ForwardX11 yes
+<% end -%>
+<% if proxy_command -%>
+  ProxyCommand <%= proxy_command %>
+<% end -%>
+<% if !disable_deprecated_algorithms -%>
+  PubkeyAcceptedKeyTypes +ssh-rsa
+  HostKeyAlgorithms +ssh-rsa
+<% end -%>

data/templates/commands/winrm_config/config.erb

@@ -0,0 +1,11 @@
+Host <%= host_key %>
+  HostName <%= winrm_host %>
+  User <%= winrm_user %>
+  Password <%= winrm_password %>
+  Port <%= winrm_port %>
+  <% if rdp_port -%>
+  RDPHostName <%= rdp_host %>
+  RDPPort <%= rdp_port %>
+  RDPUser <%= rdp_user %>
+  RDPPassword <%= rdp_pass %>
+  <% end -%>

data/templates/config/messages.erb

@@ -0,0 +1,14 @@
+<% if !warnings.empty? -%>
+Warnings:
+<% warnings.each do |warning| -%>
+* <%= warning %>
+<% end -%>
+
+<% end -%>
+<% if !errors.empty? -%>
+Errors:
+<% errors.each do |error| -%>
+* <%= error %>
+<% end -%>
+
+<% end -%>

data/templates/config/validation_failed.erb

@@ -0,0 +1,7 @@
+<% errors.each do |section, list| -%>
+<%= section %>:
+<% list.each do |error| -%>
+* <%= error %>
+<% end -%>
+
+<% end -%>

data/templates/guests/alpine/network_dhcp.erb

@@ -0,0 +1,13 @@
+#VAGRANT-BEGIN
+# The contents below are automatically generated by Vagrant. Do not modify.
+auto eth<%= options[:interface] %>
+iface eth<%= options[:interface] %> inet dhcp
+<% if !options[:use_dhcp_assigned_default_route] %>
+    post-up route del default dev $IFACE || true
+<% else %>
+    # We need to disable eth0, see GH-2648
+    post-up route del default dev eth0
+
+    pre-down route add default dev eth0
+<% end %>
+#VAGRANT-END