For contributors¶
Source and tracking¶
The recipe is being hosted in a Git repository.
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 “OCA” project 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/oca.recipe.odoo
To track a Git branch, we find the
gp.vcsdevelop
extension simple and useful. Here’s an example for
oca.recipe.odoo (notice the @ notation for the branch):
[buildout]
extensions = gp.vcsdevelop
vcs-extend-develop = git+https://github.com/OCA/oca.recipe.odoo@main#egg=oca.recipe.odoo
vcs-update = True
Note
gp.vcsdevelop leverages internally pip, and the
git+https syntax actually comes from pip.
Note
Actually some parts of the recipe are aware of the possible use
of gp.vcsdevelop for python dependencies, and special care of it is
taken in the freeze and extract features. This is known to work even
for zc.buildout itself.
Development setup¶
We recommend “developing” the source code in a virtualenv, for instance:
virtualenv recipe-env
cd recipe-env
git clone https://github.com/OCA/oca.recipe.odoo
cd oca.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.oca.bootswatch.bootstrap.min.css file
which use bootswatch united theme using
sphinx_static/united.oca.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/OCA/oca.recipe.odoo
doc-recipe-env/bin/pip install sphinx sphinx_bootstrap_theme
cd oca.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.
Note
you may use a different version of the recipe to build that testing buildout. This is anyway what happens if you build with your development version, and hack some changes afterwards.
Using a very different version of the recipe could give funky results, but you’re supposed to know what you’re doing at this point.
Continuous integration¶
Basic builds¶
Upon each push on the main branches, Anybox’ public buildbot awakes to check the coding style, run the tests and build this documentation. You may check the status there:
Actual runs¶
Furthermore, this buildbot instance runs anybox.buildbot.openerp, a buildbot configurator for Odoo installations based on the recipe.
This is used in turn to run high-level integration tests, having the latest bzr version of the recipe actually install several combinations of OpenObject server and addons, and run their unit tests.
The configuration is stored in the buildbot subdirectory of the
master branch. It is made of a high level configuration file
(MANIFEST.cfg) and buildout configuration files. This buildbot
instance actually aggregates several such configurations.
The corresponding builders are those whose name starts with
recipe- in the builders list.
Note
the integration tests mentioned above are executed in
particular during this process, currently in the
recipe-7.0-postgresql-9.2 builder.
Some builds may appear to be broken because of tests failures been pushed by upstream in Odoo itself or in the tested addons, but it’s easy to check whether this is due to a recipe failure or not.
Note
Anybox hardware resources are limited; contributing buildslaves would be greatly appreciated.