# oca/odoo-module-migrator architecture

> Architecture diagram of the GitHub repository oca/odoo-module-migrator, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/oca/odoo-module-migrator
- Repository: https://github.com/oca/odoo-module-migrator

## Overview

##### Project type and purpose
- This is a Python-based CLI tool and library—“odoo-module-migrator”—that automates source‐code migrations of Odoo modules from one version to another (e.g. 8.0→12.0).
- It reads an input module directory, applies a series of well-organized migration scripts (renaming files, replacing imports, stripping obsolete patterns), optionally uses Git format-patch to ingest upstream changes, commits results, and logs INFO/WARNING/ERROR messages.

##### File structure
- Top-level:
- configuration & CI (.github, .travis.yml, pre-commit config)
- `setup.py`, `requirements.txt`, license, README
- `odoo_module_migrate/` package containing core engine and subpackages
- `tests/` verifying migrations against sample modules
- Inside `odoo_module_migrate/`:
- `__main__.py` → CLI entrypoint
- `config.py` → command-line argument parsing
- `migration.py` + `base_migration_script.py` → core orchestration and base class
- `migration_scripts/` → version‐grouped YAML‐ and Python-based rules (deprecated, removed_fields, renamed_fields, text_replaces, etc.)
- `log.py`, `exception.py` → logging & error handling
- `tools.py`, `module_migration.py` → low-level file/string replacements and git interactions
- Tests mirror migration scripts and sample Odoo module code before/after.

##### Insights from README
- The tool chain: CLI→parse args→(optionally) git format-patch→iterate modules→load ordered migration scripts→apply replacements & renames→git add/commit→emit logs.
- Migration scripts are grouped by version ranges, written in YAML or Python, and loaded dynamically.

##### Elements
- From “User” → “CLI Parser”
- “CLI Parser” → “Core Engine”
- “Core Engine” → “Migration Scripts Loader” → “Migration Script #1” → … → “Migration Script #N” → back to “Core Engine”
- “Core Engine” → “Git Interface” → “File System”
- “Core Engine” → “Logger” → “Console/File”
- Blue rectangles for internal components
- Yellow parallelogram for user input/output (Console)

##### Detail
- Version-range grouping inside the migration_scripts component

## Diagram (Mermaid)

