OCA / odoo-module-migrator / 122

pending completion

Build # 122

Build Type

Pull #31

travis-ci

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/ac6eb1a81dc65cb6efbe05a13bca915c23250133">ac6eb1a81">&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/ac6eb1a81dc65cb6efbe05a13bca915c23250133">ac6eb1a81</a><a href="https://github.com/OCA/odoo-module-migrator/commit/ac6eb1a81dc65cb6efbe05a13bca915c23250133">&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/ac6eb1a81dc65cb6efbe05a13bca915c23250133&quot;&gt;ac6eb1a81&lt;/a&gt;&lt;a href=&quot;https://github.com/OCA/odoo-module-migrator/commit/ac6eb1a81dc65cb6efbe05a13bca915c23250133&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 #31: Include text warnings. For example, to log computed change in 12 to 13

Run Details

7 of 7 new or added lines in 2 files covered. (100.0%)

281 of 323 relevant lines covered (87.0%)

0.87 hits per line

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

93.68

/odoo_module_migrate/module_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 os
import re
from .log import logger

from .config import _ALLOWED_EXTENSIONS, _MANIFEST_NAMES
from .tools import _execute_shell
from . import tools


class ModuleMigration():

    _migration = False
    _module_name = False
    _module_path = False

    def __init__(self, migration, module_name):
        self._migration = migration
        self._module_name = module_name
        self._module_path = self._migration._directory_path / module_name

    def run(self):
        logger.info("[%s] Running migration from %s to %s" % (
            self._module_name,
            self._migration._migration_steps[0]["init_version_name"],
            self._migration._migration_steps[-1]["target_version_name"],
        ))

        # Apply migration script
        for migration_script in self._migration._migration_scripts:
            self._run_migration_scripts(migration_script)

        self._commit_changes("[MIG] %s: Migration to %s" % (
            self._module_name,
            self._migration._migration_steps[-1]["target_version_name"]))

    def _run_migration_scripts(self, migration_script):
        file_renames = getattr(migration_script, "_FILE_RENAMES", {})
        text_replaces = getattr(migration_script, "_TEXT_REPLACES", {})
        text_warnings = getattr(migration_script, "_TEXT_WARNINGS", {})
        text_errors = getattr(migration_script, "_TEXT_ERRORS", {})
        global_functions = getattr(migration_script, "_GLOBAL_FUNCTIONS", {})
        deprecated_modules = getattr(
            migration_script, "_DEPRECATED_MODULES", {})

        for root, directories, filenames in os.walk(
                self._module_path.resolve()):
            for filename in filenames:
                # Skip useless file
                # TODO, skip files present in some folders. (for exemple 'lib')
                extension = os.path.splitext(filename)[1]
                if extension not in _ALLOWED_EXTENSIONS:
                    continue

                absolute_file_path = os.path.join(root, filename)
                logger.debug("Migrate '%s' file" % absolute_file_path)

                # Rename file, if required
                new_name = file_renames.get(filename)
                if new_name:
                    self._rename_file(
                        self._migration._directory_path,
                        absolute_file_path,
                        os.path.join(root, new_name))
                    absolute_file_path = os.path.join(root, new_name)

                # Operate changes in the file (replacements, removals)
                replaces = text_replaces.get("*", {})
                replaces.update(text_replaces.get(extension, {}))

                new_text = tools._replace_in_file(
                    absolute_file_path, replaces,
                    "Change file content of %s" % filename)

                # Display errors if the new content contains some obsolete
                # pattern
                errors = text_errors.get("*", {})
                errors.update(text_errors.get(extension, {}))
                for pattern, error_message in errors.items():
                    if re.findall(pattern, new_text):
                        logger.error(error_message)

                warnings = text_warnings.get("*", {})
                warnings.update(text_warnings.get(extension, {}))
                for pattern, warning_message in warnings.items():
                    if re.findall(pattern, new_text):
                        logger.warning(
                            warning_message +
                            '. File ' + root + os.sep + filename
                        )

        # Handle deprecated modules
        current_manifest_text = tools._read_content(self._get_manifest_path())
        new_manifest_text = current_manifest_text
        for items in deprecated_modules:
            old_module, action = items[0:2]
            new_module = len(items) > 2 and items[2]
            old_module_pattern = r"('|\"){0}('|\")".format(old_module)
            if new_module:
                new_module_pattern = r"('|\"){0}('|\")".format(new_module)
                replace_pattern = r"\1{0}\2".format(new_module)

            if not re.findall(old_module_pattern, new_manifest_text):
                continue

            if action == 'removed':
                # The module has been removed, just log an error.
                logger.error(
                    "Depends on removed module '%s'" % (old_module))

            elif action == 'renamed':
                new_manifest_text = re.sub(
                    old_module_pattern, replace_pattern, new_manifest_text)
                logger.info(
                    "Replaced dependency of '%s' by '%s'." % (
                        old_module, new_module))

            elif action == 'oca_moved':
                new_manifest_text = re.sub(
                    old_module_pattern, replace_pattern, new_manifest_text)
                logger.warning(
                    "Replaced dependency of '%s' by '%s' (%s)\n"
                    "Check that '%s' is available on your system." % (
                        old_module, new_module, items[3], new_module))

            elif action == "merged":
                if not re.findall(new_module_pattern, new_manifest_text):
                    # adding dependency of the merged module
                    new_manifest_text = re.sub(
                        old_module_pattern, replace_pattern, new_manifest_text)
                    logger.info(
                        "'%s' merged in '%s'. Replacing dependency." % (
                            old_module, new_module))
                else:
                    # TODO, improve me. we should remove the dependency
                    # but it could generate coma trouble.
                    # maybe handling this treatment by ast lib could fix
                    # the problem.
                    logger.error(
                        "'%s' merged in '%s'. You should remove the"
                        " dependency to '%s' manually." % (
                            old_module, new_module, old_module))

        if current_manifest_text != new_manifest_text:
            tools._write_content(self._get_manifest_path(), new_manifest_text)

        if global_functions:
            for function in global_functions:
                function(
                    logger=logger,
                    module_path=self._module_path,
                    module_name=self._module_name,
                    manifest_path=self._get_manifest_path(),
                    migration_steps=self._migration._migration_steps,
                    tools=tools,
                )

    def _get_manifest_path(self):
        for manifest_name in _MANIFEST_NAMES:
            manifest_path = self._module_path / manifest_name
            if manifest_path.exists():
                return manifest_path

    def _rename_file(self, module_path, old_file_path, new_file_path):
        """
        Rename a file. try to execute 'git mv', to avoid huge diff.

        if 'git mv' fails, make a classical rename
        """
        logger.info(
            "Renaming file: '%s' by '%s' " % (
                old_file_path.replace(str(module_path.resolve()), ""),
                new_file_path.replace(str(module_path.resolve()), ""))
        )
        if self._migration._commit_enabled:
            _execute_shell(
                "git mv %s %s" % (old_file_path, new_file_path),
                path=module_path)
        else:
            _execute_shell(
                "mv %s %s" % (old_file_path, new_file_path),
                path=module_path)

    def _commit_changes(self, commit_name):
        if not self._migration._commit_enabled:
            return

        if _execute_shell("git diff", path=self._migration._directory_path):
            logger.info(
                "Commit changes for %s. commit name '%s'" % (
                    self._module_name, commit_name
                ))

            _execute_shell(
                " git add . --all && git commit --no-verify -m '%s'" % (
                    commit_name
                ), path=self._migration._directory_path)

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 os	1✔
6	import re	1✔
7	from .log import logger	1✔
8
9	from .config import _ALLOWED_EXTENSIONS, _MANIFEST_NAMES	1✔
10	from .tools import _execute_shell	1✔
11	from . import tools	1✔
12
13
14	class ModuleMigration():	1✔
15
16	_migration = False	1✔
17	_module_name = False	1✔
18	_module_path = False	1✔
19
20	def __init__(self, migration, module_name):	1✔
21	self._migration = migration	1✔
22	self._module_name = module_name	1✔
23	self._module_path = self._migration._directory_path / module_name	1✔
24
25	def run(self):	1✔
26	logger.info("[%s] Running migration from %s to %s" % (	1✔
27	self._module_name,
28	self._migration._migration_steps[0]["init_version_name"],
29	self._migration._migration_steps[-1]["target_version_name"],
30	))
31
32	# Apply migration script
33	for migration_script in self._migration._migration_scripts:	1✔
34	self._run_migration_scripts(migration_script)	1✔
35
36	self._commit_changes("[MIG] %s: Migration to %s" % (	1✔
37	self._module_name,
38	self._migration._migration_steps[-1]["target_version_name"]))
39
40	def _run_migration_scripts(self, migration_script):	1✔
41	file_renames = getattr(migration_script, "_FILE_RENAMES", {})	1✔
42	text_replaces = getattr(migration_script, "_TEXT_REPLACES", {})	1✔
43	text_warnings = getattr(migration_script, "_TEXT_WARNINGS", {})	1✔
44	text_errors = getattr(migration_script, "_TEXT_ERRORS", {})	1✔
45	global_functions = getattr(migration_script, "_GLOBAL_FUNCTIONS", {})	1✔
46	deprecated_modules = getattr(	1✔
47	migration_script, "_DEPRECATED_MODULES", {})
48
49	for root, directories, filenames in os.walk(	1✔
50	self._module_path.resolve()):
51	for filename in filenames:	1✔
52	# Skip useless file
53	# TODO, skip files present in some folders. (for exemple 'lib')
54	extension = os.path.splitext(filename)[1]	1✔
55	if extension not in _ALLOWED_EXTENSIONS:	1✔
56	continue	×
57
58	absolute_file_path = os.path.join(root, filename)	1✔
59	logger.debug("Migrate '%s' file" % absolute_file_path)	1✔
60
61	# Rename file, if required
62	new_name = file_renames.get(filename)	1✔
63	if new_name:	1✔
64	self._rename_file(	1✔
65	self._migration._directory_path,
66	absolute_file_path,
67	os.path.join(root, new_name))
68	absolute_file_path = os.path.join(root, new_name)	1✔
69
70	# Operate changes in the file (replacements, removals)
71	replaces = text_replaces.get("*", {})	1✔
72	replaces.update(text_replaces.get(extension, {}))	1✔
73
74	new_text = tools._replace_in_file(	1✔
75	absolute_file_path, replaces,
76	"Change file content of %s" % filename)
77
78	# Display errors if the new content contains some obsolete
79	# pattern
80	errors = text_errors.get("*", {})	1✔
81	errors.update(text_errors.get(extension, {}))	1✔
82	for pattern, error_message in errors.items():	1✔
83	if re.findall(pattern, new_text):	1✔
84	logger.error(error_message)	1✔
85
86	warnings = text_warnings.get("*", {})	1✔
87	warnings.update(text_warnings.get(extension, {}))	1✔
88	for pattern, warning_message in warnings.items():	1✔
89	if re.findall(pattern, new_text):	1✔
90	logger.warning(	×
91	warning_message +
92	'. File ' + root + os.sep + filename
93	)
94
95	# Handle deprecated modules
96	current_manifest_text = tools._read_content(self._get_manifest_path())	1✔
97	new_manifest_text = current_manifest_text	1✔
98	for items in deprecated_modules:	1✔
99	old_module, action = items[0:2]	1✔
100	new_module = len(items) > 2 and items[2]	1✔
101	old_module_pattern = r"('\|\"){0}('\|\")".format(old_module)	1✔
102	if new_module:	1✔
103	new_module_pattern = r"('\|\"){0}('\|\")".format(new_module)	1✔
104	replace_pattern = r"\1{0}\2".format(new_module)	1✔
105
106	if not re.findall(old_module_pattern, new_manifest_text):	1✔
107	continue	1✔
108
109	if action == 'removed':	1✔
110	# The module has been removed, just log an error.
111	logger.error(	1✔
112	"Depends on removed module '%s'" % (old_module))
113
114	elif action == 'renamed':	1✔
115	new_manifest_text = re.sub(	1✔
116	old_module_pattern, replace_pattern, new_manifest_text)
117	logger.info(	1✔
118	"Replaced dependency of '%s' by '%s'." % (
119	old_module, new_module))
120
121	elif action == 'oca_moved':	1✔
122	new_manifest_text = re.sub(	1✔
123	old_module_pattern, replace_pattern, new_manifest_text)
124	logger.warning(	1✔
125	"Replaced dependency of '%s' by '%s' (%s)\n"
126	"Check that '%s' is available on your system." % (
127	old_module, new_module, items[3], new_module))
128
129	elif action == "merged":	1✔
130	if not re.findall(new_module_pattern, new_manifest_text):	1✔
131	# adding dependency of the merged module
132	new_manifest_text = re.sub(	1✔
133	old_module_pattern, replace_pattern, new_manifest_text)
134	logger.info(	1✔
135	"'%s' merged in '%s'. Replacing dependency." % (
136	old_module, new_module))
137	else:
138	# TODO, improve me. we should remove the dependency
139	# but it could generate coma trouble.
140	# maybe handling this treatment by ast lib could fix
141	# the problem.
142	logger.error(	1✔
143	"'%s' merged in '%s'. You should remove the"
144	" dependency to '%s' manually." % (
145	old_module, new_module, old_module))
146
147	if current_manifest_text != new_manifest_text:	1✔
148	tools._write_content(self._get_manifest_path(), new_manifest_text)	1✔
149
150	if global_functions:	1✔
151	for function in global_functions:	1✔
152	function(	1✔
153	logger=logger,
154	module_path=self._module_path,
155	module_name=self._module_name,
156	manifest_path=self._get_manifest_path(),
157	migration_steps=self._migration._migration_steps,
158	tools=tools,
159	)
160
161	def _get_manifest_path(self):	1✔
162	for manifest_name in _MANIFEST_NAMES:	1✔
163	manifest_path = self._module_path / manifest_name	1✔
164	if manifest_path.exists():	1✔
165	return manifest_path	1✔
166
167	def _rename_file(self, module_path, old_file_path, new_file_path):	1✔
168	"""
169	Rename a file. try to execute 'git mv', to avoid huge diff.
170
171	if 'git mv' fails, make a classical rename
172	"""
173	logger.info(	1✔
174	"Renaming file: '%s' by '%s' " % (
175	old_file_path.replace(str(module_path.resolve()), ""),
176	new_file_path.replace(str(module_path.resolve()), ""))
177	)
178	if self._migration._commit_enabled:	1✔
179	_execute_shell(	×
180	"git mv %s %s" % (old_file_path, new_file_path),
181	path=module_path)
182	else:
183	_execute_shell(	1✔
184	"mv %s %s" % (old_file_path, new_file_path),
185	path=module_path)
186
187	def _commit_changes(self, commit_name):	1✔
188	if not self._migration._commit_enabled:	1✔
189	return	1✔
190
191	if _execute_shell("git diff", path=self._migration._directory_path):	×
192	logger.info(	×
193	"Commit changes for %s. commit name '%s'" % (
194	self._module_name, commit_name
195	))
196
197	_execute_shell(	×
198	" git add . --all && git commit --no-verify -m '%s'" % (
199	commit_name
200	), path=self._migration._directory_path)

OCA / odoo-module-migrator / 122

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