Testing/development buildouts for Plone

Conteúdo

• Testing/development buildouts for Plone
  • i18ndude helper script to update po files
  • Functional tests with Robot Framework and SeleniumLibrary in Travis CI
  • Testing in Travis CI with multiple versions of Plone
• Experimental configurations
  • Quality Assurance

This repository contains a number of configuration files for using zc.buildout to quickly set up a testing/development environment for your package. The intended usage is to create a buildout.cfg like:

[buildout]
extends = https://raw.github.com/collective/buildout.plonetest/master/test-4.x.cfg
package-name = plone.app.foo

Running buildout should give you a bin/test script, which can be used to run your package's tests. If your tests have additional dependencies, you should declare them via the extras_require parameter of setuptools.setup and refer to the key used using the package-extras variable:

[buildout]
extends = https://raw.github.com/collective/buildout.plonetest/master/test-4.x.cfg
package-name = plone.app.foo
package-extras = [test]

If you want to do continuous integration with Travis CI you should create a travis.cfg like:

[buildout]
extends = https://raw.github.com/collective/buildout.plonetest/master/travis-4.x.cfg
package-name = plone.app.foo
package-extras = [test]

And a .travis.yml like:

language: python
python: 2.7
install:
  - mkdir -p buildout-cache/downloads
  - python bootstrap.py -c travis.cfg
  - bin/buildout -N -t 3 -c travis.cfg
script: bin/test

i18ndude helper script to update po files

Include the following in your buildout configuration to create an i18ndude helper script to update the po files of your product:

[buildout]
parts =
    ...
    rebuild_i18n-sh

[rebuild_i18n-sh]
recipe = collective.recipe.template
url = https://raw.github.com/collective/buildout.plonetest/master/templates/rebuild_i18n.sh.in
output = ${buildout:directory}/bin/rebuild_i18n.sh
mode = 755

After running 'bin/buildout' you will find a 'bin/rebuild_i18n.sh'; run the script and the po files will be updated.

Domain name is taken from the ${buildout:package-name} variable; Plone domain is also included.

Functional tests with Robot Framework and SeleniumLibrary in Travis CI

Update your .travis.yml file with the following:

before_script:
  - export DISPLAY=:99.0
  - sh -e /etc/init.d/xvfb start

Testing in Travis CI with multiple versions of Plone

The travis.cfg file in your package should look like this:

[buildout]
extends =
    https://raw.github.com/collective/buildout.plonetest/master/travis-4.x.cfg

package-name = collective.foo
package-extras = [test]

allow-hosts +=
    code.google.com
    robotframework.googlecode.com

And the .travis.yml file should look like this:

language: python
python: 2.7
env:
  - PLONE_VERSION=4.2
  - PLONE_VERSION=4.3
install:
  - sed -ie "s#travis-4.x.cfg#travis-$PLONE_VERSION.x.cfg#" travis.cfg
  - mkdir -p buildout-cache/downloads
  - python bootstrap.py -c travis.cfg
  - bin/buildout -c travis.cfg -N -q -t 3
script: bin/test

The trick here is to replace the extended configuration with the right one using the sed command.

Experimental configurations

Caution!

The following configurations are experimental and may change at any time.

Quality Assurance

Note

This configuration is deprecated in favor of plone.recipe.codeanalysis. Please use it and help us improving it.

If you want to add Quality Assurance to your continuous integration you can update your travis.cfg file like:

[buildout]
extends =
    https://raw.github.com/collective/buildout.plonetest/master/travis-4.x.cfg
    https://raw.github.com/collective/buildout.plonetest/master/qa.cfg
package-name = plone.app.foo
package-extras = [test]
package-src = src/plone/app/foo
package-pep8-ignores = E501,W402,W801
package-min-coverage = 80
parts+=
    createcoverage
    coverage-sh
    flake8
    python-validation-sh

and update your .travis.yml like:

language: python
python: 2.7
env:
  - TARGET=test
  - TARGET=coverage.sh
  - TARGET=python-validation.sh

install:
  - mkdir -p buildout-cache/downloads
  - python bootstrap.py -c travis.cfg
  - bin/buildout -c travis.cfg -N -q -t 3

script: bin/$TARGET