fullstackenviormentss / chef-magerun

A chef cookbook to install n98-magerun Magento command line tool.

chef-magerun

chef-magerun installs n98-magerun and provides access to a corresponding LWRP.

Usage

Simply include the recipe in your application recipe, where you setup/deploy magento.

include_recipe "magerun"

ATTENTION: name this cookbook "magerun" if you want to use the LWRP like this:

magerun "PATH TO YOUR MAGENTO ROOT" do
	action :cache_flush
end

See Command-Reference for available commands. Keep an eye on the associated actions in the LWRP (providers/default.rb) since some commands had to be rewritten using no "-".

As a sidenote for vagrant users: - You may set up a bash function to use a pseudo-tty with magerun in the vagrant box.

e.g. in your local ~/.bash_profile place:

magerun () {
  vagrant ssh -- -t n98-magerun.phar --root-dir=/vagrant $@
}

Open a new bash prompt at your Vagrant project and interact with n98-magerun as if it were local.

$ magerun help
$ magerun cache:clean

Your commands will be run inside the Vagrant box using the n98-magerun config and Magento root defined. For performance reasons you might like to use the $ magerun shell feature rather than opening a new ssh connection for each command.

Dependencies

This cookbook depends on the following community cookbooks.

• php

Recommendations

• dop_php

Platform

The following platforms are supported and tested:

• Debian 6.x
• Debian 7.x
• Ubuntu 14.04.x

Other Debian family distributions are assumed to work.

Development

1. Fork the repository from GitHub.

2. Clone your fork to your local machine:

    $ git clone [email protected]:USER/chef-magerun.git
   

3. Create a git branch

    $ git checkout -b my_bug_fix
   

4. Write tests

5. Make your changes/patches/fixes, committing appropriately

6. Run the tests: rake style, rake spec, rake integration:vagrant

7. Push your changes to GitHub

8. Open a Pull Request

Testing

The following Rake tasks are provided for automated testing of the cookbook:

$ rake -T
rake spec                 # Run ChefSpec examples
rake style                # Run all style checks
rake style:chef           # Lint Chef cookbooks
rake style:ruby           # Run Ruby style checks
rake travis               # Run all tests on Travis

See TESTING.md for detailed information.

License and Author

• Author:: Achim Rosenhagen ([email protected])

• Copyright:: 2015, ffuenf

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.