Tag: 3rd_party

Find available updates for installed modules

Post author By Christian Münch
Post date February 11, 2016
1 Comment on Find available updates for installed modules

The Hypernode team of byte a hosting company in the Netherlands created a very useful n98-magerun plugin to detect outdated modules in your shop.

You can find the plugin on github.

https://github.com/Hypernode/hypernode-magerun

The plugins adds two new command to your command list:

sys:modules:list-updates
sys:info:patches

The command sys:modules:list-updates command checks your locally installed modules against a list of 500 community modules and prints all module which are outdated.

The other command sys:info:patches prints all not applied official patches.

Thanks Byte for this useful n98-magerun plugin.

Tags 3rd_party

Magerun

MageRun Addons by Peter Jaap Blaakmeer

Post author By Christian Münch
Post date December 20, 2014
1 Comment on MageRun Addons by Peter Jaap Blaakmeer

This article is part of a series covering 3rd party n98-magerun modules/extensions.

In this post we cover a 3rd party n98-magerun module created by Peter Jaap Blaakmeer which adds some new commands to your list.

Tags 3rd_party

Magerun

HarrisStreet ImpEx for Magento

Post author By Christian Münch
Post date September 28, 2014
1 Comment on HarrisStreet ImpEx for Magento

This article is part of a series covering 3rd party n98-magerun modules/extensions.

In this post we show you another great module to manage your Magento configurations. It supports importing and exporting of store config data in a hierarchical folder structure. This can be done for different environments.

The module was created by Zookal pty ltd the largest student portal in Australia.

Tags 3rd_party, Configuration

Magerun

LimeSoda Environment Configuration

Post author By Christian Münch
Post date August 23, 2014
4 Comments on LimeSoda Environment Configuration

This article is part of a series covering 3rd party n98-magerun modules/extensions.

The next article presents a solution to manage several developer, staging, production environements with a n98-magerun module and and a Magento module (can be installed at once).
If you have multiple Magento environments i.e. for all your developers you know the problem. Someone dumps a database and share it with another developer. Now every developer runs in the same boring issue. Changing the configuration according to the current environment. The list of configurations grows and grows… You know the problems.

At this point the solution of Limesoda can help you.

Installation

You need to install the file directly in your Magento installation via modman.

modman clone https://github.com/LimeSoda/LimeSoda_EnvironmentConfiguration.git

1 2	modman clone https://github.com/LimeSoda/LimeSoda_EnvironmentConfiguration.git

After the installation you must define the name of your config environment. This can be done in config.xml (in this case
the app/etc/local.xml file).

Define your dev-environment:

&lt;config&gt;
    &lt;global&gt;
        &lt;limesoda&gt;
            &lt;environment&gt;
                &lt;name&gt;dev&lt;/name&gt;
            &lt;/environment&gt;
        &lt;/limesoda&gt;
    &lt;/global&gt;
&lt;/config&gt;

</environment>

</limesoda>

</global>

</config>

Default environment

Create a new Magento module to define a config. Add a global > limesoda > environments node to your config.xml file.

&lt;?xml version="1.0"?&gt;
&lt;config&gt;
    &lt;global&gt;
        &lt;limesoda&gt;
            &lt;environments&gt;
                 &lt;default /&gt;
            &lt;/environments&gt;
        &lt;/limesoda&gt;
    &lt;/global&gt;
&lt;/config&gt;

<?xml version="1.0"?>

</environments>

</limesoda>

</global>

</config>

This was easy! We have our first default environment defined.

Now we can run n98-magerun with the new embedded command.

n98-magerun.phar ls:env:configure default

1 2	n98-magerun.phar ls:env:configure default

The output is currently empty, because our environment has no commands defined.

Define commands

Now we extend the previous config and add some n98-magerun commands. You can call every n98-magerun command as batch.

