OCA / odoo-module-migrator / 17

pending completion

Build # 17

Build Type

Pull #25

travis-ci-com

Committed by

web-flow

Commit Message

<a href="https://github.com/OCA/odoo-module-migrator/commit/<a class=hub.com/OCA/odoo-module-migrator/commit/<a class="double-link" href="https://git"><a class=hub.com/OCA/odoo-module-migrator/commit/<a class="double-link" href="https://git"><a class=hub.com/OCA/odoo-module-migrator/commit/<a class="double-link" href="https://git"><a class=hub.com/OCA/odoo-module-migrator/commit/242102c7e4f8bec58d28eb5fdbcec192864ad922">242102c7e">&lt;a href=&quot;https://github.com/OCA/odoo-module-migrator/commit/</a><a class="double-link" href="https://github.com/OCA/odoo-module-migrator/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/OCA/odoo-module-migrator/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/OCA/odoo-module-migrator/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/OCA/odoo-module-migrator/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/OCA/odoo-module-migrator/commit/242102c7e4f8bec58d28eb5fdbcec192864ad922">242102c7e</a><a href="https://github.com/OCA/odoo-module-migrator/commit/242102c7e4f8bec58d28eb5fdbcec192864ad922">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/OCA/odoo-module-migrator/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/OCA/odoo-module-migrator/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/OCA/odoo-module-migrator/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/OCA/odoo-module-migrator/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/OCA/odoo-module-migrator/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/OCA/odoo-module-migrator/commit/242102c7e4f8bec58d28eb5fdbcec192864ad922&quot;&gt;242102c7e&lt;/a&gt;&lt;a href=&quot;https://github.com/OCA/odoo-module-migrator/commit/242102c7e4f8bec58d28eb5fdbcec192864ad922&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/OCA/odoo-module-migrator/commit/&amp;lt;/a&amp;gt;&amp;lt;a... (continued)

Pull Request Pull Request #25: Run pre-commit if needed

Run Details

4 of 4 new or added lines in 1 file covered. (100.0%)

277 of 320 relevant lines covered (86.56%)

0.87 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

74.16

/odoo_module_migrate/migration.py

# Copyright (C) 2019 - Today: GRAP (http://www.grap.coop)
# @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).

import importlib
import os
import pathlib
import pkgutil
import subprocess

from .config import _AVAILABLE_MIGRATION_STEPS, _MANIFEST_NAMES
from .exception import ConfigException
from .log import logger
from .tools import _execute_shell, _get_latest_version_code
from .module_migration import ModuleMigration


