Anthem is a tool to help scripting Odoo instances for automated setup, upgrades, testing and more.

It should be an alternative to the other tools like oerpscenario.

Writing your songs is as easy as creating a Python Package. The songs functions called by anthem must have a positional ctx argument.

## songs/install.py

def setup_company(ctx):
    """ Setup company """
    company = ctx.env.ref('base.main_company')
    company.name = 'My Company'


def main(ctx):
    setup_company(ctx)

A song can display some logs when executed with @anthem.log, Context.log and Context.log_line.

import anthem

@anthem.log
def setup_company(ctx):
   """ Setting up company """
   company = ctx.env.ref('base.main_company')
   with ctx.log('Changing name'):
       company.name = 'My Company'
       ctx.log_line('Name changed')
   with ctx.log('Loading a logo'):
       company.logo = b64encode(LOGO_CONTENT)
       ctx.log_line('Logo changed')

The decorator on the function will display the first line of the docstring. Both the decorator and the context manager will show the timing of the execution. The upper example gives:

Setting up company...
    Changing name...
        Name changed
    Changing name: 0.0150s
    Loading a logo...
        Logo changed
    Loading a logo: 0.100s
Setting up company: 0.300s

Use the command line anthem. Provided your songs and openerp are in the PYTHONPATH:

anthem songs.install::main -c path/to/openerp.cfg

Anthem will execute the function main of the module songs.install with a ctx initialized with an Odoo env.

Instead of using -c for the command line, you can export the environment variable OPENERP_SERVER with the path of the configuration file.

export OPENERP_SERVER=path/to/openerp.cfg
anthem songs.install::main

In order to have openerp in the PYTHONPATH, you might install it as a package with pip install -e or directly modify the PYTHONPATH.

In order to have your songs in the PYTHONPATH, the better is to make a Python package out of them.

To run the tests, you must have Postgresql running, with accesses for your user (or you will have to modify tests/config/odoo.cfg with your database username and password).

To run anthem's tests, it is a good idea to do an editable install of it in a virtualenv, and then intall and run tox as follows:

$ git clone https://github.com/camptocamp/anthem.git
Cloning into 'anthem'...
$ cd anthem
$ python2 -m virtualenv env
$ source env/bin/activate
$ pip install -e .
$ pip install pytest invoke tox
$ tox

Additional arguments will be passed to pytest:

$ tox -e py27 -- -x tests/test_cli.py

If you prefer to execute the tests directly with pytest, you can run:

$ OPENERP_SERVER=tests/config/odoo.cfg py.test

But before, you have to ensure to have the proper environment for the tests with:

$ invoke tests.prepare
$ invoke tests.createdb

Those steps, automatically called when using tox, will download the nightly release of Odoo and install it as a package, so tests can be run against it (and that's also why it is important to use a virtualenv!)

When calling pytest, you have to define the OPENERP_SERVER environment variable with the configuration file for the Odoo database that will be used for the tests.