Add Vagrant config support

Adds a new `vagrant.default.yml` config file which is used for Vagrant
related settings in `Vagrantfile.`

`vagrant.local.yml` is also supported as a local, untracked config file
which takes precedence over the default.

Author: swalkinshaw

CHANGELOG.md

@@ -1,5 +1,6 @@
 ### HEAD
 * Ansible 2.3 compatibility ([#813](https://github.com/roots/trellis/pull/813))
+* Add Vagrant config ([#828](https://github.com/roots/trellis/pull/828))
 * Remove potentially dangerous `db_import` option ([#825](https://github.com/roots/trellis/pull/825))
 
 ### 1.0.0-rc.1: April 7th, 2017

Vagrantfile

@@ -1,73 +1,50 @@
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
-require 'yaml'
-
-ip = '192.168.50.5' # pick any local IP
-cpus = 1
-memory = 1024 # in MB
-
 ANSIBLE_PATH = __dir__ # absolute path to Ansible directory on host machine
 ANSIBLE_PATH_ON_VM = '/home/vagrant/trellis' # absolute path to Ansible directory on virtual machine
 
-# Set Ansible paths relative to Ansible directory
-ENV['ANSIBLE_CONFIG'] = ANSIBLE_PATH
-ENV['ANSIBLE_CALLBACK_PLUGINS'] = "~/.ansible/plugins/callback_plugins/:/usr/share/ansible_plugins/callback_plugins:#{File.join(ANSIBLE_PATH, 'lib/trellis/plugins/callback')}"
-ENV['ANSIBLE_FILTER_PLUGINS'] = "~/.ansible/plugins/filter_plugins/:/usr/share/ansible_plugins/filter_plugins:#{File.join(ANSIBLE_PATH, 'lib/trellis/plugins/filter')}"
-ENV['ANSIBLE_LIBRARY'] = "/usr/share/ansible:#{File.join(ANSIBLE_PATH, 'lib/trellis/modules')}"
-ENV['ANSIBLE_ROLES_PATH'] = File.join(ANSIBLE_PATH, 'vendor', 'roles')
-ENV['ANSIBLE_VARS_PLUGINS'] = "~/.ansible/plugins/vars_plugins/:/usr/share/ansible_plugins/vars_plugins:#{File.join(ANSIBLE_PATH, 'lib/trellis/plugins/vars')}"
+require File.join(ANSIBLE_PATH, 'lib', 'trellis', 'vagrant')
+require 'yaml'
 
-config_file = File.join(ANSIBLE_PATH, 'group_vars', 'development', 'wordpress_sites.yml')
+vconfig = YAML.load_file("#{ANSIBLE_PATH}/vagrant.default.yml")
 
-def fail_with_message(msg)
-  fail Vagrant::Errors::VagrantError.new, msg
+if File.exist?("#{ANSIBLE_PATH}/vagrant.local.yml")
+  local_config = YAML.load_file("#{ANSIBLE_PATH}/vagrant.local.yml")
+  vconfig.merge!(local_config) if local_config
 end
 
-if File.exists?(config_file)
-  wordpress_sites = YAML.load_file(config_file)['wordpress_sites']
-  fail_with_message "No sites found in #{config_file}." if wordpress_sites.to_h.empty?
-else
-  fail_with_message "#{config_file} was not found. Please set `ANSIBLE_PATH` in your Vagrantfile."
-end
+wordpress_sites = load_wordpress_sites
+site_hosts = hosts(wordpress_sites)
 
 Vagrant.require_version '>= 1.8.5'
 
 Vagrant.configure('2') do |config|
-  config.vm.box = 'bento/ubuntu-16.04'
-  config.vm.box_version = '2.2.9'
+  config.vm.box = vconfig.fetch('vagrant_box')
+  config.vm.box_version = vconfig.fetch('vagrant_box_version')
   config.ssh.forward_agent = true
-
   config.vm.post_up_message = post_up_message
 
   # Fix for: "stdin: is not a tty"
   # https://github.com/mitchellh/vagrant/issues/1673#issuecomment-28288042
   config.ssh.shell = %{bash -c 'BASH_ENV=/etc/profile exec bash'}
 
   # Required for NFS to work
-  config.vm.network :private_network, ip: ip, hostsupdater: 'skip'
-
-  site_hosts = wordpress_sites.flat_map { |(_name, site)| site['site_hosts'] }
-
-  site_hosts.each do |host|
-    if !host.is_a?(Hash) or !host.has_key?('canonical')
-      fail_with_message File.read(File.join(ANSIBLE_PATH, 'roles/common/templates/site_hosts.j2')).sub!('{{ env }}', 'development').gsub!(/com$/, 'dev')
-    end
-  end
+  config.vm.network :private_network, ip: vconfig.fetch('vagrant_ip'), hostsupdater: 'skip'
 
   main_hostname, *hostnames = site_hosts.map { |host| host['canonical'] }
   config.vm.hostname = main_hostname
 
-  redirects = site_hosts.flat_map { |host| host['redirects'] }.compact
-
   if Vagrant.has_plugin?('vagrant-hostmanager') && !multisite_subdomains?(wordpress_sites)
+    redirects = site_hosts.flat_map { |host| host['redirects'] }.compact
+
     config.hostmanager.enabled = true
     config.hostmanager.manage_host = true
     config.hostmanager.aliases = hostnames + redirects
   elsif Vagrant.has_plugin?('landrush') && multisite_subdomains?(wordpress_sites)
     config.landrush.enabled = true
     config.landrush.tld = config.vm.hostname
-    hostnames.each { |host| config.landrush.host host, ip }
+    hostnames.each { |host| config.landrush.host host, vconfig.fetch('vagrant_ip') }
   else
     fail_with_message "vagrant-hostmanager missing, please install the plugin with this command:\nvagrant plugin install vagrant-hostmanager\n\nOr install landrush for multisite subdomains:\nvagrant plugin install landrush"
   end
@@ -78,6 +55,7 @@ Vagrant.configure('2') do |config|
     wordpress_sites.each_pair do |name, site|
       config.vm.synced_folder local_site_path(site), remote_site_path(name, site), owner: 'vagrant', group: 'www-data', mount_options: ['dmode=776', 'fmode=775']
     end
+
     config.vm.synced_folder ANSIBLE_PATH, ANSIBLE_PATH_ON_VM, mount_options: ['dmode=755', 'fmode=644']
     config.vm.synced_folder File.join(ANSIBLE_PATH, 'bin'), bin_path, mount_options: ['dmode=755', 'fmode=755']
   else
@@ -88,37 +66,49 @@ Vagrant.configure('2') do |config|
         config.vm.synced_folder local_site_path(site), nfs_path(name), type: 'nfs'
         config.bindfs.bind_folder nfs_path(name), remote_site_path(name, site), u: 'vagrant', g: 'www-data', o: 'nonempty'
       end
+
       config.vm.synced_folder ANSIBLE_PATH, '/ansible-nfs', type: 'nfs'
       config.bindfs.bind_folder '/ansible-nfs', ANSIBLE_PATH_ON_VM, o: 'nonempty', p: '0644,a+D'
       config.bindfs.bind_folder bin_path, bin_path, perms: '0755'
     end
   end
 
+  vconfig.fetch('vagrant_synced_folders', []).each do |folder|
+    options = {
+      type: folder.fetch('type', 'nfs'),
+      create: folder.fetch('create', false),
+      mount_options: folder.fetch('mount_options', [])
+    }
+
+    config.vm.synced_folder folder['local_path'], folder['destination'], options
+
+    if folder.fetch('bindfs', true)
+      config.bindfs.bind_folder folder['local_path'], folder['destination'], options
+    end
+  end
+
   provisioner = Vagrant::Util::Platform.windows? ? :ansible_local : :ansible
   provisioning_path = Vagrant::Util::Platform.windows? ? ANSIBLE_PATH_ON_VM : ANSIBLE_PATH
+
   config.vm.provision provisioner do |ansible|
     if Vagrant::Util::Platform.windows?
       ansible.install_mode = 'pip'
       ansible.provisioning_path = provisioning_path
-      ansible.version = '2.2.0'
+      ansible.version = vconfig.fetch('vagrant_ansible_version')
     end
 
     ansible.playbook = File.join(provisioning_path, 'dev.yml')
-    unless ENV['SKIP_GALAXY']
-      ansible.galaxy_role_file = File.join(provisioning_path, 'requirements.yml')
-    end
+    ansible.galaxy_role_file = File.join(provisioning_path, 'requirements.yml') unless vconfig.fetch('vagrant_skip_galaxy') || ENV['SKIP_GALAXY']
     ansible.galaxy_roles_path = File.join(provisioning_path, 'vendor/roles')
 
     ansible.groups = {
       'web' => ['default'],
       'development' => ['default']
     }
 
-    if tags = ENV['ANSIBLE_TAGS']
-      ansible.tags = tags
-    end
+    ansible.tags = ENV['ANSIBLE_TAGS']
+    ansible.extra_vars = { 'vagrant_version' => Vagrant::VERSION }
 
-    ansible.extra_vars = {'vagrant_version' => Vagrant::VERSION}
     if vars = ENV['ANSIBLE_VARS']
       extra_vars = Hash[vars.split(',').map { |pair| pair.split('=') }]
       ansible.extra_vars.merge(extra_vars)
@@ -128,8 +118,8 @@ Vagrant.configure('2') do |config|
   # Virtualbox settings
   config.vm.provider 'virtualbox' do |vb|
     vb.name = config.vm.hostname
-    vb.customize ['modifyvm', :id, '--cpus', cpus]
-    vb.customize ['modifyvm', :id, '--memory', memory]
+    vb.customize ['modifyvm', :id, '--cpus', vconfig.fetch('vagrant_cpus')]
+    vb.customize ['modifyvm', :id, '--memory', vconfig.fetch('vagrant_memory')]
 
     # Fix for slow external network connections
     vb.customize ['modifyvm', :id, '--natdnshostresolver1', 'on']
@@ -140,43 +130,16 @@ Vagrant.configure('2') do |config|
   ['vmware_fusion', 'vmware_workstation'].each do |provider|
     config.vm.provider provider do |vmw, override|
       vmw.name = config.vm.hostname
-      vmw.vmx['numvcpus'] = cpus
-      vmw.vmx['memsize'] = memory
+      vmw.vmx['numvcpus'] = vconfig.fetch('vagrant_cpus')
+      vmw.vmx['memsize'] = vconfig.fetch('vagrant_memory')
     end
   end
 
   # Parallels settings
   config.vm.provider 'parallels' do |prl, override|
     prl.name = config.vm.hostname
-    prl.cpus = cpus
+    prl.cpus = vconfig.fetch('vagrant_cpus')
+    prl.memory = vconfig.fetch('vagrant_memory')
     prl.update_guest_tools = true
-    prl.memory = memory
   end
-
-end
-
-def local_site_path(site)
-  File.expand_path(site['local_path'], ANSIBLE_PATH)
-end
-
-def multisite_subdomains?(wordpress_sites)
-  wordpress_sites.any? { |(_name, site)| site['multisite'].fetch('enabled', false) && site['multisite'].fetch('subdomains', false) }
-end
-
-def nfs_path(site_name)
-  "/vagrant-nfs-#{site_name}"
-end
-
-def post_up_message
-  msg = 'Your Trellis Vagrant box is ready to use!'
-  msg << "\n* Composer and WP-CLI commands need to be run on the virtual machine."
-  msg << "\n* You can SSH into the machine with `vagrant ssh`."
-  msg << "\n* Then navigate to your WordPress sites at `/srv/www`"
-  msg << "\n  or to your Trellis files at `#{ANSIBLE_PATH_ON_VM}`."
-
-  msg
-end
-
-def remote_site_path(site_name, site)
-  "/srv/www/#{site_name}/#{site['current_path'] || 'current'}"
 end

lib/trellis/vagrant.rb

@@ -0,0 +1,64 @@
+# Set Ansible paths relative to Ansible directory
+ENV['ANSIBLE_CONFIG'] = ANSIBLE_PATH
+ENV['ANSIBLE_CALLBACK_PLUGINS'] = "~/.ansible/plugins/callback_plugins/:/usr/share/ansible_plugins/callback_plugins:#{File.join(ANSIBLE_PATH, 'lib/trellis/plugins/callback')}"
+ENV['ANSIBLE_FILTER_PLUGINS'] = "~/.ansible/plugins/filter_plugins/:/usr/share/ansible_plugins/filter_plugins:#{File.join(ANSIBLE_PATH, 'lib/trellis/plugins/filter')}"
+ENV['ANSIBLE_LIBRARY'] = "/usr/share/ansible:#{File.join(ANSIBLE_PATH, 'lib/trellis/modules')}"
+ENV['ANSIBLE_ROLES_PATH'] = File.join(ANSIBLE_PATH, 'vendor', 'roles')
+ENV['ANSIBLE_VARS_PLUGINS'] = "~/.ansible/plugins/vars_plugins/:/usr/share/ansible_plugins/vars_plugins:#{File.join(ANSIBLE_PATH, 'lib/trellis/plugins/vars')}"
+
+def fail_with_message(msg)
+  fail Vagrant::Errors::VagrantError.new, msg
+end
+
+def load_wordpress_sites
+  config_file = File.join(ANSIBLE_PATH, 'group_vars', 'development', 'wordpress_sites.yml')
+
+  if File.exists?(config_file)
+    wordpress_sites = YAML.load_file(config_file)['wordpress_sites']
+    fail_with_message "No sites found in #{config_file}." if wordpress_sites.to_h.empty?
+  else
+    fail_with_message "#{config_file} was not found. Please set `ANSIBLE_PATH` in your Vagrantfile."
+  end
+
+  wordpress_sites
+end
+
+def local_site_path(site)
+  File.expand_path(site['local_path'], ANSIBLE_PATH)
+end
+
+def multisite_subdomains?(wordpress_sites)
+  wordpress_sites.any? do |(_name, site)|
+    site['multisite'].fetch('enabled', false) && site['multisite'].fetch('subdomains', false)
+  end
+end
+
+def nfs_path(site_name)
+  "/vagrant-nfs-#{site_name}"
+end
+
+def post_up_message
+  msg = 'Your Trellis Vagrant box is ready to use!'
+  msg << "\n* Composer and WP-CLI commands need to be run on the virtual machine."
+  msg << "\n* You can SSH into the machine with `vagrant ssh`."
+  msg << "\n* Then navigate to your WordPress sites at `/srv/www`"
+  msg << "\n  or to your Trellis files at `#{ANSIBLE_PATH_ON_VM}`."
+
+  msg
+end
+
+def remote_site_path(site_name, site)
+  "/srv/www/#{site_name}/#{site['current_path'] || 'current'}"
+end
+
+def hosts(sites)
+  site_hosts = sites.flat_map { |(_name, site)| site['site_hosts'] }
+
+  site_hosts.each do |host|
+    if !host.is_a?(Hash) || !host.has_key?('canonical')
+      fail_with_message File.read(File.join(ANSIBLE_PATH, 'roles/common/templates/site_hosts.j2')).sub!('{{ env }}', 'development').gsub!(/com$/, 'dev')
+    end
+  end
+
+  site_hosts
+end

vagrant.default.yml

@@ -0,0 +1,18 @@
+---
+vagrant_ip: '192.168.50.5'
+vagrant_cpus: 1
+vagrant_memory: 1024 # in MB
+vagrant_box: 'bento/ubuntu-16.04'
+vagrant_box_version: '2.2.9'
+vagrant_ansible_version: '2.2.2'
+vagrant_skip_galaxy: false
+
+# Array of synced folders:
+# - local_path: .
+#   destination: /path/on/vm
+#   create: false
+#   type: nfs
+#   bindfs: true
+#   mount_options: []
+# See https://www.vagrantup.com/docs/synced-folders/basic_usage.html#mount_options
+vagrant_synced_folders: []