Refactoring

- Renamed local.config => etc
- Moved scripts from scripts/host/shell to script/host
- Improved composer update and git experience for Windows hosts
- Removed "latest release" badge (it is not stable)

Author: paliarush

CHANGELOG.md

@@ -12,13 +12,15 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
  - Moved provisioning scripts
  - Magento project directory moved to vagrant project root. Current structure is as follows: `vagrant-magento/magento2ce/magento2ee`
- - PHP 7.0 is installed by default instead of PHP 5.5.9 (can be configured in [local.config/config.yaml.dist](local.config/config.yaml.dist))
+ - PHP 7.0 is installed by default instead of PHP 5.5.9 (can be configured in [etc/config.yaml.dist](etc/config.yaml.dist))
+ - Renamed configuration folder from `local.config` to `etc`
+ - Set minimum Vagrant version as 1.8
 
 ### Added
 
  - Implemented static value of forwarded SSH port to prevent necessity to reconfigure software accessing guest via SSH
  - Implemented collision prevention for IP address and host name (in case when several machines are created at once)
- - Added configuration file [local.config/config.yaml.dist](local.config/config.yaml.dist)
+ - Added configuration file [etc/config.yaml.dist](etc/config.yaml.dist)
  - Added PHP 7.0 support
  - Added PHP Storm configuration during project initialization
  - Added [project initialization script](init_project.sh) for *nix and OSX hosts 

README.md

@@ -1,6 +1,6 @@
 # Vagrant project for Magento 2 developers (optimized for Mac, Windows and \*nix hosts)
 