&lt;?xml version="1.0"?&gt;
&lt;config&gt;
    &lt;global&gt;
        &lt;limesoda&gt;
            &lt;environments&gt;
                &lt;default&gt;
                    &lt;commands&gt;
                        &lt;set_base_url&gt;config:set web/unsecure/base_url http://magento.local/&lt;/set_base_url&gt;
                        &lt;set_sec_base_url&gt;config:set web/unsecure/base_url http://magento.local/&lt;/set_sec_base_url&gt;
                        &lt;cf&gt;cache:flush&lt;/cf&gt;
                    &lt;/commands&gt;
                &lt;/default&gt;
            &lt;/environments&gt;
         &lt;/limesoda&gt;
    &lt;/global&gt;
&lt;/config&gt;

<?xml version="1.0"?>

<set_base_url>config:set web/unsecure/base_url http://magento.local/</set_base_url>

<set_sec_base_url>config:set web/unsecure/base_url http://magento.local/</set_sec_base_url>

<cf>cache:flush</cf>

</commands>

</default>

</environments>

</limesoda>

</global>

</config>

This calls two config settings and a cache flush sequentially.

Using variables

If you look at the previous example you see that we used the same url two times. Let’s create a varible for that and see how simple is is to use a variable.

&lt;limesoda&gt;
    &lt;environments&gt;
        &lt;default&gt;
            &lt;variables&gt;
                &lt;base_url&gt;&lt;![CDATA[http://magento.local/]]&gt;&lt;/base_url&gt;
            &lt;/variables&gt;
            &lt;commands&gt;
                &lt;set_base_url&gt;config:set web/unsecure/base_url ${base_url}&lt;/set_base_url&gt;
                &lt;set_sec_base_url&gt;config:set web/secure/base_url ${base_url}&lt;/set_sec_base_url&gt;
                &lt;cf&gt;cache:flush&lt;/cf&gt;
            &lt;/commands&gt;
        &lt;/default&gt;
    &lt;/environments&gt;
&lt;/limesoda&gt;

<base_url><![CDATA[http://magento.local/]]></base_url>

</variables>

<set_base_url>config:set web/unsecure/base_url ${base_url}</set_base_url>

<set_sec_base_url>config:set web/secure/base_url ${base_url}</set_sec_base_url>

<cf>cache:flush</cf>

</commands>

</default>

</environments>

</limesoda>

Run n98-magerun again and you should see that output:

n98-magerun.phar ls:env:configure default
web/unsecure/base_url =&gt; http://magento.local/
web/secure/base_url =&gt; http://magento.local/
Cache cleared
FPC cleared

n98-magerun.phar ls:env:configure default

web/unsecure/base_url => http://magento.local/

web/secure/base_url => http://magento.local/

Cache cleared

FPC cleared

Nesting environments

This was very cool, but nesting the environments is really hot!
Let’s do it.
You can do it by adding the attribut parent to your environment definition in XML.

A typical setup could be:

.
├── default
│   ├── dev
│   │   ├── developer1
│   │   ├── developer2
│   │   └── developer3
│   ├── production
│   └── staging

├── default

│ ├── dev

│ │ ├── developer1

│ │ ├── developer2

│ │ └── developer3

│ ├── production

│ └── staging

Now we define this setup in our config:

&lt;?xml version="1.0"?&gt;
&lt;config&gt;
    &lt;global&gt;
        &lt;limesoda&gt;
            &lt;environments&gt;
                &lt;default&gt;
                    &lt;!-- Commands etc. --&gt;
                &lt;/default&gt;
                &lt;dev parent="default" /&gt;
                &lt;developer1 parent="dev" /&gt;
                &lt;developer2 parent="dev" /&gt;
                &lt;developer3 parent="dev" /&gt;
                &lt;staging parent="default" /&gt;
                &lt;production parent="default" /&gt;
            &lt;/environments&gt;
        &lt;/limesoda&gt;
    &lt;/global&gt;
&lt;/config&gt;

<?xml version="1.0"?>

</default>

</environments>

</limesoda>

</global>

</config>

The command processes your configs recursivly. That’s the power of the LimeSode Environment Configuration module.

If you like this way to manage your environments give the modules a change.
You can fetch the module from github.

https://github.com/LimeSoda/LimeSoda_EnvironmentConfiguration

Tags 3rd_party, Configuration, Environment, setup

Magerun

MageRun Addons by Kalen Jordan

Post author By Christian Münch
Post date August 15, 2014
No Comments on MageRun Addons by Kalen Jordan

This article is part of a series covering 3rd party n98-magerun modules/extensions.

Kalen Jordan (creator and founder of MageMail) is one of our longest n98-magerun users and contributors.
He was the first who published a 3rd party module with some nice commands. That’s what i like to present you now (mostly copied from module README).

You can find the module here: https://github.com/kalenjordan/magerun-addons

Installation is really simple:

mkdir -p ~/.n98-magerun/modules/
cd ~/.n98-magerun/modules/
git clone https://github.com/kalenjordan/magerun-addons

mkdir -p ~/.n98-magerun/modules/

cd ~/.n98-magerun/modules/

git clone https://github.com/kalenjordan/magerun-addons

Bust Frontend Browser Caches

$&gt; n98-magerun.phar design:refresh

1 2	$> n98-magerun.phar design:refresh

This command modifies the skin and js base URLs with a timestamp-specific URL, so that browsers will pull down fresh CSS and JS.

It’s intended to be used in conjunction with a web server rewrite rule that will rewrite, for example:

/&lt;timestamp&gt;/skin/...

1 2	/<timestamp>/skin/...

/skin/...

/skin/...

Create dummy order

$&gt; n98-magerun.phar order:create:dummy

1 2	$> n98-magerun.phar order:create:dummy

This command can create some dummy orders. It’s marked as experimental but could help you to create dummy data in your shop i.e. for performance tests.

Assign order to new customer

$&gt; n98-magerun.phar order:assign

1 2	$> n98-magerun.phar order:assign

This command can assign an order to a new customer by ID.
This is very experimental – doesn’t modify all of the places that customer data exists on the order models, such as the shipping and billing address – just the customer name, email, ID on the order entity.

Example:

$&gt; n98-magerun.phar order:assign 10000000001 10

1 2	$> n98-magerun.phar order:assign 10000000001 10

Assigns the order #10000000001 to customer ID 10.

Anonymize customer data

Anonymize customer data across a bunch of tables: order, order address, newsletter, quotes, newsletter subscriber.

$&gt; n98-magerun.phar customer:anon

1 2	$> n98-magerun.phar customer:anon

Core file diff / Theme diff

This command can diff core files to see if they have been modified.
The command depends the command line tool diff which should be installed on all unix based systems.

n98-magerun.phar diff:files

1 2	n98-magerun.phar diff:files

Same functionality for theme files:

$&gt; n98-magerun.phar diff:theme customtheme/default default/default

1 2	$> n98-magerun.phar diff:theme customtheme/default default/default

See what customizations have been made in your custom theme against the base theme.

Grab mailchimp unsubscribes

Grab all of the mailchimp unsubscribes to your primary list

$&gt; n98-magerun.phar mailchimp:unsubscribe:list

1 2	$> n98-magerun.phar mailchimp:unsubscribe:list

If you’re using Ebizmarts_MageMonkey to manage your Mailchimp integration, this will allow you to grab a list of all of the unsubscribed emails to your primary list.

The main purpose for doing this is if you need to import these unsubscribes somewhere. The routine will dispatch an event mailchimp_list_unsubscribe_discovered which you can observe in order to handle them.

Uninstall a module

ninstall a module by deleting all the module’s files and removing database tables.

$&gt; n98-magerun.phar dev:module:remove Acme_Module

1 2	$> n98-magerun.phar dev:module:remove Acme_Module

NOTE: This is not fully baked yet, at the moment it just deletes the main module config file and the code directory. Pretty trivial, but I’m going to add in database tables, layout files, template files, etc.

Generate gift card codes

The missing tool to generate EE gift card codes!

$&gt; n98-magerun.phar giftcard:generate-codes --prefix=SWEET-DISCOUNTS-

1 2	$> n98-magerun.phar giftcard:generate-codes --prefix=SWEET-DISCOUNTS-

Tags 3rd_party

Magerun

Cache Backend Benchmarking with n98-magerun

Post author By Christian Münch
Post date July 31, 2014
2 Comments on Cache Backend Benchmarking with n98-magerun

This is the start of a series which presents 3rd party n98-magerun modules.

The first one is a module which helps you to benchmark your shop cache system.

It’s a port of a benchmark script by Colin Mollenhour
which was a fork of a symlink cache script by Vinai Kopp.

Installation

The installation is really strait forward:

 mkdir -p ~/.n98-magerun/modules
 cd ~/.n98-magerun/modules
 git clone https://github.com/cmuench/magerun-module-cache-benchmark.git

mkdir -p ~/.n98-magerun/modules

cd ~/.n98-magerun/modules

git clone https://github.com/cmuench/magerun-module-cache-benchmark.git

Usage

After the installation you should see some new cache commands in your n98-magerun command list.

 cache:benchmark:analyse     Analyze the current cache contents.
 cache:benchmark:clean       Flushes cache backend.
 cache:benchmark:comp_test   Test compression library performance
 cache:benchmark:init        Inits cache dataset
 cache:benchmark:load        Load an existing dataset.
 cache:benchmark:ops         Execute a pre-generated set of operations on the existing cache.
 cache:benchmark:tags        Benchmark getIdsMatchingTags method.

cache:benchmark:analyse Analyze the current cache contents.

cache:benchmark:clean Flushes cache backend.

cache:benchmark:comp_test Test compression library performance

cache:benchmark:init Inits cache dataset

cache:benchmark:load Load an existing dataset.

cache:benchmark:ops Execute a pre-generated set of operations on the existing cache.

cache:benchmark:tags Benchmark getIdsMatchingTags method.

First run “cache:benchmark:init” which generates cache entries.
The init command can has a lot of paramters.

--name                (default to default) (default: "default")
--keys                Number of cache keys (default to 10000) (default: 10000)
--tags                Number of cache tags (default to 2000) (default: 2000)
--min-tags            The min number of tags to use for each record (default 0) (default: 0)
--max-tags            The max number of tags to use for each record (default 0) (default: 15)
--min-rec-size        The smallest size for a record (default 1) (default: 1)
--max-rec-size        The largest size for a record (default 1) (default: 1024)
--clients             The number of clients for multi-threaded testing (defaults to 4) (default: 4)
--ops                 The number of operations per client (defaults to 10000) (default: 10000)
--write-chance        The chance-factor that a key will be overwritten (defaults to 1000) (default: 1000)
--clean-chance        The chance-factor that a tag will be cleaned (defaults to 5000) (default: 5000)
--seed                The random number generator seed (default random)
--help (-h)           Display this help message.
--quiet (-q)          Do not output any message.
--verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
--version (-V)        Display this application version.
--ansi                Force ANSI output.
--no-ansi             Disable ANSI output.
--no-interaction (-n) Do not ask any interactive question.
--root-dir            Force magento root dir. No auto detection
--skip-config         Do not load any custom config.

--name (default to default) (default: "default")

--keys Number of cache keys (default to 10000) (default: 10000)

--tags Number of cache tags (default to 2000) (default: 2000)

--min-tags The min number of tags to use for each record (default 0) (default: 0)

--max-tags The max number of tags to use for each record (default 0) (default: 15)

--min-rec-size The smallest size for a record (default 1) (default: 1)

--max-rec-size The largest size for a record (default 1) (default: 1024)

--clients The number of clients for multi-threaded testing (defaults to 4) (default: 4)

--ops The number of operations per client (defaults to 10000) (default: 10000)

--write-chance The chance-factor that a key will be overwritten (defaults to 1000) (default: 1000)

--clean-chance The chance-factor that a tag will be cleaned (defaults to 5000) (default: 5000)

--seed The random number generator seed (default random)

--help (-h) Display this help message.

--quiet (-q) Do not output any message.

--verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

--version (-V) Display this application version.

--ansi Force ANSI output.

--no-ansi Disable ANSI output.

--no-interaction (-n) Do not ask any interactive question.

--root-dir Force magento root dir. No auto detection

--skip-config Do not load any custom config.

No panic. The command defines default values for every setting.

After the generation you should see a bash script like “bash var/cachebench/default/run.sh” which was
generated by the init command.

Run the shell script an see the your benchmark statistics.
Now you are able to compare different cache backends (change it in your app/etc/local.xml config).

See it in Action

Tags 3rd_party, Benchmark, cache