README.md

OpenERP-inator

Dominate the entire ERP tri-state area by easilly installing and creating an army of OpenERP server instances in your server. The self-destruct button is intended only for test databases.

OpenERP-inator is an utility script to manage a server with multiple OpenERP server instances and variants. The motivation behind oetor was to make it easy to branch, develop and test OpenERP branches, and avoid the chaos that quickly piles up when working on multiple projects.

Features:

• One line install: the quickstart command provides a one line full installation.
• Get source code: the get command makes it simple to get OpenERP sources from nightly builds, Launchpad official branches or OCB community branches.
• Update source code: the get --update option updates sources to the latest version, either from VCS or nightly builds.
• View versions: the version command shows source code versions, either from shared sources or from created instances.
• Create server instances: the create command can add multiple server instances, in an organized way and running in isolated environments.
• Automatic addons paths: the start server script calculates the addons path: add a new directory and it will be included on next start.
• Test all modules: the start -I option installs and runs tests for all modules in a specified directory.
• Instance branches: "branches" can be created using the cp system command: modified versions for development and tests.
• List servers and ports: the ps system command will list running servers and their listening port.
• Multiple homes: the default home directory is /opt/openerp, but other locations are possible and supported.

Installation

To install in an Ubuntu system:

wget https://raw.github.com/dreispt/oetor/master/oetor  # download oetor script
bash oetor install                                      # run install command
rm oetor                                                # cleanup

Quickstart full installation

The quickstart command provides a one line full installation of the latest stable version of OpenERP:

    /opt/openerp/oetor quickstart  # OpenERP dependencies and server isntallation 
    /opt/openerp/v7/main/start     # Start the 'v7' server instance

All needed dependencies are installed, including the PostgreSQL server. The installed instance, v7, is built using the latest nightly build.

Usage

A step-by-step guide on OpenERP-inator's main features. These steps can be followed either you used the quickstart or not.

Getting prepared

For convenience, let's position in the home directory and confirm that all system dependencies are installed.

    cd /opt/openerp           # position at oetor home
    ./oetor get-dependencies  # install missing system dependencies

Create server instances

Create two server instances, one using nightly build and running on port 8070, and another using Launchpad sources and listening on 8071:

    ./oetor get nightly-7.0                # download latest 7.0 nighlty build
    ./oetor create prod7 nightly-7.0 8070  # create prod7 instance on port 8070
    ./prod7/main/start &                   # start prod7 instance in the background
    
    ./oetor get openerp-7.0                # download Launchpad 7.0 source code
    ./oetor create test7 openerp-7.0 8071  # create test7 instance on port 8071
    ./test7/main/start &                   # start test7 instance in the background

    ps aux | grep openerp                  # list running instances and listening ports

Check versions and update sources

    ./oetor version ./src/nightly-7.0      # version of a shared source
    ./oetor version ./test7/main/server    # version of an instance source code

    ./oetor get openerp-7.0 --update       # update source code from Launchpad
    ./oetor get nightly-7.0 --update       # update source code from nightly builds

Work on a project and test branches

Create an instance for the Department Management project, including it's modules in the addons path:

    ./oetor create dev7 nightly-7.0                                      # create "dev7" server instance 
    bzr branch lp:department-mgmt/7.0 ./dev7/main/deptm                  # add specific code
    ./dev7/main/start --stop-sfter-init                                  # new code branch automatically added to addons
    
    cp ./dev7/main ./dev7/featX                                          # create "featX" work copy from branch "main"
    ./dev7/featX/start -i crm_department --test-enable --stop-after-init # test one module
    ./dev7/featX/start -I dptm --test-enable --stop-after-init           # test all modules
    
    rm ./dev7/featX -R && dropdb dev7-featX                              # Remove an obsolete instance branch

What's in the box?

Here is how source code directories and server instances are organized:

    /opt/openerp               # HOME directory
      +- oetor                   # oetor script
      +- /env                    # shared virtualenv (optional)
      |
      +- /src                  # shared source repository
      |    |
      |    +- /nightly-7.0       # a nightly build source directory
      |    |    +- /server
      |    |
      |    +- /openerp-7.0       # a Launchpad official source directory
      |    |    +- /server
      |    |    +- /addons
      |    |    +- /web
      |    |
      |    +- /openerp-trunk     # a Launchpad trunk official source directory
      |    |    +- ...           # ... module directories
      |    ...                 # ... more shared sources
      |
      |
      +- /server1              # an OpenERP server instance
      |    |
      |    +- /main              # the main branch
      |    |    +- start.sh        # server start script
      |    |    +- /env            # python virtualenv to use (symlinked, optional)
      |    |    +- /server         # server source code (symlinked to dir in <home>/src)
      |    |    +- /addons         # other module directories ...
      |    |    +- /web
      |    |    +- /projx          # an additional modules directory
      |    |
      |    +- /branchA           # an instance server branch
      |    |    +- start.sh
      |    |    +- /env      
      |    |    +- /server       
      |    |    +- /addons 
      |    |    +- /web
      |    |    +- /projx-z        # working with version z of the projx modules
      |    |    ...                # ... more module directories
      |    ...                   # ... more server branches
      ...                      # ... more server instances

Development guidelines and roadmap

Planned features:

• Support for producion environments:
  • Register in init.d for autostart on boot
  • Database backup and restore
• Support for other VCS
  • git
  • hg

Other ideas that could go into the roadmap:

• Support for other Unix OS, such as CentOS

Project directives to keep in mind:

• Usable: the UI should be simple and intuitive. Write docs first, code later.
• Simple: commands should wrap annoying tasks, and no more than that.
• Safe: repeating or misusing commands must de safe - no data is destroyed.
• Readable: reding the script code should allow to quickly understand what a command will do.