-[![Latest GitHub release](https://img.shields.io/github/release/paliarush/magento2-vagrant-for-developers.svg)](https://github.com/paliarush/magento2-vagrant-for-developers/releases/latest)
+# [![Latest GitHub release](https://img.shields.io/github/release/paliarush/magento2-vagrant-for-developers.svg)](https://github.com/paliarush/magento2-vagrant-for-developers/releases/latest)
 [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
 [![Semver](http://img.shields.io/SemVer/2.0.0.png?color=blue)](http://semver.org/spec/v2.0.0.html)
 
@@ -41,8 +41,15 @@ Software listed below should be available in [PATH](https://en.wikipedia.org/wik
 - [Vagrant 1.8+](https://www.vagrantup.com/downloads.html)
 - [VirtualBox](https://www.virtualbox.org/wiki/Downloads)
 - [PHP](http://php.net/manual/en/install.php) (any version) to allow Magento dependency management with [Composer](https://getcomposer.org/doc/00-intro.md)
-- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). 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: It is possible to use another way of getting codebase instead of cloning, it does not matter for successful installation.
+- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). Make sure you have SSH keys generated and associated with your github account, see [manual](https://help.github.com/articles/generating-ssh-keys/).<br />
+:information_source: It is possible to use another way of getting codebase instead of cloning, it does not matter for successful installation. Just put Magento 2 codebase inside of `vagrant-magento/magento2ce`.<br />
+:information_source: On Windows hosts make sure to set the following options to avoid issues with incorrect line separators:
+
+    ```
+    git config --global core.autocrlf false
+    git config --global core.eol LF
+    git config --global diff.renamelimit 5000
+    ```
 - [PHP Storm](https://www.jetbrains.com/phpstorm) is optional but recommended.
 
 ### Installation steps
@@ -55,9 +62,9 @@ Software listed below should be available in [PATH](https://en.wikipedia.org/wik
    git clone git@github.com:paliarush/magento2-vagrant-for-developers.git vagrant-magento
    ```
 
- 1. Copy [local.config/composer/auth.json.dist](local.config/composer/auth.json.dist) to `local.config/composer/auth.json` and specify your [GitHub OAuth token](https://github.com/settings/tokens) there. See [API rate limit and OAuth tokens](https://getcomposer.org/doc/articles/troubleshooting.md#api-rate-limit-and-oauth-tokens) for more information
+ 1. Copy [etc/composer/auth.json.dist](etc/composer/auth.json.dist) to `etc/composer/auth.json` and specify your [GitHub OAuth token](https://github.com/settings/tokens) there. See [API rate limit and OAuth tokens](https://getcomposer.org/doc/articles/troubleshooting.md#api-rate-limit-and-oauth-tokens) for more information
 
- 1. Optionally, copy [local.config/config.yaml.dist](local.config/config.yaml.dist) as `local.config/config.yaml` and make necessary customizations
+ 1. Optionally, copy [etc/config.yaml.dist](etc/config.yaml.dist) as `etc/config.yaml` and make necessary customizations
 
  1. Initialize project, configure environment, install Magento, configure PHPStorm project:
 
@@ -66,12 +73,13 @@ Software listed below should be available in [PATH](https://en.wikipedia.org/wik
    bash init_project.sh
    ```
 
-   :information_source: On OSX and \*nix hosts NFS will be used by default to sync your project files with guest. On some hosts Vagrant cannot configure NFS properly, in this case it is possible to deploy project without NFS by setting `use_nfs` option in [config.yaml](local.config/config.yaml.dist) to `0`
+   :information_source: On OSX and \*nix hosts NFS will be used by default to sync your project files with guest. On some hosts Vagrant cannot configure NFS properly, in this case it is possible to deploy project without NFS by setting `use_nfs` option in [config.yaml](etc/config.yaml.dist) to `0`
+   :information_source: On Windows hosts you might face `Composer Install Error: ZipArchive::extractTo(): Full extraction path exceed MAXPATHLEN (260)` exception during `composer install`. This can be fixed in 2 ways: decrease path length to the project directory or set `composer_prefer_source` option in [config.yaml](etc/config.yaml.dist) to `1`
 
- 1. Use `vagrant-magento` directory as project root in PHP Storm (not `vagrant-magento/magento2ce`). This is important, because in this case PHP Storm will be configured automatically by [init_project.sh](init_project.sh). If NFS files sync is disabled in [config](local.config/config.yaml.dist) and on Windows hosts [verify deployment configuration in PHP Storm](docs/phpstorm-configuration-windows-hosts.md)
+ 1. Use `vagrant-magento` directory as project root in PHP Storm (not `vagrant-magento/magento2ce`). This is important, because in this case PHP Storm will be configured automatically by [init_project.sh](init_project.sh). If NFS files sync is disabled in [config](etc/config.yaml.dist) and on Windows hosts [verify deployment configuration in PHP Storm](docs/phpstorm-configuration-windows-hosts.md)
 
 ### Default credentials and settings
-Some of default settings are available for override. These settings can be found in the file [local.config/config.yaml.dist](local.config/config.yaml.dist).
+Some of default settings are available for override. These settings can be found in the file [etc/config.yaml.dist](etc/config.yaml.dist).
 To override settings just create a copy of the file under the name 'config.yaml' and put there your custom settings.
 When using [init_project.sh](init_project.sh), if not specified manually, random IP address is generated and is used as suffix for host name to prevent collisions, in case when 2 or more instances are running at the same time.
 Upon a successful installation, you'll see the location and URL of the newly-installed Magento 2 application in console.
@@ -99,7 +107,7 @@ These limits may significantly slow down the installation since all of the libra
 
 If you have a GitHub account, you can bypass these limitations by using an OAuth token in the Composer configuration. See [API rate limit and OAuth tokens](https://getcomposer.org/doc/articles/troubleshooting.md#api-rate-limit-and-oauth-tokens) for more information.
 
-For the Vagrant configuration you may specify your token in `local.config/github.oauth.token` file after cloning the repository. The file is a basic text file and is ignored by Git, so you'll need to create it yourself. Simply write your OAuth token in this file making sure to avoid any empty spaces, and it will be read during deployment.
+For the Vagrant configuration you may specify your token in `etc/github.oauth.token` file after cloning the repository. The file is a basic text file and is ignored by Git, so you'll need to create it yourself. Simply write your OAuth token in this file making sure to avoid any empty spaces, and it will be read during deployment.
 
 ## Day-to-day development scenarios
 

Vagrantfile

@@ -14,7 +14,7 @@ end
 module Config
     # Load and override config settings
     def Config.load
-        local_config_dir = 'local.config'
+        local_config_dir = 'etc'
         config_dist_file = local_config_dir + '/config.yaml.dist'
         config_file = local_config_dir + '/config.yaml'
 
@@ -46,7 +46,7 @@ Vagrant.configure(VAGRANT_API_VERSION) do |config|
     end
 
     config.vm.synced_folder '.', '/vagrant', disabled: true
-    config.vm.synced_folder './local.config', '/vagrant/local.config'
+    config.vm.synced_folder './etc', '/vagrant/etc'
     config.vm.synced_folder './scripts', '/vagrant/scripts'
     if use_nfs_for_synced_folders
         guest_magento_dir = host_magento_dir

local.config/.gitignore etc/.gitignore

@@ -11,6 +11,7 @@ guest:
 environment:
   # If set to 0, PHP 5 will be installed
   use_php7: 1
+  composer_prefer_source: 0
 magento:
   host_name: "magento2.vagrant2"
   admin_frontname: "admin"

local.config/composer/auth.json.dist etc/composer/auth.json.dist

@@ -3,15 +3,16 @@
 vagrant_dir=$PWD
 magento_ce_dir="${vagrant_dir}/magento2ce"
 magento_ee_dir="${magento_ce_dir}/magento2ee"
-config_path="${vagrant_dir}/local.config/config.yaml"
+config_path="${vagrant_dir}/etc/config.yaml"
+host_os=$(bash "${vagrant_dir}/scripts/host/get_host_os.sh")
 
 # Enable trace printing and exit on the first error
 set -ex
 
-bash "${vagrant_dir}/scripts/host/shell/check_requirements.sh"
+bash "${vagrant_dir}/scripts/host/check_requirements.sh"
 
 # Generate random IP address and host name to prevent collisions, if not specified explicitly in local config
-if [ ! -f "${vagrant_dir}/local.config/config.yaml" ]; then
+if [ ! -f "${vagrant_dir}/etc/config.yaml" ]; then
     cp "${config_path}.dist" ${config_path}
 fi
 random_ip=$(( ( RANDOM % 240 )  + 12 ))
@@ -35,28 +36,32 @@ if [ ${force_project_cleaning} -eq 1 ]; then
 fi
 
 if [ ! -d ${magento_ce_dir} ]; then
+    if [[ ${host_os} == "Windows" ]]; then
+        git config --global core.autocrlf false
+        git config --global core.eol LF
+        git config --global diff.renamelimit 5000
+    fi
     # Check out CE repository
-    repository_url_ce=$(bash "${vagrant_dir}/scripts/host/shell/get_variable_value.sh" "repository_url_ce")
+    repository_url_ce=$(bash "${vagrant_dir}/scripts/host/get_variable_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/host/shell/get_variable_value.sh" "repository_url_ee")
+    repository_url_ee=$(bash "${vagrant_dir}/scripts/host/get_variable_value.sh" "repository_url_ee")
     if [ -n "${repository_url_ee}" ]; then
         git clone ${repository_url_ee} ${magento_ee_dir}
     fi
 fi
 
 var_generation_dir="${magento_ce_dir}/var/generation"
 if [ ! -d ${var_generation_dir} ] ; then
-    host_os=$(bash "${vagrant_dir}/scripts/host/shell/get_host_os.sh")
-    if [[ ${host_os} == "Windows" || $(bash "${vagrant_dir}/scripts/host/shell/get_variable_value.sh" "guest_use_nfs") == 0 ]]; then
+    if [[ ${host_os} == "Windows" || $(bash "${vagrant_dir}/scripts/host/get_variable_value.sh" "guest_use_nfs") == 0 ]]; then
         mkdir ${var_generation_dir}
     fi
 fi
 
 # Update Magento dependencies via Composer
 cd ${magento_ce_dir}
-bash "${vagrant_dir}/scripts/host/shell/composer.sh" install
+bash "${vagrant_dir}/scripts/host/composer.sh" install
 
 # Install necessary vagrant plugins if not installed
 if ! vagrant plugin list | grep -q 'vagrant-hostmanager' ; then
@@ -73,4 +78,4 @@ fi
 cd ${vagrant_dir}
 vagrant up
 
-bash "${vagrant_dir}/scripts/host/shell/configure_php_storm.sh"
+bash "${vagrant_dir}/scripts/host/configure_php_storm.sh"

local.config/config.yaml.dist etc/config.yaml.dist

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
-vagrant_dir=$(cd "$(dirname "$0")/../../.."; pwd)
-composer_auth_json="${vagrant_dir}/local.config/composer/auth.json"
+vagrant_dir=$(cd "$(dirname "$0")/../.."; pwd)
+composer_auth_json="${vagrant_dir}/etc/composer/auth.json"
 
 # Enable trace printing and exit on the first error
 set -ex

local.config/magento2_virtual_host.conf.dist etc/magento2_virtual_host.conf.dist

@@ -1,17 +1,17 @@
 #!/usr/bin/env bash
 
-# This script allows to use credentials specified in local.config/composer/auth.json without declaring them globally
+# This script allows to use credentials specified in etc/composer/auth.json without declaring them globally
 
 current_dir=${PWD}
-vagrant_dir=$(cd "$(dirname "$0")/../../.."; pwd)
-composer_auth_json="${vagrant_dir}/local.config/composer/auth.json"
+vagrant_dir=$(cd "$(dirname "$0")/../.."; pwd)
+composer_auth_json="${vagrant_dir}/etc/composer/auth.json"
 composer_dir="${vagrant_dir}/scripts/host"
 composer_phar="${composer_dir}/composer.phar"
 
 # Enable trace printing and exit on the first error
 set -ex
 
-bash "${vagrant_dir}/scripts/host/shell/check_requirements.sh"
+bash "${vagrant_dir}/scripts/host/check_requirements.sh"
 
 # Setup composer if necessary
 if [ ! -f ${composer_phar} ]; then
@@ -23,9 +23,9 @@ fi
 cd ${current_dir}
 cp ${composer_auth_json} "${PWD}/auth.json"
 
-host_os=$(bash "${vagrant_dir}/scripts/host/shell/get_host_os.sh")
-if [[ ${host_os} == "Windows" ]]; then
-    # prefer-source option guarantees that there will be no issues related to max path length on Windows
+host_os=$(bash "${vagrant_dir}/scripts/host/get_host_os.sh")
+if [[ $(bash "${vagrant_dir}/scripts/host/get_variable_value.sh" "environment_composer_prefer_source") == 1 ]]; then
+    # prefer-source is slow but guarantees that there will be no issues related to max path length on Windows
     php ${composer_phar} --ignore-platform-reqs --prefer-source "$@"
 else
     php ${composer_phar} --ignore-platform-reqs "$@"

init_project.sh

@@ -1,21 +1,21 @@
 #!/usr/bin/env bash
 
-vagrant_dir=$(cd "$(dirname "$0")/../../.."; pwd)
-composer_auth_json="${vagrant_dir}/local.config/composer/auth.json"
+vagrant_dir=$(cd "$(dirname "$0")/../.."; pwd)
+composer_auth_json="${vagrant_dir}/etc/composer/auth.json"
 
 # Enable trace printing and exit on the first error
 set +x
 
 cd ${vagrant_dir}
-ssh_port=$(bash "${vagrant_dir}/scripts/host/shell/get_variable_value.sh" "guest_forwarded_ssh_port")
-magento_host_name=$(bash "${vagrant_dir}/scripts/host/shell/get_variable_value.sh" "magento_host_name")
+ssh_port=$(bash "${vagrant_dir}/scripts/host/get_variable_value.sh" "guest_forwarded_ssh_port")
+magento_host_name=$(bash "${vagrant_dir}/scripts/host/get_variable_value.sh" "magento_host_name")
 
 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/shell/get_host_os.sh")
-if [[ ${host_os} == "Windows" || $(bash "${vagrant_dir}/scripts/host/shell/get_variable_value.sh" "guest_use_nfs") == 0 ]]; then
+host_os=$(bash "${vagrant_dir}/scripts/host/get_host_os.sh")
+if [[ ${host_os} == "Windows" || $(bash "${vagrant_dir}/scripts/host/get_variable_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"
@@ -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/host/shell/get_variable_value.sh" "repository_url_ee")
+repository_url_ee=$(bash "${vagrant_dir}/scripts/host/get_variable_value.sh" "repository_url_ee")
 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"

scripts/host/shell/check_requirements.sh scripts/host/check_requirements.sh

@@ -17,11 +17,11 @@ parse_yaml() {
     }'
 }
 
-vagrant_dir=$(cd "$(dirname "$0")/../../.."; pwd)
+vagrant_dir=$(cd "$(dirname "$0")/../.."; pwd)
 variable_name=$1
 
 # Read configs
-eval $(parse_yaml "${vagrant_dir}/local.config/config.yaml.dist")
-eval $(parse_yaml "${vagrant_dir}/local.config/config.yaml")
+eval $(parse_yaml "${vagrant_dir}/etc/config.yaml.dist")
+eval $(parse_yaml "${vagrant_dir}/etc/config.yaml")
 
 echo ${!variable_name}

scripts/host/shell/composer.sh scripts/host/composer.sh

@@ -11,8 +11,8 @@ use_php7=$4
 vagrant_dir="/vagrant"
 
 # Enable Magento virtual host
-custom_virtual_host_config="${vagrant_dir}/local.config/magento2_virtual_host.conf"
-default_virtual_host_config="${vagrant_dir}/local.config/magento2_virtual_host.conf.dist"
+custom_virtual_host_config="${vagrant_dir}/etc/magento2_virtual_host.conf"
+default_virtual_host_config="${vagrant_dir}/etc/magento2_virtual_host.conf.dist"
 if [ -f ${custom_virtual_host_config} ]; then
     virtual_host_config=${custom_virtual_host_config}
 else
@@ -52,7 +52,7 @@ fi
 service apache2 restart
 
 # Configure composer
-composer_auth_json="${vagrant_dir}/local.config/composer/auth.json"
+composer_auth_json="${vagrant_dir}/etc/composer/auth.json"
 if [ -f ${composer_auth_json} ]; then
     set +x
     echo "Installing composer OAuth tokens from ${composer_auth_json}..."