class Migration():

    _migration_steps = []
    _directory_path = False
    _migration_scripts = []
    _module_migrations = []
    _commit_enabled = True

    def __init__(
        self, relative_directory_path, init_version_name, target_version_name,
        module_names=[], format_patch=False, remote_name='origin',
        commit_enabled=True,
    ):
        self._commit_enabled = commit_enabled

        # Get migration steps that will be runned
        found = False
        for item in _AVAILABLE_MIGRATION_STEPS:
            if not found and item["init_version_name"] != init_version_name:
                continue
            else:
                found = True
            self._migration_steps.append(item)
            if item["target_version_name"] == target_version_name:
                # This is the last step, exiting
                break

        # Check consistency between format patch and module_names args
        if format_patch and len(module_names) != 1:
            raise ConfigException(
                "Format patch option can only be used for a single module")
        logger.debug("Module list: %s" % module_names)
        logger.debug("format patch option : %s" % format_patch)

        # convert relative or absolute directory into Path Object
        if not os.path.exists(relative_directory_path):
            raise ConfigException(
                "Unable to find directory: %s" % relative_directory_path)

        root_path = pathlib.Path(relative_directory_path)
        self._directory_path = pathlib.Path(root_path.resolve(strict=True))

        # format-patch, if required
        if format_patch:
            if not (root_path / module_names[0]).is_dir():
                self._get_code_from_previous_branch(
                    module_names[0], remote_name)
            else:
                logger.warning(
                    "Ignoring format-patch argument, as the module %s"
                    " is still present in the repository" % (module_names[0]))

        # Guess modules if not provided, and check validity
        if not module_names:
            module_names = []
            # Recover all submodules, if no modules list is provided
            child_paths = [x for x in root_path.iterdir() if x.is_dir()]
            for child_path in child_paths:
                if self._is_module_path(child_path):
                    module_names.append(child_path.name)
        else:
            child_paths = [root_path / x for x in module_names]
            for child_path in child_paths:
                if not self._is_module_path(child_path):
                    module_names.remove(child_path.name)
                    logger.warning(
                        "No valid module found for '%s' in the directory '%s'"
                        % (child_path.name, root_path.resolve()))

        if not module_names:
            raise ConfigException("No modules found to migrate. Exiting.")

        for module_name in module_names:
            self._module_migrations.append(ModuleMigration(self, module_name))

        # get migration scripts, depending to the migration list
        self._get_migration_scripts()

    def _is_module_path(self, module_path):
        return any([(module_path / x).exists() for x in _MANIFEST_NAMES])

    def _get_code_from_previous_branch(self, module_name, remote_name):
        init_version = self._migration_steps[0]["init_version_name"]
        target_version = self._migration_steps[-1]["target_version_name"]
        branch_name = "%(version)s-mig-%(module_name)s" % {
            'version': target_version,
            'module_name': module_name}

        logger.info("Creating new branch '%s' ..." % (branch_name))
        _execute_shell(
            "git checkout -b %(branch)s %(remote)s/%(version)s" % {
                'branch': branch_name,
                'remote': remote_name,
                'version': target_version,
            }, path=self._directory_path)

        _execute_shell(
            "git format-patch --keep-subject "
            "--stdout %(remote)s/%(target)s..%(remote)s/%(init)s "
            "-- %(module)s | git am -3 --keep" % {
                'remote': remote_name,
                'init': init_version,
                'target': target_version,
                'module': module_name,
            }, path=self._directory_path)

    def _get_migration_scripts(self):

        # Add the script that will be allways executed
        self._migration_scripts.append(importlib.import_module(
            "odoo_module_migrate.migration_scripts.migrate_allways"))

        all_packages = importlib.import_module(
            "odoo_module_migrate.migration_scripts")

        migration_start = float(self._migration_steps[0]["init_version_code"])
        migration_end = float(self._migration_steps[-1]["target_version_code"])

        for loader, name, is_pkg in pkgutil.walk_packages(
                all_packages.__path__):
            # Ignore script that will be allways executed.
            # this script will be added at the end.
            if name == 'migrate_allways':
                continue

            # Filter migration scripts, depending of the configuration
            full_name = all_packages.__name__ + '.' + name
            if 'allways' in name:
                # replace allways by the most recent version
                real_name = name.replace("allways", _get_latest_version_code())
            else:
                real_name = name
            splitted_name = real_name.split("_")

            script_start = float(splitted_name[1])
            script_end = float(splitted_name[2])

            # Exclude scripts
            if script_start >= migration_end or script_end <= migration_start:
                continue

            self._migration_scripts.append(importlib.import_module(full_name))

        logger.debug(
            "The following migration script will be"
            " executed:\n- %s" % '\n- '.join(
                [x.__file__.split('/')[-1] for x in self._migration_scripts]))

    def run(self):
        logger.debug(
            "Running migration from: %s to: %s in '%s'" % (
                self._migration_steps[0]["init_version_name"],
                self._migration_steps[-1]["target_version_name"],
                self._directory_path.resolve()))
        for module_migration in self._module_migrations:
            module_migration.run()

        if os.path.exists(
                self._directory_path.as_posix() +
                os.sep +
                '.pre-commit-config.yaml'
        ):
            logger.info('File .pre-commit-config.yaml finded. '
                        'Running pre-commit')
            subprocess.run(
                ["pre-commit", "run", "-a"],
                cwd=self._directory_path.as_posix()
            )

