- Improved developer experience during project initialization

 - Fixed recurring environment variables export
 - Optimized cache clearing script

Author: Alexander Paliarush

Vagrantfile

@@ -34,7 +34,8 @@ 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'
+host_vagrant_dir = Dir.pwd + ''
+host_magento_dir = host_vagrant_dir + '/magento2ce'
 
 VAGRANT_API_VERSION = 2
 Vagrant.configure(VAGRANT_API_VERSION) do |config|
@@ -64,7 +65,8 @@ Vagrant.configure(VAGRANT_API_VERSION) do |config|
         magento_host_name,                          #3
         config_data['environment']['use_php7'],     #4
         host_magento_dir,                           #5
-        OS.is_windows ? "1" : "0"                   #6
+        OS.is_windows ? "1" : "0",                  #6
+        host_vagrant_dir                            #7
     ]
 
     config.vm.provision "configure_environment", type: "shell" do |s|

init_project.sh

@@ -80,7 +80,24 @@ bash "${vagrant_dir}/scripts/host/composer.sh" install
 cd ${vagrant_dir}
 vagrant up
 
+set +x
+echo "Configuring PhpStorm..."
 if [ ${force_project_cleaning} -eq 1 ]; then
     rm -rf ${vagrant_dir}/.idea/*
 fi
 bash "${vagrant_dir}/scripts/host/configure_php_storm.sh"
+
+bold=$(tput bold)
+regular=$(tput sgr0)
+echo "
+${bold}[Important]${regular}
+    Please use ${bold}${vagrant_dir}${regular} directory as PhpStorm project root, NOT ${bold}${magento_ce_dir}${regular}."
+
+use_nfs=$(bash "${vagrant_dir}/scripts/get_config_value.sh" "guest_use_nfs")
+if [[ ${host_os} == "Windows" || ${use_nfs} == 0 ]]; then
+    echo "
+${bold}[Optional]${regular}
+    To verify that deployment configuration for ${bold}${magento_ce_dir}${regular} in PhpStorm is correct,
+        use instructions provided here: ${bold}https://github.com/paliarush/magento2-vagrant-for-developers/blob/2.0/docs/phpstorm-configuration-windows-hosts.md${regular}.
+    If not using PhpStorm, you can set up synchronization using rsync"
+fi

scripts/guest/link_configs

@@ -7,12 +7,14 @@ set -ex
 # Make guest configs visible and editable in the host IDE
 
 # Configs located under /etc/*
-configs=( apache2 php mysql varnish rabbitmq init.d crontab cron.d timezone hosts )
+configs=( apache2 php mysql varnish rabbitmq crontab cron.d timezone hosts profile profile.d )
 for config in "${configs[@]}"
 do
     if [ ! -d /vagrant/etc/guest/${config} ] && [ ! -f /vagrant/etc/guest/${config} ]; then
-        mv /etc/${config} /vagrant/etc/guest/${config}
-        ln -s /vagrant/etc/guest/${config} /etc/${config}
+        if [ -d /etc/${config} ] || [ -f /etc/${config} ]; then
+            mv /etc/${config} /vagrant/etc/guest/${config}
+            ln -s /vagrant/etc/guest/${config} /etc/${config}
+        fi
     fi
 done
 
@@ -21,7 +23,9 @@ configs=( .bashrc .composer .profile )
 for config in "${configs[@]}"
 do
     if [ ! -d /vagrant/etc/guest/${config} ] && [ ! -f /vagrant/etc/guest/${config} ]; then
-        mv /home/vagrant/${config} /vagrant/etc/guest/${config}
-        ln -s /vagrant/etc/guest/${config} /home/vagrant/${config}
+        if [ -d /home/vagrant/${config} ] || [ -f /home/vagrant/${config} ]; then
+            mv /home/vagrant/${config} /vagrant/etc/guest/${config}
+            ln -s /vagrant/etc/guest/${config} /home/vagrant/${config}
+        fi
     fi
 done

scripts/guest/m-clear-cache

@@ -4,14 +4,12 @@ echo "Clearing Magento cache..."
 
 rm -f ${MAGENTO_ROOT}/app/etc/paths.php
 #clear var
-for dir in `ls ${MAGENTO_ROOT}/var` ; do
-    rm -rf ${MAGENTO_ROOT}/var/${dir}/* ;
-done
+cd ${MAGENTO_ROOT} && mv var/.htaccess var_htaccess.back && rm -rf var/* var/.[^.]* && mv var_htaccess.back var/.htaccess
 #clear pub/statics
-cd ${MAGENTO_ROOT}/pub && mv static/.htaccess static_htaccess.back && rm -rf static/* && mv static_htaccess.back static/.htaccess
+cd ${MAGENTO_ROOT}/pub && mv static/.htaccess static_htaccess.back && rm -rf static && mkdir static && mv static_htaccess.back static/.htaccess
 #clear integration tests tmp
-cd ${MAGENTO_ROOT}/dev/tests/integration && mv tmp/.gitignore tmp_gitignore.back && rm -rf tmp/* && mv tmp_gitignore.back tmp/.gitignore
+cd ${MAGENTO_ROOT}/dev/tests/integration && mv tmp/.gitignore tmp_gitignore.back && rm -rf tmp && mkdir tmp && mv tmp_gitignore.back tmp/.gitignore
 #clear unit tests tmp
-cd ${MAGENTO_ROOT}/dev/tests/unit && rm -rf tmp/*
+cd ${MAGENTO_ROOT}/dev/tests/unit && rm -rf tmp && mkdir tmp
 
 echo "Magento cache cleared."

scripts/guest/m-reinstall

@@ -63,7 +63,7 @@ install_cmd="./bin/magento setup:install \
     --use-rewrites=1"
 
 # Configure Rabbit MQ
-if [ -f "${MAGENTO_ROOT}/app/code/Magento/Amqp/registration.php" ]; then
+if [ -f "${MAGENTO_ROOT}/app/etc/enterprise/di.xml" ] && [ -d "${MAGENTO_ROOT}/app/code/Magento/Amqp" ]; then
     install_cmd="${install_cmd} \
     --amqp-host=${setupOptions[amqp_host]} \
     --amqp-port=${setupOptions[amqp_port]} \
@@ -93,15 +93,6 @@ sed -i "s|${MAGENTO_ROOT}|${MAGENTO_ROOT_HOST}|g" "/vagrant/.idea/misc.xml"
 set +x
 echo "
 Magento application was deployed to ${MAGENTO_ROOT} and installed successfully
+
 Access storefront at ${setupOptions[base_url]}
 Access admin panel at ${setupOptions[base_url]}${setupOptions[admin_frontname]}/"
-
-if [[ ${is_windows_host} == 1 || ${use_nfs} == 0 ]]; then
-    echo "
-    [Optional] To finish developer environment set up:
-        1. Please create new PhpStorm project using 'magento2ce' directory on your host
-        (this directory should already contain Magento repository cloned earlier)
-
-        2. Use instructions provided here https://github.com/paliarush/vagrant-magento/blob/2.0/docs/phpstorm-configuration-windows-hosts.md
-        to set up synchronization in PhpStorm (or using rsync) with ${MAGENTO_ROOT} directory"
-fi

scripts/provision/configure_environment.sh

@@ -70,12 +70,6 @@ if [ -f ${composer_auth_json} ]; then
     fi
 fi
 
-# Declare path to scripts supplied with vagrant and Magento
-echo "export PATH=\$PATH:${vagrant_dir}/scripts/guest:${guest_magento_dir}/bin" >> /etc/profile
-echo "export MAGENTO_ROOT=${guest_magento_dir}" >> /etc/profile
-echo "export MAGENTO_ROOT_HOST=${host_magento_dir}" >> /etc/profile
-echo "export IS_WINDOWS_HOST=${is_windows_host}" >> /etc/profile
-
 # Set permissions to allow Magento codebase upload by Vagrant provision script
 if [ ${use_nfs_for_synced_folders} -eq 0 ]; then
     chown -R vagrant:vagrant /var/www

scripts/provision/export_env_variables_recurring.sh

@@ -6,7 +6,20 @@ set -e
 guest_magento_dir=$2
 host_magento_dir=$5
 is_windows_host=$6
+host_vagrant_dir=$7
+vagrant_dir="/vagrant"
 
-export MAGENTO_ROOT=${guest_magento_dir}
-export MAGENTO_ROOT_HOST=${host_magento_dir}
-export IS_WINDOWS_HOST=${is_windows_host}
+if ! cat /etc/profile | grep -q 'export PATH=' ; then
+    echo "export PATH=\$PATH:${vagrant_dir}/scripts/guest:${guest_magento_dir}/bin" >> /etc/profile
+fi
+
+if ! cat /etc/profile | grep -q 'export MAGENTO_ROOT=' ; then
+    echo "export MAGENTO_ROOT=${guest_magento_dir}" >> /etc/profile
+    echo "export MAGENTO_ROOT_HOST=${host_magento_dir}" >> /etc/profile
+    echo "export IS_WINDOWS_HOST=${is_windows_host}" >> /etc/profile
+fi
+
+if ! cat /etc/profile | grep -q 'export VAGRANT_ROOT=' ; then
+    echo "export VAGRANT_ROOT=${vagrant_dir}" >> /etc/profile
+    echo "export VAGRANT_ROOT_HOST=${host_vagrant_dir}" >> /etc/profile
+fi