isotoma.recipe.plonetools 0.0.16

Buildout recipes for setting up a plone site.

Introduction

This recipe is based on collective.recipe.plonesite. It provides recipes for creating and updating Plone sites, running scripts against Plone sites and for setting their properties. If you use zeoserver, all the recipes will start and stop zeo appropriately (not stopping it if it wasnt the process that started it, for example). When combined with isotoma.recipe.zope2instance it can properly deal with errors, ending the buildout run rather than continuing and succeeding.

Managing plone sites

This recipe enables you to create and update a Plone site as part of a buildout run. This recipe only aims to run profiles and Quickinstall products. It is assumed that the install methods, setuphandlers, upgrade steps, and other recipes will handle the rest of the work.

To use it, add something like this to your recipe:

[plonesite]
recipe = isotoma.recipe.plonetools:site
products =
    LinguaPlone
    iw.fss
    you.YourProduct

Parameters

[1] (1,2)

Profiles have the following format: <package_name>:<profile> (e.g. my.package:default). The profile can also be prepended with the profile- if you so choose (e.g. profile-my.package:default).

[2] (1,2)

The product name is typically not the package name such as Products.MyProduct, but just the product name MyProduct. Quickest way to find out the name that is expected is to ‘inspect’ the Quickinstaller page and see what value it is passing in.

site-id

The id of the Plone site that the script will create. This will also be used to update the site once created. Default: Plone

admin-user

The id of an admin user that will be used as the ‘Manager’. Default: admin

products-initial

A list of products to quickinstall just after initial site creation. See above for information about the product name format [2].

profiles-inital

A list of GenericSetup profiles to run just after initial site creation. See above for informaion on the expected profile id format [1].

products

A list of products to quickinstall each time buildout is run. See above for information about the product name format [2].

profiles

A list of GenericSetup profiles to run each time buildout is run. See above for informaion on the expected profile id format [1].

instance

The name of the instance that will run the script. Default: instance

zeoserver

The name of the zeoserver part that should be used. This is only required if you are using a zope/zeo setup. Default: not set

before-install

A system command to execute before installing Plone. Optional. You could use this to start a Supervisor daemon to launch ZEO, instead of launching ZEO directly. You can use this option in place of the zeoserver option.

after-install

A system command to execute after installing Plone. Optional.

site-replace

Replace any existing plone site named site-id. Default: false

enabled

Option to start up the instance/zeoserver. Default: true. This can be a useful option from the command line if you do not want to start up Zope, but still want to run the complete buildout.

$ bin/buildout -Nv plonesite:enabled=false

pre-extras

An absolute path to a file with python code that will be evaluated before running Quickinstaller and GenericSetup profiles. Multiple files can be given. Two variables will be available to you. The app variable is the zope root. The portal variable is the plone site as defined by the site-id option. NOTE: file path cannot contain spaces. Default: not set

post-extras

An absolute path to a file with python code that will be evaluated after running Quickinstaller and GenericSetup profiles. Multiple files can be given. Two variables will be available to you. The app variable is the zope root. The portal variable is the plone site as defined by the site-id option. NOTE: file path cannot contain spaces. Default: not set

properties

The name of a part that provides propert name value mappings.

Setting properties

You can set properties on your plone site object from buildout:

[portal-properties]
somestring = some string
somebool = True
somelist =
    1
    2
    3

[plonesite]
recipe = isotoma.recipe.plonetools:site
<SNIP>
properties = portal-properties

Properties set in this way are set at the same time as the Plone Site object is updated, during the same zope instance invocation so is more efficient than using a seperate recipe.

Calling Setters On Plone Objects

As a last resort you can call setters directly from buildout. This is meant for things like CacheSetup where your cached domains might vary between environments.

Just add:

[mutators]
some.object.setFoo = True
some.object.setList =
    1
    2
    3
some.other.object.setBar = some string

[plonesite]
recipe = isotoma.recipe.plonetools:site
<SNIP>
mutators = mutators

Again, these are set at the same time as the portal properties are applied and as GenericSetup is run - no extra zope invocations are required.

The migration script

If you have a plonesite:site stanza in your buildout you will get a plonesite script in your bin directory.

Running this script with no arguments will apply run the same processes that run during buildout.

Running the script with the -r argument will cause it to rebuild the site, deleting your Plone site object and recreating it. Great for sandboxes that reset nightly.

Creating wrapper scripts

This recipe lets you create a script in your buildouts bin-directory to run a script for you under the correct zope instance.

If you have a script in mypackage.myscript:

def run():
    print "This is my test script

then add something like this to your recipe:

[instance]
recipe = isotoma.recipe.zope2instance
otherprops = here

[wrappers]
recipe = isotoma.recipe.plonetools:wrapper
instance = instance
entry-points =
   myscript=mypackage.myscript:run

Mandatory parameters

entry-points

These are like the entry-points used in setuptools, in the form of wrappername=your.product.module:function

Optional parameters

instance

The name of a zope2instance part that is used to run the script. Default: instance.

arguments

Some arguments to be passed to the entry points, as python. Default: app

Changelog

0.0.16 (2012-10-09)

• The most sensible process is:

  • Create empty site

  • Run initial profiles

  • Run main profiles

  • Migrate mount points

  I think.

0.0.15 (2012-10-05)

• Fix regression in migrate script.

0.0.14 (2012-10-03)

• Automatic migration to split Data.fs when mount points are declared in zope.conf

0.0.13 (2011-09-29)

• Add a new ‘rootify’ option. It’s only available to virtualenv peeps atm.

0.0.12 (2011-09-23)

• Fix Plone 3 support (creating new site was impacted by the 4.1/2.5 changes)

0.0.11 (2011-09-22)

• The properties and script helper are no longer supported

• Write a script that can run migrations without running the rest of buildout

• This script supports a ‘-r’ flag for rebuild the /portal object from scratch.

• Don’t hang if CMFSquidTool has a purge queue that is unending

• Drop JSON dependency

• Better 2.5 and 4.1 support

0.0.10 (2011-09-21)

• Use savepoint() instead of subtransaction

• More useful output when quick installing and applying profiles

0.0.9 (2011-09-03)

• Add support for calling any setters from buildout.

• If a transient error occurs, retry up to ${:attempts} times.

0.0.8 (2011-08-30)

• Support subtransactions (stops CacheSetup hanging)

• Allow the Site recipe to set properties without a seperate properties part

0.1 (2010-04-24)

• Created friendly fork of collective.recipe.plonesite

• Catch non-zero exit codes

• Added a test to see if zeo is running before starting it

• Only shutdown zeo if we started it