- Improved error reporting #112

- Cache warm up is made optional (using -w flag)
- Fixed m-clear-cache for Magento production mode

Author: Alex Paliarush

CHANGELOG.md

@@ -25,10 +25,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
+ - Added generation of basic sample data for testing purposes
+ - Ability to upgrade Magento using `m-switch-to-ce` and `m-switch-to-ee` (when `-u` flag is specified)
  - Redis support for Magento caching
  - Access to Magento developer mode and storefront/admin UI debugging features via [etc/config.yaml.dist](etc/config.yaml.dist)
  - Composer-based installation support
- - Magento cache warming up after re-install and clearing cache
+ - Magento cache warming up after re-install and clearing cache (when `-w` flag is specified)
  - Tests configuration files are generated during project initialization
  - Sample data support
  - ElasticSearch support

init_project.sh

@@ -5,6 +5,8 @@ set -e
 vagrant_dir=$PWD
 
 source "${vagrant_dir}/scripts/output_functions.sh"
+current_script_name=`basename "$0"`
+log_file="${vagrant_dir}/log/${current_script_name}.log"
 resetNestingLevel
 
 debug_vagrant_project="$(bash "${vagrant_dir}/scripts/get_config_value.sh" "debug_vagrant_project")"
@@ -240,4 +242,4 @@ if [[ ${host_os} == "Windows" ]] || [[ ${use_nfs} == 0 ]]; then
     If not using PhpStorm, you can set up synchronization using rsync"
 fi
 
-info "See detailed log in '${vagrant_dir}/log/debug.log'. For even more details you can set debug:vagrant_project to 1 in config.yaml"
+info "See detailed log in '${vagrant_dir}/log/${current_script_name}.log'. For even more details you can set debug:vagrant_project to 1 in config.yaml"

m-bin-magento

@@ -5,6 +5,8 @@ set -e
 cd "$(dirname "${BASH_SOURCE[0]}")" && vagrant_dir=$PWD
 
 source "${vagrant_dir}/scripts/output_functions.sh"
+current_script_name=`basename "$0"`
+log_file="${vagrant_dir}/log/${current_script_name}.log"
 resetNestingLevel
 
 debug_vagrant_project="$(bash "${vagrant_dir}/scripts/get_config_value.sh" "debug_vagrant_project")"
@@ -18,4 +20,4 @@ vagrant ssh -c "\$MAGENTO_ROOT/bin/magento $arguments" 2> >(logError)
 # To debug, comment out line above and uncomment line below
 # vagrant ssh -c "php -d xdebug.remote_autostart=1 \$MAGENTO_ROOT/bin/magento $arguments" 2> >(logError)
 
-info "See detailed log in '${vagrant_dir}/log/debug.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"
+info "See detailed log in '${vagrant_dir}/log/${current_script_name}.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"

m-clear-cache

@@ -5,19 +5,31 @@ set -e
 cd "$(dirname "${BASH_SOURCE[0]}")" && vagrant_dir=$PWD
 
 source "${vagrant_dir}/scripts/output_functions.sh"
+current_script_name=`basename "$0"`
+log_file="${vagrant_dir}/log/${current_script_name}.log"
 resetNestingLevel
 
+warm_up_cache=0
+while getopts 'w' flag; do
+  case "${flag}" in
+    w) warm_up_cache=1 ;;
+    *) error "Unexpected option" && exit 1;;
+  esac
+done
+
 debug_vagrant_project="$(bash "${vagrant_dir}/scripts/get_config_value.sh" "debug_vagrant_project")"
 if [[ ${debug_vagrant_project} -eq 1 ]]; then
     set -x
 fi
 
 bash "${vagrant_dir}/scripts/host/m_clear_cache.sh" "$@" 2> >(logError)
 
-incrementNestingLevel
-
-bash "${vagrant_dir}/scripts/host/warm_up_cache.sh" 2> >(logError)
-
-decrementNestingLevel
+if [[ ${warm_up_cache} -eq 1 ]]; then
+    incrementNestingLevel
+    bash "${vagrant_dir}/scripts/host/warm_up_cache.sh" 2> >(logError)
+    decrementNestingLevel
+else
+    info "Use 'bash ./m-clear-cache -w' to get automatic cache warm up"
+fi
 
