- On Windows use m-reinstall instead of m-switch-to-* in init_project.sh

- Improved stability of m-clear-cache and m-reinstall scripts
- Fixed debugginfor web API functional tests (#12)

Author: Alexander Paliarush

Diff for: CHANGELOG.md

@@ -14,7 +14,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
  - Removed requirement for public github token due to Composer limitations (issue is fixed on Composer side)
  - Changed requirement for minimum box version from 1.0 to 1.1
  - Upgraded PHP 5.5.9 to PHP 5.6
- - When [init_project.sh](init_project.sh) is executed, EE will be installed by default, if EE repository is specified in [etc/config.yaml.dist](etc/config.yaml.dist)
+ - When [init_project.sh](init_project.sh) is executed, EE will be installed by default, if EE repository is specified in [etc/config.yaml.dist](etc/config.yaml.dist). Not supported on Windows hosts
 
 ### Fixed
 

Diff for: CONTRIBUTING.md

@@ -1 +1 @@
-Everyone is welcome to contribute improvements and fixes to this project. There are no specific requirements, just create a pull request with proposed modifications.
+Everyone is welcome to contribute improvements and fixes to this project. There are no specific requirements, just create a pull request with proposed modifications and try to run [tests](https://github.com/paliarush/magento2-vagrant-for-developers-tests) on your local environment.

Diff for: init_project.sh

@@ -5,6 +5,9 @@ magento_ce_dir="${vagrant_dir}/magento2ce"
 magento_ee_dir="${magento_ce_dir}/magento2ee"
 config_path="${vagrant_dir}/etc/config.yaml"
 host_os=$(bash "${vagrant_dir}/scripts/host/get_host_os.sh")
+use_nfs=$(bash "${vagrant_dir}/scripts/get_config_value.sh" "guest_use_nfs")
+repository_url_ce=$(bash "${vagrant_dir}/scripts/get_config_value.sh" "repository_url_ce")
+repository_url_ee=$(bash "${vagrant_dir}/scripts/get_config_value.sh" "repository_url_ee")
 
 # Enable trace printing and exit on the first error
 set -ex
@@ -65,11 +68,9 @@ if [[ ! -d ${magento_ce_dir} ]]; then
         git config --global diff.renamelimit 5000
     fi
     # Check out CE repository
-    repository_url_ce=$(bash "${vagrant_dir}/scripts/get_config_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/get_config_value.sh" "repository_url_ee")
     if [[ -n "${repository_url_ee}" ]]; then
         git clone ${repository_url_ee} "${magento_ee_dir}"
     fi
@@ -83,10 +84,15 @@ bash "${vagrant_dir}/scripts/host/composer.sh" install
 cd "${vagrant_dir}"
 vagrant up
 
-if [[ -n "${repository_url_ee}" ]]; then
-    bash "${vagrant_dir}/m-switch-to-ee" -f
+if [[ ${host_os} == "Windows" ]] || [[ ${use_nfs} == 0 ]]; then
+    # Automatic switch to EE during project initialization cannot be supported on Windows
+    bash "${vagrant_dir}/m-reinstall"
 else
-    bash "${vagrant_dir}/m-switch-to-ce" -f
+    if [[ -n "${repository_url_ee}" ]]; then
+        bash "${vagrant_dir}/m-switch-to-ee" -f
+    else
+        bash "${vagrant_dir}/m-switch-to-ce" -f
+    fi
 fi
 
 set +x
@@ -104,8 +110,7 @@ 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
+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,

Diff for: m-switch-to-ce

@@ -9,12 +9,6 @@ php_executable=$(bash "${vagrant_dir}/scripts/host/get_path_to_php.sh")
 # Enable trace printing and exit on the first error
 set -ex
 
-if [[ ! -f ${magento_ee_dir}/app/etc/aliases_to_classes_map.json ]]; then
-    set +x
-    echo "EE codebase is not available"
-    exit 0
-fi
-
 force_switch=0
 while getopts 'f' flag; do
   case "${flag}" in
@@ -23,6 +17,16 @@ while getopts 'f' flag; do
   esac
 done
 
+if [[ ! -f ${magento_ee_dir}/app/etc/aliases_to_classes_map.json ]]; then
+    set +x
+    echo "EE codebase is not available"
+    set -x
+    if [[ ${force_switch} -eq 1 ]]; then
+        bash "${vagrant_dir}/m-reinstall"
+    fi
+    exit 0
+fi
+
 if [[ ! -f ${magento_ce_dir}/app/etc/aliases_to_classes_map.json ]] && [[ ${force_switch} -eq 0 ]]; then
     set +x
     echo "Already switched to CE. Use 'm-switch-to-ce -f' to switch anyway."
@@ -35,7 +39,7 @@ cd ${magento_ce_dir}
 git checkout composer.json
 git checkout composer.lock
 
-if [[ ${host_os} == "Windows" || $(bash "${vagrant_dir}/scripts/get_config_value.sh" "guest_use_nfs") == 0 ]]; then
+if [[ ${host_os} == "Windows" ]] || [[ $(bash "${vagrant_dir}/scripts/get_config_value.sh" "guest_use_nfs") == 0 ]]; then
     # Prevent issues on Windows with incorrect symlinks to files
     if [[ -f ${magento_ce_dir}/app/etc/aliases_to_classes_map.json ]]; then
         rm ${magento_ce_dir}/app/etc/aliases_to_classes_map.json
@@ -50,7 +54,7 @@ bash "${vagrant_dir}/m-clear-cache"
 bash -c "${vagrant_dir}/m-composer install"
 
 echo "Magento installation..."
-if [[ ${host_os} == "Windows" || $(bash "${vagrant_dir}/scripts/get_config_value.sh" "guest_use_nfs") == 0 ]]; then
+if [[ ${host_os} == "Windows" ]] || [[ $(bash "${vagrant_dir}/scripts/get_config_value.sh" "guest_use_nfs") == 0 ]]; then
     read -p "Wait while Magento2 code is uploaded in PhpStorm and press any key to continue..." -n1 -s
 fi
 

Diff for: m-switch-to-ee

@@ -34,7 +34,7 @@ ${php_executable} -f ${magento_ee_dir}/dev/tools/build-ee.php -- --command=link
 cp ${magento_ee_dir}/composer.json ${magento_ce_dir}/composer.json
 cp ${magento_ee_dir}/composer.lock ${magento_ce_dir}/composer.lock
 
-if [[ ${host_os} == "Windows" || $(bash "${vagrant_dir}/scripts/get_config_value.sh" "guest_use_nfs") == 0 ]]; then
+if [[ ${host_os} == "Windows" ]] || [[ $(bash "${vagrant_dir}/scripts/get_config_value.sh" "guest_use_nfs") == 0 ]]; then
     # Prevent issues on Windows with incorrect symlinks to files
     if [[ -f ${magento_ee_dir}/app/etc/aliases_to_classes_map.json ]] && [[ -L ${magento_ce_dir}/app/etc/aliases_to_classes_map.json ]]; then
         rm ${magento_ce_dir}/app/etc/aliases_to_classes_map.json
@@ -51,7 +51,7 @@ bash "${vagrant_dir}/m-clear-cache"
 bash -c "${vagrant_dir}/m-composer install"
 
 echo "Magento installation..."
-if [[ ${host_os} == "Windows" || $(bash "${vagrant_dir}/scripts/get_config_value.sh" "guest_use_nfs") == 0 ]]; then
+if [[ ${host_os} == "Windows" ]] || [[ $(bash "${vagrant_dir}/scripts/get_config_value.sh" "guest_use_nfs") == 0 ]]; then
     read -p "Wait while Magento2 code is uploaded in PhpStorm and press any key to continue..." -n1 -s
 fi
 

Diff for: scripts/guest/m-clear-cache

@@ -2,14 +2,32 @@
 
 echo "Clearing Magento cache..."
 
-rm -f ${MAGENTO_ROOT}/app/etc/paths.php
-#clear var
-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 && 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 && mkdir tmp && mv tmp_gitignore.back tmp/.gitignore
-#clear unit tests tmp
-cd ${MAGENTO_ROOT}/dev/tests/unit && mv tmp/.gitignore tmp_gitignore.back && rm -rf tmp && mkdir tmp && mv tmp_gitignore.back tmp/.gitignore
+rm -f "${MAGENTO_ROOT}/app/etc/paths.php"
+if [[ -d "${MAGENTO_ROOT}/var" ]]; then
+    #clear var
+    cd "${MAGENTO_ROOT}" && mv var/.htaccess var_htaccess.back && rm -rf var/* var/.[^.]*
+    if [[ -f var_htaccess.back ]]; then
+        mv var_htaccess.back var/.htaccess
+    fi
+fi
+if [[ -d "${MAGENTO_ROOT}/pub" ]]; then
+    #clear pub/statics
+    cd "${MAGENTO_ROOT}/pub" && mv static/.htaccess static_htaccess.back && rm -rf static && mkdir static
+    if [[ -f static_htaccess.back ]]; then
+        mv static_htaccess.back static/.htaccess
+    fi
+fi
+if [[ -d "${MAGENTO_ROOT}/dev" ]]; then
+    #clear integration tests tmp
+    cd "${MAGENTO_ROOT}/dev/tests/integration" && mv tmp/.gitignore tmp_gitignore.back && rm -rf tmp && mkdir tmp
+    if [[ -f tmp_gitignore.back ]]; then
+        mv tmp_gitignore.back tmp/.gitignore
+    fi
+    #clear unit tests tmp
+    cd "${MAGENTO_ROOT}/dev/tests/unit" && mv tmp/.gitignore tmp_gitignore.back && rm -rf tmp && mkdir tmp
+    if [[ -f tmp_gitignore.back ]]; then
+        mv tmp_gitignore.back tmp/.gitignore
+    fi
+fi
 
 echo "Magento cache cleared."

Diff for: scripts/guest/m-reinstall

@@ -6,6 +6,8 @@ set -ex
 get_config_value="/vagrant/scripts/get_config_value.sh"
 magento_host_name=$(bash ${get_config_value} "magento_host_name")
 vagrant_dir="/vagrant"
+use_nfs=$(bash "${vagrant_dir}/scripts/get_config_value.sh" "guest_use_nfs")
+is_windows_host=${IS_WINDOWS_HOST}
 
 declare -A setupOptions
 setupOptions[admin_frontname]=$(bash ${get_config_value} "magento_admin_frontname")
@@ -27,6 +29,10 @@ setupOptions[amqp_user]='guest'
 setupOptions[amqp_password]='guest'
 setupOptions[amqp_virtualhost]='/'
 
+if [[ ${is_windows_host} == 1 ]] || [[ ${use_nfs} == 0 ]]; then
+    sudo chown -R vagrant:vagrant ${MAGENTO_ROOT}
+fi
+
 cd ${MAGENTO_ROOT}
 
 # Clear cache
@@ -72,7 +78,7 @@ if [[ -f "${MAGENTO_ROOT}/app/etc/enterprise/di.xml" ]]; then
     --amqp-password=${setupOptions[amqp_password]}"
 fi
 
-chmod +x bin/magento
+sudo chmod +x bin/magento
 php ${install_cmd}
 # Comment out the line above and uncomment the one below to debug Magento Setup script
 # php -d xdebug.remote_host=192.168.10.1 -d xdebug.idekey=PHPSTORM -d xdebug.remote_connect_back=0 -d xdebug.remote_autostart=1 ${install_cmd}
@@ -82,10 +88,8 @@ echo "* * * * * php ${MAGENTO_ROOT}/bin/magento cron:run &
 * * * * * php ${MAGENTO_ROOT}/update/cron.php &
 * * * * * php ${MAGENTO_ROOT}/bin/magento setup:cron:run &" | crontab -u vagrant -
 
-use_nfs=$(bash "${vagrant_dir}/scripts/get_config_value.sh" "guest_use_nfs")
-is_windows_host=${IS_WINDOWS_HOST}
-if [[ ${is_windows_host} == 1 || ${use_nfs} == 0 ]]; then
-    chown -R vagrant:vagrant ${MAGENTO_ROOT}
+if [[ ${is_windows_host} == 1 ]] || [[ ${use_nfs} == 0 ]]; then
+    sudo chown -R vagrant:vagrant ${MAGENTO_ROOT}
 fi
 
 # Generate XSD references for PHP Storm

Diff for: scripts/host/configure_php_storm.sh

@@ -14,7 +14,7 @@ cp -R "${vagrant_dir}/scripts/host/php-storm-configs/." "${vagrant_dir}/.idea/"
 enabled_virtual_host_config="/etc/apache2/sites-available/magento2.conf"
 
 host_os=$(bash "${vagrant_dir}/scripts/host/get_host_os.sh")
-if [[ ${host_os} == "Windows" || $(bash "${vagrant_dir}/scripts/get_config_value.sh" "guest_use_nfs") == 0 ]]; then
+if [[ ${host_os} == "Windows" ]] || [[ $(bash "${vagrant_dir}/scripts/get_config_value.sh" "guest_use_nfs") == 0 ]]; then
     sed -i.back "s|<magento_guest_path>|/var/www/magento2ce|g" "${vagrant_dir}/.idea/deployment.xml"
     sed -i.back 's|<auto_upload_attributes>| autoUpload="Always" autoUploadExternalChanges="true"|g' "${vagrant_dir}/.idea/deployment.xml"
     sed -i.back 's|<auto_upload_option>|<option name="myAutoUpload" value="ALWAYS" />|g' "${vagrant_dir}/.idea/deployment.xml"

Diff for: scripts/provision/configure_environment_recurring.sh

@@ -25,7 +25,7 @@ function init_php56 () {
         echo '
         xdebug.max_nesting_level=200
         xdebug.remote_enable=1
-        xdebug.remote_connect_back=1' >> /etc/php/5.6/mods-available/xdebug.ini
+        xdebug.remote_host=192.168.10.1' >> /etc/php/5.6/mods-available/xdebug.ini
 }
 
 # Enable trace printing and exit on the first error
@@ -78,6 +78,7 @@ if [[ ${use_php7} -eq 1 ]]; then
     if [[ -d "/etc/php/5.6" ]]; then
         a2dismod php5.6
     fi
+    sed -i "s|xdebug.remote_connect_back=1|xdebug.remote_host=192.168.10.1|g" /etc/php/7.0/cli/conf.d/20-xdebug.ini
     a2enmod php7.0
 else
     if [[ ! -d "/etc/php/5.6" ]]; then
@@ -86,6 +87,7 @@ else
     update-alternatives --set php /usr/bin/php5.6 && a2dismod php7.0 && a2enmod php5.6
     rm -f /etc/php/5.6/apache2/php.ini
     ln -s /etc/php/5.6/cli/php.ini /etc/php/5.6/apache2/php.ini
+    sed -i "s|xdebug.remote_connect_back=1|xdebug.remote_host=192.168.10.1|g" /etc/php/5.6/mods-available/xdebug.ini
 fi
 service apache2 restart
 #end Setup PHP