Refactoring and improvements

- Added use_nfs option to disable NFS folder synchronization, if necessary
- Added option to clean existing project files during project initialization

Author: Alexander Paliarush

Vagrantfile

@@ -28,6 +28,9 @@ magento_host_name = config_data['magento']['host_name']
 magento_ip_address = config_data['guest']['ip_address']
 guest_memory = config_data['guest']['memory']
 
+# NFS will be used for *nix and OSX hosts, if not disabled explicitly in config
+use_nfs_for_synced_folders = !OS.is_windows && (config_data['guest']['use_nfs'] == 1)
+
 host_magento_dir = Dir.pwd + '/magento2ce'
 
 VAGRANT_API_VERSION = 2
@@ -41,20 +44,20 @@ Vagrant.configure(VAGRANT_API_VERSION) do |config|
     config.vm.synced_folder '.', '/vagrant', disabled: true
     config.vm.synced_folder './local.config', '/vagrant/local.config'
     config.vm.synced_folder './scripts', '/vagrant/scripts'
-    if OS.is_windows
+    if use_nfs_for_synced_folders
+        guest_magento_dir = host_magento_dir
+        config.vm.synced_folder host_magento_dir, guest_magento_dir, type: "nfs"
+    else
         guest_magento_dir = '/var/www/magento2ce'
         config.vm.synced_folder host_magento_dir + '/var/generation', guest_magento_dir + '/var/generation'
         config.vm.synced_folder host_magento_dir + '/app/etc', guest_magento_dir + '/app/etc'
-    else
-        guest_magento_dir = host_magento_dir
-        config.vm.synced_folder host_magento_dir, guest_magento_dir, type: "nfs"
     end
 
     shell_script_args = [
-        OS.is_windows ? "1" : "0",                  #1
+        use_nfs_for_synced_folders ? "1" : "0",     #1
         guest_magento_dir,                          #2
         magento_host_name,                          #3
-        config_data['guest']['use_php7'],           #4
+        config_data['environment']['use_php7'],     #4
         config_data['magento']['backend_frontname'],#5
         config_data['magento']['language'],         #6
         config_data['magento']['timezone'],         #8
@@ -67,7 +70,7 @@ Vagrant.configure(VAGRANT_API_VERSION) do |config|
         s.args = shell_script_args
     end
 
-    if OS.is_windows
+    if !use_nfs_for_synced_folders
         config.vm.provision "deploy_magento_code", type: "file", source: host_magento_dir, destination: '/var/www'
     end
 

init_project.sh

@@ -9,14 +9,30 @@ set -ex
 
 bash "${vagrant_dir}/scripts/host/shell/check_requirements.sh"
 
-# Check out CE repository
-repository_url_ce=$(bash "${vagrant_dir}/scripts/host/shell/get_variable_value.sh" "repository_url_ce")
-git clone ${repository_url_ce} ${magento_ce_dir}
-# Check out EE repository
-# By default EE repository is not specified and EE project is not checked out
-repository_url_ee=$(bash "${vagrant_dir}/scripts/host/shell/get_variable_value.sh" "repository_url_ee")
-if [ -n "${repository_url_ee}" ]; then
-    git clone ${repository_url_ee} ${magento_ee_dir}
+force_project_cleaning=0
+while getopts 'f' flag; do
+  case "${flag}" in
+    f) force_project_cleaning=1 ;;
+    *) error "Unexpected option ${flag}" ;;
+  esac
+done
+
+# Clean up the project before initialization if "-f" option was specified
+if [ ${force_project_cleaning} -eq 1 ]; then
+    vagrant destroy -f
+    rm -rf ${magento_ce_dir} ${vagrant_dir}/.idea ${vagrant_dir}/.vagrant
+fi
+
+if [ ! -d ${magento_ce_dir} ]; then
+    # Check out CE repository
+    repository_url_ce=$(bash "${vagrant_dir}/scripts/host/shell/get_variable_value.sh" "repository_url_ce")
+    git clone ${repository_url_ce} ${magento_ce_dir}
+    # Check out EE repository
+    # By default EE repository is not specified and EE project is not checked out
+    repository_url_ee=$(bash "${vagrant_dir}/scripts/host/shell/get_variable_value.sh" "repository_url_ee")
+    if [ -n "${repository_url_ee}" ]; then
+        git clone ${repository_url_ee} ${magento_ee_dir}
+    fi
 fi
 
 # Update Magento dependencies via Composer

local.config/config.yaml.dist

@@ -2,9 +2,11 @@ repository_url:
   ce: "git@github.com:magento/magento2.git"
   ee: ""
 guest:
+  use_nfs: 1 # NFS will be used for folder synchronization on *nix and OSX hosts by default
   memory: 2048 # Default is 2Gb, around 3Gb is necessary to run functional tests
   ip_address: "192.168.10.11"
-  use_php7: 1
+environment:
+  use_php7: 1 # If set to 0, PHP 5 will be installed
 magento:
   host_name: "magento2.vagrant"
   backend_frontname: "admin"

scripts/host/shell/configure_php_storm.sh