-info "See detailed log in '${vagrant_dir}/log/debug.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"
+info "See detailed log in '${vagrant_dir}/log/${current_script_name}.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"

m-composer

@@ -5,6 +5,8 @@ set -e
 cd "$(dirname "${BASH_SOURCE[0]}")" && vagrant_dir=$PWD
 
 source "${vagrant_dir}/scripts/output_functions.sh"
+current_script_name=`basename "$0"`
+log_file="${vagrant_dir}/log/${current_script_name}.log"
 resetNestingLevel
 
 debug_vagrant_project="$(bash "${vagrant_dir}/scripts/get_config_value.sh" "debug_vagrant_project")"
@@ -14,4 +16,4 @@ fi
 
 bash "${vagrant_dir}/scripts/host/m_composer.sh" "$@" 2> >(logError)
 
-info "See detailed log in '${vagrant_dir}/log/debug.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"
+info "See detailed log in '${vagrant_dir}/log/${current_script_name}.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"

m-reinstall

@@ -5,6 +5,8 @@ set -e
 cd "$(dirname "${BASH_SOURCE[0]}")" && vagrant_dir=$PWD
 
 source "${vagrant_dir}/scripts/output_functions.sh"
+current_script_name=`basename "$0"`
+log_file="${vagrant_dir}/log/${current_script_name}.log"
 resetNestingLevel
 
 debug_vagrant_project="$(bash "${vagrant_dir}/scripts/get_config_value.sh" "debug_vagrant_project")"
@@ -14,4 +16,4 @@ fi
 
 bash "${vagrant_dir}/scripts/host/m_reinstall.sh" "$@" 2> >(logError)
 
-info "See detailed log in '${vagrant_dir}/log/debug.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"
+info "See detailed log in '${vagrant_dir}/log/${current_script_name}.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"

m-search-engine

@@ -5,6 +5,8 @@ set -e
 cd "$(dirname "${BASH_SOURCE[0]}")" && vagrant_dir=$PWD
 
 source "${vagrant_dir}/scripts/output_functions.sh"
+current_script_name=`basename "$0"`
+log_file="${vagrant_dir}/log/${current_script_name}.log"
 resetNestingLevel
 
 debug_vagrant_project="$(bash "${vagrant_dir}/scripts/get_config_value.sh" "debug_vagrant_project")"
@@ -15,4 +17,4 @@ fi
 cd "${vagrant_dir}"
 vagrant ssh -c "bash /vagrant/scripts/guest/m-search-engine ${@}" 2> >(logError)
 
-info "See detailed log in '${vagrant_dir}/log/debug.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"
+info "See detailed log in '${vagrant_dir}/log/${current_script_name}.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"

m-switch-to-ce

@@ -5,6 +5,8 @@ set -e
 cd "$(dirname "${BASH_SOURCE[0]}")" && vagrant_dir=$PWD
 
 source "${vagrant_dir}/scripts/output_functions.sh"
+current_script_name=`basename "$0"`
+log_file="${vagrant_dir}/log/${current_script_name}.log"
 resetNestingLevel
 
 debug_vagrant_project="$(bash "${vagrant_dir}/scripts/get_config_value.sh" "debug_vagrant_project")"
@@ -14,4 +16,4 @@ fi
 
 bash "${vagrant_dir}/scripts/host/m_switch_to_ce.sh" "$@" 2> >(logError)
 
-info "See detailed log in '${vagrant_dir}/log/debug.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"
+info "See detailed log in '${vagrant_dir}/log/${current_script_name}.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"

m-switch-to-ee

@@ -5,6 +5,8 @@ set -e
 cd "$(dirname "${BASH_SOURCE[0]}")" && vagrant_dir=$PWD
 
 source "${vagrant_dir}/scripts/output_functions.sh"
