Magento Continuous Integration Tools

A set of tools to help set up a proper environment for testing magento

Installation

Installation is very easy though composer.json

In your application or dependent library root directory, create a composer.json file. In case you are not familiar with Composer, see composer.json Schema.

In the require or alternatively in the require-dev section, add the following dependency:

"ecomdev/mage-ci": "dev-master"

Usage

Running a batch of PHPUnit tests

$ mage-ci phpunit <directory> <OPTIONS> 
    Runs unit tests for all phpunit.xml or phpunit.dist.xml files in <directory> or its subdirectories. 
    <OPTIONS> will be passed directly to phpunit binary.

Installing a particular Magento version

$ bin/mage-ci install <magento_directory> <version> <db_name> <OPTIONS>
    Installs a Magento version to a specified destination
      -c                  Create databases flag
      -t                  Create test database flag (only in combination with -c option)
      -u  <db_user>       DB Username
      -p  <db_pass>       DB Password
      -r  <sql_base_url>  SQL dumps repository url for a particular Magento version (<sql_base_url>/<version>.sql.gz)
      -f  <sql_dump_file> SQL dump file, if you'd like to preinstall some data and specfied -c option

Installing a Magento module

$ bin/mage-ci install-module <magento_directory> <module_dir_or_vcs_url>
    Installs a Magento module with modman definition

Updating installed Magento modules

$ bin/mage-ci update-modules <magento_directory>
    Updates all installed modman modules at specified Magento instnace

Uninstalling Magento version

$ bin/mage-ci uninstall <magento_directory> [<db_name>] <OPTIONS>
    Performs uninstall of Magento instance
      -u  <db_user>       DB Username
      -p  <db_pass>       DB Password

Uninstalling Magento module

$ bin/mage-ci uninstall-module <magento_directory> <module_dir_or_vcs_url>
    Performs uninstall of Magento module from instance

Mass Install of Magento versions

$ bin/mage-ci install-multiple <directory> <prefix> <version1> ... <versionN> <OPTIONS>
    Installs multiple version of magento at <directory> in subdirectories which name is a combined value of <prefix>-<version> 
       -d  <download_dir>  Directory where all downloads are stored
       -u  <db_user>       DB Username
       -p  <db_pass>       DB Password
       -t                  Create test db as well
       -r  <sql_base_url>  SQL dumps repository url for a particular Magento version (<sql_base_url>/<version>.sql.gz)

Dump databases of existing installed versions

$ bin/mage-ci db-dump <directory> <prefix> <version1> ... <versionN> <OPTIONS>
    Creates Magento database dump file at <directory> directory with name <file_prefix><version>.sql.gz, the dumped database is <prefix>_<version>
       -u  <db_user>       DB Username
       -p  <db_pass>       DB Password
       -s  <file_prefix>   sql file prefix

Magento Clean DB Dumps

It is possible to specify base url for downloading of database dump for a particular Magento version. Most of the time clean installation of Magento takes a lot of time, so it is nice to have this clean db dump prepared for each Magento version.

We created such repository at the following url: http://mage-ci.ecomdev.org

You just need to specify it during installation of process:

$ bin/mage-ci install magento-1.7.0.2 1.7.0.2 mage_1.7.0.2 -r http://mage-ci.ecomdev.org

This command will download db dump from the following URL: http://mage-ci.ecomdev.org/1.7.0.2.sql.gz

Comments

Mac OS X error

I have no idea what to do. If I understand it correct, readlink is not useable under OS X. Then it falls back to realpath, which is obviously missing :-/ Any ideas?

brank:tmp myUserName$ vendor/bin/mage-ci install /Users/myUserName/__htdocs/magento 1.7.0.2 mage -u mage -p naaYStF8wrNG3J45
readlink: illegal option -- f
usage: readlink [-n] [file ...]
vendor/bin/mage-ci: line 19: realpath: command not found

opened by Schrank 4

`readlink -f` does not exist on OSX

Unfortunately will probably require a solution such as https://github.com/magento/taf/commit/0312cb9129d9812c523487233b5893ee7b9988f9#runtests.sh unless there are any better ideas?

opened by punkstar 1
Fixed missing pathname quotes and incompatibilties with git bash

Most pathnames weren't quoted leading to instable behavior with paths containing spaces.

Additionally added support for systems that do not have realpath and readlink. Similar with tput, if not available ANSI escape sequences are used.

opened by hakre 0
Allow defintion of a PHP binary for PHP commands

In order to test my Magento extension across multiple versions of PHP As a Magento extension developer I want to be able to install different versions of Magento against different versions of PHP

opened by punkstar 0
Add optional parameter for DB hostname

Adds an optional parameter -h to the applicable tasks so that you can specify a hostname for the database connection.

I've needed this option when using Semaphore as localhost wasn't working but switching to 127.0.0.1 was.

opened by josh-taylor 0