Development of Magento modules with application deployment through Magento Composer

Introduction

The article describes the experience of deploying a developer version of a Magento application using Magento Composer. The structure of a typical Magento application in our company:

• Magento
• Third-party modules used in the project
• We are developing modules used in more than one of our projects.
• We are developing a module containing functionality specifically for this project.
• Subject for a specific project

The developer version of the Magento application should allow you to develop the code of our modules and upload changes to the corresponding repositories, allowing the code of common modules to migrate between projects.

In connection with the launch of a new project to deploy Magento applications, we decided to try Magento Composer . At the moment, we have the code for each project stored in its SVN repository, plus in a separate - all modules developed by us (both general and specialized):

• Magento installation and third-party modules for project 01;
• Magento installation and third-party modules for project 02;
• ...
• our modules;

')
To use Magento Composer, the project was divided into the following parts (each in its git repository):

• z_mage_composer_prj_01_full : deployment scripts for the entire project, theme, third-party modules not available through Magento Composer;
• z_mage_composer_mod_01 : the first module on which the project depends;
• z_mage_composer_mod_02 : the second module on which the project depends;

Environment preparation

During the experiments, it turned out that Windows is not well suited for deploying the developer version of the application. Magento Composer offers two deployment strategies: copy (copying module files to the structure of a Magento application) and symlink (creating symbolic links to module files in the structure of a Magento application). The developer version can only use symbolic links, since you need to keep the sources of the modules compactly in their folders in the vendor directory (the place where Composer places the files of the used modules). Symbolic links in Windows do not work out well enough - changes made to the original file are reflected by reference with a long delay (both in IDE PhpStorm and on the web server itself). Plus (or rather, minus) - the approach used in Magento to find templates and description of layouts ( app / design / frontend / [default] / [default] directory) does not work in Windows (Mage_Core_Model_Design_Package :: validateFile and Mage_Core_Block_Template :: fetchView), but this is more a problem at the PHP level than at the Magento level. In general, after long attempts to deploy a developer version of Windows, it was considered not the most convenient option for development (although possible), so Linux remained to be continued (Ubuntu 14.04).

There were no problems with the installation of Composer itself:

curl -sS https://getcomposer.org/installer | php mv composer.phar /usr/local/bin/composer 

Everything else (including the installation of Magento Composer) is done by setting up the project in composer.json.

composer.json

I give only the settings that are relevant in this context (full version of composer.json ):

 { ... "type": "magento-module", ... "require": { "magento-hackathon/magento-composer-installer": "*", "magento-hackathon/composer-command-integrator": "*@dev", "composer/composer": "*@alpha", "magento/core": "1.9.1.0", "magento-hackathon/hackathon_magemonitoring": "*", "connect20/nmmlm_log": "*", "praxigento/z_mage_composer_mod_01": "*@dev", "praxigento/z_mage_composer_mod_02": "*@dev" }, "repositories": [ { "type": "composer", "url": "http://packages.firegento.com" }, { "type": "vcs", "url": "https://github.com/praxigento/z_mage_composer_mod_01" }, { "type": "vcs", "url": "https://github.com/praxigento/z_mage_composer_mod_02" } ], "extra": { "magento-root-dir": "mage", "magento-deploystrategy": "symlink", "auto-append-gitignore": true } } 

Require section

• magento-hackathon / magento-composer-installer : directly to Magento Composer itself;
• magento-hackathon / composer-command-integrator : a module for incremental updating of Magento-modules during development (for creating symbolic links to new files when adding files in a module);
• composer / composer : the exact “alpha” classifier is needed in order for composer-command-integrator to work;
• magento / core : Magento code itself;
• magento-hackathon / hackathon_magemonitoring : a third-party module loaded from the Magento Composer repository (for example);
• connect20 / nmmlm_log : module freely distributed via Magento Connect (loaded from Magento Connect repository in Magento Composer repository )
• praxigento / z_mage_composer_mod_01 : one of our own module, the code of which is in the github repository;
• praxigento / z_mage_composer_mod_02 : the second is our own module, the code of which is also located in the github repository;

Repositories section

Close the composer to the repository of Magento modules:

  { "type": "composer", "url": "http://packages.firegento.com" } 

... and indicate the addresses of the repositories, where our own modules used in the project are located:

  { "type": "vcs", "url": "https://github.com/praxigento/z_mage_composer_mod_01" }, { "type": "vcs", "url": "https://github.com/praxigento/z_mage_composer_mod_02" } 

Extra section

• magento-root-dir : set the directory in which we will expand Magento ( mage );
• magento-deploystrategy : set the deployment strategy - symlink for the developer version;
• auto-append-gitignore : specify that the files of the Magento modules that will be linked to the Magento application (the mage directory) should be added to the mage / .gitignore file to be out of version control;

Deploying the project

 $ git clone git@github.com:praxigento/z_mage_composer_prj_01_full.git full $ cd full $ composer install 

As a result of the project deployment, the source codes of our modules fall into the vendor directory (screenshots are taken from the local station on Windows)

... linked to the mage Magento-catalog:

... the theme and modules that are not installed via Magento Composer are uploaded directly to the mage directory:

Mount points for various repositories with source codes:


There are two .gitignore files in the project :

• .gitignore : manually filled in by developers;
• mage / .gitignore : Filled automatically by the Magento Composer when deploying Magento itself and the modules;

Features of the development of modules

All module files must be registered in the modman's mapping registry :

 path/to/file/in/module path/to/file/in/magento 

You can create a modman file with the following command :

 for i in `find . -type f | grep -v \.git | grep -v "^.$" | grep -v "modman" | sed 's/\.\///'`; do echo ${i} ${i}; done > modman 

After adding a new file to the module, you need to start the command integrator so that the new files link to the root directory of Magento:

 $ ./vendor/bin/composerCommandIntegrator.php magento-module-deploy 

In order for the module to unfold in a form suitable for working with a version control system, in the composer.json file of the module you need to specify:

 { "name": "praxigento/z_mage_composer_mod_01", ... "config": { "preferred-install": "source" } } 

When editing a file by reference in IDE (PhpStorm), there is a discrepancy between the “apparent” ( mage / app / code / community / Vendor / Ext / Model / Observer.php ) and the “existing” (vendor / company / module / app / code / community / Vendor / Ext / Model / Observer.php) - editing the “existing” version with a delay is reflected in the “apparent” (and the Refresh function in PhpStorm is not provided for this case - you have to add a symbol to the “apparent” version, press Ctrl + S and update via “Load File System Changes”). Breakpoints for debugging can be set in both versions of the file, but step-by-step tracing goes only on the “existing” (sometimes the stop appears as if from scratch - in the “seeming” version there is a breakpoint on the corresponding line).

Additionally

" Using different VCS repositories in PhpStorm "