+current_script_name=`basename "$0"`
+log_file="${vagrant_dir}/log/${current_script_name}.log"
 resetNestingLevel
 
 debug_vagrant_project="$(bash "${vagrant_dir}/scripts/get_config_value.sh" "debug_vagrant_project")"
@@ -14,4 +16,4 @@ fi
 
 bash "${vagrant_dir}/scripts/host/m_switch_to_ee.sh" "$@" 2> >(logError)
 
-info "See detailed log in '${vagrant_dir}/log/debug.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"
+info "See detailed log in '${vagrant_dir}/log/${current_script_name}.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"

m-varnish

@@ -5,6 +5,8 @@ set -e
 cd "$(dirname "${BASH_SOURCE[0]}")" && vagrant_dir=$PWD
 
 source "${vagrant_dir}/scripts/output_functions.sh"
+current_script_name=`basename "$0"`
+log_file="${vagrant_dir}/log/${current_script_name}.log"
 resetNestingLevel
 
 debug_vagrant_project="$(bash "${vagrant_dir}/scripts/get_config_value.sh" "debug_vagrant_project")"
@@ -15,4 +17,4 @@ fi
 cd "${vagrant_dir}"
 vagrant ssh -c "bash /vagrant/scripts/guest/m-varnish ${@}" 2> >(logError)
 
-info "See detailed log in '${vagrant_dir}/log/debug.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"
+info "See detailed log in '${vagrant_dir}/log/${current_script_name}.log'. For even more details you can set 'debug:vagrant_project' to 1 in etc/config.yaml"

scripts/guest/m-clear-cache

@@ -9,21 +9,33 @@ incrementNestingLevel
 
 status "Clearing directories containing temporary files"
 
+mage_mode=$(bash "${vagrant_dir}/scripts/get_config_value.sh" "magento_mode")
+
 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/.[^.]*
+    cd "${MAGENTO_ROOT}"
+    mv var/.htaccess var_htaccess.back
+    if [[ -d "${MAGENTO_ROOT}/var/generation" ]] && [[ ${mage_mode} == "production" ]]; then
+        mv var/generation var_generation.back
+    fi
+    rm -rf var/* var/.[^.]*
     if [[ -f var_htaccess.back ]]; then
         mv var_htaccess.back var/.htaccess
     fi
+    if [[ -d "${MAGENTO_ROOT}/var_generation.back" ]] && [[ ${mage_mode} == "production" ]]; then
+        mv var_generation.back var/generation
+    fi
 fi
-if [[ -d "${MAGENTO_ROOT}/pub" ]]; then
+
+if [[ -d "${MAGENTO_ROOT}/pub" ]] && [[ ${mage_mode} != "production" ]]; 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

scripts/output_functions.sh

@@ -4,7 +4,8 @@ cd "$(dirname "${BASH_SOURCE[0]}")/.." && vagrant_dir=$PWD
 
 source "${vagrant_dir}/scripts/colors.sh"
 
-log_file="${vagrant_dir}/log/debug.log"
+default_log="${vagrant_dir}/log/debug.log"
+log_file_path="${vagrant_dir}/scripts/.current_log_path"
 nesting_level_file="${vagrant_dir}/scripts/.current_nesting_level"
 
 function info() {
@@ -53,6 +54,11 @@ function log() {
         input="$(cat)"
     fi
     if [[ -n "${input}" ]]; then
+        if [[ -f "${log_file_path}" ]]; then
+            log_file="${vagrant_dir}/$(cat "${log_file_path}")"
+        else
+            log_file="${default_log}"
+        fi
         echo "${input}" | sed "s/\[[[:digit:]]\{1,\}m//g" >> "${log_file}"
     fi
 }
@@ -131,7 +137,12 @@ function decrementNestingLevel()
 function resetNestingLevel()
 {
     rm -f "${nesting_level_file}"
-    rm -f "${log_file}"
+    if [[ -f "${log_file_path}" ]]; then
+        log_file="${vagrant_dir}/$(cat "${log_file_path}")"
+        rm -f "${log_file_path}"
+        rm -f "${log_file}"
+    fi
+    rm -f "${default_log}"
 }
 
 function getIndentationByNesting()