Merge pull request #3 from paliarush/develop

Develop

Author: paliarush

README.md

@@ -1,5 +1,16 @@
 # Vagrant project for Magento 2 developers (optimized for Mac, Windows and \*nix hosts)
 
+ * [What You get](#what-you-get)
+ * [How to install](#how-to-install)
+   * [Requirements](#requirements)
+   * [Installation steps](#installation-steps)
+   * [Default credentials and settings](#default-credentials-and-settings)
+   * [GitHub limitations](#github-limitations)
+ * [Day-to-day development scenarios](#day-to-day-development-scenarios)
+   * [Reinstall Magento](#reinstall-magento)
+   * [Clear magento cache](#clear-magento-cache)
+   * [Debugging with XDebug](#debugging-with-xdebug)
+
 ## What You get
 
 It is expected that Magento 2 project source code will be located on the host and managed using [Composer](https://getcomposer.org/doc/00-intro.md). 
@@ -14,18 +25,19 @@ With current configuration Vagrant will:
  1. Install and configure all software necessary for Magento 2
  1. Install the Magento 2 application
 
-## Environment set up workflow
+## How to install
 
 If you never used Vagrant before, read [Vagrant Docs](https://docs.vagrantup.com/v2/)
 
-### Prerequisites
+### Requirements
 - [Vagrant](https://www.vagrantup.com/downloads.html) is installed and available globally in command line
+- [Host manager plugin for Vagrant](https://github.com/smdahlen/vagrant-hostmanager)
 - [VirtualBox](https://www.virtualbox.org/wiki/Downloads)
 - [Composer](https://getcomposer.org/doc/00-intro.md) is installed and is available globally in command line
 - Make sure you have SSH keys generated and associated with your github account, see [manual](https://help.github.com/articles/generating-ssh-keys/).
 :information_source: You can use another way of getting codebase instead of cloning, it does not matter for successful installation.
 
-### To install the whole image from scratch
+### Installation steps
 
  1. Run in command line from the directory which contains your projects:
      1. Prepare Magento codebase. This step is optional, just ensure you have 'magento2ce' directory with Magento code available.
@@ -47,32 +59,27 @@ If you never used Vagrant before, read [Vagrant Docs](https://docs.vagrantup.com
         cd vagrant-magento
         vagrant up
         ```
- 1. Add corresponding record to your `hosts` file on the host machine:
- 
-    ```
-    192.168.10.11 magento2.vagrant
-    ```
  1. For **Windows hosts only**: after the installation is complete, [set up synchronization with PHP Storm](docs/phpstorm-configuration-windows-hosts.md)
 
-### 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).
-
 ### Default credentials and settings
+Upon a successful installation, you'll see the location and URL of the newly-installed Magento 2 application in console.
 
-Web access:
+**Web access**:
 - Access storefront at `http://magento2.vagrant`
 - Access admin panel at `http://magento2.vagrant/admin/`
 - Magento admin user/password: `admin/123123q`
+- Rabbit MQ control panel: `http://magento2.vagrant:15672`, credentials `guest`/`guest`
 
-Codebase and DB access:
-- Path to your Magento installation on the VM: `/var/www/magento2ce`
+**Codebase and DB access**:
+- Path to your Magento installation on the VM:
+  - Can be retrieved from environment variable: `echo ${MAGENTO_ROOT}`
+  - On Windows hosts: `/var/www/magento2ce`
+  - On Mac, \*nix hosts: the same as on host
 - MySQL DB host: `localhost` (not accessible remotely)
 - 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
+### GitHub limitations
 
 Be aware that you may encounter GitHub limits on the number of downloads (used by Composer to download Magento dependencies).
 
@@ -112,7 +119,3 @@ XDebug is already configured to connect to the host machine automatically. So ju
  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

Vagrantfile

@@ -7,6 +7,11 @@ module OS
     end
 end
 
+require 'pathname.rb'
+host_magento_dir = Pathname.new(Dir.pwd + '/../magento2ce').realpath.to_s
+magento_host_name = 'magento2.vagrant'
+magento_ip_address = '192.168.10.11'
+
 # All Vagrant configuration is done below. The "2" in Vagrant.configure
 # configures the configuration version (we support older styles for
 # backwards compatibility). Please don't change it unless you know what
@@ -15,30 +20,45 @@ Vagrant.configure(2) do |config|
     config.vm.box = "ubuntu/trusty64"
 
     config.vm.provider "virtualbox" do |vb|
-        vb.memory = 2048
+        vb.memory = 3072 # Around 3Gb is necessary to be able to run tests
     end
-    config.vm.network :private_network, ip: '192.168.10.11'
-    config.vm.hostname = "magento2.vagrant"
 
     config.vm.synced_folder '.', '/vagrant'
     if OS.is_windows
-        config.vm.synced_folder '../magento2ce/var/generation', '/var/www/magento2ce/var/generation'
-        config.vm.synced_folder '../magento2ce/app/etc', '/var/www/magento2ce/app/etc'
+        guest_magento_dir = '/var/www/magento2ce'
+        config.vm.synced_folder host_magento_dir + '/var/generation', guest_magento_dir + '/var/generation'
+        config.vm.synced_folder host_magento_dir + '/app/etc', guest_magento_dir + '/app/etc'
     else
-        config.vm.synced_folder '../magento2ce', '/var/www/magento2ce', type: "nfs"
+        guest_magento_dir = host_magento_dir
+        config.vm.synced_folder host_magento_dir, guest_magento_dir, type: "nfs"
     end
 
+    shell_script_args = [
+        OS.is_windows ? "1" : "0",
+        guest_magento_dir,
+        magento_host_name
+    ]
     config.vm.provision "install_environment", type: "shell" do |s|
         s.path = "install_environment.sh"
-        s.args = [OS.is_windows ? "1" : "0"]
+        s.args = shell_script_args
     end
 
     if OS.is_windows
-        config.vm.provision "deploy_magento_code", type: "file", source: '../magento2ce', destination: '/var/www'
+        config.vm.provision "deploy_magento_code", type: "file", source: host_magento_dir, destination: '/var/www'
     end
 
     config.vm.provision "install_magento", type: "shell" do |s|
         s.path = "install_magento.sh"
-        s.args = [OS.is_windows ? "1" : "0"]
+        s.args = shell_script_args
+    end
+
+    # Host manager plugin configuration
+    config.hostmanager.enabled = true
+    config.hostmanager.manage_host = true
+    config.hostmanager.ignore_private_ip = false
+    config.hostmanager.include_offline = true
+    config.vm.define magento_host_name do |node|
+        node.vm.hostname = magento_host_name
+        node.vm.network :private_network, ip: magento_ip_address
     end
 end

bin/magento_clear_cache

@@ -2,18 +2,16 @@
 
 echo "Clearing Magento cache..."
 
-magento_path=/var/www/magento2ce
-
-rm -f ${magento_path}/app/etc/paths.php
+rm -f ${MAGENTO_ROOT}/app/etc/paths.php
 #clear var
-for dir in `ls ${magento_path}/var` ; do
-    rm -rf ${magento_path}/var/${dir}/* ;
+for dir in `ls ${MAGENTO_ROOT}/var` ; do
+    rm -rf ${MAGENTO_ROOT}/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
+cd ${MAGENTO_ROOT}/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
+cd ${MAGENTO_ROOT}/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/*
+cd ${MAGENTO_ROOT}/dev/tests/unit && rm -rf tmp/*
 
 echo "Magento cache cleared."

install_environment.sh

@@ -4,36 +4,23 @@
 set -ex
 
 is_windows_host=$1
+guest_magento_dir=$2
+magento_host_name=$3
 
 apt-get update
 
-# Determine external IP address
-set +x
-IP=`ifconfig eth1 | grep inet | awk '{print $2}' | sed 's/addr://'`
-echo "IP address is '${IP}'"
-set -x
-
-# Determine hostname for Magento web-site
-HOST=`hostname -f`
-if [ -z ${HOST} ]; then
-    # Use external IP address as hostname
-    set +x
-    HOST=${IP}
-    echo "Use IP address '${HOST}' as hostname"
-    set -x
-fi
-
 # Setup Apache
 apt-get install -y apache2
 a2enmod rewrite
 
 # Make suer Apache is run from 'vagrant' user to avoid permission issues
-sed -i 's/www-data/vagrant/g' /etc/apache2/envvars
+sed -i 's|www-data|vagrant|g' /etc/apache2/envvars
 
 # Enable Magento virtual host
 apache_config="/etc/apache2/sites-available/magento2.conf"
 cp /vagrant/magento2.vhost.conf  ${apache_config}
-sed -i "s/<host>/${HOST}/g" ${apache_config}
+sed -i "s|<host>|${magento_host_name}|g" ${apache_config}
+sed -i "s|<guest_magento_dir>|${guest_magento_dir}|g" ${apache_config}
 a2ensite magento2.conf
 
 # Disable default virtual host
@@ -68,19 +55,40 @@ sed -i '/\[client\]/a \
 user = root \
 password =' /etc/mysql/my.cnf
 
+# Install git
+apt-get install -y git
+
 # Setup Composer
 if [ ! -f /usr/local/bin/composer ]; then
     cd /tmp
     curl -sS https://getcomposer.org/installer | php
     mv composer.phar /usr/local/bin/composer
 fi
 
+# Configure composer
+composer_auth_json="/vagrant/local.config/composer/auth.json"
+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
+      sudo -H -u vagrant bash -c 'mkdir /home/vagrant/.composer'
+    fi
+    cp ${composer_auth_json} /home/vagrant/.composer/auth.json
+fi
+
 # Declare path to scripts supplied with vagrant and Magento
-magento_dir="/var/www/magento2ce"
-echo "export PATH=\$PATH:/vagrant/bin:${magento_dir}/bin" >> /etc/profile
+echo "export PATH=\$PATH:/vagrant/bin:${guest_magento_dir}/bin" >> /etc/profile
+echo "export MAGENTO_ROOT=${guest_magento_dir}" >> /etc/profile
 
 # Set permissions to allow Magento codebase upload by Vagrant provision script
 if [ ${is_windows_host} -eq 1 ]; then
     chown -R vagrant:vagrant /var/www
     chmod -R 755 /var/www
 fi
+
+# Install RabbitMQ (is used by Enterprise edition)
+apt-get install -y rabbitmq-server
+rabbitmq-plugins enable rabbitmq_management
+invoke-rc.d rabbitmq-server stop
+invoke-rc.d rabbitmq-server start

install_magento.sh

@@ -6,32 +6,17 @@
 set -ex
 
 is_windows_host=$1
+guest_magento_dir=$2
+magento_host_name=$3
 
-# Determine external IP address
-set +x
-IP=`ifconfig eth1 | grep inet | awk '{print $2}' | sed 's/addr://'`
-echo "IP address is '${IP}'"
-set -x
-
-# Determine hostname for Magento web-site
-HOST=`hostname -f`
-if [ -z ${HOST} ]; then
-    # Use external IP address as hostname
-    set +x
-    HOST=${IP}
-    echo "Use IP address '${HOST}' as hostname"
-    set -x
-fi
-
-magento_dir="/var/www/magento2ce"
-cd ${magento_dir}
+cd ${guest_magento_dir}
 
 # Clear cache
 magento_clear_cache
 
 # Remove configuration files
-rm -f "${magento_dir}/app/etc/config.php"
-rm -f "${magento_dir}/app/etc/env.php"
+rm -f "${guest_magento_dir}/app/etc/config.php"
+rm -f "${guest_magento_dir}/app/etc/env.php"
 
 # Create DB
 db_names=("magento" "magento_integration_tests")
@@ -40,25 +25,15 @@ for db_name in "${db_names[@]}"; do
 done
 
 # Install Magento application
-cd ${magento_dir}
-github_token="/vagrant/local.config/github.oauth.token"
-if [ -f ${github_token} ]; then
-    set +x
-    echo "Installing GitHub OAuth token from ${github_token}..."
-    composer config -g github-oauth.github.com `cat ${github_token}`
-    set -x
-    composer install
-else
-    composer install --prefer-source
-fi
+cd ${guest_magento_dir}
 
 admin_frontame="admin"
 install_cmd="./bin/magento setup:install \
     --db-host=localhost \
     --db-name=magento \
     --db-user=root \
     --backend-frontname=${admin_frontame} \
-    --base-url=http://${HOST}/ \
+    --base-url=http://${magento_host_name}/ \
     --language=en_US \
     --timezone=America/Chicago \
     --currency=USD \
@@ -69,23 +44,31 @@ install_cmd="./bin/magento setup:install \
     --admin-password=123123q \
     --cleanup-database \
     --use-rewrites=1"
+
+# Configure Rabbit MQ
+if [ -f "${guest_magento_dir}/app/code/Magento/Amqp/registration.php" ]; then
+    install_cmd="${install_cmd} \
+    --amqp-host=localhost \
+    --amqp-port=5672 \
+    --amqp-user=guest \
+    --amqp-password=guest"
+fi
+
 chmod +x bin/magento
 php ${install_cmd}
 
 # Enable Magento cron jobs
-echo "* * * * * php ${magento_dir}/bin/magento cron:run &" | crontab -u vagrant -
+echo "* * * * * php ${guest_magento_dir}/bin/magento cron:run &" | crontab -u vagrant -
 
 if [ ${is_windows_host} -eq 1 ]; then
-    chown -R vagrant:vagrant ${magento_dir}
+    chown -R vagrant:vagrant ${guest_magento_dir}
 fi
 
 set +x
 echo "
-Magento application was deployed in ${magento_dir} and installed successfully
-Access storefront at http://${HOST}/
-Access admin panel at http://${HOST}/${admin_frontame}/
-
-Don't forget to update your 'hosts' file with '${IP} ${HOST}'"
+Magento application was deployed to ${guest_magento_dir} and installed successfully
+Access storefront at http://${magento_host_name}/
+Access admin panel at http://${magento_host_name}/${admin_frontame}/"
 
 if [ ${is_windows_host} -eq 1 ]; then
     echo "
@@ -94,5 +77,5 @@ if [ ${is_windows_host} -eq 1 ]; then
         (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-windows-hosts.md
-        to set up synchronization in PhpStorm (or using rsync) with ${magento_dir} directory"
+        to set up synchronization in PhpStorm (or using rsync) with ${guest_magento_dir} directory"
 fi

local.config/.gitignore

@@ -1,2 +1,5 @@
 /*
-!/.gitignore
+!/.gitignore
+!/composer
+/composer/*
+!/composer/auth.json.dist