```mermaid
graph TB
    %% Actors
    User["User / Developer"]:::user

    %% CLI Interface
    subgraph "CLI Interface"
        Main["__main__.py"]:::internal
        ConfigNode["config.py"]:::internal
    end

    %% Core Engine
    subgraph "Core Engine"
        Engine["migration.py"]:::internal
        BaseScript["base_migration_script.py"]:::internal
        ModuleMig["module_migration.py"]:::internal
        Tools["tools.py"]:::internal
    end

    %% Migration Scripts
    subgraph "Migration Scripts Loader"
        Loader["Scripts Loader"]:::internal
        subgraph "version-grouped scripts"
            MIGScriptsDir["migration_scripts/"]:::script
            MIG1["migrate_080_090.py"]:::script
            MIG2["migrate_allways.py"]:::script
            PyScripts["python_scripts/"]:::script
        end
    end

    %% Git Integration
    subgraph "Git Interface"
        Git["Git Interface"]:::external
    end

    %% File System
    subgraph "File System"
        FS["Modules Directory"]:::database
    end

    %% Logging & Error Handling
    subgraph "Logger"
        Logger["log.py"]:::internal
        Excp["exception.py"]:::internal
    end

    %% Tests Suite
    subgraph "Tests Suite"
        Tests["test_migration.py"]:::test
        DataIn["data_template/"]:::database
        DataOut["data_result/"]:::database
    end

    %% Setup & Config Files
    subgraph "Setup & Config"
        SetupPy["setup.py"]:::config
        Req["requirements.txt"]:::config
        Pre[".pre-commit-config.yaml"]:::config
        TravisN[".travis.yml"]:::config
        CIconf[".github/workflows/"]:::config
    end

    %% Flow
    User -->|"invokes CLI"| Main
    Main -->|"parse args"| ConfigNode
    ConfigNode -->|"initialize"| Engine
    Engine -->|"load scripts"| Loader
    Loader -->|"discover rules"| MIGScriptsDir
    MIGScriptsDir -->|"load YAML/Python"| MIG1
    MIGScriptsDir -->|"load YAML/Python"| MIG2
    MIGScriptsDir -->|"load Python"| PyScripts
    MIG1 -->|"apply transformations"| Engine
    MIG2 -->|"apply transformations"| Engine
    PyScripts -->|"apply transformations"| Engine
    Engine -->|"run git commands"| Git
    Git -->|"write commits"| FS
    Engine -->|"perform FS changes"| FS
    Engine -->|"emit logs"| Logger
    Engine -->|"raise errors"| Excp
    Tests -->|"use loader"| Loader
    Tests -->|"input modules"| DataIn
    Tests -->|"validate output"| DataOut

    %% Click Events
    click Main "https://github.com/oca/odoo-module-migrator/blob/master/odoo_module_migrate/__main__.py"
    click ConfigNode "https://github.com/oca/odoo-module-migrator/blob/master/odoo_module_migrate/config.py"
    click Engine "https://github.com/oca/odoo-module-migrator/blob/master/odoo_module_migrate/migration.py"
    click BaseScript "https://github.com/oca/odoo-module-migrator/blob/master/odoo_module_migrate/base_migration_script.py"
    click ModuleMig "https://github.com/oca/odoo-module-migrator/blob/master/odoo_module_migrate/module_migration.py"
    click Tools "https://github.com/oca/odoo-module-migrator/blob/master/odoo_module_migrate/tools.py"
    click Logger "https://github.com/oca/odoo-module-migrator/blob/master/odoo_module_migrate/log.py"
    click Excp "https://github.com/oca/odoo-module-migrator/blob/master/odoo_module_migrate/exception.py"
    click MIGScriptsDir "https://github.com/oca/odoo-module-migrator/tree/master/odoo_module_migrate/migration_scripts/"
    click MIG1 "https://github.com/oca/odoo-module-migrator/blob/master/odoo_module_migrate/migration_scripts/migrate_080_090.py"
    click MIG2 "https://github.com/oca/odoo-module-migrator/blob/master/odoo_module_migrate/migration_scripts/migrate_allways.py"
    click PyScripts "https://github.com/oca/odoo-module-migrator/tree/master/odoo_module_migrate/migration_scripts/python_scripts/"
    click Tests "https://github.com/oca/odoo-module-migrator/blob/master/tests/test_migration.py"
    click DataIn "https://github.com/oca/odoo-module-migrator/tree/master/tests/data_template/"
    click DataOut "https://github.com/oca/odoo-module-migrator/tree/master/tests/data_result/"
    click SetupPy "https://github.com/oca/odoo-module-migrator/blob/master/setup.py"
    click Req "https://github.com/oca/odoo-module-migrator/blob/master/requirements.txt"
    click Pre "https://github.com/oca/odoo-module-migrator/blob/master/.pre-commit-config.yaml"
    click TravisN "https://github.com/oca/odoo-module-migrator/blob/master/.travis.yml"
    click CIconf "https://github.com/oca/odoo-module-migrator/tree/master/.github/workflows/"

    %% Styles
    classDef user fill:#f9f,stroke:#333,stroke-width:1px
    classDef internal fill:#bbf,stroke:#333,stroke-width:1px
    classDef script fill:#dcb,stroke:#333,stroke-width:1px
    classDef database fill:#bfb,stroke:#333,stroke-width:1px
    classDef external fill:#ccc,stroke:#333,stroke-width:1px
    classDef test fill:#fcf,stroke:#333,stroke-width:1px
    classDef config fill:#fca,stroke:#333,stroke-width:1px
```
