[18.0][MIG] odoo_repository_migration

odoo_repository/tests/odoo_repo_mixin.py

@@ -2,7 +2,6 @@
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl)
 
 import io
-import os
 import shutil
 import tempfile
 import threading
@@ -31,20 +30,10 @@ def setUpClass(cls):
         cls.addon = "my_module"
         cls.target_addon = "my_module_renamed"
         # Create a temporary Git repository
-        cls._apply_git_config()
         cls.repo_upstream_path = cls._get_upstream_repository_path()
         cls.addon_path = Path(cls.repo_upstream_path) / cls.addon
         cls.manifest_path = cls.addon_path / "__manifest__.py"
 
-    @classmethod
-    def _apply_git_config(cls):
-        """Configure git (~/.gitconfig) if no config file exists."""
-        git_cfg = Path(os.path.expanduser("~/.gitconfig"))
-        if git_cfg.exists():
-            return
-        os.system("git config --global user.email 'test@example.com'")
-        os.system("git config --global user.name 'test'")
-
     @classmethod
     def _get_upstream_repository_path(cls) -> Path:
         """Returns the path of upstream repository.
@@ -95,7 +84,9 @@ def _unarchive_upstream_repository(cls, archive_data: bytes) -> Path:
     def _create_tmp_git_repository(cls) -> Path:
         """Create a temporary Git repository to run tests."""
         repo_path = tempfile.mkdtemp()
-        git.Repo.init(repo_path)
+        repo = git.Repo.init(repo_path)
+        repo.config_writer().set_value("user", "name", "test").release()
+        repo.config_writer().set_value("user", "email", "test@example.com").release()
         return Path(repo_path)
 
     @classmethod

odoo_repository_migration/README.rst

@@ -0,0 +1,150 @@
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
+==============================
+Odoo Repository Migration Data
+==============================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:568479ec26f358ee26894cc3b2409f3337827426661abba55f0e3f3b8db19cc3
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fmodule--composition--analysis-lightgray.png?logo=github
+    :target: https://github.com/OCA/module-composition-analysis/tree/16.0/odoo_repository_migration
+    :alt: OCA/module-composition-analysis
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/module-composition-analysis-16-0/module-composition-analysis-16-0-odoo_repository_migration
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/module-composition-analysis&target_branch=16.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module collects and records modules migration data from Odoo
+repositories.
+
+Thanks to `oca-port <https://github.com/OCA/oca-port/>`__ and data
+collected by ``odoo_repository``, this module will generate migration
+data on each module for declared migration paths (e.g. 16.0 -> 18.0).
+
+Also, for specific cases you can declare what a module became in a given
+Odoo version, like OCA ``web_domain_field`` replaced by standard Odoo
+module ``web`` starting from 17.0 (with an optional explanation that
+could help users, like how to use this new module compared to the
+previous one).
+
+Given a migration path, a module can get one of this migration status:
+
++-----------------------------+----------------------------------------+
+| Status                      | Description                            |
++=============================+========================================+
+| *Fully Ported*              | All commits from source version are    |
+|                             | present in target version              |
++-----------------------------+----------------------------------------+
+| *To migrate*                | The module doesn't exist on target     |
+|                             | version                                |
++-----------------------------+----------------------------------------+
+| *Ported (missing commits?)* | Some commits from source version are   |
+|                             | not ported in target version (could be |
+|                             | false-positive)                        |
++-----------------------------+----------------------------------------+
+| *To review*                 | A migration PR has been detected       |
++-----------------------------+----------------------------------------+
+| *Replaced*                  | The module has been replaced by        |
+|                             | another one (not sharing the same git  |
+|                             | history)                               |
++-----------------------------+----------------------------------------+
+| *Moved to standard?*        | The module name has been detected in   |
+|                             | Odoo standard repositories for target  |
+|                             | version. High chance this module is or |
+|                             | should be replaced by another one      |
+|                             | instead (by creating a timeline), so   |
+|                             | it mainly helps to detect such cases.  |
++-----------------------------+----------------------------------------+
+| *Moved to OCA*              | the module name is available in an OCA |
+|                             | repository (could be a false-positive  |
+|                             | because sharing the same name, in such |
+|                             | case a timeline has to be created)     |
++-----------------------------+----------------------------------------+
+| *Moved to generic repo*     | a specific module (only available in a |
+|                             | project) in source version now exists  |
+|                             | in a generic repository (could be a    |
+|                             | false-positive if both modules have    |
+|                             | only their name in common)             |
++-----------------------------+----------------------------------------+
+
+It helps to build a consolidated knowledge database accross different
+Odoo versions for everyone: functionals and developers.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+To enable this feature, the option *Collect migration data* should be
+enabled on repositories (opt-in).
+
+To record what a module became starting from a given Odoo version, you
+should do it through the *Odoo Repositories / Data / Modules /
+Timelines* menu.
+
+Once the scheduled action ran, the migration data are available on each
+module in *Migration* tab, or through the *Odoo Repositories / Data /
+Modules / Migrations* menu.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/module-composition-analysis/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/module-composition-analysis/issues/new?body=module:%20odoo_repository_migration%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+-------
+
+* Camptocamp
+
+Contributors
+------------
+
+- Camptocamp
+
+  - Sébastien Alix <seb@usr-src.org>
+
+Maintainers
+-----------
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+This module is part of the `OCA/module-composition-analysis <https://github.com/OCA/module-composition-analysis/tree/16.0/odoo_repository_migration>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

odoo_repository_migration/__init__.py

@@ -0,0 +1,2 @@
+from . import models
+from .hooks import update_oca_repositories

odoo_repository_migration/__manifest__.py

@@ -0,0 +1,30 @@
+# Copyright 2023 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl)
+{
+    "name": "Odoo Repository Migration Data",
+    "summary": "Collect modules migration data for Odoo Repositories.",
+    "version": "18.0.1.0.0",
+    "category": "Tools",
+    "author": "Camptocamp, Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/module-composition-analysis",
+    "data": [
+        "security/ir.model.access.csv",
+        "data/queue_job.xml",
+        "views/odoo_migration_path.xml",
+        "views/odoo_module_branch.xml",
+        "views/odoo_module_branch_migration.xml",
+        "views/odoo_module_branch_timeline.xml",
+        "views/odoo_repository.xml",
+    ],
+    "installable": True,
+    "depends": [
+        "odoo_repository",
+    ],
+    "external_dependencies": {
+        "python": [
+            "oca-port",
+        ],
+    },
+    "license": "AGPL-3",
+    "post_init_hook": "update_oca_repositories",
+}

odoo_repository_migration/data/queue_job.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!-- Copyright 2023 Camptocamp SA
+     License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
+<odoo noupdate="1">
+    <record id="queue_job_channel_scan_migration" model="queue.job.channel">
+        <field name="name">odoo_repository_scan_migration</field>
+        <field name="parent_id" ref="queue_job.channel_root" />
+    </record>
+
+    <record
+        id="queue_job_function_odoo_repository_scan_migration_paths"
+        model="queue.job.function"
+    >
+        <field name="model_id" ref="model_odoo_repository" />
+        <field name="method">_scan_migration_paths</field>
+        <field name="channel_id" ref="queue_job_channel_scan_migration" />
+        <field name="retry_pattern" eval="{1: 1, 5: 5, 10: 10, 15: 30}" />
+    </record>
+
+    <record
+        id="queue_job_function_odoo_repository_scan_migration_module"
+        model="queue.job.function"
+    >
+        <field name="model_id" ref="model_odoo_repository" />
+        <field name="method">_scan_migration_module</field>
+        <field name="channel_id" ref="queue_job_channel_scan_migration" />
+        <field name="retry_pattern" eval="{1: 1, 5: 5, 10: 10, 15: 30}" />
+    </record>
+</odoo>

odoo_repository_migration/hooks.py

@@ -0,0 +1,14 @@
+# Copyright 2023 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl)
+
+
+def update_oca_repositories(env):
+    """Configure OCA repositories to collect migration data."""
+    org = env["odoo.repository.org"].search([("name", "=", "OCA")])
+    if org:
+        repositories = (
+            env["odoo.repository"]
+            .with_context(active_test=False)
+            .search([("org_id", "=", org.id)])
+        )
+        repositories.write({"collect_migration_data": True})