Skip to content

DEVELOP.rst

Latest commit

 

History

History
181 lines (119 loc) · 5.55 KB

DEVELOP.rst

File metadata and controls

181 lines (119 loc) · 5.55 KB

Installation

# Pull Code
git clone https://github.com/grap/odoo-module-migrator
cd odoo-module-migrator

# Create virtual env and activate it
virtualenv env --python=python3
. ./env/bin/activate

# Install dependencies
pip3 install -r requirements.txt

# Run the script
python -m odoo_module_migrate COMMAND OPTIONS

You can also install from test source via pip:

pip3 install odoo-module-migrator\
    --upgrade\
    --index-url https://test.pypi.org/simple\
    --extra-index-url https://pypi.org/simple

Run tests

# Activate virtual env
. ./env/bin/activate

# Install extra dependencies required for tests
pip3 install -r test_requirements.txt

# Run Tests
coverage run --source odoo_module_migrate setup.py test

Structure of the Project

Framework

In the odoo_module_migrate folder

  • __main__.py: the entry point of this module. It mainly handles arguments, and launch the script.
  • config.py: configuration file, to updated if new features are available in this library. (For exemple, a new migration available from X to X+1)
  • log.py: Handle logs of this library.
  • tools.py: bundle of generic functions used by the framework.
  • migration.py: Define the class Migration that handle a migration from a version X.0 to a version Y.0 for any module.
  • module_migration.py: Define the class ModuleMigration that handle a migration for a given module.

Migration Scripts

The list of the operations are written in the subfolder odoo_module_migrate/migration_scripts/:

  • each operaion has specification when it has to be applied: FROM_TO part of the path.

    • Possible values are 090, 010, 011, etc.
    • The TO part may have value always, which means is should be applied in every version since FROM version.
    • Special value for FROM_TO is just a single allways (yes, it's mispealing) which means it will be applied whatever the init and target odoo version.

  • migrate_FROM_TO.py — old way to specify operations. Normally, these files should not be changed.

  • file_renames/migrate_FROM_TO/NAME.yaml — file renaming rules. For example, for migration from version 8.0 to more recent version:

    __openerp__.py: __manifest__.py

  • text_replaces/migrate_FROM_TO/NAME.yaml — replace pattern text by another. for example, for migration from version 8.0 to version 9.0:

    .py:
    select=True: index=True

  • text_errors/migrate_FROM_TO/NAME.yaml — display errors if files contains a given partern. For example, for migration from version 10.0 to version 11.0:

    "*":
    ir.values: "ir.values table does not exist anymore"

  • text_warnings/migrate_FROM_TO/NAME.yaml — display errors if files contains a given partern. For example, for migration from version 12.0 to version 13.0:

    "*":
    "@api.returns": "decorator @api.returns is deprecated"

  • deprecated_modules/migrate_FROM_TO/NAME.yaml — dependencies to obsoletes modules. There are following possibilities:

    • the module has been fully removed.
    • the module has been renamed.
    • the module features has been merged into another module.
    • the module has been moved under OCA umbrella. (w/o another name)
    - ["account_anglo_saxon", "removed"]
- ["account_check_writing", "renamed", "account_check_printing"]
- ["account_chart", "merged", "account"]
- ["account_analytic_analysis", "oca_moved", "contract", "Moved to OCA/contract"]

  • python_scripts/migrate_FROM_TO/NAME.py — for complex updates/checks. Must contain one or few functions that don't start with underscore symbol. The functions take following keyword arguments:

    def set_module_installable(**kwargs):
    tools = kwargs['tools']
    manifest_path = kwargs['manifest_path']
    old_term = r"('|\")installable('|\").*(False)"
    new_term = r"\1installable\2: True"
    tools._replace_in_file(
        manifest_path, {old_term: new_term}, "Set module installable")

How to improve the library

Package deployment

pip3 install --upgrade setuptools wheel
pip3 install  --upgrade twine

# Generate wheel and package
python3 setup.py sdist bdist_wheel

# Push on pyPi Test
twine upload --repository-url https://test.pypi.org/legacy/ dist/*

# Push on pyPi Production
twine upload dist/*