Merge pull request #39 from paliarush/Email-Logging

paliarush · paliarush · commit b7324181b992 · 2016-06-08T12:33:31.000-05:00
Added email logging support (#9)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -23,6 +23,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
+ - Added setup and upgrade cron scripts to crontab
+ - Added logging of all emails in HTML format to `vagrant-magento/log/email`
  - Added host wrapper script for bin/magento command on guest
  - Added ability to modify guest config files (PHP, Apache etc) directly from host IDE
  - Added ability to choose if PhpStorm configs should be removed during project reinitialization
diff --git a/README.md b/README.md
@@ -19,6 +19,7 @@
    * [Use Magento CLI (bin/magento)](#use-magento-cli-binmagento)
    * [Debugging with XDebug](#debugging-with-xdebug)
    * [Connecting to MySQL DB](#connecting-to-mysql-db)
+   * [View emails sent by Magento](#view-emails-sent-by-magento)
    * [Accessing PHP and other config files](#accessing-php-and-other-config-files)
    * [Switch between PHP 5.6 and 7.0](#switch-between-php-56-and-70)
    * [Multiple Magento instances](#multiple-magento-instances)
@@ -134,6 +135,7 @@ Note, that semantic versioning is only used for `x.0` branches (not for `develop
  1. Make sure that you used `vagrant-magento` directory as project root in PHP Storm (not `vagrant-magento/magento2ce`)
  1. If code is not synchronized properly on Windows hosts (or when NFS mode is disabled in [config.yaml](etc/config.yaml.dist) explicitly), make sure that PhpStorm is running before making any changes in the code. This is important because otherwise PhpStorm will not be able to detect changes and upload them to the guest machine
  1. Please make sure that currently installed software, specified in [requirements section](#requirements), meets minimum version requirement
+ 1. If MySQL fails to start and Magento reinstallation fails with `ERROR 2002 (HY000): Can't connect to local MySQL server through socket '/var/run/mysqld/mysqld.sock' (13)`, try to run login to virtual machine using `vagrant ssh` and then run `sudo dpkg-reconfigure mysql-server-5.6`, then `sudo service mysql restart.`
 
 ## Day-to-day development scenarios
 
@@ -212,6 +214,10 @@ To debug Magento Setup script, go to [Magento installation script](scripts/guest
 
 Answer can be found [here](https://github.com/paliarush/magento2-vagrant-for-developers/issues/8)
 
+### View emails sent by Magento
+
+All emails are saved to 'vagrant-magento/log/email' in HTML format.
+
 ### Accessing PHP and other config files
 
 It is possible to view/modify majority of guest machine config files directly from IDE on the host. They will be accessible in [etc/guest](etc/guest) directory only when guest machine is running. The list of accessible configs includes: PHP, Apache, Mysql, Varnish, RabbitMQ.
@@ -231,17 +237,15 @@ Unique IP address, SSH port and domain name will be generated for each new insta
 
 ### Reset environment
 
-It is possible to reset project environment to default state, which you usually get just after project initialization. The following command will delete vagrant box, vagrant project settings and PhpStorm project settings. After that it will initialize project from scratch. Magento 2 code base (`magento2ce` directory) and [etc/config.yaml](etc/config.yaml.dist) will stay untouched, but guest config files (located in [etc/guest](etc/guest)) will be removed.
+It is possible to reset project environment to default state, which you usually get just after project initialization. The following command will delete vagrant box and vagrant project settings. After that it will initialize project from scratch. Magento 2 code base (`magento2ce` directory) and [etc/config.yaml](etc/config.yaml.dist) and PhpStorm settings will stay untouched, but guest config files (located in [etc/guest](etc/guest)) will be cleared.
 
 Go to 'vagrant-magento' created earlier and run in command line:
 
 ```
 bash init_project.sh -f
 ```
 
-You can reset project settings and Magento 2 code base at the same time. Magento 2 code base will be deleted and then cloned from the repositories specified in [etc/config.yaml](etc/config.yaml.dist)
-
-Go to 'vagrant-magento' created earlier and run in command line:
+It is possible to reset Magento 2 code base at the same time. Magento 2 code base will be deleted and then cloned from the repositories specified in [etc/config.yaml](etc/config.yaml.dist)
 
 ```
 bash init_project.sh -fc
@@ -251,6 +255,10 @@ To reset PhpStorm project configuration, in addition to `-f` specify `-p` option
 
 ```
 bash init_project.sh -fp
-OR
+```
+
+Ultimate project reset can be achieved by combining all available flags:
+
+```
 bash init_project.sh -fcp
 ```
diff --git a/Vagrantfile b/Vagrantfile
@@ -49,6 +49,7 @@ Vagrant.configure(VAGRANT_API_VERSION) do |config|
     config.vm.synced_folder '.', '/vagrant', disabled: true
     config.vm.synced_folder './etc', '/vagrant/etc', mount_options: ["dmode=775,fmode=664"]
     config.vm.synced_folder './scripts', '/vagrant/scripts'
+    config.vm.synced_folder './log', '/vagrant/log'
     config.vm.synced_folder './.idea', '/vagrant/.idea', create: true
     if use_nfs_for_synced_folders
         guest_magento_dir = host_magento_dir
diff --git a/init_project.sh b/init_project.sh
@@ -52,6 +52,7 @@ if [[ ${force_project_cleaning} -eq 1 ]]; then
     rm -rf "${vagrant_dir}/.vagrant" "${vagrant_dir}/etc/guest"
     mkdir "${vagrant_dir}/etc/guest"
     mv "${vagrant_dir}/etc/.gitignore.back" "${vagrant_dir}/etc/guest/.gitignore"
+    cd "${vagrant_dir}/log" && mv email/.gitignore email_gitignore.back && rm -rf email && mkdir email && mv email_gitignore.back email/.gitignore
     if [[ ${force_codebase_cleaning} -eq 1 ]]; then
         rm -rf "${magento_ce_dir}"
     fi
diff --git a/log/email/.gitignore b/log/email/.gitignore
@@ -0,0 +1 @@
+*
diff --git a/m-switch-to-ce b/m-switch-to-ce
@@ -9,12 +9,12 @@ 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
+if [[ ! -f ${magento_ee_dir}/app/etc/aliases_to_classes_map.json ]]; then
     echo "EE codebase is not available"
     exit 0
 fi
 
-if [ ! -f ${magento_ce_dir}/app/etc/aliases_to_classes_map.json ]; then
+if [[ ! -f ${magento_ce_dir}/app/etc/aliases_to_classes_map.json ]]; then
     echo "Already switched to CE"
     exit 0
 fi
@@ -27,10 +27,10 @@ git checkout composer.lock
 
 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
+    if [[ -f ${magento_ce_dir}/app/etc/aliases_to_classes_map.json ]]; then
         rm ${magento_ce_dir}/app/etc/aliases_to_classes_map.json
     fi
-    if [ -f ${magento_ce_dir}/app/etc/enterprise/di.xml ] && [ ! -L ${magento_ce_dir}/app/etc/enterprise ]; then
+    if [[ -f ${magento_ce_dir}/app/etc/enterprise/di.xml ]] && [[ ! -L ${magento_ce_dir}/app/etc/enterprise ]]; then
         rm ${magento_ce_dir}/app/etc/enterprise/di.xml
         rmdir ${magento_ce_dir}/app/etc/enterprise
     fi
diff --git a/m-switch-to-ee b/m-switch-to-ee
@@ -9,12 +9,12 @@ 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
+if [[ ! -f ${magento_ee_dir}/app/etc/aliases_to_classes_map.json ]]; then
     echo "EE codebase is not available"
     exit 0
 fi
 
-if [ -f ${magento_ce_dir}/app/etc/aliases_to_classes_map.json ]; then
+if [[ -f ${magento_ce_dir}/app/etc/aliases_to_classes_map.json ]]; then
     echo "Already switched to EE"
     exit 0
 fi
@@ -26,11 +26,11 @@ 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
     # 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
+    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
         cp ${magento_ee_dir}/app/etc/aliases_to_classes_map.json ${magento_ce_dir}/app/etc/aliases_to_classes_map.json
     fi
-    if [ -f ${magento_ee_dir}/app/etc/enterprise/di.xml ] && [ -L ${magento_ce_dir}/app/etc/enterprise ]; then
+    if [[ -f ${magento_ee_dir}/app/etc/enterprise/di.xml ]] && [[ -L ${magento_ce_dir}/app/etc/enterprise ]]; then
         rm ${magento_ce_dir}/app/etc/enterprise
         mkdir ${magento_ce_dir}/app/etc/enterprise
         cp ${magento_ee_dir}/app/etc/enterprise/di.xml ${magento_ce_dir}/app/etc/enterprise/di.xml
diff --git a/scripts/guest/link_configs b/scripts/guest/link_configs
@@ -5,8 +5,8 @@ function process_configs () {
     configs=$2
     for config in "${configs[@]}"
     do
-        if [ ! -d /vagrant/etc/guest/${config} ] && [ ! -f /vagrant/etc/guest/${config} ]; then
-            if [ -d ${configs_path}/${config} ] || [ -f ${configs_path}/${config} ]; then
+        if [[ ! -d /vagrant/etc/guest/${config} ]] && [[ ! -f /vagrant/etc/guest/${config} ]]; then
+            if [[ -d ${configs_path}/${config} ]] || [[ -f ${configs_path}/${config} ]]; then
                 sudo rm -rf "${configs_path}/${config}.back"
                 sudo cp -rp ${configs_path}/${config} "${configs_path}/${config}.back"
                 sudo mv ${configs_path}/${config} /vagrant/etc/guest/${config}
diff --git a/scripts/guest/log_email b/scripts/guest/log_email
@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+email_log_dir=$1
+if [[ ! -d ${email_log_dir} ]]; then
+    mkdir -p "${email_log_dir}"
+fi
+
+# Construct email file path
+current_time=$( date +"%Y-%m-%d_%H-%M-%S" )
+# Add random suffix to file name just in case there several emails sent in one second
+random_suffix=$(( RANDOM % 100 ))
+email_file_path="${email_log_dir}/${current_time}_${random_suffix}"
+
+raw_email_output=$(cat)
+
+# Add email topic to file name
+pattern="Subject: (.*)\sX-PHP-Originating-Script:"
+if [[ "${raw_email_output}" =~ ${pattern} ]]; then
+    email_topic=${BASH_REMATCH[1]}
+    email_file_path="${email_file_path}_${email_topic}"
+fi
+email_file_path="${email_file_path}.html"
+
+# Output content
+echo ${raw_email_output} > "${email_file_path}"
+
+# Process raw content of an email to make it a valid HTML
+sed -i "s|.*<\!DOCTYPE|<\!DOCTYPE|g" "${email_file_path}"
+sed -i "s|=3D|=|g" "${email_file_path}"
+sed -i "s|=0A||g" "${email_file_path}"
+sed -i "s|= ||g" "${email_file_path}"
diff --git a/scripts/guest/m-reinstall b/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/etc/enterprise/di.xml" ] && [ -d "${MAGENTO_ROOT}/app/code/Magento/Amqp" ]; 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]} \
@@ -78,7 +78,9 @@ php ${install_cmd}
 # 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}
 
 # Enable Magento cron jobs
-echo "* * * * * php ${MAGENTO_ROOT}/bin/magento cron:run &" | crontab -u vagrant -
+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}
diff --git a/scripts/guest/unlink_configs b/scripts/guest/unlink_configs
@@ -5,10 +5,10 @@ function process_configs () {
     configs=$2
     for config in "${configs[@]}"
     do
-        if [ -L ${config_dir}/${config} ] && [ -e ${config_dir}/${config} ]; then
+        if [[ -L ${config_dir}/${config} ]] && [[ -e ${config_dir}/${config} ]]; then
             sudo rm ${config_dir}/${config}
             sudo mv /vagrant/etc/guest/${config} ${config_dir}/${config}
-        elif [ ! -e ${config_dir}/${config} ] && [ -e "${config_dir}/${config}.back" ]; then
+        elif [[ ! -e ${config_dir}/${config} ]] && [[ -e "${config_dir}/${config}.back" ]]; then
             sudo rm -rf ${config_dir}/${config}
             sudo cp -rp "${config_dir}/${config}.back" ${config_dir}/${config}
         fi
diff --git a/scripts/host/configure_php_storm.sh b/scripts/host/configure_php_storm.sh
@@ -38,7 +38,7 @@ rm -f "${vagrant_dir}/.idea/.name.back"
 mv "${vagrant_dir}/.idea/host_name.iml" "${vagrant_dir}/.idea/${magento_host_name}.iml"
 
 repository_url_ee=$(bash "${vagrant_dir}/scripts/get_config_value.sh" "repository_url_ee")
-if [ -z ${repository_url_ee} ]; then
+if [[ -z ${repository_url_ee} ]]; then
     mv "${vagrant_dir}/.idea/vcs.ce.xml" "${vagrant_dir}/.idea/vcs.xml"
     rm "${vagrant_dir}/.idea/vcs.ee.xml"
 else
diff --git a/scripts/host/get_host_os.sh b/scripts/host/get_host_os.sh
@@ -1,12 +1,12 @@
 #!/usr/bin/env bash
 
-if [ "$(uname)" == "Darwin" ]; then
+if [[ "$(uname)" == "Darwin" ]]; then
     echo "OSX"
-elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
+elif [[ "$(expr substr $(uname -s) 1 5)" == "Linux" ]]; then
     echo "Linux"
-elif [ "$(expr substr $(uname -s) 1 5)" == "MINGW" ]; then
+elif [[ "$(expr substr $(uname -s) 1 5)" == "MINGW" ]]; then
     echo "Windows"
-elif [ "$(expr substr $(uname -s) 1 6)" == "CYGWIN" ]; then
+elif [[ "$(expr substr $(uname -s) 1 6)" == "CYGWIN" ]]; then
     echo "Windows"
 else
     echo "Unknown host OS"
diff --git a/scripts/provision/configure_environment.sh b/scripts/provision/configure_environment.sh
@@ -31,11 +31,11 @@ sudo a2dissite 000-default
 
 # Configure composer
 composer_auth_json="${vagrant_dir}/etc/composer/auth.json"
-if [ -f ${composer_auth_json} ]; then
+if [[ -f ${composer_auth_json} ]]; then
     set +x
     echo "Installing composer OAuth tokens from ${composer_auth_json}..."
     set -x
-    if [ ! -d /home/vagrant/.composer ] ; then
+    if [[ ! -d /home/vagrant/.composer ]] ; then
       sudo -H -u vagrant bash -c 'mkdir /home/vagrant/.composer'
     fi
     if [[ -f ${composer_auth_json} ]]; then
@@ -44,7 +44,7 @@ if [ -f ${composer_auth_json} ]; then
 fi
 
 # Set permissions to allow Magento codebase upload by Vagrant provision script
-if [ ${use_nfs_for_synced_folders} -eq 0 ]; then
+if [[ ${use_nfs_for_synced_folders} -eq 0 ]]; then
     chown -R vagrant:vagrant /var/www
     chmod -R 755 /var/www
 fi
diff --git a/scripts/provision/configure_environment_recurring.sh b/scripts/provision/configure_environment_recurring.sh
@@ -29,7 +29,6 @@ function init_php56 () {
 set +x
 
 use_php7=$4
-
 vagrant_dir="/vagrant"
 
 # Remove configs from host in case of force stop of virtual machine before linking restored ones
@@ -39,7 +38,7 @@ bash "${vagrant_dir}/scripts/guest/link_configs"
 # Make sure configs are restored on system halt and during reboot
 rm -f /etc/init.d/unlink-configs
 cp "${vagrant_dir}/scripts/guest/unlink_configs" /etc/init.d/unlink-configs
-if [ ! -f /etc/rc0.d/K04-unlink-configs ]; then
+if [[ ! -f /etc/rc0.d/K04-unlink-configs ]]; then
     ln -s /etc/init.d/unlink-configs /etc/rc0.d/K04-unlink-configs
     ln -s /etc/init.d/unlink-configs /etc/rc1.d/S04-unlink-configs
     ln -s /etc/init.d/unlink-configs /etc/rc2.d/S04-unlink-configs
@@ -58,14 +57,14 @@ fi
 php_ini_paths=( /etc/php/7.0/cli/php.ini /etc/php/5.6/cli/php.ini )
 process_php_config ${php_ini_paths}
 
-if [ ${use_php7} -eq 1 ]; then
+if [[ ${use_php7} -eq 1 ]]; then
     update-alternatives --set php /usr/bin/php7.0
-    if [ -d "/etc/php/5.6" ]; then
+    if [[ -d "/etc/php/5.6" ]]; then
         a2dismod php5.6
     fi
     a2enmod php7.0
 else
-    if [ ! -d "/etc/php/5.6" ]; then
+    if [[ ! -d "/etc/php/5.6" ]]; then
         init_php56
     fi
     update-alternatives --set php /usr/bin/php5.6 && a2dismod php7.0 && a2enmod php5.6
@@ -74,3 +73,16 @@ else
 fi
 service apache2 restart
 #end Setup PHP
+
+# Enable email logging
+if [[ ${use_php7} -eq 1 ]]; then
+    php_ini_file="/etc/php/7.0/cli/php.ini"
+else
+    php_ini_file="/etc/php/5.6/cli/php.ini"
+fi
+pattern=";sendmail_path"
+php_config_content="$(cat ${php_ini_file})"
+if [[ ${php_config_content} =~ ${pattern} ]]; then
+    sed -i "s|;sendmail_path =|sendmail_path = \"/vagrant/scripts/guest/log_email ${vagrant_dir}/log/email\"|g" ${php_ini_file}
+    service apache2 restart
+fi
