- Removed 'magento' MySQL user, password of 'root' user removed

- Database for integration tests are created by default
- Added script for clearing Magento cache from host command line. Added related documentation
- Configured XDebug to allow remote debugging. Added related documentation

Author: Alexander Paliarush

README.md

@@ -12,7 +12,7 @@ With current configuration Vagrant will:
  1. Install all necessary libraries
  1. Install the Magento 2 application
 
-## Usage
+## Environment set up workflow
 
 If you never used Vagrant before, read [Vagrant Docs](https://docs.vagrantup.com/v2/)
 
@@ -51,21 +51,11 @@ If you never used Vagrant before, read [Vagrant Docs](https://docs.vagrantup.com
     192.168.10.11 magento2.vagrant
     ```
  1. After the installation is complete, [set up synchronization with PHP Storm](docs/phpstorm-configuration.md)
-    
-###To reinstall Magento
-To save some time and get clear Magento installation, you can skip installation of software like web server or php.
-The following command will clear Magento DB, Magento caches and reinstall Magento instance.
-
-Go to 'vagrant-magento' created earlier and run in command line:
-
-```
-vagrant provision --provision-with install_magento
-```
 
 ### After installation
 
 Upon a successful installation, you'll see the location and URL of the newly-installed Magento 2 application in console.
-See a list of [default credentials and settings](README.md#default-credentials) below.
+See a list of [default credentials and settings](README.md#default-credentials).
 
 ### Default credentials and settings
 
@@ -77,8 +67,8 @@ Web access:
 Codebase and DB access:
 - Path to your Magento installation on the VM: `/var/www/magento2ce`
 - MySQL DB host: `localhost` (not accessible remotely)
-- MySQL DB name: `magento`
-- MySQL DB user/password: `magento/magento`. Alternatively `root/password`
+- MySQL DB name: `magento`, `magento_integration_tests`
+- MySQL DB user/password: just use `mysql` with no user and password (`root/password` will be used by default)
 
 ### GitHub Limitations
 
@@ -93,6 +83,34 @@ For the Vagrant configuration you may specify your token in `local.config/github
 Installing GitHub OAuth token from /vagrant/local.config/github.oauth.token
 ```
 
+## Magento development workflow
+    
+### Reinstall Magento
+To save some time and get clear Magento installation, you can skip installation of software like web server or php.
+The following command will clear Magento DB, Magento caches and reinstall Magento instance.
+
+Go to 'vagrant-magento' created earlier and run in command line:
+
+```
+vagrant provision --provision-with install_magento
+```
+
+### Clear magento cache
+
+Go to 'vagrant-magento' created earlier and run in command line:
+
+```
+vagrant ssh -c 'magento_clear_cache'
+```
+
+### Debugging with XDebug
+
+XDebug is already configured to connect to the host machine automatically. So just:
+ 
+ 1. Set XDEBUG_SESSION=1 cookie (e.g. using 'easy Xdebug' extension for Firefox). See [XDebug documentation](http://xdebug.org/docs/remote) for more details
+ 1. Start listening for PHP Debug connections in PhpStorm. See how to [integrate XDebug with PhpStorm](https://www.jetbrains.com/phpstorm/help/configuring-xdebug.html#integrationWithProduct)
+ 1. Set beakpoint or set option in PhpStorm menu 'Run -> Break at first line in PHP scripts'
+
 ## Related Repositories
 
 - https://github.com/buskamuza/magento2-product-vagrant

bin/magento_clear_cache

@@ -0,0 +1,19 @@
+#!/bin/sh
+
+echo "Clearing Magento cache..."
+
+magento_path=/var/www/magento2ce
+
+rm -f ${magento_path}/app/etc/paths.php
+#clear var
+for dir in `ls ${magento_path}/var` ; do
+    rm -rf ${magento_path}/var/${dir}/* ;
+done
+#clear pub/statics
+cd ${magento_path}/pub && mv static/.htaccess static_htaccess.back && rm -rf static/* && mv static_htaccess.back static/.htaccess
+#clear integration tests tmp
+cd ${magento_path}/dev/tests/integration && mv tmp/.gitignore tmp_gitignore.back && rm -rf tmp/* && mv tmp_gitignore.back tmp/.gitignore
+#clear unit tests tmp
+cd ${magento_path}/dev/tests/unit && rm -rf tmp/*
+
+echo "Magento cache cleared."

docs/developer-use-cases.md

@@ -1,6 +1,6 @@
 Synchronization with local PHP Storm
 -----------------
 
- 1. You can upload full Magento code base to the virtual machine from the host machine using context menu on the root of the project in PHPStorm. 
+ 1. You can upload full Magento code base to the virtual machine from the host machine using context menu on the root of the project in PhpStorm. 
 
      ![](images/upload-magento-codebase.png)

docs/performance-issue-on-windows-hosts.md

@@ -31,4 +31,4 @@ Even though there are no out-of-the-box solution which satisfies our developer e
  - does not break developer experience
  - has negligible performance degradation caused by files synchronization
 
-To solve performance degradation problem, local copy of the project should be stored on host (for good indexing performance in IDE) and on the guest (to avoid delays caused by PHP requesting remote files via network). This cannot be achieved with built-in Vagrant synchronization capabilities. However, this can be done using one-way PHPStorm project deployment to remote host or by using rsync.  This approach has one drawback: all files generated on the guest, will not be visible to IDE and as a result autocomplete for auto-generated classes will be unavailable. This issue can be overcome by enabling two-way Vagrant synchronization for those files which should be downloaded from guest OS.
+To solve performance degradation problem, local copy of the project should be stored on host (for good indexing performance in IDE) and on the guest (to avoid delays caused by PHP requesting remote files via network). This cannot be achieved with built-in Vagrant synchronization capabilities. However, this can be done using one-way PhpStorm project deployment to remote host or by using rsync.  This approach has one drawback: all files generated on the guest, will not be visible to IDE and as a result autocomplete for auto-generated classes will be unavailable. This issue can be overcome by enabling two-way Vagrant synchronization for those files which should be downloaded from guest OS.

docs/phpstorm-configuration.md

@@ -12,7 +12,7 @@ This solution is applicable to any Vagrant configuration for Magento instance, s
     end
     ```
 
- 1. Open your project on host machine in PHPStorm and set up deployment configuration, which will upload to the guest machine everything except for those folders which are synchronized by Vagrant.  :information_source: Note that rsync can be used instead of PHP Storm deployment.
+ 1. Open your project on host machine in PhpStorm and set up deployment configuration, which will upload to the guest machine everything except for those folders which are synchronized by Vagrant.  :information_source: Note that rsync can be used instead of PHP Storm deployment.
      1. Go to Tools -> Deployment -> Configuration
 
          ![](images/deployment-configuration.png)
@@ -34,7 +34,7 @@ This solution is applicable to any Vagrant configuration for Magento instance, s
 
          ![](images/projects-mapping.png)
 
-     1. Add remote paths excluded from synchronization by PHPStorm. You should add those paths which are specified in Vagrant config for synchronization. 
+     1. Add remote paths excluded from synchronization by PhpStorm. You should add those paths which are specified in Vagrant config for synchronization. 
 
          ![](images/exclude-paths-from-mapping.png)
 

install_environment.sh

@@ -1,5 +1,6 @@
 #!/usr/bin/env bash
 
+# Enable trace printing and exit on the first error
 set -ex
 
 apt-get update
@@ -46,8 +47,10 @@ if [ ! -f /etc/php5/cli/conf.d/20-mcrypt.ini ]; then
 fi
 echo "date.timezone = America/Chicago" >> /etc/php5/cli/php.ini
 
-# Configure XDebug
-echo "xdebug.max_nesting_level=200" >> /etc/php5/cli/conf.d/20-xdebug.ini
+# Configure XDebug to allow remote connections from the host
+echo "xdebug.max_nesting_level=200\
+xdebug.remote_enable=1\
+xdebug.remote_connect_back=1" >> /etc/php5/cli/conf.d/20-xdebug.ini
 
 # Restart Apache
 service apache2 restart
@@ -56,6 +59,12 @@ service apache2 restart
 debconf-set-selections <<< 'mysql-server mysql-server/root_password password password'
 debconf-set-selections <<< 'mysql-server mysql-server/root_password_again password password'
 apt-get install -q -y mysql-server-5.6 mysql-client-5.6
+mysqladmin -uroot -ppassword password ''
+
+# Make it possible to run 'mysql' without username and password
+sed -i '/\[client\]/a\
+user = root\
+password =' /etc/mysql/my.cnf
 
 # Setup Composer
 if [ ! -f /usr/local/bin/composer ]; then
@@ -66,4 +75,8 @@ fi
 
 # Set permissions to allow Magento codebase upload by Vagrant provision script
 chown -R vagrant:vagrant /var/www
-chmod -R 755 /var/www
+chmod -R 755 /var/www
+
+# Declare path to scripts supplied with vagrant and Magento
+magento_dir="/var/www/magento2ce"
+echo "export PATH=\$PATH:/vagrant/bin:${magento_dir}/bin" >> /home/vagrant/.profile

install_magento.sh

@@ -2,6 +2,7 @@
 
 # vagrant provision --provision-with install_magento
 
+# Enable trace printing and exit on the first error
 set -ex
 
 # Determine external IP address
@@ -34,9 +35,10 @@ rm -f "${magento_dir}/app/etc/config.php"
 rm -f "${magento_dir}/app/etc/env.php"
 
 # Create DB
-db_name="magento"
-mysql -u root -ppassword -e "drop database if exists ${db_name}; create database ${db_name};"
-mysql -u root -ppassword -e "GRANT ALL ON ${db_name}.* TO magento@localhost IDENTIFIED BY 'magento';"
+db_names=("magento" "magento_integration_tests")
+for db_name in "${db_names[@]}"; do
+    mysql -e "drop database if exists ${db_name}; create database ${db_name};"
+done
 
 # Install Magento application
 cd ${magento_dir}
@@ -55,8 +57,7 @@ admin_frontame="admin"
 install_cmd="./bin/magento setup:install \
     --db-host=localhost \
     --db-name=magento \
-    --db-user=magento \
-    --db-password=magento \
+    --db-user=root \
     --backend-frontname=${admin_frontame} \
     --base-url=http://${HOST}/ \
     --language=en_US \
@@ -86,8 +87,8 @@ Access admin panel at http://${HOST}/${admin_frontame}/
 Don't forget to update your 'hosts' file with '${IP} ${HOST}'
 
 [Optional] To finish developer environment set up:
-    1. Please create new PHPStorm project using 'magento2ce' directory on your host
+    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/master/docs/phpstorm-configuration.md
-    to set up synchronization in PHPStorm (or using rsync) with ${magento_dir} directory"
+    to set up synchronization in PhpStorm (or using rsync) with ${magento_dir} directory"