1	# Copyright (C) 2019 - Today: GRAP (http://www.grap.coop)
2	# @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
3	# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
4
5	import importlib	1✔
6	import os	1✔
7	import pathlib	1✔
8	import pkgutil	1✔
9	import subprocess	1✔
10
11	from .config import _AVAILABLE_MIGRATION_STEPS, _MANIFEST_NAMES	1✔
12	from .exception import ConfigException	1✔
13	from .log import logger	1✔
14	from .tools import _execute_shell, _get_latest_version_code	1✔
15	from .module_migration import ModuleMigration	1✔
16
17
18	class Migration():	1✔
19
20	_migration_steps = []	1✔
21	_directory_path = False	1✔
22	_migration_scripts = []	1✔
23	_module_migrations = []	1✔
24	_commit_enabled = True	1✔
25
26	def __init__(	1✔
27	self, relative_directory_path, init_version_name, target_version_name,
28	module_names=[], format_patch=False, remote_name='origin',
29	commit_enabled=True,
30	):
31	self._commit_enabled = commit_enabled	1✔
32
33	# Get migration steps that will be runned
34	found = False	1✔
35	for item in _AVAILABLE_MIGRATION_STEPS:	1✔
36	if not found and item["init_version_name"] != init_version_name:	1✔
37	continue	×
38	else:
39	found = True	1✔
40	self._migration_steps.append(item)	1✔
41	if item["target_version_name"] == target_version_name:	1✔
42	# This is the last step, exiting
43	break	1✔
44
45	# Check consistency between format patch and module_names args
46	if format_patch and len(module_names) != 1:	1✔
47	raise ConfigException(	×
48	"Format patch option can only be used for a single module")
49	logger.debug("Module list: %s" % module_names)	1✔
50	logger.debug("format patch option : %s" % format_patch)	1✔
51
52	# convert relative or absolute directory into Path Object
53	if not os.path.exists(relative_directory_path):	1✔
54	raise ConfigException(	×
55	"Unable to find directory: %s" % relative_directory_path)
56
57	root_path = pathlib.Path(relative_directory_path)	1✔
58	self._directory_path = pathlib.Path(root_path.resolve(strict=True))	1✔
59
60	# format-patch, if required
61	if format_patch:	1✔
62	if not (root_path / module_names[0]).is_dir():	×
63	self._get_code_from_previous_branch(	×
64	module_names[0], remote_name)
65	else:
66	logger.warning(	×
67	"Ignoring format-patch argument, as the module %s"
68	" is still present in the repository" % (module_names[0]))
69
70	# Guess modules if not provided, and check validity
71	if not module_names:	1✔
72	module_names = []	×
73	# Recover all submodules, if no modules list is provided
74	child_paths = [x for x in root_path.iterdir() if x.is_dir()]	×
75	for child_path in child_paths:	×
76	if self._is_module_path(child_path):	×
77	module_names.append(child_path.name)	×
78	else:
79	child_paths = [root_path / x for x in module_names]	1✔
80	for child_path in child_paths:	1✔
81	if not self._is_module_path(child_path):	1✔
82	module_names.remove(child_path.name)	×
83	logger.warning(	×
84	"No valid module found for '%s' in the directory '%s'"
85	% (child_path.name, root_path.resolve()))
86
87	if not module_names:	1✔
88	raise ConfigException("No modules found to migrate. Exiting.")	×
89
90	for module_name in module_names:	1✔
91	self._module_migrations.append(ModuleMigration(self, module_name))	1✔
92
93	# get migration scripts, depending to the migration list
94	self._get_migration_scripts()	1✔
95
96	def _is_module_path(self, module_path):	1✔
97	return any([(module_path / x).exists() for x in _MANIFEST_NAMES])	1✔
98
99	def _get_code_from_previous_branch(self, module_name, remote_name):	1✔
100	init_version = self._migration_steps[0]["init_version_name"]	×
101	target_version = self._migration_steps[-1]["target_version_name"]	×
102	branch_name = "%(version)s-mig-%(module_name)s" % {	×
103	'version': target_version,
104	'module_name': module_name}
105
106	logger.info("Creating new branch '%s' ..." % (branch_name))	×
107	_execute_shell(	×
108	"git checkout -b %(branch)s %(remote)s/%(version)s" % {
109	'branch': branch_name,
110	'remote': remote_name,
111	'version': target_version,
112	}, path=self._directory_path)
113
114	_execute_shell(	×
115	"git format-patch --keep-subject "
116	"--stdout %(remote)s/%(target)s..%(remote)s/%(init)s "
117	"-- %(module)s \| git am -3 --keep" % {
118	'remote': remote_name,
119	'init': init_version,
120	'target': target_version,
121	'module': module_name,
122	}, path=self._directory_path)
123
124	def _get_migration_scripts(self):	1✔
125
126	# Add the script that will be allways executed
127	self._migration_scripts.append(importlib.import_module(	1✔
128	"odoo_module_migrate.migration_scripts.migrate_allways"))
129
130	all_packages = importlib.import_module(	1✔
131	"odoo_module_migrate.migration_scripts")
132
133	migration_start = float(self._migration_steps[0]["init_version_code"])	1✔
134	migration_end = float(self._migration_steps[-1]["target_version_code"])	1✔
135
136	for loader, name, is_pkg in pkgutil.walk_packages(	1✔
137	all_packages.__path__):
138	# Ignore script that will be allways executed.
139	# this script will be added at the end.
140	if name == 'migrate_allways':	1✔
141	continue	1✔
142
143	# Filter migration scripts, depending of the configuration
144	full_name = all_packages.__name__ + '.' + name	1✔
145	if 'allways' in name:	1✔
146	# replace allways by the most recent version
147	real_name = name.replace("allways", _get_latest_version_code())	1✔
148	else:
149	real_name = name	1✔
150	splitted_name = real_name.split("_")	1✔
151
152	script_start = float(splitted_name[1])	1✔
153	script_end = float(splitted_name[2])	1✔
154
155	# Exclude scripts
156	if script_start >= migration_end or script_end <= migration_start:	1✔
157	continue	×
158
159	self._migration_scripts.append(importlib.import_module(full_name))	1✔
160
161	logger.debug(	1✔
162	"The following migration script will be"
163	" executed:\n- %s" % '\n- '.join(
164	[x.__file__.split('/')[-1] for x in self._migration_scripts]))
165
166	def run(self):	1✔
167	logger.debug(	1✔
168	"Running migration from: %s to: %s in '%s'" % (
169	self._migration_steps[0]["init_version_name"],
170	self._migration_steps[-1]["target_version_name"],
171	self._directory_path.resolve()))
172	for module_migration in self._module_migrations:	1✔
173	module_migration.run()	1✔
174
175	if os.path.exists(	1✔
176	self._directory_path.as_posix() +
177	os.sep +
178	'.pre-commit-config.yaml'
179	):
180	logger.info('File .pre-commit-config.yaml finded. '	×
181	'Running pre-commit')
182	subprocess.run(	×
183	["pre-commit", "run", "-a"],
184	cwd=self._directory_path.as_posix()
185	)

OCA / odoo-module-migrator / 17

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous