For contributors¶

Source and tracking¶

The recipes are currently both hosted in a single Git repository, the master branch being anybox.recipe.odoo, whereas anybox.recipe.openerp is to be found in the a.r.openerp-x.y branches (currently only 1.9 and the legacy 1.8). This unusual structure because they still have most in common, a.r.odoo being a.r.openerp without the bits for backward compatibility before Odoo v8.

We follow the standard GitHub workflow (issues, pull requests…). Code contributors are systematically added to the list of contributors at the end of the README, unless they explicitely wish not to (what GitHub does is obviously out of our scope).

Members of the “Anybox” organization have push privileges on this repository.

Using a development version¶

To use a local version of the recipe, you may use the develop general buildout option:

[buildout]
develop = /path/to/anybox.recipe.o

To track a Git branch, we find the gp.vcsdevelop extension simple and useful. Here’s an example for anybox.recipe.openerp (notice the @ notation for the branch):

[buildout]
extensions = gp.vcsdevelop
vcs-extend-develop = git+https://github.com/anybox/anybox.recipe.odoo@a.r.openerp-1.9#egg=a.r.openerp
vcs-update = True

Development setup¶

We recommend “developing” the source code in a virtualenv, for instance:

virtualenv recipe-env
cd recipe-env
git clone https://github.com/anybox/anybox.recipe.odoo
cd anybox.recipe.odoo
../bin/pip install -e.[test]

Building documentation¶

We are using sphinx_bootstrap_theme to easly get responsive design documentation.

You will find sphinx_static/united.anybox.bootswatch.bootstrap.min.css file which use bootswatch united theme using sphinx_static/united.anybox.bootswatch.variables.less variables file. To generate .css file, please follow bootswatch instructions.

HowTo build documentation:

virtualenv doc-recipe-env
git clone https://github.com/anybox/anybox.recipe.odoo
doc-recipe-env/bin/pip install sphinx sphinx_bootstrap_theme
cd anybox.recipe.odoo/doc
doc-recipe-env/bin/sphinx-build . sphinx_build/

Coding style¶

The recipe follows the same strong code development coding principles as many other projects:

• Style enforcement : we follow the PEP8 guidelines
• Static analysis with flake8 (combines conveniently pep8 and pyflakes).
• Unit tests: we try and test as much as possible. It is hard to achieve a real 100% with a tool that calls so many external processes, but this is mitigated by our continuous integration practice of doing real Odoo installations with the latest revision of the recipe.

Launching static analysis and unit tests¶

Install flake8 and, optionally, coverage:

../bin/pip install coverage flake8

Run flake8 and the tests (in this example, after virtualenv activation):

../bin/python setup.py flake8 && ../bin/python setup.py nosetests

There is also this convenience to run the tests and output a coverage report:

source ./test-cover

Integration tests¶

There is a special category of tests: those that need a real Odoo instance, built with the recipe, to run.

They are located within the tests_with_openerp subdirectory and need to be launched with a launcher script constructed by the recipe.

For example, create a testing buildout like this:

[buildout]
parts = odoo
[odoo]
# version as you wish
version = nightly 8.0 latest
eggs = nose
openerp_scripts = nosetests command-line-options=-d

Then run bin/buildout, create a database and initialize it. From the buildout directory:

createdb test-recipe
bin/start_odoo -d test-recipe -i base --stop-after-init

You can then run the tests:

bin/nosetests_odoo -d test-recipe -- /path/to/recipe/branch/tests_with_openerp

Currently, these tests are all about the Session objects, used in scripts.

Continuous integration¶