@@ -14,20 +14,14 @@ cp -R "${vagrant_dir}/scripts/host/php-storm-configs/." "${vagrant_dir}/.idea/"
 
 enabled_virtual_host_config="/etc/apache2/sites-available/magento2.conf"
 
-current_os="$(bash ${vagrant_dir}/scripts/host/shell/get_current_os.sh)"
-if [ ${current_os} -eq "OSX" ]; then
-    sed_command="sed -i ''"
-else
-    sed_command="sed -i"
-fi
-
-${sed_command} "s|<host_name>|${magento_host_name}|g" "${vagrant_dir}/.idea/webServers.xml"
-${sed_command} "s|<ssh_port>|${ssh_port}|g" "${vagrant_dir}/.idea/webServers.xml"
-${sed_command} "s|<host_name>|${magento_host_name}|g" "${vagrant_dir}/.idea/php.xml"
-${sed_command} "s|<ssh_port>|${ssh_port}|g" "${vagrant_dir}/.idea/php.xml"
-${sed_command} "s|<host_name>|${magento_host_name}|g" "${vagrant_dir}/.idea/deployment.xml"
-${sed_command} "s|<host_name>|${magento_host_name}|g" "${vagrant_dir}/.idea/.name"
-${sed_command} "s|<host_name>|${magento_host_name}|g" "${vagrant_dir}/.idea/modules.xml"
+sed -i.back "s|<host_name>|${magento_host_name}|g" "${vagrant_dir}/.idea/webServers.xml"
+sed -i.back "s|<ssh_port>|${ssh_port}|g" "${vagrant_dir}/.idea/webServers.xml"
+sed -i.back "s|<host_name>|${magento_host_name}|g" "${vagrant_dir}/.idea/php.xml"
+sed -i.back "s|<ssh_port>|${ssh_port}|g" "${vagrant_dir}/.idea/php.xml"
+sed -i.back "s|<host_name>|${magento_host_name}|g" "${vagrant_dir}/.idea/deployment.xml"
+sed -i.back "s|<host_name>|${magento_host_name}|g" "${vagrant_dir}/.idea/.name"
+sed -i.back "s|<host_name>|${magento_host_name}|g" "${vagrant_dir}/.idea/modules.xml"
+rm -rf ${vagrant_dir}/.idea/*.back
 
 mv "${vagrant_dir}/.idea/<host_name>.iml" "${vagrant_dir}/.idea/${magento_host_name}.iml"
 

scripts/provision/install_environment.sh

@@ -3,7 +3,7 @@
 # Enable trace printing and exit on the first error
 set -ex
 
-is_windows_host=$1
+use_nfs_for_synced_folders=$1
 guest_magento_dir=$2
 magento_host_name=$3
 use_php7=$4
@@ -125,7 +125,7 @@ echo "export PATH=\$PATH:${vagrant_dir}/scripts/guest:${guest_magento_dir}/bin"
 echo "export MAGENTO_ROOT=${guest_magento_dir}" >> /etc/profile
 
 # Set permissions to allow Magento codebase upload by Vagrant provision script
-if [ ${is_windows_host} -eq 1 ]; then
+if [ ${use_nfs_for_synced_folders} -eq 0 ]; then
     chown -R vagrant:vagrant /var/www
     chmod -R 755 /var/www
 fi

scripts/provision/install_magento.sh

@@ -5,7 +5,7 @@
 # Enable trace printing and exit on the first error
 set -ex
 
-is_windows_host=$1
+use_nfs_for_synced_folders=$1
 guest_magento_dir=$2
 magento_host_name=$3
 
@@ -15,11 +15,11 @@ setupOptions[language]=$6
 setupOptions[timezone]=$7
 setupOptions[currency]=$8
 setupOptions[admin_user]=$9
-setupOptions[admin_password]=$10
+setupOptions[admin_password]=${10}
 setupOptions[db_host]='localhost'
 setupOptions[db_name]='magento'
 setupOptions[db_user]='root'
-setupOptions[base_url]='http://${magento_host_name}/'
+setupOptions[base_url]="http://${magento_host_name}/"
 setupOptions[admin_lastname]='Admin'
 setupOptions[admin_firstname]='Admin'
 setupOptions[admin_email]='admin@example.com'
@@ -78,17 +78,17 @@ php ${install_cmd}
 # Enable Magento cron jobs
 echo "* * * * * php ${guest_magento_dir}/bin/magento cron:run &" | crontab -u vagrant -
 
-if [ ${is_windows_host} -eq 1 ]; then
+if [ ${use_nfs_for_synced_folders} -eq 0 ]; then
     chown -R vagrant:vagrant ${guest_magento_dir}
 fi
 
 set +x
 echo "
 Magento application was deployed to ${guest_magento_dir} and installed successfully
 Access storefront at ${setupOptions[base_url]}
-Access admin panel at ${setupOptions[base_url]}${backend_frontame}/"
+Access admin panel at ${setupOptions[base_url]}${setupOptions[backend_frontname]}/"
 
-if [ ${is_windows_host} -eq 1 ]; then
+if [ ${use_nfs_for_synced_folders} -eq 0 ]; then
     echo "
     [Optional] To finish developer environment set up:
         1. Please create new PhpStorm project using 'magento2ce' directory on your host