43 |
44 |
45 |
46 |
47 |
48 |
--------------------------------------------------------------------------------
/tests/test_fixit.py:
--------------------------------------------------------------------------------
1 | import os
2 | import unittest
3 | from pathlib import Path
4 |
5 | from fixit.config import collect_rules, parse_rule
6 | from fixit.ftypes import Config
7 | from fixit.testing import generate_lint_rule_test_cases
8 |
9 | from oca_pre_commit_hooks import checks_odoo_module_fixit
10 |
11 |
12 | class FixitTest(unittest.TestCase):
13 | def test_fixit(self):
14 | """Run 'fixit test' based on fixit.cli.test method"""
15 | os.environ["FIXIT_ODOO_VERSION"] = "18.0"
16 | os.environ["FIXIT_AUTOFIX"] = "True"
17 |
18 | rule = parse_rule(
19 | ".checks_odoo_module_fixit",
20 | Path(os.path.dirname(os.path.dirname(os.path.abspath(checks_odoo_module_fixit.__file__)))),
21 | )
22 | lint_rules = collect_rules(Config(enable=[rule], disable=[], python_version=None))
23 | test_cases = generate_lint_rule_test_cases(lint_rules)
24 | print("")
25 | for test_case_class in test_cases:
26 | with self.subTest(rule_class=test_case_class.__name__):
27 | suite = unittest.defaultTestLoader.loadTestsFromTestCase(test_case_class)
28 | for test in suite:
29 | test_result = unittest.TestResult()
30 | test.run(test_result)
31 | if test_result.failures or test_result.errors:
32 | print(f"❌ Failed: {test.id()}")
33 | for _fail, traceback in test_result.failures + test_result.errors:
34 | print(traceback)
35 | self.fail(f"Subtest {test.id()} failed")
36 | else:
37 | print(f"✅ Subtest {test.id()} passed")
38 |
--------------------------------------------------------------------------------
/.pylintrc:
--------------------------------------------------------------------------------
1 |
2 |
3 | [MASTER]
4 | load-plugins=pylint.extensions.docstyle, pylint.extensions.mccabe
5 | score=n
6 |
7 | [MESSAGES CONTROL]
8 | enable=all
9 | # Enable all then relax disable instead of disable all and enable one-by-one
10 | disable=c-extension-no-member,
11 | fixme,
12 | import-error,
13 | inconsistent-return-statements,
14 | line-too-long,
15 | locally-disabled,
16 | logging-too-many-args,
17 | missing-class-docstring,
18 | missing-function-docstring,
19 | missing-module-docstring,
20 | suppressed-message,
21 | too-few-public-methods,
22 | too-many-ancestors,
23 | too-many-arguments,
24 | too-many-boolean-expressions,
25 | too-many-branches,
26 | too-many-branches,
27 | too-many-format-args,
28 | too-many-function-args,
29 | too-many-instance-attributes,
30 | too-many-instance-attributes,
31 | too-many-lines,
32 | too-many-locals,
33 | too-many-locals,
34 | too-many-nested-blocks,
35 | too-many-public-methods,
36 | too-many-return-statements,
37 | too-many-star-expressions,
38 | too-many-statements,
39 |
40 | [REPORTS]
41 | msg-template={path}:{line}: [{msg_id}({symbol}), {obj}] {msg}
42 | output-format=colorized
43 | reports=no
44 |
45 | [SIMILARITIES]
46 | min-similarity-lines=14
47 | ignore-comments=yes
48 | ignore-docstrings=yes
49 |
50 | [DESIGN]
51 | # McCabe complexity cyclomatic threshold for too-complex check
52 | # Value definied from https://en.wikipedia.org/wiki/Cyclomatic_complexity
53 | # - The figure of 10 had received substantial corroborating evidence,
54 | # but that in some circumstances it may be appropriate to relax the restriction
55 | # and permit modules with a complexity as high as 15
56 | max-complexity=15
57 |
--------------------------------------------------------------------------------
/pytest.ini:
--------------------------------------------------------------------------------
1 | [pytest]
2 | norecursedirs =
3 | .git
4 | .tox
5 | .env
6 | dist
7 | build
8 | migrations
9 |
10 | python_files =
11 | test_*.py
12 | *_test.py
13 | tests.py
14 | addopts =
15 | -ra
16 | --strict-markers
17 | --ignore=docs/conf.py
18 | --ignore=setup.py
19 | --ignore=ci
20 | --ignore=.eggs
21 | --doctest-modules
22 | --doctest-glob=\*.rst
23 | --tb=short
24 | --pyargs
25 | # The order of these options matters. testpaths comes after addopts so that
26 | # oca_pre_commit_hooks in testpaths is interpreted as
27 | # --pyargs oca_pre_commit_hooks.
28 | # Any tests in the src/ directory (that is, tests installed with the package)
29 | # can be run by any user with pytest --pyargs oca_pre_commit_hooks.
30 | # Packages that are sensitive to the host machine, most famously NumPy,
31 | # include tests with the installed package so that any user can check
32 | # at any time that everything is working properly.
33 | # If you do choose to make installable tests, this will run the installed
34 | # tests as they are actually installed (same principle as when we ensure that
35 | # we always test the installed version of the package).
36 | # If you have no need for this (and your src/ directory is very large),
37 | # you can save a few milliseconds on testing by telling pytest not to search
38 | # the src/ directory by removing
39 | # --pyargs and oca_pre_commit_hooks from the options here.
40 | testpaths =
41 | src/oca_pre_commit_hooks
42 | tests/
43 |
44 | # Idea from: https://til.simonwillison.net/pytest/treat-warnings-as-errors
45 | filterwarnings =
46 | error
47 | # You can add exclusions, some examples:
48 | # ignore:'oca_pre_commit_hooks' defines default_app_config:PendingDeprecationWarning::
49 | # ignore:The {{% if:::
50 | # ignore:Coverage disabled via --no-cov switch!
51 |
--------------------------------------------------------------------------------
/test_repo/test_module/except_pass.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | """Test Except Pass usage"""
3 |
4 |
5 | class TestExceptPass(object):
6 | """Test Except Pass class """
7 |
8 | def test_method(self):
9 | try:
10 | raise Exception('Exception')
11 | except Exception: # except-pass
12 | pass
13 |
14 | def test_2_method(self):
15 | """This pass is skip for body of except has more than one line """
16 | try:
17 | raise Exception('Exception')
18 | except Exception:
19 | pass
20 | print('Exception')
21 |
22 | def test_3_method(self):
23 | """This pass is skip for the exception is assigned"""
24 | exception = False
25 | try:
26 | raise Exception('Exception')
27 | except Exception:
28 | pass
29 | if exception:
30 | pass
31 |
32 | def test_4_method(self):
33 | userError = False
34 | try:
35 | raise Exception('Exception')
36 | except Exception:
37 | pass
38 | if userError:
39 | pass
40 |
41 | def test_5_method(self):
42 | exception = False
43 | try:
44 | raise Exception('Exception')
45 | except (Exception, IndexError):
46 | pass
47 | if exception:
48 | pass
49 |
50 | def test_6_method(self):
51 | try:
52 | raise Exception('Exception')
53 | except (Exception, IndexError): # except-pass
54 | pass
55 |
56 | def test_7_method(self):
57 | exception = False
58 | try:
59 | raise Exception('Exception')
60 | except (Exception, IndexError, NameError):
61 | pass
62 | except Exception: # except-pass
63 | pass
64 | if exception:
65 | pass
66 |
--------------------------------------------------------------------------------
/test_repo/test_module/website_templates_disable.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 | This shows proper usage. Default content is provided but can be modified/replaced by the user!
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
--------------------------------------------------------------------------------
/docs/messages/xml/oe-structure-missing-id.rst:
--------------------------------------------------------------------------------
1 | xml-oe-structure-missing-id
2 | ###########################
3 | This message is generated whenever a tag having :code:`oe_structure` as one of its classes is missing a valid
4 | :code:`id`. A valid :code:`id` must contain :code:`oe_structure` inside it. So :code:`id="my_unique_id"` is not valid,
5 | while :code:`id="oe_structure_my_unique_id"` is valid.
6 |
7 | Rationale
8 | *********
9 | The check was suggested in `this issue `_. Tags with
10 | :code:`oe_structure` as their class are meant for users to edit them through the website builder. If the tag has no
11 | :code:`id`, the website will replace the entire original view with a copy that contains the user changes.
12 | This means updates to other parts of the view (through code, AKA updating a module) may not be reflected.
13 |
14 | By providing a valid :code:`id`, only the tag with it will be replaced. Internally Odoo will inherit the original view
15 | and use an XPath to replace the tag with the user's content. This means the rest of the view can still be updated
16 | and changes should be reflected.
17 |
18 | Fixing your code
19 | ****************
20 | To fix your code you should first of all determine whether the content inside the offending tag should be
21 | editable by users. If it shouldn't, removing :code:`oe_structure` is probably the best solution.
22 |
23 | If the content is meant to be edited by users then provide a valid, **unique** ID. In order to avoid collisions
24 | it is often recommended for the ID to contain the template's ID in it. For example:
25 |
26 | .. code-block:: xml
27 |
28 |
29 |
30 | Some stuff that should not be edited
31 |
32 |
33 | Customize this greeting through the website editor!
34 |
35 |
36 |
37 | Additionally **ensure your code does not depend on any elements inside tags with oe_structure**. User editable
38 | content is volatile and subject to changes or complete removal (if the user so wishes), so something like an
39 | XPath expression may break if the user removes elements referenced in it.
40 |
--------------------------------------------------------------------------------
/tox.ini:
--------------------------------------------------------------------------------
1 | [tox]
2 | envlist =
3 | lint,
4 | update-readme,
5 | build,
6 | py39,
7 | py310,
8 | py311,
9 | py312,
10 | py313,
11 | py314,
12 |
13 | [testenv]
14 | parallel_show_output=true
15 | setenv =
16 | PYTHONPATH={toxinidir}/tests
17 | PYTHONUNBUFFERED=yes
18 | # Compatible with "tox --parallel" to avoid concurrency
19 | COVERAGE_FILE={toxinidir}/.coverage.{envname}
20 | COVERAGE_CONTEXT={envname}
21 | passenv =
22 | *
23 | deps = -r{toxinidir}/test-requirements.txt
24 | usedevelop = true
25 | commands =
26 | pytest --cov-append -s --cov --cov-report=term-missing --cov-report=html --cov-context=test -vv {posargs:}
27 |
28 | [testenv:cprofile]
29 | setenv =
30 | PROFILING=yes
31 | commands =
32 | pytest -vv -rA {posargs:-k test_profile_checks}
33 |
34 | [testenv:update-readme]
35 | basepython = {env:TOXPYTHON:python3.13}
36 | setenv =
37 | {[testenv]setenv}
38 | BUILD_README=true
39 | usedevelop = true
40 | commands =
41 | {posargs:pytest -svvk test_build_docstring}
42 | deps =
43 | {[testenv]deps}
44 |
45 | [testenv:lint]
46 | skip_install = true
47 | commands =
48 | pre-commit run --all-files --show-diff-on-failure --color=always
49 |
50 | [testenv:build]
51 | skip_install = true
52 | deps =
53 | {[testenv]deps}
54 | commands =
55 | python -m build --sdist --wheel --outdir dist_wo_pbr/
56 | python -c "import shutil;shutil.rmtree('dist/', ignore_errors=True)"
57 | python -m build --no-isolation --sdist --wheel --outdir dist/ # Generate ChangeLog with pbr
58 | python -m twine check --strict dist/*
59 | bump2version patch --allow-dirty --no-commit --no-tag --dry-run --verbose
60 | # Install packages from binaries to test if all files were already included in the compressed file
61 | python -c '''import sys,pip,os,glob;os.chdir("dist");sys.argv = ["", "install", "-U", "--force-reinstall", glob.glob("*.tar.gz")[-1], "--use-feature=no-binary-enable-wheel-cache"];pip.main()'''
62 | # Testing the package is importing the dependencies well
63 | python -c '''import sys, os;from oca_pre_commit_hooks import cli,cli_po;os.chdir("dist");sys.argv = ["", "--list-msgs", "--no-exit"];cli.main();cli_po.main()'''
64 |
65 | [testenv:clean]
66 | commands = coverage erase
67 | skip_install = true
68 | deps = coverage
69 |
--------------------------------------------------------------------------------
/test_repo/test_module/website_templates.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
Customize this! It is missing an ID
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 | Hello. Please add an ID on this!!
26 |
27 |
28 |
29 |
30 |
31 | Invalid ID :(
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
--------------------------------------------------------------------------------
/test_repo/eleven_module/i18n/pretty.po:
--------------------------------------------------------------------------------
1 | # Translation of Odoo Server.
2 | # This file contains the translation of the following modules:
3 | # * hr
4 | #
5 | # Translators:
6 | # Leonardo J. Caballero G. , 2022
7 | # oscaryuu, 2022
8 | # Pedro M. Baeza , 2023
9 | # Martin Trigaux, 2023
10 | #
11 | msgid ""
12 | msgstr ""
13 | "Project-Id-Version: Odoo Server 16.0\n"
14 | "Report-Msgid-Bugs-To: \n"
15 | "POT-Creation-Date: 2023-04-14 05:51+0000\n"
16 | "PO-Revision-Date: 2022-09-22 05:46+0000\n"
17 | "Last-Translator: Martin Trigaux, 2023\n"
18 | "Language-Team: Spanish (https://app.transifex.com/odoo/teams/41243/es/)\n"
19 | "Language: es\n"
20 | "MIME-Version: 1.0\n"
21 | "Content-Type: text/plain; charset=UTF-8\n"
22 | "Content-Transfer-Encoding: \n"
23 | "Plural-Forms: nplurals=3; plural=n == 1 ? 0 : n != 0 && n % 1000000 == 0 ? 1 : 2;\n"
24 |
25 | #. module: hr
26 | #: model:ir.model.fields,field_description:hr.field_res_company__hr_presence_control_email_amount
27 | #: model:ir.model.fields,field_description:hr.field_res_config_settings__hr_presence_control_email_amount
28 | msgid "# emails to send"
29 | msgstr "# correos electrónicos por enviar"
30 |
31 | #. module: hr
32 | #. odoo-python
33 | #: code:addons/hr/wizard/hr_plan_wizard.py:0
34 | #, python-format
35 | msgid "%(activity)s, assigned to %(name)s, due on the %(deadline)s"
36 | msgstr ""
37 |
38 | #. module: hr
39 | #. odoo-python
40 | #: code:addons/hr/models/hr_job.py:0
41 | #, python-format
42 | msgid "%s (copy)"
43 | msgstr "%s (copia)"
44 |
45 | #. module: hr
46 | #: model_terms:ir.ui.view,arch_db:hr.hr_job_view_kanban
47 | msgid " "
48 | msgstr ""
49 |
50 | #. module: hr
51 | #: model:ir.actions.report,print_report_name:hr.hr_employee_print_badge
52 | msgid "'Print Badge - %s' % (object.name).replace('/', '')"
53 | msgstr "'Imprimir insignia - %s' % (object.name).replace('/', '')"
54 |
55 | #. module: hr
56 | #: model_terms:hr.job,job_details:hr.job_ceo
57 | #: model_terms:hr.job,job_details:hr.job_consultant
58 | #: model_terms:hr.job,job_details:hr.job_cto
59 | #: model_terms:hr.job,job_details:hr.job_developer
60 | #: model_terms:hr.job,job_details:hr.job_hrm
61 | #: model_terms:hr.job,job_details:hr.job_marketing
62 | #: model_terms:hr.job,job_details:hr.job_trainee
63 | msgid "1 Onsite Interview"
64 | msgstr ""
65 |
66 | #. module: hr
67 | #: model_terms:hr.job,job_details:hr.composition
68 | msgid "Zinc"
69 | msgstr ""
70 |
--------------------------------------------------------------------------------
/test_repo/eleven_module/i18n/ugly.po:
--------------------------------------------------------------------------------
1 | # Translation of Odoo Server.
2 | # This file contains the translation of the following modules:
3 | # * hr
4 | #
5 | # Translators:
6 | # Leonardo J. Caballero G. , 2022
7 | # oscaryuu, 2022
8 | # Pedro M. Baeza , 2023
9 | # Martin Trigaux, 2023
10 | #
11 | msgid ""
12 | msgstr ""
13 | "Project-Id-Version: Odoo Server 16.0\n"
14 | "Report-Msgid-Bugs-To: \n"
15 | "POT-Creation-Date: 2023-04-14 05:51+0000\n"
16 | "PO-Revision-Date: 2022-09-22 05:46+0000\n"
17 | "Last-Translator: Martin Trigaux, 2023\n"
18 | "Language-Team: Spanish (https://app.transifex.com/odoo/teams/41243/es/)\n"
19 | "Language: es\n"
20 | "MIME-Version: 1.0\n"
21 | "Content-Type: text/plain; charset=UTF-8\n"
22 | "Content-Transfer-Encoding: \n"
23 | "Plural-Forms: nplurals=3; plural=n == 1 ? 0 : n != 0 && n % 1000000 == 0 ? 1 : 2;\n"
24 |
25 | #. module: hr
26 | #. odoo-python
27 | #: code:addons/hr/models/hr_job.py:0
28 | #, python-format
29 | msgid "%s (copy)"
30 | msgstr "%s (copia)"
31 |
32 | #. module: hr
33 | #: model:ir.model.fields,field_description:hr.field_res_company__hr_presence_control_email_amount
34 | #: model:ir.model.fields,field_description:hr.field_res_config_settings__hr_presence_control_email_amount
35 | msgid "# emails to send"
36 | msgstr "# correos electrónicos por enviar"
37 |
38 | #. module: hr
39 | #. odoo-python
40 | #: code:addons/hr/wizard/hr_plan_wizard.py:0
41 | #, python-format
42 | msgid "%(activity)s, assigned to %(name)s, due on the %(deadline)s"
43 | msgstr ""
44 |
45 | #. module: hr
46 | #: model_terms:ir.ui.view,arch_db:hr.hr_job_view_kanban
47 | msgid " "
48 | msgstr " "
49 |
50 | #. module: hr
51 | #: model:ir.actions.report,print_report_name:hr.hr_employee_print_badge
52 | msgid "'Print Badge - %s' % (object.name).replace('/', '')"
53 | msgstr "'Imprimir insignia - %s' % (object.name).replace('/', '')"
54 |
55 | #. module: hr
56 | #: model_terms:hr.job,job_details:hr.job_ceo
57 | #: model_terms:hr.job,job_details:hr.job_consultant
58 | #: model_terms:hr.job,job_details:hr.job_cto
59 | #: model_terms:hr.job,job_details:hr.job_developer
60 | #: model_terms:hr.job,job_details:hr.job_hrm
61 | #: model_terms:hr.job,job_details:hr.job_marketing
62 | #: model_terms:hr.job,job_details:hr.job_trainee
63 | msgid "1 Onsite Interview"
64 | msgstr "super long translation definitively longer than 78 characters, more like 120 chars, this should be wrapped ...."
65 |
66 | #. module: hr
67 | #: model_terms:hr.job,job_details:hr.composition
68 | msgid "Zinc"
69 | msgstr "Zinc"
70 |
--------------------------------------------------------------------------------
/test_repo/eleven_module/i18n/autofixed_ugly.po:
--------------------------------------------------------------------------------
1 | # Translation of Odoo Server.
2 | # This file contains the translation of the following modules:
3 | # * hr
4 | #
5 | # Translators:
6 | # Leonardo J. Caballero G. , 2022
7 | # oscaryuu, 2022
8 | # Pedro M. Baeza , 2023
9 | # Martin Trigaux, 2023
10 | #
11 | msgid ""
12 | msgstr ""
13 | "Project-Id-Version: Odoo Server 16.0\n"
14 | "Report-Msgid-Bugs-To: \n"
15 | "POT-Creation-Date: 2023-04-14 05:51+0000\n"
16 | "PO-Revision-Date: 2022-09-22 05:46+0000\n"
17 | "Last-Translator: Martin Trigaux, 2023\n"
18 | "Language-Team: Spanish (https://app.transifex.com/odoo/teams/41243/es/)\n"
19 | "Language: es\n"
20 | "MIME-Version: 1.0\n"
21 | "Content-Type: text/plain; charset=UTF-8\n"
22 | "Content-Transfer-Encoding: \n"
23 | "Plural-Forms: nplurals=3; plural=n == 1 ? 0 : n != 0 && n % 1000000 == 0 ? 1 : 2;\n"
24 |
25 | #. module: hr
26 | #: model:ir.model.fields,field_description:hr.field_res_company__hr_presence_control_email_amount
27 | #: model:ir.model.fields,field_description:hr.field_res_config_settings__hr_presence_control_email_amount
28 | msgid "# emails to send"
29 | msgstr "# correos electrónicos por enviar"
30 |
31 | #. module: hr
32 | #. odoo-python
33 | #: code:addons/hr/wizard/hr_plan_wizard.py:0
34 | #, python-format
35 | msgid "%(activity)s, assigned to %(name)s, due on the %(deadline)s"
36 | msgstr ""
37 |
38 | #. module: hr
39 | #. odoo-python
40 | #: code:addons/hr/models/hr_job.py:0
41 | #, python-format
42 | msgid "%s (copy)"
43 | msgstr "%s (copia)"
44 |
45 | #. module: hr
46 | #: model_terms:ir.ui.view,arch_db:hr.hr_job_view_kanban
47 | msgid " "
48 | msgstr ""
49 |
50 | #. module: hr
51 | #: model:ir.actions.report,print_report_name:hr.hr_employee_print_badge
52 | msgid "'Print Badge - %s' % (object.name).replace('/', '')"
53 | msgstr "'Imprimir insignia - %s' % (object.name).replace('/', '')"
54 |
55 | #. module: hr
56 | #: model_terms:hr.job,job_details:hr.job_ceo
57 | #: model_terms:hr.job,job_details:hr.job_consultant
58 | #: model_terms:hr.job,job_details:hr.job_cto
59 | #: model_terms:hr.job,job_details:hr.job_developer
60 | #: model_terms:hr.job,job_details:hr.job_hrm
61 | #: model_terms:hr.job,job_details:hr.job_marketing
62 | #: model_terms:hr.job,job_details:hr.job_trainee
63 | msgid "1 Onsite Interview"
64 | msgstr ""
65 | "super long translation definitively longer than 78 characters, more like 120"
66 | " chars, this should be wrapped ...."
67 |
68 | #. module: hr
69 | #: model_terms:hr.job,job_details:hr.composition
70 | msgid "Zinc"
71 | msgstr ""
72 |
--------------------------------------------------------------------------------
/test_repo/broken_module/model_view_odoo.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | view.model.form
7 | test.model
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | view.model.form
18 | test.model
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 | test.model.tree
29 | test.model
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 | test.model.tree
40 | test.model
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 | test.model.tree
51 | test.model
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
61 | By name
62 | test.model
63 | {'group_by': ['name']}
64 |
65 |
66 |
67 |
68 |
--------------------------------------------------------------------------------
/test_repo/broken_module/pylint_oca_broken.py:
--------------------------------------------------------------------------------
1 |
2 |
3 | import openerp
4 |
5 | from openerp import api
6 | from openerp.api import one, multi
7 |
8 | from openerp.exceptions import Warning as UserError # pylint: disable=W0622
9 | from openerp.exceptions import Warning as OtherName # pylint: disable=W0404
10 | from openerp.exceptions import Warning # pylint: disable=W0404,W0622
11 | from openerp.exceptions import (AccessError as AE, # pylint: disable=W0404
12 | ValidationError,
13 | Warning as UserError2)
14 |
15 |
16 | class snake_case(object):
17 | pass
18 |
19 |
20 | class UseUnusedImport(object):
21 | def method1(self):
22 | return UserError, OtherName, Warning, AE, ValidationError, UserError2
23 |
24 | def inherited_method(self):
25 | # Missing return()
26 | super(UseUnusedImport, self).inherited_method()
27 |
28 | def inherited_method2(self):
29 | # Missing return(), however this is a generator.
30 | for i in super(UseUnusedImport, self).inherited_method2():
31 | yield i
32 | yield 1
33 |
34 | def write(self):
35 | return super(UseUnusedImport, self).write()
36 |
37 |
38 | class ApiOne(object):
39 | @api.one
40 | def copy(self):
41 | # Missing super()
42 | pass
43 |
44 | def create(self):
45 | # Missing super()
46 | pass
47 |
48 | def write(self):
49 | # Missing super()
50 | pass
51 |
52 | def unlink(self):
53 | # Missing super()
54 | pass
55 |
56 | def read(self):
57 | # Missing super()
58 | pass
59 |
60 | def setUp(self):
61 | # Missing super()
62 | pass
63 |
64 | def tearDown(self):
65 | # Missing super()
66 | pass
67 |
68 | def default_get(self):
69 | # Missing super()
70 | pass
71 |
72 |
73 | class One(object):
74 | @one
75 | def copy(self):
76 | return super(One, self).copy()
77 |
78 |
79 | class OpenerpApiOne(object):
80 | @openerp.api.one
81 | def copy(self):
82 | return super(OpenerpApiOne, self).copy()
83 |
84 |
85 | class WOApiOne(object):
86 | # copy without api.one decorator
87 | def copy(self):
88 | return super(WOApiOne, self).copy()
89 |
90 |
91 | class ApiOneMultiTogether(object):
92 |
93 | @api.multi
94 | @api.one
95 | def copy(self):
96 | return super(ApiOneMultiTogether, self).copy()
97 |
98 | @multi
99 | @one
100 | def copy2(self):
101 | return super(ApiOneMultiTogether, self).copy2()
102 |
103 | @openerp.api.multi
104 | @openerp.api.one
105 | def copy3(self):
106 | return super(ApiOneMultiTogether, self).copy3()
107 |
108 | # vim:comment vim
109 |
--------------------------------------------------------------------------------
/tests/test_profiling.py:
--------------------------------------------------------------------------------
1 | import sys
2 | from contextlib import contextmanager
3 | from cProfile import Profile
4 | from glob import glob
5 | from os import environ
6 | from os.path import dirname, join, realpath
7 | from pstats import Stats
8 | from sys import stdout
9 | from unittest import TestCase, skipUnless
10 |
11 | import oca_pre_commit_hooks
12 | from . import common
13 | from .test_checks import EXPECTED_ERRORS as MODULES_ERRORS
14 | from .test_checks_po import EXPECTED_ERRORS as PO_ERRORS
15 |
16 |
17 | @contextmanager
18 | def cprofile():
19 | profiler = Profile()
20 |
21 | profiler.enable()
22 | yield
23 | profiler.disable()
24 |
25 | stats = Stats(profiler, stream=stdout)
26 | stats.strip_dirs()
27 | stats.sort_stats("cumtime")
28 | stats.print_stats()
29 |
30 |
31 | @skipUnless(environ.get("PROFILING"), "Profiling not enabled")
32 | class TestProfiling(TestCase):
33 | @staticmethod
34 | def manifests_from_repo(repo: str):
35 | return glob(join(repo, "**", "__openerp__.py"), recursive=True) + glob(
36 | join(repo, "**", "__manifest__.py"), recursive=True
37 | )
38 |
39 | @staticmethod
40 | def pofiles_from_repo(repo: str):
41 | po_glob_pattern = join(repo, "**", "*.po")
42 | pot_glob_pattern = f"{po_glob_pattern}t"
43 |
44 | return glob(po_glob_pattern, recursive=True) + glob(pot_glob_pattern, recursive=True)
45 |
46 | @classmethod
47 | def setUpClass(cls):
48 | test_repo_path = join(dirname(dirname(realpath(__file__))), "test_repo")
49 |
50 | cls.module_files = cls.manifests_from_repo(test_repo_path)
51 | cls.po_files = cls.pofiles_from_repo(test_repo_path)
52 |
53 | def test_profile_checks_module(self):
54 | checks_module_run = oca_pre_commit_hooks.cli.main
55 | sys.argv = ["", "--no-exit", "--no-verbose"] + self.module_files
56 | with cprofile():
57 | errors = checks_module_run()
58 |
59 | self.assertDictEqual(common.ChecksCommon.get_count_code_errors(errors), MODULES_ERRORS)
60 |
61 | def test_profile_checks_po(self):
62 | checks_po_run = oca_pre_commit_hooks.cli_po.main
63 | sys.argv = ["", "--no-exit", "--no-verbose"] + self.po_files
64 | with cprofile():
65 | errors = checks_po_run()
66 |
67 | self.assertDictEqual(common.ChecksCommon.get_count_code_errors(errors), PO_ERRORS)
68 |
69 | @skipUnless(environ.get("PROFILING_TEST_REPO"), "No custom repository set for profiling")
70 | def test_profile_checks_module_custom(self):
71 | manifests = self.manifests_from_repo(environ.get("PROFILING_TEST_REPO"))
72 | checks_module_run = oca_pre_commit_hooks.cli.main
73 | sys.argv = ["", "--no-exit", "--no-verbose"] + manifests
74 |
75 | print(f"Running oca-checks-odoo-module on {len(manifests)} manifests")
76 | with cprofile():
77 | checks_module_run()
78 |
--------------------------------------------------------------------------------
/test_repo/test_module/i18n/fr.po:
--------------------------------------------------------------------------------
1 | msgid ""
2 | msgstr ""
3 | "Project-Id-Version: Odoo Server\n"
4 | "Report-Msgid-Bugs-To: \n"
5 | "POT-Creation-Date: 1985-04-14 17:12+0000\n"
6 | "PO-Revision-Date: 1985-04-14 02:03+0000\n"
7 | "Last-Translator: Moisés López \n"
8 | "Language-Team: \n"
9 | "MIME-Version: 1.0\n"
10 | "Content-Type: text/plain; charset=UTF-8\n"
11 | "Content-Transfer-Encoding: \n"
12 | "Plural-Forms: \n"
13 |
14 | #. module: test_module
15 | #: model:ir.model.fields,field_description:test_module.field_description
16 | #, python-format
17 | msgid "Branch"
18 | msgstr "Branche"
19 |
20 | #. module: test_module
21 | #: model:ir.model.fields,field_description2:test_module.field_description2
22 | #: model:ir.model.fields,field_description2:test_module.field_description2
23 | #, python-format
24 | msgid "Correct variables %s"
25 | msgstr "Correct variables %s"
26 |
27 | #. module: test_module
28 | #: model:ir.model.fields,field_description5:test_module.field_description5
29 | #: model:ir.model.fields,field_description5:test_module.field_description5
30 | #, python-format
31 | msgid "Correct variables %(variable)s"
32 | msgstr "Correct variables %(variable)s"
33 |
34 | #. module: test_module
35 | #: model:ir.model.fields,field_description3:test_module.field_description3
36 | #: model:ir.model.fields,field_description3:test_module.field_description3
37 | #, python-format
38 | msgid "Correct variables {}"
39 | msgstr "Correct variables {}"
40 |
41 | #. module: test_module
42 | #: model:ir.model.fields,field_description4:test_module.field_description4
43 | #: model:ir.model.fields,field_description4:test_module.field_description4
44 | #, python-format
45 | msgid "Correct variables {variable}"
46 | msgstr "Correct variables {variable}"
47 |
48 | #. module: test_module
49 | #: code:test_module/__init__.py:0
50 | #, python-format
51 | msgid ""
52 | "Multi line valid message!\n"
53 | "{message: %s,\n"
54 | "error code: %s,\n"
55 | "error type: %s,\n"
56 | "request id: %s}"
57 | msgstr ""
58 | "Multi line valid message!\n"
59 | "{message2: %s,\n"
60 | "error code2: %s,\n"
61 | "error type2: %s,\n"
62 | "request id2: %s}"
63 |
64 | #. module: test_module
65 | #: code:test_module/__init__.py:0
66 | #, python-format
67 | msgid ""
68 | "Multi line valid message!\n"
69 | "{message: %s,\n"
70 | msgstr ""
71 | "Multi line valid message!\n"
72 | "{message2: %s,\n"
73 |
74 |
75 | #. module: test_module
76 | #: code:test_module/__init__.py:2
77 | #, python-format
78 | msgid ""
79 | "it must be a literal python dictionary definition e.g. "
80 | "\"{'field': 'value'}\""
81 | msgstr ""
82 | "it must be a literal python dictionary definition e.g. "
83 | "\"{'field_translated': 'value_translated'}\""
84 |
85 | #. module: test_module
86 | #: code:addons/test_module/__init__.py:8
87 | #, python-format
88 | msgid "%s%% discount"
89 | msgstr "%s%%discount without space"
90 |
91 | #. module: test_module
92 | #: code:addons/test_module/__init__.py:10
93 | #, python-format
94 | #~ msgid "Obsolet msgid"
95 | #~ msgstr "Obsolet msgstr"
96 |
--------------------------------------------------------------------------------
/.github/workflows/stale.yml:
--------------------------------------------------------------------------------
1 | name: Mark stale issues and pull requests
2 |
3 | on:
4 | schedule:
5 | - cron: "0 12 * * 0"
6 |
7 | jobs:
8 | stale:
9 | runs-on: ubuntu-latest
10 | steps:
11 | - name: Stale PRs and issues policy
12 | uses: actions/stale@v4
13 | with:
14 | repo-token: ${{ secrets.GITHUB_TOKEN }}
15 | # General settings.
16 | ascending: true
17 | remove-stale-when-updated: true
18 | # Pull Requests settings.
19 | # 120+30 day stale policy for PRs
20 | # * Except PRs marked as "no stale"
21 | days-before-pr-stale: 120
22 | days-before-pr-close: 30
23 | exempt-pr-labels: "no stale"
24 | stale-pr-label: "stale"
25 | stale-pr-message: >
26 | There hasn't been any activity on this pull request in the past 4 months, so
27 | it has been marked as stale and it will be closed automatically if no
28 | further activity occurs in the next 30 days.
29 |
30 | If you want this PR to never become stale, please ask a PSC member to apply
31 | the "no stale" label.
32 | # Issues settings.
33 | # 180+30 day stale policy for open issues
34 | # * Except Issues marked as "no stale"
35 | days-before-issue-stale: 180
36 | days-before-issue-close: 30
37 | exempt-issue-labels: "no stale,needs more information"
38 | stale-issue-label: "stale"
39 | stale-issue-message: >
40 | There hasn't been any activity on this issue in the past 6 months, so it has
41 | been marked as stale and it will be closed automatically if no further
42 | activity occurs in the next 30 days.
43 |
44 | If you want this issue to never become stale, please ask a PSC member to
45 | apply the "no stale" label.
46 |
47 | # 15+30 day stale policy for issues pending more information
48 | # * Issues that are pending more information
49 | # * Except Issues marked as "no stale"
50 | - name: Needs more information stale issues policy
51 | uses: actions/stale@v4
52 | with:
53 | repo-token: ${{ secrets.GITHUB_TOKEN }}
54 | ascending: true
55 | only-labels: "needs more information"
56 | exempt-issue-labels: "no stale"
57 | days-before-stale: 15
58 | days-before-close: 30
59 | days-before-pr-stale: -1
60 | days-before-pr-close: -1
61 | remove-stale-when-updated: true
62 | stale-issue-label: "stale"
63 | stale-issue-message: >
64 | This issue needs more information and there hasn't been any activity
65 | recently, so it has been marked as stale and it will be closed automatically
66 | if no further activity occurs in the next 30 days.
67 |
68 | If you think this is a mistake, please ask a PSC member to remove the "needs
69 | more information" label.
70 |
--------------------------------------------------------------------------------
/tests/test_pre_commit_hook.py:
--------------------------------------------------------------------------------
1 | import os
2 | import subprocess
3 | import sys
4 | import unittest
5 |
6 | from . import common, test_checks, test_checks_po
7 |
8 |
9 | def run_cmd(cmd):
10 | try:
11 | returncode = 0
12 | output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
13 | except subprocess.CalledProcessError as process_error:
14 | returncode = process_error.returncode
15 | output = process_error.output
16 | return (returncode, output.decode(sys.stdout.encoding), " ".join(cmd))
17 |
18 |
19 | class ChecksCommon(unittest.TestCase):
20 | # TODO: Create a tmp repo and run different scenarios
21 |
22 | @classmethod
23 | def setUpClass(cls):
24 | super().setUpClass()
25 | cls.maxDiff = None
26 | top_path = os.path.join(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
27 | cls.pre_commit_hooks_yaml_path = os.path.join(top_path, ".pre-commit-hooks.yaml")
28 | cls.pre_commit_config_yaml_path = os.path.join(top_path, ".pre-commit-config-local.yaml")
29 | with open(cls.pre_commit_hooks_yaml_path, encoding="UTF-8") as f_src, open(
30 | cls.pre_commit_config_yaml_path, "w", encoding="UTF-8"
31 | ) as f_dest:
32 | new_content = f"""
33 | # Do not use this file as example
34 | # It is only to test suite
35 | # Run "pre-commit run -c .pre-commit-config-local.yaml -v --all"
36 | # TODO: Auto-generate from .pre-commit-hooks.yaml
37 | repos:
38 | - repo: local
39 | hooks:
40 | {' '.join(line for line in f_src)}
41 | """
42 | f_dest.write(new_content)
43 |
44 | def setUp(self):
45 | super().setUp()
46 | self.pre_commit_cmd = ["pre-commit", "run", "--color=never", "-avc", self.pre_commit_config_yaml_path]
47 | self.expected_errors = {}
48 |
49 | def test_checks_hook_odoo_module(self):
50 | self.expected_errors = test_checks.EXPECTED_ERRORS.copy()
51 | self.pre_commit_cmd.append("oca-checks-odoo-module")
52 | returncode, output, cmd_str = run_cmd(self.pre_commit_cmd)
53 | self.assertTrue(returncode, f"The process exited with code zero {returncode} {output}")
54 | errors_count = {code: output.count(f": {code} ") for code in self.expected_errors}
55 | common.assertDictEqual(
56 | self, errors_count, self.expected_errors, f"Different result than expected for\n{cmd_str}\n{output}"
57 | )
58 |
59 | def test_checks_hook_po(self):
60 | self.expected_errors = test_checks_po.EXPECTED_ERRORS.copy()
61 | self.pre_commit_cmd.append("oca-checks-po")
62 | returncode, output, cmd_str = run_cmd(self.pre_commit_cmd)
63 | self.assertTrue(returncode, f"The process exited with code zero {returncode} {output}")
64 | errors_count = {code: output.count(code) for code in self.expected_errors}
65 | common.assertDictEqual(
66 | self, errors_count, self.expected_errors, f"Different result than expected for\n{cmd_str}\n{output}"
67 | )
68 |
--------------------------------------------------------------------------------
/.pre-commit-config.yaml:
--------------------------------------------------------------------------------
1 | exclude: |
2 | (?x)
3 | # NOT INSTALLABLE ADDONS
4 | # END NOT INSTALLABLE ADDONS
5 | # Files and folders generated by bots, to avoid loops
6 | ^setup/|/static/description/index\.html$|
7 | # We don't want to mess with tool-generated files
8 | .svg$|/tests/([^/]+/)?cassettes/|^.copier-answers.yml$|^.github/|
9 | # Maybe reactivate this when all README files include prettier ignore tags?
10 | ^README\.md$|
11 | # Library files can have extraneous formatting (even minimized)
12 | /static/(src/)?lib/|
13 | # test_repo is expected to break lints
14 | test_repo/|
15 | # Repos using Sphinx to generate docs don't need prettying
16 | ^docs/_templates/.*\.html$|
17 | # You don't usually want a bot to modify your legal texts
18 | (LICENSE.*|COPYING.*)
19 | default_language_version:
20 | python: python3
21 | node: "16.17.0"
22 | repos:
23 | - repo: local
24 | hooks:
25 | # These files are most likely copier diff rejection junks; if found,
26 | # review them manually, fix the problem (if needed) and remove them
27 | - id: forbidden-files
28 | name: forbidden files
29 | entry: found forbidden files; remove them
30 | language: fail
31 | files: "\\.rej$"
32 | - repo: https://github.com/myint/autoflake
33 | rev: v2.3.1
34 | hooks:
35 | - id: autoflake
36 | args:
37 | - --expand-star-imports
38 | - --ignore-init-module-imports
39 | - --in-place
40 | - --remove-all-unused-imports
41 | - --remove-duplicate-keys
42 | - --remove-unused-variables
43 | - repo: https://github.com/psf/black
44 | rev: 24.3.0
45 | hooks:
46 | - id: black
47 | - repo: https://github.com/pre-commit/pre-commit-hooks
48 | rev: v4.5.0
49 | hooks:
50 | - id: trailing-whitespace
51 | - id: end-of-file-fixer
52 | - id: debug-statements
53 | - id: fix-encoding-pragma
54 | args: ["--remove"]
55 | - id: check-case-conflict
56 | - id: check-docstring-first
57 | - id: check-executables-have-shebangs
58 | - id: check-merge-conflict
59 | # exclude files where underlines are not distinguishable from merge conflicts
60 | exclude: /README\.rst$|^docs/.*\.rst$
61 | - id: check-symlinks
62 | - id: check-xml
63 | - id: mixed-line-ending
64 | args: ["--fix=lf"]
65 | - repo: https://github.com/asottile/pyupgrade
66 | rev: v3.15.2
67 | hooks:
68 | - id: pyupgrade
69 | args: ["--keep-percent-format"]
70 | - repo: https://github.com/PyCQA/isort
71 | rev: 5.13.2
72 | hooks:
73 | - id: isort
74 | name: isort except __init__.py
75 | args:
76 | - --settings=.
77 | exclude: /__init__\.py$
78 | - repo: https://github.com/PyCQA/flake8
79 | rev: 7.0.0
80 | hooks:
81 | - id: flake8
82 | name: flake8
83 | additional_dependencies: ["flake8-bugbear==24.2.6"]
84 | - repo: https://github.com/PyCQA/pylint
85 | rev: v3.1.0
86 | hooks:
87 | - id: pylint
88 |
--------------------------------------------------------------------------------
/src/oca_pre_commit_hooks/checks_odoo_module_csv.py:
--------------------------------------------------------------------------------
1 | import csv
2 | import os
3 | from collections import defaultdict
4 | from typing import Sequence, Set, Union
5 |
6 | from oca_pre_commit_hooks import utils
7 | from oca_pre_commit_hooks.base_checker import BaseChecker
8 |
9 |
10 | class ChecksOdooModuleCSV(BaseChecker):
11 | def __init__(
12 | self,
13 | manifest_datas: Union[Sequence, None] = None,
14 | module_name: str = None,
15 | enable: Union[Set, None] = None,
16 | disable: Union[Set, None] = None,
17 | ):
18 | super().__init__(enable, disable, module_name)
19 |
20 | self.manifest_datas = manifest_datas or []
21 | for manifest_data in manifest_datas:
22 | manifest_data.update(
23 | {
24 | "model": os.path.splitext(os.path.basename(manifest_data["filename"]))[0],
25 | }
26 | )
27 |
28 | @utils.only_required_for_checks("csv-syntax-error", "csv-duplicate-record-id")
29 | def check_csv(self):
30 | """* Check csv-duplicate-record-id
31 | duplicate CSV "id" AKA xmlid but for CSV files
32 |
33 | * Check csv-syntax-error
34 | Check syntax error for CSV files declared in the manifest
35 | """
36 | csvids = defaultdict(list)
37 | for manifest_data in self.manifest_datas:
38 | try:
39 | with open(manifest_data["filename"], encoding="UTF-8") as f_csv:
40 | csv_r = csv.DictReader(f_csv)
41 | if not csv_r or "id" not in csv_r.fieldnames:
42 | continue
43 | for record in csv_r:
44 | record_id = record["id"]
45 | csvid = f"{manifest_data['data_section']}/{record_id}"
46 | csvids[csvid].append(
47 | (
48 | manifest_data["filename_short"],
49 | csv_r.line_num,
50 | record_id,
51 | )
52 | )
53 | except (FileNotFoundError, csv.Error, UnicodeDecodeError) as csv_err:
54 | if self.is_message_enabled("csv-syntax-error"):
55 | self.register_error(
56 | code="csv-syntax-error",
57 | message=str(csv_err),
58 | filepath=manifest_data["filename_short"],
59 | line=1,
60 | )
61 |
62 | if self.is_message_enabled("csv-duplicate-record-id"):
63 | for __, records in csvids.items():
64 | if len(records) < 2:
65 | continue
66 | filepath, line, record_id = records[0]
67 | self.register_error(
68 | code="csv-duplicate-record-id",
69 | message=f"Duplicate CSV record `{record_id}`",
70 | filepath=filepath,
71 | line=line,
72 | extra_positions=[(other_filepath, other_line) for other_filepath, other_line, __ in records[1:]],
73 | )
74 |
--------------------------------------------------------------------------------
/test_repo/broken_module/i18n/es.po:
--------------------------------------------------------------------------------
1 | msgid ""
2 | msgstr ""
3 | "Project-Id-Version: Odoo Server\n"
4 | "Report-Msgid-Bugs-To: \n"
5 | "POT-Creation-Date: 1985-04-14 17:12+0000\n"
6 | "PO-Revision-Date: 1985-04-14 02:03+0000\n"
7 | "Last-Translator: Moisés López \n"
8 | "Language-Team: \n"
9 | "MIME-Version: 1.0\n"
10 | "Content-Type: text/plain; charset=UTF-8\n"
11 | "Content-Transfer-Encoding: \n"
12 | "Plural-Forms: \n"
13 |
14 | #. module: broken_module
15 | #: model:ir.model.fields,field_description:broken_module.field_wizard_description
16 | #, python-format
17 | msgid "Branch"
18 | msgstr ""
19 |
20 | #. module: broken_module
21 | #: model:ir.model.fields,field_description:broken_module.field_description
22 | #, python-format
23 | msgid "Branch"
24 | msgstr ""
25 |
26 | #. module: broken_module
27 | #: model:ir.model.fields,field_description:broken_module.field_wizard_description
28 | #, python-format
29 | msgid "Branch"
30 | msgstr ""
31 |
32 | #. module: broken_module
33 | #: model:ir.model.fields,field_description2:broken_module.field_wizard_description2
34 | #, python-format
35 | msgid "Message id toooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo laaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaarge"
36 | msgstr ""
37 |
38 | #. module: broken_module
39 | #: model:ir.model.fields,field_description2:broken_module.field_wizard_description2
40 | #, python-format
41 | msgid "Message id toooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo laaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaarge"
42 | msgstr ""
43 |
44 | #. module: broken_module
45 | #: model:ir.model.fields,field_description3:broken_module.field_wizard_description3
46 | #, python-format
47 | msgid "Two variables %s %s"
48 | msgstr "Translated just one %s"
49 |
50 | #. module: broken_module
51 | #: model:ir.model.fields,field_description4:broken_module.field_wizard_description4
52 | #, python-format
53 | msgid "One variable {}"
54 | msgstr "Translated 2 {} {}"
55 |
56 | #. module: broken_module
57 | #: model:ir.model.fields,field_description5:broken_module.field_wizard_description5
58 | #, python-format
59 | msgid "One variable {0}"
60 | msgstr "Translated 2 {0} {1}"
61 |
62 | #. module: broken_module
63 | #: model:ir.model.fields,field_description5:broken_module.field_wizard_description5
64 | #, python-format
65 | msgid "One variable {variable1}"
66 | msgstr "Translated 2 {variable1} {variable2}"
67 |
68 | #. module: broken_module
69 | #: model:ir.model.fields,field_description10:broken_module.field_wizard_description10
70 | #, python-format
71 | msgid "One variable {variable1}"
72 | msgstr "Translated other one {variable2}"
73 |
74 | #. module: broken_module
75 | #: model:ir.model.fields,field_description6:broken_module.field_wizard_description6
76 | #, python-format
77 | msgid "It is a mistake"
78 | msgstr "but without raising an error %s"
79 |
80 | #. module: broken_module
81 | #: model:ir.model.fields,field_description7:broken_module.field_wizard_description7
82 | #, python-format
83 | msgid "Same quantity of variables but different variable %s"
84 | msgstr "Same quantity of variables but different variable %d"
85 |
86 | #. module: broken_module
87 | #: model:ir.model.fields,field_description8:broken_module.field_wizard_description8
88 | #, no-python-format
89 | msgid "String variables error but it is not a python format %s"
90 | msgstr "String variables error but it is not a python format"
91 |
--------------------------------------------------------------------------------
/src/oca_pre_commit_hooks/base_checker.py:
--------------------------------------------------------------------------------
1 | from typing import List, NamedTuple, Set, Tuple, Union
2 |
3 | from colorama import Fore, Style
4 |
5 |
6 | class FilePosition(NamedTuple):
7 | filepath: str
8 | line: int = 0
9 | column: int = 0
10 |
11 | def to_string(self, separator: str = ":") -> str:
12 | return separator.join(str(x) for x in iter(self) if x)
13 |
14 | def __str__(self):
15 | return self.to_string()
16 |
17 |
18 | class CheckerError(NamedTuple):
19 | position: FilePosition
20 | code: str
21 | message: str
22 | info: Union[str, None] = None
23 | extra_positions: Union[List[FilePosition], None] = None
24 |
25 | def to_string(self):
26 | # File position with a styled separator
27 | res = Style.BRIGHT + Fore.RESET
28 | res += self.position.to_string(separator=Fore.CYAN + ":" + Style.RESET_ALL)
29 | res += Style.RESET_ALL
30 | # Extra styled separator
31 | res += Fore.CYAN + ":" + Style.RESET_ALL
32 | # Code
33 | res += " "
34 | res += Style.BRIGHT + Fore.RED + self.code + Style.RESET_ALL
35 | # Message
36 | res += " "
37 | res += self.message
38 | # Extra positions
39 | if self.extra_positions:
40 | res += "\n"
41 | res += Fore.YELLOW
42 | res += "\n".join(str(x) for x in iter(self.extra_positions))
43 | res += Style.RESET_ALL
44 | # Optional info
45 | if self.info:
46 | res += "\n"
47 | res += Style.DIM
48 | res += self.info
49 | res += Style.RESET_ALL
50 | return res
51 |
52 | def __str__(self):
53 | return self.to_string()
54 |
55 |
56 | class BaseChecker:
57 | def __init__(
58 | self,
59 | enable: Set[str],
60 | disable: Set[str],
61 | module_name: Union[str, None] = None,
62 | module_version: Union[str, None] = None,
63 | autofix: bool = False,
64 | ):
65 | self.enable = enable
66 | self.disable = disable
67 | self.autofix = autofix
68 | self.module_name = module_name
69 | self.module_version = module_version
70 |
71 | self.checks_errors = []
72 | self.needs_autofix = False
73 |
74 | def is_message_enabled(self, message: str, extra_disable: Union[Set[str], None] = None):
75 | if extra_disable and message in extra_disable:
76 | return False
77 | if self.enable:
78 | return message in self.enable
79 | if self.disable:
80 | return message not in self.disable
81 |
82 | return True
83 |
84 | def register_error(
85 | self,
86 | code: str,
87 | message: str,
88 | filepath: str,
89 | line: int = 0,
90 | column: int = 0,
91 | info: Union[str, None] = None,
92 | extra_positions: Union[List[Tuple[str, int, int]], None] = None,
93 | ):
94 | self.checks_errors.append(
95 | CheckerError(
96 | position=FilePosition(filepath, line, column),
97 | code=code,
98 | message=message,
99 | info=info,
100 | extra_positions=[FilePosition(*x) for x in extra_positions] if extra_positions else None,
101 | )
102 | )
103 |
--------------------------------------------------------------------------------
/src/oca_pre_commit_hooks/checks_odoo_module_fixit/manifest_superfluous_key_rule.py:
--------------------------------------------------------------------------------
1 | import libcst as cst
2 | from fixit import InvalidTestCase, ValidTestCase
3 |
4 | from .. import checks_odoo_module_fixit_common as common
5 |
6 |
7 | class ManifestSuperfluousKeyRule(common.Common):
8 | """Identifies and removes
9 | Identifies from Odoo manifest files (__manifest__.py) superfluous keys
10 | (if they have the same as the default value) should be omitted for simplicity
11 |
12 | e.g. 'installable': True
13 | `True` is the default value for installable key
14 |
15 | e.g. 'data': []
16 | `[]` is the default value for 'data' key
17 | """
18 |
19 | INVALID = [
20 | InvalidTestCase(
21 | code="""
22 | {
23 | 'installable': True,
24 | 'depends': [],
25 | 'author': '',
26 | 'name': 'My Module',
27 | }
28 | """,
29 | expected_replacement="""
30 | {
31 | 'name': 'My Module',
32 | }
33 | """,
34 | ),
35 | InvalidTestCase(
36 | code="""
37 | {
38 | 'installable': True,
39 | 'name': 'Another Module',
40 | }
41 | """,
42 | expected_replacement="""
43 | {
44 | 'name': 'Another Module',
45 | }
46 | """,
47 | ),
48 | InvalidTestCase(
49 | code="""
50 | {
51 | "active": True,
52 | "installable": (
53 | True),
54 | "auto_install": (
55 | False),
56 | "name": "hello",
57 | }
58 | """,
59 | expected_replacement="""
60 | {
61 | "name": "hello",
62 | }
63 | """,
64 | ),
65 | ]
66 |
67 | VALID = [
68 | ValidTestCase(
69 | code="""
70 | {
71 | 'name': 'My Module',
72 | 'depends': ['base'],
73 | 'installable': False,
74 | 'active': False,
75 | }
76 | """
77 | ),
78 | ValidTestCase(
79 | code="""
80 | {
81 | 'name': 'My Module',
82 | 'depends': ['base'],
83 | }
84 | """
85 | ),
86 | ]
87 |
88 | manifest_keys_values_true = ["active", "installable"]
89 |
90 | def __init__(self) -> None:
91 | super().__init__()
92 | self.name = "manifest-superfluous-key"
93 |
94 | def visit_DictElement(self, node: cst.DictElement) -> None: # pylint:disable=invalid-name
95 | if not isinstance(node.key, cst.SimpleString):
96 | return
97 | if (
98 | (isinstance(node.value, cst.List) and not node.value.elements)
99 | or (isinstance(node.value, cst.SimpleString) and not node.value.evaluated_value)
100 | or (
101 | node.key.evaluated_value in self.manifest_keys_values_true
102 | and isinstance(node.value, cst.Name)
103 | and node.value.value == "True"
104 | )
105 | or (
106 | # boolean keys are `False` by default, only the ones listed in
107 | # `manifest_keys_values_true` are treated as `True` by default
108 | node.key.evaluated_value not in self.manifest_keys_values_true
109 | and isinstance(node.value, cst.Name)
110 | and node.value.value == "False"
111 | )
112 | ):
113 | self.report(
114 | node,
115 | "Delete empty values.",
116 | replacement=cst.RemoveFromParent(),
117 | )
118 |
--------------------------------------------------------------------------------
/.github/workflows/test.yml:
--------------------------------------------------------------------------------
1 | name: build
2 | on:
3 | push:
4 | branches:
5 | - main
6 | tags:
7 | - 'v*'
8 | pull_request:
9 | branches:
10 | - main
11 |
12 | env:
13 | CACHE_VERSION: 1
14 | PRE_COMMIT_CACHE: ~/.cache/pre-commit
15 |
16 | jobs:
17 | test:
18 | runs-on: ${{ matrix.os }}
19 | timeout-minutes: 30
20 | strategy:
21 | fail-fast: false
22 | matrix:
23 | python: ['3.10', '3.11', '3.12', '3.13']
24 | os: [ubuntu-latest, windows-latest, macos-13, macos-latest]
25 | tox_env: ["py"]
26 | include:
27 | - python: '3.13'
28 | os: ubuntu-latest
29 | tox_env: 'lint'
30 | - python: '3.13'
31 | os: ubuntu-latest
32 | tox_env: 'update-readme'
33 | - python: '3.13'
34 | os: ubuntu-latest
35 | tox_env: 'build'
36 | - python: '3.13'
37 | os: ubuntu-latest
38 | tox_env: 'cprofile'
39 | - python: '3.14-dev'
40 | os: ubuntu-latest
41 | tox_env: 'py'
42 | exclude:
43 | - python: '3.10'
44 | os: macos-latest
45 |
46 | steps:
47 | - name: Set git to not change EoL
48 | if: runner.os == 'Windows'
49 | run: |
50 | git config --global core.autocrlf false
51 | - name: Cache pre-commit packages
52 | id: cache-pre-commit
53 | uses: actions/cache@v4
54 | with:
55 | path: ${{ env.PRE_COMMIT_CACHE }}
56 | key: ${{ runner.os }}-${{ runner.arch }}-py${{ matrix.python }}-pre-commit
57 | - uses: actions/checkout@v4
58 | with:
59 | fetch-depth: 0
60 | - uses: actions/setup-python@v5
61 | with:
62 | python-version: ${{ matrix.python }}
63 | architecture: 'x64'
64 | cache: 'pip'
65 | - name: Install system dependencies (Linux only)
66 | if: runner.os == 'Linux'
67 | run: |
68 | sudo apt-get update -qqq
69 | sudo apt-get install -y libxml2-dev libxslt1-dev zlib1g-dev
70 | - name: install dependencies
71 | run: |
72 | python -mpip install --progress-bar=off -r test-requirements.txt
73 | pip --version
74 | pip list --format=freeze
75 | - name: Test
76 | run: tox -e ${{ matrix.tox_env }} -v
77 | # TODO: Publish package only for signed tags
78 | - name: Publish package
79 | if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') && contains(matrix.tox_env, 'build')
80 | run: |
81 | ls -lah dist/*
82 | python -m twine upload --verbose -u __token__ -p ${{ secrets.PYPI_API_TOKEN }} --repository-url https://upload.pypi.org/legacy/ dist/*
83 | # TODO: Add GITHUB_RUN_ID.GITHUB_RUN_ATTEMPT.GITHUB_RUN_NUMBER to bumpversion to avoid duplicating upload versions or even the git sha
84 | # For now, feel free to uncomment this line of code to test things related to upload to pypi (test)
85 | # - name: TestPyPI publish package
86 | # if: runner.os == 'Linux' && startsWith(matrix.tox_env, 'py39-cover')
87 | # run: >-
88 | # python -m twine upload --verbose -u __token__ -p ${{ secrets.PYPI_TEST_API_TOKEN }} \
89 | # --repository-url https://test.pypi.org/legacy/ dist/* || true
90 | - name: codecov
91 | if: startsWith(matrix.tox_env, 'py') # only coveralls in python tests
92 | uses: codecov/codecov-action@v5
93 | with:
94 | fail_ci_if_error: true
95 | verbose: true
96 | token: ${{ secrets.CODECOV_TOKEN }}
97 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | import re
4 | from glob import glob
5 | from os.path import basename, dirname, join, splitext
6 |
7 | from setuptools import find_packages, setup
8 |
9 | try:
10 | from pbr import git
11 | except ImportError:
12 | git = None
13 |
14 |
15 | def generate_changelog():
16 | fname = "ChangeLog"
17 | if not git:
18 | changelog_str = '# ChangeLog was not generated. You need to install "pbr"'
19 | with open(fname, "w", encoding="UTF-8") as fchg:
20 | fchg.write(changelog_str)
21 | return changelog_str
22 | # pylint: disable=protected-access
23 | changelog = git._iter_log_oneline()
24 | changelog = git._iter_changelog(changelog)
25 | git.write_git_changelog(changelog=filter(lambda log: not log[1].startswith("* Bump version"), changelog))
26 | return read(fname)
27 |
28 |
29 | def generate_dependencies():
30 | return read("requirements.txt").splitlines()
31 |
32 |
33 | def read(*names, **kwargs):
34 | with open(join(dirname(__file__), *names), encoding=kwargs.get("encoding", "utf8")) as file_obj:
35 | return file_obj.read()
36 |
37 |
38 | def generage_long_description():
39 | long_description = "{}\n{}".format(
40 | # re.compile(".*\(start-badges\).*^.*\(end-badges\)", re.M | re.S).sub("", read("README.md")),
41 | read("README.md"),
42 | re.sub(":[a-z]+:`~?(.*?)`", r"``\1``", generate_changelog()),
43 | )
44 | return long_description
45 |
46 |
47 | setup(
48 | name="oca-odoo-pre-commit-hooks",
49 | version="0.2.2",
50 | license="LGPL-3.0-or-later",
51 | description="odoo-pre-commit-hooks to use in pre-commit-config.yml files",
52 | long_description=generage_long_description(),
53 | long_description_content_type="text/markdown",
54 | author="Odoo Community Association (OCA)",
55 | author_email="support@odoo-community.org",
56 | url="https://github.com/OCA/odoo-pre-commit-hooks",
57 | packages=find_packages("src"),
58 | package_dir={"": "src"},
59 | data_files=[("requirements", ["requirements.txt"])],
60 | py_modules=[splitext(basename(path))[0] for path in glob("src/*.py")],
61 | include_package_data=True,
62 | zip_safe=False,
63 | classifiers=[
64 | # complete classifier list: http://pypi.python.org/pypi?%3Aaction=list_classifiers
65 | "Development Status :: 5 - Production/Stable",
66 | "Intended Audience :: Developers",
67 | "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
68 | "Operating System :: Unix",
69 | "Operating System :: POSIX",
70 | "Operating System :: Microsoft :: Windows",
71 | "Operating System :: MacOS",
72 | "Programming Language :: Python :: 3",
73 | "Programming Language :: Python :: 3.10",
74 | "Programming Language :: Python :: 3.11",
75 | "Programming Language :: Python :: 3.12",
76 | "Programming Language :: Python :: 3.13",
77 | "Programming Language :: Python :: 3.14",
78 | "Topic :: Utilities",
79 | ],
80 | project_urls={
81 | "Issue Tracker": "https://github.com/OCA/odoo-pre-commit-hooks/issues",
82 | },
83 | keywords=[
84 | "pre-commit",
85 | "OCA",
86 | "Odoo Community Association",
87 | "pre-commit-hook",
88 | ],
89 | python_requires=">=3.9",
90 | install_requires=generate_dependencies(),
91 | extras_require={},
92 | entry_points={
93 | "console_scripts": [
94 | "oca-checks-odoo-module = oca_pre_commit_hooks.cli:main",
95 | "oca-checks-po = oca_pre_commit_hooks.cli_po:main",
96 | ]
97 | },
98 | )
99 |
--------------------------------------------------------------------------------
/src/oca_pre_commit_hooks/global_parser.py:
--------------------------------------------------------------------------------
1 | import argparse
2 | import configparser
3 | from os import environ, getcwd
4 | from os.path import isfile, join
5 |
6 | from oca_pre_commit_hooks.utils import top_path
7 |
8 | CONFIG_NAME = ".oca_hooks.cfg"
9 | MSG_CTRL = "MESSAGES_CONTROL"
10 |
11 | ENABLE_ENV_VAR = "OCA_HOOKS_ENABLE"
12 | DISABLE_ENV_VAR = "OCA_HOOKS_DISABLE"
13 |
14 |
15 | def parse_csv(comma_sep_str):
16 | return set(map(str.strip, comma_sep_str.split(",")))
17 |
18 |
19 | class GlobalParser(argparse.ArgumentParser):
20 | def __init__(self):
21 | super().__init__()
22 | self.add_argument(
23 | "--no-verbose",
24 | action="store_true",
25 | default=False,
26 | help="If enabled so disable verbose mode.",
27 | )
28 | self.add_argument(
29 | "--no-exit",
30 | action="store_true",
31 | default=False,
32 | help="If enabled so it will not call exit.",
33 | )
34 | self.add_argument(
35 | "--disable",
36 | "-d",
37 | type=parse_csv,
38 | default=self._default_env_csv(DISABLE_ENV_VAR),
39 | help="Disable the checker with the given 'check-name', separated by commas.",
40 | )
41 | self.add_argument(
42 | "--enable",
43 | "-e",
44 | type=parse_csv,
45 | default=self._default_env_csv(ENABLE_ENV_VAR),
46 | help=(
47 | "Enable the checker with the given 'check-name', separated by commas. "
48 | "Default: All checks are enabled by default"
49 | ),
50 | )
51 | self.add_argument(
52 | "--config",
53 | "-c",
54 | type=str,
55 | help=f"Path to a configuration file (default: {CONFIG_NAME})",
56 | )
57 | self.add_argument(
58 | "--list-msgs", default=False, action="store_true", help="List all currently enabled messages."
59 | )
60 | self.add_argument(
61 | "--fix",
62 | action="store_true",
63 | dest="autofix",
64 | help="Automatically fix files when possible",
65 | )
66 |
67 | @staticmethod
68 | def _default_env_csv(env_var):
69 | if environ.get(env_var, False):
70 | return parse_csv(environ[env_var])
71 |
72 | return set()
73 |
74 | def parse_args(self, args=None, namespace=None):
75 | res = super().parse_args(args)
76 |
77 | if not res.config:
78 | if isfile(join(getcwd(), CONFIG_NAME)):
79 | res.config = join(getcwd(), CONFIG_NAME)
80 | elif isfile(join(top_path(getcwd()), CONFIG_NAME)):
81 | # TODO: Add unittest creating a new git repo
82 | res.config = join(top_path(getcwd()), CONFIG_NAME) # pragma: no cover
83 |
84 | if res.config:
85 | conf = configparser.ConfigParser()
86 | with open(res.config, encoding="UTF-8") as f_cfg:
87 | conf.read_file(f_cfg)
88 |
89 | if conf.has_section(MSG_CTRL):
90 | message_conf = conf[MSG_CTRL]
91 | # --arguments takes precedence over config file
92 | if not res.enable and message_conf.get("enable"):
93 | res.enable = parse_csv(message_conf.get("enable"))
94 | if not res.disable and message_conf.get("disable"):
95 | res.disable = parse_csv(message_conf.get("disable"))
96 |
97 | # Not expected/used by any other program component as of now.
98 | delattr(res, "config")
99 | return res
100 |
--------------------------------------------------------------------------------
/src/oca_pre_commit_hooks/checks_odoo_module_fixit/prefer_env_translation.py:
--------------------------------------------------------------------------------
1 | import os
2 |
3 | import libcst as cst
4 | from fixit import InvalidTestCase, ValidTestCase
5 | from libcst.metadata import QualifiedName, QualifiedNameProvider
6 |
7 | from .. import checks_odoo_module_fixit_common as common, utils
8 |
9 |
10 | class PreferEnvTranslationRule(common.Common):
11 | """Replace `_('text')` with `self.env._('text')` only if '_' comes from 'odoo._'
12 | and only for modules >=18.0"""
13 |
14 | MESSAGE = "Use self.env._(...) instead of _(…) directly inside Odoo model methods."
15 | METADATA_DEPENDENCIES = (QualifiedNameProvider,)
16 | VALID = [
17 | ValidTestCase(
18 | code="""
19 | from odoo import models, _
20 |
21 |
22 | class TestModel(models.Model):
23 | def my_method(self):
24 | self.env._("ok")
25 | """
26 | ),
27 | ValidTestCase(
28 | code="""
29 | from gettext import gettext as _
30 |
31 |
32 | def outside_model():
33 | _("not Odoo")
34 | """
35 | ),
36 | ValidTestCase(
37 | code="""
38 | _ = lambda *a: True
39 |
40 |
41 | class TestModel(models.Model):
42 | def my_method(self):
43 | _("is not a Odoo translation")
44 | """
45 | ),
46 | ]
47 |
48 | INVALID = [
49 | InvalidTestCase(
50 | code="""
51 | from odoo import models, _
52 |
53 |
54 | class TestModel(models.Model):
55 | def my_method(self):
56 | _("old translated")
57 | """,
58 | expected_replacement="""
59 | from odoo import models, _
60 |
61 |
62 | class TestModel(models.Model):
63 | def my_method(self):
64 | self.env._("old translated")
65 | """,
66 | ),
67 | InvalidTestCase(
68 | code="""
69 | from odoo import models, _ as lt
70 |
71 |
72 | class TestModel(models.Model):
73 | def my_method(self):
74 | lt("old translated")
75 | """,
76 | expected_replacement="""
77 | from odoo import models, _ as lt
78 |
79 |
80 | class TestModel(models.Model):
81 | def my_method(self):
82 | self.env._("old translated")
83 | """,
84 | ),
85 | ]
86 |
87 | def __init__(self) -> None:
88 | super().__init__()
89 | self.name = "prefer-env-translation"
90 | self.odoo_version = utils.str2version(os.getenv("FIXIT_ODOO_VERSION", ""))
91 | self.odoo_min_version = utils.str2version("18.0")
92 |
93 | def visit_Call(self, node: cst.Call) -> None: # noqa: B906 pylint:disable=invalid-name
94 | if not self.odoo_version:
95 | print(
96 | f"WARNING. Invalid manifest versions format ({self.odoo_version}). "
97 | f"It was not possible if {self.name} rule applies but even running",
98 | )
99 | self.odoo_version = self.odoo_min_version # Set default min version to run the check
100 | if not isinstance(node.func, cst.Name):
101 | return
102 | if self.odoo_min_version > self.odoo_version:
103 | return
104 | qualified_names = self.get_metadata(QualifiedNameProvider, node.func, set())
105 | for qname in qualified_names:
106 | if isinstance(qname, QualifiedName) and (
107 | qname.name.startswith("odoo._") or qname.name.startswith("openerp._")
108 | ):
109 | replacement = self.fix(node)
110 | self.report(node, replacement=replacement)
111 | break
112 |
113 | def fix(self, node: cst.Call) -> cst.Call:
114 | return node.with_changes(
115 | func=cst.Attribute(
116 | value=cst.Attribute(
117 | value=cst.Name("self"),
118 | attr=cst.Name("env"),
119 | ),
120 | attr=cst.Name("_"),
121 | )
122 | )
123 |
--------------------------------------------------------------------------------
/.eslintrc.yml:
--------------------------------------------------------------------------------
1 | env:
2 | browser: true
3 | es6: true
4 |
5 | # See https://github.com/OCA/odoo-community.org/issues/37#issuecomment-470686449
6 | parserOptions:
7 | ecmaVersion: 2019
8 |
9 | overrides:
10 | - files:
11 | - "**/*.esm.js"
12 | parserOptions:
13 | sourceType: module
14 |
15 | # Globals available in Odoo that shouldn't produce errorings
16 | globals:
17 | _: readonly
18 | $: readonly
19 | fuzzy: readonly
20 | jQuery: readonly
21 | moment: readonly
22 | odoo: readonly
23 | openerp: readonly
24 | owl: readonly
25 |
26 | # Styling is handled by Prettier, so we only need to enable AST rules;
27 | # see https://github.com/OCA/maintainer-quality-tools/pull/618#issuecomment-558576890
28 | rules:
29 | accessor-pairs: warn
30 | array-callback-return: warn
31 | callback-return: warn
32 | capitalized-comments:
33 | - warn
34 | - always
35 | - ignoreConsecutiveComments: true
36 | ignoreInlineComments: true
37 | complexity:
38 | - warn
39 | - 15
40 | constructor-super: warn
41 | dot-notation: warn
42 | eqeqeq: warn
43 | global-require: warn
44 | handle-callback-err: warn
45 | id-blacklist: warn
46 | id-match: warn
47 | init-declarations: error
48 | max-depth: warn
49 | max-nested-callbacks: warn
50 | max-statements-per-line: warn
51 | no-alert: warn
52 | no-array-constructor: warn
53 | no-caller: warn
54 | no-case-declarations: warn
55 | no-class-assign: warn
56 | no-cond-assign: error
57 | no-const-assign: error
58 | no-constant-condition: warn
59 | no-control-regex: warn
60 | no-debugger: error
61 | no-delete-var: warn
62 | no-div-regex: warn
63 | no-dupe-args: error
64 | no-dupe-class-members: error
65 | no-dupe-keys: error
66 | no-duplicate-case: error
67 | no-duplicate-imports: error
68 | no-else-return: warn
69 | no-empty-character-class: warn
70 | no-empty-function: error
71 | no-empty-pattern: error
72 | no-empty: warn
73 | no-eq-null: error
74 | no-eval: error
75 | no-ex-assign: error
76 | no-extend-native: warn
77 | no-extra-bind: warn
78 | no-extra-boolean-cast: warn
79 | no-extra-label: warn
80 | no-fallthrough: warn
81 | no-func-assign: error
82 | no-global-assign: error
83 | no-implicit-coercion:
84 | - warn
85 | - allow: ["~"]
86 | no-implicit-globals: warn
87 | no-implied-eval: warn
88 | no-inline-comments: warn
89 | no-inner-declarations: warn
90 | no-invalid-regexp: warn
91 | no-irregular-whitespace: warn
92 | no-iterator: warn
93 | no-label-var: warn
94 | no-labels: warn
95 | no-lone-blocks: warn
96 | no-lonely-if: error
97 | no-mixed-requires: error
98 | no-multi-str: warn
99 | no-native-reassign: error
100 | no-negated-condition: warn
101 | no-negated-in-lhs: error
102 | no-new-func: warn
103 | no-new-object: warn
104 | no-new-require: warn
105 | no-new-symbol: warn
106 | no-new-wrappers: warn
107 | no-new: warn
108 | no-obj-calls: warn
109 | no-octal-escape: warn
110 | no-octal: warn
111 | no-param-reassign: warn
112 | no-path-concat: warn
113 | no-process-env: warn
114 | no-process-exit: warn
115 | no-proto: warn
116 | no-prototype-builtins: warn
117 | no-redeclare: warn
118 | no-regex-spaces: warn
119 | no-restricted-globals: warn
120 | no-restricted-imports: warn
121 | no-restricted-modules: warn
122 | no-restricted-syntax: warn
123 | no-return-assign: error
124 | no-script-url: warn
125 | no-self-assign: warn
126 | no-self-compare: warn
127 | no-sequences: warn
128 | no-shadow-restricted-names: warn
129 | no-shadow: warn
130 | no-sparse-arrays: warn
131 | no-sync: warn
132 | no-this-before-super: warn
133 | no-throw-literal: warn
134 | no-undef-init: warn
135 | no-undef: error
136 | no-unmodified-loop-condition: warn
137 | no-unneeded-ternary: error
138 | no-unreachable: error
139 | no-unsafe-finally: error
140 | no-unused-expressions: error
141 | no-unused-labels: error
142 | no-unused-vars: error
143 | no-use-before-define: error
144 | no-useless-call: warn
145 | no-useless-computed-key: warn
146 | no-useless-concat: warn
147 | no-useless-constructor: warn
148 | no-useless-escape: warn
149 | no-useless-rename: warn
150 | no-void: warn
151 | no-with: warn
152 | operator-assignment: [error, always]
153 | prefer-const: warn
154 | radix: warn
155 | require-yield: warn
156 | sort-imports: warn
157 | spaced-comment: [error, always]
158 | strict: [error, function]
159 | use-isnan: error
160 | valid-jsdoc:
161 | - warn
162 | - prefer:
163 | arg: param
164 | argument: param
165 | augments: extends
166 | constructor: class
167 | exception: throws
168 | func: function
169 | method: function
170 | prop: property
171 | return: returns
172 | virtual: abstract
173 | yield: yields
174 | preferType:
175 | array: Array
176 | bool: Boolean
177 | boolean: Boolean
178 | number: Number
179 | object: Object
180 | str: String
181 | string: String
182 | requireParamDescription: false
183 | requireReturn: false
184 | requireReturnDescription: false
185 | requireReturnType: false
186 | valid-typeof: warn
187 | yoda: warn
188 |
--------------------------------------------------------------------------------
/test_repo/broken_module/model_view2.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | view.model.form2
7 | test.model
8 |
9 |
12 |
13 |
14 |
15 |
16 | view.model.form2
17 | test.model
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 | view.model.form10
27 | test.model
28 |
29 |
34 |
35 |
36 |
37 |
38 | view.model.form20
39 | test.model
40 |
41 |
44 |
45 |
46 |
47 |
48 | view.model.form30
49 | test.model
50 |
51 |
56 |
57 |
58 |
59 |
60 | view.model.form40
61 | test.model
62 | 100
63 |
64 |
67 |
68 |
69 |
70 |
71 | view.model.form50
72 | test.model
73 | 10
74 |
75 |
78 |
79 |
80 |
81 |
82 | view.model.form60
83 | test.model
84 |
85 |
86 |
89 |
90 |
91 |
92 |
93 | view.model.form70
94 | test.model
95 |
96 |
97 |
100 |
101 |
102 |
103 |
104 | view.model.form80
105 | test.model
106 |
107 |
108 |
109 | view.model.form90
110 | test.model
111 | 10
112 |
113 |
114 |
115 |
116 |
117 |
118 | view.model.form100
119 | test.model
120 | 10
121 |
122 |
123 |
124 |
125 |
126 |
127 | red
128 |
129 |
130 |
131 |
132 |
133 |
--------------------------------------------------------------------------------
/tests/test_checks_po.py:
--------------------------------------------------------------------------------
1 | import glob
2 | import os
3 | import re
4 | import subprocess
5 | import sys
6 | import unittest
7 | from shutil import copyfile
8 | from tempfile import TemporaryDirectory
9 |
10 | import oca_pre_commit_hooks
11 | from . import common
12 |
13 | RE_CHECK_DOCSTRING = r"\* Check (?P[\w|\-]+)"
14 | RE_CHECK_OUTPUT = r"\- \[(?P[\w|-]+)\]"
15 |
16 | ALL_CHECK_CLASS = [
17 | oca_pre_commit_hooks.checks_odoo_module_po.ChecksOdooModulePO,
18 | ]
19 |
20 | EXPECTED_ERRORS = {
21 | "po-duplicate-message-definition": 3,
22 | "po-python-parse-format": 4,
23 | "po-python-parse-printf": 2,
24 | "po-requires-module": 1,
25 | "po-syntax-error": 2,
26 | "po-pretty-format": 6,
27 | "po-duplicate-model-definition": 7,
28 | }
29 |
30 |
31 | class TestChecksPO(common.ChecksCommon):
32 | @classmethod
33 | def setUpClass(cls):
34 | super().setUpClass()
35 | cls.test_repo_path = os.path.join(os.path.dirname(os.path.dirname(os.path.realpath(__file__))), "test_repo")
36 | po_glob_pattern = os.path.join(cls.test_repo_path, "**", "*.po")
37 | pot_glob_pattern = f"{po_glob_pattern}t"
38 | cls.file_paths = glob.glob(po_glob_pattern, recursive=True) + glob.glob(pot_glob_pattern, recursive=True)
39 | cls.compatible_with_directories = False # *.po files are not compatible with directoris only run with files
40 |
41 | def setUp(self):
42 | super().setUp()
43 | self.expected_errors = EXPECTED_ERRORS.copy()
44 | self.checks_run = oca_pre_commit_hooks.checks_odoo_module_po.run
45 | self.checks_cli_main = oca_pre_commit_hooks.cli_po.main
46 |
47 | def test_non_exists_path(self):
48 | all_check_errors = self.checks_run(["/tmp/no_exists"], no_exit=True, no_verbose=False)
49 | real_errors = self.get_count_code_errors(all_check_errors)
50 | self.assertDictEqual(real_errors, {"po-syntax-error": 1})
51 |
52 | def test_pretty_format_po(self):
53 | ugly_po = os.path.join(self.test_repo_path, "eleven_module", "i18n", "ugly.po")
54 | pretty_po = os.path.join(self.test_repo_path, "eleven_module", "i18n", "pretty.po")
55 |
56 | errors = self.checks_run([pretty_po], enable={"po-pretty-format"}, no_exit=True, no_verbose=False)
57 | self.assertFalse(errors)
58 |
59 | errors = self.checks_run([ugly_po], enable={"po-pretty-format"}, no_exit=True, no_verbose=False)
60 | real_errors = self.get_count_code_errors(errors)
61 | self.assertIn("po-pretty-format", real_errors)
62 |
63 | def test_pretty_format_po_autofix(self):
64 | ugly_po = os.path.join(self.test_repo_path, "eleven_module", "i18n", "ugly.po")
65 | autofix_po = os.path.join(self.test_repo_path, "eleven_module", "i18n", "autofixed_ugly.po")
66 |
67 | with TemporaryDirectory() as tmpdir:
68 | # Compatible with top_path method that only works with .git folders
69 | subprocess.check_output(["git", "init", tmpdir])
70 | ugly_po_cp = os.path.join(tmpdir, "ugly.po")
71 | copyfile(ugly_po, ugly_po_cp)
72 |
73 | self.checks_run([ugly_po_cp], enable={"po-pretty-format"}, no_exit=True, no_verbose=False, autofix=False)
74 | with open(ugly_po_cp, encoding="utf-8") as ugly_fd, open(autofix_po, encoding="utf-8") as pretty_fd:
75 | self.assertNotEqual(ugly_fd.read(), pretty_fd.read())
76 |
77 | self.checks_run([ugly_po_cp], enable={"po-pretty-format"}, no_exit=True, no_verbose=False, autofix=True)
78 | with open(ugly_po_cp, encoding="utf-8") as ugly_fd, open(autofix_po, encoding="utf-8") as pretty_fd:
79 | self.assertEqual(ugly_fd.read(), pretty_fd.read())
80 |
81 | @unittest.skipIf(not os.environ.get("BUILD_README"), "BUILD_README environment variable not enabled")
82 | def test_build_docstring(self):
83 | checks_found, checks_docstring = oca_pre_commit_hooks.utils.get_checks_docstring(
84 | [oca_pre_commit_hooks.checks_odoo_module_po.ChecksOdooModulePO]
85 | )
86 |
87 | readme_path = os.path.join(os.path.dirname(os.path.dirname(os.path.realpath(__file__))), "README.md")
88 | with open(readme_path, encoding="UTF-8") as f_readme:
89 | readme_content = f_readme.read()
90 |
91 | checks_docstring = f"# Checks PO\n{checks_docstring}"
92 | new_readme = self.re_replace(
93 | "[//]: # (start-checks-po)", "[//]: # (end-checks-po)", checks_docstring, readme_content
94 | )
95 |
96 | # Find a better way to get the --help string
97 | help_content = subprocess.check_output(["oca-checks-po", "--help"], stderr=subprocess.STDOUT).decode(
98 | sys.stdout.encoding
99 | )
100 | help_content = f"# Help PO\n```bash\n{help_content}\n```"
101 | # remove extra spaces
102 | help_content = re.sub(r"\n( )+", " ", help_content)
103 | help_content = re.sub(r"( )+", " ", help_content)
104 | new_readme = self.re_replace("[//]: # (start-help-po)", "[//]: # (end-help-po)", help_content, new_readme)
105 |
106 | all_check_errors = self.checks_run(sorted(self.file_paths), no_exit=True, no_verbose=False)
107 | all_check_errors_by_code = self.get_grouped_errors(all_check_errors)
108 |
109 | version = oca_pre_commit_hooks.__version__
110 | check_example_content = ""
111 | for code in sorted(all_check_errors_by_code):
112 | check_example_content += f"\n\n * {code}\n"
113 | for check_error in all_check_errors_by_code[code]:
114 | msg = f"{check_error.position.filepath}"
115 | if check_error.position.line:
116 | msg += f"#L{check_error.position.line}"
117 | if check_error.message:
118 | msg += f" {check_error.message}"
119 | check_example_content += f"\n - https://github.com/OCA/odoo-pre-commit-hooks/blob/v{version}/{msg}"
120 | check_example_content = f"# Examples PO\n{check_example_content}"
121 | new_readme = self.re_replace(
122 | "[//]: # (start-example-po)", "[//]: # (end-example-po)", check_example_content, new_readme
123 | )
124 | with open(readme_path, "w", encoding="UTF-8") as f_readme:
125 | f_readme.write(new_readme)
126 | self.assertEqual(
127 | readme_content,
128 | new_readme,
129 | "The README was updated! Don't panic only failing for CI purposes. Run the same test again.",
130 | )
131 | self.assertFalse(set(self.expected_errors) - checks_found, "Missing docstring of checks tested")
132 |
--------------------------------------------------------------------------------
/test_repo/broken_module/model_view_odoo2.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | view.model.form
7 | test.model
8 |
9 |
10 |
11 |
12 |
13 | view.model.form4
14 |
15 |
16 |
17 |
18 | view.model.form
19 | which.model.is.right
20 | test.model
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 | red
31 | red
32 |
33 |
34 |
35 |
36 |
37 |
38 | ir.config_parameter
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 | view.model.form
51 | test.model
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
62 |
63 | Access rule
64 |
65 |
66 |
67 |
68 |
69 | [('user_ids','in',user.id)]
70 |
71 |
72 |
73 |
74 | test.model5
75 | view.model.form
76 | test.model
77 |
78 |
79 |
102 |
103 |
104 |
105 |
106 |
107 | view.model.form
108 | test.model
109 |
110 |
122 |
123 |
124 |
125 |
126 |
127 | view.model.form
128 | test.model
129 |
130 |
147 |
148 |
149 |
150 |
151 |
152 |
--------------------------------------------------------------------------------
/test_repo/broken_module/i18n/ar_unicode.po:
--------------------------------------------------------------------------------
1 | # Translation of OpenERP Server.
2 | # This file contains the translation of the following modules:
3 | # * base_report_designer
4 | #
5 | msgid ""
6 | msgstr ""
7 | "Project-Id-Version: OpenERP Server 6.0dev\n"
8 | "Report-Msgid-Bugs-To: support@openerp.com\n"
9 | "POT-Creation-Date: 2012-12-21 17:05+0000\n"
10 | "PO-Revision-Date: 2012-12-01 17:32+0000\n"
11 | "Last-Translator: gehad shaat \n"
12 | "Language-Team: \n"
13 | "MIME-Version: 1.0\n"
14 | "Content-Type: text/plain; charset=UTF-8\n"
15 | "Content-Transfer-Encoding: 8bit\n"
16 | "X-Launchpad-Export-Date: 2014-04-22 07:02+0000\n"
17 | "X-Generator: Launchpad (build 16985)\n"
18 |
19 | #. module: base_report_designer
20 | #: model:ir.model,name:base_report_designer.model_base_report_sxw
21 | msgid "base.report.sxw"
22 | msgstr "base.report.sxw"
23 |
24 | #. module: base_report_designer
25 | #: view:base_report_designer.installer:0
26 | msgid "OpenERP Report Designer Configuration"
27 | msgstr "إعدادت OpenERP لتصميم التقارير"
28 |
29 | #. module: base_report_designer
30 | #: view:base_report_designer.installer:0
31 | msgid ""
32 | "This plug-in allows you to create/modify OpenERP Reports into OpenOffice "
33 | "Writer."
34 | msgstr "يسمح لك سد العجز بإنشاء/تعديل تقارير OpenERP إلى محرر .OpenOffice"
35 |
36 | #. module: base_report_designer
37 | #: view:base.report.sxw:0
38 | msgid "Upload the modified report"
39 | msgstr "تحميل تقرير معدل"
40 |
41 | #. module: base_report_designer
42 | #: view:base.report.file.sxw:0
43 | msgid "The .SXW report"
44 | msgstr "تقرير SXW"
45 |
46 | #. module: base_report_designer
47 | #: model:ir.model,name:base_report_designer.model_base_report_designer_installer
48 | msgid "base_report_designer.installer"
49 | msgstr "base_report_designer.installer"
50 |
51 | #. module: base_report_designer
52 | #: model:ir.model,name:base_report_designer.model_base_report_rml_save
53 | msgid "base.report.rml.save"
54 | msgstr "base.report.rml.save"
55 |
56 | #. module: base_report_designer
57 | #: view:base_report_designer.installer:0
58 | msgid "Configure"
59 | msgstr "تهيئة"
60 |
61 | #. module: base_report_designer
62 | #: view:base_report_designer.installer:0
63 | msgid "title"
64 | msgstr "الاسم"
65 |
66 | #. module: base_report_designer
67 | #: field:base.report.file.sxw,report_id:0
68 | #: field:base.report.sxw,report_id:0
69 | msgid "Report"
70 | msgstr "تقرير"
71 |
72 | #. module: base_report_designer
73 | #: view:base.report.rml.save:0
74 | msgid "The RML Report"
75 | msgstr "تقرير RML"
76 |
77 | #. module: base_report_designer
78 | #: model:ir.ui.menu,name:base_report_designer.menu_action_report_designer_wizard
79 | msgid "Report Designer"
80 | msgstr "مصمم تقارير"
81 |
82 | #. module: base_report_designer
83 | #: field:base_report_designer.installer,name:0
84 | msgid "File name"
85 | msgstr "اسم الملف"
86 |
87 | #. module: base_report_designer
88 | #: view:base.report.file.sxw:0
89 | #: view:base.report.sxw:0
90 | msgid "Get a report"
91 | msgstr "احصل علي التقرير"
92 |
93 | #. module: base_report_designer
94 | #: view:base_report_designer.installer:0
95 | #: model:ir.actions.act_window,name:base_report_designer.action_report_designer_wizard
96 | msgid "OpenERP Report Designer"
97 | msgstr "مصمم التقارير لـ Openerp"
98 |
99 | #. module: base_report_designer
100 | #: view:base.report.sxw:0
101 | msgid "Continue"
102 | msgstr "تابع"
103 |
104 | #. module: base_report_designer
105 | #: field:base.report.rml.save,file_rml:0
106 | msgid "Save As"
107 | msgstr "حفظ كـ"
108 |
109 | #. module: base_report_designer
110 | #: help:base_report_designer.installer,plugin_file:0
111 | msgid ""
112 | "OpenObject Report Designer plug-in file. Save as this file and install this "
113 | "plug-in in OpenOffice."
114 | msgstr ""
115 | "يسد تصميم التقرير OpenObject العجز في الملف. احفظ كهذا الملف وثبت سد العجز "
116 | "فيOpenOffice."
117 |
118 | #. module: base_report_designer
119 | #: view:base.report.rml.save:0
120 | msgid "Save RML FIle"
121 | msgstr "حفظ كملف RML"
122 |
123 | #. module: base_report_designer
124 | #: field:base.report.file.sxw,file_sxw:0
125 | #: field:base.report.file.sxw,file_sxw_upload:0
126 | msgid "Your .SXW file"
127 | msgstr "ملفك SXW"
128 |
129 | #. module: base_report_designer
130 | #: view:base_report_designer.installer:0
131 | msgid "Installation and Configuration Steps"
132 | msgstr "خطوات التثبيت و التهيئة"
133 |
134 | #. module: base_report_designer
135 | #: field:base_report_designer.installer,description:0
136 | msgid "Description"
137 | msgstr "وصف"
138 |
139 | #. module: base_report_designer
140 | #: view:base.report.file.sxw:0
141 | msgid ""
142 | "This is the template of your requested report.\n"
143 | "Save it as a .SXW file and open it with OpenOffice.\n"
144 | "Don't forget to install the OpenERP SA OpenOffice package to modify it.\n"
145 | "Once it is modified, re-upload it in OpenERP using this wizard."
146 | msgstr ""
147 | "هذا هو قالب التقرير المطلوب.\n"
148 | "قم بحفظه كملف SXW و افتحه ببرنامج LibreOffice.\n"
149 | "لا تنسي أن تقوم بتثبيت باقة Openerp لتستطيع التحرير و التعديل.\n"
150 | "حين الإنتهاء يمكنك إعادة تحميله مرة أخرة بإستخدام نفس المعالج."
151 |
152 | #. module: base_report_designer
153 | #: model:ir.actions.act_window,name:base_report_designer.action_view_base_report_sxw
154 | msgid "Base Report sxw"
155 | msgstr "التقرير الأساسي كـ SXW"
156 |
157 | #. module: base_report_designer
158 | #: model:ir.model,name:base_report_designer.model_base_report_file_sxw
159 | msgid "base.report.file.sxw"
160 | msgstr "base.report.file.sxw"
161 |
162 | #. module: base_report_designer
163 | #: field:base_report_designer.installer,plugin_file:0
164 | msgid "OpenObject Report Designer Plug-in"
165 | msgstr "أداة OpenObject لتصميم التقارير"
166 |
167 | #. module: base_report_designer
168 | #: model:ir.actions.act_window,name:base_report_designer.action_report_designer_installer
169 | msgid "OpenERP Report Designer Installation"
170 | msgstr "تثبيت مصمم التقارير لـ Openerp"
171 |
172 | #. module: base_report_designer
173 | #: view:base.report.sxw:0
174 | msgid "Cancel"
175 | msgstr "إلغاء"
176 |
177 | #. module: base_report_designer
178 | #: view:base.report.sxw:0
179 | msgid "or"
180 | msgstr "أو"
181 |
182 | #. module: base_report_designer
183 | #: model:ir.model,name:base_report_designer.model_ir_actions_report_xml
184 | msgid "ir.actions.report.xml"
185 | msgstr "ir.actions.report.xml"
186 |
187 | #. module: base_report_designer
188 | #: view:base.report.sxw:0
189 | msgid "Select your report"
190 | msgstr "اختر التقرير"
191 |
192 | #~ msgid "Introduction"
193 | #~ msgstr "المقدمة"
194 |
195 | #~ msgid "_Close"
196 | #~ msgstr "إ_غلاق"
197 |
198 | #~ msgid "Configuration Progress"
199 | #~ msgstr "سير الإعدادات"
200 |
201 | #~ msgid "Skip"
202 | #~ msgstr "تخطي"
203 |
204 | #~ msgid "Image"
205 | #~ msgstr "صورة"
206 |
207 | #~ msgid "Report designer interface module"
208 | #~ msgstr "برنامج واجهة تصميم التقارير"
209 |
210 | #~ msgid "The RML report"
211 | #~ msgstr "تقرير RML"
212 |
213 | #~ msgid ""
214 | #~ "\n"
215 | #~ "This module is used along with OpenERP OpenOffice plugin.\n"
216 | #~ "You have to first install the plugin which is available at\n"
217 | #~ "http://www.openerp.com\n"
218 | #~ "\n"
219 | #~ "This module adds wizards to Import/Export .sxw report that\n"
220 | #~ "you can modify in OpenOffice.Once you have modified it you can\n"
221 | #~ "upload the report using the same wizard.\n"
222 | #~ msgstr ""
223 | #~ "\n"
224 | #~ "وتستخدم هذه الوحدة جنبا إلى جنب مع البرنامج المساعد OpenERP أوبن أوفيس.\n"
225 | #~ "عليك أولا تثبيت البرنامج المساعد والذي يتوفر في\n"
226 | #~ "http://www.openerp.com\n"
227 | #~ "\n"
228 | #~ "تضيف هذه الوحدة المعالجات إلى تقرير الاستيراد / التصدير. sxw إلى أن\n"
229 | #~ "يمكنك التعديل في OpenOffice.Once عندما تقوم بتعديل ذلك يمكنك\n"
230 | #~ "رفع التقرير باستخدام المعالج نفسه.\n"
231 |
--------------------------------------------------------------------------------
/src/oca_pre_commit_hooks/utils.py:
--------------------------------------------------------------------------------
1 | import os
2 | import re
3 | import shutil
4 | import subprocess
5 | import sys
6 | import tempfile
7 | from ast import literal_eval
8 | from contextlib import contextmanager
9 | from functools import lru_cache
10 | from inspect import getmembers, isfunction
11 | from itertools import chain
12 | from pathlib import Path
13 |
14 | from fixit.config import collect_rules, parse_rule
15 | from fixit.ftypes import Config
16 | from packaging.version import InvalidVersion, Version
17 |
18 | from oca_pre_commit_hooks.base_checker import BaseChecker
19 |
20 | CHECKS_DISABLED_REGEX = re.compile(re.escape("oca-hooks:disable=") + r"([a-z\-,]+)")
21 | DEPRECATED_CHECKS_DISABLED_REGEX = re.compile(re.escape("pylint:disable=") + r"([a-z\-,]+)")
22 | RE_CHECK_DOCSTRING = r"\* Check (?P[\w|\-]+)"
23 |
24 |
25 | def checks_disabled(comment):
26 | comment_strip = comment.replace("\n", "").replace(" ", "").replace("#", "")
27 | check_disable_match = CHECKS_DISABLED_REGEX.search(comment_strip)
28 | check_deprecated_disable_match = DEPRECATED_CHECKS_DISABLED_REGEX.search(comment_strip)
29 |
30 | match = check_disable_match or check_deprecated_disable_match
31 | use_deprecate = bool(check_deprecated_disable_match)
32 | if not match:
33 | return [], False
34 |
35 | return match.groups()[0].split(","), use_deprecate
36 |
37 |
38 | def only_required_for_checks(*checks):
39 | """Decorator to store checks that are handled by a checker method as an
40 | attribute of the function object.
41 |
42 | This information is used to decide whether to call the decorated
43 | method or not. If none of the checks is enabled, the method will be skipped.
44 | """
45 |
46 | def store_checks(func):
47 | setattr(func, "checks", set(checks)) # noqa: B010
48 | return func
49 |
50 | return store_checks
51 |
52 |
53 | def only_required_for_installable():
54 | """Decorator to store checks that are handled by a checker method as an
55 | attribute of the function object.
56 |
57 | This information is used to decide whether to call the decorated
58 | method or not. If the module is not installabe, the method will be skipped.
59 | """
60 |
61 | def store_installable(func):
62 | setattr(func, "installable", True) # noqa: B010
63 | return func
64 |
65 | return store_installable
66 |
67 |
68 | def getattr_checks(obj_or_class: BaseChecker, prefix="check_", disable_node=None):
69 | """Get all the attributes callables (methods)
70 | that start with word 'def check_*'
71 | Skip the methods with attribute "checks" defined if
72 | the check is not enable or if it is disabled"""
73 | for attr in dir(obj_or_class):
74 | if not callable(getattr(obj_or_class, attr)) or not attr.startswith(prefix):
75 | continue
76 | meth = getattr(obj_or_class, attr)
77 | meth_checks = getattr(meth, "checks", set())
78 | if meth_checks and not any(
79 | obj_or_class.is_message_enabled(meth_check, disable_node) for meth_check in meth_checks
80 | ):
81 | continue
82 | meth_installable = getattr(meth, "installable", None)
83 | is_module_installable = getattr(obj_or_class, "is_module_installable", None)
84 | if (
85 | meth_installable is not None
86 | and is_module_installable is not None
87 | and meth_installable
88 | and not is_module_installable
89 | ):
90 | continue
91 | yield getattr(obj_or_class, attr)
92 |
93 |
94 | @contextmanager
95 | def chdir(directory):
96 | """Change the current directory similar to command 'cd directory'
97 | but remembering the previous value to be revert at final
98 | Similar to run 'original_dir=$(pwd) && cd odoo && cd ${original_dir}'
99 | """
100 | original_dir = os.getcwd()
101 | os.chdir(directory)
102 | try:
103 | yield
104 | finally:
105 | os.chdir(original_dir)
106 |
107 |
108 | @lru_cache(maxsize=256)
109 | def top_path(path):
110 | """Get the top level path based on git
111 | If no git repository is found (and therefore no top level path), the user's HOME is returned.
112 |
113 | It is using lru_cache in order to re-use top level path values
114 | if multiple files are sharing the same path
115 |
116 | Notice it is not compatible with TemporaryDirectory since that it needs to have a .git folder
117 | but you can fix it using "git init"
118 | """
119 | try:
120 | with chdir(path):
121 | return (
122 | subprocess.check_output(["git", "rev-parse", "--show-toplevel"], stderr=subprocess.STDOUT)
123 | .decode(sys.stdout.encoding)
124 | .strip()
125 | )
126 | except (FileNotFoundError, subprocess.CalledProcessError):
127 | path = Path(path)
128 | return path.root or Path.home()
129 |
130 |
131 | def full_norm_path(path):
132 | """Expand paths in all possible ways"""
133 | return os.path.normpath(os.path.realpath(os.path.abspath(os.path.expanduser(os.path.expandvars(path.strip())))))
134 |
135 |
136 | @lru_cache(maxsize=256)
137 | def walk_up(path, filenames, top):
138 | """Look for "filenames" walking up in parent paths of "path"
139 | but limited only to "top" path
140 | """
141 | if full_norm_path(path) == full_norm_path(top):
142 | return None
143 | for filename in filenames:
144 | path_filename = os.path.join(path, filename)
145 | if os.path.isfile(full_norm_path(path_filename)):
146 | return path_filename
147 | return walk_up(os.path.dirname(path), filenames, top)
148 |
149 |
150 | def get_checks_docstring(check_classes):
151 | checks_docstring = ""
152 | checks_found = set()
153 | for check_class in check_classes:
154 | check_meths = chain(
155 | [member[1] for member in getmembers(check_class, predicate=isfunction) if member[0].startswith("check")],
156 | [member[1] for member in getmembers(check_class, predicate=isfunction) if member[0].startswith("visit")],
157 | )
158 | # Sorted to avoid mutable checks order readme
159 | check_meths = sorted(
160 | list(check_meths), key=lambda m: m.__name__.replace("visit", "", 1).replace("check", "", 1).strip("_")
161 | )
162 | for check_meth in check_meths:
163 | if not check_meth or not check_meth.__doc__ or "* Check" not in check_meth.__doc__:
164 | continue
165 | checks_docstring += "\n" + check_meth.__doc__.strip(" \n") + "\n"
166 | checks_found |= set(re.findall(RE_CHECK_DOCSTRING, checks_docstring))
167 | checks_docstring = re.sub(r"( )+\*", "*", checks_docstring)
168 | rule = parse_rule(
169 | ".checks_odoo_module_fixit",
170 | Path(__file__).resolve().parent,
171 | )
172 | if "ChecksOdooModule" in [check_class.__name__ for check_class in check_classes]:
173 | checks_docstring += "\n** Special fixit checks\n"
174 | lint_rules = collect_rules(Config(enable=[rule], disable=[], python_version=None))
175 | for lint_rule in sorted(lint_rules, key=lambda r: r.name):
176 | checks_found |= {lint_rule.name}
177 | rule_doc = lint_rule.__doc__.strip("\n ")
178 | checks_docstring += f"\n* Check {lint_rule.name}\n{rule_doc}\n"
179 | return checks_found, checks_docstring
180 |
181 |
182 | def str2version(version_str):
183 | try:
184 | return Version(version_str)
185 | except (InvalidVersion, TypeError):
186 | return None
187 |
188 |
189 | def manifest_version(manifest_path):
190 | with open(manifest_path, encoding="utf-8") as manifest_fd:
191 | try:
192 | manifest = literal_eval(manifest_fd.read())
193 | except (ValueError, SyntaxError):
194 | return None
195 | return str2version(manifest.get("version"))
196 |
197 |
198 | def perform_fix(file_path, new_content):
199 | """Perform the fix by overwriting the file with the new content
200 | using a temp file to copy after."""
201 | # Use `delete=False` to be able to copy the file on Windows
202 | with tempfile.NamedTemporaryFile("wb", delete=False) as f_tmp:
203 | f_tmp.write(new_content)
204 | shutil.copy(f_tmp.name, file_path)
205 | os.unlink(f_tmp.name)
206 |
--------------------------------------------------------------------------------
/tests/test_checks.py:
--------------------------------------------------------------------------------
1 | # pylint: disable=duplicate-code,useless-suppression
2 | import glob
3 | import os
4 | import re
5 | import subprocess
6 | import sys
7 | import unittest
8 |
9 | import oca_pre_commit_hooks
10 | from . import common
11 |
12 | ALL_CHECK_CLASS = [
13 | oca_pre_commit_hooks.checks_odoo_module.ChecksOdooModule,
14 | oca_pre_commit_hooks.checks_odoo_module_csv.ChecksOdooModuleCSV,
15 | oca_pre_commit_hooks.checks_odoo_module_xml.ChecksOdooModuleXML,
16 | ]
17 |
18 |
19 | EXPECTED_ERRORS = {
20 | "csv-duplicate-record-id": 1,
21 | "csv-syntax-error": 1,
22 | "file-not-used": 1,
23 | "manifest-superfluous-key": 3,
24 | "manifest-syntax-error": 2,
25 | "prefer-env-translation": 41,
26 | "xml-create-user-wo-reset-password": 1,
27 | "xml-dangerous-qweb-replace-low-priority": 9,
28 | "xml-deprecated-data-node": 8,
29 | "xml-deprecated-openerp-node": 4,
30 | "xml-deprecated-qweb-directive": 2,
31 | "xml-deprecated-tree-attribute": 3,
32 | "xml-duplicate-fields": 3,
33 | "xml-duplicate-record-id": 2,
34 | "xml-not-valid-char-link": 2,
35 | "xml-redundant-module-name": 2,
36 | "xml-syntax-error": 2,
37 | "xml-view-dangerous-replace-low-priority": 7,
38 | "xml-xpath-translatable-item": 4,
39 | "xml-oe-structure-missing-id": 6,
40 | "xml-record-missing-id": 2,
41 | "xml-duplicate-template-id": 9,
42 | "xml-header-missing": 1,
43 | "xml-header-wrong": 19,
44 | "xml-id-position-first": 3,
45 | "xml-deprecated-oe-chatter": 1,
46 | }
47 |
48 |
49 | class TestChecks(common.ChecksCommon):
50 |
51 | def setUp(self):
52 | super().setUp()
53 | self.file_paths = glob.glob(os.path.join(self.test_repo_path, "*", "__openerp__.py")) + glob.glob(
54 | os.path.join(self.test_repo_path, "*", "__manifest__.py")
55 | )
56 | self.checks_run = oca_pre_commit_hooks.checks_odoo_module.run
57 | self.checks_cli_main = oca_pre_commit_hooks.cli.main
58 | self.expected_errors = EXPECTED_ERRORS.copy()
59 |
60 | @unittest.skipIf(not os.environ.get("BUILD_README"), "BUILD_README environment variable not enabled")
61 | def test_build_docstring(self):
62 | # Run "tox -e update-readme"
63 | # Why this here?
64 | # The unittest are isolated using "tox" virtualenv with all test-requirements installed
65 | # and latest dev version of the package instead of using the
66 | # already installed in the OS (without latest dev changes)
67 | # and we do not have way to evaluate all checks are evaluated and documented from another side
68 | # Feel free to migrate to better place this non-standard section of the code
69 |
70 | checks_found, checks_docstring = oca_pre_commit_hooks.utils.get_checks_docstring(ALL_CHECK_CLASS)
71 | readme_path = os.path.join(os.path.dirname(os.path.dirname(os.path.realpath(__file__))), "README.md")
72 | with open(readme_path, encoding="UTF-8") as f_readme:
73 | readme_content = f_readme.read()
74 |
75 | checks_docstring = f"# Checks\n{checks_docstring}"
76 | new_readme = self.re_replace(
77 | "[//]: # (start-checks)", "[//]: # (end-checks)", checks_docstring, readme_content
78 | )
79 |
80 | # Find a better way to get the --help string
81 | help_content = subprocess.check_output(["oca-checks-odoo-module", "--help"], stderr=subprocess.STDOUT).decode(
82 | sys.stdout.encoding
83 | )
84 | help_content = f"# Help\n```bash\n{help_content}\n```"
85 | # remove extra spaces
86 | help_content = re.sub(r"\n( )+", " ", help_content)
87 | help_content = re.sub(r"( )+", " ", help_content)
88 | new_readme = self.re_replace("[//]: # (start-help)", "[//]: # (end-help)", help_content, new_readme)
89 |
90 | all_check_errors = self.checks_run(sorted(self.file_paths), no_exit=True, no_verbose=False)
91 | all_check_errors_by_code = self.get_grouped_errors(all_check_errors)
92 |
93 | version = oca_pre_commit_hooks.__version__
94 | check_example_content = ""
95 | for code in sorted(all_check_errors_by_code):
96 | check_example_content += f"\n\n * {code}\n"
97 | for check_error in sorted(all_check_errors_by_code[code])[:3]:
98 | msg = f"{check_error.position.filepath}"
99 | if check_error.position.line:
100 | msg += f"#L{check_error.position.line}"
101 | if check_error.message:
102 | msg += f" {check_error.message}"
103 | check_example_content += (
104 | f"\n - https://github.com/OCA/odoo-pre-commit-hooks/blob/v{version}/test_repo/{msg}"
105 | )
106 | check_example_content = f"# Examples\n{check_example_content}"
107 | new_readme = self.re_replace(
108 | "[//]: # (start-example)", "[//]: # (end-example)", check_example_content, new_readme
109 | )
110 | with open(readme_path, "w", encoding="UTF-8") as f_readme:
111 | f_readme.write(new_readme)
112 | self.assertEqual(
113 | readme_content,
114 | new_readme,
115 | "The README was updated! Don't panic only failing for CI purposes. Run the same test again.",
116 | )
117 | self.assertFalse(set(self.expected_errors) - checks_found, "Missing docstring of checks tested")
118 |
119 | def test_non_exists_path(self):
120 | all_check_errors = self.checks_run(["/tmp/no_exists"], no_exit=True, no_verbose=False)
121 | self.assertFalse(all_check_errors)
122 |
123 | def test_autofix(self):
124 | # Before autofix
125 | fname_wo_header = os.path.join(self.test_repo_path, "broken_module", "xml_wo_header.xml")
126 | with open(fname_wo_header, "rb") as f_wo_header:
127 | content = f_wo_header.read()
128 | self.assertFalse(content.strip().startswith(b"',
143 | content,
144 | "The XML wrong xmlid order was previously fixed",
145 | )
146 | self.assertIn(
147 | b'',
148 | content,
149 | "The XML wrong xmlid order and redundant module name was previously fixed",
150 | )
151 |
152 | fname_redundant_module_name = os.path.join(self.test_repo_path, "broken_module", "model_view2.xml")
153 | with open(fname_redundant_module_name, "rb") as f_redundant_module_name:
154 | content = f_redundant_module_name.read()
155 | self.assertIn(
156 | b'',
157 | content,
158 | "The XML wrong redundant module name was previously fixed",
159 | )
160 |
161 | self.checks_run(self.file_paths, autofix=True, no_exit=True, no_verbose=False)
162 |
163 | # After autofix
164 | with open(fname_wo_header, "rb") as f_wo_header:
165 | content = f_wo_header.read()
166 | self.assertTrue(content.strip().startswith(b"', content, "The XML wrong xmlid was not fixed"
178 | )
179 | self.assertIn(
180 | b'',
181 | content,
182 | "The XML wrong xmlid order and redundant module name was not fixed",
183 | )
184 |
185 | with open(fname_redundant_module_name, "rb") as f_redundant_module_name:
186 | content = f_redundant_module_name.read()
187 | self.assertIn(
188 | b'',
189 | content,
190 | "The XML wrong redundant module name was not fixed",
191 | )
192 |
--------------------------------------------------------------------------------
/docs/dev.md:
--------------------------------------------------------------------------------
1 | # Development
2 | This file documents the purpose and architecture of programs contained in this repository.
3 | It is meant to serve as an introduction to new developers and a guideline for development. It is expected that
4 | new code will abide to these guidelines.
5 |
6 | ## Purpose
7 | Provide linters that complement [`pylint-odoo`](https://github.com/OCA/pylint-odoo). `pylint-odoo` is focused on
8 | checking Python source code, which means linters in this project focus solely on the following types of files:
9 |
10 | * csv
11 | * po
12 | * xml
13 |
14 | As the name of the repository implies, all linters in this project must be compatible with
15 | [`pre-commit`](https://pre-commit.com/). This means **all linters must comply with the following points:
16 |
17 | * provide an entrypoint in the form of an executable which takes (at least) filenames as arguments
18 | * nonzero exit on failure
19 |
20 | A linter is considered to have failed once it emits a message.
21 |
22 | ## Nomenclature
23 | * Linter: An executable (entry point) which runs checks and emits messages.
24 | * Check: A routine inside a linter, verifies the source code conforms to a certain rule (or rules).
25 | * Message: **Generated by checks** when a rule is not met. **Emitted by linters**.
26 |
27 | Why is this last point important? Checks must be self-contained units which perform a single task: verify the source
28 | conforms to the rule it checks for. This improves testability.
29 |
30 | ## Checks
31 | Checks are run by linters. The nature of checks can be divided in two categories:
32 |
33 | * Dependent
34 | * Independent
35 |
36 | ### Dependent Checks
37 | These are checks that depend on other files. **The check must process all its dependencies everytime it runs**. Most
38 | times these dependencies consist of all files of the same type inside an
39 | [Odoo module](https://www.odoo.com/documentation/16.0/developer/howtos/backend.html). An example of a dependent
40 | check is `xml-duplicate-record-id`.
41 |
42 | This check must read all `` tags inside a module and verify none of them share the
43 | same id (``), `` tags are found in **xml** files, so this check **must read all xml files in
44 | a module**.
45 |
46 | ### Independent Checks
47 | These checks have no dependencies. They only need to process the very file they are checking. An example would be
48 | `xml-deprecated-node`. This check ensures there are no `` tags in xml files.
49 |
50 | ## Messages
51 | Messages are generated by checks, but emitted by linters. They alert the user about failure to meet one of the
52 | rules verified by checks. They are a standardized in a dataclass. **All compliant checks must only generate
53 | messages in their standardized format (see Architecture Specs).
54 |
55 | ## Linters
56 | Linters are programs executed by the user to run various checks. They are separated based on the types of checks they
57 | run. **Linters must contain only one type of check (dependent or independent).**
58 |
59 | > **Warning**
60 | > Running independent and dependent checks inside the same linter will nullify one feature of `pre-commit`: performing
61 | > checks only on files which have been modified.
62 |
63 | Linters are composed of five elements:
64 |
65 | * **Frontend**: Command line executable. **In charge of parsing all user input**. User input not only consists of
66 | command line arguments, but also environment variables and configuration files. Said configuration files may not be
67 | explicitly stated by the user and may reside in default locations. It needs to normalize all user input into a common
68 | format for the next component, the *scheduler*.
69 | * **Scheduler**: Gathers all checks for the linter and runs the *necessary* checks in an orderly manner. Note the word
70 | *necessary*. Certain messages may be disabled
71 | (either trough command line arguments, environment variables or a configuration file). The scheduler must detect this
72 | cases and stop the checks that generate said messages from running.
73 | * **Checks**: Self contained function which takes a list of arguments and if necessary generates messages.
74 | * **Message Stack**: Stores all messages generated during the execution of checks.
75 | * **Printer**: Reads messages from the message stack and generates the corresponding output. Generally in the form
76 | of text to `stdout`.
77 |
78 | ```mermaid
79 | flowchart TD;
80 | start([Executable is run]) --> frontend[/Parse user's arguments. Read environment variables and config files/]
81 | subgraph _______________Frontend
82 | frontend --> frontendProc(Normalize user input into standard configuration)
83 | frontendProc --> scheduler(Start Scheduler with normalized config)
84 | end
85 | subgraph ______________Scheduler
86 | scheduler --> check(Run Check)
87 | check --> checkIf{Any more checks?}
88 | checkIf -->|Yes| check
89 | end
90 | subgraph ____________Printer
91 | checkIf -->|No| msgIf{Are there any messages in the Message Stack?}
92 | msgIf -->|Yes| printer[/Show messages to user/]
93 | end
94 | msgIf -->|No| zeroExit([Exit with return code = 0])
95 | printer --> nonZeroExit([Exit with return code != 0])
96 | ```
97 |
98 | ## Architecture Specs
99 | Based on the components and their definitions mentioned below the following architecture is proposed. It tries to be
100 | as standard and strict as possible in order to streamline development and reduce the creation of
101 | technical debt, but provides means to customize behavior if necessary (for those edge cases)
102 |
103 | *Note: The following code examples have been reduced as they are meant as grand scheme examples and not a detailed
104 | implementation.*
105 |
106 | ### Frontend
107 | The main task for the frontend is parsing user's configuration and normalizing into a common format for the Scheduler.
108 | To enforce the format, it has been declared into a dataclass.
109 |
110 | In the case of dependent linters, `filenames` shall consist solely of `__manifest__.py` files. The manifest file
111 | states all source code files (outside of Python) and lets the scheduler calculate any dependencies which need to be
112 | checked.
113 |
114 | For independent linters, `filenames` consists of all files to be checked. Ideally these will only be those changed
115 | by the current commit.
116 |
117 | ### Scheduler and Lifecycle
118 | As stated before, the scheduler must run all necessary checks. Besides running checks it also needs to run
119 | the following "Lifecycle methods":
120 |
121 | * `check_loop` - Runs all checks in the linter against a file.
122 | * `on_global_open` - Runs just before checks start being run.
123 | * `on_global_close` - Runs after all checks have run. The scheduler will yield control of the program after calling this method.
124 | * `on_open` - Runs before a check loop starts.
125 | * `on_close` - Runs after a check loop. The next check loop (if any) will be run after this
126 |
127 | ### Message Stack
128 | Stores all messages generated by checks. Must implement (at least) the following method:
129 |
130 | * `store_message` - Stores a new message into the stack.
131 |
132 | ### Printer
133 | Produces output for the user to see. This output should contain all messages generated by checks. Alternatively,
134 | the user can choose to display messages that can be generated by the linter instead of linting files. The printer
135 | must produce said output too (message descriptions).
136 |
137 | ### Abstract Super Class
138 | In order to enforce the structure and flow described in this document an abstract class is used. **All
139 | compliant linters must be subclasses of it**. In order to keeps thing simple the
140 | linter is encompassed in just one class, the five components are just a mental construct used to organize concerns,
141 | in practice they are all implemented in the linter.
142 |
143 | ```python
144 | from abc import ABCMeta, abstractmethod
145 | from argparse import ArgumentParser
146 | from dataclasses import dataclass
147 | from typing import Mapping
148 |
149 |
150 | @dataclass
151 | class Message:
152 | key: str # Contains the message-id, for example xml-duplicate-record-id
153 | file: str # Absolute path to the file which committed the violation
154 | args: tuple = tuple() # Extra arguments used by the Printer to format the message
155 | # The following values won't be shown to the user if they are negative.
156 | line: int = -1 # Optional. Line in the file where the violation was found.
157 | column: int = -1 # Optional. Column where the violation happened.
158 |
159 |
160 | @dataclass(frozen=True)
161 | class SchedulerConfiguration:
162 | filenames: list[str] # Files to run the checker on.
163 | enable: list[str] # All enabled messages.
164 | disable: list[str] # All disabled messages.
165 | list_msgs: bool = False # Do not run any checks. Just print out the messages this linter emits.
166 | zero_exit: bool = False # If true the linter will always produce 0 as a return code.
167 | kwargs: dict = None # Extra arguments which can be used for customization. Implementation dependent.
168 |
169 |
170 | class AbstractLinter(ArgumentParser, metaclass=ABCMeta):
171 | _messages: Mapping[str, str] = None
172 |
173 | def __init__(self):
174 | self.add_argument("filenames")
175 | self.add_argument("--enable")
176 | self.add_argument("--disable")
177 | self.add_argument("--zero-exit")
178 |
179 | # Lifecycle
180 | def on_global_open(self): pass
181 | def on_global_close(self): pass
182 | def on_open(self): pass
183 | def on_close(self): pass
184 |
185 | @abstractmethod
186 | def get_exit_status(self) -> int:
187 | pass
188 |
189 | # Entrypoint (this runs when the user calls the executable)
190 | def run(self, args) -> int:
191 | # Frontend is called
192 | config = self.generate_config(args)
193 | if config.list_msgs:
194 | self.print_message_descriptions()
195 | return 0
196 |
197 | # Scheduler starts with a call to _on_global_open
198 | self.on_global_open()
199 | # Files get linted. A check loop is run per file.
200 | for file in config.filenames:
201 | self.perform_check_run(file)
202 | # Scheduler ends with a call to _on_global_close
203 | self.on_global_close()
204 |
205 | self.print_generated_messages()
206 |
207 | return self.get_exit_status()
208 |
209 | # Frontend
210 | @abstractmethod
211 | def generate_config(self, args) -> SchedulerConfiguration:
212 | pass
213 |
214 | # Scheduler
215 | @abstractmethod
216 | def _check_loop(self, file: str):
217 | pass
218 |
219 | def perform_check_run(self, file: str):
220 | self.on_open()
221 | self._check_loop(file)
222 | self.on_close()
223 |
224 | # Message Stack
225 | def add_message(self, message: Message):
226 | if message.key not in self._messages:
227 | raise ValueError(f"Message type ${message.key} is not generated by this linter.")
228 |
229 | self._store_message(message)
230 |
231 | @abstractmethod
232 | def _store_message(self, message: Message):
233 | pass
234 |
235 | # Printer
236 | @abstractmethod
237 | def print_generated_messages(self):
238 | pass
239 |
240 | @abstractmethod
241 | def print_message_descriptions(self):
242 | pass
243 | ```
244 |
245 | ## pre-commit Integration
246 | [pre-commit](https://pre-commit.com/) is a tool that integrates with Git to automatically run checks before
247 | committing changes. It uses Git Hooks to accomplish this. Two important features are `require_serial` and the ability
248 | to run lints on only files that have been changed.
249 |
250 | `require_serial` lets linters run in parallel processes. This speeds up the linting process and is generally a nice
251 | thing to have. Linting the minimum amount of files needed (only those that have changed) is also a great benefit as it
252 | reduces CPU usage/time (and saves money).
253 |
254 | ### Independent Linters
255 | All compliant Independent Linters can and should run (if possible) as parallel processes. As of
256 | writing this, [it is this way by default](), so no extra configuration needs to be performed. They should also lint
257 | only files of their type that have been modified. This is also the default.
258 |
259 | A sample configuration for this type of linter could be:
260 | ```yaml
261 | # .pre-commit-hooks.yaml
262 | - id: independent-csv-checker
263 | name: check csv files
264 | entry: csv-checker
265 | types: [csv]
266 | ```
267 |
268 | ### Dependent Linters
269 | Dependent Linters can't run in parallel processes, since they need the same context in order to detect stuff like
270 | duplicate IDs. This means their entry in `.pre-commit-hooks.yaml` must contain `require_serial: true`.
271 |
272 | They can run only when files of their type (csv, po, xml) are changed. For example, there is no sense
273 | in running an XML Linter (and looking for duplicated ids) if only .po or .csv files were changed.
274 | Using the same example, they do have to run if just a single XML file has been changed, and they need to run on
275 | all XML files *in the module*.
276 |
277 | Emphasis is on *module*, if `views.xml` from the module `sale_management` is changed, there is no need to check files
278 | in other modules. Context is limited to the module in this case. A sample configuration for this type of
279 | linter would be:
280 |
281 | ```yaml
282 | # .pre-commit-hooks.yaml
283 | - id: dependent-xml-checker
284 | name: check xml files
285 | require_serial: true
286 | entry: xml-checker
287 | types: [xml]
288 | ```
289 |
290 | Following the example before, if `views.xml` is changed, `pre-commit` will pass it to the executable as part of
291 | the `filenames` argument. Initially the dependent linter will only have a xml file in its filenames
292 | (it needs all xml files in said module). This is where the flexibility provided by separating concerns comes into
293 | place.
294 |
295 | The Frontend receives `views.xml` as the only file. This Frontend has been written for Dependent Linters, so it knows
296 | it needs all XML files. Therefore, it finds the module `views.xml` belongs to, reads it `__manifest__.py` and
297 | generates a `SchedulerConfiguration` whose `filenames` contain all the module's XML files it found. This configuration
298 | is passed to the scheduler and all checks run as expected.
299 |
--------------------------------------------------------------------------------
/tests/common.py:
--------------------------------------------------------------------------------
1 | import os
2 | import random
3 | import re
4 | import shutil
5 | import subprocess
6 | import sys
7 | import tempfile
8 | import unittest
9 | from collections import defaultdict
10 | from contextlib import contextmanager
11 | from distutils.dir_util import copy_tree # pylint:disable=deprecated-module
12 |
13 | from oca_pre_commit_hooks import utils
14 | from oca_pre_commit_hooks.global_parser import CONFIG_NAME, DISABLE_ENV_VAR, ENABLE_ENV_VAR
15 |
16 | RND = random.Random(987654321)
17 |
18 |
19 | def assertDictEqual(self, d1, d2, msg=None):
20 | # pylint:disable=invalid-name
21 | """Original method does not show the correct item diff
22 | Using ordered list it is showing the diff better"""
23 | real_dict2list = [(i, d1[i]) for i in sorted(d1)]
24 | expected_dict2list = [(i, d2[i]) for i in sorted(d2)]
25 | self.assertEqual(real_dict2list, expected_dict2list, msg)
26 |
27 |
28 | @contextmanager
29 | def chdir(directory):
30 | original_dir = os.getcwd()
31 | try:
32 | os.chdir(directory)
33 | yield
34 | finally:
35 | os.chdir(original_dir)
36 |
37 |
38 | def create_dummy_repo(src_path, dest_path):
39 | copy_tree(src_path, dest_path)
40 | subprocess.check_call(["git", "init", dest_path, "--initial-branch=main"])
41 |
42 |
43 | class ChecksCommon(unittest.TestCase):
44 | # pylint: disable=no-member
45 | @classmethod
46 | def setUpClass(cls):
47 | super().setUpClass()
48 | cls.maxDiff = None
49 | cls.original_test_repo_path = os.path.join(
50 | os.path.dirname(os.path.dirname(os.path.realpath(__file__))), "test_repo"
51 | )
52 | # For the inherited classes set "compatible_with_directories = True"
53 | # if the checks can run with directory paths
54 | # set False otherwise
55 | # e.g. "*.po" files are not compatible with directories
56 | cls.compatible_with_directories = True
57 |
58 | def setUp(self):
59 | super().setUp()
60 | os.environ.pop(DISABLE_ENV_VAR, None)
61 | os.environ.pop(ENABLE_ENV_VAR, None)
62 | self.tmp_dir = os.path.realpath(tempfile.mkdtemp(suffix="_oca_pre_commit_hooks"))
63 | self.test_repo_path = self.tmp_dir
64 | create_dummy_repo(self.original_test_repo_path, self.tmp_dir)
65 |
66 | def tearDown(self):
67 | super().tearDown()
68 | if os.path.isdir(self.tmp_dir) and self.tmp_dir != "/":
69 | shutil.rmtree(self.tmp_dir, ignore_errors=True)
70 |
71 | @staticmethod
72 | def get_grouped_errors(all_check_errors):
73 | grouped_errors = defaultdict(list)
74 | for check_error in all_check_errors:
75 | grouped_errors[check_error.code].append(check_error)
76 | return grouped_errors
77 |
78 | @staticmethod
79 | def get_count_code_errors(all_check_errors):
80 | grouped_errors = ChecksCommon.get_grouped_errors(all_check_errors)
81 | return {code: len(errors) for code, errors in grouped_errors.items()}
82 |
83 | @staticmethod
84 | def re_replace(sub_start, sub_end, substitution, content):
85 | re_sub = re.compile(rf"^{re.escape(sub_start)}$.*^{re.escape(sub_end)}$", re.M | re.S)
86 | if not re_sub.findall(content):
87 | raise UserWarning("No matched content")
88 | new_content = re_sub.sub(f"{sub_start}\n\n{substitution}\n\n{sub_end}", content)
89 | return new_content
90 |
91 | @unittest.skip("Repeated")
92 | def test_checks_basic(self):
93 | all_check_errors = self.checks_run(self.file_paths, no_exit=True, no_verbose=False)
94 | real_errors = self.get_count_code_errors(all_check_errors)
95 | # Uncommet to get sorted values to update EXPECTED_ERRORS dict
96 | # print("\n".join(f"'{key}':{real_errors[key]}," for key in sorted(real_errors)))
97 | assertDictEqual(self, real_errors, self.expected_errors)
98 |
99 | def test_checks_with_cli(self):
100 | sys.argv = ["", "--no-exit", "--no-verbose"] + self.file_paths
101 | all_check_errors = self.checks_cli_main()
102 | real_errors = self.get_count_code_errors(all_check_errors)
103 | assertDictEqual(self, real_errors, self.expected_errors)
104 |
105 | def test_checks_disable_one_by_one_with_random_cli_env_conf(self):
106 | """Faster way to test disable one by one using random method selection"""
107 | methods = [
108 | getattr(self, name)
109 | for name in dir(self)
110 | if name.startswith("_test_checks_disable_one_by_one") and callable(getattr(self, name))
111 | ]
112 | file_paths = self.file_paths
113 | dir_paths = [os.path.dirname(i) for i in self.file_paths]
114 | for check2disable in self.expected_errors:
115 | os.environ.pop(ENABLE_ENV_VAR, None)
116 | os.environ.pop(DISABLE_ENV_VAR, None)
117 | method = RND.choice(methods)
118 | if self.compatible_with_directories:
119 | self.file_paths = RND.choice([file_paths, dir_paths]) # pylint: disable=attribute-defined-outside-init
120 | method(check2disable)
121 |
122 | def _test_checks_disable_one_by_one(self, check2disable):
123 | expected_errors = self.expected_errors.copy()
124 | all_check_errors = self.checks_run(self.file_paths, no_exit=True, no_verbose=True, disable={check2disable})
125 | expected_errors.pop(check2disable)
126 | real_errors = self.get_count_code_errors(all_check_errors)
127 | assertDictEqual(self, real_errors, expected_errors, f"Disabled only {check2disable}")
128 |
129 | def _test_checks_disable_one_by_one_with_cli(self, check2disable):
130 | expected_errors = self.expected_errors.copy()
131 | sys.argv = ["", "--no-exit", "--no-verbose", f"--disable={check2disable}"] + self.file_paths
132 | all_check_errors = self.checks_cli_main()
133 | expected_errors.pop(check2disable)
134 | real_errors = self.get_count_code_errors(all_check_errors)
135 | assertDictEqual(self, real_errors, expected_errors, f"Disabled only {check2disable}")
136 |
137 | def _test_checks_disable_one_by_one_with_env(self, check2disable):
138 | expected_errors = self.expected_errors.copy()
139 | sys.argv = ["", "--no-exit", "--no-verbose"] + self.file_paths
140 | os.environ[DISABLE_ENV_VAR] = check2disable
141 | all_check_errors = self.checks_cli_main()
142 | expected_errors.pop(check2disable)
143 | real_errors = self.get_count_code_errors(all_check_errors)
144 | assertDictEqual(self, real_errors, expected_errors, f"Disabled only {check2disable}")
145 |
146 | def _test_checks_disable_one_by_one_with_cli_conf_file(self, check2disable):
147 | file_tmpl = "[MESSAGES_CONTROL]\ndisable=%s"
148 | with tempfile.TemporaryDirectory() as tmp_dir:
149 | tmp_fname = os.path.join(tmp_dir, CONFIG_NAME)
150 | with open(tmp_fname, "w", encoding="UTF-8") as temp_fl:
151 | content = file_tmpl % check2disable
152 | temp_fl.write(content)
153 | temp_fl.flush()
154 |
155 | expected_errors = self.expected_errors.copy()
156 | sys.argv = ["", "--no-exit", "--no-verbose", f"--config={temp_fl.name}"] + self.file_paths
157 | all_check_errors = self.checks_cli_main()
158 | expected_errors.pop(check2disable)
159 | real_errors = self.get_count_code_errors(all_check_errors)
160 | self.assertTrue(real_errors == expected_errors, f"Disabled only {check2disable}")
161 |
162 | def test_checks_enable_one_by_one_with_random_cli_env_conf(self):
163 | """Faster way to test enable one by one using random method selection"""
164 | methods = [
165 | getattr(self, name)
166 | for name in dir(self)
167 | if name.startswith("_test_checks_enable_one_by_one") and callable(getattr(self, name))
168 | ]
169 | file_paths = self.file_paths
170 | dir_paths = [os.path.dirname(i) for i in self.file_paths]
171 | for check2enable in self.expected_errors:
172 | os.environ.pop(ENABLE_ENV_VAR, None)
173 | os.environ.pop(DISABLE_ENV_VAR, None)
174 | method = RND.choice(methods)
175 | if self.compatible_with_directories:
176 | self.file_paths = RND.choice([file_paths, dir_paths]) # pylint: disable=attribute-defined-outside-init
177 | method(check2enable)
178 |
179 | def _test_checks_enable_one_by_one(self, check2enable):
180 | all_check_errors = self.checks_run(self.file_paths, no_exit=True, no_verbose=True, enable={check2enable})
181 | real_errors = self.get_count_code_errors(all_check_errors)
182 | assertDictEqual(
183 | self, real_errors, {check2enable: self.expected_errors[check2enable]}, f"Enabled only {check2enable}"
184 | )
185 |
186 | def _test_checks_enable_one_by_one_with_cli(self, check2enable):
187 | sys.argv = ["", "--no-exit", "--no-verbose", f"--enable={check2enable}"] + self.file_paths
188 | all_check_errors = self.checks_cli_main()
189 | real_errors = self.get_count_code_errors(all_check_errors)
190 | assertDictEqual(
191 | self, real_errors, {check2enable: self.expected_errors[check2enable]}, f"Enabled only {check2enable}"
192 | )
193 |
194 | def _test_checks_enable_one_by_one_with_env(self, check2enable):
195 | sys.argv = ["", "--no-exit", "--no-verbose"] + self.file_paths
196 | os.environ[ENABLE_ENV_VAR] = check2enable
197 | all_check_errors = self.checks_cli_main()
198 | real_errors = self.get_count_code_errors(all_check_errors)
199 | assertDictEqual(
200 | self, real_errors, {check2enable: self.expected_errors[check2enable]}, f"Enabled only {check2enable}"
201 | )
202 |
203 | def _test_checks_enable_one_by_one_with_cli_conf_file(self, check2enable):
204 | file_tmpl = "[MESSAGES_CONTROL]\nenable=%s"
205 | with tempfile.TemporaryDirectory() as tmp_dir:
206 | with chdir(tmp_dir): # Should use the configuration file of the current path
207 | tmp_fname = os.path.join(tmp_dir, CONFIG_NAME)
208 | with open(tmp_fname, "w", encoding="UTF-8") as temp_fl:
209 | content = file_tmpl % check2enable
210 | temp_fl.write(content)
211 | temp_fl.flush()
212 |
213 | sys.argv = ["", "--no-exit", "--no-verbose"] + self.file_paths
214 | all_check_errors = self.checks_cli_main()
215 | real_errors = self.get_count_code_errors(all_check_errors)
216 | assertDictEqual(
217 | self,
218 | real_errors,
219 | {check2enable: self.expected_errors[check2enable]},
220 | f"Enabled only {check2enable}",
221 | )
222 |
223 | def test_checks_enable_priority(self):
224 | """Verify enable configuration options have the correct priority. It should be:
225 | 1. --enable/--disable arguments
226 | 2. Environment variables
227 | 3. Configuration files (either trough arguments or by being in default locations (e.g. repo root))
228 | """
229 | expected_errors = list(self.expected_errors.keys())
230 |
231 | cli_check = expected_errors[0]
232 | env_check = expected_errors[1]
233 | conf_check = expected_errors[2]
234 |
235 | os.environ[ENABLE_ENV_VAR] = env_check
236 | with tempfile.TemporaryDirectory() as tmp_dir:
237 | with open(os.path.join(tmp_dir, CONFIG_NAME), "w", encoding="UTF-8") as conf_file:
238 | conf_file.write(f"[MESSAGES_CONTROL]\nenable={conf_check}")
239 | conf_file.flush()
240 |
241 | # First case. Only expect cli_check, it comes first over everything else
242 | sys.argv = [
243 | "",
244 | "--no-exit",
245 | "--no-verbose",
246 | f"--enable={cli_check}",
247 | f"--config={conf_file.name}",
248 | ] + self.file_paths
249 | real_errors = self.get_count_code_errors(self.checks_cli_main())
250 | assertDictEqual(self, real_errors, {cli_check: self.expected_errors[cli_check]})
251 |
252 | # Second case. Only expect env_check, it overwrites whatever is in the config file
253 | sys.argv = ["", "--no-exit", "--no-verbose", f"--config={conf_file.name}"] + self.file_paths
254 | real_errors = self.get_count_code_errors(self.checks_cli_main())
255 | assertDictEqual(self, real_errors, {env_check: self.expected_errors[env_check]})
256 |
257 | # Third case. Expect only conf_check since there is no cli argument or env var
258 | os.environ.pop(ENABLE_ENV_VAR, None)
259 | sys.argv = ["", "--no-exit", "--no-verbose", f"--config={conf_file.name}"] + self.file_paths
260 | real_errors = self.get_count_code_errors(self.checks_cli_main())
261 | assertDictEqual(self, real_errors, {conf_check: self.expected_errors[conf_check]})
262 |
263 | def test_checks_disable_priority(self):
264 | """Verify disable configuration options have the correct priority. It should be:
265 | 1. --enable/--disable arguments
266 | 2. Environment variables
267 | 3. Configuration files (either trough arguments or by being in default locations (e.g. repo root))
268 | """
269 | expected_errors = list(self.expected_errors.keys())
270 |
271 | cli_check = expected_errors[0]
272 | env_check = expected_errors[1]
273 | conf_check = expected_errors[2]
274 |
275 | os.environ[DISABLE_ENV_VAR] = env_check
276 | with tempfile.TemporaryDirectory() as tmp_dir:
277 | with open(os.path.join(tmp_dir, CONFIG_NAME), "w", encoding="UTF-8") as conf_file:
278 | conf_file.write(f"[MESSAGES_CONTROL]\ndisable={conf_check}")
279 | conf_file.flush()
280 |
281 | # First case. Do not expect cli_check, it comes first over everything else
282 | sys.argv = [
283 | "",
284 | "--no-exit",
285 | "--no-verbose",
286 | f"--disable={cli_check}",
287 | f"--config={conf_file.name}",
288 | ] + self.file_paths
289 | real_errors = self.get_count_code_errors(self.checks_cli_main())
290 | expected_errors = self.expected_errors.copy()
291 | expected_errors.pop(cli_check)
292 | assertDictEqual(self, real_errors, expected_errors)
293 |
294 | # Second case. Do not expect env_check, it overwrites whatever is in the config file
295 | sys.argv = ["", "--no-exit", "--no-verbose", f"--config={conf_file.name}"] + self.file_paths
296 | expected_errors = self.expected_errors.copy()
297 | expected_errors.pop(env_check)
298 | real_errors = self.get_count_code_errors(self.checks_cli_main())
299 | assertDictEqual(self, real_errors, expected_errors)
300 |
301 | # Third case. Expect only conf_check since there is no cli argument or env var
302 | os.environ.pop(DISABLE_ENV_VAR, None)
303 | sys.argv = ["", "--no-exit", "--no-verbose", f"--config={conf_file.name}"] + self.file_paths
304 | expected_errors = self.expected_errors.copy()
305 | expected_errors.pop(conf_check)
306 | real_errors = self.get_count_code_errors(self.checks_cli_main())
307 | assertDictEqual(self, real_errors, expected_errors)
308 |
309 | def test_list_messages(self):
310 | all_messages = self.checks_run([], list_msgs=True, no_exit=True, no_verbose=False)
311 | checks_found = re.findall(utils.RE_CHECK_DOCSTRING, all_messages)
312 | self.assertFalse(set(self.expected_errors) - set(checks_found), "Missing list-message of checks")
313 |
314 | @unittest.skipUnless(os.getenv("DEBUG_TEST_CHECK"), "No message to debug was set")
315 | def test_debug_check(self):
316 | check_ut = os.getenv("DEBUG_TEST_CHECK")
317 | if not self.expected_errors.get(check_ut):
318 | return
319 |
320 | real_errors = self.get_count_code_errors(self.checks_run(self.file_paths, enable={check_ut}, no_exit=True))
321 | assertDictEqual(self, real_errors, {check_ut: self.expected_errors[check_ut]})
322 |
323 | def test_checks_as_string(self):
324 | all_check_errors = self.checks_run(self.file_paths, no_exit=True, no_verbose=False)
325 | for check_error in all_check_errors:
326 | self.assertTrue(str(check_error).count(check_error.code) >= 1)
327 |
--------------------------------------------------------------------------------