Odoo18-Base/odoo/addons/test_lint/tests/test_pylint.py
2025-01-06 10:57:38 +07:00

107 lines
3.3 KiB
Python

# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.
import logging
import platform
try:
import pylint
except ImportError:
pylint = None
import subprocess
import os
from os.path import join
from odoo import tools
from odoo.modules import get_modules, get_module_path
from odoo.tests import TransactionCase
from odoo.tools.which import which
HERE = os.path.dirname(os.path.realpath(__file__))
_logger = logging.getLogger(__name__)
class TestPyLint(TransactionCase):
ENABLED_CODES = [
'used-before-assignment',
'undefined-variable',
'eval-used',
'unreachable',
'function-redefined',
# custom checkers
'sql-injection',
'gettext-variable',
'gettext-placeholders',
'gettext-repr',
'raise-unlink-override',
]
BAD_FUNCTIONS = [
'input',
]
BAD_MODULES = [
'csv',
'urllib',
'cgi',
] + list(tools.constants.SUPPORTED_DEBUGGER)
def _skip_test(self, reason):
_logger.warning(reason)
self.skipTest(reason)
def test_pylint(self):
if pylint is None:
self._skip_test('please install pylint')
required_pylint_version = tools.parse_version('1.7.0')
if tools.parse_version(getattr(pylint, '__version__', '0.0.1')) < required_pylint_version:
self._skip_test('please upgrade pylint to >= %s' % required_pylint_version)
paths = [tools.config['root_path']]
for module in get_modules():
module_path = get_module_path(module)
if not module_path.startswith(join(tools.config['root_path'], 'addons')):
paths.append(module_path)
options = [
'--rcfile=%s' % os.devnull,
'--disable=all',
'--enable=%s' % ','.join(self.ENABLED_CODES),
'--reports=n',
"--msg-template='{msg} ({msg_id}) at {path}:{line}'",
'--load-plugins=pylint.extensions.bad_builtin,_odoo_checker_sql_injection,_odoo_checker_gettext,_odoo_checker_unlink_override',
'--bad-functions=%s' % ','.join(self.BAD_FUNCTIONS),
'--deprecated-modules=%s' % ','.join(self.BAD_MODULES)
]
pypath = HERE + os.pathsep + os.environ.get('PYTHONPATH', '')
env = dict(os.environ, PYTHONPATH=pypath)
if os.name == 'posix' and platform.system() != 'Darwin':
# Pylint started failing at ~2.4g from time to time.
# Removing the memory limit will solve this issue for a while (runbot limit is arroung 5g)
def preexec():
import resource
resource.setrlimit(resource.RLIMIT_AS, (resource.RLIM_INFINITY, resource.RLIM_INFINITY))
else:
preexec = None
try:
pylint_bin = which('pylint')
process = subprocess.Popen(
[pylint_bin] + options + paths,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
env=env,
preexec_fn=preexec,
)
except (OSError, IOError):
self._skip_test('pylint executable not found in the path')
else:
out, err = process.communicate()
if process.returncode:
self.fail("pylint test failed:\n" + (b"\n" + out + b"\n" + err).decode('utf-8').strip())