Merge pull request #72 from paliarush/Sample-Data-Support

Sample data support (#18)

Author: paliarush

CHANGELOG.md

@@ -19,6 +19,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
+ - Added sample data support
  - Added ElasticSearch support
 
 ## [v2.1.0] - 2016-06-22

README.md

@@ -1,5 +1,6 @@
 # Vagrant project for Magento 2 developers (optimized for Mac, Windows and \*nix hosts)
 
+[![Tests passing on OSX](docs/images/tests_badge.png)](https://github.com/paliarush/magento2-vagrant-for-developers-tests)
 [![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)
 [![Latest GitHub release](docs/images/release_badge.png)](https://github.com/paliarush/magento2-vagrant-for-developers/releases/latest)
@@ -13,14 +14,15 @@
  * [Day-to-day development scenarios](#day-to-day-development-scenarios)
    * [Reinstall Magento](#reinstall-magento)
    * [Clear Magento cache](#clear-magento-cache)
-   * [Update Composer dependencies](#update-composer-dependencies)
    * [Switch between CE and EE](#switch-between-ce-and-ee)
+   * [Sample data installation](#sample-data-installation)
    * [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)
    * [Multiple Magento instances](#multiple-magento-instances)
+   * [Update Composer dependencies](#update-composer-dependencies)
  * [Environment configuration](#environment-configuration)
    * [Switch between PHP 5.6 and 7.0](#switch-between-php-56-and-70)
    * [Activating Varnish](#activating-varnish)
@@ -169,15 +171,12 @@ Force switch can be done using `-f` flag even if already switched to the target
 
 :information_source: On Windows hosts (or when NFS mode is disabled in [config.yaml](etc/config.yaml.dist) explicitly) you will be asked to wait until code is uploaded to guest machine by PhpStorm (PhpStorm must be launched). To continue the process press any key.
 
-### Update Composer dependencies
+### Sample data installation
 
-Go to 'vagrant-magento' created earlier and run in command line:
+Make sure that `ce_sample_data` and `ee_sample_data` are defined in [config.yaml](etc/config.yaml.dist) and point CE and optionally EE sample data repositories.
+During initial project setup or during `bash init_project.sh -fc` (with `-fc` project will be re-created from scratch), sample data repositories willl be checked out to `vagrant_project_root/magento2ce/magento2ce-sample-data` and `vagrant_project_root/magento2ce/magento2ee-sample-data`.
 
-```
-bash m-composer install
-OR
-bash m-composer update
-```
+To install Magento with sample data set `install_sample_data` in [config.yaml](etc/config.yaml.dist) to `1` and run `bash m-switch-to-ce -f` or `bash m-switch-to-ee -f`, depending on the edition to be installed. To disable sample data, set this option to `0` and force-switch to necessary edition (using the same commands).
 
 ### Use Magento CLI (bin/magento)
 
@@ -229,6 +228,16 @@ After editing configs in IDE it is still required to restart related services ma
 To install several Magento instances based on different code bases, just follow [Installation steps](#installation-steps) to initialize project in another directory on the host.
 Unique IP address, SSH port and domain name will be generated for each new instance if not specified manually in `etc/config.yaml`
 
+### Update Composer dependencies
+
+Go to 'vagrant-magento' created earlier and run in command line:
+
+```
+bash m-composer install
+OR
+bash m-composer update
+```
+
 ## Environment configuration
 
 ### Switch between PHP 5.6 and 7.0

docs/images/tests_badge.png

@@ -1,7 +1,13 @@
 repository_url:
   # [To apply changes: init-project -fc]
+  # git@github.com:magento/magento2ce.git OR custom one
   ce: "git@github.com:magento/magento2.git"
+  # git@github.com:magento/magento2ee.git OR custom one
   ee: ""
+  # can be replaced with custom repository
+  ce_sample_data: "git@github.com:magento/magento2-sample-data.git"
+  # git@github.com:magento/magento2-sample-data-ee.git OR custom one
+  ee_sample_data: ""
 guest:
   # [To apply changes: init-project -f]
   # NFS will be used for folder synchronization on *nix and OSX hosts by default.
@@ -22,6 +28,8 @@ environment:
   # [To apply changes: m-reinstall]
   search_engine: "mysql"
 magento:
+  # [To apply changes: m-switch-to-ce -f OR m-switch-to-ee -f]
+  install_sample_data: 0
   # [To apply changes: init-project -f]
   host_name: "magento2.vagrant2"
   # [To apply changes: m-reinstall]

docs/images/tests_badge.svg

@@ -2,7 +2,9 @@
 
 vagrant_dir=$PWD
 magento_ce_dir="${vagrant_dir}/magento2ce"
+magento_ce_sample_data_dir="${magento_ce_dir}/magento2ce-sample-data"
 magento_ee_dir="${magento_ce_dir}/magento2ee"
+magento_ee_sample_data_dir="${magento_ce_dir}/magento2ee-sample-data"
 config_path="${vagrant_dir}/etc/config.yaml"
 host_os=$(bash "${vagrant_dir}/scripts/host/get_host_os.sh")
 use_nfs=$(bash "${vagrant_dir}/scripts/get_config_value.sh" "guest_use_nfs")
@@ -69,11 +71,20 @@ if [[ ! -d ${magento_ce_dir} ]]; then
     fi
     # Check out CE repository
     git clone ${repository_url_ce} "${magento_ce_dir}"
+    # Check out CE sample data repository
+    repository_url_ce_sample_data=$(bash "${vagrant_dir}/scripts/get_config_value.sh" "repository_url_ce_sample_data")
+    git clone ${repository_url_ce_sample_data} ${magento_ce_sample_data_dir}
     # Check out EE repository
     # By default EE repository is not specified and EE project is not checked out
     if [[ -n "${repository_url_ee}" ]]; then
         git clone ${repository_url_ee} "${magento_ee_dir}"
     fi
+    # Check out EE sample data repository
+    # By default EE sample data repository is not specified and EE project is not checked out
+    repository_url_ee_sample_data=$(bash "${vagrant_dir}/scripts/get_config_value.sh" "repository_url_ee_sample_data")
+    if [ -n "${repository_url_ee_sample_data}" ]; then
+        git clone ${repository_url_ee_sample_data} ${magento_ee_sample_data_dir}
+    fi
 fi
 
 # Update Magento dependencies via Composer

etc/config.yaml.dist

@@ -6,4 +6,4 @@ vagrant_dir=$(cd "$(dirname "$0")"; pwd)
 set -ex
 
 cd "${vagrant_dir}"
-vagrant ssh -c "m-reinstall"
+vagrant ssh -c "m-reinstall"

init_project.sh

@@ -17,39 +17,40 @@ while getopts 'f' flag; do
   esac
 done
 
-if [[ ! -f ${magento_ee_dir}/app/etc/aliases_to_classes_map.json ]]; then
-    set +x
-    echo "EE codebase is not available"
-    set -x
-    if [[ ${force_switch} -eq 1 ]]; then
-        bash "${vagrant_dir}/m-reinstall"
+if [[ ! -f ${magento_ee_dir}/app/etc/enterprise/di.xml ]]; then
+    if [[ ${force_switch} -eq 0 ]]; then
+        set +x
+        echo "EE codebase is not available. Use 'm-switch-to-ce -f' to switch anyway."
+        set -x
+        exit 0
     fi
-    exit 0
-fi
-
-if [[ ! -f ${magento_ce_dir}/app/etc/aliases_to_classes_map.json ]] && [[ ${force_switch} -eq 0 ]]; then
-    set +x
-    echo "Already switched to CE. Use 'm-switch-to-ce -f' to switch anyway."
-    exit 0
-fi
-
-${php_executable} -f ${magento_ee_dir}/dev/tools/build-ee.php -- --command=unlink --ee-source="${magento_ee_dir}" --ce-source="${magento_ce_dir}"
-
-cd ${magento_ce_dir}
-git checkout composer.json
-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
-        rm ${magento_ce_dir}/app/etc/aliases_to_classes_map.json
+else
+    if [[ ! -f ${magento_ce_dir}/app/etc/enterprise/di.xml ]] && [[ ${force_switch} -eq 0 ]]; then
+        set +x
+        echo "Already switched to CE. Use 'm-switch-to-ce -f' to switch anyway."
+        exit 0
     fi
-    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
+
+    ${php_executable} -f ${magento_ee_dir}/dev/tools/build-ee.php -- --command=unlink --ee-source="${magento_ee_dir}" --ce-source="${magento_ce_dir}"
+
+    cd ${magento_ce_dir}
+    git checkout composer.json
+    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
+            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
+            rm ${magento_ce_dir}/app/etc/enterprise/di.xml
+            rmdir ${magento_ce_dir}/app/etc/enterprise
+        fi
     fi
 fi
 
+bash "${vagrant_dir}/scripts/host/relink_sample_data.sh"
+
 bash "${vagrant_dir}/m-clear-cache"
 bash -c "${vagrant_dir}/m-composer install"
 
@@ -58,4 +59,4 @@ if [[ ${host_os} == "Windows" ]] || [[ $(bash "${vagrant_dir}/scripts/get_config
     read -p "Wait while Magento2 code is uploaded in PhpStorm and press any key to continue..." -n1 -s
 fi
 
-bash "${vagrant_dir}/m-reinstall"
+bash "${vagrant_dir}/m-reinstall"

m-reinstall

@@ -9,12 +9,6 @@ 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
-    set +x
-    echo "EE codebase is not available"
-    exit 0
-fi
-
 force_switch=0
 while getopts 'f' flag; do
   case "${flag}" in
@@ -23,30 +17,41 @@ while getopts 'f' flag; do
   esac
 done
 
-if [[ -f ${magento_ce_dir}/app/etc/aliases_to_classes_map.json ]] && [[ ${force_switch} -eq 0 ]]; then
-    set +x
-    echo "Already switched to EE. Use 'm-switch-to-ee -f' to switch anyway."
-    exit 0
-fi
-
-${php_executable} -f ${magento_ee_dir}/dev/tools/build-ee.php -- --command=link --ee-source="${magento_ee_dir}" --ce-source="${magento_ce_dir}"
-
-cp ${magento_ee_dir}/composer.json ${magento_ce_dir}/composer.json
-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
-        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
+if [[ ! -f ${magento_ee_dir}/app/etc/enterprise/di.xml ]]; then
+    if [[ ${force_switch} -eq 0 ]]; then
+        set +x
+        echo "EE codebase is not available. Use 'm-switch-to-ee -f' to switch anyway."
+        set -x
+        exit 0
     fi
-    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
+else
+    if [[ -f ${magento_ce_dir}/app/etc/enterprise/di.xml ]] && [[ ${force_switch} -eq 0 ]]; then
+        set +x
+        echo "Already switched to EE. Use 'm-switch-to-ee -f' to switch anyway."
+        exit 0
+    fi
+
+    ${php_executable} -f ${magento_ee_dir}/dev/tools/build-ee.php -- --command=link --ee-source="${magento_ee_dir}" --ce-source="${magento_ce_dir}"
+
+    cp ${magento_ee_dir}/composer.json ${magento_ce_dir}/composer.json
+    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
+            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
+            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
+        fi
     fi
 fi
 
+bash "${vagrant_dir}/scripts/host/relink_sample_data.sh"
+
 bash "${vagrant_dir}/m-clear-cache"
 bash "${vagrant_dir}/m-composer" install
 
@@ -55,4 +60,4 @@ if [[ ${host_os} == "Windows" ]] || [[ $(bash "${vagrant_dir}/scripts/get_config
     read -p "Wait while Magento2 code is uploaded in PhpStorm and press any key to continue..." -n1 -s
 fi
 
-bash "${vagrant_dir}/m-reinstall"
+bash "${vagrant_dir}/m-reinstall"

m-switch-to-ce

@@ -0,0 +1,71 @@
+#!/usr/bin/env bash
+
+vagrant_dir=$(cd "$(dirname "$0")/../.."; pwd)
+magento_ce_dir="${vagrant_dir}/magento2ce"
+magento_ee_dir="${magento_ce_dir}/magento2ee"
+magento_ce_sample_data_dir="${magento_ce_dir}/magento2ce-sample-data"
+magento_ee_sample_data_dir="${magento_ce_dir}/magento2ee-sample-data"
+php_executable="$(bash "${vagrant_dir}/scripts/host/get_path_to_php.sh")"
+install_sample_data=$(bash "${vagrant_dir}/scripts/get_config_value.sh" "magento_install_sample_data")
+
+
+# Enable trace printing and exit on the first error
+set -ex
+
+install_ee=0
+if [[ -f "${magento_ce_dir}/app/etc/enterprise/di.xml" ]]; then
+    install_ee=1
+fi
+
+# As a precondition, disable CE sample data
+if [[ -f "${magento_ce_sample_data_dir}/dev/tools/build-sample-data.php" ]]; then
+    ${php_executable} -f "${magento_ce_sample_data_dir}/dev/tools/build-sample-data.php" -- --command=unlink --ce-source="${magento_ce_dir}" --sample-data-source="${magento_ce_sample_data_dir}"
+    set +x
+    echo "CE Sample data disabled"
+    set -x
+fi
+# As a precondition, disable EE sample data
+if [[ -f "${magento_ee_sample_data_dir}/dev/tools/build-sample-data.php" ]]; then
+    "${php_executable}" -f "${magento_ee_sample_data_dir}/dev/tools/build-sample-data.php" -- --command=unlink --ce-source="${magento_ce_dir}" --sample-data-source="${magento_ee_sample_data_dir}"
+    set +x
+    echo "EE Sample data disabled"
+    set -x
+fi
+
+if [[ ${install_ee} -eq 1 ]]; then
+    "${php_executable}" -f "${magento_ee_dir}/dev/tools/build-ee.php" -- --command=link --ee-source="${magento_ee_dir}" --ce-source="${magento_ce_dir}"
+fi
+
+if [[ ${install_sample_data} -eq 1 ]]; then
+    # Installing CE or EE, in both cases CE sample data should be linked
+    if [[ ! -f "${magento_ce_sample_data_dir}/dev/tools/build-sample-data.php" ]]; then
+        # Sample data not available and should be enabled
+        set +x
+        echo "CE Sample data repository is not available. Recreate project using \"init_project.sh -fc\", which will delete Magento code base and recreate project from scratch. Or clone sample data to <project_dir>/magento2ce/magento2ce-sample-data."
+        set -x
+        exit 0
+    else
+        # Sample data available and should be enabled
+        set +x
+        echo "CE Sample data enabled"
+        set -x
+        "${php_executable}" -f "${magento_ce_sample_data_dir}/dev/tools/build-sample-data.php" -- --command=link --ce-source="${magento_ce_dir}" --sample-data-source="${magento_ce_sample_data_dir}"
+    fi
+
+    if [[ ${install_ee} -eq 1 ]]; then
+        # Installing EE
+        if [[ ! -f "${magento_ee_sample_data_dir}/dev/tools/build-sample-data.php" ]]; then
+            # Sample data not available and should be enabled
+            set +x
+            echo "EE Sample data repository is not available. Recreate project using \"init_project.sh -fc\", which will delete Magento code base and recreate project from scratch. Or clone sample data to <project_dir>/magento2ce/magento2ee-sample-data."
+            set -x
+            exit 0
+        else
+            # Sample data available and should be enabled
+            set +x
+            echo "EE Sample data enabled"
+            set -x
+            "${php_executable}" -f "${magento_ee_sample_data_dir}/dev/tools/build-sample-data.php" -- --command=link --ce-source="${magento_ce_dir}" --sample-data-source="${magento_ee_sample_data_dir}"
+        fi
+    fi
+fi